diff --git a/404.html b/404.html index 1ad14d621eb..f89a09cb3f3 100644 --- a/404.html +++ b/404.html @@ -13,7 +13,7 @@ - + diff --git a/api.html b/api.html index 5263114c267..f3cbf62aa87 100644 --- a/api.html +++ b/api.html @@ -13,7 +13,7 @@ - + diff --git a/api/classes/CancellationTokenSource.html b/api/classes/CancellationTokenSource.html index ee3801cf3e2..2e4d9406e05 100644 --- a/api/classes/CancellationTokenSource.html +++ b/api/classes/CancellationTokenSource.html @@ -13,7 +13,7 @@ - + @@ -32,7 +32,7 @@

The cancellation token of this source.

Defined in

-

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

+

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

Methods

cancel()

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

Returns

void

Defined in

-

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

+

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


dispose()

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

Returns

void

Defined in

-

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

+

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

\ No newline at end of file diff --git a/api/classes/Disposable.html b/api/classes/Disposable.html index 34c623131d1..806f135f2d4 100644 --- a/api/classes/Disposable.html +++ b/api/classes/Disposable.html @@ -13,7 +13,7 @@ - + @@ -34,7 +34,7 @@

Returns

Disposable

Defined in

-

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

+

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

new Disposable()

new Disposable(callOnDispose): Disposable

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

Returns

Disposable

Defined in

-

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

+

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

Methods

dispose()

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

Returns

void

Defined in

-

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

+

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


create()

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

Returns

Disposable

Defined in

-

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

+

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


from()

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

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

Defined in

-

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 552b8e68c1a..54c19b7874c 100644 --- a/api/classes/EventEmitter.html +++ b/api/classes/EventEmitter.html @@ -13,7 +13,7 @@ - + @@ -38,7 +38,7 @@ extensions.

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

Defined in

-

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

Defined in

-

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

+

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


fire()

@@ -61,6 +61,6 @@ extensions.

Returns

void

Defined in

-

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 828b08d67d2..2e8be9c9639 100644 --- a/api/classes/TelemetryTrustedValue.html +++ b/api/classes/TelemetryTrustedValue.html @@ -13,7 +13,7 @@ - + @@ -32,13 +32,13 @@ This is to be used when you can guarantee no identifiable information is contain

Returns

TelemetryTrustedValue<T>

Defined in

-

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

+

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

Properties

value

readonly value: T

Defined in

-

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

+

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

\ No newline at end of file diff --git a/api/classes/Uri.html b/api/classes/Uri.html index be16d829045..c37b12df66d 100644 --- a/api/classes/Uri.html +++ b/api/classes/Uri.html @@ -13,7 +13,7 @@ - + @@ -27,7 +27,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.

Defined in

-

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

+

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


fragment

@@ -35,7 +35,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.

Defined in

-

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

+

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


fsPath

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

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

Defined in

-

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

+

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


path

@@ -51,7 +51,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.

Defined in

-

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

+

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


query

@@ -59,7 +59,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.

Defined in

-

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

+

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


scheme

@@ -68,7 +68,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.

Defined in

-

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

+

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

Methods

toString()

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

Returns

string

Defined in

-

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

+

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


with()

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

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

Defined in

-

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

+

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


file()

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

Returns

Uri

Defined in

-

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

+

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


joinPath()

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

Uri

A new uri which path is joined with the given fragments

Defined in

-

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

+

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


parse()

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

See

Uri.toString

Defined in

-

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

+

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

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

Error: 3

Defined in

-

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

+

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


Info

Info: 1

Defined in

-

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

+

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


Warning

Warning: 2

Defined in

-

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

+

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

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

See

TASK_WIDGET

Defined in

-

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

+

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


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

Defined in

-

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

+

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

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

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

Defined in

-

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

+

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


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.

Defined in

-

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

+

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

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

record: string

Defined in

-

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

+

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


type

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

Defined in

-

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

+

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

\ No newline at end of file diff --git a/api/interfaces/AuditRequestItems.html b/api/interfaces/AuditRequestItems.html index c7d7991c9cf..3bbe3c27c8f 100644 --- a/api/interfaces/AuditRequestItems.html +++ b/api/interfaces/AuditRequestItems.html @@ -13,7 +13,7 @@ - + diff --git a/api/interfaces/AuditResult.html b/api/interfaces/AuditResult.html index 26414fd75aa..45b223aab3d 100644 --- a/api/interfaces/AuditResult.html +++ b/api/interfaces/AuditResult.html @@ -13,7 +13,7 @@ - + @@ -24,6 +24,6 @@

records: AuditRecord[]

Defined in

-

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

+

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

\ No newline at end of file diff --git a/api/interfaces/Auditor.html b/api/interfaces/Auditor.html index 544b4579ecb..b2cf5c8df30 100644 --- a/api/interfaces/Auditor.html +++ b/api/interfaces/Auditor.html @@ -13,7 +13,7 @@ - + @@ -28,6 +28,6 @@

Returns

Promise<AuditResult>

Defined in

-

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

+

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

\ No newline at end of file diff --git a/api/interfaces/AuthConfig.html b/api/interfaces/AuthConfig.html index 811e6f0f7fa..f6339a94357 100644 --- a/api/interfaces/AuthConfig.html +++ b/api/interfaces/AuthConfig.html @@ -13,7 +13,7 @@ - + @@ -24,27 +24,27 @@

optional email: string

Defined in

-

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

+

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


password

password: string

Defined in

-

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

+

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


serveraddress

serveraddress: string

Defined in

-

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

+

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


username

username: string

Defined in

-

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

+

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

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

Defaults to false.

Defined in

-

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

+

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


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.

Defined in

-

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

+

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


forceNewSession?

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

createIfNone.

This defaults to false.

Defined in

-

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

+

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


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.

Defined in

-

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

+

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

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

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

Defined in

-

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

+

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

Methods

createSession()

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

Promise<AuthenticationSession>

A promise that resolves to an authentication session.

Defined in

-

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

+

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


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.

Defined in

-

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

+

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


removeSession()

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

Returns

Promise<void>

Defined in

-

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

+

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

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

The AuthenticationSessions of the AuthenticationProvider that have been added.

Defined in

-

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

+

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


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.

Defined in

-

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

+

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


removed?

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

The AuthenticationSessions of the AuthenticationProvider that have been removed.

Defined in

-

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

+

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

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

The unique identifier of the authentication provider.

Defined in

-

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

+

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


label

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

The human-readable name of the authentication provider.

Defined in

-

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

+

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

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

readonly optional images: ProviderImages

Defined in

-

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

+

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


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.

Defined in

-

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

+

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

\ No newline at end of file diff --git a/api/interfaces/AuthenticationSession.html b/api/interfaces/AuthenticationSession.html index 3238ba90fe4..62169ceee1a 100644 --- a/api/interfaces/AuthenticationSession.html +++ b/api/interfaces/AuthenticationSession.html @@ -13,7 +13,7 @@ - + @@ -26,7 +26,7 @@

The access token.

Defined in

-

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

+

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


account

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

The account associated with the session.

Defined in

-

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

+

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


id

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

The identifier of the authentication session.

Defined in

-

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

+

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


scopes

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

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

Defined in

-

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

+

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

\ No newline at end of file diff --git a/api/interfaces/AuthenticationSessionAccountInformation.html b/api/interfaces/AuthenticationSessionAccountInformation.html index 5af05bf73db..aa613d88c8c 100644 --- a/api/interfaces/AuthenticationSessionAccountInformation.html +++ b/api/interfaces/AuthenticationSessionAccountInformation.html @@ -13,7 +13,7 @@ - + @@ -26,7 +26,7 @@

The unique identifier of the account.

Defined in

-

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

+

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


label

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

The human-readable name of the account.

Defined in

-

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

+

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

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

The authenticationProvider that has had its sessions change.

Defined in

-

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

+

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

\ No newline at end of file diff --git a/api/interfaces/BlkioStatEntry.html b/api/interfaces/BlkioStatEntry.html index 4cc6957d8f5..e67853916a7 100644 --- a/api/interfaces/BlkioStatEntry.html +++ b/api/interfaces/BlkioStatEntry.html @@ -13,7 +13,7 @@ - + @@ -24,27 +24,27 @@

major: number

Defined in

-

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

+

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


minor

minor: number

Defined in

-

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

+

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


op

op: string

Defined in

-

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

+

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


value

value: number

Defined in

-

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

+

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

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

io_merged_recursive: BlkioStatEntry[]

Defined in

-

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

+

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


io_queue_recursive

io_queue_recursive: BlkioStatEntry[]

Defined in

-

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

+

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


io_service_bytes_recursive

io_service_bytes_recursive: BlkioStatEntry[]

Defined in

-

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

+

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


io_service_time_recursive

io_service_time_recursive: BlkioStatEntry[]

Defined in

-

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

+

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


io_serviced_recursive

io_serviced_recursive: BlkioStatEntry[]

Defined in

-

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

+

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


io_time_recursive

io_time_recursive: BlkioStatEntry[]

Defined in

-

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

+

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


io_wait_time_recursive

io_wait_time_recursive: BlkioStatEntry[]

Defined in

-

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

+

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


sectors_recursive

sectors_recursive: BlkioStatEntry[]

Defined in

-

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

+

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

\ No newline at end of file diff --git a/api/interfaces/BuildImageOptions.html b/api/interfaces/BuildImageOptions.html index 1184e1079da..6861f1ac02b 100644 --- a/api/interfaces/BuildImageOptions.html +++ b/api/interfaces/BuildImageOptions.html @@ -13,7 +13,7 @@ - + @@ -25,7 +25,7 @@

The abort controller for running the build image operation

Defined in

-

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

+

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


buildargs?

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

[key: string]: string

Defined in

-

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

+

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


cachefrom?

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

JSON array of images used for build cache resolution.

Defined in

-

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

+

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


containerFile?

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

Specifies a Containerfile which contains instructions for building the image

Defined in

-

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

+

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


cpuperiod?

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

The length of a CPU period in microseconds.

Defined in

-

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

+

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


cpuquota?

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

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

Defined in

-

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

+

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


cpusetcpus?

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

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

Defined in

-

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

+

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


cpushares?

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

CPU shares (relative weight).

Defined in

-

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

+

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


extrahosts?

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

Extra hosts to add to /etc/hosts

Defined in

-

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

+

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


forcerm?

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

Always remove intermediate containers, even upon failure.

Defined in

-

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

+

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


labels?

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

[key: string]: string

Defined in

-

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

+

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


memory?

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

Set memory limit for build.

Defined in

-

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

+

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


memswap?

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

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

Defined in

-

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

+

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


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.

Defined in

-

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

+

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


nocache?

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

Default: false

Do not use the cache when building the image.

Defined in

-

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

+

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


outputs?

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

Default: ""

BuildKit output configuration

Defined in

-

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

+

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


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

Defined in

-

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

+

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


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)

Defined in

-

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

+

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


pull?

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

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

Defined in

-

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

+

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


q?

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

Default: false

Suppress verbose build output.

Defined in

-

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

+

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


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.

Defined in

-

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

+

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


rm?

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

Default: true

Remove intermediate containers after a successful build.

Defined in

-

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

+

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


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.

Defined in

-

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

+

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


squash?

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

Squash the resulting images layers into a single layer.

Defined in

-

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

+

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


tag?

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

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

Defined in

-

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

+

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


target?

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

Default: ""

Target build stage

Defined in

-

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

+

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

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

cpu_usage: CPUUsage

Defined in

-

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

+

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


online_cpus

online_cpus: number

Defined in

-

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

+

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


system_cpu_usage

system_cpu_usage: number

Defined in

-

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

+

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


throttling_data

throttling_data: ThrottlingData

Defined in

-

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

+

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

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

percpu_usage: number[]

Defined in

-

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

+

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


total_usage

total_usage: number

Defined in

-

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

+

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


usage_in_kernelmode

usage_in_kernelmode: number

Defined in

-

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

+

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


usage_in_usermode

usage_in_usermode: number

Defined in

-

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

+

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

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

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

Defined in

-

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

+

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


onCancellationRequested

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

An Event which fires upon cancellation.

Defined in

-

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

+

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

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

optional description: string

Defined in

-

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

+

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


optional docLinks: Link[]

Defined in

-

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

+

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


docLinksDescription?

optional docLinksDescription: string

Defined in

-

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

+

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


fixCommand?

optional fixCommand: CheckResultFixCommand

Defined in

-

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

+

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


successful

successful: boolean

Defined in

-

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

+

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

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

id: string

Defined in

-

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

+

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


title

title: string

Defined in

-

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

+

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

\ No newline at end of file diff --git a/api/interfaces/CliTool.html b/api/interfaces/CliTool.html index 84f527e6f0e..acfb296c74f 100644 --- a/api/interfaces/CliTool.html +++ b/api/interfaces/CliTool.html @@ -13,7 +13,7 @@ - + @@ -30,7 +30,7 @@

Inherited from

CliToolInfo.displayName

Defined in

-

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

+

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


extensionInfo

@@ -47,7 +47,7 @@

Inherited from

CliToolInfo.extensionInfo

Defined in

-

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

+

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


id

@@ -56,7 +56,7 @@

Inherited from

CliToolInfo.id

Defined in

-

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

+

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


images

@@ -65,7 +65,7 @@

Inherited from

CliToolInfo.images

Defined in

-

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

+

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


markdownDescription

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

Inherited from

CliToolInfo.markdownDescription

Defined in

-

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

+

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


name

@@ -83,28 +83,28 @@

Inherited from

CliToolInfo.name

Defined in

-

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

+

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


onDidUninstall

onDidUninstall: Event<void>

Defined in

-

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

+

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


onDidUpdateVersion

onDidUpdateVersion: Event<string>

Defined in

-

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

+

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


state

state: "registered"

Defined in

-

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

+

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


version?

@@ -113,7 +113,7 @@

Inherited from

CliToolInfo.version

Defined in

-

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

+

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

Methods

dispose()

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

Inherited from

Disposable.dispose

Defined in

-

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

+

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


registerInstaller()

@@ -136,7 +136,7 @@

Returns

Disposable

Defined in

-

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

+

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


registerUpdate()

@@ -147,7 +147,7 @@

Returns

Disposable

Defined in

-

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

+

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


updateVersion()

@@ -158,6 +158,6 @@

Returns

void

Defined in

-

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

+

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

\ No newline at end of file diff --git a/api/interfaces/CliToolInfo.html b/api/interfaces/CliToolInfo.html index f804d633578..917c0d91811 100644 --- a/api/interfaces/CliToolInfo.html +++ b/api/interfaces/CliToolInfo.html @@ -13,7 +13,7 @@ - + @@ -28,7 +28,7 @@

displayName: string

Defined in

-

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

+

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


extensionInfo

@@ -43,41 +43,41 @@

label: string

Defined in

-

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

+

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


id

id: string

Defined in

-

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

+

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


images

images: ProviderImages

Defined in

-

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

+

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


markdownDescription

markdownDescription: string

Defined in

-

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

+

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


name

name: string

Defined in

-

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

+

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


version?

optional version: string

Defined in

-

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

+

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

\ No newline at end of file diff --git a/api/interfaces/CliToolInstaller.html b/api/interfaces/CliToolInstaller.html index d2fab47ee48..675a95561ed 100644 --- a/api/interfaces/CliToolInstaller.html +++ b/api/interfaces/CliToolInstaller.html @@ -13,7 +13,7 @@ - + @@ -28,7 +28,7 @@

Returns

Promise<void>

Defined in

-

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

+

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


doUninstall()

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

Returns

Promise<void>

Defined in

-

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

+

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


selectVersion()

@@ -48,6 +48,6 @@

Returns

Promise<string>

Defined in

-

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

+

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

\ No newline at end of file diff --git a/api/interfaces/CliToolOptions.html b/api/interfaces/CliToolOptions.html index a442b8a4103..4621edd3159 100644 --- a/api/interfaces/CliToolOptions.html +++ b/api/interfaces/CliToolOptions.html @@ -13,7 +13,7 @@ - + @@ -25,14 +25,14 @@

displayName: string

Defined in

-

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

+

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


images

images: ProviderImages

Defined in

-

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

+

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


installationSource?

@@ -44,28 +44,28 @@
  • extension: it has been installed by podman desktop extension. It can be updated
  • Defined in

    -

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

    +

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


    markdownDescription

    markdownDescription: string

    Defined in

    -

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

    +

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


    name

    name: string

    Defined in

    -

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

    +

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


    path?

    optional path: string

    Defined in

    -

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

    +

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


    version?

    @@ -78,6 +78,6 @@ This is usually the ~/.local/share/containers/podman-desktop/extensions-storage Note: The expected value should not include 'v'. Note: If the version and path are not defined (= the tool is not installed), the install logic should be implemented

    Defined in

    -

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

    +

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

    \ No newline at end of file diff --git a/api/interfaces/CliToolSelectUpdate.html b/api/interfaces/CliToolSelectUpdate.html index 986ec6d3ff1..e5918b5537f 100644 --- a/api/interfaces/CliToolSelectUpdate.html +++ b/api/interfaces/CliToolSelectUpdate.html @@ -13,7 +13,7 @@ - + @@ -28,7 +28,7 @@

    Returns

    Promise<void>

    Defined in

    -

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

    +

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


    selectVersion()

    @@ -37,6 +37,6 @@

    Returns

    Promise<string>

    Defined in

    -

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

    +

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

    \ No newline at end of file diff --git a/api/interfaces/CliToolUpdate.html b/api/interfaces/CliToolUpdate.html index 9b3afccccaf..5d3cc04237e 100644 --- a/api/interfaces/CliToolUpdate.html +++ b/api/interfaces/CliToolUpdate.html @@ -13,7 +13,7 @@ - + @@ -28,13 +28,13 @@

    Returns

    Promise<void>

    Defined in

    -

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

    +

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


    version

    version: string

    Defined in

    -

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

    +

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

    \ No newline at end of file diff --git a/api/interfaces/CliToolUpdateOptions.html b/api/interfaces/CliToolUpdateOptions.html index 4c17d64791d..41eb5a16241 100644 --- a/api/interfaces/CliToolUpdateOptions.html +++ b/api/interfaces/CliToolUpdateOptions.html @@ -13,7 +13,7 @@ - + @@ -25,41 +25,41 @@

    optional displayName: string

    Defined in

    -

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

    +

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


    images?

    optional images: ProviderImages

    Defined in

    -

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

    +

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


    installationSource?

    optional installationSource: CliToolInstallationSource

    Defined in

    -

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

    +

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


    markdownDescription?

    optional markdownDescription: string

    Defined in

    -

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

    +

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


    path?

    optional path: string

    Defined in

    -

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

    +

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


    version

    version: string

    Defined in

    -

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

    +

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

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

    Promise<string>

    A Promise that resolves to a string.

    Defined in

    -

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

    +

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


    writeText()

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

    Promise<void>

    A Promise that resolves when writing happened.

    Defined in

    -

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

    +

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

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

    optional arguments: any[]

    Defined in

    -

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

    +

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


    command

    command: string

    Defined in

    -

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

    +

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


    title

    title: string

    Defined in

    -

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

    +

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


    tooltip?

    optional tooltip: string

    Defined in

    -

    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 147637a27b9..a7a1e6055c0 100644 --- a/api/interfaces/Configuration.html +++ b/api/interfaces/Configuration.html @@ -13,7 +13,7 @@ - + @@ -36,7 +36,7 @@

    undefined | T

    The value section denotes or undefined.

    Defined in
    -

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

    +

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

    get(section, defaultValue)

    get<T>(section, defaultValue): T

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

    T

    The value section denotes or the default.

    Defined in
    -

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

    +

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


    has()

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

    boolean

    true if the section doesn't resolve to undefined.

    Defined in

    -

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

    +

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


    update()

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

    Returns

    Promise<void>

    Defined in

    -

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

    +

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

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

    boolean

    true if the given section has changed.

    Defined in

    -

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

    +

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

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

    optional email: string

    Defined in

    -

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

    +

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


    password

    password: string

    Defined in

    -

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

    +

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


    serveraddress

    serveraddress: string

    Defined in

    -

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

    +

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


    username

    username: string

    Defined in

    -

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

    +

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

    \ No newline at end of file diff --git a/api/interfaces/ContainerCreateOptions.html b/api/interfaces/ContainerCreateOptions.html index 968f81c9f46..12319b02dfa 100644 --- a/api/interfaces/ContainerCreateOptions.html +++ b/api/interfaces/ContainerCreateOptions.html @@ -13,7 +13,7 @@ - + @@ -26,7 +26,7 @@

    Default: false

    Command is already escaped (Windows only)

    Defined in

    -

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

    +

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


    AttachStderr?

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

    Whether to attach to stderr (default false)

    Defined in

    -

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

    +

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


    AttachStdin?

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

    Whether to attach to stdin (default false)

    Defined in

    -

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

    +

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


    AttachStdout?

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

    Whether to attach to stdout(default false)

    Defined in

    -

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

    +

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


    Cmd?

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

    Command to run specified as an array of strings

    Defined in

    -

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

    +

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


    Detach?

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

    Run the container in the background

    Defined in

    -

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

    +

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


    Domainname?

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

    The domain name to use for the container.

    Defined in

    -

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

    +

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


    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).

    Defined in

    -

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

    +

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


    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

    Defined in

    -

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

    +

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


    EnvFiles?

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

    Environment files to use

    Defined in

    -

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

    +

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


    ExposedPorts?

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

    Index Signature

    [port: string]: object

    Defined in

    -

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

    +

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


    HealthCheck?

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

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

    Defined in

    -

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

    +

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


    HostConfig?

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

    Container configuration that depends on the host we are running on

    Defined in

    -

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

    +

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


    Hostname?

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

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

    Defined in

    -

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

    +

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


    Image?

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

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

    Defined in

    -

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

    +

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


    Labels?

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

    Index Signature

    [label: string]: string

    Defined in

    -

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

    +

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


    MacAddress?

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

    MAC address of the container.

    Defined in

    -

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

    +

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


    NetworkConfig?

    optional NetworkConfig: NetworkingConfig

    Defined in

    -

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

    +

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


    NetworkDisabled?

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

    Disable networking for the container.

    Defined in

    -

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

    +

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


    OnBuild?

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

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

    Defined in

    -

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

    +

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


    OpenStdin?

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

    Whether to open stdin (default false)

    Defined in

    -

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

    +

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


    Shell?

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

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

    Defined in

    -

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

    +

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


    StdinOnce?

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

    Close stdin after one attached client disconnects (deafult false)

    Defined in

    -

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

    +

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


    StopSignal?

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

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

    Defined in

    -

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

    +

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


    StopTimeout?

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

    Default: 10

    Timeout to stop a container in seconds.

    Defined in

    -

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

    +

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


    Tty?

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

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

    Defined in

    -

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

    +

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


    User?

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

    The user that commands are run as inside the container

    Defined in

    -

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

    +

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


    Volumes?

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

    Index Signature

    [volume: string]: object

    Defined in

    -

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

    +

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


    WorkingDir?

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

    The working directory for commands to run in.

    Defined in

    -

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

    +

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


    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

    Defined in

    -

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

    +

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


    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

    Defined in

    -

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

    +

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


    pod?

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

    Pod where to create the container in

    Defined in

    -

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

    +

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


    start?

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

    Start the container immediately (default true)

    Defined in

    -

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

    +

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

    \ No newline at end of file diff --git a/api/interfaces/ContainerCreateResult.html b/api/interfaces/ContainerCreateResult.html index 4db6e685ba2..a02fb031606 100644 --- a/api/interfaces/ContainerCreateResult.html +++ b/api/interfaces/ContainerCreateResult.html @@ -13,7 +13,7 @@ - + @@ -26,7 +26,7 @@

    the engineId where the container is running

    Defined in

    -

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

    +

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


    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)

    Defined in

    -

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

    +

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

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

    Percentage of idle CPUs (for Podman engines only)

    Defined in

    -

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

    +

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


    cpus?

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

    number of CPUs available for the container engine

    Defined in

    -

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

    +

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


    diskSize?

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

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

    Defined in

    -

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

    +

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


    diskUsed?

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

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

    Defined in

    -

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

    +

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


    engineId

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

    unique id identifying the container engine

    Defined in

    -

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

    +

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


    engineName

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

    name of the container engine

    Defined in

    -

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

    +

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


    engineType

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

    engine type, either 'podman' or 'docker'

    Defined in

    -

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

    +

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


    memory?

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

    Quantity of memory available for the container engine

    Defined in

    -

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

    +

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


    memoryUsed?

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

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

    Defined in

    -

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

    +

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

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

    Command: string

    Defined in

    -

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

    +

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


    Created

    Created: number

    Defined in

    -

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

    +

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


    HostConfig

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

    NetworkMode: string

    Defined in

    -

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

    +

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


    Id

    Id: string

    Defined in

    -

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

    +

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


    Image

    Image: string

    Defined in

    -

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

    +

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


    ImageID

    ImageID: string

    Defined in

    -

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

    +

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


    Labels

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

    Index Signature

    [label: string]: string

    Defined in

    -

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

    +

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


    Mounts

    Mounts: object[]

    Defined in

    -

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

    +

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


    Names

    Names: string[]

    Defined in

    -

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

    +

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


    NetworkSettings

    @@ -99,48 +99,48 @@
    Index Signature

    [networkType: string]: NetworkInfo

    Defined in

    -

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

    +

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


    Ports

    Ports: Port[]

    Defined in

    -

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

    +

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


    State

    State: string

    Defined in

    -

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

    +

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


    Status

    Status: string

    Defined in

    -

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

    +

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


    engineId

    engineId: string

    Defined in

    -

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

    +

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


    engineName

    engineName: string

    Defined in

    -

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

    +

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


    engineType

    engineType: "docker" | "podman"

    Defined in

    -

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

    +

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

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

    AppArmorProfile: string

    Defined in

    -

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

    +

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


    Args

    Args: string[]

    Defined in

    -

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

    +

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


    Config

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

    WorkingDir: string

    Defined in

    -

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

    +

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


    Created

    Created: string

    Defined in

    -

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

    +

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


    Driver

    Driver: string

    Defined in

    -

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

    +

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


    ExecIDs?

    optional ExecIDs: string[]

    Defined in

    -

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

    +

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


    GraphDriver

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

    Name: string

    Defined in

    -

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

    +

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


    HostConfig

    HostConfig: HostConfig

    Defined in

    -

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

    +

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


    HostnamePath

    HostnamePath: string

    Defined in

    -

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

    +

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


    HostsPath

    HostsPath: string

    Defined in

    -

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

    +

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


    Id

    Id: string

    Defined in

    -

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

    +

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


    Image

    Image: string

    Defined in

    -

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

    +

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


    LogPath

    LogPath: string

    Defined in

    -

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

    +

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


    MountLabel

    MountLabel: string

    Defined in

    -

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

    +

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


    Mounts

    Mounts: object[]

    Defined in

    -

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

    +

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


    Name

    Name: string

    Defined in

    -

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

    +

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


    NetworkSettings

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

    optional SecondaryIPv6Addresses: unknown

    Defined in

    -

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

    +

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


    Path

    Path: string

    Defined in

    -

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

    +

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


    Platform

    Platform: string

    Defined in

    -

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

    +

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


    ProcessLabel

    ProcessLabel: string

    Defined in

    -

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

    +

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


    ResolvConfPath

    ResolvConfPath: string

    Defined in

    -

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

    +

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


    RestartCount

    RestartCount: number

    Defined in

    -

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

    +

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


    State

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

    Status: string

    Defined in

    -

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

    +

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


    engineId

    engineId: string

    Defined in

    -

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

    +

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


    engineName

    engineName: string

    Defined in

    -

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

    +

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

    \ No newline at end of file diff --git a/api/interfaces/ContainerJSONEvent.html b/api/interfaces/ContainerJSONEvent.html index 5aecfe8011d..f9b027fe540 100644 --- a/api/interfaces/ContainerJSONEvent.html +++ b/api/interfaces/ContainerJSONEvent.html @@ -13,7 +13,7 @@ - + @@ -24,27 +24,27 @@

    optional Type: string

    Defined in

    -

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

    +

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


    id

    id: string

    Defined in

    -

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

    +

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


    status

    status: string

    Defined in

    -

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

    +

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


    type

    type: string

    Defined in

    -

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

    +

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

    \ No newline at end of file diff --git a/api/interfaces/ContainerProviderConnection.html b/api/interfaces/ContainerProviderConnection.html index 8bb11ecc43d..ead310ff1fc 100644 --- a/api/interfaces/ContainerProviderConnection.html +++ b/api/interfaces/ContainerProviderConnection.html @@ -13,7 +13,7 @@ - + @@ -24,35 +24,35 @@

    endpoint: ContainerProviderConnectionEndpoint

    Defined in

    -

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

    +

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


    lifecycle?

    optional lifecycle: ProviderConnectionLifecycle

    Defined in

    -

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

    +

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


    name

    name: string

    Defined in

    -

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

    +

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


    type

    type: "docker" | "podman"

    Defined in

    -

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

    +

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


    vmType?

    optional vmType: string

    Defined in

    -

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

    +

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

    Methods

    status()

    @@ -61,6 +61,6 @@

    Returns

    ProviderConnectionStatus

    Defined in

    -

    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 e68bcc95701..0d68bc007c1 100644 --- a/api/interfaces/ContainerProviderConnectionEndpoint.html +++ b/api/interfaces/ContainerProviderConnectionEndpoint.html @@ -13,7 +13,7 @@ - + @@ -24,6 +24,6 @@

    socketPath: string

    Defined in

    -

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

    +

    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 598b4ba0a08..b64dd413c31 100644 --- a/api/interfaces/ContainerProviderConnectionFactory.html +++ b/api/interfaces/ContainerProviderConnectionFactory.html @@ -13,7 +13,7 @@ - + @@ -30,7 +30,7 @@

    Inherited from

    ProviderConnectionFactory.creationButtonTitle

    Defined in

    -

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

    +

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


    creationDisplayName?

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

    Inherited from

    ProviderConnectionFactory.creationDisplayName

    Defined in

    -

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

    +

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

    Methods

    create()

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

    Returns

    Promise<void>

    Defined in

    -

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

    +

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


    initialize()?

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

    Inherited from

    ProviderConnectionFactory.initialize

    Defined in

    -

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

    +

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

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

    optional blkio_stats: BlkioStats

    Defined in

    -

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

    +

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


    cpu_stats

    cpu_stats: CPUStats

    Defined in

    -

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

    +

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


    engineId

    engineId: string

    Defined in

    -

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

    +

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


    engineName

    engineName: string

    Defined in

    -

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

    +

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


    memory_stats

    memory_stats: MemoryStats

    Defined in

    -

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

    +

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


    networks

    networks: NetworkStats

    Defined in

    -

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

    +

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


    num_procs

    num_procs: number

    Defined in

    -

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

    +

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


    pids_stats?

    optional pids_stats: PidsStats

    Defined in

    -

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

    +

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


    precpu_stats

    precpu_stats: CPUStats

    Defined in

    -

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

    +

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


    preread

    preread: string

    Defined in

    -

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

    +

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


    read

    read: string

    Defined in

    -

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

    +

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


    storage_stats?

    optional storage_stats: StorageStats

    Defined in

    -

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

    +

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

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

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

    Defined in

    -

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

    +

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


    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.

    Defined in

    -

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

    +

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


    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.

    Defined in

    -

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

    +

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


    icon?

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

    An optional base64 PNG image

    Defined in

    -

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

    +

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


    items

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

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

    Defined in

    -

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

    +

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


    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.

    Defined in

    -

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

    +

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


    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).

    Defined in

    -

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

    +

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


    onDidHide

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

    An event signaling when this input UI is hidden.

    Defined in

    -

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

    +

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


    title?

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

    An optional human-readable string which is rendered prominent.

    Defined in

    -

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

    +

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

    Methods

    dispose()

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

    Returns

    void

    Defined in

    -

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

    +

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


    hide()

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

    Returns

    void

    Defined in

    -

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

    +

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


    show()

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

    Returns

    void

    Defined in

    -

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

    +

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

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

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

    Defined in

    -

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

    +

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


    markDownContent

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

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

    Defined in

    -

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

    +

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


    sections?

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

    Optional sections that will be rendered in separate lines

    Defined in

    -

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

    +

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


    selected?

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

    Optional flag indicating if this item is selected initially

    Defined in

    -

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

    +

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


    title

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

    A human-readable string which is rendered prominent.

    Defined in

    -

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

    +

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

    \ No newline at end of file diff --git a/api/interfaces/CustomPickSectionItem.html b/api/interfaces/CustomPickSectionItem.html index 36aa61e5458..a6a8bb924f8 100644 --- a/api/interfaces/CustomPickSectionItem.html +++ b/api/interfaces/CustomPickSectionItem.html @@ -13,7 +13,7 @@ - + @@ -27,7 +27,7 @@ a list of items.

    A human-readable string which is rendered in a separate line.

    Defined in

    -

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

    +

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


    markDownContent?

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

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

    Defined in

    -

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

    +

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


    title

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

    A human-readable string which is rendered prominent.

    Defined in

    -

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

    +

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

    \ No newline at end of file diff --git a/api/interfaces/DeviceRequest.html b/api/interfaces/DeviceRequest.html index ff19b43a937..d9c2d1a9e7e 100644 --- a/api/interfaces/DeviceRequest.html +++ b/api/interfaces/DeviceRequest.html @@ -13,7 +13,7 @@ - + @@ -24,28 +24,28 @@

    optional Capabilities: string[][]

    Defined in

    -

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

    +

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


    Count?

    optional Count: number

    Defined in

    -

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

    +

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


    DeviceIDs?

    optional DeviceIDs: string[]

    Defined in

    -

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

    +

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


    Driver?

    optional Driver: string

    Defined in

    -

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

    +

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


    Options?

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

    Index Signature

    [key: string]: string

    Defined in

    -

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

    +

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

    \ No newline at end of file diff --git a/api/interfaces/EndpointIPAMConfig.html b/api/interfaces/EndpointIPAMConfig.html index 394564d1a25..713596cb6d5 100644 --- a/api/interfaces/EndpointIPAMConfig.html +++ b/api/interfaces/EndpointIPAMConfig.html @@ -13,7 +13,7 @@ - + @@ -24,20 +24,20 @@

    optional IPv4Address: string

    Defined in

    -

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

    +

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


    IPv6Address?

    optional IPv6Address: string

    Defined in

    -

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

    +

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


    LinkLocalIPs?

    optional LinkLocalIPs: string[]

    Defined in

    -

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

    +

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

    \ No newline at end of file diff --git a/api/interfaces/EndpointSettings.html b/api/interfaces/EndpointSettings.html index a719be4bb55..01f82798470 100644 --- a/api/interfaces/EndpointSettings.html +++ b/api/interfaces/EndpointSettings.html @@ -13,7 +13,7 @@ - + @@ -24,7 +24,7 @@

    optional Aliases: string[]

    Defined in

    -

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

    +

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


    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.

    Defined in

    -

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

    +

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


    DriverOpts?

    @@ -46,7 +46,7 @@ appending .<network-name>. For instance, if container name is

    Index Signature

    [key: string]: string

    Defined in

    -

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

    +

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


    EndpointID?

    @@ -54,7 +54,7 @@ appending .<network-name>. For instance, if container name is

    Unique ID for the service endpoint in a Sandbox.

    Defined in

    -

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

    +

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


    Gateway?

    @@ -62,7 +62,7 @@ appending .<network-name>. For instance, if container name is

    Gateway address for this network.

    Defined in

    -

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

    +

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


    GlobalIPv6Address?

    @@ -70,7 +70,7 @@ appending .<network-name>. For instance, if container name is

    Global IPv6 address.

    Defined in

    -

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

    +

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


    GlobalIPv6PrefixLen?

    @@ -78,7 +78,7 @@ appending .<network-name>. For instance, if container name is

    Mask length of the global IPv6 address.

    Defined in

    -

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

    +

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


    IPAMConfig?

    @@ -86,7 +86,7 @@ appending .<network-name>. For instance, if container name is

    EndpointIPAMConfig represents an endpoint's IPAM configuration.

    Defined in

    -

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

    +

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


    IPAddress?

    @@ -94,7 +94,7 @@ appending .<network-name>. For instance, if container name is

    IPv4 address.

    Defined in

    -

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

    +

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


    IPPrefixLen?

    @@ -102,7 +102,7 @@ appending .<network-name>. For instance, if container name is

    Mask length of the IPv4 address.

    Defined in

    -

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

    +

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


    IPv6Gateway?

    @@ -110,14 +110,14 @@ appending .<network-name>. For instance, if container name is

    IPv6 gateway address.

    Defined in

    -

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

    +

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


    optional Links: string[]

    Defined in

    -

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

    +

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


    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.

    Defined in

    -

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

    +

    packages/extension-api/src/extension-api.d.ts:2775


    NetworkID?

    @@ -133,6 +133,6 @@ appending .<network-name>. For instance, if container name is

    Unique ID of the network.

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:2782

    +

    packages/extension-api/src/extension-api.d.ts:2782

    \ No newline at end of file diff --git a/api/interfaces/Event.html b/api/interfaces/Event.html index 1d11362014e..f583d97af94 100644 --- a/api/interfaces/Event.html +++ b/api/interfaces/Event.html @@ -13,7 +13,7 @@ - + @@ -36,6 +36,6 @@

    Disposable

    A disposable which unsubscribes the event listener.

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:125

    +

    packages/extension-api/src/extension-api.d.ts:125

    \ No newline at end of file diff --git a/api/interfaces/Extension.html b/api/interfaces/Extension.html index 2fc6660f690..f0d72d0cdc8 100644 --- a/api/interfaces/Extension.html +++ b/api/interfaces/Extension.html @@ -13,7 +13,7 @@ - + @@ -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.

    Defined in

    -

    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).

    Defined in

    -

    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.

    Defined in

    -

    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.

    Defined in

    -

    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.

    Defined in

    -

    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 9275d9e37f8..8f2ff0d9b60 100644 --- a/api/interfaces/ExtensionContext.html +++ b/api/interfaces/ExtensionContext.html @@ -13,7 +13,7 @@ - + @@ -25,7 +25,7 @@

    The uri of the directory containing the extension.

    Defined in

    -

    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.

    Defined in

    -

    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.

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:160

    +

    packages/extension-api/src/extension-api.d.ts:160


    subscriptions

    readonly subscriptions: object[]

    Defined in

    -

    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 eb9a6dd7266..2ba09308333 100644 --- a/api/interfaces/FileSystemWatcher.html +++ b/api/interfaces/FileSystemWatcher.html @@ -13,7 +13,7 @@ - + @@ -29,21 +29,21 @@

    readonly onDidChange: Event<Uri>

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:1673

    +

    packages/extension-api/src/extension-api.d.ts:1673


    onDidCreate

    readonly onDidCreate: Event<Uri>

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:1672

    +

    packages/extension-api/src/extension-api.d.ts:1672


    onDidDelete

    readonly onDidDelete: Event<Uri>

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:1674

    +

    packages/extension-api/src/extension-api.d.ts:1674

    Methods

    dispose()

    @@ -55,6 +55,6 @@

    Inherited from

    Disposable.dispose

    Defined in

    -

    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 c8628b1e860..d4d5bf0f6cf 100644 --- a/api/interfaces/GenerateKubeResult.html +++ b/api/interfaces/GenerateKubeResult.html @@ -13,7 +13,7 @@ - + @@ -25,6 +25,6 @@

    yaml: string

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:2137

    +

    packages/extension-api/src/extension-api.d.ts:2137

    \ No newline at end of file diff --git a/api/interfaces/HealthCheckLog.html b/api/interfaces/HealthCheckLog.html index 75e02d6f063..5c7ad43606c 100644 --- a/api/interfaces/HealthCheckLog.html +++ b/api/interfaces/HealthCheckLog.html @@ -13,7 +13,7 @@ - + @@ -26,7 +26,7 @@

    End time as a string

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:2531

    +

    packages/extension-api/src/extension-api.d.ts:2531


    ExitCode

    @@ -34,7 +34,7 @@

    Exitcode is 0 or 1

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:2535

    +

    packages/extension-api/src/extension-api.d.ts:2535


    Output

    @@ -42,7 +42,7 @@

    Output is the stdout/stderr from the healthcheck command

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:2539

    +

    packages/extension-api/src/extension-api.d.ts:2539


    Start

    @@ -50,6 +50,6 @@

    Start time as string

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:2527

    +

    packages/extension-api/src/extension-api.d.ts:2527

    \ No newline at end of file diff --git a/api/interfaces/HealthCheckResults.html b/api/interfaces/HealthCheckResults.html index 0aa604a0126..494142cd2b9 100644 --- a/api/interfaces/HealthCheckResults.html +++ b/api/interfaces/HealthCheckResults.html @@ -13,7 +13,7 @@ - + @@ -26,7 +26,7 @@

    FailingStreak is the number of consecutive failed healthchecks

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:2513

    +

    packages/extension-api/src/extension-api.d.ts:2513


    Log

    @@ -34,7 +34,7 @@

    Log describes healthcheck attempts and results

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:2517

    +

    packages/extension-api/src/extension-api.d.ts:2517


    Status

    @@ -42,6 +42,6 @@

    Status is starting, healthy or unhealthy

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:2509

    +

    packages/extension-api/src/extension-api.d.ts:2509

    \ No newline at end of file diff --git a/api/interfaces/HealthConfig.html b/api/interfaces/HealthConfig.html index 1fd8bbee821..597aa1f0847 100644 --- a/api/interfaces/HealthConfig.html +++ b/api/interfaces/HealthConfig.html @@ -13,7 +13,7 @@ - + @@ -29,7 +29,7 @@ To get health check result you can use Example
    // Set interval to 1 second
    Interval?: 1000000000;

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:2727

    +

    packages/extension-api/src/extension-api.d.ts:2727


    Retries?

    @@ -39,7 +39,7 @@ To get health check result you can use Example
    // Set retries to 3
    Retries?: 3;

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:2755

    +

    packages/extension-api/src/extension-api.d.ts:2755


    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;

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:2746

    +

    packages/extension-api/src/extension-api.d.ts:2746


    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"];

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:2718

    +

    packages/extension-api/src/extension-api.d.ts:2718


    Timeout?

    @@ -73,6 +73,6 @@ be 0 or at least 1000000 (1 ms). 0 means inherit.

    Example

    // Set timeout to 5 seconds
    Timeout?: 5000000000;

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:2736

    +

    packages/extension-api/src/extension-api.d.ts:2736

    \ No newline at end of file diff --git a/api/interfaces/HostConfig.html b/api/interfaces/HostConfig.html index 90eef0c37f4..509b5f4b2bd 100644 --- a/api/interfaces/HostConfig.html +++ b/api/interfaces/HostConfig.html @@ -13,7 +13,7 @@ - + @@ -24,259 +24,259 @@

    optional AutoRemove: boolean

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:2430

    +

    packages/extension-api/src/extension-api.d.ts:2430


    Binds?

    optional Binds: string[]

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:2431

    +

    packages/extension-api/src/extension-api.d.ts:2431


    BlkioDeviceReadBps?

    optional BlkioDeviceReadBps: unknown

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:2474

    +

    packages/extension-api/src/extension-api.d.ts:2474


    BlkioDeviceReadIOps?

    optional BlkioDeviceReadIOps: unknown

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:2476

    +

    packages/extension-api/src/extension-api.d.ts:2476


    BlkioDeviceWriteBps?

    optional BlkioDeviceWriteBps: unknown

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:2475

    +

    packages/extension-api/src/extension-api.d.ts:2475


    BlkioDeviceWriteIOps?

    optional BlkioDeviceWriteIOps: unknown

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:2477

    +

    packages/extension-api/src/extension-api.d.ts:2477


    BlkioWeight?

    optional BlkioWeight: number

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:2472

    +

    packages/extension-api/src/extension-api.d.ts:2472


    BlkioWeightDevice?

    optional BlkioWeightDevice: unknown

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:2473

    +

    packages/extension-api/src/extension-api.d.ts:2473


    CapAdd?

    optional CapAdd: string[]

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:2443

    +

    packages/extension-api/src/extension-api.d.ts:2443


    CapDrop?

    optional CapDrop: string[]

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:2444

    +

    packages/extension-api/src/extension-api.d.ts:2444


    Cgroup?

    optional Cgroup: string

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:2451

    +

    packages/extension-api/src/extension-api.d.ts:2451


    CgroupParent?

    optional CgroupParent: string

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:2471

    +

    packages/extension-api/src/extension-api.d.ts:2471


    ConsoleSize?

    optional ConsoleSize: number[]

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:2466

    +

    packages/extension-api/src/extension-api.d.ts:2466


    ContainerIDFile?

    optional ContainerIDFile: string

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:2432

    +

    packages/extension-api/src/extension-api.d.ts:2432


    CpuCount?

    optional CpuCount: number

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:2496

    +

    packages/extension-api/src/extension-api.d.ts:2496


    CpuPercent?

    optional CpuPercent: number

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:2497

    +

    packages/extension-api/src/extension-api.d.ts:2497


    CpuPeriod?

    optional CpuPeriod: number

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:2478

    +

    packages/extension-api/src/extension-api.d.ts:2478


    CpuQuota?

    optional CpuQuota: number

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:2479

    +

    packages/extension-api/src/extension-api.d.ts:2479


    CpuRealtimePeriod?

    optional CpuRealtimePeriod: number

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:2498

    +

    packages/extension-api/src/extension-api.d.ts:2498


    CpuRealtimeRuntime?

    optional CpuRealtimeRuntime: number

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:2499

    +

    packages/extension-api/src/extension-api.d.ts:2499


    CpuShares?

    optional CpuShares: number

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:2470

    +

    packages/extension-api/src/extension-api.d.ts:2470


    CpusetCpus?

    optional CpusetCpus: string

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:2480

    +

    packages/extension-api/src/extension-api.d.ts:2480


    CpusetMems?

    optional CpusetMems: string

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:2481

    +

    packages/extension-api/src/extension-api.d.ts:2481


    DeviceCgroupRules?

    optional DeviceCgroupRules: string[]

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:2483

    +

    packages/extension-api/src/extension-api.d.ts:2483


    DeviceRequests?

    optional DeviceRequests: DeviceRequest[]

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:2484

    +

    packages/extension-api/src/extension-api.d.ts:2484


    Devices?

    optional Devices: unknown

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:2482

    +

    packages/extension-api/src/extension-api.d.ts:2482


    DiskQuota?

    optional DiskQuota: number

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:2485

    +

    packages/extension-api/src/extension-api.d.ts:2485


    Dns?

    optional Dns: string[]

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:2445

    +

    packages/extension-api/src/extension-api.d.ts:2445


    DnsOptions?

    optional DnsOptions: unknown[]

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:2446

    +

    packages/extension-api/src/extension-api.d.ts:2446


    DnsSearch?

    optional DnsSearch: string[]

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:2447

    +

    packages/extension-api/src/extension-api.d.ts:2447


    ExtraHosts?

    optional ExtraHosts: string[]

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:2448

    +

    packages/extension-api/src/extension-api.d.ts:2448


    GroupAdd?

    optional GroupAdd: string[]

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:2449

    +

    packages/extension-api/src/extension-api.d.ts:2449


    Init?

    optional Init: boolean

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:2493

    +

    packages/extension-api/src/extension-api.d.ts:2493


    IpcMode?

    optional IpcMode: string

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:2450

    +

    packages/extension-api/src/extension-api.d.ts:2450


    Isolation?

    optional Isolation: string

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:2467

    +

    packages/extension-api/src/extension-api.d.ts:2467


    KernelMemory?

    optional KernelMemory: number

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:2486

    +

    packages/extension-api/src/extension-api.d.ts:2486


    optional Links: unknown

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:2452

    +

    packages/extension-api/src/extension-api.d.ts:2452


    LogConfig?

    @@ -291,154 +291,154 @@

    Type: string

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:2433

    +

    packages/extension-api/src/extension-api.d.ts:2433


    MaskedPaths?

    optional MaskedPaths: string[]

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:2468

    +

    packages/extension-api/src/extension-api.d.ts:2468


    Memory?

    optional Memory: number

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:2487

    +

    packages/extension-api/src/extension-api.d.ts:2487


    MemoryReservation?

    optional MemoryReservation: number

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:2488

    +

    packages/extension-api/src/extension-api.d.ts:2488


    MemorySwap?

    optional MemorySwap: number

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:2489

    +

    packages/extension-api/src/extension-api.d.ts:2489


    MemorySwappiness?

    optional MemorySwappiness: number

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:2490

    +

    packages/extension-api/src/extension-api.d.ts:2490


    Mounts?

    optional Mounts: MountConfig

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:2442

    +

    packages/extension-api/src/extension-api.d.ts:2442


    NanoCpus?

    optional NanoCpus: number

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:2491

    +

    packages/extension-api/src/extension-api.d.ts:2491


    NetworkMode?

    optional NetworkMode: string

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:2437

    +

    packages/extension-api/src/extension-api.d.ts:2437


    OomKillDisable?

    optional OomKillDisable: boolean

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:2492

    +

    packages/extension-api/src/extension-api.d.ts:2492


    OomScoreAdj?

    optional OomScoreAdj: number

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:2453

    +

    packages/extension-api/src/extension-api.d.ts:2453


    PidMode?

    optional PidMode: string

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:2454

    +

    packages/extension-api/src/extension-api.d.ts:2454


    PidsLimit?

    optional PidsLimit: number

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:2494

    +

    packages/extension-api/src/extension-api.d.ts:2494


    PortBindings?

    optional PortBindings: unknown

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:2438

    +

    packages/extension-api/src/extension-api.d.ts:2438


    Privileged?

    optional Privileged: boolean

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:2455

    +

    packages/extension-api/src/extension-api.d.ts:2455


    PublishAllPorts?

    optional PublishAllPorts: boolean

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:2456

    +

    packages/extension-api/src/extension-api.d.ts:2456


    ReadonlyPaths?

    optional ReadonlyPaths: string[]

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:2469

    +

    packages/extension-api/src/extension-api.d.ts:2469


    ReadonlyRootfs?

    optional ReadonlyRootfs: boolean

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:2457

    +

    packages/extension-api/src/extension-api.d.ts:2457


    RestartPolicy?

    optional RestartPolicy: HostRestartPolicy

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:2439

    +

    packages/extension-api/src/extension-api.d.ts:2439


    Runtime?

    optional Runtime: string

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:2465

    +

    packages/extension-api/src/extension-api.d.ts:2465


    SecurityOpt?

    optional SecurityOpt: string[]

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:2458

    +

    packages/extension-api/src/extension-api.d.ts:2458


    ShmSize?

    optional ShmSize: number

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:2463

    +

    packages/extension-api/src/extension-api.d.ts:2463


    StorageOpt?

    @@ -447,7 +447,7 @@

    Index Signature

    [option: string]: string

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:2459

    +

    packages/extension-api/src/extension-api.d.ts:2459


    Sysctls?

    @@ -456,7 +456,7 @@

    Index Signature

    [index: string]: string

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:2464

    +

    packages/extension-api/src/extension-api.d.ts:2464


    Tmpfs?

    @@ -465,41 +465,41 @@

    Index Signature

    [dir: string]: string

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:2460

    +

    packages/extension-api/src/extension-api.d.ts:2460


    UTSMode?

    optional UTSMode: string

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:2461

    +

    packages/extension-api/src/extension-api.d.ts:2461


    Ulimits?

    optional Ulimits: unknown

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:2495

    +

    packages/extension-api/src/extension-api.d.ts:2495


    UsernsMode?

    optional UsernsMode: string

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:2462

    +

    packages/extension-api/src/extension-api.d.ts:2462


    VolumeDriver?

    optional VolumeDriver: string

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:2440

    +

    packages/extension-api/src/extension-api.d.ts:2440


    VolumesFrom?

    optional VolumesFrom: unknown

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:2441

    +

    packages/extension-api/src/extension-api.d.ts:2441

    \ No newline at end of file diff --git a/api/interfaces/HostRestartPolicy.html b/api/interfaces/HostRestartPolicy.html index ea8e111fc93..eaf208404f1 100644 --- a/api/interfaces/HostRestartPolicy.html +++ b/api/interfaces/HostRestartPolicy.html @@ -13,7 +13,7 @@ - + @@ -24,13 +24,13 @@

    optional MaximumRetryCount: number

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:2386

    +

    packages/extension-api/src/extension-api.d.ts:2386


    Name

    Name: string

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:2385

    +

    packages/extension-api/src/extension-api.d.ts:2385

    \ No newline at end of file diff --git a/api/interfaces/IPAM.html b/api/interfaces/IPAM.html index 0ecf4ac7db9..52aa06f27d2 100644 --- a/api/interfaces/IPAM.html +++ b/api/interfaces/IPAM.html @@ -13,7 +13,7 @@ - + @@ -24,14 +24,14 @@

    optional Config: object[]

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:2260

    +

    packages/extension-api/src/extension-api.d.ts:2260


    Driver

    Driver: string

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:2259

    +

    packages/extension-api/src/extension-api.d.ts:2259


    Options?

    @@ -40,6 +40,6 @@

    Index Signature

    [key: string]: string

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:2261

    +

    packages/extension-api/src/extension-api.d.ts:2261

    \ No newline at end of file diff --git a/api/interfaces/ImageCheck.html b/api/interfaces/ImageCheck.html index 211eb8371ee..5fe5be3d1d1 100644 --- a/api/interfaces/ImageCheck.html +++ b/api/interfaces/ImageCheck.html @@ -13,7 +13,7 @@ - + @@ -26,7 +26,7 @@

    full description of the error/recommendation

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:4442

    +

    packages/extension-api/src/extension-api.d.ts:4442


    name

    @@ -34,7 +34,7 @@

    a short and descriptive name for the error/recommendation

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:4430

    +

    packages/extension-api/src/extension-api.d.ts:4430


    severity?

    @@ -42,7 +42,7 @@

    severity of the error/recommendation, when the status is failed

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:4438

    +

    packages/extension-api/src/extension-api.d.ts:4438


    status

    @@ -50,6 +50,6 @@

    either the feedback is positive or negative

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:4434

    +

    packages/extension-api/src/extension-api.d.ts:4434

    \ No newline at end of file diff --git a/api/interfaces/ImageCheckerProvider.html b/api/interfaces/ImageCheckerProvider.html index 307557ae392..56bf33df34d 100644 --- a/api/interfaces/ImageCheckerProvider.html +++ b/api/interfaces/ImageCheckerProvider.html @@ -13,7 +13,7 @@ - + @@ -33,6 +33,6 @@

    ProviderResult<ImageChecks>

    the complete result of the analyze, either synchronously of through a Promise

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:4465

    +

    packages/extension-api/src/extension-api.d.ts:4465

    \ No newline at end of file diff --git a/api/interfaces/ImageCheckerProviderMetadata.html b/api/interfaces/ImageCheckerProviderMetadata.html index 835bd760ee1..e2d6aba1081 100644 --- a/api/interfaces/ImageCheckerProviderMetadata.html +++ b/api/interfaces/ImageCheckerProviderMetadata.html @@ -13,7 +13,7 @@ - + @@ -24,6 +24,6 @@

    readonly label: string

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:4469

    +

    packages/extension-api/src/extension-api.d.ts:4469

    \ No newline at end of file diff --git a/api/interfaces/ImageChecks.html b/api/interfaces/ImageChecks.html index c74ec40abd4..c3df17465fa 100644 --- a/api/interfaces/ImageChecks.html +++ b/api/interfaces/ImageChecks.html @@ -13,7 +13,7 @@ - + @@ -26,6 +26,6 @@

    the list of errors/recommendations found during the image check

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:4452

    +

    packages/extension-api/src/extension-api.d.ts:4452

    \ No newline at end of file diff --git a/api/interfaces/ImageFile.html b/api/interfaces/ImageFile.html index 802f14c890b..a6a89d39678 100644 --- a/api/interfaces/ImageFile.html +++ b/api/interfaces/ImageFile.html @@ -13,7 +13,7 @@ - + @@ -29,62 +29,62 @@

    atime: Date

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:738

    +

    packages/extension-api/src/extension-api.d.ts:738


    ctime

    ctime: Date

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:737

    +

    packages/extension-api/src/extension-api.d.ts:737


    gid

    gid: number

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:735

    +

    packages/extension-api/src/extension-api.d.ts:735


    mode

    mode: number

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:733

    +

    packages/extension-api/src/extension-api.d.ts:733


    mtime

    mtime: Date

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:739

    +

    packages/extension-api/src/extension-api.d.ts:739


    path

    path: string

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:730

    +

    packages/extension-api/src/extension-api.d.ts:730


    size

    size: number

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:736

    +

    packages/extension-api/src/extension-api.d.ts:736


    type

    type: "file" | "directory" | "symlink"

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:731

    +

    packages/extension-api/src/extension-api.d.ts:731


    uid

    uid: number

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:734

    +

    packages/extension-api/src/extension-api.d.ts:734

    \ No newline at end of file diff --git a/api/interfaces/ImageFileSymlink.html b/api/interfaces/ImageFileSymlink.html index f87535edf12..158886f463b 100644 --- a/api/interfaces/ImageFileSymlink.html +++ b/api/interfaces/ImageFileSymlink.html @@ -13,7 +13,7 @@ - + @@ -31,7 +31,7 @@

    Inherited from

    ImageFile.atime

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:738

    +

    packages/extension-api/src/extension-api.d.ts:738


    ctime

    @@ -40,7 +40,7 @@

    Inherited from

    ImageFile.ctime

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:737

    +

    packages/extension-api/src/extension-api.d.ts:737


    gid

    @@ -49,14 +49,14 @@

    Inherited from

    ImageFile.gid

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:735

    +

    packages/extension-api/src/extension-api.d.ts:735


    linkPath

    linkPath: string

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:748

    +

    packages/extension-api/src/extension-api.d.ts:748


    mode

    @@ -65,7 +65,7 @@

    Inherited from

    ImageFile.mode

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:733

    +

    packages/extension-api/src/extension-api.d.ts:733


    mtime

    @@ -74,7 +74,7 @@

    Inherited from

    ImageFile.mtime

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:739

    +

    packages/extension-api/src/extension-api.d.ts:739


    path

    @@ -83,7 +83,7 @@

    Inherited from

    ImageFile.path

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:730

    +

    packages/extension-api/src/extension-api.d.ts:730


    size

    @@ -92,7 +92,7 @@

    Inherited from

    ImageFile.size

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:736

    +

    packages/extension-api/src/extension-api.d.ts:736


    type

    @@ -101,7 +101,7 @@

    Overrides

    ImageFile.type

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:746

    +

    packages/extension-api/src/extension-api.d.ts:746


    uid

    @@ -110,6 +110,6 @@

    Inherited from

    ImageFile.uid

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:734

    +

    packages/extension-api/src/extension-api.d.ts:734

    \ No newline at end of file diff --git a/api/interfaces/ImageFilesCallbacks.html b/api/interfaces/ImageFilesCallbacks.html index 3ef26c62849..6c19bbe43f3 100644 --- a/api/interfaces/ImageFilesCallbacks.html +++ b/api/interfaces/ImageFilesCallbacks.html @@ -13,7 +13,7 @@ - + @@ -33,6 +33,6 @@

    ProviderResult<ImageFilesystemLayers>

    the complete result of the layers, either synchronously of through a Promise

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:794

    +

    packages/extension-api/src/extension-api.d.ts:794

    \ No newline at end of file diff --git a/api/interfaces/ImageFilesProvider.html b/api/interfaces/ImageFilesProvider.html index 838512de3e1..db3cfb971ec 100644 --- a/api/interfaces/ImageFilesProvider.html +++ b/api/interfaces/ImageFilesProvider.html @@ -13,7 +13,7 @@ - + @@ -38,7 +38,7 @@ Provides helper functions for building the response of the createImageFile

    Returns

    ImageFilesProvider

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:809

    +

    packages/extension-api/src/extension-api.d.ts:809


    addFile()

    @@ -54,7 +54,7 @@ Provides helper functions for building the response of the createImageFile

    Returns

    ImageFilesProvider

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:805

    +

    packages/extension-api/src/extension-api.d.ts:805


    addOpaqueWhiteout()

    @@ -67,7 +67,7 @@ Provides helper functions for building the response of the createImageFile

    Returns

    ImageFilesProvider

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:823

    +

    packages/extension-api/src/extension-api.d.ts:823


    @@ -83,7 +83,7 @@ Provides helper functions for building the response of the createImageFile

    Returns

    ImageFilesProvider

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:813

    +

    packages/extension-api/src/extension-api.d.ts:813


    addWhiteout()

    @@ -96,7 +96,7 @@ Provides helper functions for building the response of the createImageFile

    Returns

    ImageFilesProvider

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:818

    +

    packages/extension-api/src/extension-api.d.ts:818


    dispose()

    @@ -108,6 +108,6 @@ Provides helper functions for building the response of the createImageFile

    Inherited from

    Disposable.dispose

    Defined in

    -

    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/ImageFilesProviderMetadata.html b/api/interfaces/ImageFilesProviderMetadata.html index 60a650edf95..c2cc791bc57 100644 --- a/api/interfaces/ImageFilesProviderMetadata.html +++ b/api/interfaces/ImageFilesProviderMetadata.html @@ -13,7 +13,7 @@ - + @@ -24,6 +24,6 @@

    readonly label: string

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:827

    +

    packages/extension-api/src/extension-api.d.ts:827

    \ No newline at end of file diff --git a/api/interfaces/ImageFilesystemLayer.html b/api/interfaces/ImageFilesystemLayer.html index a821be421de..8c44fc8d7dd 100644 --- a/api/interfaces/ImageFilesystemLayer.html +++ b/api/interfaces/ImageFilesystemLayer.html @@ -13,7 +13,7 @@ - + @@ -26,7 +26,7 @@

    the command which created the layer

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:762

    +

    packages/extension-api/src/extension-api.d.ts:762


    files?

    @@ -34,7 +34,7 @@

    files indicate the paths of the files added or modified in the layer

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:766

    +

    packages/extension-api/src/extension-api.d.ts:766


    id

    @@ -42,7 +42,7 @@

    unique id of the layer

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:758

    +

    packages/extension-api/src/extension-api.d.ts:758


    opaqueWhiteouts?

    @@ -50,7 +50,7 @@

    opaque whiteouts indicate the directories in which the content has to be completely deleted from previous layers.

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:774

    +

    packages/extension-api/src/extension-api.d.ts:774


    whiteouts?

    @@ -58,6 +58,6 @@

    whiteouts indicate the paths of the files to be deleted from previous layers.

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:770

    +

    packages/extension-api/src/extension-api.d.ts:770

    \ No newline at end of file diff --git a/api/interfaces/ImageFilesystemLayers.html b/api/interfaces/ImageFilesystemLayers.html index 0a1cfd0d656..317f7fdf2af 100644 --- a/api/interfaces/ImageFilesystemLayers.html +++ b/api/interfaces/ImageFilesystemLayers.html @@ -13,7 +13,7 @@ - + @@ -25,6 +25,6 @@

    layers: ImageFilesystemLayer[]

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:781

    +

    packages/extension-api/src/extension-api.d.ts:781

    \ No newline at end of file diff --git a/api/interfaces/ImageInfo.html b/api/interfaces/ImageInfo.html index 4d93fb36828..6e6941e2921 100644 --- a/api/interfaces/ImageInfo.html +++ b/api/interfaces/ImageInfo.html @@ -13,7 +13,7 @@ - + @@ -24,35 +24,35 @@

    Containers: number

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:2169

    +

    packages/extension-api/src/extension-api.d.ts:2169


    Created

    Created: number

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:2164

    +

    packages/extension-api/src/extension-api.d.ts:2164


    Digest

    Digest: string

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:2171

    +

    packages/extension-api/src/extension-api.d.ts:2171


    History?

    optional History: string[]

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:2170

    +

    packages/extension-api/src/extension-api.d.ts:2170


    Id

    Id: string

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:2160

    +

    packages/extension-api/src/extension-api.d.ts:2160


    Labels

    @@ -61,69 +61,69 @@

    Index Signature

    [label: string]: string

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:2168

    +

    packages/extension-api/src/extension-api.d.ts:2168


    ParentId

    ParentId: string

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:2161

    +

    packages/extension-api/src/extension-api.d.ts:2161


    RepoDigests?

    optional RepoDigests: string[]

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:2163

    +

    packages/extension-api/src/extension-api.d.ts:2163


    RepoTags

    RepoTags: undefined | string[]

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:2162

    +

    packages/extension-api/src/extension-api.d.ts:2162


    SharedSize

    SharedSize: number

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:2167

    +

    packages/extension-api/src/extension-api.d.ts:2167


    Size

    Size: number

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:2165

    +

    packages/extension-api/src/extension-api.d.ts:2165


    VirtualSize

    VirtualSize: number

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:2166

    +

    packages/extension-api/src/extension-api.d.ts:2166


    engineId

    engineId: string

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:2158

    +

    packages/extension-api/src/extension-api.d.ts:2158


    engineName

    engineName: string

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:2159

    +

    packages/extension-api/src/extension-api.d.ts:2159


    isManifest?

    optional isManifest: boolean

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:2174

    +

    packages/extension-api/src/extension-api.d.ts:2174

    \ No newline at end of file diff --git a/api/interfaces/ImageInspectInfo.html b/api/interfaces/ImageInspectInfo.html index eb650ac0785..ed5e5ddfb34 100644 --- a/api/interfaces/ImageInspectInfo.html +++ b/api/interfaces/ImageInspectInfo.html @@ -13,7 +13,7 @@ - + @@ -24,21 +24,21 @@

    Architecture: string

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:2231

    +

    packages/extension-api/src/extension-api.d.ts:2231


    Author

    Author: string

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:2209

    +

    packages/extension-api/src/extension-api.d.ts:2209


    Comment

    Comment: string

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:2184

    +

    packages/extension-api/src/extension-api.d.ts:2184


    Config

    @@ -127,14 +127,14 @@

    WorkingDir: string

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:2210

    +

    packages/extension-api/src/extension-api.d.ts:2210


    Container

    Container: string

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:2186

    +

    packages/extension-api/src/extension-api.d.ts:2186


    ContainerConfig

    @@ -223,21 +223,21 @@

    WorkingDir: string

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:2187

    +

    packages/extension-api/src/extension-api.d.ts:2187


    Created

    Created: string

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:2185

    +

    packages/extension-api/src/extension-api.d.ts:2185


    DockerVersion

    DockerVersion: string

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:2208

    +

    packages/extension-api/src/extension-api.d.ts:2208


    GraphDriver

    @@ -264,42 +264,42 @@

    Name: string

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:2235

    +

    packages/extension-api/src/extension-api.d.ts:2235


    Id

    Id: string

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:2180

    +

    packages/extension-api/src/extension-api.d.ts:2180


    Os

    Os: string

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:2232

    +

    packages/extension-api/src/extension-api.d.ts:2232


    Parent

    Parent: string

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:2183

    +

    packages/extension-api/src/extension-api.d.ts:2183


    RepoDigests

    RepoDigests: string[]

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:2182

    +

    packages/extension-api/src/extension-api.d.ts:2182


    RepoTags

    RepoTags: string[]

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:2181

    +

    packages/extension-api/src/extension-api.d.ts:2181


    RootFS

    @@ -318,34 +318,34 @@

    Type: string

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:2243

    +

    packages/extension-api/src/extension-api.d.ts:2243


    Size

    Size: number

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:2233

    +

    packages/extension-api/src/extension-api.d.ts:2233


    VirtualSize

    VirtualSize: number

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:2234

    +

    packages/extension-api/src/extension-api.d.ts:2234


    engineId

    engineId: string

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:2178

    +

    packages/extension-api/src/extension-api.d.ts:2178


    engineName

    engineName: string

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:2179

    +

    packages/extension-api/src/extension-api.d.ts:2179

    \ No newline at end of file diff --git a/api/interfaces/InputBoxOptions.html b/api/interfaces/InputBoxOptions.html index 4f5fdfa5c91..be65b72743b 100644 --- a/api/interfaces/InputBoxOptions.html +++ b/api/interfaces/InputBoxOptions.html @@ -13,7 +13,7 @@ - + @@ -27,7 +27,7 @@

    Set to true to keep the input box open when focus moves to another part of the editor or to another window. This setting is ignored on iPad and is always false.

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:1181

    +

    packages/extension-api/src/extension-api.d.ts:1181


    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)

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:1165

    +

    packages/extension-api/src/extension-api.d.ts:1165


    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.

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:1186

    +

    packages/extension-api/src/extension-api.d.ts:1186


    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.

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:1175

    +

    packages/extension-api/src/extension-api.d.ts:1175


    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.

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:1170

    +

    packages/extension-api/src/extension-api.d.ts:1170


    prompt?

    @@ -67,7 +67,7 @@ This setting is ignored on iPad and is always false.

    The text to display underneath the input box.

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:1160

    +

    packages/extension-api/src/extension-api.d.ts:1160


    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.

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:1142

    +

    packages/extension-api/src/extension-api.d.ts:1142


    value?

    @@ -83,7 +83,7 @@ This setting is ignored on iPad and is always false.

    The value to pre-fill in the input box.

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:1147

    +

    packages/extension-api/src/extension-api.d.ts:1147


    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.

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:1155

    +

    packages/extension-api/src/extension-api.d.ts:1155

    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.

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:1196

    +

    packages/extension-api/src/extension-api.d.ts:1196

    \ No newline at end of file diff --git a/api/interfaces/InputBoxValidationMessage.html b/api/interfaces/InputBoxValidationMessage.html index a4aeddda4a8..ccd95fc250c 100644 --- a/api/interfaces/InputBoxValidationMessage.html +++ b/api/interfaces/InputBoxValidationMessage.html @@ -13,7 +13,7 @@ - + @@ -26,7 +26,7 @@

    The validation message to display.

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:1125

    +

    packages/extension-api/src/extension-api.d.ts:1125


    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.

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:1132

    +

    packages/extension-api/src/extension-api.d.ts:1132

    \ No newline at end of file diff --git a/api/interfaces/InstallCheck.html b/api/interfaces/InstallCheck.html index af0c1cea5bd..f13afb1b577 100644 --- a/api/interfaces/InstallCheck.html +++ b/api/interfaces/InstallCheck.html @@ -13,7 +13,7 @@ - + @@ -24,7 +24,7 @@

    title: string

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:553

    +

    packages/extension-api/src/extension-api.d.ts:553

    Methods

    execute()

    @@ -33,7 +33,7 @@

    Returns

    Promise<CheckResult>

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:554

    +

    packages/extension-api/src/extension-api.d.ts:554


    init()?

    @@ -42,6 +42,6 @@

    Returns

    Promise<void>

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:555

    +

    packages/extension-api/src/extension-api.d.ts:555

    \ No newline at end of file diff --git a/api/interfaces/KubeconfigUpdateEvent.html b/api/interfaces/KubeconfigUpdateEvent.html index 378b41600da..9aee8718966 100644 --- a/api/interfaces/KubeconfigUpdateEvent.html +++ b/api/interfaces/KubeconfigUpdateEvent.html @@ -13,7 +13,7 @@ - + @@ -25,13 +25,13 @@

    readonly location: Uri

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:2126

    +

    packages/extension-api/src/extension-api.d.ts:2126


    type

    readonly type: "CREATE" | "UPDATE" | "DELETE"

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:2125

    +

    packages/extension-api/src/extension-api.d.ts:2125

    \ No newline at end of file diff --git a/api/interfaces/KubernetesGeneratorProvider.html b/api/interfaces/KubernetesGeneratorProvider.html index 8cd6008dc31..27f8a47a705 100644 --- a/api/interfaces/KubernetesGeneratorProvider.html +++ b/api/interfaces/KubernetesGeneratorProvider.html @@ -13,7 +13,7 @@ - + @@ -26,14 +26,14 @@ KubernetesGeneratorType.

    name: string

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:2152

    +

    packages/extension-api/src/extension-api.d.ts:2152


    types

    types: KubernetesGeneratorSelector

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:2153

    +

    packages/extension-api/src/extension-api.d.ts:2153

    Methods

    generate()

    @@ -44,6 +44,6 @@ KubernetesGeneratorType.

    Returns

    Promise<GenerateKubeResult>

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:2154

    +

    packages/extension-api/src/extension-api.d.ts:2154

    \ No newline at end of file diff --git a/api/interfaces/KubernetesProviderConnection.html b/api/interfaces/KubernetesProviderConnection.html index 116c3c6907a..624adfa482e 100644 --- a/api/interfaces/KubernetesProviderConnection.html +++ b/api/interfaces/KubernetesProviderConnection.html @@ -13,7 +13,7 @@ - + @@ -24,21 +24,21 @@

    endpoint: KubernetesProviderConnectionEndpoint

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:485

    +

    packages/extension-api/src/extension-api.d.ts:485


    lifecycle?

    optional lifecycle: ProviderConnectionLifecycle

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:486

    +

    packages/extension-api/src/extension-api.d.ts:486


    name

    name: string

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:484

    +

    packages/extension-api/src/extension-api.d.ts:484

    Methods

    status()

    @@ -47,6 +47,6 @@

    Returns

    ProviderConnectionStatus

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:487

    +

    packages/extension-api/src/extension-api.d.ts:487

    \ No newline at end of file diff --git a/api/interfaces/KubernetesProviderConnectionEndpoint.html b/api/interfaces/KubernetesProviderConnectionEndpoint.html index 64680c67e18..17404d164c9 100644 --- a/api/interfaces/KubernetesProviderConnectionEndpoint.html +++ b/api/interfaces/KubernetesProviderConnectionEndpoint.html @@ -13,7 +13,7 @@ - + @@ -24,6 +24,6 @@

    apiURL: string

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:481

    +

    packages/extension-api/src/extension-api.d.ts:481

    \ No newline at end of file diff --git a/api/interfaces/KubernetesProviderConnectionFactory.html b/api/interfaces/KubernetesProviderConnectionFactory.html index 05e02a1de72..c34506c8bd4 100644 --- a/api/interfaces/KubernetesProviderConnectionFactory.html +++ b/api/interfaces/KubernetesProviderConnectionFactory.html @@ -13,7 +13,7 @@ - + @@ -30,7 +30,7 @@

    Inherited from

    ProviderConnectionFactory.creationButtonTitle

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:499

    +

    packages/extension-api/src/extension-api.d.ts:499


    creationDisplayName?

    @@ -39,7 +39,7 @@

    Inherited from

    ProviderConnectionFactory.creationDisplayName

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:496

    +

    packages/extension-api/src/extension-api.d.ts:496

    Methods

    create()?

    @@ -52,7 +52,7 @@

    Returns

    Promise<void>

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:511

    +

    packages/extension-api/src/extension-api.d.ts:511


    initialize()?

    @@ -63,6 +63,6 @@

    Inherited from

    ProviderConnectionFactory.initialize

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:493

    +

    packages/extension-api/src/extension-api.d.ts:493

    \ No newline at end of file diff --git a/api/interfaces/LifecycleContext.html b/api/interfaces/LifecycleContext.html index 7d1d9ab8b33..9dc3c14c3e8 100644 --- a/api/interfaces/LifecycleContext.html +++ b/api/interfaces/LifecycleContext.html @@ -13,7 +13,7 @@ - + @@ -24,6 +24,6 @@

    log: Logger

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:339

    +

    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 f4324f9b814..81b7dcdc148 100644 --- a/api/interfaces/Link.html +++ b/api/interfaces/Link.html @@ -13,7 +13,7 @@ - + @@ -24,20 +24,20 @@

    optional group: string

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:535

    +

    packages/extension-api/src/extension-api.d.ts:535


    title

    title: string

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:533

    +

    packages/extension-api/src/extension-api.d.ts:533


    url

    url: string

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:534

    +

    packages/extension-api/src/extension-api.d.ts:534

    \ No newline at end of file diff --git a/api/interfaces/ListImagesOptions.html b/api/interfaces/ListImagesOptions.html index ca7b85d7042..be2a8876e6c 100644 --- a/api/interfaces/ListImagesOptions.html +++ b/api/interfaces/ListImagesOptions.html @@ -13,7 +13,7 @@ - + @@ -27,6 +27,6 @@

    Default Value

    undefined

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:3347

    +

    packages/extension-api/src/extension-api.d.ts:3347

    \ No newline at end of file diff --git a/api/interfaces/ListInfosOptions.html b/api/interfaces/ListInfosOptions.html index 4dfb7a1b239..ce42054489f 100644 --- a/api/interfaces/ListInfosOptions.html +++ b/api/interfaces/ListInfosOptions.html @@ -13,7 +13,7 @@ - + @@ -27,6 +27,6 @@

    Default Value

    undefined

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:3451

    +

    packages/extension-api/src/extension-api.d.ts:3451

    \ No newline at end of file diff --git a/api/interfaces/Logger.html b/api/interfaces/Logger.html index 4319d4e952e..cb89551acc3 100644 --- a/api/interfaces/Logger.html +++ b/api/interfaces/Logger.html @@ -13,7 +13,7 @@ - + @@ -28,7 +28,7 @@

    Returns

    void

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:333

    +

    packages/extension-api/src/extension-api.d.ts:333


    log()

    @@ -39,7 +39,7 @@

    Returns

    void

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:331

    +

    packages/extension-api/src/extension-api.d.ts:331


    warn()

    @@ -50,6 +50,6 @@

    Returns

    void

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:335

    +

    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 2e2e7412fc2..d854444a8e4 100644 --- a/api/interfaces/ManifestCreateOptions.html +++ b/api/interfaces/ManifestCreateOptions.html @@ -13,7 +13,7 @@ - + @@ -24,34 +24,34 @@

    optional all: boolean

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:436

    +

    packages/extension-api/src/extension-api.d.ts:436


    amend?

    optional amend: boolean

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:435

    +

    packages/extension-api/src/extension-api.d.ts:435


    images

    images: string[]

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:433

    +

    packages/extension-api/src/extension-api.d.ts:433


    name

    name: string

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:434

    +

    packages/extension-api/src/extension-api.d.ts:434


    provider?

    optional provider: ContainerProviderConnection

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:439

    +

    packages/extension-api/src/extension-api.d.ts:439

    \ No newline at end of file diff --git a/api/interfaces/ManifestInspectInfo.html b/api/interfaces/ManifestInspectInfo.html index 4bcb5964143..e4f8c945c30 100644 --- a/api/interfaces/ManifestInspectInfo.html +++ b/api/interfaces/ManifestInspectInfo.html @@ -13,7 +13,7 @@ - + @@ -24,34 +24,34 @@

    engineId: string

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:462

    +

    packages/extension-api/src/extension-api.d.ts:462


    engineName

    engineName: string

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:463

    +

    packages/extension-api/src/extension-api.d.ts:463


    manifests

    manifests: object[]

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:464

    +

    packages/extension-api/src/extension-api.d.ts:464


    mediaType

    mediaType: string

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:476

    +

    packages/extension-api/src/extension-api.d.ts:476


    schemaVersion

    schemaVersion: number

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:477

    +

    packages/extension-api/src/extension-api.d.ts:477

    \ No newline at end of file diff --git a/api/interfaces/ManifestPushOptions.html b/api/interfaces/ManifestPushOptions.html index 5b9c86a63cc..8e019acce34 100644 --- a/api/interfaces/ManifestPushOptions.html +++ b/api/interfaces/ManifestPushOptions.html @@ -13,7 +13,7 @@ - + @@ -28,7 +28,7 @@ this can be the same as 'name' or a different one.

    Example

    "quay.io/myrepo/myotherdestination"

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:450

    +

    packages/extension-api/src/extension-api.d.ts:450


    name

    @@ -38,13 +38,13 @@ this can be the same as 'name' or a different one.

    Example

    "quay.io/myrepo/mymanifest"

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:456

    +

    packages/extension-api/src/extension-api.d.ts:456


    provider?

    optional provider: ContainerProviderConnection

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:458

    +

    packages/extension-api/src/extension-api.d.ts:458

    \ No newline at end of file diff --git a/api/interfaces/MemoryStats.html b/api/interfaces/MemoryStats.html index 3425155f699..7455732c3b9 100644 --- a/api/interfaces/MemoryStats.html +++ b/api/interfaces/MemoryStats.html @@ -13,7 +13,7 @@ - + @@ -24,42 +24,42 @@

    optional commitbytes: number

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:3147

    +

    packages/extension-api/src/extension-api.d.ts:3147


    commitpeakbytes?

    optional commitpeakbytes: number

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:3148

    +

    packages/extension-api/src/extension-api.d.ts:3148


    failcnt

    failcnt: number

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:3143

    +

    packages/extension-api/src/extension-api.d.ts:3143


    limit

    limit: number

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:3144

    +

    packages/extension-api/src/extension-api.d.ts:3144


    max_usage

    max_usage: number

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:3141

    +

    packages/extension-api/src/extension-api.d.ts:3141


    privateworkingset?

    optional privateworkingset: number

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:3149

    +

    packages/extension-api/src/extension-api.d.ts:3149


    stats

    @@ -182,13 +182,13 @@

    writeback: number

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:3110

    +

    packages/extension-api/src/extension-api.d.ts:3110


    usage

    usage: number

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:3142

    +

    packages/extension-api/src/extension-api.d.ts:3142

    \ No newline at end of file diff --git a/api/interfaces/MenuItem.html b/api/interfaces/MenuItem.html index 4b5bf735cf6..a84fcf59283 100644 --- a/api/interfaces/MenuItem.html +++ b/api/interfaces/MenuItem.html @@ -13,7 +13,7 @@ - + @@ -25,7 +25,7 @@

    Should only be specified for checkbox or radio type menu items.

    Defined in

    -

    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.

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:71

    +

    packages/extension-api/src/extension-api.d.ts:71


    icon?

    optional icon: string

    Defined in

    -

    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

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:62

    +

    packages/extension-api/src/extension-api.d.ts:62


    label?

    optional label: string

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:65

    +

    packages/extension-api/src/extension-api.d.ts:65


    optional submenu: MenuItem[]

    Defined in

    -

    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"

    Defined in

    -

    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.

    Defined in

    -

    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 f3307728b07..b3bb157c85e 100644 --- a/api/interfaces/MountSettings.html +++ b/api/interfaces/MountSettings.html @@ -13,7 +13,7 @@ - + @@ -28,42 +28,42 @@

    Propagation: MountPropagation

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:2402

    +

    packages/extension-api/src/extension-api.d.ts:2402


    Consistency?

    optional Consistency: MountConsistency

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:2400

    +

    packages/extension-api/src/extension-api.d.ts:2400


    Mode?

    optional Mode: string

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:2401

    +

    packages/extension-api/src/extension-api.d.ts:2401


    ReadOnly?

    optional ReadOnly: boolean

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:2399

    +

    packages/extension-api/src/extension-api.d.ts:2399


    Source

    Source: string

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:2397

    +

    packages/extension-api/src/extension-api.d.ts:2397


    Target

    Target: string

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:2396

    +

    packages/extension-api/src/extension-api.d.ts:2396


    TmpfsOptions?

    @@ -78,14 +78,14 @@

    SizeBytes: number

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:2413

    +

    packages/extension-api/src/extension-api.d.ts:2413


    Type

    Type: MountType

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:2398

    +

    packages/extension-api/src/extension-api.d.ts:2398


    VolumeOptions?

    @@ -116,6 +116,6 @@

    NoCopy: boolean

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:2405

    +

    packages/extension-api/src/extension-api.d.ts:2405

    \ No newline at end of file diff --git a/api/interfaces/NetworkContainer.html b/api/interfaces/NetworkContainer.html index b442e094138..7a6f105cb7c 100644 --- a/api/interfaces/NetworkContainer.html +++ b/api/interfaces/NetworkContainer.html @@ -13,7 +13,7 @@ - + @@ -24,34 +24,34 @@

    EndpointID: string

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:2252

    +

    packages/extension-api/src/extension-api.d.ts:2252


    IPv4Address

    IPv4Address: string

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:2254

    +

    packages/extension-api/src/extension-api.d.ts:2254


    IPv6Address

    IPv6Address: string

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:2255

    +

    packages/extension-api/src/extension-api.d.ts:2255


    MacAddress

    MacAddress: string

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:2253

    +

    packages/extension-api/src/extension-api.d.ts:2253


    Name

    Name: string

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:2251

    +

    packages/extension-api/src/extension-api.d.ts:2251

    \ No newline at end of file diff --git a/api/interfaces/NetworkCreateOptions.html b/api/interfaces/NetworkCreateOptions.html index 52538af3e14..0c4e3efa5a0 100644 --- a/api/interfaces/NetworkCreateOptions.html +++ b/api/interfaces/NetworkCreateOptions.html @@ -13,7 +13,7 @@ - + @@ -24,6 +24,6 @@

    Name: string

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:3351

    +

    packages/extension-api/src/extension-api.d.ts:3351

    \ No newline at end of file diff --git a/api/interfaces/NetworkCreateResult.html b/api/interfaces/NetworkCreateResult.html index ac8165cc6e7..b48ffa15570 100644 --- a/api/interfaces/NetworkCreateResult.html +++ b/api/interfaces/NetworkCreateResult.html @@ -13,7 +13,7 @@ - + @@ -24,6 +24,6 @@

    Id: string

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:3355

    +

    packages/extension-api/src/extension-api.d.ts:3355

    \ No newline at end of file diff --git a/api/interfaces/NetworkInfo.html b/api/interfaces/NetworkInfo.html index e7c02b9bb99..d30ad5882a0 100644 --- a/api/interfaces/NetworkInfo.html +++ b/api/interfaces/NetworkInfo.html @@ -13,7 +13,7 @@ - + @@ -24,83 +24,83 @@

    optional Aliases: unknown

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:2327

    +

    packages/extension-api/src/extension-api.d.ts:2327


    EndpointID

    EndpointID: string

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:2329

    +

    packages/extension-api/src/extension-api.d.ts:2329


    Gateway

    Gateway: string

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:2330

    +

    packages/extension-api/src/extension-api.d.ts:2330


    GlobalIPv6Address

    GlobalIPv6Address: string

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:2334

    +

    packages/extension-api/src/extension-api.d.ts:2334


    GlobalIPv6PrefixLen

    GlobalIPv6PrefixLen: number

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:2335

    +

    packages/extension-api/src/extension-api.d.ts:2335


    IPAMConfig?

    optional IPAMConfig: unknown

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:2325

    +

    packages/extension-api/src/extension-api.d.ts:2325


    IPAddress

    IPAddress: string

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:2331

    +

    packages/extension-api/src/extension-api.d.ts:2331


    IPPrefixLen

    IPPrefixLen: number

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:2332

    +

    packages/extension-api/src/extension-api.d.ts:2332


    IPv6Gateway

    IPv6Gateway: string

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:2333

    +

    packages/extension-api/src/extension-api.d.ts:2333


    optional Links: unknown

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:2326

    +

    packages/extension-api/src/extension-api.d.ts:2326


    MacAddress

    MacAddress: string

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:2336

    +

    packages/extension-api/src/extension-api.d.ts:2336


    NetworkID

    NetworkID: string

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:2328

    +

    packages/extension-api/src/extension-api.d.ts:2328

    \ No newline at end of file diff --git a/api/interfaces/NetworkInspectInfo.html b/api/interfaces/NetworkInspectInfo.html index 77b390dbe59..754fea8cab4 100644 --- a/api/interfaces/NetworkInspectInfo.html +++ b/api/interfaces/NetworkInspectInfo.html @@ -13,7 +13,7 @@ - + @@ -24,7 +24,7 @@

    Attachable: boolean

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:2276

    +

    packages/extension-api/src/extension-api.d.ts:2276


    ConfigFrom?

    @@ -35,14 +35,14 @@

    Network: string

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:2278

    +

    packages/extension-api/src/extension-api.d.ts:2278


    ConfigOnly

    ConfigOnly: boolean

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:2279

    +

    packages/extension-api/src/extension-api.d.ts:2279


    Containers?

    @@ -51,56 +51,56 @@

    Index Signature

    [id: string]: NetworkContainer

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:2280

    +

    packages/extension-api/src/extension-api.d.ts:2280


    Created

    Created: string

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:2270

    +

    packages/extension-api/src/extension-api.d.ts:2270


    Driver

    Driver: string

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:2272

    +

    packages/extension-api/src/extension-api.d.ts:2272


    EnableIPv6

    EnableIPv6: boolean

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:2273

    +

    packages/extension-api/src/extension-api.d.ts:2273


    IPAM?

    optional IPAM: IPAM

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:2274

    +

    packages/extension-api/src/extension-api.d.ts:2274


    Id

    Id: string

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:2269

    +

    packages/extension-api/src/extension-api.d.ts:2269


    Ingress

    Ingress: boolean

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:2277

    +

    packages/extension-api/src/extension-api.d.ts:2277


    Internal

    Internal: boolean

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:2275

    +

    packages/extension-api/src/extension-api.d.ts:2275


    Labels?

    @@ -109,14 +109,14 @@

    Index Signature

    [key: string]: string

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:2282

    +

    packages/extension-api/src/extension-api.d.ts:2282


    Name

    Name: string

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:2268

    +

    packages/extension-api/src/extension-api.d.ts:2268


    Options?

    @@ -125,34 +125,34 @@

    Index Signature

    [key: string]: string

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:2281

    +

    packages/extension-api/src/extension-api.d.ts:2281


    Scope

    Scope: string

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:2271

    +

    packages/extension-api/src/extension-api.d.ts:2271


    engineId

    engineId: string

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:2265

    +

    packages/extension-api/src/extension-api.d.ts:2265


    engineName

    engineName: string

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:2266

    +

    packages/extension-api/src/extension-api.d.ts:2266


    engineType

    engineType: "docker" | "podman"

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:2267

    +

    packages/extension-api/src/extension-api.d.ts:2267

    \ No newline at end of file diff --git a/api/interfaces/NetworkStats.html b/api/interfaces/NetworkStats.html index 1b74fa8e274..d47a1fba23a 100644 --- a/api/interfaces/NetworkStats.html +++ b/api/interfaces/NetworkStats.html @@ -13,7 +13,7 @@ - + diff --git a/api/interfaces/NetworkingConfig.html b/api/interfaces/NetworkingConfig.html index 685a12e61f5..0e793ba93d4 100644 --- a/api/interfaces/NetworkingConfig.html +++ b/api/interfaces/NetworkingConfig.html @@ -13,7 +13,7 @@ - + @@ -26,6 +26,6 @@

    Index Signature

    [key: string]: EndpointSettings

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:2836

    +

    packages/extension-api/src/extension-api.d.ts:2836

    \ No newline at end of file diff --git a/api/interfaces/NotificationOptions.html b/api/interfaces/NotificationOptions.html index b23fdde14dc..9fe99537efb 100644 --- a/api/interfaces/NotificationOptions.html +++ b/api/interfaces/NotificationOptions.html @@ -13,7 +13,7 @@ - + @@ -25,7 +25,7 @@

    The body text of the notification, which will be displayed below the title.

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:1461

    +

    packages/extension-api/src/extension-api.d.ts:1461


    highlight?

    @@ -33,7 +33,7 @@

    this notification will be highlighted to the user so it draws attention

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:1477

    +

    packages/extension-api/src/extension-api.d.ts:1477


    markdownActions?

    @@ -41,7 +41,7 @@

    displayed below the description. It contains actions (like markdown commands/buttons and links)

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:1473

    +

    packages/extension-api/src/extension-api.d.ts:1473


    silent?

    @@ -49,7 +49,7 @@

    Whether or not to emit an OS notification noise when showing the notification.

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:1465

    +

    packages/extension-api/src/extension-api.d.ts:1465


    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.

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:1457

    +

    packages/extension-api/src/extension-api.d.ts:1457


    type?

    @@ -65,6 +65,6 @@

    The type of the notification. Default value: info

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:1469

    +

    packages/extension-api/src/extension-api.d.ts:1469

    \ No newline at end of file diff --git a/api/interfaces/OpenDialogOptions.html b/api/interfaces/OpenDialogOptions.html index 6bbe7973f6f..d59fc1ab357 100644 --- a/api/interfaces/OpenDialogOptions.html +++ b/api/interfaces/OpenDialogOptions.html @@ -13,7 +13,7 @@ - + @@ -26,7 +26,7 @@

    The resource the dialog shows when opened.

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:1819

    +

    packages/extension-api/src/extension-api.d.ts:1819


    filters?

    @@ -34,7 +34,7 @@

    A set of file filters that are used by the dialog.

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:1835

    +

    packages/extension-api/src/extension-api.d.ts:1835


    openLabel?

    @@ -42,7 +42,7 @@

    A human-readable string for the open button.

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:1824

    +

    packages/extension-api/src/extension-api.d.ts:1824


    selectors?

    @@ -51,7 +51,7 @@

    Contains which features the dialog should use. The following values are supported:

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:1830

    +

    packages/extension-api/src/extension-api.d.ts:1830


    title?

    @@ -59,6 +59,6 @@ supported:

    Dialog title.

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:1843

    +

    packages/extension-api/src/extension-api.d.ts:1843

    \ No newline at end of file diff --git a/api/interfaces/PidsStats.html b/api/interfaces/PidsStats.html index 2fca6f533cf..202811d42d3 100644 --- a/api/interfaces/PidsStats.html +++ b/api/interfaces/PidsStats.html @@ -13,7 +13,7 @@ - + @@ -24,13 +24,13 @@

    optional current: number

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:3064

    +

    packages/extension-api/src/extension-api.d.ts:3064


    limit?

    optional limit: number

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:3065

    +

    packages/extension-api/src/extension-api.d.ts:3065

    \ No newline at end of file diff --git a/api/interfaces/PodContainerInfo.html b/api/interfaces/PodContainerInfo.html index f61edc10ebe..52da587e4f1 100644 --- a/api/interfaces/PodContainerInfo.html +++ b/api/interfaces/PodContainerInfo.html @@ -13,7 +13,7 @@ - + @@ -24,20 +24,20 @@

    Id: string

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:2340

    +

    packages/extension-api/src/extension-api.d.ts:2340


    Names

    Names: string

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:2341

    +

    packages/extension-api/src/extension-api.d.ts:2341


    Status

    Status: string

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:2342

    +

    packages/extension-api/src/extension-api.d.ts:2342

    \ No newline at end of file diff --git a/api/interfaces/PodCreateOptions.html b/api/interfaces/PodCreateOptions.html index 301e0e2158e..6653bb5b26c 100644 --- a/api/interfaces/PodCreateOptions.html +++ b/api/interfaces/PodCreateOptions.html @@ -13,7 +13,7 @@ - + @@ -30,7 +30,7 @@ You can request additional settings for each network, you can set network aliase

    Remarks

    PodCreateOptions.netns.nsmode need to be set to bridge to join a network

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:400

    +

    packages/extension-api/src/extension-api.d.ts:400


    exit_policy?

    @@ -41,7 +41,7 @@ You can request additional settings for each network, you can set network aliase
    "continue": the pod continues running. This is the default policy
    when creating a pod.
    "stop": stop the pod when the last container exits. This is the
    default behaviour for play kube.

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:429

    +

    packages/extension-api/src/extension-api.d.ts:429


    labels?

    @@ -51,7 +51,7 @@ You can request additional settings for each network, you can set network aliase

    Index Signature

    [key: string]: string

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:390

    +

    packages/extension-api/src/extension-api.d.ts:390


    name?

    @@ -59,7 +59,7 @@ You can request additional settings for each network, you can set network aliase

    Name is the name of the pod. If not provided, a name will be generated when the pod is created. Optional.

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:380

    +

    packages/extension-api/src/extension-api.d.ts:380


    netns?

    @@ -75,7 +75,7 @@ You can request additional settings for each network, you can set network aliase
    `bridge` indicates that the network backend (CNI/netavark) should be used.
    `pasta` indicates that a pasta network stack should be used.

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:409

    +

    packages/extension-api/src/extension-api.d.ts:409


    portmappings?

    @@ -85,13 +85,13 @@ You can request additional settings for each network, you can set network aliase As, by default, containers share their network with the infra container, this will forward the ports to the entire pod. Only available if NetNS is set to Bridge, Slirp, or Pasta.

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:386

    +

    packages/extension-api/src/extension-api.d.ts:386


    provider?

    optional provider: ContainerProviderConnection

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:392

    +

    packages/extension-api/src/extension-api.d.ts:392

    \ No newline at end of file diff --git a/api/interfaces/PodCreatePortOptions.html b/api/interfaces/PodCreatePortOptions.html index c9b6f411cf1..cfb1a6efeef 100644 --- a/api/interfaces/PodCreatePortOptions.html +++ b/api/interfaces/PodCreatePortOptions.html @@ -13,7 +13,7 @@ - + @@ -24,34 +24,34 @@

    container_port: number

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:370

    +

    packages/extension-api/src/extension-api.d.ts:370


    host_ip

    host_ip: string

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:369

    +

    packages/extension-api/src/extension-api.d.ts:369


    host_port

    host_port: number

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:371

    +

    packages/extension-api/src/extension-api.d.ts:371


    protocol

    protocol: string

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:372

    +

    packages/extension-api/src/extension-api.d.ts:372


    range

    range: number

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:373

    +

    packages/extension-api/src/extension-api.d.ts:373

    \ No newline at end of file diff --git a/api/interfaces/PodInfo.html b/api/interfaces/PodInfo.html index d7a2ed39a5e..15c63528748 100644 --- a/api/interfaces/PodInfo.html +++ b/api/interfaces/PodInfo.html @@ -13,7 +13,7 @@ - + @@ -24,35 +24,35 @@

    Cgroup: string

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:2349

    +

    packages/extension-api/src/extension-api.d.ts:2349


    Containers

    Containers: PodContainerInfo[]

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:2350

    +

    packages/extension-api/src/extension-api.d.ts:2350


    Created

    Created: string

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:2351

    +

    packages/extension-api/src/extension-api.d.ts:2351


    Id

    Id: string

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:2352

    +

    packages/extension-api/src/extension-api.d.ts:2352


    InfraId

    InfraId: string

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:2353

    +

    packages/extension-api/src/extension-api.d.ts:2353


    Labels

    @@ -61,55 +61,55 @@

    Index Signature

    [key: string]: string

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:2354

    +

    packages/extension-api/src/extension-api.d.ts:2354


    Name

    Name: string

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:2355

    +

    packages/extension-api/src/extension-api.d.ts:2355


    Namespace

    Namespace: string

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:2356

    +

    packages/extension-api/src/extension-api.d.ts:2356


    Networks

    Networks: string[]

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:2357

    +

    packages/extension-api/src/extension-api.d.ts:2357


    Status

    Status: string

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:2358

    +

    packages/extension-api/src/extension-api.d.ts:2358


    engineId

    engineId: string

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:2346

    +

    packages/extension-api/src/extension-api.d.ts:2346


    engineName

    engineName: string

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:2347

    +

    packages/extension-api/src/extension-api.d.ts:2347


    kind

    kind: "podman" | "kubernetes"

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:2348

    +

    packages/extension-api/src/extension-api.d.ts:2348

    \ No newline at end of file diff --git a/api/interfaces/PodmanContainerCreateOptions.html b/api/interfaces/PodmanContainerCreateOptions.html index 451989111b3..f5e64ccae46 100644 --- a/api/interfaces/PodmanContainerCreateOptions.html +++ b/api/interfaces/PodmanContainerCreateOptions.html @@ -13,7 +13,7 @@ - + @@ -24,14 +24,14 @@

    optional command: string[]

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:2840

    +

    packages/extension-api/src/extension-api.d.ts:2840


    entrypoint?

    optional entrypoint: string | string[]

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:2841

    +

    packages/extension-api/src/extension-api.d.ts:2841


    env?

    @@ -40,41 +40,41 @@

    Index Signature

    [key: string]: string

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:2842

    +

    packages/extension-api/src/extension-api.d.ts:2842


    hostname?

    optional hostname: string

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:2844

    +

    packages/extension-api/src/extension-api.d.ts:2844


    image?

    optional image: string

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:2845

    +

    packages/extension-api/src/extension-api.d.ts:2845


    mounts?

    optional mounts: object[]

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:2847

    +

    packages/extension-api/src/extension-api.d.ts:2847


    name?

    optional name: string

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:2846

    +

    packages/extension-api/src/extension-api.d.ts:2846


    pod?

    optional pod: string

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:2843

    +

    packages/extension-api/src/extension-api.d.ts:2843

    \ No newline at end of file diff --git a/api/interfaces/Port.html b/api/interfaces/Port.html index 1e1b8b45d18..7dabda3cc74 100644 --- a/api/interfaces/Port.html +++ b/api/interfaces/Port.html @@ -13,7 +13,7 @@ - + @@ -24,27 +24,27 @@

    IP: string

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:2318

    +

    packages/extension-api/src/extension-api.d.ts:2318


    PrivatePort

    PrivatePort: number

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:2319

    +

    packages/extension-api/src/extension-api.d.ts:2319


    PublicPort

    PublicPort: number

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:2320

    +

    packages/extension-api/src/extension-api.d.ts:2320


    Type

    Type: string

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:2321

    +

    packages/extension-api/src/extension-api.d.ts:2321

    \ No newline at end of file diff --git a/api/interfaces/PortBinding.html b/api/interfaces/PortBinding.html index 220249fb1d6..fd125b6e341 100644 --- a/api/interfaces/PortBinding.html +++ b/api/interfaces/PortBinding.html @@ -13,7 +13,7 @@ - + @@ -24,13 +24,13 @@

    optional HostIp: string

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:2376

    +

    packages/extension-api/src/extension-api.d.ts:2376


    HostPort?

    optional HostPort: string

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:2377

    +

    packages/extension-api/src/extension-api.d.ts:2377

    \ No newline at end of file diff --git a/api/interfaces/PortMap.html b/api/interfaces/PortMap.html index f746a13b882..aae472d0162 100644 --- a/api/interfaces/PortMap.html +++ b/api/interfaces/PortMap.html @@ -13,7 +13,7 @@ - + diff --git a/api/interfaces/Progress.html b/api/interfaces/Progress.html index cbd0d01e9b5..4bca406e355 100644 --- a/api/interfaces/Progress.html +++ b/api/interfaces/Progress.html @@ -13,7 +13,7 @@ - + @@ -34,6 +34,6 @@ report on how much work finished

    Returns

    void

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:1028

    +

    packages/extension-api/src/extension-api.d.ts:1028

    \ No newline at end of file diff --git a/api/interfaces/ProgressOptions.html b/api/interfaces/ProgressOptions.html index 5f640d61ed5..10e78e3a4db 100644 --- a/api/interfaces/ProgressOptions.html +++ b/api/interfaces/ProgressOptions.html @@ -13,7 +13,7 @@ - + @@ -29,7 +29,7 @@ cancel the long running operation. Note that currently only ProgressLocation.Notification is supporting to show a cancel button.

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:1072

    +

    packages/extension-api/src/extension-api.d.ts:1072


    location

    @@ -37,7 +37,7 @@ button.

    The location at which progress should show.

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:1058

    +

    packages/extension-api/src/extension-api.d.ts:1058


    title?

    @@ -46,6 +46,6 @@ button.

    A human-readable string which will be used to describe the operation.

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:1064

    +

    packages/extension-api/src/extension-api.d.ts:1064

    \ No newline at end of file diff --git a/api/interfaces/Provider.html b/api/interfaces/Provider.html index a90ddb1c7c2..6743d681500 100644 --- a/api/interfaces/Provider.html +++ b/api/interfaces/Provider.html @@ -13,7 +13,7 @@ - + @@ -24,77 +24,77 @@

    readonly detectionChecks: ProviderDetectionCheck[]

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:650

    +

    packages/extension-api/src/extension-api.d.ts:650


    id

    readonly id: string

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:635

    +

    packages/extension-api/src/extension-api.d.ts:635


    images

    readonly images: ProviderImages

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:645

    +

    packages/extension-api/src/extension-api.d.ts:645


    readonly links: Link[]

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:647

    +

    packages/extension-api/src/extension-api.d.ts:647


    name

    readonly name: string

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:634

    +

    packages/extension-api/src/extension-api.d.ts:634


    onDidUpdateDetectionChecks

    onDidUpdateDetectionChecks: Event<ProviderDetectionCheck[]>

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:661

    +

    packages/extension-api/src/extension-api.d.ts:661


    onDidUpdateStatus

    onDidUpdateStatus: Event<ProviderStatus>

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:638

    +

    packages/extension-api/src/extension-api.d.ts:638


    onDidUpdateVersion

    onDidUpdateVersion: Event<string>

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:643

    +

    packages/extension-api/src/extension-api.d.ts:643


    status

    readonly status: ProviderStatus

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:636

    +

    packages/extension-api/src/extension-api.d.ts:636


    version

    readonly version: undefined | string

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:641

    +

    packages/extension-api/src/extension-api.d.ts:641


    warnings

    readonly warnings: ProviderInformation[]

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:657

    +

    packages/extension-api/src/extension-api.d.ts:657

    Methods

    dispose()

    @@ -103,7 +103,7 @@

    Returns

    void

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:633

    +

    packages/extension-api/src/extension-api.d.ts:633


    registerAutostart()

    @@ -114,7 +114,7 @@

    Returns

    Disposable

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:629

    +

    packages/extension-api/src/extension-api.d.ts:629


    registerCleanup()

    @@ -125,7 +125,7 @@

    Returns

    Disposable

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:631

    +

    packages/extension-api/src/extension-api.d.ts:631


    registerContainerProviderConnection()

    @@ -136,7 +136,7 @@

    Returns

    Disposable

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:618

    +

    packages/extension-api/src/extension-api.d.ts:618


    registerInstallation()

    @@ -147,7 +147,7 @@

    Returns

    Disposable

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:623

    +

    packages/extension-api/src/extension-api.d.ts:623


    registerKubernetesProviderConnection()

    @@ -158,7 +158,7 @@

    Returns

    Disposable

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:619

    +

    packages/extension-api/src/extension-api.d.ts:619


    registerLifecycle()

    @@ -169,7 +169,7 @@

    Returns

    Disposable

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:620

    +

    packages/extension-api/src/extension-api.d.ts:620


    registerUpdate()

    @@ -180,7 +180,7 @@

    Returns

    Disposable

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:626

    +

    packages/extension-api/src/extension-api.d.ts:626


    setContainerProviderConnectionFactory()

    @@ -192,7 +192,7 @@

    Returns

    Disposable

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:609

    +

    packages/extension-api/src/extension-api.d.ts:609


    setKubernetesProviderConnectionFactory()

    @@ -204,7 +204,7 @@

    Returns

    Disposable

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:613

    +

    packages/extension-api/src/extension-api.d.ts:613


    updateDetectionChecks()

    @@ -215,7 +215,7 @@

    Returns

    void

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:654

    +

    packages/extension-api/src/extension-api.d.ts:654


    updateStatus()

    @@ -226,7 +226,7 @@

    Returns

    void

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:637

    +

    packages/extension-api/src/extension-api.d.ts:637


    updateVersion()

    @@ -237,7 +237,7 @@

    Returns

    void

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:642

    +

    packages/extension-api/src/extension-api.d.ts:642


    updateWarnings()

    @@ -248,6 +248,6 @@

    Returns

    void

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:658

    +

    packages/extension-api/src/extension-api.d.ts:658

    \ No newline at end of file diff --git a/api/interfaces/ProviderAutostart.html b/api/interfaces/ProviderAutostart.html index fbd6acd5c4e..742aa1d9db0 100644 --- a/api/interfaces/ProviderAutostart.html +++ b/api/interfaces/ProviderAutostart.html @@ -13,7 +13,7 @@ - + @@ -31,6 +31,6 @@ It can be turned off/on by the user.

    Returns

    Promise<void>

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:578

    +

    packages/extension-api/src/extension-api.d.ts:578

    \ No newline at end of file diff --git a/api/interfaces/ProviderCleanup.html b/api/interfaces/ProviderCleanup.html index 6a960b719ce..fdcfa987243 100644 --- a/api/interfaces/ProviderCleanup.html +++ b/api/interfaces/ProviderCleanup.html @@ -13,7 +13,7 @@ - + @@ -27,6 +27,6 @@

    Returns

    Promise<ProviderCleanupAction[]>

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:585

    +

    packages/extension-api/src/extension-api.d.ts:585

    \ No newline at end of file diff --git a/api/interfaces/ProviderCleanupAction.html b/api/interfaces/ProviderCleanupAction.html index 711eff14190..d47a5ff6d01 100644 --- a/api/interfaces/ProviderCleanupAction.html +++ b/api/interfaces/ProviderCleanupAction.html @@ -13,7 +13,7 @@ - + @@ -24,7 +24,7 @@

    name: string

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:596

    +

    packages/extension-api/src/extension-api.d.ts:596

    Methods

    execute()

    @@ -35,6 +35,6 @@

    Returns

    Promise<void>

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:598

    +

    packages/extension-api/src/extension-api.d.ts:598

    \ No newline at end of file diff --git a/api/interfaces/ProviderCleanupExecuteOptions.html b/api/interfaces/ProviderCleanupExecuteOptions.html index 065478ddb18..f270f8a48f5 100644 --- a/api/interfaces/ProviderCleanupExecuteOptions.html +++ b/api/interfaces/ProviderCleanupExecuteOptions.html @@ -13,7 +13,7 @@ - + @@ -24,13 +24,13 @@

    logger: Logger

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:589

    +

    packages/extension-api/src/extension-api.d.ts:589


    token?

    optional token: CancellationToken

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:590

    +

    packages/extension-api/src/extension-api.d.ts:590

    \ No newline at end of file diff --git a/api/interfaces/ProviderConnectionFactory.html b/api/interfaces/ProviderConnectionFactory.html index 34c5258d1ab..3621e6d0fc3 100644 --- a/api/interfaces/ProviderConnectionFactory.html +++ b/api/interfaces/ProviderConnectionFactory.html @@ -13,7 +13,7 @@ - + @@ -29,14 +29,14 @@

    optional creationButtonTitle: string

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:499

    +

    packages/extension-api/src/extension-api.d.ts:499


    creationDisplayName?

    optional creationDisplayName: string

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:496

    +

    packages/extension-api/src/extension-api.d.ts:496

    Methods

    initialize()?

    @@ -45,6 +45,6 @@

    Returns

    Promise<void>

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:493

    +

    packages/extension-api/src/extension-api.d.ts:493

    \ No newline at end of file diff --git a/api/interfaces/ProviderConnectionLifecycle.html b/api/interfaces/ProviderConnectionLifecycle.html index 5f511f50c20..45da7030ac4 100644 --- a/api/interfaces/ProviderConnectionLifecycle.html +++ b/api/interfaces/ProviderConnectionLifecycle.html @@ -13,7 +13,7 @@ - + @@ -28,7 +28,7 @@

    Returns

    Promise<void>

    Defined in

    -

    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>

    Defined in

    -

    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>

    Defined in

    -

    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>

    Defined in

    -

    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 dd8d787e658..7e160234e7e 100644 --- a/api/interfaces/ProviderContainerConnection.html +++ b/api/interfaces/ProviderContainerConnection.html @@ -13,7 +13,7 @@ - + @@ -24,13 +24,13 @@

    connection: ContainerProviderConnection

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:723

    +

    packages/extension-api/src/extension-api.d.ts:723


    providerId

    providerId: string

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:722

    +

    packages/extension-api/src/extension-api.d.ts:722

    \ No newline at end of file diff --git a/api/interfaces/ProviderDetectionCheck.html b/api/interfaces/ProviderDetectionCheck.html index 0b10cd52843..d5b338b3293 100644 --- a/api/interfaces/ProviderDetectionCheck.html +++ b/api/interfaces/ProviderDetectionCheck.html @@ -13,7 +13,7 @@ - + @@ -24,20 +24,20 @@

    optional details: string

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:307

    +

    packages/extension-api/src/extension-api.d.ts:307


    name

    name: string

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:306

    +

    packages/extension-api/src/extension-api.d.ts:306


    status

    status: boolean

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:308

    +

    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 d50c78f8f7e..e926577fecb 100644 --- a/api/interfaces/ProviderEvent.html +++ b/api/interfaces/ProviderEvent.html @@ -13,7 +13,7 @@ - + @@ -24,20 +24,20 @@

    id: string

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:691

    +

    packages/extension-api/src/extension-api.d.ts:691


    name

    name: string

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:692

    +

    packages/extension-api/src/extension-api.d.ts:692


    status

    status: ProviderStatus

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:693

    +

    packages/extension-api/src/extension-api.d.ts:693

    \ No newline at end of file diff --git a/api/interfaces/ProviderImages.html b/api/interfaces/ProviderImages.html index b90d950bd8e..451f3b54505 100644 --- a/api/interfaces/ProviderImages.html +++ b/api/interfaces/ProviderImages.html @@ -13,7 +13,7 @@ - + @@ -24,13 +24,13 @@

    optional icon: string | object

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:604

    +

    packages/extension-api/src/extension-api.d.ts:604


    optional logo: string | object

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:605

    +

    packages/extension-api/src/extension-api.d.ts:605

    \ No newline at end of file diff --git a/api/interfaces/ProviderInformation.html b/api/interfaces/ProviderInformation.html index 0a649a94455..fd738c62773 100644 --- a/api/interfaces/ProviderInformation.html +++ b/api/interfaces/ProviderInformation.html @@ -13,7 +13,7 @@ - + @@ -24,13 +24,13 @@

    optional details: string

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:302

    +

    packages/extension-api/src/extension-api.d.ts:302


    name

    name: string

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:301

    +

    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 be6e36fc6ea..a1955d0bf6a 100644 --- a/api/interfaces/ProviderInstallation.html +++ b/api/interfaces/ProviderInstallation.html @@ -13,7 +13,7 @@ - + @@ -28,7 +28,7 @@

    Returns

    Promise<void>

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:561

    +

    packages/extension-api/src/extension-api.d.ts:561


    preflightChecks()?

    @@ -37,6 +37,6 @@

    Returns

    InstallCheck[]

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:559

    +

    packages/extension-api/src/extension-api.d.ts:559

    \ No newline at end of file diff --git a/api/interfaces/ProviderLifecycle.html b/api/interfaces/ProviderLifecycle.html index fd6df0b30d0..c3fba1ec46d 100644 --- a/api/interfaces/ProviderLifecycle.html +++ b/api/interfaces/ProviderLifecycle.html @@ -13,7 +13,7 @@ - + @@ -28,7 +28,7 @@

    Returns

    Promise<void>

    Defined in

    -

    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>

    Defined in

    -

    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

    Defined in

    -

    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>

    Defined in

    -

    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 b0b14a819ee..ee4e97b99eb 100644 --- a/api/interfaces/ProviderOptions.html +++ b/api/interfaces/ProviderOptions.html @@ -13,7 +13,7 @@ - + @@ -24,62 +24,62 @@

    optional detectionChecks: ProviderDetectionCheck[]

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:318

    +

    packages/extension-api/src/extension-api.d.ts:318


    emptyConnectionMarkdownDescription?

    optional emptyConnectionMarkdownDescription: string

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:324

    +

    packages/extension-api/src/extension-api.d.ts:324


    id

    id: string

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:312

    +

    packages/extension-api/src/extension-api.d.ts:312


    images?

    optional images: ProviderImages

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:316

    +

    packages/extension-api/src/extension-api.d.ts:316


    optional links: Link[]

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:317

    +

    packages/extension-api/src/extension-api.d.ts:317


    name

    name: string

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:313

    +

    packages/extension-api/src/extension-api.d.ts:313


    status

    status: ProviderStatus

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:314

    +

    packages/extension-api/src/extension-api.d.ts:314


    version?

    optional version: string

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:315

    +

    packages/extension-api/src/extension-api.d.ts:315


    warnings?

    optional warnings: ProviderInformation[]

    Defined in

    -

    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 837c1da2752..506e5870ff5 100644 --- a/api/interfaces/ProviderUpdate.html +++ b/api/interfaces/ProviderUpdate.html @@ -13,7 +13,7 @@ - + @@ -24,7 +24,7 @@

    version: string

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:565

    +

    packages/extension-api/src/extension-api.d.ts:565

    Methods

    preflightChecks()?

    @@ -33,7 +33,7 @@

    Returns

    InstallCheck[]

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:569

    +

    packages/extension-api/src/extension-api.d.ts:569


    update()

    @@ -44,6 +44,6 @@

    Returns

    Promise<void>

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:567

    +

    packages/extension-api/src/extension-api.d.ts:567

    \ No newline at end of file diff --git a/api/interfaces/ProxySettings.html b/api/interfaces/ProxySettings.html index 92e20d16320..3858a675fa0 100644 --- a/api/interfaces/ProxySettings.html +++ b/api/interfaces/ProxySettings.html @@ -13,7 +13,7 @@ - + @@ -24,20 +24,20 @@

    httpProxy: undefined | string

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:868

    +

    packages/extension-api/src/extension-api.d.ts:868


    httpsProxy

    httpsProxy: undefined | string

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:869

    +

    packages/extension-api/src/extension-api.d.ts:869


    noProxy

    noProxy: undefined | string

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:870

    +

    packages/extension-api/src/extension-api.d.ts:870

    \ No newline at end of file diff --git a/api/interfaces/PullEvent.html b/api/interfaces/PullEvent.html index 4b8acf571b6..eeea1629cf6 100644 --- a/api/interfaces/PullEvent.html +++ b/api/interfaces/PullEvent.html @@ -13,7 +13,7 @@ - + @@ -24,7 +24,7 @@

    optional error: string

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:2690

    +

    packages/extension-api/src/extension-api.d.ts:2690


    errorDetails?

    @@ -35,21 +35,21 @@

    optional message: string

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:2691

    +

    packages/extension-api/src/extension-api.d.ts:2691


    id?

    optional id: string

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:2683

    +

    packages/extension-api/src/extension-api.d.ts:2683


    progress?

    optional progress: string

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:2685

    +

    packages/extension-api/src/extension-api.d.ts:2685


    progressDetail?

    @@ -64,20 +64,20 @@

    optional total: number

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:2686

    +

    packages/extension-api/src/extension-api.d.ts:2686


    status?

    optional status: string

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:2684

    +

    packages/extension-api/src/extension-api.d.ts:2684


    stream?

    optional stream: string

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:2682

    +

    packages/extension-api/src/extension-api.d.ts:2682

    \ No newline at end of file diff --git a/api/interfaces/QuickInputButton.html b/api/interfaces/QuickInputButton.html index 14b477b98ab..74e7103bd3a 100644 --- a/api/interfaces/QuickInputButton.html +++ b/api/interfaces/QuickInputButton.html @@ -13,7 +13,7 @@ - + @@ -26,7 +26,7 @@

    Icon for the button.

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:1228

    +

    packages/extension-api/src/extension-api.d.ts:1228


    tooltip?

    @@ -34,6 +34,6 @@

    An optional tooltip.

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:1233

    +

    packages/extension-api/src/extension-api.d.ts:1233

    \ No newline at end of file diff --git a/api/interfaces/QuickPickItem.html b/api/interfaces/QuickPickItem.html index 3b1c179d241..14096d093cc 100644 --- a/api/interfaces/QuickPickItem.html +++ b/api/interfaces/QuickPickItem.html @@ -13,7 +13,7 @@ - + @@ -28,7 +28,7 @@ a list of items.

    Always show this item.

    Note: this property is ignored when kind is set to QuickPickItemKind.Separator

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:1329

    +

    packages/extension-api/src/extension-api.d.ts:1329


    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

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:1339

    +

    packages/extension-api/src/extension-api.d.ts:1339


    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

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:1301

    +

    packages/extension-api/src/extension-api.d.ts:1301


    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

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:1309

    +

    packages/extension-api/src/extension-api.d.ts:1309


    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.

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:1293

    +

    packages/extension-api/src/extension-api.d.ts:1293


    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.

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:1287

    +

    packages/extension-api/src/extension-api.d.ts:1287


    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

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:1322

    +

    packages/extension-api/src/extension-api.d.ts:1322

    \ No newline at end of file diff --git a/api/interfaces/QuickPickOptions.html b/api/interfaces/QuickPickOptions.html index 6941cb5c066..8fad86c6970 100644 --- a/api/interfaces/QuickPickOptions.html +++ b/api/interfaces/QuickPickOptions.html @@ -13,7 +13,7 @@ - + @@ -26,7 +26,7 @@

    An optional flag to make the picker accept multiple selections, if true the result is an array of picks.

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:1269

    +

    packages/extension-api/src/extension-api.d.ts:1269


    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.

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:1264

    +

    packages/extension-api/src/extension-api.d.ts:1264


    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.

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:1248

    +

    packages/extension-api/src/extension-api.d.ts:1248


    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.

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:1253

    +

    packages/extension-api/src/extension-api.d.ts:1253


    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.

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:1258

    +

    packages/extension-api/src/extension-api.d.ts:1258


    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.

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:1243

    +

    packages/extension-api/src/extension-api.d.ts:1243

    Methods

    onDidSelectItem()?

    @@ -79,6 +79,6 @@ This setting is ignored on iPad and is always false.

    Returns

    any

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:1275

    +

    packages/extension-api/src/extension-api.d.ts:1275

    \ No newline at end of file diff --git a/api/interfaces/RegisterContainerConnectionEvent.html b/api/interfaces/RegisterContainerConnectionEvent.html index 11d17f1abb9..3798ef94e5d 100644 --- a/api/interfaces/RegisterContainerConnectionEvent.html +++ b/api/interfaces/RegisterContainerConnectionEvent.html @@ -13,7 +13,7 @@ - + @@ -24,13 +24,13 @@

    connection: ContainerProviderConnection

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:719

    +

    packages/extension-api/src/extension-api.d.ts:719


    providerId

    providerId: string

    Defined in

    -

    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/RegisterKubernetesConnectionEvent.html b/api/interfaces/RegisterKubernetesConnectionEvent.html index 426dbe98c01..38b2ff4ba66 100644 --- a/api/interfaces/RegisterKubernetesConnectionEvent.html +++ b/api/interfaces/RegisterKubernetesConnectionEvent.html @@ -13,7 +13,7 @@ - + @@ -24,6 +24,6 @@

    providerId: string

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:715

    +

    packages/extension-api/src/extension-api.d.ts:715

    \ No newline at end of file diff --git a/api/interfaces/Registry.html b/api/interfaces/Registry.html index 7b155c1038f..675d9b366f1 100644 --- a/api/interfaces/Registry.html +++ b/api/interfaces/Registry.html @@ -13,7 +13,7 @@ - + @@ -30,14 +30,14 @@

    Inherited from

    RegistryCreateOptions.alias

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:908

    +

    packages/extension-api/src/extension-api.d.ts:908


    icon?

    optional icon: string

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:900

    +

    packages/extension-api/src/extension-api.d.ts:900


    insecure?

    @@ -46,14 +46,14 @@

    Inherited from

    RegistryCreateOptions.insecure

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:907

    +

    packages/extension-api/src/extension-api.d.ts:907


    name?

    optional name: string

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:899

    +

    packages/extension-api/src/extension-api.d.ts:899


    secret

    @@ -62,7 +62,7 @@

    Inherited from

    RegistryCreateOptions.secret

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:906

    +

    packages/extension-api/src/extension-api.d.ts:906


    serverUrl

    @@ -71,14 +71,14 @@

    Inherited from

    RegistryCreateOptions.serverUrl

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:904

    +

    packages/extension-api/src/extension-api.d.ts:904


    source

    source: string

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:896

    +

    packages/extension-api/src/extension-api.d.ts:896


    username

    @@ -87,6 +87,6 @@

    Inherited from

    RegistryCreateOptions.username

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:905

    +

    packages/extension-api/src/extension-api.d.ts:905

    \ No newline at end of file diff --git a/api/interfaces/RegistryConfig.html b/api/interfaces/RegistryConfig.html index 5211f0649a0..2decef64136 100644 --- a/api/interfaces/RegistryConfig.html +++ b/api/interfaces/RegistryConfig.html @@ -13,7 +13,7 @@ - + diff --git a/api/interfaces/RegistryCreateOptions.html b/api/interfaces/RegistryCreateOptions.html index d903446a70c..755b0da000f 100644 --- a/api/interfaces/RegistryCreateOptions.html +++ b/api/interfaces/RegistryCreateOptions.html @@ -13,7 +13,7 @@ - + @@ -28,34 +28,34 @@

    optional alias: string

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:908

    +

    packages/extension-api/src/extension-api.d.ts:908


    insecure?

    optional insecure: boolean

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:907

    +

    packages/extension-api/src/extension-api.d.ts:907


    secret

    secret: string

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:906

    +

    packages/extension-api/src/extension-api.d.ts:906


    serverUrl

    serverUrl: string

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:904

    +

    packages/extension-api/src/extension-api.d.ts:904


    username

    username: string

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:905

    +

    packages/extension-api/src/extension-api.d.ts:905

    \ No newline at end of file diff --git a/api/interfaces/RegistryProvider.html b/api/interfaces/RegistryProvider.html index 74b9d723fda..406889f1637 100644 --- a/api/interfaces/RegistryProvider.html +++ b/api/interfaces/RegistryProvider.html @@ -13,7 +13,7 @@ - + @@ -24,7 +24,7 @@

    readonly name: string

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:912

    +

    packages/extension-api/src/extension-api.d.ts:912

    Methods

    create()

    @@ -35,6 +35,6 @@

    Returns

    Registry

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:913

    +

    packages/extension-api/src/extension-api.d.ts:913

    \ No newline at end of file diff --git a/api/interfaces/RegistrySuggestedProvider.html b/api/interfaces/RegistrySuggestedProvider.html index 28af71954f7..71a4418ffbc 100644 --- a/api/interfaces/RegistrySuggestedProvider.html +++ b/api/interfaces/RegistrySuggestedProvider.html @@ -13,7 +13,7 @@ - + @@ -24,20 +24,20 @@

    optional icon: string

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:892

    +

    packages/extension-api/src/extension-api.d.ts:892


    name

    name: string

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:888

    +

    packages/extension-api/src/extension-api.d.ts:888


    url

    url: string

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:889

    +

    packages/extension-api/src/extension-api.d.ts:889

    \ No newline at end of file diff --git a/api/interfaces/RunError.html b/api/interfaces/RunError.html index 62bd763f8f6..3bd67d34b72 100644 --- a/api/interfaces/RunError.html +++ b/api/interfaces/RunError.html @@ -13,7 +13,7 @@ - + @@ -30,7 +30,7 @@

    Indicates whether the execution was cancelled.

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:4116

    +

    packages/extension-api/src/extension-api.d.ts:4116


    cause?

    @@ -47,7 +47,7 @@

    The command that was executed.

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:4101

    +

    packages/extension-api/src/extension-api.d.ts:4101


    exitCode

    @@ -55,7 +55,7 @@

    The exit code of the command.

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:4096

    +

    packages/extension-api/src/extension-api.d.ts:4096


    killed

    @@ -63,7 +63,7 @@

    Indicates whether the process was forcefully killed.

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:4121

    +

    packages/extension-api/src/extension-api.d.ts:4121


    message

    @@ -73,7 +73,7 @@

    Overrides

    Error.message

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:4091

    +

    packages/extension-api/src/extension-api.d.ts:4091


    name

    @@ -99,7 +99,7 @@

    The standard error (stderr) content of the command.

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:4111

    +

    packages/extension-api/src/extension-api.d.ts:4111


    stdout

    @@ -107,6 +107,6 @@

    The standard output (stdout) content of the command.

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:4106

    +

    packages/extension-api/src/extension-api.d.ts:4106

    \ No newline at end of file diff --git a/api/interfaces/RunOptions.html b/api/interfaces/RunOptions.html index b0933d70b0d..47f564f3ee0 100644 --- a/api/interfaces/RunOptions.html +++ b/api/interfaces/RunOptions.html @@ -13,7 +13,7 @@ - + @@ -26,7 +26,7 @@

    custom directory

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:4051

    +

    packages/extension-api/src/extension-api.d.ts:4051


    encoding?

    @@ -34,7 +34,7 @@

    The encoding to use. Default utf8

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:4061

    +

    packages/extension-api/src/extension-api.d.ts:4061


    env?

    @@ -44,7 +44,7 @@

    Index Signature

    [key: string]: string

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:4036

    +

    packages/extension-api/src/extension-api.d.ts:4036


    isAdmin?

    @@ -52,7 +52,7 @@

    admin privileges required

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:4056

    +

    packages/extension-api/src/extension-api.d.ts:4056


    logger?

    @@ -60,7 +60,7 @@

    A logger used to track execution events.

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:4046

    +

    packages/extension-api/src/extension-api.d.ts:4046


    token?

    @@ -68,6 +68,6 @@

    A cancellation token used to request cancellation.

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:4041

    +

    packages/extension-api/src/extension-api.d.ts:4041

    \ No newline at end of file diff --git a/api/interfaces/RunResult.html b/api/interfaces/RunResult.html index feeed7a43f0..ea732ba4623 100644 --- a/api/interfaces/RunResult.html +++ b/api/interfaces/RunResult.html @@ -13,7 +13,7 @@ - + @@ -26,7 +26,7 @@

    The command that was executed.

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:4071

    +

    packages/extension-api/src/extension-api.d.ts:4071


    stderr

    @@ -34,7 +34,7 @@

    The standard error (stderr) content of the command.

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:4081

    +

    packages/extension-api/src/extension-api.d.ts:4081


    stdout

    @@ -42,6 +42,6 @@

    The standard output (stdout) content of the command.

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:4076

    +

    packages/extension-api/src/extension-api.d.ts:4076

    \ No newline at end of file diff --git a/api/interfaces/SaveDialogOptions.html b/api/interfaces/SaveDialogOptions.html index 2b9e68b6531..6bfc2723ee6 100644 --- a/api/interfaces/SaveDialogOptions.html +++ b/api/interfaces/SaveDialogOptions.html @@ -13,7 +13,7 @@ - + @@ -26,7 +26,7 @@

    The resource the dialog shows when opened.

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:1853

    +

    packages/extension-api/src/extension-api.d.ts:1853


    filters?

    @@ -34,7 +34,7 @@

    A set of file filters that are used by the dialog.

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:1863

    +

    packages/extension-api/src/extension-api.d.ts:1863


    saveLabel?

    @@ -42,7 +42,7 @@

    A human-readable string for the save button.

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:1858

    +

    packages/extension-api/src/extension-api.d.ts:1858


    title?

    @@ -50,6 +50,6 @@

    Dialog title.

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:1871

    +

    packages/extension-api/src/extension-api.d.ts:1871

    \ No newline at end of file diff --git a/api/interfaces/SecretStorage.html b/api/interfaces/SecretStorage.html index e42f6311732..b4635925942 100644 --- a/api/interfaces/SecretStorage.html +++ b/api/interfaces/SecretStorage.html @@ -13,7 +13,7 @@ - + @@ -27,7 +27,7 @@ sensitive.

    Fires when a secret is stored or deleted.

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:4588

    +

    packages/extension-api/src/extension-api.d.ts:4588

    Methods

    delete()

    @@ -40,7 +40,7 @@ sensitive.

    Returns

    Promise<void>

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:4583

    +

    packages/extension-api/src/extension-api.d.ts:4583


    get()

    @@ -55,7 +55,7 @@ is no secret matching that key.

    Promise<undefined | string>

    The stored value or undefined.

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:4570

    +

    packages/extension-api/src/extension-api.d.ts:4570


    store()

    @@ -70,6 +70,6 @@ is no secret matching that key.

    Returns

    Promise<void>

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:4577

    +

    packages/extension-api/src/extension-api.d.ts:4577

    \ No newline at end of file diff --git a/api/interfaces/SecretStorageChangeEvent.html b/api/interfaces/SecretStorageChangeEvent.html index 18147488485..a5b73c7403a 100644 --- a/api/interfaces/SecretStorageChangeEvent.html +++ b/api/interfaces/SecretStorageChangeEvent.html @@ -13,7 +13,7 @@ - + @@ -26,6 +26,6 @@

    The key of the secret that has changed.

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:4556

    +

    packages/extension-api/src/extension-api.d.ts:4556

    \ No newline at end of file diff --git a/api/interfaces/StatusBarItem.html b/api/interfaces/StatusBarItem.html index c4fe362c18d..658def4d666 100644 --- a/api/interfaces/StatusBarItem.html +++ b/api/interfaces/StatusBarItem.html @@ -13,7 +13,7 @@ - + @@ -27,7 +27,7 @@ show text and icons and run a command on click.

    The alignment of this item.

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:1506

    +

    packages/extension-api/src/extension-api.d.ts:1506


    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.

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:1534

    +

    packages/extension-api/src/extension-api.d.ts:1534


    commandArgs?

    @@ -43,7 +43,7 @@ show text and icons and run a command on click.

    Arguments that the command handler should be invoked with.

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:1539

    +

    packages/extension-api/src/extension-api.d.ts:1539


    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.

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:1530

    +

    packages/extension-api/src/extension-api.d.ts:1530


    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.

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:1525

    +

    packages/extension-api/src/extension-api.d.ts:1525


    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.

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:1511

    +

    packages/extension-api/src/extension-api.d.ts:1511


    text?

    @@ -79,7 +79,7 @@ or more to the right.

    The text to show for the entry.

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:1515

    +

    packages/extension-api/src/extension-api.d.ts:1515


    tooltip?

    @@ -87,7 +87,7 @@ or more to the right.

    The tooltip text when you hover over this entry.

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:1519

    +

    packages/extension-api/src/extension-api.d.ts:1519

    Methods

    dispose()

    @@ -98,7 +98,7 @@ or more to the right.

    Returns

    void

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:1553

    +

    packages/extension-api/src/extension-api.d.ts:1553


    hide()

    @@ -108,7 +108,7 @@ or more to the right.

    Returns

    void

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:1547

    +

    packages/extension-api/src/extension-api.d.ts:1547


    show()

    @@ -118,6 +118,6 @@ or more to the right.

    Returns

    void

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:1543

    +

    packages/extension-api/src/extension-api.d.ts:1543

    \ No newline at end of file diff --git a/api/interfaces/StorageStats.html b/api/interfaces/StorageStats.html index d32fc6db30c..b8b3cad1275 100644 --- a/api/interfaces/StorageStats.html +++ b/api/interfaces/StorageStats.html @@ -13,7 +13,7 @@ - + @@ -24,27 +24,27 @@

    optional read_count_normalized: number

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:3087

    +

    packages/extension-api/src/extension-api.d.ts:3087


    read_size_bytes?

    optional read_size_bytes: number

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:3088

    +

    packages/extension-api/src/extension-api.d.ts:3088


    write_count_normalized?

    optional write_count_normalized: number

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:3089

    +

    packages/extension-api/src/extension-api.d.ts:3089


    write_size_bytes?

    optional write_size_bytes: number

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:3090

    +

    packages/extension-api/src/extension-api.d.ts:3090

    \ No newline at end of file diff --git a/api/interfaces/TelemetryLogger.html b/api/interfaces/TelemetryLogger.html index 4021abf3a70..7b5f648331c 100644 --- a/api/interfaces/TelemetryLogger.html +++ b/api/interfaces/TelemetryLogger.html @@ -13,7 +13,7 @@ - + @@ -35,7 +35,7 @@ to forward unhandled errors to the respective extensions.

    Whether or not error telemetry is enabled for this logger.

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:4178

    +

    packages/extension-api/src/extension-api.d.ts:4178


    isUsageEnabled

    @@ -43,7 +43,7 @@ to forward unhandled errors to the respective extensions.

    Whether or not usage telemetry is enabled for this logger.

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:4173

    +

    packages/extension-api/src/extension-api.d.ts:4173


    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.

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:4168

    +

    packages/extension-api/src/extension-api.d.ts:4168

    Methods

    dispose()

    @@ -61,7 +61,7 @@ to forward unhandled errors to the respective extensions.

    Returns

    void

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:4213

    +

    packages/extension-api/src/extension-api.d.ts:4213


    logError()

    logError(eventName, data)

    @@ -79,7 +79,7 @@ Automatically supports echoing to extension telemetry output channel.

    Returns

    void

    Defined in
    -

    packages/extension-api/src/extension-api.d.ts:4200

    +

    packages/extension-api/src/extension-api.d.ts:4200

    logError(error, data)

    logError(error, data?): void

    @@ -93,7 +93,7 @@ Automatically supports echoing to extension telemetry output channel.

    Returns

    void

    Defined in
    -

    packages/extension-api/src/extension-api.d.ts:4208

    +

    packages/extension-api/src/extension-api.d.ts:4208


    logUsage()

    @@ -110,6 +110,6 @@ Automatically supports echoing to extension telemetry output channel.

    Returns

    void

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:4189

    +

    packages/extension-api/src/extension-api.d.ts:4189

    \ No newline at end of file diff --git a/api/interfaces/TelemetryLoggerOptions.html b/api/interfaces/TelemetryLoggerOptions.html index c679559c65d..d137db72a83 100644 --- a/api/interfaces/TelemetryLoggerOptions.html +++ b/api/interfaces/TelemetryLoggerOptions.html @@ -13,7 +13,7 @@ - + @@ -26,7 +26,7 @@

    Any additional common properties which should be injected into the data object.

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:4266

    +

    packages/extension-api/src/extension-api.d.ts:4266


    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.

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:4254

    +

    packages/extension-api/src/extension-api.d.ts:4254


    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.

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:4260

    +

    packages/extension-api/src/extension-api.d.ts:4260

    \ No newline at end of file diff --git a/api/interfaces/TelemetrySender.html b/api/interfaces/TelemetrySender.html index 1348848377b..8413a18d036 100644 --- a/api/interfaces/TelemetrySender.html +++ b/api/interfaces/TelemetrySender.html @@ -13,7 +13,7 @@ - + @@ -30,7 +30,7 @@ as its TelemetryLogger is being di

    Returns

    void | Promise<void>

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:4243

    +

    packages/extension-api/src/extension-api.d.ts:4243


    sendErrorData()

    @@ -45,7 +45,7 @@ as its TelemetryLogger is being di

    Returns

    void

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:4237

    +

    packages/extension-api/src/extension-api.d.ts:4237


    sendEventData()

    @@ -60,6 +60,6 @@ as its TelemetryLogger is being di

    Returns

    void

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:4228

    +

    packages/extension-api/src/extension-api.d.ts:4228

    \ No newline at end of file diff --git a/api/interfaces/ThrottlingData.html b/api/interfaces/ThrottlingData.html index 5f287b4c48d..79e5aa992be 100644 --- a/api/interfaces/ThrottlingData.html +++ b/api/interfaces/ThrottlingData.html @@ -13,7 +13,7 @@ - + @@ -24,20 +24,20 @@

    periods: number

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:3160

    +

    packages/extension-api/src/extension-api.d.ts:3160


    throttled_periods

    throttled_periods: number

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:3161

    +

    packages/extension-api/src/extension-api.d.ts:3161


    throttled_time

    throttled_time: number

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:3162

    +

    packages/extension-api/src/extension-api.d.ts:3162

    \ No newline at end of file diff --git a/api/interfaces/UnregisterContainerConnectionEvent.html b/api/interfaces/UnregisterContainerConnectionEvent.html index c78221b562e..107c57470f8 100644 --- a/api/interfaces/UnregisterContainerConnectionEvent.html +++ b/api/interfaces/UnregisterContainerConnectionEvent.html @@ -13,7 +13,7 @@ - + @@ -24,6 +24,6 @@

    providerId: string

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:709

    +

    packages/extension-api/src/extension-api.d.ts:709

    \ No newline at end of file diff --git a/api/interfaces/UnregisterKubernetesConnectionEvent.html b/api/interfaces/UnregisterKubernetesConnectionEvent.html index 8cd791e493e..d7ddfe32d33 100644 --- a/api/interfaces/UnregisterKubernetesConnectionEvent.html +++ b/api/interfaces/UnregisterKubernetesConnectionEvent.html @@ -13,7 +13,7 @@ - + @@ -24,6 +24,6 @@

    providerId: string

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:712

    +

    packages/extension-api/src/extension-api.d.ts:712

    \ No newline at end of file diff --git a/api/interfaces/UpdateContainerConnectionEvent.html b/api/interfaces/UpdateContainerConnectionEvent.html index ba7eab2fc95..2ae2e8a55bf 100644 --- a/api/interfaces/UpdateContainerConnectionEvent.html +++ b/api/interfaces/UpdateContainerConnectionEvent.html @@ -13,7 +13,7 @@ - + @@ -24,20 +24,20 @@

    connection: ContainerProviderConnection

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:698

    +

    packages/extension-api/src/extension-api.d.ts:698


    providerId

    providerId: string

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:697

    +

    packages/extension-api/src/extension-api.d.ts:697


    status

    status: ProviderConnectionStatus

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:699

    +

    packages/extension-api/src/extension-api.d.ts:699

    \ No newline at end of file diff --git a/api/interfaces/UpdateKubernetesConnectionEvent.html b/api/interfaces/UpdateKubernetesConnectionEvent.html index 5e7e0897af3..3a23e8303f7 100644 --- a/api/interfaces/UpdateKubernetesConnectionEvent.html +++ b/api/interfaces/UpdateKubernetesConnectionEvent.html @@ -13,7 +13,7 @@ - + @@ -24,20 +24,20 @@

    connection: KubernetesProviderConnection

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:704

    +

    packages/extension-api/src/extension-api.d.ts:704


    providerId

    providerId: string

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:703

    +

    packages/extension-api/src/extension-api.d.ts:703


    status

    status: ProviderConnectionStatus

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:705

    +

    packages/extension-api/src/extension-api.d.ts:705

    \ No newline at end of file diff --git a/api/interfaces/VolumeCreateOptions.html b/api/interfaces/VolumeCreateOptions.html index aa1e8debf50..cfbfd9c2643 100644 --- a/api/interfaces/VolumeCreateOptions.html +++ b/api/interfaces/VolumeCreateOptions.html @@ -13,7 +13,7 @@ - + @@ -24,13 +24,13 @@

    Name: string

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:3425

    +

    packages/extension-api/src/extension-api.d.ts:3425


    provider?

    optional provider: ContainerProviderConnection

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:3427

    +

    packages/extension-api/src/extension-api.d.ts:3427

    \ No newline at end of file diff --git a/api/interfaces/VolumeCreateResponseInfo.html b/api/interfaces/VolumeCreateResponseInfo.html index 2d27fb525d8..b73a3e30cb7 100644 --- a/api/interfaces/VolumeCreateResponseInfo.html +++ b/api/interfaces/VolumeCreateResponseInfo.html @@ -13,7 +13,7 @@ - + @@ -24,14 +24,14 @@

    optional CreatedAt: string

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:3439

    +

    packages/extension-api/src/extension-api.d.ts:3439


    Driver

    Driver: string

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:3437

    +

    packages/extension-api/src/extension-api.d.ts:3437


    Labels

    @@ -40,28 +40,28 @@

    Index Signature

    [label: string]: string

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:3441

    +

    packages/extension-api/src/extension-api.d.ts:3441


    Mountpoint

    Mountpoint: string

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:3438

    +

    packages/extension-api/src/extension-api.d.ts:3438


    Name

    Name: string

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:3436

    +

    packages/extension-api/src/extension-api.d.ts:3436


    Scope

    Scope: string

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:3442

    +

    packages/extension-api/src/extension-api.d.ts:3442


    Status?

    @@ -70,6 +70,6 @@

    Index Signature

    [key: string]: string

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:3440

    +

    packages/extension-api/src/extension-api.d.ts:3440

    \ No newline at end of file diff --git a/api/interfaces/VolumeDeleteOptions.html b/api/interfaces/VolumeDeleteOptions.html index fdf0c5b9e7c..c849b4847f6 100644 --- a/api/interfaces/VolumeDeleteOptions.html +++ b/api/interfaces/VolumeDeleteOptions.html @@ -13,7 +13,7 @@ - + @@ -24,6 +24,6 @@

    optional provider: ContainerProviderConnection

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:3432

    +

    packages/extension-api/src/extension-api.d.ts:3432

    \ No newline at end of file diff --git a/api/interfaces/VolumeInfo.html b/api/interfaces/VolumeInfo.html index 6e9178052cf..2d7d56ddefd 100644 --- a/api/interfaces/VolumeInfo.html +++ b/api/interfaces/VolumeInfo.html @@ -13,7 +13,7 @@ - + @@ -24,14 +24,14 @@

    CreatedAt: string

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:3403

    +

    packages/extension-api/src/extension-api.d.ts:3403


    Driver

    Driver: string

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:3406

    +

    packages/extension-api/src/extension-api.d.ts:3406


    Labels

    @@ -40,35 +40,35 @@

    Index Signature

    [key: string]: string

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:3409

    +

    packages/extension-api/src/extension-api.d.ts:3409


    Mountpoint

    Mountpoint: string

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:3407

    +

    packages/extension-api/src/extension-api.d.ts:3407


    Name

    Name: string

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:3405

    +

    packages/extension-api/src/extension-api.d.ts:3405


    Options?

    optional Options: null | object

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:3411

    +

    packages/extension-api/src/extension-api.d.ts:3411


    Scope

    Scope: "global" | "local"

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:3410

    +

    packages/extension-api/src/extension-api.d.ts:3410


    Status?

    @@ -77,34 +77,34 @@

    Index Signature

    [key: string]: string

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:3408

    +

    packages/extension-api/src/extension-api.d.ts:3408


    UsageData?

    optional UsageData: null | object

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:3412

    +

    packages/extension-api/src/extension-api.d.ts:3412


    containersUsage

    containersUsage: object[]

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:3404

    +

    packages/extension-api/src/extension-api.d.ts:3404


    engineId

    engineId: string

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:3401

    +

    packages/extension-api/src/extension-api.d.ts:3401


    engineName

    engineName: string

    Defined in

    -

    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/interfaces/VolumeListInfo.html b/api/interfaces/VolumeListInfo.html index a69506b395e..1c1c7ef9abf 100644 --- a/api/interfaces/VolumeListInfo.html +++ b/api/interfaces/VolumeListInfo.html @@ -13,7 +13,7 @@ - + @@ -24,27 +24,27 @@

    Volumes: VolumeInfo[]

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:3418

    +

    packages/extension-api/src/extension-api.d.ts:3418


    Warnings

    Warnings: string[]

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:3419

    +

    packages/extension-api/src/extension-api.d.ts:3419


    engineId

    engineId: string

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:3420

    +

    packages/extension-api/src/extension-api.d.ts:3420


    engineName

    engineName: string

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:3421

    +

    packages/extension-api/src/extension-api.d.ts:3421

    \ No newline at end of file diff --git a/api/interfaces/Webview.html b/api/interfaces/Webview.html index 80073185c9e..643a177042d 100644 --- a/api/interfaces/Webview.html +++ b/api/interfaces/Webview.html @@ -13,7 +13,7 @@ - + @@ -26,7 +26,7 @@

    Content security policy source for webview resources.

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:1733

    +

    packages/extension-api/src/extension-api.d.ts:1733


    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.

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:1710

    +

    packages/extension-api/src/extension-api.d.ts:1710


    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.

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:1717

    +

    packages/extension-api/src/extension-api.d.ts:1717


    options

    @@ -52,7 +52,7 @@

    Content settings for the webview.

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:1702

    +

    packages/extension-api/src/extension-api.d.ts:1702

    Methods

    asWebviewUri()

    @@ -64,7 +64,7 @@

    Returns

    Uri

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:1727

    +

    packages/extension-api/src/extension-api.d.ts:1727


    postMessage()

    @@ -76,6 +76,6 @@

    Returns

    Promise<boolean>

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:1722

    +

    packages/extension-api/src/extension-api.d.ts:1722

    \ No newline at end of file diff --git a/api/interfaces/WebviewInfo.html b/api/interfaces/WebviewInfo.html index 9522c4f6289..2d9377cbe8f 100644 --- a/api/interfaces/WebviewInfo.html +++ b/api/interfaces/WebviewInfo.html @@ -13,7 +13,7 @@ - + @@ -24,20 +24,20 @@

    id: string

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:3058

    +

    packages/extension-api/src/extension-api.d.ts:3058


    title

    title: string

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:3060

    +

    packages/extension-api/src/extension-api.d.ts:3060


    viewType

    viewType: string

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:3059

    +

    packages/extension-api/src/extension-api.d.ts:3059

    \ No newline at end of file diff --git a/api/interfaces/WebviewOptions.html b/api/interfaces/WebviewOptions.html index b622a3cf626..591b768d9bc 100644 --- a/api/interfaces/WebviewOptions.html +++ b/api/interfaces/WebviewOptions.html @@ -13,7 +13,7 @@ - + @@ -28,6 +28,6 @@

    Default to the root folders of the current workspace plus the extension's install directory.

    Pass in an empty array to disallow access to any local resources.

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:1692

    +

    packages/extension-api/src/extension-api.d.ts:1692

    \ No newline at end of file diff --git a/api/interfaces/WebviewPanel.html b/api/interfaces/WebviewPanel.html index 12795f293e4..00e09c574cc 100644 --- a/api/interfaces/WebviewPanel.html +++ b/api/interfaces/WebviewPanel.html @@ -13,7 +13,7 @@ - + @@ -26,7 +26,7 @@

    Whether the panel is active (focused by the user).

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:1774

    +

    packages/extension-api/src/extension-api.d.ts:1774


    iconPath?

    @@ -34,7 +34,7 @@

    Icon for the panel shown in UI.

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:1753

    +

    packages/extension-api/src/extension-api.d.ts:1753


    onDidChangeViewState

    @@ -42,7 +42,7 @@

    Fired when the panel's view state changes.

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:1784

    +

    packages/extension-api/src/extension-api.d.ts:1784


    onDidDispose

    @@ -53,7 +53,7 @@ called on it.

    Trying to use the panel after it has been disposed throws an exception.

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:1794

    +

    packages/extension-api/src/extension-api.d.ts:1794


    title

    @@ -61,7 +61,7 @@ called on it.

    Title of the panel shown in UI.

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:1748

    +

    packages/extension-api/src/extension-api.d.ts:1748


    viewType

    @@ -69,7 +69,7 @@ called on it.

    Identifies the type of the webview panel.

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:1743

    +

    packages/extension-api/src/extension-api.d.ts:1743


    visible

    @@ -77,7 +77,7 @@ called on it.

    Whether the panel is visible.

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:1779

    +

    packages/extension-api/src/extension-api.d.ts:1779


    webview

    @@ -85,7 +85,7 @@ called on it.

    Webview belonging to the panel.

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:1769

    +

    packages/extension-api/src/extension-api.d.ts:1769

    Methods

    dispose()

    @@ -98,7 +98,7 @@ fire the onDispose event.

    Returns

    void

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:1809

    +

    packages/extension-api/src/extension-api.d.ts:1809


    reveal()

    @@ -111,6 +111,6 @@ fire the onDispose event.

    Returns

    void

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:1800

    +

    packages/extension-api/src/extension-api.d.ts:1800

    \ No newline at end of file diff --git a/api/interfaces/WebviewPanelOnDidChangeViewStateEvent.html b/api/interfaces/WebviewPanelOnDidChangeViewStateEvent.html index bc7628e4c50..1e35f396540 100644 --- a/api/interfaces/WebviewPanelOnDidChangeViewStateEvent.html +++ b/api/interfaces/WebviewPanelOnDidChangeViewStateEvent.html @@ -13,7 +13,7 @@ - + @@ -26,6 +26,6 @@

    Webview panel whose view state changed.

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:1881

    +

    packages/extension-api/src/extension-api.d.ts:1881

    \ No newline at end of file diff --git a/api/namespaces/authentication.html b/api/namespaces/authentication.html index 3f865b13537..fa4d35a6437 100644 --- a/api/namespaces/authentication.html +++ b/api/namespaces/authentication.html @@ -13,7 +13,7 @@ - + diff --git a/api/namespaces/authentication/functions/getSession.html b/api/namespaces/authentication/functions/getSession.html index 9036347e147..43fe8bafb0a 100644 --- a/api/namespaces/authentication/functions/getSession.html +++ b/api/namespaces/authentication/functions/getSession.html @@ -13,7 +13,7 @@ - + @@ -39,7 +39,7 @@ to VS Code that implement GitHub and Microsoft authentication: their providerId&

    Promise<AuthenticationSession | undefined>

    A promise that resolves to an authentication session

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:3915

    +

    packages/extension-api/src/extension-api.d.ts:3915

    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

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:3934

    +

    packages/extension-api/src/extension-api.d.ts:3934

    \ No newline at end of file diff --git a/api/namespaces/authentication/functions/onDidChangeSessions.html b/api/namespaces/authentication/functions/onDidChangeSessions.html index 2d6dd445589..430a61bb6f9 100644 --- a/api/namespaces/authentication/functions/onDidChangeSessions.html +++ b/api/namespaces/authentication/functions/onDidChangeSessions.html @@ -13,7 +13,7 @@ - + @@ -34,6 +34,6 @@ been added, removed, or changed.

    Disposable

    A disposable which unsubscribes the event listener.

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:3944

    +

    packages/extension-api/src/extension-api.d.ts:3944

    \ No newline at end of file diff --git a/api/namespaces/authentication/functions/registerAuthenticationProvider.html b/api/namespaces/authentication/functions/registerAuthenticationProvider.html index 7eb5f2bbe62..d2ce8a20c5f 100644 --- a/api/namespaces/authentication/functions/registerAuthenticationProvider.html +++ b/api/namespaces/authentication/functions/registerAuthenticationProvider.html @@ -13,7 +13,7 @@ - + @@ -37,6 +37,6 @@ has already been used by another provider. Ids are case-sensitive.

    Disposable

    A disposable that unregisters this provider when being disposed.

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:3958

    +

    packages/extension-api/src/extension-api.d.ts:3958

    \ No newline at end of file diff --git a/api/namespaces/cli.html b/api/namespaces/cli.html index 0735f2248b5..b20b656ab27 100644 --- a/api/namespaces/cli.html +++ b/api/namespaces/cli.html @@ -13,7 +13,7 @@ - + diff --git a/api/namespaces/cli/functions/createCliTool.html b/api/namespaces/cli/functions/createCliTool.html index 4d3f63b8119..85e27f72979 100644 --- a/api/namespaces/cli/functions/createCliTool.html +++ b/api/namespaces/cli/functions/createCliTool.html @@ -13,7 +13,7 @@ - + @@ -29,6 +29,6 @@

    CliTool

    CliTool instance

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:4403

    +

    packages/extension-api/src/extension-api.d.ts:4403

    \ No newline at end of file diff --git a/api/namespaces/cli/functions/getCliTool.html b/api/namespaces/cli/functions/getCliTool.html index a091114c5cf..01b59974dd5 100644 --- a/api/namespaces/cli/functions/getCliTool.html +++ b/api/namespaces/cli/functions/getCliTool.html @@ -13,7 +13,7 @@ - + @@ -28,6 +28,6 @@

    Returns

    CliToolInfo | undefined

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:4409

    +

    packages/extension-api/src/extension-api.d.ts:4409

    \ No newline at end of file diff --git a/api/namespaces/cli/functions/onDidChange.html b/api/namespaces/cli/functions/onDidChange.html index 410078f2936..371c59c66ff 100644 --- a/api/namespaces/cli/functions/onDidChange.html +++ b/api/namespaces/cli/functions/onDidChange.html @@ -13,7 +13,7 @@ - + @@ -34,6 +34,6 @@ installed, uninstalled, enabled or disabled.

    Disposable

    A disposable which unsubscribes the event listener.

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:4420

    +

    packages/extension-api/src/extension-api.d.ts:4420

    \ No newline at end of file diff --git a/api/namespaces/cli/variables/all.html b/api/namespaces/cli/variables/all.html index 08ac7cca3b1..736c56cef3e 100644 --- a/api/namespaces/cli/variables/all.html +++ b/api/namespaces/cli/variables/all.html @@ -13,7 +13,7 @@ - + @@ -23,6 +23,6 @@

    All cli tools currently known to the system.

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:4414

    +

    packages/extension-api/src/extension-api.d.ts:4414

    \ No newline at end of file diff --git a/api/namespaces/commands.html b/api/namespaces/commands.html index a49d13805f5..be608661a6d 100644 --- a/api/namespaces/commands.html +++ b/api/namespaces/commands.html @@ -13,7 +13,7 @@ - + diff --git a/api/namespaces/commands/functions/executeCommand.html b/api/namespaces/commands/functions/executeCommand.html index 80b6e0a2f58..1b27bd42d86 100644 --- a/api/namespaces/commands/functions/executeCommand.html +++ b/api/namespaces/commands/functions/executeCommand.html @@ -13,7 +13,7 @@ - + @@ -38,6 +38,6 @@

    Throws

    if the command throws an exception

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:687

    +

    packages/extension-api/src/extension-api.d.ts:687

    \ No newline at end of file diff --git a/api/namespaces/commands/functions/registerCommand.html b/api/namespaces/commands/functions/registerCommand.html index 8f0d7eb7c9d..082b6306117 100644 --- a/api/namespaces/commands/functions/registerCommand.html +++ b/api/namespaces/commands/functions/registerCommand.html @@ -13,7 +13,7 @@ - + @@ -35,6 +35,6 @@

    Throws

    if a command with the same name is already registered.

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:675

    +

    packages/extension-api/src/extension-api.d.ts:675

    \ No newline at end of file diff --git a/api/namespaces/configuration.html b/api/namespaces/configuration.html index 379eece1a55..a1be720d478 100644 --- a/api/namespaces/configuration.html +++ b/api/namespaces/configuration.html @@ -13,7 +13,7 @@ - + diff --git a/api/namespaces/configuration/functions/getConfiguration.html b/api/namespaces/configuration/functions/getConfiguration.html index 876fe26acdc..c58dde9dcb1 100644 --- a/api/namespaces/configuration/functions/getConfiguration.html +++ b/api/namespaces/configuration/functions/getConfiguration.html @@ -13,7 +13,7 @@ - + @@ -27,6 +27,6 @@

    Returns

    Configuration

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:952

    +

    packages/extension-api/src/extension-api.d.ts:952

    \ No newline at end of file diff --git a/api/namespaces/configuration/functions/onDidChangeConfiguration.html b/api/namespaces/configuration/functions/onDidChangeConfiguration.html index d9f93cf7414..42de7a69776 100644 --- a/api/namespaces/configuration/functions/onDidChangeConfiguration.html +++ b/api/namespaces/configuration/functions/onDidChangeConfiguration.html @@ -13,7 +13,7 @@ - + @@ -33,6 +33,6 @@

    Disposable

    A disposable which unsubscribes the event listener.

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:957

    +

    packages/extension-api/src/extension-api.d.ts:957

    \ No newline at end of file diff --git a/api/namespaces/containerEngine.html b/api/namespaces/containerEngine.html index 23f68bb7aee..cb80eca22c1 100644 --- a/api/namespaces/containerEngine.html +++ b/api/namespaces/containerEngine.html @@ -13,7 +13,7 @@ - + diff --git a/api/namespaces/containerEngine/functions/buildImage.html b/api/namespaces/containerEngine/functions/buildImage.html index bfa77122129..ef41426c27a 100644 --- a/api/namespaces/containerEngine/functions/buildImage.html +++ b/api/namespaces/containerEngine/functions/buildImage.html @@ -13,7 +13,7 @@ - + @@ -32,6 +32,6 @@

    Returns

    Promise<unknown>

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:3556

    +

    packages/extension-api/src/extension-api.d.ts:3556

    \ No newline at end of file diff --git a/api/namespaces/containerEngine/functions/createContainer.html b/api/namespaces/containerEngine/functions/createContainer.html index 780b21e0e68..28af1abb103 100644 --- a/api/namespaces/containerEngine/functions/createContainer.html +++ b/api/namespaces/containerEngine/functions/createContainer.html @@ -13,7 +13,7 @@ - + @@ -31,6 +31,6 @@

    Promise<ContainerCreateResult>

    A promise resolving to the information on the created container

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:3481

    +

    packages/extension-api/src/extension-api.d.ts:3481

    \ No newline at end of file diff --git a/api/namespaces/containerEngine/functions/createManifest.html b/api/namespaces/containerEngine/functions/createManifest.html index d686eddd678..e46e000206c 100644 --- a/api/namespaces/containerEngine/functions/createManifest.html +++ b/api/namespaces/containerEngine/functions/createManifest.html @@ -13,7 +13,7 @@ - + @@ -34,6 +34,6 @@

    engineId: string

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:3692

    +

    packages/extension-api/src/extension-api.d.ts:3692

    \ No newline at end of file diff --git a/api/namespaces/containerEngine/functions/createNetwork.html b/api/namespaces/containerEngine/functions/createNetwork.html index 5c0260f32d7..1aadec7b9f4 100644 --- a/api/namespaces/containerEngine/functions/createNetwork.html +++ b/api/namespaces/containerEngine/functions/createNetwork.html @@ -13,7 +13,7 @@ - + @@ -27,6 +27,6 @@

    Returns

    Promise<NetworkCreateResult>

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:3671

    +

    packages/extension-api/src/extension-api.d.ts:3671

    \ No newline at end of file diff --git a/api/namespaces/containerEngine/functions/createPod.html b/api/namespaces/containerEngine/functions/createPod.html index a507df59f3f..64e5caa0939 100644 --- a/api/namespaces/containerEngine/functions/createPod.html +++ b/api/namespaces/containerEngine/functions/createPod.html @@ -13,7 +13,7 @@ - + @@ -34,6 +34,6 @@

    engineId: string

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:3680

    +

    packages/extension-api/src/extension-api.d.ts:3680

    \ No newline at end of file diff --git a/api/namespaces/containerEngine/functions/createVolume.html b/api/namespaces/containerEngine/functions/createVolume.html index 67368f67d0c..8e4f7e28d4b 100644 --- a/api/namespaces/containerEngine/functions/createVolume.html +++ b/api/namespaces/containerEngine/functions/createVolume.html @@ -13,7 +13,7 @@ - + @@ -26,6 +26,6 @@

    Returns

    Promise<VolumeCreateResponseInfo>

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:3677

    +

    packages/extension-api/src/extension-api.d.ts:3677

    \ No newline at end of file diff --git a/api/namespaces/containerEngine/functions/deleteContainer.html b/api/namespaces/containerEngine/functions/deleteContainer.html index 5d2fb0357d6..e2fab1d256f 100644 --- a/api/namespaces/containerEngine/functions/deleteContainer.html +++ b/api/namespaces/containerEngine/functions/deleteContainer.html @@ -13,7 +13,7 @@ - + @@ -30,6 +30,6 @@

    Returns

    Promise<void>

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:3548

    +

    packages/extension-api/src/extension-api.d.ts:3548

    \ No newline at end of file diff --git a/api/namespaces/containerEngine/functions/deleteImage.html b/api/namespaces/containerEngine/functions/deleteImage.html index d4feb592bf9..a728d15d0f3 100644 --- a/api/namespaces/containerEngine/functions/deleteImage.html +++ b/api/namespaces/containerEngine/functions/deleteImage.html @@ -13,7 +13,7 @@ - + @@ -30,6 +30,6 @@

    Returns

    Promise<void>

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:3637

    +

    packages/extension-api/src/extension-api.d.ts:3637

    \ No newline at end of file diff --git a/api/namespaces/containerEngine/functions/deleteVolume.html b/api/namespaces/containerEngine/functions/deleteVolume.html index e4811c25ad5..d8cc826e98e 100644 --- a/api/namespaces/containerEngine/functions/deleteVolume.html +++ b/api/namespaces/containerEngine/functions/deleteVolume.html @@ -13,7 +13,7 @@ - + @@ -27,6 +27,6 @@

    Returns

    Promise<void>

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:3678

    +

    packages/extension-api/src/extension-api.d.ts:3678

    \ No newline at end of file diff --git a/api/namespaces/containerEngine/functions/getImageInspect.html b/api/namespaces/containerEngine/functions/getImageInspect.html index 4fe8515b5db..86792ad3486 100644 --- a/api/namespaces/containerEngine/functions/getImageInspect.html +++ b/api/namespaces/containerEngine/functions/getImageInspect.html @@ -13,7 +13,7 @@ - + @@ -31,6 +31,6 @@

    Promise<ImageInspectInfo>

    A promise resolving to a structure containing the image information

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:3646

    +

    packages/extension-api/src/extension-api.d.ts:3646

    \ No newline at end of file diff --git a/api/namespaces/containerEngine/functions/info.html b/api/namespaces/containerEngine/functions/info.html index 643aae83cb2..b73b6accf31 100644 --- a/api/namespaces/containerEngine/functions/info.html +++ b/api/namespaces/containerEngine/functions/info.html @@ -13,7 +13,7 @@ - + @@ -26,6 +26,6 @@

    Returns

    Promise<ContainerEngineInfo>

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:3648

    +

    packages/extension-api/src/extension-api.d.ts:3648

    \ No newline at end of file diff --git a/api/namespaces/containerEngine/functions/inspectContainer.html b/api/namespaces/containerEngine/functions/inspectContainer.html index 4988f006f0f..216037dd567 100644 --- a/api/namespaces/containerEngine/functions/inspectContainer.html +++ b/api/namespaces/containerEngine/functions/inspectContainer.html @@ -13,7 +13,7 @@ - + @@ -31,6 +31,6 @@

    Promise<ContainerInspectInfo>

    A promise resolving to a structure containing the container information

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:3472

    +

    packages/extension-api/src/extension-api.d.ts:3472

    \ No newline at end of file diff --git a/api/namespaces/containerEngine/functions/inspectManifest.html b/api/namespaces/containerEngine/functions/inspectManifest.html index 3b27afba1b5..3d6eadbdff6 100644 --- a/api/namespaces/containerEngine/functions/inspectManifest.html +++ b/api/namespaces/containerEngine/functions/inspectManifest.html @@ -13,7 +13,7 @@ - + @@ -27,6 +27,6 @@

    Returns

    Promise<ManifestInspectInfo>

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:3693

    +

    packages/extension-api/src/extension-api.d.ts:3693

    \ No newline at end of file diff --git a/api/namespaces/containerEngine/functions/listContainers.html b/api/namespaces/containerEngine/functions/listContainers.html index 1320f5935f6..bf3c92c2693 100644 --- a/api/namespaces/containerEngine/functions/listContainers.html +++ b/api/namespaces/containerEngine/functions/listContainers.html @@ -13,7 +13,7 @@ - + @@ -26,6 +26,6 @@

    Promise<ContainerInfo[]>

    A promise resolving to an array of containers information. This method returns a subset of the available information for containers. To get the complete description of a specific container, you can use the containerEngine.inspectContainer method.

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:3463

    +

    packages/extension-api/src/extension-api.d.ts:3463

    \ No newline at end of file diff --git a/api/namespaces/containerEngine/functions/listImages.html b/api/namespaces/containerEngine/functions/listImages.html index fc8f45a543d..3a42252c8c8 100644 --- a/api/namespaces/containerEngine/functions/listImages.html +++ b/api/namespaces/containerEngine/functions/listImages.html @@ -13,7 +13,7 @@ - + @@ -32,6 +32,6 @@
    // Example 1: List all container images when no specific provider is provided.
    const images = await listImages();
    console.log(images);
    // Example 2: List container images for a specific provider.
    const provider = provider.getContainerConnections().find(connection => connection.connection.status() === 'started');
    const images = await listImages({ provider: provider.connection });
    console.log(images);

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:3589

    +

    packages/extension-api/src/extension-api.d.ts:3589

    \ No newline at end of file diff --git a/api/namespaces/containerEngine/functions/listInfos.html b/api/namespaces/containerEngine/functions/listInfos.html index 22f262b5322..7b0b3bad0b6 100644 --- a/api/namespaces/containerEngine/functions/listInfos.html +++ b/api/namespaces/containerEngine/functions/listInfos.html @@ -13,7 +13,7 @@ - + @@ -32,6 +32,6 @@
    // Example 1: List all engine information when no specific provider is provided.
    const infos = await listInfos();
    console.log(infos);
    // Example 2: List information for a specific provider.
    const provider = provider.getContainerConnections().find(connection => connection.connection.status() === 'started');
    const info = await listInfos({ provider: provider.connection });
    console.log(info);

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:3667

    +

    packages/extension-api/src/extension-api.d.ts:3667

    \ No newline at end of file diff --git a/api/namespaces/containerEngine/functions/listNetworks.html b/api/namespaces/containerEngine/functions/listNetworks.html index a9622b4d1f4..b3c90bb6feb 100644 --- a/api/namespaces/containerEngine/functions/listNetworks.html +++ b/api/namespaces/containerEngine/functions/listNetworks.html @@ -13,7 +13,7 @@ - + @@ -24,6 +24,6 @@

    Returns

    Promise<NetworkInspectInfo[]>

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:3670

    +

    packages/extension-api/src/extension-api.d.ts:3670

    \ No newline at end of file diff --git a/api/namespaces/containerEngine/functions/listPods.html b/api/namespaces/containerEngine/functions/listPods.html index 8da9e1dfcfc..f2b6841c7b0 100644 --- a/api/namespaces/containerEngine/functions/listPods.html +++ b/api/namespaces/containerEngine/functions/listPods.html @@ -13,7 +13,7 @@ - + @@ -24,6 +24,6 @@

    Returns

    Promise<PodInfo[]>

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:3687

    +

    packages/extension-api/src/extension-api.d.ts:3687

    \ No newline at end of file diff --git a/api/namespaces/containerEngine/functions/listVolumes.html b/api/namespaces/containerEngine/functions/listVolumes.html index bfbc0dff5f9..80089772c6a 100644 --- a/api/namespaces/containerEngine/functions/listVolumes.html +++ b/api/namespaces/containerEngine/functions/listVolumes.html @@ -13,7 +13,7 @@ - + @@ -24,6 +24,6 @@

    Returns

    Promise<VolumeListInfo[]>

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:3676

    +

    packages/extension-api/src/extension-api.d.ts:3676

    \ No newline at end of file diff --git a/api/namespaces/containerEngine/functions/logsContainer.html b/api/namespaces/containerEngine/functions/logsContainer.html index a4607cf8a2b..c96217a861e 100644 --- a/api/namespaces/containerEngine/functions/logsContainer.html +++ b/api/namespaces/containerEngine/functions/logsContainer.html @@ -13,7 +13,7 @@ - + @@ -32,6 +32,6 @@

    Returns

    Promise<void>

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:3501

    +

    packages/extension-api/src/extension-api.d.ts:3501

    \ No newline at end of file diff --git a/api/namespaces/containerEngine/functions/onEvent.html b/api/namespaces/containerEngine/functions/onEvent.html index b3bf36ce994..c2d792ee200 100644 --- a/api/namespaces/containerEngine/functions/onEvent.html +++ b/api/namespaces/containerEngine/functions/onEvent.html @@ -13,7 +13,7 @@ - + @@ -32,6 +32,6 @@

    Disposable

    A disposable which unsubscribes the event listener.

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:3668

    +

    packages/extension-api/src/extension-api.d.ts:3668

    \ No newline at end of file diff --git a/api/namespaces/containerEngine/functions/pullImage.html b/api/namespaces/containerEngine/functions/pullImage.html index 76526d6ad13..19b9db3d1a9 100644 --- a/api/namespaces/containerEngine/functions/pullImage.html +++ b/api/namespaces/containerEngine/functions/pullImage.html @@ -13,7 +13,7 @@ - + @@ -32,6 +32,6 @@

    Returns

    Promise<void>

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:3625

    +

    packages/extension-api/src/extension-api.d.ts:3625

    \ No newline at end of file diff --git a/api/namespaces/containerEngine/functions/pushImage.html b/api/namespaces/containerEngine/functions/pushImage.html index 62eb542f048..11f1e3c48ae 100644 --- a/api/namespaces/containerEngine/functions/pushImage.html +++ b/api/namespaces/containerEngine/functions/pushImage.html @@ -13,7 +13,7 @@ - + @@ -35,6 +35,6 @@

    Returns

    Promise<void>

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:3611

    +

    packages/extension-api/src/extension-api.d.ts:3611

    \ No newline at end of file diff --git a/api/namespaces/containerEngine/functions/pushManifest.html b/api/namespaces/containerEngine/functions/pushManifest.html index 52b91316080..d0c55cd4d3c 100644 --- a/api/namespaces/containerEngine/functions/pushManifest.html +++ b/api/namespaces/containerEngine/functions/pushManifest.html @@ -13,7 +13,7 @@ - + @@ -26,6 +26,6 @@

    Returns

    Promise<void>

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:3694

    +

    packages/extension-api/src/extension-api.d.ts:3694

    \ No newline at end of file diff --git a/api/namespaces/containerEngine/functions/removeManifest.html b/api/namespaces/containerEngine/functions/removeManifest.html index 5cb620de1f1..d01dfd9f28e 100644 --- a/api/namespaces/containerEngine/functions/removeManifest.html +++ b/api/namespaces/containerEngine/functions/removeManifest.html @@ -13,7 +13,7 @@ - + @@ -27,6 +27,6 @@

    Returns

    Promise<void>

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:3695

    +

    packages/extension-api/src/extension-api.d.ts:3695

    \ No newline at end of file diff --git a/api/namespaces/containerEngine/functions/removePod.html b/api/namespaces/containerEngine/functions/removePod.html index e3ca59e9cd7..feb504bea33 100644 --- a/api/namespaces/containerEngine/functions/removePod.html +++ b/api/namespaces/containerEngine/functions/removePod.html @@ -13,7 +13,7 @@ - + @@ -27,6 +27,6 @@

    Returns

    Promise<void>

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:3689

    +

    packages/extension-api/src/extension-api.d.ts:3689

    \ No newline at end of file diff --git a/api/namespaces/containerEngine/functions/replicatePodmanContainer.html b/api/namespaces/containerEngine/functions/replicatePodmanContainer.html index eab4bf9449d..55d4f18f5e6 100644 --- a/api/namespaces/containerEngine/functions/replicatePodmanContainer.html +++ b/api/namespaces/containerEngine/functions/replicatePodmanContainer.html @@ -13,7 +13,7 @@ - + @@ -39,6 +39,6 @@

    Warnings: string[]

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:3681

    +

    packages/extension-api/src/extension-api.d.ts:3681

    \ No newline at end of file diff --git a/api/namespaces/containerEngine/functions/saveImage.html b/api/namespaces/containerEngine/functions/saveImage.html index d12b99e1d93..0f2e23699b3 100644 --- a/api/namespaces/containerEngine/functions/saveImage.html +++ b/api/namespaces/containerEngine/functions/saveImage.html @@ -13,7 +13,7 @@ - + @@ -34,6 +34,6 @@

    Returns

    Promise<void>

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:3570

    +

    packages/extension-api/src/extension-api.d.ts:3570

    \ No newline at end of file diff --git a/api/namespaces/containerEngine/functions/startContainer.html b/api/namespaces/containerEngine/functions/startContainer.html index 90518650b8b..a9947ced353 100644 --- a/api/namespaces/containerEngine/functions/startContainer.html +++ b/api/namespaces/containerEngine/functions/startContainer.html @@ -13,7 +13,7 @@ - + @@ -30,6 +30,6 @@

    Returns

    Promise<void>

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:3492

    +

    packages/extension-api/src/extension-api.d.ts:3492

    \ No newline at end of file diff --git a/api/namespaces/containerEngine/functions/startPod.html b/api/namespaces/containerEngine/functions/startPod.html index f03c84bcc15..8818e7652da 100644 --- a/api/namespaces/containerEngine/functions/startPod.html +++ b/api/namespaces/containerEngine/functions/startPod.html @@ -13,7 +13,7 @@ - + @@ -27,6 +27,6 @@

    Returns

    Promise<void>

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:3686

    +

    packages/extension-api/src/extension-api.d.ts:3686

    \ No newline at end of file diff --git a/api/namespaces/containerEngine/functions/statsContainer.html b/api/namespaces/containerEngine/functions/statsContainer.html index effc11a11c9..a217db833f6 100644 --- a/api/namespaces/containerEngine/functions/statsContainer.html +++ b/api/namespaces/containerEngine/functions/statsContainer.html @@ -13,7 +13,7 @@ - + @@ -36,6 +36,6 @@

    Here is a usage example

    const disposable = await statsContainer('engineId', 'containerId', (stats: ContainerStatsInfo): void => {
    console.log('CPU Usage', stats.cpu_stats.cpu_usage.total_usage);
    });

    // When no longer needed
    disposable.dispose();

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:3527

    +

    packages/extension-api/src/extension-api.d.ts:3527

    \ No newline at end of file diff --git a/api/namespaces/containerEngine/functions/stopContainer.html b/api/namespaces/containerEngine/functions/stopContainer.html index 93ce0d24926..dc3eef5a4a8 100644 --- a/api/namespaces/containerEngine/functions/stopContainer.html +++ b/api/namespaces/containerEngine/functions/stopContainer.html @@ -13,7 +13,7 @@ - + @@ -30,6 +30,6 @@

    Returns

    Promise<void>

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:3539

    +

    packages/extension-api/src/extension-api.d.ts:3539

    \ No newline at end of file diff --git a/api/namespaces/containerEngine/functions/stopPod.html b/api/namespaces/containerEngine/functions/stopPod.html index 928bc96f0ed..e9eea3d5317 100644 --- a/api/namespaces/containerEngine/functions/stopPod.html +++ b/api/namespaces/containerEngine/functions/stopPod.html @@ -13,7 +13,7 @@ - + @@ -27,6 +27,6 @@

    Returns

    Promise<void>

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:3688

    +

    packages/extension-api/src/extension-api.d.ts:3688

    \ No newline at end of file diff --git a/api/namespaces/containerEngine/functions/tagImage.html b/api/namespaces/containerEngine/functions/tagImage.html index 0faf5ce5a4b..88fc0834a19 100644 --- a/api/namespaces/containerEngine/functions/tagImage.html +++ b/api/namespaces/containerEngine/functions/tagImage.html @@ -13,7 +13,7 @@ - + @@ -34,6 +34,6 @@

    Returns

    Promise<void>

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:3599

    +

    packages/extension-api/src/extension-api.d.ts:3599

    \ No newline at end of file diff --git a/api/namespaces/context.html b/api/namespaces/context.html index 9c51e193991..1d1be99b50f 100644 --- a/api/namespaces/context.html +++ b/api/namespaces/context.html @@ -13,7 +13,7 @@ - + diff --git a/api/namespaces/context/functions/setValue.html b/api/namespaces/context/functions/setValue.html index d8e3ca44d8b..27c79e2627b 100644 --- a/api/namespaces/context/functions/setValue.html +++ b/api/namespaces/context/functions/setValue.html @@ -13,7 +13,7 @@ - + @@ -34,6 +34,6 @@ The key should consists of '"extension-id"."actual-key"

    Returns

    void

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:4300

    +

    packages/extension-api/src/extension-api.d.ts:4300

    \ No newline at end of file diff --git a/api/namespaces/env.html b/api/namespaces/env.html index 354536b0305..ce636d1c70a 100644 --- a/api/namespaces/env.html +++ b/api/namespaces/env.html @@ -13,7 +13,7 @@ - + diff --git a/api/namespaces/env/functions/createTelemetryLogger.html b/api/namespaces/env/functions/createTelemetryLogger.html index 9f0d1f284c2..4b61af874ac 100644 --- a/api/namespaces/env/functions/createTelemetryLogger.html +++ b/api/namespaces/env/functions/createTelemetryLogger.html @@ -13,7 +13,7 @@ - + @@ -31,6 +31,6 @@

    TelemetryLogger

    A new telemetry logger

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:4021

    +

    packages/extension-api/src/extension-api.d.ts:4021

    \ No newline at end of file diff --git a/api/namespaces/env/functions/onDidChangeTelemetryEnabled.html b/api/namespaces/env/functions/onDidChangeTelemetryEnabled.html index b8082673fd0..34a72801a7f 100644 --- a/api/namespaces/env/functions/onDidChangeTelemetryEnabled.html +++ b/api/namespaces/env/functions/onDidChangeTelemetryEnabled.html @@ -13,7 +13,7 @@ - + @@ -34,6 +34,6 @@

    Disposable

    A disposable which unsubscribes the event listener.

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:4004

    +

    packages/extension-api/src/extension-api.d.ts:4004

    \ No newline at end of file diff --git a/api/namespaces/env/functions/openExternal.html b/api/namespaces/env/functions/openExternal.html index d2f64644de2..55922cfb42b 100644 --- a/api/namespaces/env/functions/openExternal.html +++ b/api/namespaces/env/functions/openExternal.html @@ -13,7 +13,7 @@ - + @@ -29,6 +29,6 @@

    Promise<boolean>

    A promise indicating if open was successful.

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:4012

    +

    packages/extension-api/src/extension-api.d.ts:4012

    \ No newline at end of file diff --git a/api/namespaces/env/variables/clipboard.html b/api/namespaces/env/variables/clipboard.html index 4541ec14ae9..68d4211dc57 100644 --- a/api/namespaces/env/variables/clipboard.html +++ b/api/namespaces/env/variables/clipboard.html @@ -13,7 +13,7 @@ - + @@ -23,6 +23,6 @@

    The system clipboard.

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:4026

    +

    packages/extension-api/src/extension-api.d.ts:4026

    \ No newline at end of file diff --git a/api/namespaces/env/variables/isLinux.html b/api/namespaces/env/variables/isLinux.html index 43e78f29723..9bf951b4d07 100644 --- a/api/namespaces/env/variables/isLinux.html +++ b/api/namespaces/env/variables/isLinux.html @@ -13,7 +13,7 @@ - + @@ -25,6 +25,6 @@

    If the value of this flag is true, it means the current system is Linux. If the value is false, it means the current system is not Linux.

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:3992

    +

    packages/extension-api/src/extension-api.d.ts:3992

    \ No newline at end of file diff --git a/api/namespaces/env/variables/isMac.html b/api/namespaces/env/variables/isMac.html index 343893f5b07..fa9220d1e63 100644 --- a/api/namespaces/env/variables/isMac.html +++ b/api/namespaces/env/variables/isMac.html @@ -13,7 +13,7 @@ - + @@ -25,6 +25,6 @@

    If the value of this flag is true, it means the current system is macOS. If the value is false, it means the current system is not macOS.

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:3976

    +

    packages/extension-api/src/extension-api.d.ts:3976

    \ No newline at end of file diff --git a/api/namespaces/env/variables/isTelemetryEnabled.html b/api/namespaces/env/variables/isTelemetryEnabled.html index 53b6a247ef8..443db6038d2 100644 --- a/api/namespaces/env/variables/isTelemetryEnabled.html +++ b/api/namespaces/env/variables/isTelemetryEnabled.html @@ -13,7 +13,7 @@ - + @@ -24,6 +24,6 @@

    Indicates whether the users has telemetry enabled. Can be observed to determine if the extension should send telemetry.

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:3998

    +

    packages/extension-api/src/extension-api.d.ts:3998

    \ No newline at end of file diff --git a/api/namespaces/env/variables/isWindows.html b/api/namespaces/env/variables/isWindows.html index 7c9199494a1..04962ab07ea 100644 --- a/api/namespaces/env/variables/isWindows.html +++ b/api/namespaces/env/variables/isWindows.html @@ -13,7 +13,7 @@ - + @@ -25,6 +25,6 @@

    If the value of this flag is true, it means the current system is Windows. If the value is false, it means the current system is not Windows.

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:3984

    +

    packages/extension-api/src/extension-api.d.ts:3984

    \ No newline at end of file diff --git a/api/namespaces/extensions.html b/api/namespaces/extensions.html index d084995fd97..14ba7af42fd 100644 --- a/api/namespaces/extensions.html +++ b/api/namespaces/extensions.html @@ -13,7 +13,7 @@ - + diff --git a/api/namespaces/extensions/functions/getExtension.html b/api/namespaces/extensions/functions/getExtension.html index 504eb1111e1..04e3853395a 100644 --- a/api/namespaces/extensions/functions/getExtension.html +++ b/api/namespaces/extensions/functions/getExtension.html @@ -13,7 +13,7 @@ - + @@ -31,6 +31,6 @@

    Extension<T> | undefined

    An extension or undefined.

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:234

    +

    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 4b8b25f0e71..504f6e784f7 100644 --- a/api/namespaces/extensions/functions/onDidChange.html +++ b/api/namespaces/extensions/functions/onDidChange.html @@ -13,7 +13,7 @@ - + @@ -34,6 +34,6 @@ installed, uninstalled, enabled or disabled.

    Disposable

    A disposable which unsubscribes the event listener.

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:246

    +

    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 a9964452a7f..4cbed42f245 100644 --- a/api/namespaces/extensions/variables/all.html +++ b/api/namespaces/extensions/variables/all.html @@ -13,7 +13,7 @@ - + @@ -23,6 +23,6 @@

    All extensions currently known to the system.

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:240

    +

    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 5e50bfd4dad..6574a66c131 100644 --- a/api/namespaces/fs.html +++ b/api/namespaces/fs.html @@ -13,7 +13,7 @@ - + diff --git a/api/namespaces/fs/functions/createFileSystemWatcher.html b/api/namespaces/fs/functions/createFileSystemWatcher.html index fc81795b650..0a79f6f7200 100644 --- a/api/namespaces/fs/functions/createFileSystemWatcher.html +++ b/api/namespaces/fs/functions/createFileSystemWatcher.html @@ -13,7 +13,7 @@ - + @@ -26,6 +26,6 @@

    Returns

    FileSystemWatcher

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:1678

    +

    packages/extension-api/src/extension-api.d.ts:1678

    \ No newline at end of file diff --git a/api/namespaces/imageChecker.html b/api/namespaces/imageChecker.html index b74a0bc85c3..7b571f98279 100644 --- a/api/namespaces/imageChecker.html +++ b/api/namespaces/imageChecker.html @@ -13,7 +13,7 @@ - + diff --git a/api/namespaces/imageChecker/functions/registerImageCheckerProvider.html b/api/namespaces/imageChecker/functions/registerImageCheckerProvider.html index 2c3583bbc62..6dec0a62b72 100644 --- a/api/namespaces/imageChecker/functions/registerImageCheckerProvider.html +++ b/api/namespaces/imageChecker/functions/registerImageCheckerProvider.html @@ -13,7 +13,7 @@ - + @@ -33,6 +33,6 @@ application can call the provider with specific tasks when necessary.

    Disposable

    A disposable that unregisters this provider when being disposed

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:4490

    +

    packages/extension-api/src/extension-api.d.ts:4490

    \ No newline at end of file diff --git a/api/namespaces/kubernetes.html b/api/namespaces/kubernetes.html index 60a7e101d36..21977e7a410 100644 --- a/api/namespaces/kubernetes.html +++ b/api/namespaces/kubernetes.html @@ -13,7 +13,7 @@ - + diff --git a/api/namespaces/kubernetes/functions/createResources.html b/api/namespaces/kubernetes/functions/createResources.html index d72c8776148..837beb8285a 100644 --- a/api/namespaces/kubernetes/functions/createResources.html +++ b/api/namespaces/kubernetes/functions/createResources.html @@ -13,7 +13,7 @@ - + @@ -30,6 +30,6 @@

    Returns

    Promise<void>

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:2113

    +

    packages/extension-api/src/extension-api.d.ts:2113

    \ No newline at end of file diff --git a/api/namespaces/kubernetes/functions/getKubeconfig.html b/api/namespaces/kubernetes/functions/getKubeconfig.html index 6051f051c0f..f7cc489a1dd 100644 --- a/api/namespaces/kubernetes/functions/getKubeconfig.html +++ b/api/namespaces/kubernetes/functions/getKubeconfig.html @@ -13,7 +13,7 @@ - + @@ -24,6 +24,6 @@

    Returns

    Uri

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:2103

    +

    packages/extension-api/src/extension-api.d.ts:2103

    \ No newline at end of file diff --git a/api/namespaces/kubernetes/functions/onDidUpdateKubeconfig.html b/api/namespaces/kubernetes/functions/onDidUpdateKubeconfig.html index 5b182c9be29..cbc77efdc06 100644 --- a/api/namespaces/kubernetes/functions/onDidUpdateKubeconfig.html +++ b/api/namespaces/kubernetes/functions/onDidUpdateKubeconfig.html @@ -13,7 +13,7 @@ - + @@ -32,6 +32,6 @@

    Disposable

    A disposable which unsubscribes the event listener.

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:2104

    +

    packages/extension-api/src/extension-api.d.ts:2104

    \ No newline at end of file diff --git a/api/namespaces/kubernetes/functions/registerKubernetesGenerator.html b/api/namespaces/kubernetes/functions/registerKubernetesGenerator.html index 1954836f191..3e690c0997e 100644 --- a/api/namespaces/kubernetes/functions/registerKubernetesGenerator.html +++ b/api/namespaces/kubernetes/functions/registerKubernetesGenerator.html @@ -13,7 +13,7 @@ - + @@ -28,6 +28,6 @@

    Returns

    Disposable

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:2119

    +

    packages/extension-api/src/extension-api.d.ts:2119

    \ No newline at end of file diff --git a/api/namespaces/kubernetes/functions/setKubeconfig.html b/api/namespaces/kubernetes/functions/setKubeconfig.html index faa7c5fc804..484ba489b6d 100644 --- a/api/namespaces/kubernetes/functions/setKubeconfig.html +++ b/api/namespaces/kubernetes/functions/setKubeconfig.html @@ -13,7 +13,7 @@ - + @@ -26,6 +26,6 @@

    Returns

    Promise<void>

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:2105

    +

    packages/extension-api/src/extension-api.d.ts:2105

    \ No newline at end of file diff --git a/api/namespaces/navigation.html b/api/namespaces/navigation.html index 06266d2045b..afd11040edb 100644 --- a/api/namespaces/navigation.html +++ b/api/namespaces/navigation.html @@ -13,7 +13,7 @@ - + diff --git a/api/namespaces/navigation/functions/navigateToAuthentication.html b/api/namespaces/navigation/functions/navigateToAuthentication.html index 035a0897723..97ff9c55f04 100644 --- a/api/namespaces/navigation/functions/navigateToAuthentication.html +++ b/api/namespaces/navigation/functions/navigateToAuthentication.html @@ -13,7 +13,7 @@ - + @@ -25,6 +25,6 @@

    Returns

    Promise<void>

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:4537

    +

    packages/extension-api/src/extension-api.d.ts:4537

    \ No newline at end of file diff --git a/api/namespaces/navigation/functions/navigateToContainer.html b/api/namespaces/navigation/functions/navigateToContainer.html index cb8cb4c6c26..1dee438cf05 100644 --- a/api/namespaces/navigation/functions/navigateToContainer.html +++ b/api/namespaces/navigation/functions/navigateToContainer.html @@ -13,7 +13,7 @@ - + @@ -26,6 +26,6 @@

    Returns

    Promise<void>

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:4500

    +

    packages/extension-api/src/extension-api.d.ts:4500

    \ No newline at end of file diff --git a/api/namespaces/navigation/functions/navigateToContainerInspect.html b/api/namespaces/navigation/functions/navigateToContainerInspect.html index a4743714106..1df2a00f342 100644 --- a/api/namespaces/navigation/functions/navigateToContainerInspect.html +++ b/api/namespaces/navigation/functions/navigateToContainerInspect.html @@ -13,7 +13,7 @@ - + @@ -26,6 +26,6 @@

    Returns

    Promise<void>

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:4504

    +

    packages/extension-api/src/extension-api.d.ts:4504

    \ No newline at end of file diff --git a/api/namespaces/navigation/functions/navigateToContainerLogs.html b/api/namespaces/navigation/functions/navigateToContainerLogs.html index ddfd09b704c..79781b74ac1 100644 --- a/api/namespaces/navigation/functions/navigateToContainerLogs.html +++ b/api/namespaces/navigation/functions/navigateToContainerLogs.html @@ -13,7 +13,7 @@ - + @@ -26,6 +26,6 @@

    Returns

    Promise<void>

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:4502

    +

    packages/extension-api/src/extension-api.d.ts:4502

    \ No newline at end of file diff --git a/api/namespaces/navigation/functions/navigateToContainerTerminal.html b/api/namespaces/navigation/functions/navigateToContainerTerminal.html index 9c082271872..c09796e9749 100644 --- a/api/namespaces/navigation/functions/navigateToContainerTerminal.html +++ b/api/namespaces/navigation/functions/navigateToContainerTerminal.html @@ -13,7 +13,7 @@ - + @@ -26,6 +26,6 @@

    Returns

    Promise<void>

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:4506

    +

    packages/extension-api/src/extension-api.d.ts:4506

    \ No newline at end of file diff --git a/api/namespaces/navigation/functions/navigateToContainers.html b/api/namespaces/navigation/functions/navigateToContainers.html index 399341703cb..ce6851ed902 100644 --- a/api/namespaces/navigation/functions/navigateToContainers.html +++ b/api/namespaces/navigation/functions/navigateToContainers.html @@ -13,7 +13,7 @@ - + @@ -24,6 +24,6 @@

    Returns

    Promise<void>

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:4498

    +

    packages/extension-api/src/extension-api.d.ts:4498

    \ No newline at end of file diff --git a/api/namespaces/navigation/functions/navigateToContribution.html b/api/namespaces/navigation/functions/navigateToContribution.html index ed1df0e189a..5eabc0a90b1 100644 --- a/api/namespaces/navigation/functions/navigateToContribution.html +++ b/api/namespaces/navigation/functions/navigateToContribution.html @@ -13,7 +13,7 @@ - + @@ -26,6 +26,6 @@

    Returns

    Promise<void>

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:4524

    +

    packages/extension-api/src/extension-api.d.ts:4524

    \ No newline at end of file diff --git a/api/namespaces/navigation/functions/navigateToEditProviderContainerConnection.html b/api/namespaces/navigation/functions/navigateToEditProviderContainerConnection.html index 06696fc92d6..663e962da76 100644 --- a/api/namespaces/navigation/functions/navigateToEditProviderContainerConnection.html +++ b/api/namespaces/navigation/functions/navigateToEditProviderContainerConnection.html @@ -13,7 +13,7 @@ - + @@ -27,6 +27,6 @@

    Returns

    Promise<void>

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:4546

    +

    packages/extension-api/src/extension-api.d.ts:4546

    \ No newline at end of file diff --git a/api/namespaces/navigation/functions/navigateToImage.html b/api/namespaces/navigation/functions/navigateToImage.html index c430a6053a7..782dd320208 100644 --- a/api/namespaces/navigation/functions/navigateToImage.html +++ b/api/namespaces/navigation/functions/navigateToImage.html @@ -13,7 +13,7 @@ - + @@ -28,6 +28,6 @@

    Returns

    Promise<void>

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:4511

    +

    packages/extension-api/src/extension-api.d.ts:4511

    \ No newline at end of file diff --git a/api/namespaces/navigation/functions/navigateToImages.html b/api/namespaces/navigation/functions/navigateToImages.html index de7463f0a61..888dc966015 100644 --- a/api/namespaces/navigation/functions/navigateToImages.html +++ b/api/namespaces/navigation/functions/navigateToImages.html @@ -13,7 +13,7 @@ - + @@ -24,6 +24,6 @@

    Returns

    Promise<void>

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:4509

    +

    packages/extension-api/src/extension-api.d.ts:4509

    \ No newline at end of file diff --git a/api/namespaces/navigation/functions/navigateToPod.html b/api/namespaces/navigation/functions/navigateToPod.html index 775cd03bbff..cab1d76b8b8 100644 --- a/api/namespaces/navigation/functions/navigateToPod.html +++ b/api/namespaces/navigation/functions/navigateToPod.html @@ -13,7 +13,7 @@ - + @@ -28,6 +28,6 @@

    Returns

    Promise<void>

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:4521

    +

    packages/extension-api/src/extension-api.d.ts:4521

    \ No newline at end of file diff --git a/api/namespaces/navigation/functions/navigateToPods.html b/api/namespaces/navigation/functions/navigateToPods.html index 72fb90fc5b9..9c948c53ca1 100644 --- a/api/namespaces/navigation/functions/navigateToPods.html +++ b/api/namespaces/navigation/functions/navigateToPods.html @@ -13,7 +13,7 @@ - + @@ -24,6 +24,6 @@

    Returns

    Promise<void>

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:4519

    +

    packages/extension-api/src/extension-api.d.ts:4519

    \ No newline at end of file diff --git a/api/namespaces/navigation/functions/navigateToResources.html b/api/namespaces/navigation/functions/navigateToResources.html index 884180dee3d..6b473dcb3ec 100644 --- a/api/namespaces/navigation/functions/navigateToResources.html +++ b/api/namespaces/navigation/functions/navigateToResources.html @@ -13,7 +13,7 @@ - + @@ -25,6 +25,6 @@

    Returns

    Promise<void>

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:4542

    +

    packages/extension-api/src/extension-api.d.ts:4542

    \ No newline at end of file diff --git a/api/namespaces/navigation/functions/navigateToVolume.html b/api/namespaces/navigation/functions/navigateToVolume.html index 0524b76cff7..bb9ec6aacb3 100644 --- a/api/namespaces/navigation/functions/navigateToVolume.html +++ b/api/namespaces/navigation/functions/navigateToVolume.html @@ -13,7 +13,7 @@ - + @@ -27,6 +27,6 @@

    Returns

    Promise<void>

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:4516

    +

    packages/extension-api/src/extension-api.d.ts:4516

    \ No newline at end of file diff --git a/api/namespaces/navigation/functions/navigateToVolumes.html b/api/namespaces/navigation/functions/navigateToVolumes.html index 76f435b9e42..3fd3f06940c 100644 --- a/api/namespaces/navigation/functions/navigateToVolumes.html +++ b/api/namespaces/navigation/functions/navigateToVolumes.html @@ -13,7 +13,7 @@ - + @@ -24,6 +24,6 @@

    Returns

    Promise<void>

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:4514

    +

    packages/extension-api/src/extension-api.d.ts:4514

    \ No newline at end of file diff --git a/api/namespaces/navigation/functions/navigateToWebview.html b/api/namespaces/navigation/functions/navigateToWebview.html index 0d4bcd1a53b..c63e4ac3156 100644 --- a/api/namespaces/navigation/functions/navigateToWebview.html +++ b/api/namespaces/navigation/functions/navigateToWebview.html @@ -13,7 +13,7 @@ - + @@ -33,6 +33,6 @@
  • createWebviewPanel for creating a Webview
  • Defined in

    -

    packages/extension-api/src/extension-api.d.ts:4532

    +

    packages/extension-api/src/extension-api.d.ts:4532

    \ No newline at end of file diff --git a/api/namespaces/process.html b/api/namespaces/process.html index 45d90ca29b6..fd53df98a13 100644 --- a/api/namespaces/process.html +++ b/api/namespaces/process.html @@ -13,7 +13,7 @@ - + diff --git a/api/namespaces/process/functions/exec.html b/api/namespaces/process/functions/exec.html index beda8b4c3fb..da52d396d3c 100644 --- a/api/namespaces/process/functions/exec.html +++ b/api/namespaces/process/functions/exec.html @@ -13,7 +13,7 @@ - + @@ -36,6 +36,6 @@ stdout, and stderr content.

    Throws

    RunError if provided command can not be executed.

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:4137

    +

    packages/extension-api/src/extension-api.d.ts:4137

    \ No newline at end of file diff --git a/api/namespaces/provider.html b/api/namespaces/provider.html index 54ec3428642..475b848ffc3 100644 --- a/api/namespaces/provider.html +++ b/api/namespaces/provider.html @@ -13,7 +13,7 @@ - + diff --git a/api/namespaces/provider/functions/createImageFilesProvider.html b/api/namespaces/provider/functions/createImageFilesProvider.html index 34d48505c03..3aab4fa184b 100644 --- a/api/namespaces/provider/functions/createImageFilesProvider.html +++ b/api/namespaces/provider/functions/createImageFilesProvider.html @@ -13,7 +13,7 @@ - + @@ -34,6 +34,6 @@ application can call the provider with specific tasks when necessary.

    ImageFilesProvider

    A disposable that unregisters this provider when being disposed

    Defined in

    -

    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/namespaces/provider/functions/createProvider.html b/api/namespaces/provider/functions/createProvider.html index de960628a59..4767abbd1a6 100644 --- a/api/namespaces/provider/functions/createProvider.html +++ b/api/namespaces/provider/functions/createProvider.html @@ -13,7 +13,7 @@ - + @@ -26,6 +26,6 @@

    Returns

    Provider

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:831

    +

    packages/extension-api/src/extension-api.d.ts:831

    \ No newline at end of file diff --git a/api/namespaces/provider/functions/getContainerConnections.html b/api/namespaces/provider/functions/getContainerConnections.html index 5c1b48ef16b..02e798a8d94 100644 --- a/api/namespaces/provider/functions/getContainerConnections.html +++ b/api/namespaces/provider/functions/getContainerConnections.html @@ -13,7 +13,7 @@ - + @@ -24,6 +24,6 @@

    Returns

    ProviderContainerConnection[]

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:837

    +

    packages/extension-api/src/extension-api.d.ts:837

    \ No newline at end of file diff --git a/api/namespaces/provider/functions/getProviderLifecycleContext.html b/api/namespaces/provider/functions/getProviderLifecycleContext.html index 817c4ad40ba..1ffc914a92b 100644 --- a/api/namespaces/provider/functions/getProviderLifecycleContext.html +++ b/api/namespaces/provider/functions/getProviderLifecycleContext.html @@ -13,7 +13,7 @@ - + @@ -34,6 +34,6 @@ If no context is found it throws an error

    Throws

    if no provider with the id has been found or there is no context associate to it.

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:847

    +

    packages/extension-api/src/extension-api.d.ts:847

    \ No newline at end of file diff --git a/api/namespaces/provider/functions/onDidRegisterContainerConnection.html b/api/namespaces/provider/functions/onDidRegisterContainerConnection.html index 585d0eecada..e1d94036a18 100644 --- a/api/namespaces/provider/functions/onDidRegisterContainerConnection.html +++ b/api/namespaces/provider/functions/onDidRegisterContainerConnection.html @@ -13,7 +13,7 @@ - + @@ -32,6 +32,6 @@

    Disposable

    A disposable which unsubscribes the event listener.

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:836

    +

    packages/extension-api/src/extension-api.d.ts:836

    \ No newline at end of file diff --git a/api/namespaces/provider/functions/onDidUnregisterContainerConnection.html b/api/namespaces/provider/functions/onDidUnregisterContainerConnection.html index d96e7c413a6..e5b6d7fedc0 100644 --- a/api/namespaces/provider/functions/onDidUnregisterContainerConnection.html +++ b/api/namespaces/provider/functions/onDidUnregisterContainerConnection.html @@ -13,7 +13,7 @@ - + @@ -32,6 +32,6 @@

    Disposable

    A disposable which unsubscribes the event listener.

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:835

    +

    packages/extension-api/src/extension-api.d.ts:835

    \ No newline at end of file diff --git a/api/namespaces/provider/functions/onDidUpdateContainerConnection.html b/api/namespaces/provider/functions/onDidUpdateContainerConnection.html index 3eddcc660c6..7111b636a2a 100644 --- a/api/namespaces/provider/functions/onDidUpdateContainerConnection.html +++ b/api/namespaces/provider/functions/onDidUpdateContainerConnection.html @@ -13,7 +13,7 @@ - + @@ -32,6 +32,6 @@

    Disposable

    A disposable which unsubscribes the event listener.

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:833

    +

    packages/extension-api/src/extension-api.d.ts:833

    \ No newline at end of file diff --git a/api/namespaces/provider/functions/onDidUpdateKubernetesConnection.html b/api/namespaces/provider/functions/onDidUpdateKubernetesConnection.html index 3885be3810c..2fe5ab24bae 100644 --- a/api/namespaces/provider/functions/onDidUpdateKubernetesConnection.html +++ b/api/namespaces/provider/functions/onDidUpdateKubernetesConnection.html @@ -13,7 +13,7 @@ - + @@ -32,6 +32,6 @@

    Disposable

    A disposable which unsubscribes the event listener.

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:834

    +

    packages/extension-api/src/extension-api.d.ts:834

    \ No newline at end of file diff --git a/api/namespaces/provider/functions/onDidUpdateProvider.html b/api/namespaces/provider/functions/onDidUpdateProvider.html index 329ab3fcf82..029b0db6831 100644 --- a/api/namespaces/provider/functions/onDidUpdateProvider.html +++ b/api/namespaces/provider/functions/onDidUpdateProvider.html @@ -13,7 +13,7 @@ - + @@ -32,6 +32,6 @@

    Disposable

    A disposable which unsubscribes the event listener.

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:832

    +

    packages/extension-api/src/extension-api.d.ts:832

    \ No newline at end of file diff --git a/api/namespaces/proxy.html b/api/namespaces/proxy.html index cd4555be269..b732796c19b 100644 --- a/api/namespaces/proxy.html +++ b/api/namespaces/proxy.html @@ -13,7 +13,7 @@ - + diff --git a/api/namespaces/proxy/functions/getProxySettings.html b/api/namespaces/proxy/functions/getProxySettings.html index 3250f797fec..aa04ad73c70 100644 --- a/api/namespaces/proxy/functions/getProxySettings.html +++ b/api/namespaces/proxy/functions/getProxySettings.html @@ -13,7 +13,7 @@ - + @@ -24,6 +24,6 @@

    Returns

    ProxySettings | undefined

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:874

    +

    packages/extension-api/src/extension-api.d.ts:874

    \ No newline at end of file diff --git a/api/namespaces/proxy/functions/isEnabled.html b/api/namespaces/proxy/functions/isEnabled.html index 5f36ca6bb0c..01b6c777bca 100644 --- a/api/namespaces/proxy/functions/isEnabled.html +++ b/api/namespaces/proxy/functions/isEnabled.html @@ -13,7 +13,7 @@ - + @@ -24,6 +24,6 @@

    Returns

    boolean

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:880

    +

    packages/extension-api/src/extension-api.d.ts:880

    \ No newline at end of file diff --git a/api/namespaces/proxy/functions/onDidStateChange.html b/api/namespaces/proxy/functions/onDidStateChange.html index 8c4ee8d4dd4..196a3a05c46 100644 --- a/api/namespaces/proxy/functions/onDidStateChange.html +++ b/api/namespaces/proxy/functions/onDidStateChange.html @@ -13,7 +13,7 @@ - + @@ -32,6 +32,6 @@

    Disposable

    A disposable which unsubscribes the event listener.

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:881

    +

    packages/extension-api/src/extension-api.d.ts:881

    \ No newline at end of file diff --git a/api/namespaces/proxy/functions/onDidUpdateProxy.html b/api/namespaces/proxy/functions/onDidUpdateProxy.html index 3ba9b29ea1b..59c1eaa1580 100644 --- a/api/namespaces/proxy/functions/onDidUpdateProxy.html +++ b/api/namespaces/proxy/functions/onDidUpdateProxy.html @@ -13,7 +13,7 @@ - + @@ -32,6 +32,6 @@

    Disposable

    A disposable which unsubscribes the event listener.

    Defined in

    -

    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/namespaces/proxy/functions/setProxy.html b/api/namespaces/proxy/functions/setProxy.html index 598f09cf639..cb385fcf8c4 100644 --- a/api/namespaces/proxy/functions/setProxy.html +++ b/api/namespaces/proxy/functions/setProxy.html @@ -13,7 +13,7 @@ - + @@ -26,6 +26,6 @@

    Returns

    Promise<void>

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:875

    +

    packages/extension-api/src/extension-api.d.ts:875

    \ No newline at end of file diff --git a/api/namespaces/registry.html b/api/namespaces/registry.html index 34b245f16a2..2ad016af4f4 100644 --- a/api/namespaces/registry.html +++ b/api/namespaces/registry.html @@ -13,7 +13,7 @@ - + diff --git a/api/namespaces/registry/functions/onDidRegisterRegistry.html b/api/namespaces/registry/functions/onDidRegisterRegistry.html index 1d38611676f..682ebee029a 100644 --- a/api/namespaces/registry/functions/onDidRegisterRegistry.html +++ b/api/namespaces/registry/functions/onDidRegisterRegistry.html @@ -13,7 +13,7 @@ - + @@ -32,6 +32,6 @@

    Disposable

    A disposable which unsubscribes the event listener.

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:931

    +

    packages/extension-api/src/extension-api.d.ts:931

    \ No newline at end of file diff --git a/api/namespaces/registry/functions/onDidUnregisterRegistry.html b/api/namespaces/registry/functions/onDidUnregisterRegistry.html index 78fd90ac13a..40ed84ffd15 100644 --- a/api/namespaces/registry/functions/onDidUnregisterRegistry.html +++ b/api/namespaces/registry/functions/onDidUnregisterRegistry.html @@ -13,7 +13,7 @@ - + @@ -32,6 +32,6 @@

    Disposable

    A disposable which unsubscribes the event listener.

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:933

    +

    packages/extension-api/src/extension-api.d.ts:933

    \ No newline at end of file diff --git a/api/namespaces/registry/functions/onDidUpdateRegistry.html b/api/namespaces/registry/functions/onDidUpdateRegistry.html index 89536d3f534..c01767ea123 100644 --- a/api/namespaces/registry/functions/onDidUpdateRegistry.html +++ b/api/namespaces/registry/functions/onDidUpdateRegistry.html @@ -13,7 +13,7 @@ - + @@ -32,6 +32,6 @@

    Disposable

    A disposable which unsubscribes the event listener.

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:932

    +

    packages/extension-api/src/extension-api.d.ts:932

    \ No newline at end of file diff --git a/api/namespaces/registry/functions/registerRegistry.html b/api/namespaces/registry/functions/registerRegistry.html index 5229898fa01..795b6498072 100644 --- a/api/namespaces/registry/functions/registerRegistry.html +++ b/api/namespaces/registry/functions/registerRegistry.html @@ -13,7 +13,7 @@ - + @@ -26,6 +26,6 @@

    Returns

    Disposable

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:923

    +

    packages/extension-api/src/extension-api.d.ts:923

    \ No newline at end of file diff --git a/api/namespaces/registry/functions/registerRegistryProvider.html b/api/namespaces/registry/functions/registerRegistryProvider.html index c8b6e75fc1d..748116a2f82 100644 --- a/api/namespaces/registry/functions/registerRegistryProvider.html +++ b/api/namespaces/registry/functions/registerRegistryProvider.html @@ -13,7 +13,7 @@ - + @@ -26,6 +26,6 @@

    Returns

    Disposable

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:920

    +

    packages/extension-api/src/extension-api.d.ts:920

    \ No newline at end of file diff --git a/api/namespaces/registry/functions/suggestRegistry.html b/api/namespaces/registry/functions/suggestRegistry.html index ca82bb18398..ed83d79c79a 100644 --- a/api/namespaces/registry/functions/suggestRegistry.html +++ b/api/namespaces/registry/functions/suggestRegistry.html @@ -13,7 +13,7 @@ - + @@ -26,6 +26,6 @@

    Returns

    Disposable

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:929

    +

    packages/extension-api/src/extension-api.d.ts:929

    \ No newline at end of file diff --git a/api/namespaces/registry/functions/unregisterRegistry.html b/api/namespaces/registry/functions/unregisterRegistry.html index be76755844e..0e720a3357d 100644 --- a/api/namespaces/registry/functions/unregisterRegistry.html +++ b/api/namespaces/registry/functions/unregisterRegistry.html @@ -13,7 +13,7 @@ - + @@ -26,6 +26,6 @@

    Returns

    void

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:926

    +

    packages/extension-api/src/extension-api.d.ts:926

    \ No newline at end of file diff --git a/api/namespaces/tray.html b/api/namespaces/tray.html index 0be413735a9..5eb88bdaeb8 100644 --- a/api/namespaces/tray.html +++ b/api/namespaces/tray.html @@ -13,7 +13,7 @@ - + diff --git a/api/namespaces/tray/functions/registerMenuItem.html b/api/namespaces/tray/functions/registerMenuItem.html index a1e59aece09..cea257ac5bf 100644 --- a/api/namespaces/tray/functions/registerMenuItem.html +++ b/api/namespaces/tray/functions/registerMenuItem.html @@ -13,7 +13,7 @@ - + @@ -28,6 +28,6 @@

    Returns

    Disposable

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:941

    +

    packages/extension-api/src/extension-api.d.ts:941

    \ No newline at end of file diff --git a/api/namespaces/tray/functions/registerProviderMenuItem.html b/api/namespaces/tray/functions/registerProviderMenuItem.html index 811ef469050..eb536098841 100644 --- a/api/namespaces/tray/functions/registerProviderMenuItem.html +++ b/api/namespaces/tray/functions/registerProviderMenuItem.html @@ -13,7 +13,7 @@ - + @@ -29,6 +29,6 @@

    Returns

    Disposable

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:948

    +

    packages/extension-api/src/extension-api.d.ts:948

    \ No newline at end of file diff --git a/api/namespaces/window.html b/api/namespaces/window.html index 7887bded458..8500d5ca423 100644 --- a/api/namespaces/window.html +++ b/api/namespaces/window.html @@ -13,7 +13,7 @@ - + diff --git a/api/namespaces/window/functions/createCustomPick.html b/api/namespaces/window/functions/createCustomPick.html index 2258a5bb53d..483194fc4e9 100644 --- a/api/namespaces/window/functions/createCustomPick.html +++ b/api/namespaces/window/functions/createCustomPick.html @@ -13,7 +13,7 @@ - + @@ -28,6 +28,6 @@

    CustomPick<T>

    A new CustomPick

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:2085

    +

    packages/extension-api/src/extension-api.d.ts:2085

    \ No newline at end of file diff --git a/api/namespaces/window/functions/createStatusBarItem.html b/api/namespaces/window/functions/createStatusBarItem.html index 2d965de80e3..91aa96e7e15 100644 --- a/api/namespaces/window/functions/createStatusBarItem.html +++ b/api/namespaces/window/functions/createStatusBarItem.html @@ -13,7 +13,7 @@ - + @@ -31,6 +31,6 @@

    StatusBarItem

    A new status bar item.

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:1992

    +

    packages/extension-api/src/extension-api.d.ts:1992

    \ No newline at end of file diff --git a/api/namespaces/window/functions/createWebviewPanel.html b/api/namespaces/window/functions/createWebviewPanel.html index d565f3db621..6336f7cf7fe 100644 --- a/api/namespaces/window/functions/createWebviewPanel.html +++ b/api/namespaces/window/functions/createWebviewPanel.html @@ -13,7 +13,7 @@ - + @@ -33,6 +33,6 @@

    WebviewPanel

    New webview panel.

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:2096

    +

    packages/extension-api/src/extension-api.d.ts:2096

    \ No newline at end of file diff --git a/api/namespaces/window/functions/listWebviews.html b/api/namespaces/window/functions/listWebviews.html index 01397243155..6fd011b2854 100644 --- a/api/namespaces/window/functions/listWebviews.html +++ b/api/namespaces/window/functions/listWebviews.html @@ -13,7 +13,7 @@ - + @@ -24,6 +24,6 @@

    Returns

    Promise<WebviewInfo[]>

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:2098

    +

    packages/extension-api/src/extension-api.d.ts:2098

    \ No newline at end of file diff --git a/api/namespaces/window/functions/showErrorMessage.html b/api/namespaces/window/functions/showErrorMessage.html index 993e867bd2c..ebe5675a69a 100644 --- a/api/namespaces/window/functions/showErrorMessage.html +++ b/api/namespaces/window/functions/showErrorMessage.html @@ -13,7 +13,7 @@ - + @@ -32,6 +32,6 @@ clickable buttons.

    Promise<string | undefined>

    A promise that resolves to the selected item or undefined when being dismissed.

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:1913

    +

    packages/extension-api/src/extension-api.d.ts:1913

    \ No newline at end of file diff --git a/api/namespaces/window/functions/showInformationMessage.html b/api/namespaces/window/functions/showInformationMessage.html index 33c7be6728b..00019b59d49 100644 --- a/api/namespaces/window/functions/showInformationMessage.html +++ b/api/namespaces/window/functions/showInformationMessage.html @@ -13,7 +13,7 @@ - + @@ -32,6 +32,6 @@ clickable buttons.

    Promise<string | undefined>

    A promise that resolves to the selected item or undefined when being dismissed.

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:1893

    +

    packages/extension-api/src/extension-api.d.ts:1893

    \ No newline at end of file diff --git a/api/namespaces/window/functions/showInputBox.html b/api/namespaces/window/functions/showInputBox.html index 781eff14493..0ba6c77dd27 100644 --- a/api/namespaces/window/functions/showInputBox.html +++ b/api/namespaces/window/functions/showInputBox.html @@ -13,7 +13,7 @@ - + @@ -34,6 +34,6 @@ anything but dismissed the input box with OK.

    Promise<string | undefined>

    A promise that resolves to a string the user provided or to undefined in case of dismissal.

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:2005

    +

    packages/extension-api/src/extension-api.d.ts:2005

    \ No newline at end of file diff --git a/api/namespaces/window/functions/showNotification.html b/api/namespaces/window/functions/showNotification.html index ea9f513e8cb..9ddda9b43c7 100644 --- a/api/namespaces/window/functions/showNotification.html +++ b/api/namespaces/window/functions/showNotification.html @@ -13,7 +13,7 @@ - + @@ -28,6 +28,6 @@

    Returns

    Disposable

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:1983

    +

    packages/extension-api/src/extension-api.d.ts:1983

    \ No newline at end of file diff --git a/api/namespaces/window/functions/showOpenDialog.html b/api/namespaces/window/functions/showOpenDialog.html index bd06cb93097..b39d411dc06 100644 --- a/api/namespaces/window/functions/showOpenDialog.html +++ b/api/namespaces/window/functions/showOpenDialog.html @@ -13,7 +13,7 @@ - + @@ -30,6 +30,6 @@ for opening-purposes.

    Promise<Uri[] | undefined>

    A promise that resolves to the selected resources or undefined.

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:2014

    +

    packages/extension-api/src/extension-api.d.ts:2014

    \ No newline at end of file diff --git a/api/namespaces/window/functions/showQuickPick.html b/api/namespaces/window/functions/showQuickPick.html index 3f158e8dac0..9d04a568696 100644 --- a/api/namespaces/window/functions/showQuickPick.html +++ b/api/namespaces/window/functions/showQuickPick.html @@ -13,7 +13,7 @@ - + @@ -34,7 +34,7 @@

    Promise<string[] | undefined>

    A promise that resolves to the selected items or undefined.

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:2033

    +

    packages/extension-api/src/extension-api.d.ts:2033

    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.

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:2047

    +

    packages/extension-api/src/extension-api.d.ts:2047

    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.

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:2061

    +

    packages/extension-api/src/extension-api.d.ts:2061

    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.

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:2075

    +

    packages/extension-api/src/extension-api.d.ts:2075

    \ No newline at end of file diff --git a/api/namespaces/window/functions/showSaveDialog.html b/api/namespaces/window/functions/showSaveDialog.html index 254a95124ab..9ba9e2d0ca7 100644 --- a/api/namespaces/window/functions/showSaveDialog.html +++ b/api/namespaces/window/functions/showSaveDialog.html @@ -13,7 +13,7 @@ - + @@ -30,6 +30,6 @@ for saving-purposes.

    Promise<Uri | undefined>

    A promise that resolves to the selected resource or undefined.

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:2023

    +

    packages/extension-api/src/extension-api.d.ts:2023

    \ No newline at end of file diff --git a/api/namespaces/window/functions/showWarningMessage.html b/api/namespaces/window/functions/showWarningMessage.html index a056daa9c43..b814d2db8dc 100644 --- a/api/namespaces/window/functions/showWarningMessage.html +++ b/api/namespaces/window/functions/showWarningMessage.html @@ -13,7 +13,7 @@ - + @@ -32,6 +32,6 @@ clickable buttons.

    Promise<string | undefined>

    A promise that resolves to the selected item or undefined when being dismissed.

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:1903

    +

    packages/extension-api/src/extension-api.d.ts:1903

    \ No newline at end of file diff --git a/api/namespaces/window/functions/withProgress.html b/api/namespaces/window/functions/withProgress.html index 421dd39ebd0..ec7c52f6e72 100644 --- a/api/namespaces/window/functions/withProgress.html +++ b/api/namespaces/window/functions/withProgress.html @@ -13,7 +13,7 @@ - + @@ -50,6 +50,6 @@ long-running operation.

    You can return a value from the task callback

    const result: number = await window.withProgress<number>(
    { location: ProgressLocation.TASK_WIDGET, title: `Running task` },
    async progress => {
    // compute something
    return 55;
    },
    );

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:1974

    +

    packages/extension-api/src/extension-api.d.ts:1974

    \ No newline at end of file diff --git a/api/type-aliases/CheckResultLink.html b/api/type-aliases/CheckResultLink.html index cf06719d14b..0a52139d941 100644 --- a/api/type-aliases/CheckResultLink.html +++ b/api/type-aliases/CheckResultLink.html @@ -13,7 +13,7 @@ - + @@ -22,6 +22,6 @@

    CheckResultLink: Link

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:537

    +

    packages/extension-api/src/extension-api.d.ts:537

    \ No newline at end of file diff --git a/api/type-aliases/CliToolInstallationSource.html b/api/type-aliases/CliToolInstallationSource.html index 5b5046cb9f7..ee64bdf6a86 100644 --- a/api/type-aliases/CliToolInstallationSource.html +++ b/api/type-aliases/CliToolInstallationSource.html @@ -13,7 +13,7 @@ - + @@ -22,6 +22,6 @@

    CliToolInstallationSource: "extension" | "external"

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:4303

    +

    packages/extension-api/src/extension-api.d.ts:4303

    \ No newline at end of file diff --git a/api/type-aliases/CliToolState.html b/api/type-aliases/CliToolState.html index ea9f2309f36..3017f155015 100644 --- a/api/type-aliases/CliToolState.html +++ b/api/type-aliases/CliToolState.html @@ -13,7 +13,7 @@ - + @@ -22,6 +22,6 @@

    CliToolState: "registered"

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:4362

    +

    packages/extension-api/src/extension-api.d.ts:4362

    \ No newline at end of file diff --git a/api/type-aliases/ConfigurationScope.html b/api/type-aliases/ConfigurationScope.html index 5ab95b24fed..24be76a9fd8 100644 --- a/api/type-aliases/ConfigurationScope.html +++ b/api/type-aliases/ConfigurationScope.html @@ -13,7 +13,7 @@ - + @@ -23,6 +23,6 @@

    The configuration scope

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:963

    +

    packages/extension-api/src/extension-api.d.ts:963

    \ No newline at end of file diff --git a/api/type-aliases/KubernetesGeneratorArgument.html b/api/type-aliases/KubernetesGeneratorArgument.html index d3f49db70e7..513f00d4703 100644 --- a/api/type-aliases/KubernetesGeneratorArgument.html +++ b/api/type-aliases/KubernetesGeneratorArgument.html @@ -13,7 +13,7 @@ - + @@ -39,6 +39,6 @@

    optional pods: string[]

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:2140

    +

    packages/extension-api/src/extension-api.d.ts:2140

    \ No newline at end of file diff --git a/api/type-aliases/KubernetesGeneratorSelector.html b/api/type-aliases/KubernetesGeneratorSelector.html index 1572198ec96..258705fc3fc 100644 --- a/api/type-aliases/KubernetesGeneratorSelector.html +++ b/api/type-aliases/KubernetesGeneratorSelector.html @@ -13,7 +13,7 @@ - + @@ -22,6 +22,6 @@

    KubernetesGeneratorSelector: KubernetesGeneratorType | ReadonlyArray<KubernetesGeneratorType>

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:2129

    +

    packages/extension-api/src/extension-api.d.ts:2129

    \ No newline at end of file diff --git a/api/type-aliases/KubernetesGeneratorType.html b/api/type-aliases/KubernetesGeneratorType.html index bb5fea95105..c905f0756fc 100644 --- a/api/type-aliases/KubernetesGeneratorType.html +++ b/api/type-aliases/KubernetesGeneratorType.html @@ -13,7 +13,7 @@ - + @@ -22,6 +22,6 @@

    KubernetesGeneratorType: "Compose" | "Pod" | "Container"

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:2131

    +

    packages/extension-api/src/extension-api.d.ts:2131

    \ No newline at end of file diff --git a/api/type-aliases/MountConfig.html b/api/type-aliases/MountConfig.html index 0f7540c26ed..6ad85f78683 100644 --- a/api/type-aliases/MountConfig.html +++ b/api/type-aliases/MountConfig.html @@ -13,7 +13,7 @@ - + @@ -22,6 +22,6 @@

    MountConfig: MountSettings[]

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:2419

    +

    packages/extension-api/src/extension-api.d.ts:2419

    \ No newline at end of file diff --git a/api/type-aliases/MountConsistency.html b/api/type-aliases/MountConsistency.html index 6081c13bc33..b1ebad1a122 100644 --- a/api/type-aliases/MountConsistency.html +++ b/api/type-aliases/MountConsistency.html @@ -13,7 +13,7 @@ - + @@ -22,6 +22,6 @@

    MountConsistency: "default" | "consistent" | "cached" | "delegated"

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:2391

    +

    packages/extension-api/src/extension-api.d.ts:2391

    \ No newline at end of file diff --git a/api/type-aliases/MountPropagation.html b/api/type-aliases/MountPropagation.html index f79ea493342..51b000e2bcd 100644 --- a/api/type-aliases/MountPropagation.html +++ b/api/type-aliases/MountPropagation.html @@ -13,7 +13,7 @@ - + @@ -22,6 +22,6 @@

    MountPropagation: "private" | "rprivate" | "shared" | "rshared" | "slave" | "rslave"

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:2393

    +

    packages/extension-api/src/extension-api.d.ts:2393

    \ No newline at end of file diff --git a/api/type-aliases/MountType.html b/api/type-aliases/MountType.html index 770d11c90e8..bf8f3272dd0 100644 --- a/api/type-aliases/MountType.html +++ b/api/type-aliases/MountType.html @@ -13,7 +13,7 @@ - + @@ -22,6 +22,6 @@

    MountType: "bind" | "volume" | "tmpfs"

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:2389

    +

    packages/extension-api/src/extension-api.d.ts:2389

    \ No newline at end of file diff --git a/api/type-aliases/NotificationType.html b/api/type-aliases/NotificationType.html index 284f4239dc3..e6c838a00fd 100644 --- a/api/type-aliases/NotificationType.html +++ b/api/type-aliases/NotificationType.html @@ -13,7 +13,7 @@ - + @@ -22,6 +22,6 @@

    NotificationType: "info" | "warn" | "error"

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:1451

    +

    packages/extension-api/src/extension-api.d.ts:1451

    \ No newline at end of file diff --git a/api/type-aliases/ProviderConnectionStatus.html b/api/type-aliases/ProviderConnectionStatus.html index 2cf34740d94..ba39450719c 100644 --- a/api/type-aliases/ProviderConnectionStatus.html +++ b/api/type-aliases/ProviderConnectionStatus.html @@ -13,7 +13,7 @@ - + @@ -22,6 +22,6 @@

    ProviderConnectionStatus: "started" | "stopped" | "starting" | "stopping" | "unknown"

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:327

    +

    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 2e3f10853d9..a4bbb30c413 100644 --- a/api/type-aliases/ProviderLinks.html +++ b/api/type-aliases/ProviderLinks.html @@ -13,7 +13,7 @@ - + @@ -22,6 +22,6 @@

    ProviderLinks: Link

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:601

    +

    packages/extension-api/src/extension-api.d.ts:601

    \ No newline at end of file diff --git a/api/type-aliases/ProviderResult.html b/api/type-aliases/ProviderResult.html index 2090fb40042..44e6c582c3a 100644 --- a/api/type-aliases/ProviderResult.html +++ b/api/type-aliases/ProviderResult.html @@ -13,7 +13,7 @@ - + @@ -30,6 +30,6 @@ Promise.

    Type Parameters

    T

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:276

    +

    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 24c246b7dfc..88d119d11cd 100644 --- a/api/type-aliases/ProviderStatus.html +++ b/api/type-aliases/ProviderStatus.html @@ -13,7 +13,7 @@ - + @@ -22,6 +22,6 @@

    ProviderStatus: "not-installed" | "installed" | "configuring" | "configured" | "ready" | "started" | "stopped" | "starting" | "stopping" | "error" | "unknown"

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:278

    +

    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 fb4638ee750..da858e62d5c 100644 --- a/api/type-aliases/StatusBarAlignment.html +++ b/api/type-aliases/StatusBarAlignment.html @@ -13,7 +13,7 @@ - + @@ -23,6 +23,6 @@

    Represents the alignment of status bar items.

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:1491

    +

    packages/extension-api/src/extension-api.d.ts:1491

    \ No newline at end of file diff --git a/api/variables/StatusBarAlignLeft.html b/api/variables/StatusBarAlignLeft.html index f3c3b11d75e..8623fbf1a0f 100644 --- a/api/variables/StatusBarAlignLeft.html +++ b/api/variables/StatusBarAlignLeft.html @@ -13,7 +13,7 @@ - + @@ -23,6 +23,6 @@

    Aligned to the left side.

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:1483

    +

    packages/extension-api/src/extension-api.d.ts:1483

    \ No newline at end of file diff --git a/api/variables/StatusBarAlignRight.html b/api/variables/StatusBarAlignRight.html index c2fece45465..18bb197b466 100644 --- a/api/variables/StatusBarAlignRight.html +++ b/api/variables/StatusBarAlignRight.html @@ -13,7 +13,7 @@ - + @@ -23,6 +23,6 @@

    Aligned to the right side.

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:1487

    +

    packages/extension-api/src/extension-api.d.ts:1487

    \ No newline at end of file diff --git a/api/variables/StatusBarItemDefaultPriority.html b/api/variables/StatusBarItemDefaultPriority.html index 55472590f6f..7b8664662c0 100644 --- a/api/variables/StatusBarItemDefaultPriority.html +++ b/api/variables/StatusBarItemDefaultPriority.html @@ -13,7 +13,7 @@ - + @@ -23,6 +23,6 @@

    Default priority for the status bar items.

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:1496

    +

    packages/extension-api/src/extension-api.d.ts:1496

    \ No newline at end of file diff --git a/api/variables/version.html b/api/variables/version.html index b0c97d3a6ee..32892f20521 100644 --- a/api/variables/version.html +++ b/api/variables/version.html @@ -13,7 +13,7 @@ - + @@ -23,6 +23,6 @@

    The version of Podman Desktop.

    Defined in

    -

    packages/extension-api/src/extension-api.d.ts:42

    +

    packages/extension-api/src/extension-api.d.ts:42

    \ No newline at end of file diff --git a/assets/js/0029a336.2c40c19a.js b/assets/js/0029a336.a827462c.js similarity index 97% rename from assets/js/0029a336.2c40c19a.js rename to assets/js/0029a336.a827462c.js index 400924d393f..612a0bed139 100644 --- a/assets/js/0029a336.2c40c19a.js +++ b/assets/js/0029a336.a827462c.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[1171],{35061:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>c,contentTitle:()=>o,default:()=>h,frontMatter:()=>i,metadata:()=>a,toc:()=>d});var r=s(62540),t=s(43023);const i={},o="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={},d=[{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:"Defined in",id:"defined-in",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",pre:"pre",strong:"strong",...(0,t.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.header,{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:"defined-in",children:"Defined in"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L1974",children:"packages/extension-api/src/extension-api.d.ts:1974"})})]})}function h(e={}){const{wrapper:n}={...(0,t.R)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(l,{...e})}):l(e)}},43023:(e,n,s)=>{s.d(n,{R:()=>o,x:()=>a});var r=s(63696);const t={},i=r.createContext(t);function o(e){const n=r.useContext(i);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function a(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:o(e.components),r.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[1171],{35061:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>c,contentTitle:()=>o,default:()=>h,frontMatter:()=>i,metadata:()=>a,toc:()=>d});var r=s(62540),t=s(43023);const i={},o="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={},d=[{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:"Defined in",id:"defined-in",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",pre:"pre",strong:"strong",...(0,t.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.header,{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:"defined-in",children:"Defined in"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L1974",children:"packages/extension-api/src/extension-api.d.ts:1974"})})]})}function h(e={}){const{wrapper:n}={...(0,t.R)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(l,{...e})}):l(e)}},43023:(e,n,s)=>{s.d(n,{R:()=>o,x:()=>a});var r=s(63696);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/0102eb3e.3a21f55e.js b/assets/js/0102eb3e.65e07fbe.js similarity index 76% rename from assets/js/0102eb3e.3a21f55e.js rename to assets/js/0102eb3e.65e07fbe.js index 379c971e7be..8440cf6645c 100644 --- a/assets/js/0102eb3e.3a21f55e.js +++ b/assets/js/0102eb3e.65e07fbe.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[90989],{31874:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>c,contentTitle:()=>d,default:()=>p,frontMatter:()=>r,metadata:()=>o,toc:()=>a});var t=i(62540),s=i(43023);const r={},d="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"}},c={},a=[{value:"Properties",id:"properties",level:2},{value:"id",id:"id",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"title",id:"title",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"viewType",id:"viewtype",level:3},{value:"Defined in",id:"defined-in-2",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",p:"p",strong:"strong",...(0,s.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.header,{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:"defined-in",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L3058",children:"packages/extension-api/src/extension-api.d.ts:3058"})}),"\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:"defined-in-1",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L3060",children:"packages/extension-api/src/extension-api.d.ts:3060"})}),"\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:"defined-in-2",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L3059",children:"packages/extension-api/src/extension-api.d.ts:3059"})})]})}function p(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},43023:(e,n,i)=>{i.d(n,{R:()=>d,x:()=>o});var t=i(63696);const s={},r=t.createContext(s);function d(e){const n=t.useContext(r);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:d(e.components),t.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[90989],{31874:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>o,contentTitle:()=>c,default:()=>p,frontMatter:()=>r,metadata:()=>d,toc:()=>a});var t=i(62540),s=i(43023);const r={},c="Interface: WebviewInfo",d={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"}},o={},a=[{value:"Properties",id:"properties",level:2},{value:"id",id:"id",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"title",id:"title",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"viewType",id:"viewtype",level:3},{value:"Defined in",id:"defined-in-2",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",p:"p",strong:"strong",...(0,s.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.header,{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:"defined-in",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L3058",children:"packages/extension-api/src/extension-api.d.ts:3058"})}),"\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:"defined-in-1",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L3060",children:"packages/extension-api/src/extension-api.d.ts:3060"})}),"\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:"defined-in-2",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L3059",children:"packages/extension-api/src/extension-api.d.ts:3059"})})]})}function p(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},43023:(e,n,i)=>{i.d(n,{R:()=>c,x:()=>d});var t=i(63696);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 d(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:c(e.components),t.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/01821883.300660dc.js b/assets/js/01821883.8da815af.js similarity index 84% rename from assets/js/01821883.300660dc.js rename to assets/js/01821883.8da815af.js index fcb17aef5b4..14f18455fb6 100644 --- a/assets/js/01821883.300660dc.js +++ b/assets/js/01821883.8da815af.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[39004],{44862:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>o,contentTitle:()=>c,default:()=>p,frontMatter:()=>d,metadata:()=>r,toc:()=>a});var s=i(62540),t=i(43023);const d={},c="Interface: DeviceRequest",r={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"}},o={},a=[{value:"Properties",id:"properties",level:2},{value:"Capabilities?",id:"capabilities",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"Count?",id:"count",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"DeviceIDs?",id:"deviceids",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"Driver?",id:"driver",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"Options?",id:"options",level:3},{value:"Index Signature",id:"index-signature",level:4},{value:"Defined in",id:"defined-in-4",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",p:"p",strong:"strong",...(0,t.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.header,{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:"defined-in",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2425",children:"packages/extension-api/src/extension-api.d.ts:2425"})}),"\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:"defined-in-1",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2423",children:"packages/extension-api/src/extension-api.d.ts:2423"})}),"\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:"defined-in-2",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2424",children:"packages/extension-api/src/extension-api.d.ts:2424"})}),"\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:"defined-in-3",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2422",children:"packages/extension-api/src/extension-api.d.ts:2422"})}),"\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:"defined-in-4",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2426",children:"packages/extension-api/src/extension-api.d.ts:2426"})})]})}function p(e={}){const{wrapper:n}={...(0,t.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},43023:(e,n,i)=>{i.d(n,{R:()=>c,x:()=>r});var s=i(63696);const t={},d=s.createContext(t);function c(e){const n=s.useContext(d);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(d.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[39004],{44862:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>o,contentTitle:()=>d,default:()=>p,frontMatter:()=>c,metadata:()=>r,toc:()=>a});var s=i(62540),t=i(43023);const c={},d="Interface: DeviceRequest",r={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"}},o={},a=[{value:"Properties",id:"properties",level:2},{value:"Capabilities?",id:"capabilities",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"Count?",id:"count",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"DeviceIDs?",id:"deviceids",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"Driver?",id:"driver",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"Options?",id:"options",level:3},{value:"Index Signature",id:"index-signature",level:4},{value:"Defined in",id:"defined-in-4",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",p:"p",strong:"strong",...(0,t.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.header,{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:"defined-in",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2425",children:"packages/extension-api/src/extension-api.d.ts:2425"})}),"\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:"defined-in-1",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2423",children:"packages/extension-api/src/extension-api.d.ts:2423"})}),"\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:"defined-in-2",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2424",children:"packages/extension-api/src/extension-api.d.ts:2424"})}),"\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:"defined-in-3",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2422",children:"packages/extension-api/src/extension-api.d.ts:2422"})}),"\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:"defined-in-4",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2426",children:"packages/extension-api/src/extension-api.d.ts:2426"})})]})}function p(e={}){const{wrapper:n}={...(0,t.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},43023:(e,n,i)=>{i.d(n,{R:()=>d,x:()=>r});var s=i(63696);const t={},c=s.createContext(t);function d(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:d(e.components),s.createElement(c.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/01a1d0f4.c06ba542.js b/assets/js/01a1d0f4.bc23bcbe.js similarity index 96% rename from assets/js/01a1d0f4.c06ba542.js rename to assets/js/01a1d0f4.bc23bcbe.js index 571c5c8d6f1..ae55ace249c 100644 --- a/assets/js/01a1d0f4.c06ba542.js +++ b/assets/js/01a1d0f4.bc23bcbe.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[63090],{45642:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>a,contentTitle:()=>o,default:()=>p,frontMatter:()=>t,metadata:()=>c,toc:()=>d});var s=i(62540),r=i(43023);const t={},o="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:"Defined in",id:"defined-in",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",strong:"strong",...(0,r.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.header,{children:(0,s.jsx)(n.h1,{id:"function-ondidunregistercontainerconnection",children:"Function: onDidUnregisterContainerConnection()"})}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"onDidUnregisterContainerConnection"}),"(",(0,s.jsx)(n.code,{children:"listener"}),", ",(0,s.jsx)(n.code,{children:"thisArgs"}),"?, ",(0,s.jsx)(n.code,{children:"disposables"}),"?): ",(0,s.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,s.jsx)(n.code,{children:"Disposable"})})]}),"\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:"listener"})]}),"\n",(0,s.jsx)(n.p,{children:"The listener function will be called when the event happens."}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"thisArgs?"}),": ",(0,s.jsx)(n.code,{children:"any"})]}),"\n",(0,s.jsxs)(n.p,{children:["The ",(0,s.jsx)(n.code,{children:"this"}),"-argument which will be used when calling the event listener."]}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"disposables?"}),": ",(0,s.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,s.jsx)(n.code,{children:"Disposable"})}),"[]"]}),"\n",(0,s.jsxs)(n.p,{children:["An array to which a ",(0,s.jsx)(n.a,{href:"/api/classes/Disposable",children:"Disposable"})," will be added."]}),"\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.p,{children:"A disposable which unsubscribes the event listener."}),"\n",(0,s.jsx)(n.h2,{id:"defined-in",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L835",children:"packages/extension-api/src/extension-api.d.ts:835"})})]})}function p(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},43023:(e,n,i)=>{i.d(n,{R:()=>o,x:()=>c});var s=i(63696);const r={},t=s.createContext(r);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(r):e.components||r:o(e.components),s.createElement(t.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[63090],{45642:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>a,contentTitle:()=>o,default:()=>p,frontMatter:()=>t,metadata:()=>c,toc:()=>d});var s=i(62540),r=i(43023);const t={},o="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:"Defined in",id:"defined-in",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",strong:"strong",...(0,r.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.header,{children:(0,s.jsx)(n.h1,{id:"function-ondidunregistercontainerconnection",children:"Function: onDidUnregisterContainerConnection()"})}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"onDidUnregisterContainerConnection"}),"(",(0,s.jsx)(n.code,{children:"listener"}),", ",(0,s.jsx)(n.code,{children:"thisArgs"}),"?, ",(0,s.jsx)(n.code,{children:"disposables"}),"?): ",(0,s.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,s.jsx)(n.code,{children:"Disposable"})})]}),"\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:"listener"})]}),"\n",(0,s.jsx)(n.p,{children:"The listener function will be called when the event happens."}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"thisArgs?"}),": ",(0,s.jsx)(n.code,{children:"any"})]}),"\n",(0,s.jsxs)(n.p,{children:["The ",(0,s.jsx)(n.code,{children:"this"}),"-argument which will be used when calling the event listener."]}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"disposables?"}),": ",(0,s.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,s.jsx)(n.code,{children:"Disposable"})}),"[]"]}),"\n",(0,s.jsxs)(n.p,{children:["An array to which a ",(0,s.jsx)(n.a,{href:"/api/classes/Disposable",children:"Disposable"})," will be added."]}),"\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.p,{children:"A disposable which unsubscribes the event listener."}),"\n",(0,s.jsx)(n.h2,{id:"defined-in",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L835",children:"packages/extension-api/src/extension-api.d.ts:835"})})]})}function p(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},43023:(e,n,i)=>{i.d(n,{R:()=>o,x:()=>c});var s=i(63696);const r={},t=s.createContext(r);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(r):e.components||r:o(e.components),s.createElement(t.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/030ccfd9.47c63788.js b/assets/js/030ccfd9.62027475.js similarity index 97% rename from assets/js/030ccfd9.47c63788.js rename to assets/js/030ccfd9.62027475.js index 66daf39bc43..848b5cd68e1 100644 --- a/assets/js/030ccfd9.47c63788.js +++ b/assets/js/030ccfd9.62027475.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[69345],{52939:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>o,default:()=>p,frontMatter:()=>c,metadata:()=>r,toc:()=>u});var s=t(62540),i=t(43023);const c={},o="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:"Defined in",id:"defined-in",level:2}];function d(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",strong:"strong",...(0,i.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.header,{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:"defined-in",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2103",children:"packages/extension-api/src/extension-api.d.ts:2103"})})]})}function p(e={}){const{wrapper:n}={...(0,i.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(d,{...e})}):d(e)}},43023:(e,n,t)=>{t.d(n,{R:()=>o,x:()=>r});var s=t(63696);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 r(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:o(e.components),s.createElement(c.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[69345],{52939:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>o,default:()=>p,frontMatter:()=>c,metadata:()=>r,toc:()=>u});var s=t(62540),i=t(43023);const c={},o="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:"Defined in",id:"defined-in",level:2}];function d(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",strong:"strong",...(0,i.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.header,{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:"defined-in",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2103",children:"packages/extension-api/src/extension-api.d.ts:2103"})})]})}function p(e={}){const{wrapper:n}={...(0,i.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(d,{...e})}):d(e)}},43023:(e,n,t)=>{t.d(n,{R:()=>o,x:()=>r});var s=t(63696);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 r(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/04a546a4.8f9617e9.js b/assets/js/04a546a4.a76ae295.js similarity index 84% rename from assets/js/04a546a4.8f9617e9.js rename to assets/js/04a546a4.a76ae295.js index 248e87d2e0a..69000dc6577 100644 --- a/assets/js/04a546a4.8f9617e9.js +++ b/assets/js/04a546a4.a76ae295.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[31672],{71155:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>o,contentTitle:()=>d,default:()=>h,frontMatter:()=>s,metadata:()=>a,toc:()=>c});var i=r(62540),t=r(43023);const s={},d="Interface: Clipboard",a={id:"interfaces/Clipboard",title:"Interface: Clipboard",description:"The clipboard provides read and write access to the system's clipboard.",source:"@site/api/interfaces/Clipboard.md",sourceDirName:"interfaces",slug:"/interfaces/Clipboard",permalink:"/api/interfaces/Clipboard",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"CliToolUpdateOptions",permalink:"/api/interfaces/CliToolUpdateOptions"},next:{title:"Command",permalink:"/api/interfaces/Command"}},o={},c=[{value:"Methods",id:"methods",level:2},{value:"readText()",id:"readtext",level:3},{value:"Returns",id:"returns",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"writeText()",id:"writetext",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Defined in",id:"defined-in-1",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",p:"p",strong:"strong",...(0,t.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.header,{children:(0,i.jsx)(n.h1,{id:"interface-clipboard",children:"Interface: Clipboard"})}),"\n",(0,i.jsx)(n.p,{children:"The clipboard provides read and write access to the system's clipboard."}),"\n",(0,i.jsx)(n.h2,{id:"methods",children:"Methods"}),"\n",(0,i.jsx)(n.h3,{id:"readtext",children:"readText()"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"readText"}),"(): ",(0,i.jsx)(n.code,{children:"Promise"}),"<",(0,i.jsx)(n.code,{children:"string"}),">"]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Read the current clipboard contents as text."}),"\n",(0,i.jsx)(n.h4,{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"}),">"]}),"\n",(0,i.jsx)(n.p,{children:"A Promise that resolves to a string."}),"\n",(0,i.jsx)(n.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L4277",children:"packages/extension-api/src/extension-api.d.ts:4277"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"writetext",children:"writeText()"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"writeText"}),"(",(0,i.jsx)(n.code,{children:"value"}),"): ",(0,i.jsx)(n.code,{children:"Promise"}),"<",(0,i.jsx)(n.code,{children:"void"}),">"]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Writes text into the clipboard."}),"\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.h4,{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:"void"}),">"]}),"\n",(0,i.jsx)(n.p,{children:"A Promise that resolves when writing happened."}),"\n",(0,i.jsx)(n.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L4283",children:"packages/extension-api/src/extension-api.d.ts:4283"})})]})}function h(e={}){const{wrapper:n}={...(0,t.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},43023:(e,n,r)=>{r.d(n,{R:()=>d,x:()=>a});var i=r(63696);const t={},s=i.createContext(t);function d(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(t):e.components||t:d(e.components),i.createElement(s.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[31672],{71155:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>a,contentTitle:()=>d,default:()=>h,frontMatter:()=>s,metadata:()=>c,toc:()=>o});var i=r(62540),t=r(43023);const s={},d="Interface: Clipboard",c={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"}},a={},o=[{value:"Methods",id:"methods",level:2},{value:"readText()",id:"readtext",level:3},{value:"Returns",id:"returns",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"writeText()",id:"writetext",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Defined in",id:"defined-in-1",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",p:"p",strong:"strong",...(0,t.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.header,{children:(0,i.jsx)(n.h1,{id:"interface-clipboard",children:"Interface: Clipboard"})}),"\n",(0,i.jsx)(n.p,{children:"The clipboard provides read and write access to the system's clipboard."}),"\n",(0,i.jsx)(n.h2,{id:"methods",children:"Methods"}),"\n",(0,i.jsx)(n.h3,{id:"readtext",children:"readText()"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"readText"}),"(): ",(0,i.jsx)(n.code,{children:"Promise"}),"<",(0,i.jsx)(n.code,{children:"string"}),">"]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Read the current clipboard contents as text."}),"\n",(0,i.jsx)(n.h4,{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"}),">"]}),"\n",(0,i.jsx)(n.p,{children:"A Promise that resolves to a string."}),"\n",(0,i.jsx)(n.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L4277",children:"packages/extension-api/src/extension-api.d.ts:4277"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"writetext",children:"writeText()"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"writeText"}),"(",(0,i.jsx)(n.code,{children:"value"}),"): ",(0,i.jsx)(n.code,{children:"Promise"}),"<",(0,i.jsx)(n.code,{children:"void"}),">"]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Writes text into the clipboard."}),"\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.h4,{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:"void"}),">"]}),"\n",(0,i.jsx)(n.p,{children:"A Promise that resolves when writing happened."}),"\n",(0,i.jsx)(n.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L4283",children:"packages/extension-api/src/extension-api.d.ts:4283"})})]})}function h(e={}){const{wrapper:n}={...(0,t.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},43023:(e,n,r)=>{r.d(n,{R:()=>d,x:()=>c});var i=r(63696);const t={},s=i.createContext(t);function d(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:d(e.components),i.createElement(s.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/0547cb65.79fd4546.js b/assets/js/0547cb65.9ed8cdaf.js similarity index 82% rename from assets/js/0547cb65.79fd4546.js rename to assets/js/0547cb65.9ed8cdaf.js index 17af4230ab4..97660f6f6a0 100644 --- a/assets/js/0547cb65.79fd4546.js +++ b/assets/js/0547cb65.9ed8cdaf.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[22405],{88714:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>o,contentTitle:()=>s,default:()=>u,frontMatter:()=>a,metadata:()=>c,toc:()=>d});var t=i(62540),r=i(43023);const a={},s="Enumeration: QuickPickItemKind",c={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:"Defined in",id:"defined-in",level:4},{value:"Separator",id:"separator",level:3},{value:"Defined in",id:"defined-in-1",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",p:"p",strong:"strong",...(0,r.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.header,{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:"defined-in",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L1218",children:"packages/extension-api/src/extension-api.d.ts:1218"})}),"\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:"defined-in-1",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L1214",children:"packages/extension-api/src/extension-api.d.ts:1214"})})]})}function u(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},43023:(e,n,i)=>{i.d(n,{R:()=>s,x:()=>c});var t=i(63696);const r={},a=t.createContext(r);function s(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(r):e.components||r:s(e.components),t.createElement(a.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[22405],{88714:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>o,contentTitle:()=>c,default:()=>u,frontMatter:()=>a,metadata:()=>s,toc:()=>d});var t=i(62540),r=i(43023);const a={},c="Enumeration: QuickPickItemKind",s={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:"Defined in",id:"defined-in",level:4},{value:"Separator",id:"separator",level:3},{value:"Defined in",id:"defined-in-1",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",p:"p",strong:"strong",...(0,r.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.header,{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:"defined-in",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L1218",children:"packages/extension-api/src/extension-api.d.ts:1218"})}),"\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:"defined-in-1",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L1214",children:"packages/extension-api/src/extension-api.d.ts:1214"})})]})}function u(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},43023:(e,n,i)=>{i.d(n,{R:()=>c,x:()=>s});var t=i(63696);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 s(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/065365b3.042b108e.js b/assets/js/065365b3.24742235.js similarity index 95% rename from assets/js/065365b3.042b108e.js rename to assets/js/065365b3.24742235.js index 15d61478a2a..9d0a4a0b2fb 100644 --- a/assets/js/065365b3.042b108e.js +++ b/assets/js/065365b3.24742235.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[59911],{68205:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>o,contentTitle:()=>i,default:()=>l,frontMatter:()=>s,metadata:()=>a,toc:()=>d});var c=t(62540),r=t(43023);const s={},i="Interface: ImageChecks",a={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:"ImageFile",permalink:"/api/interfaces/ImageFile"}},o={},d=[{value:"Properties",id:"properties",level:2},{value:"checks",id:"checks",level:3},{value:"Defined in",id:"defined-in",level:4}];function h(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",p:"p",strong:"strong",...(0,r.R)(),...e.components};return(0,c.jsxs)(c.Fragment,{children:[(0,c.jsx)(n.header,{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:"defined-in",children:"Defined in"}),"\n",(0,c.jsx)(n.p,{children:(0,c.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L4452",children:"packages/extension-api/src/extension-api.d.ts:4452"})})]})}function l(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,c.jsx)(n,{...e,children:(0,c.jsx)(h,{...e})}):h(e)}},43023:(e,n,t)=>{t.d(n,{R:()=>i,x:()=>a});var c=t(63696);const r={},s=c.createContext(r);function i(e){const n=c.useContext(s);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(s.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[59911],{68205:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>o,contentTitle:()=>i,default:()=>l,frontMatter:()=>s,metadata:()=>a,toc:()=>d});var c=t(62540),r=t(43023);const s={},i="Interface: ImageChecks",a={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:"ImageFile",permalink:"/api/interfaces/ImageFile"}},o={},d=[{value:"Properties",id:"properties",level:2},{value:"checks",id:"checks",level:3},{value:"Defined in",id:"defined-in",level:4}];function h(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",p:"p",strong:"strong",...(0,r.R)(),...e.components};return(0,c.jsxs)(c.Fragment,{children:[(0,c.jsx)(n.header,{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:"defined-in",children:"Defined in"}),"\n",(0,c.jsx)(n.p,{children:(0,c.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L4452",children:"packages/extension-api/src/extension-api.d.ts:4452"})})]})}function l(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,c.jsx)(n,{...e,children:(0,c.jsx)(h,{...e})}):h(e)}},43023:(e,n,t)=>{t.d(n,{R:()=>i,x:()=>a});var c=t(63696);const r={},s=c.createContext(r);function i(e){const n=c.useContext(s);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(s.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/06a27da2.4118e3b3.js b/assets/js/06a27da2.3a1a0752.js similarity index 89% rename from assets/js/06a27da2.4118e3b3.js rename to assets/js/06a27da2.3a1a0752.js index 38384cdc18b..264169f0ffe 100644 --- a/assets/js/06a27da2.4118e3b3.js +++ b/assets/js/06a27da2.3a1a0752.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[49808],{47286:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>c,contentTitle:()=>r,default:()=>h,frontMatter:()=>a,metadata:()=>t,toc:()=>o});var s=i(62540),d=i(43023);const a={},r="Interface: PodInfo",t={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"}},c={},o=[{value:"Properties",id:"properties",level:2},{value:"Cgroup",id:"cgroup",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"Containers",id:"containers",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"Created",id:"created",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"Id",id:"id",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"InfraId",id:"infraid",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"Labels",id:"labels",level:3},{value:"Index Signature",id:"index-signature",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"Name",id:"name",level:3},{value:"Defined in",id:"defined-in-6",level:4},{value:"Namespace",id:"namespace",level:3},{value:"Defined in",id:"defined-in-7",level:4},{value:"Networks",id:"networks",level:3},{value:"Defined in",id:"defined-in-8",level:4},{value:"Status",id:"status",level:3},{value:"Defined in",id:"defined-in-9",level:4},{value:"engineId",id:"engineid",level:3},{value:"Defined in",id:"defined-in-10",level:4},{value:"engineName",id:"enginename",level:3},{value:"Defined in",id:"defined-in-11",level:4},{value:"kind",id:"kind",level:3},{value:"Defined in",id:"defined-in-12",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",p:"p",strong:"strong",...(0,d.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.header,{children:(0,s.jsx)(n.h1,{id:"interface-podinfo",children:"Interface: PodInfo"})}),"\n",(0,s.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,s.jsx)(n.h3,{id:"cgroup",children:"Cgroup"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Cgroup"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/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:"containers",children:"Containers"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Containers"}),": ",(0,s.jsx)(n.a,{href:"/api/interfaces/PodContainerInfo",children:(0,s.jsx)(n.code,{children:"PodContainerInfo"})}),"[]"]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2350",children:"packages/extension-api/src/extension-api.d.ts:2350"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"created",children:"Created"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Created"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-2",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2351",children:"packages/extension-api/src/extension-api.d.ts:2351"})}),"\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:"defined-in-3",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2352",children:"packages/extension-api/src/extension-api.d.ts:2352"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"infraid",children:"InfraId"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"InfraId"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-4",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/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:"labels",children:"Labels"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Labels"}),": ",(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:"defined-in-5",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2354",children:"packages/extension-api/src/extension-api.d.ts:2354"})}),"\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:"defined-in-6",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2355",children:"packages/extension-api/src/extension-api.d.ts:2355"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"namespace",children:"Namespace"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Namespace"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-7",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2356",children:"packages/extension-api/src/extension-api.d.ts:2356"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"networks",children:"Networks"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Networks"}),": ",(0,s.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-8",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2357",children:"packages/extension-api/src/extension-api.d.ts:2357"})}),"\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:"defined-in-9",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2358",children:"packages/extension-api/src/extension-api.d.ts:2358"})}),"\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.h4,{id:"defined-in-10",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2346",children:"packages/extension-api/src/extension-api.d.ts:2346"})}),"\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.h4,{id:"defined-in-11",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2347",children:"packages/extension-api/src/extension-api.d.ts:2347"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"kind",children:"kind"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"kind"}),": ",(0,s.jsx)(n.code,{children:'"podman"'})," | ",(0,s.jsx)(n.code,{children:'"kubernetes"'})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-12",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2348",children:"packages/extension-api/src/extension-api.d.ts:2348"})})]})}function h(e={}){const{wrapper:n}={...(0,d.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},43023:(e,n,i)=>{i.d(n,{R:()=>r,x:()=>t});var s=i(63696);const d={},a=s.createContext(d);function r(e){const n=s.useContext(a);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(d):e.components||d:r(e.components),s.createElement(a.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[49808],{47286:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>c,contentTitle:()=>r,default:()=>h,frontMatter:()=>a,metadata:()=>t,toc:()=>o});var s=i(62540),d=i(43023);const a={},r="Interface: PodInfo",t={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"}},c={},o=[{value:"Properties",id:"properties",level:2},{value:"Cgroup",id:"cgroup",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"Containers",id:"containers",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"Created",id:"created",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"Id",id:"id",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"InfraId",id:"infraid",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"Labels",id:"labels",level:3},{value:"Index Signature",id:"index-signature",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"Name",id:"name",level:3},{value:"Defined in",id:"defined-in-6",level:4},{value:"Namespace",id:"namespace",level:3},{value:"Defined in",id:"defined-in-7",level:4},{value:"Networks",id:"networks",level:3},{value:"Defined in",id:"defined-in-8",level:4},{value:"Status",id:"status",level:3},{value:"Defined in",id:"defined-in-9",level:4},{value:"engineId",id:"engineid",level:3},{value:"Defined in",id:"defined-in-10",level:4},{value:"engineName",id:"enginename",level:3},{value:"Defined in",id:"defined-in-11",level:4},{value:"kind",id:"kind",level:3},{value:"Defined in",id:"defined-in-12",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",p:"p",strong:"strong",...(0,d.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.header,{children:(0,s.jsx)(n.h1,{id:"interface-podinfo",children:"Interface: PodInfo"})}),"\n",(0,s.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,s.jsx)(n.h3,{id:"cgroup",children:"Cgroup"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Cgroup"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/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:"containers",children:"Containers"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Containers"}),": ",(0,s.jsx)(n.a,{href:"/api/interfaces/PodContainerInfo",children:(0,s.jsx)(n.code,{children:"PodContainerInfo"})}),"[]"]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2350",children:"packages/extension-api/src/extension-api.d.ts:2350"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"created",children:"Created"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Created"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-2",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2351",children:"packages/extension-api/src/extension-api.d.ts:2351"})}),"\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:"defined-in-3",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2352",children:"packages/extension-api/src/extension-api.d.ts:2352"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"infraid",children:"InfraId"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"InfraId"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-4",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/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:"labels",children:"Labels"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Labels"}),": ",(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:"defined-in-5",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2354",children:"packages/extension-api/src/extension-api.d.ts:2354"})}),"\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:"defined-in-6",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2355",children:"packages/extension-api/src/extension-api.d.ts:2355"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"namespace",children:"Namespace"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Namespace"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-7",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2356",children:"packages/extension-api/src/extension-api.d.ts:2356"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"networks",children:"Networks"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Networks"}),": ",(0,s.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-8",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2357",children:"packages/extension-api/src/extension-api.d.ts:2357"})}),"\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:"defined-in-9",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2358",children:"packages/extension-api/src/extension-api.d.ts:2358"})}),"\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.h4,{id:"defined-in-10",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2346",children:"packages/extension-api/src/extension-api.d.ts:2346"})}),"\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.h4,{id:"defined-in-11",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2347",children:"packages/extension-api/src/extension-api.d.ts:2347"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"kind",children:"kind"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"kind"}),": ",(0,s.jsx)(n.code,{children:'"podman"'})," | ",(0,s.jsx)(n.code,{children:'"kubernetes"'})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-12",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2348",children:"packages/extension-api/src/extension-api.d.ts:2348"})})]})}function h(e={}){const{wrapper:n}={...(0,d.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},43023:(e,n,i)=>{i.d(n,{R:()=>r,x:()=>t});var s=i(63696);const d={},a=s.createContext(d);function r(e){const n=s.useContext(a);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(d):e.components||d:r(e.components),s.createElement(a.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/080a9824.8fd13ebb.js b/assets/js/080a9824.d3723757.js similarity index 92% rename from assets/js/080a9824.8fd13ebb.js rename to assets/js/080a9824.d3723757.js index 0699769ce07..6ef24589bef 100644 --- a/assets/js/080a9824.8fd13ebb.js +++ b/assets/js/080a9824.d3723757.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[51023],{7174:(e,i,n)=>{n.r(i),n.d(i,{assets:()=>c,contentTitle:()=>d,default:()=>h,frontMatter:()=>a,metadata:()=>r,toc:()=>o});var s=n(62540),t=n(43023);const a={},d="Interface: ImageFilesystemLayer",r={id:"interfaces/ImageFilesystemLayer",title:"Interface: ImageFilesystemLayer",description:"a filesystem layer of an image as defined by spec",source:"@site/api/interfaces/ImageFilesystemLayer.md",sourceDirName:"interfaces",slug:"/interfaces/ImageFilesystemLayer",permalink:"/api/interfaces/ImageFilesystemLayer",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"ImageFilesProviderMetadata",permalink:"/api/interfaces/ImageFilesProviderMetadata"},next:{title:"ImageFilesystemLayers",permalink:"/api/interfaces/ImageFilesystemLayers"}},c={},o=[{value:"Properties",id:"properties",level:2},{value:"createdBy?",id:"createdby",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"files?",id:"files",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"id",id:"id",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"opaqueWhiteouts?",id:"opaquewhiteouts",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"whiteouts?",id:"whiteouts",level:3},{value:"Defined in",id:"defined-in-4",level:4}];function l(e){const i={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",p:"p",strong:"strong",...(0,t.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(i.header,{children:(0,s.jsx)(i.h1,{id:"interface-imagefilesystemlayer",children:"Interface: ImageFilesystemLayer"})}),"\n",(0,s.jsxs)(i.p,{children:["a filesystem layer of an image as defined by ",(0,s.jsx)(i.a,{href:"https://github.com/opencontainers/image-spec/blob/main/spec.md",children:"spec"})]}),"\n",(0,s.jsx)(i.h2,{id:"properties",children:"Properties"}),"\n",(0,s.jsx)(i.h3,{id:"createdby",children:"createdBy?"}),"\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:"createdBy"}),": ",(0,s.jsx)(i.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(i.p,{children:"the command which created the layer"}),"\n",(0,s.jsx)(i.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,s.jsx)(i.p,{children:(0,s.jsx)(i.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L762",children:"packages/extension-api/src/extension-api.d.ts:762"})}),"\n",(0,s.jsx)(i.hr,{}),"\n",(0,s.jsx)(i.h3,{id:"files",children:"files?"}),"\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:"files"}),": ",(0,s.jsx)(i.a,{href:"/api/interfaces/ImageFile",children:(0,s.jsx)(i.code,{children:"ImageFile"})}),"[]"]}),"\n"]}),"\n",(0,s.jsx)(i.p,{children:"files indicate the paths of the files added or modified in the layer"}),"\n",(0,s.jsx)(i.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,s.jsx)(i.p,{children:(0,s.jsx)(i.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L766",children:"packages/extension-api/src/extension-api.d.ts:766"})}),"\n",(0,s.jsx)(i.hr,{}),"\n",(0,s.jsx)(i.h3,{id:"id",children:"id"}),"\n",(0,s.jsxs)(i.blockquote,{children:["\n",(0,s.jsxs)(i.p,{children:[(0,s.jsx)(i.strong,{children:"id"}),": ",(0,s.jsx)(i.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(i.p,{children:"unique id of the layer"}),"\n",(0,s.jsx)(i.h4,{id:"defined-in-2",children:"Defined in"}),"\n",(0,s.jsx)(i.p,{children:(0,s.jsx)(i.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L758",children:"packages/extension-api/src/extension-api.d.ts:758"})}),"\n",(0,s.jsx)(i.hr,{}),"\n",(0,s.jsx)(i.h3,{id:"opaquewhiteouts",children:"opaqueWhiteouts?"}),"\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:"opaqueWhiteouts"}),": ",(0,s.jsx)(i.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,s.jsx)(i.p,{children:"opaque whiteouts indicate the directories in which the content has to be completely deleted from previous layers."}),"\n",(0,s.jsx)(i.h4,{id:"defined-in-3",children:"Defined in"}),"\n",(0,s.jsx)(i.p,{children:(0,s.jsx)(i.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L774",children:"packages/extension-api/src/extension-api.d.ts:774"})}),"\n",(0,s.jsx)(i.hr,{}),"\n",(0,s.jsx)(i.h3,{id:"whiteouts",children:"whiteouts?"}),"\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:"whiteouts"}),": ",(0,s.jsx)(i.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,s.jsx)(i.p,{children:"whiteouts indicate the paths of the files to be deleted from previous layers."}),"\n",(0,s.jsx)(i.h4,{id:"defined-in-4",children:"Defined in"}),"\n",(0,s.jsx)(i.p,{children:(0,s.jsx)(i.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L770",children:"packages/extension-api/src/extension-api.d.ts:770"})})]})}function h(e={}){const{wrapper:i}={...(0,t.R)(),...e.components};return i?(0,s.jsx)(i,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},43023:(e,i,n)=>{n.d(i,{R:()=>d,x:()=>r});var s=n(63696);const t={},a=s.createContext(t);function d(e){const i=s.useContext(a);return s.useMemo((function(){return"function"==typeof e?e(i):{...i,...e}}),[i,e])}function r(e){let i;return i=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:d(e.components),s.createElement(a.Provider,{value:i},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[51023],{7174:(e,i,n)=>{n.r(i),n.d(i,{assets:()=>c,contentTitle:()=>d,default:()=>h,frontMatter:()=>a,metadata:()=>r,toc:()=>o});var s=n(62540),t=n(43023);const a={},d="Interface: ImageFilesystemLayer",r={id:"interfaces/ImageFilesystemLayer",title:"Interface: ImageFilesystemLayer",description:"a filesystem layer of an image as defined by spec",source:"@site/api/interfaces/ImageFilesystemLayer.md",sourceDirName:"interfaces",slug:"/interfaces/ImageFilesystemLayer",permalink:"/api/interfaces/ImageFilesystemLayer",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"ImageFilesProviderMetadata",permalink:"/api/interfaces/ImageFilesProviderMetadata"},next:{title:"ImageFilesystemLayers",permalink:"/api/interfaces/ImageFilesystemLayers"}},c={},o=[{value:"Properties",id:"properties",level:2},{value:"createdBy?",id:"createdby",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"files?",id:"files",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"id",id:"id",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"opaqueWhiteouts?",id:"opaquewhiteouts",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"whiteouts?",id:"whiteouts",level:3},{value:"Defined in",id:"defined-in-4",level:4}];function l(e){const i={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",p:"p",strong:"strong",...(0,t.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(i.header,{children:(0,s.jsx)(i.h1,{id:"interface-imagefilesystemlayer",children:"Interface: ImageFilesystemLayer"})}),"\n",(0,s.jsxs)(i.p,{children:["a filesystem layer of an image as defined by ",(0,s.jsx)(i.a,{href:"https://github.com/opencontainers/image-spec/blob/main/spec.md",children:"spec"})]}),"\n",(0,s.jsx)(i.h2,{id:"properties",children:"Properties"}),"\n",(0,s.jsx)(i.h3,{id:"createdby",children:"createdBy?"}),"\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:"createdBy"}),": ",(0,s.jsx)(i.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(i.p,{children:"the command which created the layer"}),"\n",(0,s.jsx)(i.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,s.jsx)(i.p,{children:(0,s.jsx)(i.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L762",children:"packages/extension-api/src/extension-api.d.ts:762"})}),"\n",(0,s.jsx)(i.hr,{}),"\n",(0,s.jsx)(i.h3,{id:"files",children:"files?"}),"\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:"files"}),": ",(0,s.jsx)(i.a,{href:"/api/interfaces/ImageFile",children:(0,s.jsx)(i.code,{children:"ImageFile"})}),"[]"]}),"\n"]}),"\n",(0,s.jsx)(i.p,{children:"files indicate the paths of the files added or modified in the layer"}),"\n",(0,s.jsx)(i.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,s.jsx)(i.p,{children:(0,s.jsx)(i.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L766",children:"packages/extension-api/src/extension-api.d.ts:766"})}),"\n",(0,s.jsx)(i.hr,{}),"\n",(0,s.jsx)(i.h3,{id:"id",children:"id"}),"\n",(0,s.jsxs)(i.blockquote,{children:["\n",(0,s.jsxs)(i.p,{children:[(0,s.jsx)(i.strong,{children:"id"}),": ",(0,s.jsx)(i.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(i.p,{children:"unique id of the layer"}),"\n",(0,s.jsx)(i.h4,{id:"defined-in-2",children:"Defined in"}),"\n",(0,s.jsx)(i.p,{children:(0,s.jsx)(i.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L758",children:"packages/extension-api/src/extension-api.d.ts:758"})}),"\n",(0,s.jsx)(i.hr,{}),"\n",(0,s.jsx)(i.h3,{id:"opaquewhiteouts",children:"opaqueWhiteouts?"}),"\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:"opaqueWhiteouts"}),": ",(0,s.jsx)(i.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,s.jsx)(i.p,{children:"opaque whiteouts indicate the directories in which the content has to be completely deleted from previous layers."}),"\n",(0,s.jsx)(i.h4,{id:"defined-in-3",children:"Defined in"}),"\n",(0,s.jsx)(i.p,{children:(0,s.jsx)(i.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L774",children:"packages/extension-api/src/extension-api.d.ts:774"})}),"\n",(0,s.jsx)(i.hr,{}),"\n",(0,s.jsx)(i.h3,{id:"whiteouts",children:"whiteouts?"}),"\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:"whiteouts"}),": ",(0,s.jsx)(i.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,s.jsx)(i.p,{children:"whiteouts indicate the paths of the files to be deleted from previous layers."}),"\n",(0,s.jsx)(i.h4,{id:"defined-in-4",children:"Defined in"}),"\n",(0,s.jsx)(i.p,{children:(0,s.jsx)(i.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L770",children:"packages/extension-api/src/extension-api.d.ts:770"})})]})}function h(e={}){const{wrapper:i}={...(0,t.R)(),...e.components};return i?(0,s.jsx)(i,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},43023:(e,i,n)=>{n.d(i,{R:()=>d,x:()=>r});var s=n(63696);const t={},a=s.createContext(t);function d(e){const i=s.useContext(a);return s.useMemo((function(){return"function"==typeof e?e(i):{...i,...e}}),[i,e])}function r(e){let i;return i=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:d(e.components),s.createElement(a.Provider,{value:i},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/0877aebd.5fc4b403.js b/assets/js/0877aebd.04f19fc0.js similarity index 93% rename from assets/js/0877aebd.5fc4b403.js rename to assets/js/0877aebd.04f19fc0.js index cfc77441f69..9f11b1a2d0f 100644 --- a/assets/js/0877aebd.5fc4b403.js +++ b/assets/js/0877aebd.04f19fc0.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[89885],{244:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>a,contentTitle:()=>r,default:()=>p,frontMatter:()=>s,metadata:()=>c,toc:()=>d});var t=i(62540),o=i(43023);const s={},r="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:"Defined in",id:"defined-in",level:4},{value:"supportsMultipleAccounts?",id:"supportsmultipleaccounts",level:3},{value:"Defined in",id:"defined-in-1",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",p:"p",strong:"strong",...(0,o.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.header,{children:(0,t.jsx)(n.h1,{id:"interface-authenticationprovideroptions",children:"Interface: AuthenticationProviderOptions"})}),"\n",(0,t.jsxs)(n.p,{children:["Options for creating 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:"images",children:"images?"}),"\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.code,{children:"optional"})," ",(0,t.jsx)(n.strong,{children:"images"}),": ",(0,t.jsx)(n.a,{href:"/api/interfaces/ProviderImages",children:(0,t.jsx)(n.code,{children:"ProviderImages"})})]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L3829",children:"packages/extension-api/src/extension-api.d.ts:3829"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"supportsmultipleaccounts",children:"supportsMultipleAccounts?"}),"\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.code,{children:"optional"})," ",(0,t.jsx)(n.strong,{children:"supportsMultipleAccounts"}),": ",(0,t.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,t.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,t.jsx)(n.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L3827",children:"packages/extension-api/src/extension-api.d.ts:3827"})})]})}function p(e={}){const{wrapper:n}={...(0,o.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},43023:(e,n,i)=>{i.d(n,{R:()=>r,x:()=>c});var t=i(63696);const o={},s=t.createContext(o);function r(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:r(e.components),t.createElement(s.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[89885],{244:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>a,contentTitle:()=>r,default:()=>p,frontMatter:()=>s,metadata:()=>c,toc:()=>d});var t=i(62540),o=i(43023);const s={},r="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:"Defined in",id:"defined-in",level:4},{value:"supportsMultipleAccounts?",id:"supportsmultipleaccounts",level:3},{value:"Defined in",id:"defined-in-1",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",p:"p",strong:"strong",...(0,o.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.header,{children:(0,t.jsx)(n.h1,{id:"interface-authenticationprovideroptions",children:"Interface: AuthenticationProviderOptions"})}),"\n",(0,t.jsxs)(n.p,{children:["Options for creating 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:"images",children:"images?"}),"\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.code,{children:"optional"})," ",(0,t.jsx)(n.strong,{children:"images"}),": ",(0,t.jsx)(n.a,{href:"/api/interfaces/ProviderImages",children:(0,t.jsx)(n.code,{children:"ProviderImages"})})]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L3829",children:"packages/extension-api/src/extension-api.d.ts:3829"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"supportsmultipleaccounts",children:"supportsMultipleAccounts?"}),"\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.code,{children:"optional"})," ",(0,t.jsx)(n.strong,{children:"supportsMultipleAccounts"}),": ",(0,t.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,t.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,t.jsx)(n.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L3827",children:"packages/extension-api/src/extension-api.d.ts:3827"})})]})}function p(e={}){const{wrapper:n}={...(0,o.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},43023:(e,n,i)=>{i.d(n,{R:()=>r,x:()=>c});var t=i(63696);const o={},s=t.createContext(o);function r(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:r(e.components),t.createElement(s.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/0c14b239.c3d5ca0d.js b/assets/js/0c14b239.6be7511e.js similarity index 96% rename from assets/js/0c14b239.c3d5ca0d.js rename to assets/js/0c14b239.6be7511e.js index e64b5c728c2..76b8d5d071c 100644 --- a/assets/js/0c14b239.c3d5ca0d.js +++ b/assets/js/0c14b239.6be7511e.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[16583],{79408:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>c,contentTitle:()=>a,default:()=>h,frontMatter:()=>o,metadata:()=>r,toc:()=>d});var s=i(62540),t=i(43023);const o={},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:"containerEngine",permalink:"/api/namespaces/containerEngine/"}},c={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Defined in",id:"defined-in",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",strong:"strong",...(0,t.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.header,{children:(0,s.jsx)(n.h1,{id:"function-ondidchangeconfiguration",children:"Function: onDidChangeConfiguration()"})}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"onDidChangeConfiguration"}),"(",(0,s.jsx)(n.code,{children:"listener"}),", ",(0,s.jsx)(n.code,{children:"thisArgs"}),"?, ",(0,s.jsx)(n.code,{children:"disposables"}),"?): ",(0,s.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,s.jsx)(n.code,{children:"Disposable"})})]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:["An event that is emitted when the ",(0,s.jsx)(n.a,{href:"/api/interfaces/Configuration",children:"configuration"})," changed."]}),"\n",(0,s.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"listener"})]}),"\n",(0,s.jsx)(n.p,{children:"The listener function will be called when the event happens."}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"thisArgs?"}),": ",(0,s.jsx)(n.code,{children:"any"})]}),"\n",(0,s.jsxs)(n.p,{children:["The ",(0,s.jsx)(n.code,{children:"this"}),"-argument which will be used when calling the event listener."]}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"disposables?"}),": ",(0,s.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,s.jsx)(n.code,{children:"Disposable"})}),"[]"]}),"\n",(0,s.jsxs)(n.p,{children:["An array to which a ",(0,s.jsx)(n.a,{href:"/api/classes/Disposable",children:"Disposable"})," will be added."]}),"\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.p,{children:"A disposable which unsubscribes the event listener."}),"\n",(0,s.jsx)(n.h2,{id:"defined-in",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L957",children:"packages/extension-api/src/extension-api.d.ts:957"})})]})}function h(e={}){const{wrapper:n}={...(0,t.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},43023:(e,n,i)=>{i.d(n,{R:()=>a,x:()=>r});var s=i(63696);const t={},o=s.createContext(t);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(t):e.components||t:a(e.components),s.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[16583],{79408:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>c,contentTitle:()=>a,default:()=>h,frontMatter:()=>o,metadata:()=>r,toc:()=>d});var s=i(62540),t=i(43023);const o={},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:"containerEngine",permalink:"/api/namespaces/containerEngine/"}},c={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Defined in",id:"defined-in",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",strong:"strong",...(0,t.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.header,{children:(0,s.jsx)(n.h1,{id:"function-ondidchangeconfiguration",children:"Function: onDidChangeConfiguration()"})}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"onDidChangeConfiguration"}),"(",(0,s.jsx)(n.code,{children:"listener"}),", ",(0,s.jsx)(n.code,{children:"thisArgs"}),"?, ",(0,s.jsx)(n.code,{children:"disposables"}),"?): ",(0,s.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,s.jsx)(n.code,{children:"Disposable"})})]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:["An event that is emitted when the ",(0,s.jsx)(n.a,{href:"/api/interfaces/Configuration",children:"configuration"})," changed."]}),"\n",(0,s.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"listener"})]}),"\n",(0,s.jsx)(n.p,{children:"The listener function will be called when the event happens."}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"thisArgs?"}),": ",(0,s.jsx)(n.code,{children:"any"})]}),"\n",(0,s.jsxs)(n.p,{children:["The ",(0,s.jsx)(n.code,{children:"this"}),"-argument which will be used when calling the event listener."]}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"disposables?"}),": ",(0,s.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,s.jsx)(n.code,{children:"Disposable"})}),"[]"]}),"\n",(0,s.jsxs)(n.p,{children:["An array to which a ",(0,s.jsx)(n.a,{href:"/api/classes/Disposable",children:"Disposable"})," will be added."]}),"\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.p,{children:"A disposable which unsubscribes the event listener."}),"\n",(0,s.jsx)(n.h2,{id:"defined-in",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L957",children:"packages/extension-api/src/extension-api.d.ts:957"})})]})}function h(e={}){const{wrapper:n}={...(0,t.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},43023:(e,n,i)=>{i.d(n,{R:()=>a,x:()=>r});var s=i(63696);const t={},o=s.createContext(t);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(t):e.components||t:a(e.components),s.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/0c4fad6b.39bf846a.js b/assets/js/0c4fad6b.0c8cef87.js similarity index 95% rename from assets/js/0c4fad6b.39bf846a.js rename to assets/js/0c4fad6b.0c8cef87.js index bc08cc6a901..b3d4bb3a1bf 100644 --- a/assets/js/0c4fad6b.39bf846a.js +++ b/assets/js/0c4fad6b.0c8cef87.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[53113],{110:(n,e,t)=>{t.r(e),t.d(e,{assets:()=>r,contentTitle:()=>s,default:()=>p,frontMatter:()=>o,metadata:()=>c,toc:()=>d});var i=t(62540),a=t(43023);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:"navigation",permalink:"/api/namespaces/navigation/"},next:{title:"navigateToContainer",permalink:"/api/namespaces/navigation/functions/navigateToContainer"}},r={},d=[{value:"Returns",id:"returns",level:2},{value:"Defined in",id:"defined-in",level:2}];function u(n){const e={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",strong:"strong",...(0,a.R)(),...n.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(e.header,{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:"defined-in",children:"Defined in"}),"\n",(0,i.jsx)(e.p,{children:(0,i.jsx)(e.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L4537",children:"packages/extension-api/src/extension-api.d.ts:4537"})})]})}function p(n={}){const{wrapper:e}={...(0,a.R)(),...n.components};return e?(0,i.jsx)(e,{...n,children:(0,i.jsx)(u,{...n})}):u(n)}},43023:(n,e,t)=>{t.d(e,{R:()=>s,x:()=>c});var i=t(63696);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([[53113],{110:(n,e,t)=>{t.r(e),t.d(e,{assets:()=>r,contentTitle:()=>s,default:()=>p,frontMatter:()=>o,metadata:()=>c,toc:()=>d});var i=t(62540),a=t(43023);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:"navigation",permalink:"/api/namespaces/navigation/"},next:{title:"navigateToContainer",permalink:"/api/namespaces/navigation/functions/navigateToContainer"}},r={},d=[{value:"Returns",id:"returns",level:2},{value:"Defined in",id:"defined-in",level:2}];function u(n){const e={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",strong:"strong",...(0,a.R)(),...n.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(e.header,{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:"defined-in",children:"Defined in"}),"\n",(0,i.jsx)(e.p,{children:(0,i.jsx)(e.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L4537",children:"packages/extension-api/src/extension-api.d.ts:4537"})})]})}function p(n={}){const{wrapper:e}={...(0,a.R)(),...n.components};return e?(0,i.jsx)(e,{...n,children:(0,i.jsx)(u,{...n})}):u(n)}},43023:(n,e,t)=>{t.d(e,{R:()=>s,x:()=>c});var i=t(63696);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.f1dc9fb4.js b/assets/js/0cab2b3a.0587a16f.js similarity index 87% rename from assets/js/0cab2b3a.f1dc9fb4.js rename to assets/js/0cab2b3a.0587a16f.js index a89e9a8d400..51967018831 100644 --- a/assets/js/0cab2b3a.f1dc9fb4.js +++ b/assets/js/0cab2b3a.0587a16f.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[17349],{8744:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>i,contentTitle:()=>o,default:()=>h,frontMatter:()=>c,metadata:()=>d,toc:()=>a});var t=s(62540),r=s(43023);const c={},o="Function: executeCommand()",d={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:"commands",permalink:"/api/namespaces/commands/"},next:{title:"registerCommand",permalink:"/api/namespaces/commands/functions/registerCommand"}},i={},a=[{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:"Defined in",id:"defined-in",level:2}];function m(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",strong:"strong",...(0,r.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.header,{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:"defined-in",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L687",children:"packages/extension-api/src/extension-api.d.ts:687"})})]})}function h(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(m,{...e})}):m(e)}},43023:(e,n,s)=>{s.d(n,{R:()=>o,x:()=>d});var t=s(63696);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 d(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:o(e.components),t.createElement(c.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[17349],{8744:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>d,contentTitle:()=>o,default:()=>h,frontMatter:()=>c,metadata:()=>i,toc:()=>a});var t=s(62540),r=s(43023);const c={},o="Function: executeCommand()",i={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:"commands",permalink:"/api/namespaces/commands/"},next:{title:"registerCommand",permalink:"/api/namespaces/commands/functions/registerCommand"}},d={},a=[{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:"Defined in",id:"defined-in",level:2}];function m(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",strong:"strong",...(0,r.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.header,{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:"defined-in",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L687",children:"packages/extension-api/src/extension-api.d.ts:687"})})]})}function h(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(m,{...e})}):m(e)}},43023:(e,n,s)=>{s.d(n,{R:()=>o,x:()=>i});var t=s(63696);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/0e3a398f.ad06bcb7.js b/assets/js/0e3a398f.f5b42f08.js similarity index 95% rename from assets/js/0e3a398f.ad06bcb7.js rename to assets/js/0e3a398f.f5b42f08.js index aa498b913c5..dee073f6c84 100644 --- a/assets/js/0e3a398f.ad06bcb7.js +++ b/assets/js/0e3a398f.f5b42f08.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[40532],{45053:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>d,contentTitle:()=>s,default:()=>u,frontMatter:()=>o,metadata:()=>c,toc:()=>a});var r=t(62540),i=t(43023);const o={},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"}},d={},a=[{value:"Properties",id:"properties",level:2},{value:"apiURL",id:"apiurl",level:3},{value:"Defined in",id:"defined-in",level:4}];function p(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",p:"p",strong:"strong",...(0,i.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.header,{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:"defined-in",children:"Defined in"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L481",children:"packages/extension-api/src/extension-api.d.ts:481"})})]})}function u(e={}){const{wrapper:n}={...(0,i.R)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(p,{...e})}):p(e)}},43023:(e,n,t)=>{t.d(n,{R:()=>s,x:()=>c});var r=t(63696);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([[40532],{45053:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>d,contentTitle:()=>s,default:()=>u,frontMatter:()=>o,metadata:()=>c,toc:()=>a});var r=t(62540),i=t(43023);const o={},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"}},d={},a=[{value:"Properties",id:"properties",level:2},{value:"apiURL",id:"apiurl",level:3},{value:"Defined in",id:"defined-in",level:4}];function p(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",p:"p",strong:"strong",...(0,i.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.header,{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:"defined-in",children:"Defined in"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L481",children:"packages/extension-api/src/extension-api.d.ts:481"})})]})}function u(e={}){const{wrapper:n}={...(0,i.R)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(p,{...e})}):p(e)}},43023:(e,n,t)=>{t.d(n,{R:()=>s,x:()=>c});var r=t(63696);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/0e72c11a.87a4deef.js b/assets/js/0e72c11a.760caae1.js similarity index 95% rename from assets/js/0e72c11a.87a4deef.js rename to assets/js/0e72c11a.760caae1.js index 7def4e79238..b7fd9c6c574 100644 --- a/assets/js/0e72c11a.87a4deef.js +++ b/assets/js/0e72c11a.760caae1.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[51047],{67101:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>r,contentTitle:()=>a,default:()=>l,frontMatter:()=>i,metadata:()=>c,toc:()=>d});var t=s(62540),o=s(43023);const i={},a="Function: navigateToResources()",c={id:"namespaces/navigation/functions/navigateToResources",title:"Function: navigateToResources()",description:"navigateToResources(): Promise\\",source:"@site/api/namespaces/navigation/functions/navigateToResources.md",sourceDirName:"namespaces/navigation/functions",slug:"/namespaces/navigation/functions/navigateToResources",permalink:"/api/namespaces/navigation/functions/navigateToResources",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"navigateToPods",permalink:"/api/namespaces/navigation/functions/navigateToPods"},next:{title:"navigateToVolume",permalink:"/api/namespaces/navigation/functions/navigateToVolume"}},r={},d=[{value:"Returns",id:"returns",level:2},{value:"Defined in",id:"defined-in",level:2}];function u(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",strong:"strong",...(0,o.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.header,{children:(0,t.jsx)(n.h1,{id:"function-navigatetoresources",children:"Function: navigateToResources()"})}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"navigateToResources"}),"(): ",(0,t.jsx)(n.code,{children:"Promise"}),"<",(0,t.jsx)(n.code,{children:"void"}),">"]}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"Navigate to Resources page"}),"\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:"defined-in",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L4542",children:"packages/extension-api/src/extension-api.d.ts:4542"})})]})}function l(e={}){const{wrapper:n}={...(0,o.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(u,{...e})}):u(e)}},43023:(e,n,s)=>{s.d(n,{R:()=>a,x:()=>c});var t=s(63696);const o={},i=t.createContext(o);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(o):e.components||o:a(e.components),t.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[51047],{67101:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>r,contentTitle:()=>a,default:()=>l,frontMatter:()=>i,metadata:()=>c,toc:()=>d});var t=s(62540),o=s(43023);const i={},a="Function: navigateToResources()",c={id:"namespaces/navigation/functions/navigateToResources",title:"Function: navigateToResources()",description:"navigateToResources(): Promise\\",source:"@site/api/namespaces/navigation/functions/navigateToResources.md",sourceDirName:"namespaces/navigation/functions",slug:"/namespaces/navigation/functions/navigateToResources",permalink:"/api/namespaces/navigation/functions/navigateToResources",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"navigateToPods",permalink:"/api/namespaces/navigation/functions/navigateToPods"},next:{title:"navigateToVolume",permalink:"/api/namespaces/navigation/functions/navigateToVolume"}},r={},d=[{value:"Returns",id:"returns",level:2},{value:"Defined in",id:"defined-in",level:2}];function u(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",strong:"strong",...(0,o.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.header,{children:(0,t.jsx)(n.h1,{id:"function-navigatetoresources",children:"Function: navigateToResources()"})}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"navigateToResources"}),"(): ",(0,t.jsx)(n.code,{children:"Promise"}),"<",(0,t.jsx)(n.code,{children:"void"}),">"]}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"Navigate to Resources page"}),"\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:"defined-in",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L4542",children:"packages/extension-api/src/extension-api.d.ts:4542"})})]})}function l(e={}){const{wrapper:n}={...(0,o.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(u,{...e})}):u(e)}},43023:(e,n,s)=>{s.d(n,{R:()=>a,x:()=>c});var t=s(63696);const o={},i=t.createContext(o);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(o):e.components||o:a(e.components),t.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/0f54081d.1f1a3a49.js b/assets/js/0f54081d.0a8fa52a.js similarity index 98% rename from assets/js/0f54081d.1f1a3a49.js rename to assets/js/0f54081d.0a8fa52a.js index 5355e683a50..fd04b75ee41 100644 --- a/assets/js/0f54081d.1f1a3a49.js +++ b/assets/js/0f54081d.0a8fa52a.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[21381],{24599:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>d,contentTitle:()=>c,default:()=>p,frontMatter:()=>o,metadata:()=>s,toc:()=>a});var i=t(62540),r=t(43023);const o={},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:"Defined in",id:"defined-in",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",strong:"strong",...(0,r.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.header,{children:(0,i.jsx)(n.h1,{id:"function-getproviderlifecyclecontext",children:"Function: getProviderLifecycleContext()"})}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"getProviderLifecycleContext"}),"(",(0,i.jsx)(n.code,{children:"providerId"}),", ",(0,i.jsx)(n.code,{children:"containerProviderConnection"}),"): ",(0,i.jsx)(n.a,{href:"/api/interfaces/LifecycleContext",children:(0,i.jsx)(n.code,{children:"LifecycleContext"})})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"It returns the lifecycle context for the provider connection.\nIf no context is found it throws an error"}),"\n",(0,i.jsx)(n.h2,{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 provider id"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"containerProviderConnection"}),": ",(0,i.jsx)(n.a,{href:"/api/interfaces/ContainerProviderConnection",children:(0,i.jsx)(n.code,{children:"ContainerProviderConnection"})})]}),"\n",(0,i.jsx)(n.p,{children:"the connection to retrieve the lifecycle context for"}),"\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/LifecycleContext",children:(0,i.jsx)(n.code,{children:"LifecycleContext"})})}),"\n",(0,i.jsx)(n.p,{children:"the lifecycle context"}),"\n",(0,i.jsx)(n.h2,{id:"throws",children:"Throws"}),"\n",(0,i.jsx)(n.p,{children:"if no provider with the id has been found or there is no context associate to it."}),"\n",(0,i.jsx)(n.h2,{id:"defined-in",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L847",children:"packages/extension-api/src/extension-api.d.ts:847"})})]})}function p(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},43023:(e,n,t)=>{t.d(n,{R:()=>c,x:()=>s});var i=t(63696);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([[21381],{24599:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>d,contentTitle:()=>c,default:()=>p,frontMatter:()=>o,metadata:()=>s,toc:()=>a});var i=t(62540),r=t(43023);const o={},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:"Defined in",id:"defined-in",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",strong:"strong",...(0,r.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.header,{children:(0,i.jsx)(n.h1,{id:"function-getproviderlifecyclecontext",children:"Function: getProviderLifecycleContext()"})}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"getProviderLifecycleContext"}),"(",(0,i.jsx)(n.code,{children:"providerId"}),", ",(0,i.jsx)(n.code,{children:"containerProviderConnection"}),"): ",(0,i.jsx)(n.a,{href:"/api/interfaces/LifecycleContext",children:(0,i.jsx)(n.code,{children:"LifecycleContext"})})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"It returns the lifecycle context for the provider connection.\nIf no context is found it throws an error"}),"\n",(0,i.jsx)(n.h2,{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 provider id"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"containerProviderConnection"}),": ",(0,i.jsx)(n.a,{href:"/api/interfaces/ContainerProviderConnection",children:(0,i.jsx)(n.code,{children:"ContainerProviderConnection"})})]}),"\n",(0,i.jsx)(n.p,{children:"the connection to retrieve the lifecycle context for"}),"\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/LifecycleContext",children:(0,i.jsx)(n.code,{children:"LifecycleContext"})})}),"\n",(0,i.jsx)(n.p,{children:"the lifecycle context"}),"\n",(0,i.jsx)(n.h2,{id:"throws",children:"Throws"}),"\n",(0,i.jsx)(n.p,{children:"if no provider with the id has been found or there is no context associate to it."}),"\n",(0,i.jsx)(n.h2,{id:"defined-in",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L847",children:"packages/extension-api/src/extension-api.d.ts:847"})})]})}function p(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},43023:(e,n,t)=>{t.d(n,{R:()=>c,x:()=>s});var i=t(63696);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/0fa6e9bf.ed7a37dd.js b/assets/js/0fa6e9bf.dfa96e60.js similarity index 97% rename from assets/js/0fa6e9bf.ed7a37dd.js rename to assets/js/0fa6e9bf.dfa96e60.js index 8f66532cbbf..7710ba96370 100644 --- a/assets/js/0fa6e9bf.ed7a37dd.js +++ b/assets/js/0fa6e9bf.dfa96e60.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[76430],{7776:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>c,contentTitle:()=>o,default:()=>p,frontMatter:()=>r,metadata:()=>a,toc:()=>d});var t=s(62540),i=s(43023);const r={},o="Function: openExternal()",a={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:"extensions",permalink:"/api/namespaces/extensions/"}},c={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Defined in",id:"defined-in",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",strong:"strong",...(0,i.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.header,{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.p,{children:"The uri that should be opened."}),"\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:"defined-in",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L4012",children:"packages/extension-api/src/extension-api.d.ts:4012"})})]})}function p(e={}){const{wrapper:n}={...(0,i.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},43023:(e,n,s)=>{s.d(n,{R:()=>o,x:()=>a});var t=s(63696);const i={},r=t.createContext(i);function o(e){const n=t.useContext(r);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function a(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:o(e.components),t.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[76430],{7776:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>c,contentTitle:()=>o,default:()=>p,frontMatter:()=>r,metadata:()=>a,toc:()=>d});var t=s(62540),i=s(43023);const r={},o="Function: openExternal()",a={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:"extensions",permalink:"/api/namespaces/extensions/"}},c={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Defined in",id:"defined-in",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",strong:"strong",...(0,i.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.header,{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.p,{children:"The uri that should be opened."}),"\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:"defined-in",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L4012",children:"packages/extension-api/src/extension-api.d.ts:4012"})})]})}function p(e={}){const{wrapper:n}={...(0,i.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},43023:(e,n,s)=>{s.d(n,{R:()=>o,x:()=>a});var t=s(63696);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/10210328.254d3d2f.js b/assets/js/10210328.be0cabc7.js similarity index 96% rename from assets/js/10210328.254d3d2f.js rename to assets/js/10210328.be0cabc7.js index 8baced03494..154f1f60792 100644 --- a/assets/js/10210328.254d3d2f.js +++ b/assets/js/10210328.be0cabc7.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[41382],{69249:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>d,contentTitle:()=>o,default:()=>x,frontMatter:()=>r,metadata:()=>c,toc:()=>a});var t=s(62540),i=s(43023);const r={},o="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"}},d={},a=[{value:"Type Parameters",id:"type-parameters",level:2},{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Defined in",id:"defined-in",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",strong:"strong",...(0,i.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.header,{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:"defined-in",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/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.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},43023:(e,n,s)=>{s.d(n,{R:()=>o,x:()=>c});var t=s(63696);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([[41382],{69249:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>d,contentTitle:()=>o,default:()=>x,frontMatter:()=>r,metadata:()=>c,toc:()=>a});var t=s(62540),i=s(43023);const r={},o="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"}},d={},a=[{value:"Type Parameters",id:"type-parameters",level:2},{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Defined in",id:"defined-in",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",strong:"strong",...(0,i.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.header,{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:"defined-in",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/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.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},43023:(e,n,s)=>{s.d(n,{R:()=>o,x:()=>c});var t=s(63696);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/107d77e6.b9344263.js b/assets/js/107d77e6.8eaa5676.js similarity index 95% rename from assets/js/107d77e6.b9344263.js rename to assets/js/107d77e6.8eaa5676.js index 0f43d9b960a..977d8eacf27 100644 --- a/assets/js/107d77e6.b9344263.js +++ b/assets/js/107d77e6.8eaa5676.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[21126],{7416:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>c,contentTitle:()=>o,default:()=>p,frontMatter:()=>r,metadata:()=>a,toc:()=>d});var i=t(62540),s=t(43023);const r={},o="Interface: ListInfosOptions",a={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"}},c={},d=[{value:"Properties",id:"properties",level:2},{value:"provider?",id:"provider",level:3},{value:"Default Value",id:"default-value",level:4},{value:"Defined in",id:"defined-in",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",p:"p",pre:"pre",strong:"strong",...(0,s.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.header,{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:"defined-in",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L3451",children:"packages/extension-api/src/extension-api.d.ts:3451"})})]})}function p(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},43023:(e,n,t)=>{t.d(n,{R:()=>o,x:()=>a});var i=t(63696);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([[21126],{7416:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>c,contentTitle:()=>o,default:()=>p,frontMatter:()=>r,metadata:()=>a,toc:()=>d});var i=t(62540),s=t(43023);const r={},o="Interface: ListInfosOptions",a={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"}},c={},d=[{value:"Properties",id:"properties",level:2},{value:"provider?",id:"provider",level:3},{value:"Default Value",id:"default-value",level:4},{value:"Defined in",id:"defined-in",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",p:"p",pre:"pre",strong:"strong",...(0,s.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.header,{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:"defined-in",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L3451",children:"packages/extension-api/src/extension-api.d.ts:3451"})})]})}function p(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},43023:(e,n,t)=>{t.d(n,{R:()=>o,x:()=>a});var i=t(63696);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/123a454a.f7e4c3ba.js b/assets/js/123a454a.aa629d67.js similarity index 80% rename from assets/js/123a454a.f7e4c3ba.js rename to assets/js/123a454a.aa629d67.js index 13ada57861d..0ef6d6b390a 100644 --- a/assets/js/123a454a.f7e4c3ba.js +++ b/assets/js/123a454a.aa629d67.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[97550],{90829:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>c,contentTitle:()=>d,default:()=>h,frontMatter:()=>r,metadata:()=>o,toc:()=>a});var s=t(62540),i=t(43023);const r={},d="Interface: RunResult",o={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"}},c={},a=[{value:"Properties",id:"properties",level:2},{value:"command",id:"command",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"stderr",id:"stderr",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"stdout",id:"stdout",level:3},{value:"Defined in",id:"defined-in-2",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",p:"p",strong:"strong",...(0,i.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.header,{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:"defined-in",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L4071",children:"packages/extension-api/src/extension-api.d.ts:4071"})}),"\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:"defined-in-1",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L4081",children:"packages/extension-api/src/extension-api.d.ts:4081"})}),"\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:"defined-in-2",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L4076",children:"packages/extension-api/src/extension-api.d.ts:4076"})})]})}function h(e={}){const{wrapper:n}={...(0,i.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},43023:(e,n,t)=>{t.d(n,{R:()=>d,x:()=>o});var s=t(63696);const i={},r=s.createContext(i);function d(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:d(e.components),s.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[97550],{90829:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>o,contentTitle:()=>d,default:()=>h,frontMatter:()=>r,metadata:()=>c,toc:()=>a});var s=t(62540),i=t(43023);const r={},d="Interface: RunResult",c={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"}},o={},a=[{value:"Properties",id:"properties",level:2},{value:"command",id:"command",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"stderr",id:"stderr",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"stdout",id:"stdout",level:3},{value:"Defined in",id:"defined-in-2",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",p:"p",strong:"strong",...(0,i.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.header,{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:"defined-in",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L4071",children:"packages/extension-api/src/extension-api.d.ts:4071"})}),"\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:"defined-in-1",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L4081",children:"packages/extension-api/src/extension-api.d.ts:4081"})}),"\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:"defined-in-2",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L4076",children:"packages/extension-api/src/extension-api.d.ts:4076"})})]})}function h(e={}){const{wrapper:n}={...(0,i.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},43023:(e,n,t)=>{t.d(n,{R:()=>d,x:()=>c});var s=t(63696);const i={},r=s.createContext(i);function d(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:d(e.components),s.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/125d93c1.bef6c0c3.js b/assets/js/125d93c1.57a18275.js similarity index 97% rename from assets/js/125d93c1.bef6c0c3.js rename to assets/js/125d93c1.57a18275.js index 90bc5f3f508..5229f4bd38a 100644 --- a/assets/js/125d93c1.bef6c0c3.js +++ b/assets/js/125d93c1.57a18275.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[53629],{93442:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>r,contentTitle:()=>a,default:()=>p,frontMatter:()=>s,metadata:()=>c,toc:()=>d});var o=t(62540),i=t(43023);const s={},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:"Defined in",id:"defined-in",level:2}];function u(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",strong:"strong",...(0,i.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(n.header,{children:(0,o.jsx)(n.h1,{id:"function-navigatetopods",children:"Function: navigateToPods()"})}),"\n",(0,o.jsxs)(n.blockquote,{children:["\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.strong,{children:"navigateToPods"}),"(): ",(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:"defined-in",children:"Defined in"}),"\n",(0,o.jsx)(n.p,{children:(0,o.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L4519",children:"packages/extension-api/src/extension-api.d.ts:4519"})})]})}function p(e={}){const{wrapper:n}={...(0,i.R)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(u,{...e})}):u(e)}},43023:(e,n,t)=>{t.d(n,{R:()=>a,x:()=>c});var o=t(63696);const i={},s=o.createContext(i);function a(e){const n=o.useContext(s);return o.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:a(e.components),o.createElement(s.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[53629],{93442:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>r,contentTitle:()=>a,default:()=>p,frontMatter:()=>s,metadata:()=>c,toc:()=>d});var o=t(62540),i=t(43023);const s={},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:"Defined in",id:"defined-in",level:2}];function u(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",strong:"strong",...(0,i.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(n.header,{children:(0,o.jsx)(n.h1,{id:"function-navigatetopods",children:"Function: navigateToPods()"})}),"\n",(0,o.jsxs)(n.blockquote,{children:["\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.strong,{children:"navigateToPods"}),"(): ",(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:"defined-in",children:"Defined in"}),"\n",(0,o.jsx)(n.p,{children:(0,o.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L4519",children:"packages/extension-api/src/extension-api.d.ts:4519"})})]})}function p(e={}){const{wrapper:n}={...(0,i.R)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(u,{...e})}):u(e)}},43023:(e,n,t)=>{t.d(n,{R:()=>a,x:()=>c});var o=t(63696);const i={},s=o.createContext(i);function a(e){const n=o.useContext(s);return o.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:a(e.components),o.createElement(s.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/12eb386e.3bff7be2.js b/assets/js/12eb386e.f732d0f4.js similarity index 85% rename from assets/js/12eb386e.3bff7be2.js rename to assets/js/12eb386e.f732d0f4.js index 5827f92dc2d..20de1578c6e 100644 --- a/assets/js/12eb386e.3bff7be2.js +++ b/assets/js/12eb386e.f732d0f4.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[78989],{19343:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>l,contentTitle:()=>d,default:()=>h,frontMatter:()=>o,metadata:()=>a,toc:()=>r});var s=i(62540),t=i(43023);const o={},d="Interface: CliToolOptions",a={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:"CliToolInstaller",permalink:"/api/interfaces/CliToolInstaller"},next:{title:"CliToolSelectUpdate",permalink:"/api/interfaces/CliToolSelectUpdate"}},l={},r=[{value:"Properties",id:"properties",level:2},{value:"displayName",id:"displayname",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"images",id:"images",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"installationSource?",id:"installationsource",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"markdownDescription",id:"markdowndescription",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"name",id:"name",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"path?",id:"path",level:3},{value:"Defined in",id:"defined-in-5",level:4},{value:"version?",id:"version",level:3},{value:"Defined in",id:"defined-in-6",level:4}];function c(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",li:"li",p:"p",strong:"strong",ul:"ul",...(0,t.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.header,{children:(0,s.jsx)(n.h1,{id:"interface-clitooloptions",children:"Interface: CliToolOptions"})}),"\n",(0,s.jsx)(n.p,{children:"Options to create new CliTool instance and register it in podman desktop"}),"\n",(0,s.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,s.jsx)(n.h3,{id:"displayname",children:"displayName"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"displayName"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L4311",children:"packages/extension-api/src/extension-api.d.ts:4311"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"images",children:"images"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"images"}),": ",(0,s.jsx)(n.a,{href:"/api/interfaces/ProviderImages",children:(0,s.jsx)(n.code,{children:"ProviderImages"})})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L4313",children:"packages/extension-api/src/extension-api.d.ts:4313"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"installationsource",children:"installationSource?"}),"\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:"installationSource"}),": ",(0,s.jsx)(n.a,{href:"/api/type-aliases/CliToolInstallationSource",children:(0,s.jsx)(n.code,{children:"CliToolInstallationSource"})})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"How the cli tool has been installed"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsx)(n.li,{children:"external: it has been installed by the user externally from podman desktop. Its update process is disable."}),"\n",(0,s.jsx)(n.li,{children:"extension: it has been installed by podman desktop extension. It can be updated"}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-2",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L4331",children:"packages/extension-api/src/extension-api.d.ts:4331"})}),"\n",(0,s.jsx)(n.hr,{}),"\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.strong,{children:"markdownDescription"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-3",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L4312",children:"packages/extension-api/src/extension-api.d.ts:4312"})}),"\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:"defined-in-4",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L4310",children:"packages/extension-api/src/extension-api.d.ts:4310"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"path",children:"path?"}),"\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:"path"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-5",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L4324",children:"packages/extension-api/src/extension-api.d.ts:4324"})}),"\n",(0,s.jsx)(n.hr,{}),"\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.code,{children:"optional"})," ",(0,s.jsx)(n.strong,{children:"version"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.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,s.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'.\nNote: If the version and path are not defined (= the tool is not installed), the install logic should be implemented"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-6",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L4323",children:"packages/extension-api/src/extension-api.d.ts:4323"})})]})}function h(e={}){const{wrapper:n}={...(0,t.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(c,{...e})}):c(e)}},43023:(e,n,i)=>{i.d(n,{R:()=>d,x:()=>a});var s=i(63696);const t={},o=s.createContext(t);function d(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:d(e.components),s.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[78989],{19343:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>l,contentTitle:()=>a,default:()=>h,frontMatter:()=>o,metadata:()=>d,toc:()=>r});var s=i(62540),t=i(43023);const o={},a="Interface: CliToolOptions",d={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:"CliToolInstaller",permalink:"/api/interfaces/CliToolInstaller"},next:{title:"CliToolSelectUpdate",permalink:"/api/interfaces/CliToolSelectUpdate"}},l={},r=[{value:"Properties",id:"properties",level:2},{value:"displayName",id:"displayname",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"images",id:"images",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"installationSource?",id:"installationsource",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"markdownDescription",id:"markdowndescription",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"name",id:"name",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"path?",id:"path",level:3},{value:"Defined in",id:"defined-in-5",level:4},{value:"version?",id:"version",level:3},{value:"Defined in",id:"defined-in-6",level:4}];function c(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",li:"li",p:"p",strong:"strong",ul:"ul",...(0,t.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.header,{children:(0,s.jsx)(n.h1,{id:"interface-clitooloptions",children:"Interface: CliToolOptions"})}),"\n",(0,s.jsx)(n.p,{children:"Options to create new CliTool instance and register it in podman desktop"}),"\n",(0,s.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,s.jsx)(n.h3,{id:"displayname",children:"displayName"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"displayName"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L4311",children:"packages/extension-api/src/extension-api.d.ts:4311"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"images",children:"images"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"images"}),": ",(0,s.jsx)(n.a,{href:"/api/interfaces/ProviderImages",children:(0,s.jsx)(n.code,{children:"ProviderImages"})})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L4313",children:"packages/extension-api/src/extension-api.d.ts:4313"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"installationsource",children:"installationSource?"}),"\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:"installationSource"}),": ",(0,s.jsx)(n.a,{href:"/api/type-aliases/CliToolInstallationSource",children:(0,s.jsx)(n.code,{children:"CliToolInstallationSource"})})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"How the cli tool has been installed"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsx)(n.li,{children:"external: it has been installed by the user externally from podman desktop. Its update process is disable."}),"\n",(0,s.jsx)(n.li,{children:"extension: it has been installed by podman desktop extension. It can be updated"}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-2",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L4331",children:"packages/extension-api/src/extension-api.d.ts:4331"})}),"\n",(0,s.jsx)(n.hr,{}),"\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.strong,{children:"markdownDescription"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-3",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L4312",children:"packages/extension-api/src/extension-api.d.ts:4312"})}),"\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:"defined-in-4",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L4310",children:"packages/extension-api/src/extension-api.d.ts:4310"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"path",children:"path?"}),"\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:"path"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-5",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L4324",children:"packages/extension-api/src/extension-api.d.ts:4324"})}),"\n",(0,s.jsx)(n.hr,{}),"\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.code,{children:"optional"})," ",(0,s.jsx)(n.strong,{children:"version"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.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,s.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'.\nNote: If the version and path are not defined (= the tool is not installed), the install logic should be implemented"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-6",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L4323",children:"packages/extension-api/src/extension-api.d.ts:4323"})})]})}function h(e={}){const{wrapper:n}={...(0,t.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(c,{...e})}):c(e)}},43023:(e,n,i)=>{i.d(n,{R:()=>a,x:()=>d});var s=i(63696);const t={},o=s.createContext(t);function a(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(t):e.components||t:a(e.components),s.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/148448cb.7b3edab0.js b/assets/js/148448cb.cae7c405.js similarity index 88% rename from assets/js/148448cb.7b3edab0.js rename to assets/js/148448cb.cae7c405.js index 19988dd8f1b..dca445309bc 100644 --- a/assets/js/148448cb.7b3edab0.js +++ b/assets/js/148448cb.cae7c405.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[40611],{98810:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>o,contentTitle:()=>a,default:()=>h,frontMatter:()=>t,metadata:()=>c,toc:()=>r});var s=i(62540),d=i(43023);const t={},a="Interface: ContainerCreateOptions",c={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"}},o={},r=[{value:"Properties",id:"properties",level:2},{value:"ArgsEscaped?",id:"argsescaped",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"AttachStderr?",id:"attachstderr",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"AttachStdin?",id:"attachstdin",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"AttachStdout?",id:"attachstdout",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"Cmd?",id:"cmd",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"Detach?",id:"detach",level:3},{value:"Defined in",id:"defined-in-5",level:4},{value:"Domainname?",id:"domainname",level:3},{value:"Defined in",id:"defined-in-6",level:4},{value:"Entrypoint?",id:"entrypoint",level:3},{value:"Defined in",id:"defined-in-7",level:4},{value:"Env?",id:"env",level:3},{value:"Defined in",id:"defined-in-8",level:4},{value:"EnvFiles?",id:"envfiles",level:3},{value:"Defined in",id:"defined-in-9",level:4},{value:"ExposedPorts?",id:"exposedports",level:3},{value:"Index Signature",id:"index-signature",level:4},{value:"Defined in",id:"defined-in-10",level:4},{value:"HealthCheck?",id:"healthcheck",level:3},{value:"Defined in",id:"defined-in-11",level:4},{value:"HostConfig?",id:"hostconfig",level:3},{value:"Defined in",id:"defined-in-12",level:4},{value:"Hostname?",id:"hostname",level:3},{value:"Defined in",id:"defined-in-13",level:4},{value:"Image?",id:"image",level:3},{value:"Defined in",id:"defined-in-14",level:4},{value:"Labels?",id:"labels",level:3},{value:"Index Signature",id:"index-signature-1",level:4},{value:"Defined in",id:"defined-in-15",level:4},{value:"MacAddress?",id:"macaddress",level:3},{value:"Defined in",id:"defined-in-16",level:4},{value:"NetworkConfig?",id:"networkconfig",level:3},{value:"Defined in",id:"defined-in-17",level:4},{value:"NetworkDisabled?",id:"networkdisabled",level:3},{value:"Defined in",id:"defined-in-18",level:4},{value:"OnBuild?",id:"onbuild",level:3},{value:"Defined in",id:"defined-in-19",level:4},{value:"OpenStdin?",id:"openstdin",level:3},{value:"Defined in",id:"defined-in-20",level:4},{value:"Shell?",id:"shell",level:3},{value:"Defined in",id:"defined-in-21",level:4},{value:"StdinOnce?",id:"stdinonce",level:3},{value:"Defined in",id:"defined-in-22",level:4},{value:"StopSignal?",id:"stopsignal",level:3},{value:"Defined in",id:"defined-in-23",level:4},{value:"StopTimeout?",id:"stoptimeout",level:3},{value:"Defined in",id:"defined-in-24",level:4},{value:"Tty?",id:"tty",level:3},{value:"Defined in",id:"defined-in-25",level:4},{value:"User?",id:"user",level:3},{value:"Defined in",id:"defined-in-26",level:4},{value:"Volumes?",id:"volumes",level:3},{value:"Index Signature",id:"index-signature-2",level:4},{value:"Defined in",id:"defined-in-27",level:4},{value:"WorkingDir?",id:"workingdir",level:3},{value:"Defined in",id:"defined-in-28",level:4},{value:"name?",id:"name",level:3},{value:"Defined in",id:"defined-in-29",level:4},{value:"platform?",id:"platform",level:3},{value:"Defined in",id:"defined-in-30",level:4},{value:"pod?",id:"pod",level:3},{value:"Defined in",id:"defined-in-31",level:4},{value:"start?",id:"start",level:3},{value:"Defined in",id:"defined-in-32",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",p:"p",pre:"pre",strong:"strong",...(0,d.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.header,{children:(0,s.jsx)(n.h1,{id:"interface-containercreateoptions",children:"Interface: ContainerCreateOptions"})}),"\n",(0,s.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,s.jsx)(n.h3,{id:"argsescaped",children:"ArgsEscaped?"}),"\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:"ArgsEscaped"}),": ",(0,s.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:["Default: ",(0,s.jsx)(n.code,{children:"false"})]}),"\n",(0,s.jsx)(n.p,{children:"Command is already escaped (Windows only)"}),"\n",(0,s.jsx)(n.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2991",children:"packages/extension-api/src/extension-api.d.ts:2991"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"attachstderr",children:"AttachStderr?"}),"\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:"AttachStderr"}),": ",(0,s.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:["Whether to attach to ",(0,s.jsx)(n.code,{children:"stderr"})," (default false)"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2959",children:"packages/extension-api/src/extension-api.d.ts:2959"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"attachstdin",children:"AttachStdin?"}),"\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:"AttachStdin"}),": ",(0,s.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:["Whether to attach to ",(0,s.jsx)(n.code,{children:"stdin"})," (default false)"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-2",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2949",children:"packages/extension-api/src/extension-api.d.ts:2949"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"attachstdout",children:"AttachStdout?"}),"\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:"AttachStdout"}),": ",(0,s.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:["Whether to attach to ",(0,s.jsx)(n.code,{children:"stdout"}),"(default false)"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-3",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2954",children:"packages/extension-api/src/extension-api.d.ts:2954"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"cmd",children:"Cmd?"}),"\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:"Cmd"}),": ",(0,s.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Command to run specified as an array of strings"}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-4",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2937",children:"packages/extension-api/src/extension-api.d.ts:2937"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"detach",children:"Detach?"}),"\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:"Detach"}),": ",(0,s.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Run the container in the background"}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-5",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2974",children:"packages/extension-api/src/extension-api.d.ts:2974"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"domainname",children:"Domainname?"}),"\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:"Domainname"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The domain name to use for the container."}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-6",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2891",children:"packages/extension-api/src/extension-api.d.ts:2891"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"entrypoint",children:"Entrypoint?"}),"\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:"Entrypoint"}),": ",(0,s.jsx)(n.code,{children:"string"})," | ",(0,s.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The entry point for the container as a string or an array of strings."}),"\n",(0,s.jsxs)(n.p,{children:["If the array consists of exactly one empty string (",(0,s.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,s.jsx)(n.h4,{id:"defined-in-7",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2944",children:"packages/extension-api/src/extension-api.d.ts:2944"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"env",children:"Env?"}),"\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:"Env"}),": ",(0,s.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:["A list of environment variables to set inside the container in the form ",(0,s.jsx)(n.code,{children:'["VAR=value", ...]'}),". A variable without ",(0,s.jsx)(n.code,{children:"="})," is removed from the environment, rather than to have an empty value"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-8",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/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:"envfiles",children:"EnvFiles?"}),"\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:"EnvFiles"}),": ",(0,s.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Environment files to use"}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-9",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2906",children:"packages/extension-api/src/extension-api.d.ts:2906"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"exposedports",children:"ExposedPorts?"}),"\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:"ExposedPorts"}),": ",(0,s.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:["An object mapping ports to an empty object in the form: ",(0,s.jsx)(n.code,{children:'{"/": {}}'})]}),"\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:"port"}),": ",(0,s.jsx)(n.code,{children:"string"}),"]: ",(0,s.jsx)(n.code,{children:"object"})]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-10",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2917",children:"packages/extension-api/src/extension-api.d.ts:2917"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"healthcheck",children:"HealthCheck?"}),"\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:"HealthCheck"}),": ",(0,s.jsx)(n.a,{href:"/api/interfaces/HealthConfig",children:(0,s.jsx)(n.code,{children:"HealthConfig"})})]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:["A test to perform to check that the container is healthy. See ",(0,s.jsx)(n.a,{href:"/api/interfaces/HealthConfig",children:"HealthConfig"})," for usage details"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-11",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2984",children:"packages/extension-api/src/extension-api.d.ts:2984"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"hostconfig",children:"HostConfig?"}),"\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:"HostConfig"}),": ",(0,s.jsx)(n.a,{href:"/api/interfaces/HostConfig",children:(0,s.jsx)(n.code,{children:"HostConfig"})})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Container configuration that depends on the host we are running on"}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-12",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2922",children:"packages/extension-api/src/extension-api.d.ts:2922"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"hostname",children:"Hostname?"}),"\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:"Hostname"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The hostname to use for the container, as a valid RFC 1123 hostname"}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-13",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2886",children:"packages/extension-api/src/extension-api.d.ts:2886"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"image",children:"Image?"}),"\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:"Image"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The name (or reference) of the image to use when creating the container"}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-14",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2927",children:"packages/extension-api/src/extension-api.d.ts:2927"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"labels",children:"Labels?"}),"\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:"Labels"}),": ",(0,s.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"User-defined key/value metadata"}),"\n",(0,s.jsx)(n.h4,{id:"index-signature-1",children:"Index Signature"}),"\n",(0,s.jsxs)(n.p,{children:["[",(0,s.jsx)(n.code,{children:"label"}),": ",(0,s.jsx)(n.code,{children:"string"}),"]: ",(0,s.jsx)(n.code,{children:"string"})]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-15",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2911",children:"packages/extension-api/src/extension-api.d.ts:2911"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"macaddress",children:"MacAddress?"}),"\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:"MacAddress"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"MAC address of the container."}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-16",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L3011",children:"packages/extension-api/src/extension-api.d.ts:3011"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"networkconfig",children:"NetworkConfig?"}),"\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:"NetworkConfig"}),": ",(0,s.jsx)(n.a,{href:"/api/interfaces/NetworkingConfig",children:(0,s.jsx)(n.code,{children:"NetworkingConfig"})})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-17",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L3035",children:"packages/extension-api/src/extension-api.d.ts:3035"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"networkdisabled",children:"NetworkDisabled?"}),"\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:"NetworkDisabled"}),": ",(0,s.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Disable networking for the container."}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-18",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L3006",children:"packages/extension-api/src/extension-api.d.ts:3006"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"onbuild",children:"OnBuild?"}),"\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:"OnBuild"}),": ",(0,s.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"ONBUILD"})," metadata that were defined in the image's ",(0,s.jsx)(n.code,{children:"Dockerfile"}),"."]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-19",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L3016",children:"packages/extension-api/src/extension-api.d.ts:3016"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"openstdin",children:"OpenStdin?"}),"\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:"OpenStdin"}),": ",(0,s.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:["Whether to open ",(0,s.jsx)(n.code,{children:"stdin"})," (default false)"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-20",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2964",children:"packages/extension-api/src/extension-api.d.ts:2964"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"shell",children:"Shell?"}),"\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:"Shell"}),": ",(0,s.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:["Shell for when ",(0,s.jsx)(n.code,{children:"RUN"}),", ",(0,s.jsx)(n.code,{children:"CMD"}),", and ",(0,s.jsx)(n.code,{children:"ENTRYPOINT"})," uses a shell."]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-21",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L3033",children:"packages/extension-api/src/extension-api.d.ts:3033"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"stdinonce",children:"StdinOnce?"}),"\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:"StdinOnce"}),": ",(0,s.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:["Close ",(0,s.jsx)(n.code,{children:"stdin"})," after one attached client disconnects (deafult false)"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-22",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2969",children:"packages/extension-api/src/extension-api.d.ts:2969"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"stopsignal",children:"StopSignal?"}),"\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:"StopSignal"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Signal to stop a container as a string or unsigned integer."}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-23",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L3021",children:"packages/extension-api/src/extension-api.d.ts:3021"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"stoptimeout",children:"StopTimeout?"}),"\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:"StopTimeout"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:["Default: ",(0,s.jsx)(n.code,{children:"10"})]}),"\n",(0,s.jsx)(n.p,{children:"Timeout to stop a container in seconds."}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-24",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L3028",children:"packages/extension-api/src/extension-api.d.ts:3028"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"tty",children:"Tty?"}),"\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:"Tty"}),": ",(0,s.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Attach standard streams to a TTY, including stdin if it is not closed (default false)"}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-25",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2932",children:"packages/extension-api/src/extension-api.d.ts:2932"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"user",children:"User?"}),"\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:"User"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The user that commands are run as inside the container"}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-26",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2896",children:"packages/extension-api/src/extension-api.d.ts:2896"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"volumes",children:"Volumes?"}),"\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:"Volumes"}),": ",(0,s.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"An object mapping mount point paths inside the container to empty objects."}),"\n",(0,s.jsx)(n.h4,{id:"index-signature-2",children:"Index Signature"}),"\n",(0,s.jsxs)(n.p,{children:["[",(0,s.jsx)(n.code,{children:"volume"}),": ",(0,s.jsx)(n.code,{children:"string"}),"]: ",(0,s.jsx)(n.code,{children:"object"})]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-27",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2996",children:"packages/extension-api/src/extension-api.d.ts:2996"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"workingdir",children:"WorkingDir?"}),"\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:"WorkingDir"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The working directory for commands to run in."}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-28",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L3001",children:"packages/extension-api/src/extension-api.d.ts:3001"})}),"\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.code,{children:"optional"})," ",(0,s.jsx)(n.strong,{children:"name"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:["Assign the specified name to the container. Must match the regular expression",(0,s.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,s.jsx)(n.h4,{id:"defined-in-29",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2864",children:"packages/extension-api/src/extension-api.d.ts:2864"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"platform",children:"platform?"}),"\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:"platform"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:'Default: ""'}),"\n",(0,s.jsxs)(n.p,{children:["Platform in the format ",(0,s.jsx)(n.code,{children:"os[/arch[/variant]]"})," used for image lookup."]}),"\n",(0,s.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,s.jsx)(n.code,{children:"404"})," status."]}),"\n",(0,s.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,s.jsx)(n.code,{children:"Warnings"})," field in the response, for example;"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.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,s.jsx)(n.h4,{id:"defined-in-30",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2881",children:"packages/extension-api/src/extension-api.d.ts:2881"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"pod",children:"pod?"}),"\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:"pod"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Pod where to create the container in"}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-31",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L3040",children:"packages/extension-api/src/extension-api.d.ts:3040"})}),"\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:"boolean"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Start the container immediately (default true)"}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-32",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2979",children:"packages/extension-api/src/extension-api.d.ts:2979"})})]})}function h(e={}){const{wrapper:n}={...(0,d.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},43023:(e,n,i)=>{i.d(n,{R:()=>a,x:()=>c});var s=i(63696);const d={},t=s.createContext(d);function a(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(d):e.components||d:a(e.components),s.createElement(t.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[40611],{98810:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>o,contentTitle:()=>a,default:()=>h,frontMatter:()=>t,metadata:()=>c,toc:()=>r});var s=i(62540),d=i(43023);const t={},a="Interface: ContainerCreateOptions",c={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"}},o={},r=[{value:"Properties",id:"properties",level:2},{value:"ArgsEscaped?",id:"argsescaped",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"AttachStderr?",id:"attachstderr",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"AttachStdin?",id:"attachstdin",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"AttachStdout?",id:"attachstdout",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"Cmd?",id:"cmd",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"Detach?",id:"detach",level:3},{value:"Defined in",id:"defined-in-5",level:4},{value:"Domainname?",id:"domainname",level:3},{value:"Defined in",id:"defined-in-6",level:4},{value:"Entrypoint?",id:"entrypoint",level:3},{value:"Defined in",id:"defined-in-7",level:4},{value:"Env?",id:"env",level:3},{value:"Defined in",id:"defined-in-8",level:4},{value:"EnvFiles?",id:"envfiles",level:3},{value:"Defined in",id:"defined-in-9",level:4},{value:"ExposedPorts?",id:"exposedports",level:3},{value:"Index Signature",id:"index-signature",level:4},{value:"Defined in",id:"defined-in-10",level:4},{value:"HealthCheck?",id:"healthcheck",level:3},{value:"Defined in",id:"defined-in-11",level:4},{value:"HostConfig?",id:"hostconfig",level:3},{value:"Defined in",id:"defined-in-12",level:4},{value:"Hostname?",id:"hostname",level:3},{value:"Defined in",id:"defined-in-13",level:4},{value:"Image?",id:"image",level:3},{value:"Defined in",id:"defined-in-14",level:4},{value:"Labels?",id:"labels",level:3},{value:"Index Signature",id:"index-signature-1",level:4},{value:"Defined in",id:"defined-in-15",level:4},{value:"MacAddress?",id:"macaddress",level:3},{value:"Defined in",id:"defined-in-16",level:4},{value:"NetworkConfig?",id:"networkconfig",level:3},{value:"Defined in",id:"defined-in-17",level:4},{value:"NetworkDisabled?",id:"networkdisabled",level:3},{value:"Defined in",id:"defined-in-18",level:4},{value:"OnBuild?",id:"onbuild",level:3},{value:"Defined in",id:"defined-in-19",level:4},{value:"OpenStdin?",id:"openstdin",level:3},{value:"Defined in",id:"defined-in-20",level:4},{value:"Shell?",id:"shell",level:3},{value:"Defined in",id:"defined-in-21",level:4},{value:"StdinOnce?",id:"stdinonce",level:3},{value:"Defined in",id:"defined-in-22",level:4},{value:"StopSignal?",id:"stopsignal",level:3},{value:"Defined in",id:"defined-in-23",level:4},{value:"StopTimeout?",id:"stoptimeout",level:3},{value:"Defined in",id:"defined-in-24",level:4},{value:"Tty?",id:"tty",level:3},{value:"Defined in",id:"defined-in-25",level:4},{value:"User?",id:"user",level:3},{value:"Defined in",id:"defined-in-26",level:4},{value:"Volumes?",id:"volumes",level:3},{value:"Index Signature",id:"index-signature-2",level:4},{value:"Defined in",id:"defined-in-27",level:4},{value:"WorkingDir?",id:"workingdir",level:3},{value:"Defined in",id:"defined-in-28",level:4},{value:"name?",id:"name",level:3},{value:"Defined in",id:"defined-in-29",level:4},{value:"platform?",id:"platform",level:3},{value:"Defined in",id:"defined-in-30",level:4},{value:"pod?",id:"pod",level:3},{value:"Defined in",id:"defined-in-31",level:4},{value:"start?",id:"start",level:3},{value:"Defined in",id:"defined-in-32",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",p:"p",pre:"pre",strong:"strong",...(0,d.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.header,{children:(0,s.jsx)(n.h1,{id:"interface-containercreateoptions",children:"Interface: ContainerCreateOptions"})}),"\n",(0,s.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,s.jsx)(n.h3,{id:"argsescaped",children:"ArgsEscaped?"}),"\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:"ArgsEscaped"}),": ",(0,s.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:["Default: ",(0,s.jsx)(n.code,{children:"false"})]}),"\n",(0,s.jsx)(n.p,{children:"Command is already escaped (Windows only)"}),"\n",(0,s.jsx)(n.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2991",children:"packages/extension-api/src/extension-api.d.ts:2991"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"attachstderr",children:"AttachStderr?"}),"\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:"AttachStderr"}),": ",(0,s.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:["Whether to attach to ",(0,s.jsx)(n.code,{children:"stderr"})," (default false)"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2959",children:"packages/extension-api/src/extension-api.d.ts:2959"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"attachstdin",children:"AttachStdin?"}),"\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:"AttachStdin"}),": ",(0,s.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:["Whether to attach to ",(0,s.jsx)(n.code,{children:"stdin"})," (default false)"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-2",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2949",children:"packages/extension-api/src/extension-api.d.ts:2949"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"attachstdout",children:"AttachStdout?"}),"\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:"AttachStdout"}),": ",(0,s.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:["Whether to attach to ",(0,s.jsx)(n.code,{children:"stdout"}),"(default false)"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-3",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2954",children:"packages/extension-api/src/extension-api.d.ts:2954"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"cmd",children:"Cmd?"}),"\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:"Cmd"}),": ",(0,s.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Command to run specified as an array of strings"}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-4",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2937",children:"packages/extension-api/src/extension-api.d.ts:2937"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"detach",children:"Detach?"}),"\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:"Detach"}),": ",(0,s.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Run the container in the background"}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-5",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2974",children:"packages/extension-api/src/extension-api.d.ts:2974"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"domainname",children:"Domainname?"}),"\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:"Domainname"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The domain name to use for the container."}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-6",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2891",children:"packages/extension-api/src/extension-api.d.ts:2891"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"entrypoint",children:"Entrypoint?"}),"\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:"Entrypoint"}),": ",(0,s.jsx)(n.code,{children:"string"})," | ",(0,s.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The entry point for the container as a string or an array of strings."}),"\n",(0,s.jsxs)(n.p,{children:["If the array consists of exactly one empty string (",(0,s.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,s.jsx)(n.h4,{id:"defined-in-7",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2944",children:"packages/extension-api/src/extension-api.d.ts:2944"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"env",children:"Env?"}),"\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:"Env"}),": ",(0,s.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:["A list of environment variables to set inside the container in the form ",(0,s.jsx)(n.code,{children:'["VAR=value", ...]'}),". A variable without ",(0,s.jsx)(n.code,{children:"="})," is removed from the environment, rather than to have an empty value"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-8",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/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:"envfiles",children:"EnvFiles?"}),"\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:"EnvFiles"}),": ",(0,s.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Environment files to use"}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-9",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2906",children:"packages/extension-api/src/extension-api.d.ts:2906"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"exposedports",children:"ExposedPorts?"}),"\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:"ExposedPorts"}),": ",(0,s.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:["An object mapping ports to an empty object in the form: ",(0,s.jsx)(n.code,{children:'{"/": {}}'})]}),"\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:"port"}),": ",(0,s.jsx)(n.code,{children:"string"}),"]: ",(0,s.jsx)(n.code,{children:"object"})]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-10",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2917",children:"packages/extension-api/src/extension-api.d.ts:2917"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"healthcheck",children:"HealthCheck?"}),"\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:"HealthCheck"}),": ",(0,s.jsx)(n.a,{href:"/api/interfaces/HealthConfig",children:(0,s.jsx)(n.code,{children:"HealthConfig"})})]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:["A test to perform to check that the container is healthy. See ",(0,s.jsx)(n.a,{href:"/api/interfaces/HealthConfig",children:"HealthConfig"})," for usage details"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-11",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2984",children:"packages/extension-api/src/extension-api.d.ts:2984"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"hostconfig",children:"HostConfig?"}),"\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:"HostConfig"}),": ",(0,s.jsx)(n.a,{href:"/api/interfaces/HostConfig",children:(0,s.jsx)(n.code,{children:"HostConfig"})})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Container configuration that depends on the host we are running on"}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-12",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2922",children:"packages/extension-api/src/extension-api.d.ts:2922"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"hostname",children:"Hostname?"}),"\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:"Hostname"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The hostname to use for the container, as a valid RFC 1123 hostname"}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-13",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2886",children:"packages/extension-api/src/extension-api.d.ts:2886"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"image",children:"Image?"}),"\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:"Image"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The name (or reference) of the image to use when creating the container"}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-14",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2927",children:"packages/extension-api/src/extension-api.d.ts:2927"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"labels",children:"Labels?"}),"\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:"Labels"}),": ",(0,s.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"User-defined key/value metadata"}),"\n",(0,s.jsx)(n.h4,{id:"index-signature-1",children:"Index Signature"}),"\n",(0,s.jsxs)(n.p,{children:["[",(0,s.jsx)(n.code,{children:"label"}),": ",(0,s.jsx)(n.code,{children:"string"}),"]: ",(0,s.jsx)(n.code,{children:"string"})]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-15",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2911",children:"packages/extension-api/src/extension-api.d.ts:2911"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"macaddress",children:"MacAddress?"}),"\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:"MacAddress"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"MAC address of the container."}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-16",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L3011",children:"packages/extension-api/src/extension-api.d.ts:3011"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"networkconfig",children:"NetworkConfig?"}),"\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:"NetworkConfig"}),": ",(0,s.jsx)(n.a,{href:"/api/interfaces/NetworkingConfig",children:(0,s.jsx)(n.code,{children:"NetworkingConfig"})})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-17",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L3035",children:"packages/extension-api/src/extension-api.d.ts:3035"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"networkdisabled",children:"NetworkDisabled?"}),"\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:"NetworkDisabled"}),": ",(0,s.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Disable networking for the container."}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-18",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L3006",children:"packages/extension-api/src/extension-api.d.ts:3006"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"onbuild",children:"OnBuild?"}),"\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:"OnBuild"}),": ",(0,s.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"ONBUILD"})," metadata that were defined in the image's ",(0,s.jsx)(n.code,{children:"Dockerfile"}),"."]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-19",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L3016",children:"packages/extension-api/src/extension-api.d.ts:3016"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"openstdin",children:"OpenStdin?"}),"\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:"OpenStdin"}),": ",(0,s.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:["Whether to open ",(0,s.jsx)(n.code,{children:"stdin"})," (default false)"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-20",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2964",children:"packages/extension-api/src/extension-api.d.ts:2964"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"shell",children:"Shell?"}),"\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:"Shell"}),": ",(0,s.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:["Shell for when ",(0,s.jsx)(n.code,{children:"RUN"}),", ",(0,s.jsx)(n.code,{children:"CMD"}),", and ",(0,s.jsx)(n.code,{children:"ENTRYPOINT"})," uses a shell."]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-21",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L3033",children:"packages/extension-api/src/extension-api.d.ts:3033"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"stdinonce",children:"StdinOnce?"}),"\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:"StdinOnce"}),": ",(0,s.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:["Close ",(0,s.jsx)(n.code,{children:"stdin"})," after one attached client disconnects (deafult false)"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-22",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2969",children:"packages/extension-api/src/extension-api.d.ts:2969"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"stopsignal",children:"StopSignal?"}),"\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:"StopSignal"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Signal to stop a container as a string or unsigned integer."}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-23",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L3021",children:"packages/extension-api/src/extension-api.d.ts:3021"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"stoptimeout",children:"StopTimeout?"}),"\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:"StopTimeout"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:["Default: ",(0,s.jsx)(n.code,{children:"10"})]}),"\n",(0,s.jsx)(n.p,{children:"Timeout to stop a container in seconds."}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-24",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L3028",children:"packages/extension-api/src/extension-api.d.ts:3028"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"tty",children:"Tty?"}),"\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:"Tty"}),": ",(0,s.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Attach standard streams to a TTY, including stdin if it is not closed (default false)"}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-25",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2932",children:"packages/extension-api/src/extension-api.d.ts:2932"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"user",children:"User?"}),"\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:"User"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The user that commands are run as inside the container"}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-26",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2896",children:"packages/extension-api/src/extension-api.d.ts:2896"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"volumes",children:"Volumes?"}),"\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:"Volumes"}),": ",(0,s.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"An object mapping mount point paths inside the container to empty objects."}),"\n",(0,s.jsx)(n.h4,{id:"index-signature-2",children:"Index Signature"}),"\n",(0,s.jsxs)(n.p,{children:["[",(0,s.jsx)(n.code,{children:"volume"}),": ",(0,s.jsx)(n.code,{children:"string"}),"]: ",(0,s.jsx)(n.code,{children:"object"})]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-27",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2996",children:"packages/extension-api/src/extension-api.d.ts:2996"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"workingdir",children:"WorkingDir?"}),"\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:"WorkingDir"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The working directory for commands to run in."}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-28",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L3001",children:"packages/extension-api/src/extension-api.d.ts:3001"})}),"\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.code,{children:"optional"})," ",(0,s.jsx)(n.strong,{children:"name"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:["Assign the specified name to the container. Must match the regular expression",(0,s.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,s.jsx)(n.h4,{id:"defined-in-29",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2864",children:"packages/extension-api/src/extension-api.d.ts:2864"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"platform",children:"platform?"}),"\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:"platform"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:'Default: ""'}),"\n",(0,s.jsxs)(n.p,{children:["Platform in the format ",(0,s.jsx)(n.code,{children:"os[/arch[/variant]]"})," used for image lookup."]}),"\n",(0,s.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,s.jsx)(n.code,{children:"404"})," status."]}),"\n",(0,s.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,s.jsx)(n.code,{children:"Warnings"})," field in the response, for example;"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.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,s.jsx)(n.h4,{id:"defined-in-30",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2881",children:"packages/extension-api/src/extension-api.d.ts:2881"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"pod",children:"pod?"}),"\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:"pod"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Pod where to create the container in"}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-31",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L3040",children:"packages/extension-api/src/extension-api.d.ts:3040"})}),"\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:"boolean"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Start the container immediately (default true)"}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-32",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2979",children:"packages/extension-api/src/extension-api.d.ts:2979"})})]})}function h(e={}){const{wrapper:n}={...(0,d.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},43023:(e,n,i)=>{i.d(n,{R:()=>a,x:()=>c});var s=i(63696);const d={},t=s.createContext(d);function a(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(d):e.components||d:a(e.components),s.createElement(t.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/14ae68e7.19a19f4d.js b/assets/js/14ae68e7.4af9c8c3.js similarity index 93% rename from assets/js/14ae68e7.19a19f4d.js rename to assets/js/14ae68e7.4af9c8c3.js index c1bc94149da..c87ecc2aee1 100644 --- a/assets/js/14ae68e7.19a19f4d.js +++ b/assets/js/14ae68e7.4af9c8c3.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[836],{98837:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>c,contentTitle:()=>r,default:()=>p,frontMatter:()=>d,metadata:()=>o,toc:()=>a});var s=i(62540),t=i(43023);const d={},r="Interface: EndpointIPAMConfig",o={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"}},c={},a=[{value:"Properties",id:"properties",level:2},{value:"IPv4Address?",id:"ipv4address",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"IPv6Address?",id:"ipv6address",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"LinkLocalIPs?",id:"linklocalips",level:3},{value:"Defined in",id:"defined-in-2",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",p:"p",strong:"strong",...(0,t.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.header,{children:(0,s.jsx)(n.h1,{id:"interface-endpointipamconfig",children:"Interface: EndpointIPAMConfig"})}),"\n",(0,s.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,s.jsx)(n.h3,{id:"ipv4address",children:"IPv4Address?"}),"\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:"IPv4Address"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2759",children:"packages/extension-api/src/extension-api.d.ts:2759"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"ipv6address",children:"IPv6Address?"}),"\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:"IPv6Address"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2760",children:"packages/extension-api/src/extension-api.d.ts:2760"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"linklocalips",children:"LinkLocalIPs?"}),"\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:"LinkLocalIPs"}),": ",(0,s.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-2",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2761",children:"packages/extension-api/src/extension-api.d.ts:2761"})})]})}function p(e={}){const{wrapper:n}={...(0,t.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},43023:(e,n,i)=>{i.d(n,{R:()=>r,x:()=>o});var s=i(63696);const t={},d=s.createContext(t);function r(e){const n=s.useContext(d);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(d.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[836],{98837:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>c,contentTitle:()=>r,default:()=>p,frontMatter:()=>d,metadata:()=>o,toc:()=>a});var s=i(62540),t=i(43023);const d={},r="Interface: EndpointIPAMConfig",o={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"}},c={},a=[{value:"Properties",id:"properties",level:2},{value:"IPv4Address?",id:"ipv4address",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"IPv6Address?",id:"ipv6address",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"LinkLocalIPs?",id:"linklocalips",level:3},{value:"Defined in",id:"defined-in-2",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",p:"p",strong:"strong",...(0,t.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.header,{children:(0,s.jsx)(n.h1,{id:"interface-endpointipamconfig",children:"Interface: EndpointIPAMConfig"})}),"\n",(0,s.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,s.jsx)(n.h3,{id:"ipv4address",children:"IPv4Address?"}),"\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:"IPv4Address"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2759",children:"packages/extension-api/src/extension-api.d.ts:2759"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"ipv6address",children:"IPv6Address?"}),"\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:"IPv6Address"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2760",children:"packages/extension-api/src/extension-api.d.ts:2760"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"linklocalips",children:"LinkLocalIPs?"}),"\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:"LinkLocalIPs"}),": ",(0,s.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-2",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2761",children:"packages/extension-api/src/extension-api.d.ts:2761"})})]})}function p(e={}){const{wrapper:n}={...(0,t.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},43023:(e,n,i)=>{i.d(n,{R:()=>r,x:()=>o});var s=i(63696);const t={},d=s.createContext(t);function r(e){const n=s.useContext(d);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(d.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/1515c895.29a309e1.js b/assets/js/1515c895.88b21388.js similarity index 96% rename from assets/js/1515c895.29a309e1.js rename to assets/js/1515c895.88b21388.js index 8f6c88b7512..5aa12743d90 100644 --- a/assets/js/1515c895.29a309e1.js +++ b/assets/js/1515c895.88b21388.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[26716],{36105:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>c,contentTitle:()=>o,default:()=>g,frontMatter:()=>s,metadata:()=>r,toc:()=>d});var t=i(62540),a=i(43023);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:"Defined in",id:"defined-in",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",strong:"strong",...(0,a.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.header,{children:(0,t.jsx)(n.h1,{id:"function-navigatetoimage",children:"Function: navigateToImage()"})}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"navigateToImage"}),"(",(0,t.jsx)(n.code,{children:"id"}),", ",(0,t.jsx)(n.code,{children:"engineId"}),", ",(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.h2,{id:"parameters",children:"Parameters"}),"\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:["\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:"tag"}),": ",(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:"defined-in",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L4511",children:"packages/extension-api/src/extension-api.d.ts:4511"})})]})}function g(e={}){const{wrapper:n}={...(0,a.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},43023:(e,n,i)=>{i.d(n,{R:()=>o,x:()=>r});var t=i(63696);const a={},s=t.createContext(a);function o(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(a):e.components||a:o(e.components),t.createElement(s.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[26716],{36105:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>c,contentTitle:()=>o,default:()=>g,frontMatter:()=>s,metadata:()=>r,toc:()=>d});var t=i(62540),a=i(43023);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:"Defined in",id:"defined-in",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",strong:"strong",...(0,a.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.header,{children:(0,t.jsx)(n.h1,{id:"function-navigatetoimage",children:"Function: navigateToImage()"})}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"navigateToImage"}),"(",(0,t.jsx)(n.code,{children:"id"}),", ",(0,t.jsx)(n.code,{children:"engineId"}),", ",(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.h2,{id:"parameters",children:"Parameters"}),"\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:["\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:"tag"}),": ",(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:"defined-in",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L4511",children:"packages/extension-api/src/extension-api.d.ts:4511"})})]})}function g(e={}){const{wrapper:n}={...(0,a.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},43023:(e,n,i)=>{i.d(n,{R:()=>o,x:()=>r});var t=i(63696);const a={},s=t.createContext(a);function o(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(a):e.components||a:o(e.components),t.createElement(s.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/160cb329.688bd9c3.js b/assets/js/160cb329.e38489c1.js similarity index 81% rename from assets/js/160cb329.688bd9c3.js rename to assets/js/160cb329.e38489c1.js index 66c2d2cc6ae..033aaf07029 100644 --- a/assets/js/160cb329.688bd9c3.js +++ b/assets/js/160cb329.e38489c1.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[45759],{86341:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>d,contentTitle:()=>o,default:()=>h,frontMatter:()=>r,metadata:()=>c,toc:()=>a});var t=i(62540),s=i(43023);const r={},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"}},d={},a=[{value:"Properties",id:"properties",level:2},{value:"details?",id:"details",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"name",id:"name",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"status",id:"status",level:3},{value:"Defined in",id:"defined-in-2",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",p:"p",strong:"strong",...(0,s.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.header,{children:(0,t.jsx)(n.h1,{id:"interface-providerdetectioncheck",children:"Interface: ProviderDetectionCheck"})}),"\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:"defined-in",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L307",children:"packages/extension-api/src/extension-api.d.ts:307"})}),"\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:"defined-in-1",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L306",children:"packages/extension-api/src/extension-api.d.ts:306"})}),"\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:"boolean"})]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"defined-in-2",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/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.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},43023:(e,n,i)=>{i.d(n,{R:()=>o,x:()=>c});var t=i(63696);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 +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[45759],{86341:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>d,contentTitle:()=>c,default:()=>h,frontMatter:()=>r,metadata:()=>o,toc:()=>a});var t=i(62540),s=i(43023);const r={},c="Interface: ProviderDetectionCheck",o={id:"interfaces/ProviderDetectionCheck",title:"Interface: ProviderDetectionCheck",description:"Properties",source:"@site/api/interfaces/ProviderDetectionCheck.md",sourceDirName:"interfaces",slug:"/interfaces/ProviderDetectionCheck",permalink:"/api/interfaces/ProviderDetectionCheck",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"ProviderContainerConnection",permalink:"/api/interfaces/ProviderContainerConnection"},next:{title:"ProviderEvent",permalink:"/api/interfaces/ProviderEvent"}},d={},a=[{value:"Properties",id:"properties",level:2},{value:"details?",id:"details",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"name",id:"name",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"status",id:"status",level:3},{value:"Defined in",id:"defined-in-2",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",p:"p",strong:"strong",...(0,s.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.header,{children:(0,t.jsx)(n.h1,{id:"interface-providerdetectioncheck",children:"Interface: ProviderDetectionCheck"})}),"\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:"defined-in",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L307",children:"packages/extension-api/src/extension-api.d.ts:307"})}),"\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:"defined-in-1",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L306",children:"packages/extension-api/src/extension-api.d.ts:306"})}),"\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:"boolean"})]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"defined-in-2",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/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.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},43023:(e,n,i)=>{i.d(n,{R:()=>c,x:()=>o});var t=i(63696);const s={},r=t.createContext(s);function c(e){const n=t.useContext(r);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:c(e.components),t.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/164937d2.480240d3.js b/assets/js/164937d2.ebc7a947.js similarity index 95% rename from assets/js/164937d2.480240d3.js rename to assets/js/164937d2.ebc7a947.js index 3f42a6cba57..baee249be60 100644 --- a/assets/js/164937d2.480240d3.js +++ b/assets/js/164937d2.ebc7a947.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[2571],{78632:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>a,contentTitle:()=>d,default:()=>h,frontMatter:()=>t,metadata:()=>c,toc:()=>o});var s=r(62540),i=r(43023);const t={},d="Interface: SecretStorage",c={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"}},a={},o=[{value:"Properties",id:"properties",level:2},{value:"onDidChange",id:"ondidchange",level:3},{value:"Defined in",id:"defined-in",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:"Defined in",id:"defined-in-1",level:4},{value:"get()",id:"get",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"store()",id:"store",level:3},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-2",level:4},{value:"Defined in",id:"defined-in-3",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",p:"p",strong:"strong",...(0,i.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.header,{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:"defined-in",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L4588",children:"packages/extension-api/src/extension-api.d.ts:4588"})}),"\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:"defined-in-1",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L4583",children:"packages/extension-api/src/extension-api.d.ts:4583"})}),"\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:"defined-in-2",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L4570",children:"packages/extension-api/src/extension-api.d.ts:4570"})}),"\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:"defined-in-3",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L4577",children:"packages/extension-api/src/extension-api.d.ts:4577"})})]})}function h(e={}){const{wrapper:n}={...(0,i.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},43023:(e,n,r)=>{r.d(n,{R:()=>d,x:()=>c});var s=r(63696);const i={},t=s.createContext(i);function d(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:d(e.components),s.createElement(t.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[2571],{78632:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>a,contentTitle:()=>d,default:()=>h,frontMatter:()=>t,metadata:()=>c,toc:()=>o});var s=r(62540),i=r(43023);const t={},d="Interface: SecretStorage",c={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"}},a={},o=[{value:"Properties",id:"properties",level:2},{value:"onDidChange",id:"ondidchange",level:3},{value:"Defined in",id:"defined-in",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:"Defined in",id:"defined-in-1",level:4},{value:"get()",id:"get",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"store()",id:"store",level:3},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-2",level:4},{value:"Defined in",id:"defined-in-3",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",p:"p",strong:"strong",...(0,i.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.header,{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:"defined-in",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L4588",children:"packages/extension-api/src/extension-api.d.ts:4588"})}),"\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:"defined-in-1",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L4583",children:"packages/extension-api/src/extension-api.d.ts:4583"})}),"\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:"defined-in-2",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L4570",children:"packages/extension-api/src/extension-api.d.ts:4570"})}),"\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:"defined-in-3",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L4577",children:"packages/extension-api/src/extension-api.d.ts:4577"})})]})}function h(e={}){const{wrapper:n}={...(0,i.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},43023:(e,n,r)=>{r.d(n,{R:()=>d,x:()=>c});var s=r(63696);const i={},t=s.createContext(i);function d(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:d(e.components),s.createElement(t.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/16914cba.be0d01e2.js b/assets/js/16914cba.6fded6fc.js similarity index 98% rename from assets/js/16914cba.be0d01e2.js rename to assets/js/16914cba.6fded6fc.js index 1d71ead943f..f2b50a182fb 100644 --- a/assets/js/16914cba.be0d01e2.js +++ b/assets/js/16914cba.6fded6fc.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[40296],{82527:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>c,contentTitle:()=>o,default:()=>h,frontMatter:()=>r,metadata:()=>a,toc:()=>d});var i=t(62540),s=t(43023);const r={},o="Function: deleteContainer()",a={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"}},c={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Defined in",id:"defined-in",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",strong:"strong",...(0,s.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.header,{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:"defined-in",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L3548",children:"packages/extension-api/src/extension-api.d.ts:3548"})})]})}function h(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},43023:(e,n,t)=>{t.d(n,{R:()=>o,x:()=>a});var i=t(63696);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([[40296],{82527:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>c,contentTitle:()=>o,default:()=>h,frontMatter:()=>r,metadata:()=>a,toc:()=>d});var i=t(62540),s=t(43023);const r={},o="Function: deleteContainer()",a={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"}},c={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Defined in",id:"defined-in",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",strong:"strong",...(0,s.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.header,{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:"defined-in",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L3548",children:"packages/extension-api/src/extension-api.d.ts:3548"})})]})}function h(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},43023:(e,n,t)=>{t.d(n,{R:()=>o,x:()=>a});var i=t(63696);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/17612ae7.c5143c47.js b/assets/js/17612ae7.9b161957.js similarity index 98% rename from assets/js/17612ae7.c5143c47.js rename to assets/js/17612ae7.9b161957.js index d943b2de5af..b2213cd67d3 100644 --- a/assets/js/17612ae7.c5143c47.js +++ b/assets/js/17612ae7.9b161957.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[53203],{49717:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>o,contentTitle:()=>a,default:()=>h,frontMatter:()=>r,metadata:()=>c,toc:()=>d});var t=i(62540),s=i(43023);const r={},a="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"}},o={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Defined in",id:"defined-in",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",strong:"strong",...(0,s.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.header,{children:(0,t.jsx)(n.h1,{id:"function-deleteimage",children:"Function: deleteImage()"})}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"deleteImage"}),"(",(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.code,{children:"void"}),">"]}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"Delete a container image from a local engine"}),"\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:"id"}),": ",(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.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:"defined-in",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L3637",children:"packages/extension-api/src/extension-api.d.ts:3637"})})]})}function h(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},43023:(e,n,i)=>{i.d(n,{R:()=>a,x:()=>c});var t=i(63696);const s={},r=t.createContext(s);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(s):e.components||s:a(e.components),t.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[53203],{49717:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>o,contentTitle:()=>a,default:()=>h,frontMatter:()=>r,metadata:()=>c,toc:()=>d});var t=i(62540),s=i(43023);const r={},a="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"}},o={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Defined in",id:"defined-in",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",strong:"strong",...(0,s.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.header,{children:(0,t.jsx)(n.h1,{id:"function-deleteimage",children:"Function: deleteImage()"})}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"deleteImage"}),"(",(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.code,{children:"void"}),">"]}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"Delete a container image from a local engine"}),"\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:"id"}),": ",(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.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:"defined-in",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L3637",children:"packages/extension-api/src/extension-api.d.ts:3637"})})]})}function h(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},43023:(e,n,i)=>{i.d(n,{R:()=>a,x:()=>c});var t=i(63696);const s={},r=t.createContext(s);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(s):e.components||s:a(e.components),t.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/17c68348.5936e890.js b/assets/js/17c68348.75fd8c6b.js similarity index 92% rename from assets/js/17c68348.5936e890.js rename to assets/js/17c68348.75fd8c6b.js index 03e6158a24c..dfefce3ca7d 100644 --- a/assets/js/17c68348.5936e890.js +++ b/assets/js/17c68348.75fd8c6b.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[18687],{74784:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>d,contentTitle:()=>r,default:()=>p,frontMatter:()=>a,metadata:()=>o,toc:()=>c});var s=i(62540),t=i(43023);const a={},r="Interface: ManifestPushOptions",o={id:"interfaces/ManifestPushOptions",title:"Interface: ManifestPushOptions",description:"Properties",source:"@site/api/interfaces/ManifestPushOptions.md",sourceDirName:"interfaces",slug:"/interfaces/ManifestPushOptions",permalink:"/api/interfaces/ManifestPushOptions",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"ManifestInspectInfo",permalink:"/api/interfaces/ManifestInspectInfo"},next:{title:"MemoryStats",permalink:"/api/interfaces/MemoryStats"}},d={},c=[{value:"Properties",id:"properties",level:2},{value:"destination",id:"destination",level:3},{value:"Example",id:"example",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"name",id:"name",level:3},{value:"Example",id:"example-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"provider?",id:"provider",level:3},{value:"Defined in",id:"defined-in-2",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",p:"p",pre:"pre",strong:"strong",...(0,t.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.header,{children:(0,s.jsx)(n.h1,{id:"interface-manifestpushoptions",children:"Interface: ManifestPushOptions"})}),"\n",(0,s.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,s.jsx)(n.h3,{id:"destination",children:"destination"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"destination"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The destination of the manifest list to push.\nthis can be the same as 'name' or a different one."}),"\n",(0,s.jsx)(n.h4,{id:"example",children:"Example"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:'"quay.io/myrepo/myotherdestination"\n'})}),"\n",(0,s.jsx)(n.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L450",children:"packages/extension-api/src/extension-api.d.ts:450"})}),"\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:"The name of the manifest list to push"}),"\n",(0,s.jsx)(n.h4,{id:"example-1",children:"Example"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:'"quay.io/myrepo/mymanifest"\n'})}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L456",children:"packages/extension-api/src/extension-api.d.ts:456"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"provider",children:"provider?"}),"\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:"provider"}),": ",(0,s.jsx)(n.a,{href:"/api/interfaces/ContainerProviderConnection",children:(0,s.jsx)(n.code,{children:"ContainerProviderConnection"})})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-2",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L458",children:"packages/extension-api/src/extension-api.d.ts:458"})})]})}function p(e={}){const{wrapper:n}={...(0,t.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},43023:(e,n,i)=>{i.d(n,{R:()=>r,x:()=>o});var s=i(63696);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 o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:r(e.components),s.createElement(a.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[18687],{74784:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>d,contentTitle:()=>r,default:()=>p,frontMatter:()=>a,metadata:()=>o,toc:()=>c});var s=i(62540),t=i(43023);const a={},r="Interface: ManifestPushOptions",o={id:"interfaces/ManifestPushOptions",title:"Interface: ManifestPushOptions",description:"Properties",source:"@site/api/interfaces/ManifestPushOptions.md",sourceDirName:"interfaces",slug:"/interfaces/ManifestPushOptions",permalink:"/api/interfaces/ManifestPushOptions",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"ManifestInspectInfo",permalink:"/api/interfaces/ManifestInspectInfo"},next:{title:"MemoryStats",permalink:"/api/interfaces/MemoryStats"}},d={},c=[{value:"Properties",id:"properties",level:2},{value:"destination",id:"destination",level:3},{value:"Example",id:"example",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"name",id:"name",level:3},{value:"Example",id:"example-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"provider?",id:"provider",level:3},{value:"Defined in",id:"defined-in-2",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",p:"p",pre:"pre",strong:"strong",...(0,t.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.header,{children:(0,s.jsx)(n.h1,{id:"interface-manifestpushoptions",children:"Interface: ManifestPushOptions"})}),"\n",(0,s.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,s.jsx)(n.h3,{id:"destination",children:"destination"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"destination"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The destination of the manifest list to push.\nthis can be the same as 'name' or a different one."}),"\n",(0,s.jsx)(n.h4,{id:"example",children:"Example"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:'"quay.io/myrepo/myotherdestination"\n'})}),"\n",(0,s.jsx)(n.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L450",children:"packages/extension-api/src/extension-api.d.ts:450"})}),"\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:"The name of the manifest list to push"}),"\n",(0,s.jsx)(n.h4,{id:"example-1",children:"Example"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:'"quay.io/myrepo/mymanifest"\n'})}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L456",children:"packages/extension-api/src/extension-api.d.ts:456"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"provider",children:"provider?"}),"\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:"provider"}),": ",(0,s.jsx)(n.a,{href:"/api/interfaces/ContainerProviderConnection",children:(0,s.jsx)(n.code,{children:"ContainerProviderConnection"})})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-2",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L458",children:"packages/extension-api/src/extension-api.d.ts:458"})})]})}function p(e={}){const{wrapper:n}={...(0,t.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},43023:(e,n,i)=>{i.d(n,{R:()=>r,x:()=>o});var s=i(63696);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 o(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/17d2ebc8.b1416d2b.js b/assets/js/17d2ebc8.4e26a60c.js similarity index 85% rename from assets/js/17d2ebc8.b1416d2b.js rename to assets/js/17d2ebc8.4e26a60c.js index 7c03c5de7d8..4f85d1e5b6b 100644 --- a/assets/js/17d2ebc8.b1416d2b.js +++ b/assets/js/17d2ebc8.4e26a60c.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[63805],{45721:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>o,contentTitle:()=>d,default:()=>p,frontMatter:()=>r,metadata:()=>a,toc:()=>c});var t=i(62540),s=i(43023);const r={},d="Interface: ContainerJSONEvent",a={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"}},o={},c=[{value:"Properties",id:"properties",level:2},{value:"Type?",id:"type",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"id",id:"id",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"status",id:"status",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"type",id:"type-1",level:3},{value:"Defined in",id:"defined-in-3",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",p:"p",strong:"strong",...(0,s.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.header,{children:(0,t.jsx)(n.h1,{id:"interface-containerjsonevent",children:"Interface: ContainerJSONEvent"})}),"\n",(0,t.jsx)(n.h2,{id:"properties",children:"Properties"}),"\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.code,{children:"string"})]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2668",children:"packages/extension-api/src/extension-api.d.ts:2668"})}),"\n",(0,t.jsx)(n.hr,{}),"\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:"defined-in-1",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2667",children:"packages/extension-api/src/extension-api.d.ts:2667"})}),"\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:"defined-in-2",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2666",children:"packages/extension-api/src/extension-api.d.ts:2666"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"type-1",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:"defined-in-3",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2665",children:"packages/extension-api/src/extension-api.d.ts:2665"})})]})}function p(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},43023:(e,n,i)=>{i.d(n,{R:()=>d,x:()=>a});var t=i(63696);const s={},r=t.createContext(s);function d(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(s):e.components||s:d(e.components),t.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[63805],{45721:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>c,contentTitle:()=>d,default:()=>p,frontMatter:()=>r,metadata:()=>a,toc:()=>o});var t=i(62540),s=i(43023);const r={},d="Interface: ContainerJSONEvent",a={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"}},c={},o=[{value:"Properties",id:"properties",level:2},{value:"Type?",id:"type",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"id",id:"id",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"status",id:"status",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"type",id:"type-1",level:3},{value:"Defined in",id:"defined-in-3",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",p:"p",strong:"strong",...(0,s.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.header,{children:(0,t.jsx)(n.h1,{id:"interface-containerjsonevent",children:"Interface: ContainerJSONEvent"})}),"\n",(0,t.jsx)(n.h2,{id:"properties",children:"Properties"}),"\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.code,{children:"string"})]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2668",children:"packages/extension-api/src/extension-api.d.ts:2668"})}),"\n",(0,t.jsx)(n.hr,{}),"\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:"defined-in-1",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2667",children:"packages/extension-api/src/extension-api.d.ts:2667"})}),"\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:"defined-in-2",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2666",children:"packages/extension-api/src/extension-api.d.ts:2666"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"type-1",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:"defined-in-3",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2665",children:"packages/extension-api/src/extension-api.d.ts:2665"})})]})}function p(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},43023:(e,n,i)=>{i.d(n,{R:()=>d,x:()=>a});var t=i(63696);const s={},r=t.createContext(s);function d(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(s):e.components||s:d(e.components),t.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/180d0c5f.731ec28d.js b/assets/js/180d0c5f.17181c3f.js similarity index 85% rename from assets/js/180d0c5f.731ec28d.js rename to assets/js/180d0c5f.17181c3f.js index dbdad701b11..329e3c93af3 100644 --- a/assets/js/180d0c5f.731ec28d.js +++ b/assets/js/180d0c5f.17181c3f.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[89634],{63890:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>c,contentTitle:()=>r,default:()=>l,frontMatter:()=>o,metadata:()=>a,toc:()=>d});var i=t(62540),s=t(43023);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={},d=[{value:"Properties",id:"properties",level:2},{value:"provider",id:"provider",level:3},{value:"Defined in",id:"defined-in",level:4}];function h(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",p:"p",strong:"strong",...(0,s.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.header,{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:"defined-in",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L3816",children:"packages/extension-api/src/extension-api.d.ts:3816"})})]})}function l(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(h,{...e})}):h(e)}},43023:(e,n,t)=>{t.d(n,{R:()=>r,x:()=>a});var i=t(63696);const s={},o=i.createContext(s);function r(e){const n=i.useContext(o);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function a(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:r(e.components),i.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[89634],{63890:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>c,contentTitle:()=>r,default:()=>l,frontMatter:()=>o,metadata:()=>a,toc:()=>h});var i=t(62540),s=t(43023);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:"Defined in",id:"defined-in",level:4}];function d(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",p:"p",strong:"strong",...(0,s.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.header,{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:"defined-in",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L3816",children:"packages/extension-api/src/extension-api.d.ts:3816"})})]})}function l(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(d,{...e})}):d(e)}},43023:(e,n,t)=>{t.d(n,{R:()=>r,x:()=>a});var i=t(63696);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.42df6b29.js b/assets/js/185c52e7.63c685d2.js similarity index 88% rename from assets/js/185c52e7.42df6b29.js rename to assets/js/185c52e7.63c685d2.js index a110442fa41..535c72a24b7 100644 --- a/assets/js/185c52e7.42df6b29.js +++ b/assets/js/185c52e7.63c685d2.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[32993],{67804:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>o,contentTitle:()=>r,default:()=>h,frontMatter:()=>d,metadata:()=>a,toc:()=>c});var s=i(62540),t=i(43023);const d={},r="Interface: VolumeCreateResponseInfo",a={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"}},o={},c=[{value:"Properties",id:"properties",level:2},{value:"CreatedAt?",id:"createdat",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"Driver",id:"driver",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"Labels",id:"labels",level:3},{value:"Index Signature",id:"index-signature",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"Mountpoint",id:"mountpoint",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"Name",id:"name",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"Scope",id:"scope",level:3},{value:"Defined in",id:"defined-in-5",level:4},{value:"Status?",id:"status",level:3},{value:"Index Signature",id:"index-signature-1",level:4},{value:"Defined in",id:"defined-in-6",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",p:"p",strong:"strong",...(0,t.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.header,{children:(0,s.jsx)(n.h1,{id:"interface-volumecreateresponseinfo",children:"Interface: VolumeCreateResponseInfo"})}),"\n",(0,s.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,s.jsx)(n.h3,{id:"createdat",children:"CreatedAt?"}),"\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:"CreatedAt"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L3439",children:"packages/extension-api/src/extension-api.d.ts:3439"})}),"\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.strong,{children:"Driver"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L3437",children:"packages/extension-api/src/extension-api.d.ts:3437"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"labels",children:"Labels"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Labels"}),": ",(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:"label"}),": ",(0,s.jsx)(n.code,{children:"string"}),"]: ",(0,s.jsx)(n.code,{children:"string"})]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-2",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L3441",children:"packages/extension-api/src/extension-api.d.ts:3441"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"mountpoint",children:"Mountpoint"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Mountpoint"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-3",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L3438",children:"packages/extension-api/src/extension-api.d.ts:3438"})}),"\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:"defined-in-4",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L3436",children:"packages/extension-api/src/extension-api.d.ts:3436"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"scope",children:"Scope"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Scope"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-5",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L3442",children:"packages/extension-api/src/extension-api.d.ts:3442"})}),"\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.code,{children:"optional"})," ",(0,s.jsx)(n.strong,{children:"Status"}),": ",(0,s.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"index-signature-1",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:"defined-in-6",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L3440",children:"packages/extension-api/src/extension-api.d.ts:3440"})})]})}function h(e={}){const{wrapper:n}={...(0,t.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},43023:(e,n,i)=>{i.d(n,{R:()=>r,x:()=>a});var s=i(63696);const t={},d=s.createContext(t);function r(e){const n=s.useContext(d);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:r(e.components),s.createElement(d.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[32993],{67804:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>c,contentTitle:()=>r,default:()=>h,frontMatter:()=>d,metadata:()=>a,toc:()=>o});var s=i(62540),t=i(43023);const d={},r="Interface: VolumeCreateResponseInfo",a={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"}},c={},o=[{value:"Properties",id:"properties",level:2},{value:"CreatedAt?",id:"createdat",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"Driver",id:"driver",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"Labels",id:"labels",level:3},{value:"Index Signature",id:"index-signature",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"Mountpoint",id:"mountpoint",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"Name",id:"name",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"Scope",id:"scope",level:3},{value:"Defined in",id:"defined-in-5",level:4},{value:"Status?",id:"status",level:3},{value:"Index Signature",id:"index-signature-1",level:4},{value:"Defined in",id:"defined-in-6",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",p:"p",strong:"strong",...(0,t.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.header,{children:(0,s.jsx)(n.h1,{id:"interface-volumecreateresponseinfo",children:"Interface: VolumeCreateResponseInfo"})}),"\n",(0,s.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,s.jsx)(n.h3,{id:"createdat",children:"CreatedAt?"}),"\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:"CreatedAt"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L3439",children:"packages/extension-api/src/extension-api.d.ts:3439"})}),"\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.strong,{children:"Driver"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L3437",children:"packages/extension-api/src/extension-api.d.ts:3437"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"labels",children:"Labels"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Labels"}),": ",(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:"label"}),": ",(0,s.jsx)(n.code,{children:"string"}),"]: ",(0,s.jsx)(n.code,{children:"string"})]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-2",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L3441",children:"packages/extension-api/src/extension-api.d.ts:3441"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"mountpoint",children:"Mountpoint"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Mountpoint"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-3",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L3438",children:"packages/extension-api/src/extension-api.d.ts:3438"})}),"\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:"defined-in-4",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L3436",children:"packages/extension-api/src/extension-api.d.ts:3436"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"scope",children:"Scope"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Scope"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-5",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L3442",children:"packages/extension-api/src/extension-api.d.ts:3442"})}),"\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.code,{children:"optional"})," ",(0,s.jsx)(n.strong,{children:"Status"}),": ",(0,s.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"index-signature-1",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:"defined-in-6",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L3440",children:"packages/extension-api/src/extension-api.d.ts:3440"})})]})}function h(e={}){const{wrapper:n}={...(0,t.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},43023:(e,n,i)=>{i.d(n,{R:()=>r,x:()=>a});var s=i(63696);const t={},d=s.createContext(t);function r(e){const n=s.useContext(d);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:r(e.components),s.createElement(d.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/19e69ccd.44b229e2.js b/assets/js/19e69ccd.9b091196.js similarity index 80% rename from assets/js/19e69ccd.44b229e2.js rename to assets/js/19e69ccd.9b091196.js index c30114e45ed..d684636f3a5 100644 --- a/assets/js/19e69ccd.44b229e2.js +++ b/assets/js/19e69ccd.9b091196.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[83509],{82948:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>d,contentTitle:()=>r,default:()=>p,frontMatter:()=>a,metadata:()=>c,toc:()=>o});var i=s(62540),t=s(43023);const a={},r="Interface: CPUStats",c={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"}},d={},o=[{value:"Properties",id:"properties",level:2},{value:"cpu_usage",id:"cpu_usage",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"online_cpus",id:"online_cpus",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"system_cpu_usage",id:"system_cpu_usage",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"throttling_data",id:"throttling_data",level:3},{value:"Defined in",id:"defined-in-3",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",p:"p",strong:"strong",...(0,t.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.header,{children:(0,i.jsx)(n.h1,{id:"interface-cpustats",children:"Interface: CPUStats"})}),"\n",(0,i.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(n.h3,{id:"cpu_usage",children:"cpu_usage"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"cpu_usage"}),": ",(0,i.jsx)(n.a,{href:"/api/interfaces/CPUUsage",children:(0,i.jsx)(n.code,{children:"CPUUsage"})})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L3166",children:"packages/extension-api/src/extension-api.d.ts:3166"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"online_cpus",children:"online_cpus"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"online_cpus"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L3168",children:"packages/extension-api/src/extension-api.d.ts:3168"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"system_cpu_usage",children:"system_cpu_usage"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"system_cpu_usage"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"defined-in-2",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L3167",children:"packages/extension-api/src/extension-api.d.ts:3167"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"throttling_data",children:"throttling_data"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"throttling_data"}),": ",(0,i.jsx)(n.a,{href:"/api/interfaces/ThrottlingData",children:(0,i.jsx)(n.code,{children:"ThrottlingData"})})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"defined-in-3",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L3169",children:"packages/extension-api/src/extension-api.d.ts:3169"})})]})}function p(e={}){const{wrapper:n}={...(0,t.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},43023:(e,n,s)=>{s.d(n,{R:()=>r,x:()=>c});var i=s(63696);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([[83509],{82948:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>d,contentTitle:()=>c,default:()=>p,frontMatter:()=>a,metadata:()=>r,toc:()=>o});var i=s(62540),t=s(43023);const a={},c="Interface: CPUStats",r={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"}},d={},o=[{value:"Properties",id:"properties",level:2},{value:"cpu_usage",id:"cpu_usage",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"online_cpus",id:"online_cpus",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"system_cpu_usage",id:"system_cpu_usage",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"throttling_data",id:"throttling_data",level:3},{value:"Defined in",id:"defined-in-3",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",p:"p",strong:"strong",...(0,t.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.header,{children:(0,i.jsx)(n.h1,{id:"interface-cpustats",children:"Interface: CPUStats"})}),"\n",(0,i.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(n.h3,{id:"cpu_usage",children:"cpu_usage"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"cpu_usage"}),": ",(0,i.jsx)(n.a,{href:"/api/interfaces/CPUUsage",children:(0,i.jsx)(n.code,{children:"CPUUsage"})})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L3166",children:"packages/extension-api/src/extension-api.d.ts:3166"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"online_cpus",children:"online_cpus"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"online_cpus"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L3168",children:"packages/extension-api/src/extension-api.d.ts:3168"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"system_cpu_usage",children:"system_cpu_usage"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"system_cpu_usage"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"defined-in-2",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L3167",children:"packages/extension-api/src/extension-api.d.ts:3167"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"throttling_data",children:"throttling_data"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"throttling_data"}),": ",(0,i.jsx)(n.a,{href:"/api/interfaces/ThrottlingData",children:(0,i.jsx)(n.code,{children:"ThrottlingData"})})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"defined-in-3",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L3169",children:"packages/extension-api/src/extension-api.d.ts:3169"})})]})}function p(e={}){const{wrapper:n}={...(0,t.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},43023:(e,n,s)=>{s.d(n,{R:()=>c,x:()=>r});var i=s(63696);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 diff --git a/assets/js/1a906644.fff6b18b.js b/assets/js/1a906644.b171c747.js similarity index 96% rename from assets/js/1a906644.fff6b18b.js rename to assets/js/1a906644.b171c747.js index 89cb719efbe..7b79cdc45e2 100644 --- a/assets/js/1a906644.fff6b18b.js +++ b/assets/js/1a906644.b171c747.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[19150],{1168:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>o,contentTitle:()=>c,default:()=>h,frontMatter:()=>r,metadata:()=>a,toc:()=>d});var i=t(62540),s=t(43023);const r={},c="Function: createManifest()",a={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"}},o={},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:"Defined in",id:"defined-in",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",header:"header",p:"p",strong:"strong",...(0,s.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.header,{children:(0,i.jsx)(n.h1,{id:"function-createmanifest",children:"Function: createManifest()"})}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"createManifest"}),"(",(0,i.jsx)(n.code,{children:"options"}),"): ",(0,i.jsx)(n.code,{children:"Promise"}),"<",(0,i.jsx)(n.code,{children:"object"}),">"]}),"\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:"options"}),": ",(0,i.jsx)(n.a,{href:"/api/interfaces/ManifestCreateOptions",children:(0,i.jsx)(n.code,{children:"ManifestCreateOptions"})})]}),"\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:"object"}),">"]}),"\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.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.h2,{id:"defined-in",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L3692",children:"packages/extension-api/src/extension-api.d.ts:3692"})})]})}function h(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},43023:(e,n,t)=>{t.d(n,{R:()=>c,x:()=>a});var i=t(63696);const s={},r=i.createContext(s);function c(e){const n=i.useContext(r);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function a(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:c(e.components),i.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[19150],{1168:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>o,contentTitle:()=>c,default:()=>h,frontMatter:()=>r,metadata:()=>a,toc:()=>d});var i=t(62540),s=t(43023);const r={},c="Function: createManifest()",a={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"}},o={},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:"Defined in",id:"defined-in",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",header:"header",p:"p",strong:"strong",...(0,s.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.header,{children:(0,i.jsx)(n.h1,{id:"function-createmanifest",children:"Function: createManifest()"})}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"createManifest"}),"(",(0,i.jsx)(n.code,{children:"options"}),"): ",(0,i.jsx)(n.code,{children:"Promise"}),"<",(0,i.jsx)(n.code,{children:"object"}),">"]}),"\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:"options"}),": ",(0,i.jsx)(n.a,{href:"/api/interfaces/ManifestCreateOptions",children:(0,i.jsx)(n.code,{children:"ManifestCreateOptions"})})]}),"\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:"object"}),">"]}),"\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.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.h2,{id:"defined-in",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L3692",children:"packages/extension-api/src/extension-api.d.ts:3692"})})]})}function h(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},43023:(e,n,t)=>{t.d(n,{R:()=>c,x:()=>a});var i=t(63696);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/1dfee34e.a26a51b0.js b/assets/js/1dfee34e.23dcc2ee.js similarity index 95% rename from assets/js/1dfee34e.a26a51b0.js rename to assets/js/1dfee34e.23dcc2ee.js index 50c593d2654..75bf6e8bdb9 100644 --- a/assets/js/1dfee34e.a26a51b0.js +++ b/assets/js/1dfee34e.23dcc2ee.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[77546],{3302:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>r,contentTitle:()=>t,default:()=>h,frontMatter:()=>o,metadata:()=>l,toc:()=>a});var i=s(62540),c=s(43023);const o={},t="Class: CancellationTokenSource",l={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"}},r={},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:"Defined in",id:"defined-in",level:4},{value:"Methods",id:"methods",level:2},{value:"cancel()",id:"cancel",level:3},{value:"Returns",id:"returns-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"dispose()",id:"dispose",level:3},{value:"Returns",id:"returns-2",level:4},{value:"Defined in",id:"defined-in-2",level:4}];function d(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",p:"p",strong:"strong",...(0,c.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.header,{children:(0,i.jsx)(n.h1,{id:"class-cancellationtokensource",children:"Class: CancellationTokenSource"})}),"\n",(0,i.jsx)(n.h2,{id:"constructors",children:"Constructors"}),"\n",(0,i.jsx)(n.h3,{id:"new-cancellationtokensource",children:"new CancellationTokenSource()"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"new CancellationTokenSource"}),"(): ",(0,i.jsx)(n.a,{href:"/api/classes/CancellationTokenSource",children:(0,i.jsx)(n.code,{children:"CancellationTokenSource"})})]}),"\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/classes/CancellationTokenSource",children:(0,i.jsx)(n.code,{children:"CancellationTokenSource"})})}),"\n",(0,i.jsx)(n.h2,{id:"properties",children:"Properties"}),"\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.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:"The cancellation token of this source."}),"\n",(0,i.jsx)(n.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L1096",children:"packages/extension-api/src/extension-api.d.ts:1096"})}),"\n",(0,i.jsx)(n.h2,{id:"methods",children:"Methods"}),"\n",(0,i.jsx)(n.h3,{id:"cancel",children:"cancel()"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"cancel"}),"(): ",(0,i.jsx)(n.code,{children:"void"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Signal cancellation on the token."}),"\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:"defined-in-1",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L1101",children:"packages/extension-api/src/extension-api.d.ts:1101"})}),"\n",(0,i.jsx)(n.hr,{}),"\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 object and free resources."}),"\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:"defined-in-2",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L1106",children:"packages/extension-api/src/extension-api.d.ts:1106"})})]})}function h(e={}){const{wrapper:n}={...(0,c.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(d,{...e})}):d(e)}},43023:(e,n,s)=>{s.d(n,{R:()=>t,x:()=>l});var i=s(63696);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 l(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 +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[77546],{3302:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>r,contentTitle:()=>t,default:()=>h,frontMatter:()=>o,metadata:()=>l,toc:()=>a});var i=s(62540),c=s(43023);const o={},t="Class: CancellationTokenSource",l={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"}},r={},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:"Defined in",id:"defined-in",level:4},{value:"Methods",id:"methods",level:2},{value:"cancel()",id:"cancel",level:3},{value:"Returns",id:"returns-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"dispose()",id:"dispose",level:3},{value:"Returns",id:"returns-2",level:4},{value:"Defined in",id:"defined-in-2",level:4}];function d(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",p:"p",strong:"strong",...(0,c.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.header,{children:(0,i.jsx)(n.h1,{id:"class-cancellationtokensource",children:"Class: CancellationTokenSource"})}),"\n",(0,i.jsx)(n.h2,{id:"constructors",children:"Constructors"}),"\n",(0,i.jsx)(n.h3,{id:"new-cancellationtokensource",children:"new CancellationTokenSource()"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"new CancellationTokenSource"}),"(): ",(0,i.jsx)(n.a,{href:"/api/classes/CancellationTokenSource",children:(0,i.jsx)(n.code,{children:"CancellationTokenSource"})})]}),"\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/classes/CancellationTokenSource",children:(0,i.jsx)(n.code,{children:"CancellationTokenSource"})})}),"\n",(0,i.jsx)(n.h2,{id:"properties",children:"Properties"}),"\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.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:"The cancellation token of this source."}),"\n",(0,i.jsx)(n.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L1096",children:"packages/extension-api/src/extension-api.d.ts:1096"})}),"\n",(0,i.jsx)(n.h2,{id:"methods",children:"Methods"}),"\n",(0,i.jsx)(n.h3,{id:"cancel",children:"cancel()"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"cancel"}),"(): ",(0,i.jsx)(n.code,{children:"void"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Signal cancellation on the token."}),"\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:"defined-in-1",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L1101",children:"packages/extension-api/src/extension-api.d.ts:1101"})}),"\n",(0,i.jsx)(n.hr,{}),"\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 object and free resources."}),"\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:"defined-in-2",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L1106",children:"packages/extension-api/src/extension-api.d.ts:1106"})})]})}function h(e={}){const{wrapper:n}={...(0,c.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(d,{...e})}):d(e)}},43023:(e,n,s)=>{s.d(n,{R:()=>t,x:()=>l});var i=s(63696);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 l(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/1ee92283.d90fc574.js b/assets/js/1ee92283.26bd4b22.js similarity index 89% rename from assets/js/1ee92283.d90fc574.js rename to assets/js/1ee92283.26bd4b22.js index f10b827b3d6..eea3f91e6c7 100644 --- a/assets/js/1ee92283.d90fc574.js +++ b/assets/js/1ee92283.26bd4b22.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[6704],{19168:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>c,contentTitle:()=>a,default:()=>h,frontMatter:()=>d,metadata:()=>t,toc:()=>o});var s=i(62540),r=i(43023);const d={},a="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"}},c={},o=[{value:"Properties",id:"properties",level:2},{value:"detectionChecks",id:"detectionchecks",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"id",id:"id",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"images",id:"images",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"links",id:"links",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"name",id:"name",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"onDidUpdateDetectionChecks",id:"ondidupdatedetectionchecks",level:3},{value:"Defined in",id:"defined-in-5",level:4},{value:"onDidUpdateStatus",id:"ondidupdatestatus",level:3},{value:"Defined in",id:"defined-in-6",level:4},{value:"onDidUpdateVersion",id:"ondidupdateversion",level:3},{value:"Defined in",id:"defined-in-7",level:4},{value:"status",id:"status",level:3},{value:"Defined in",id:"defined-in-8",level:4},{value:"version",id:"version",level:3},{value:"Defined in",id:"defined-in-9",level:4},{value:"warnings",id:"warnings",level:3},{value:"Defined in",id:"defined-in-10",level:4},{value:"Methods",id:"methods",level:2},{value:"dispose()",id:"dispose",level:3},{value:"Returns",id:"returns",level:4},{value:"Defined in",id:"defined-in-11",level:4},{value:"registerAutostart()",id:"registerautostart",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Defined in",id:"defined-in-12",level:4},{value:"registerCleanup()",id:"registercleanup",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-2",level:4},{value:"Defined in",id:"defined-in-13",level:4},{value:"registerContainerProviderConnection()",id:"registercontainerproviderconnection",level:3},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-3",level:4},{value:"Defined in",id:"defined-in-14",level:4},{value:"registerInstallation()",id:"registerinstallation",level:3},{value:"Parameters",id:"parameters-3",level:4},{value:"Returns",id:"returns-4",level:4},{value:"Defined in",id:"defined-in-15",level:4},{value:"registerKubernetesProviderConnection()",id:"registerkubernetesproviderconnection",level:3},{value:"Parameters",id:"parameters-4",level:4},{value:"Returns",id:"returns-5",level:4},{value:"Defined in",id:"defined-in-16",level:4},{value:"registerLifecycle()",id:"registerlifecycle",level:3},{value:"Parameters",id:"parameters-5",level:4},{value:"Returns",id:"returns-6",level:4},{value:"Defined in",id:"defined-in-17",level:4},{value:"registerUpdate()",id:"registerupdate",level:3},{value:"Parameters",id:"parameters-6",level:4},{value:"Returns",id:"returns-7",level:4},{value:"Defined in",id:"defined-in-18",level:4},{value:"setContainerProviderConnectionFactory()",id:"setcontainerproviderconnectionfactory",level:3},{value:"Parameters",id:"parameters-7",level:4},{value:"Returns",id:"returns-8",level:4},{value:"Defined in",id:"defined-in-19",level:4},{value:"setKubernetesProviderConnectionFactory()",id:"setkubernetesproviderconnectionfactory",level:3},{value:"Parameters",id:"parameters-8",level:4},{value:"Returns",id:"returns-9",level:4},{value:"Defined in",id:"defined-in-20",level:4},{value:"updateDetectionChecks()",id:"updatedetectionchecks",level:3},{value:"Parameters",id:"parameters-9",level:4},{value:"Returns",id:"returns-10",level:4},{value:"Defined in",id:"defined-in-21",level:4},{value:"updateStatus()",id:"updatestatus",level:3},{value:"Parameters",id:"parameters-10",level:4},{value:"Returns",id:"returns-11",level:4},{value:"Defined in",id:"defined-in-22",level:4},{value:"updateVersion()",id:"updateversion",level:3},{value:"Parameters",id:"parameters-11",level:4},{value:"Returns",id:"returns-12",level:4},{value:"Defined in",id:"defined-in-23",level:4},{value:"updateWarnings()",id:"updatewarnings",level:3},{value:"Parameters",id:"parameters-12",level:4},{value:"Returns",id:"returns-13",level:4},{value:"Defined in",id:"defined-in-24",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",p:"p",strong:"strong",...(0,r.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.header,{children:(0,s.jsx)(n.h1,{id:"interface-provider",children:"Interface: Provider"})}),"\n",(0,s.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,s.jsx)(n.h3,{id:"detectionchecks",children:"detectionChecks"}),"\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:"detectionChecks"}),": ",(0,s.jsx)(n.a,{href:"/api/interfaces/ProviderDetectionCheck",children:(0,s.jsx)(n.code,{children:"ProviderDetectionCheck"})}),"[]"]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L650",children:"packages/extension-api/src/extension-api.d.ts:650"})}),"\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.code,{children:"readonly"})," ",(0,s.jsx)(n.strong,{children:"id"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/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:"images",children:"images"}),"\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:"images"}),": ",(0,s.jsx)(n.a,{href:"/api/interfaces/ProviderImages",children:(0,s.jsx)(n.code,{children:"ProviderImages"})})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-2",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L645",children:"packages/extension-api/src/extension-api.d.ts:645"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"links",children:"links"}),"\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:"links"}),": ",(0,s.jsx)(n.a,{href:"/api/interfaces/Link",children:(0,s.jsx)(n.code,{children:"Link"})}),"[]"]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-3",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L647",children:"packages/extension-api/src/extension-api.d.ts:647"})}),"\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.code,{children:"readonly"})," ",(0,s.jsx)(n.strong,{children:"name"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-4",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/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:"ondidupdatedetectionchecks",children:"onDidUpdateDetectionChecks"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"onDidUpdateDetectionChecks"}),": ",(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/ProviderDetectionCheck",children:(0,s.jsx)(n.code,{children:"ProviderDetectionCheck"})}),"[]>"]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-5",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L661",children:"packages/extension-api/src/extension-api.d.ts:661"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"ondidupdatestatus",children:"onDidUpdateStatus"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"onDidUpdateStatus"}),": ",(0,s.jsx)(n.a,{href:"/api/interfaces/Event",children:(0,s.jsx)(n.code,{children:"Event"})}),"<",(0,s.jsx)(n.a,{href:"/api/type-aliases/ProviderStatus",children:(0,s.jsx)(n.code,{children:"ProviderStatus"})}),">"]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-6",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L638",children:"packages/extension-api/src/extension-api.d.ts:638"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"ondidupdateversion",children:"onDidUpdateVersion"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"onDidUpdateVersion"}),": ",(0,s.jsx)(n.a,{href:"/api/interfaces/Event",children:(0,s.jsx)(n.code,{children:"Event"})}),"<",(0,s.jsx)(n.code,{children:"string"}),">"]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-7",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L643",children:"packages/extension-api/src/extension-api.d.ts:643"})}),"\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.code,{children:"readonly"})," ",(0,s.jsx)(n.strong,{children:"status"}),": ",(0,s.jsx)(n.a,{href:"/api/type-aliases/ProviderStatus",children:(0,s.jsx)(n.code,{children:"ProviderStatus"})})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-8",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L636",children:"packages/extension-api/src/extension-api.d.ts:636"})}),"\n",(0,s.jsx)(n.hr,{}),"\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.code,{children:"readonly"})," ",(0,s.jsx)(n.strong,{children:"version"}),": ",(0,s.jsx)(n.code,{children:"undefined"})," | ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-9",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L641",children:"packages/extension-api/src/extension-api.d.ts:641"})}),"\n",(0,s.jsx)(n.hr,{}),"\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.code,{children:"readonly"})," ",(0,s.jsx)(n.strong,{children:"warnings"}),": ",(0,s.jsx)(n.a,{href:"/api/interfaces/ProviderInformation",children:(0,s.jsx)(n.code,{children:"ProviderInformation"})}),"[]"]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-10",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L657",children:"packages/extension-api/src/extension-api.d.ts:657"})}),"\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.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:"defined-in-11",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L633",children:"packages/extension-api/src/extension-api.d.ts:633"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"registerautostart",children:"registerAutostart()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"registerAutostart"}),"(",(0,s.jsx)(n.code,{children:"autostart"}),"): ",(0,s.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,s.jsx)(n.code,{children:"Disposable"})})]}),"\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:"autostart"}),": ",(0,s.jsx)(n.a,{href:"/api/interfaces/ProviderAutostart",children:(0,s.jsx)(n.code,{children:"ProviderAutostart"})})]}),"\n",(0,s.jsx)(n.h4,{id:"returns-1",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.h4,{id:"defined-in-12",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L629",children:"packages/extension-api/src/extension-api.d.ts:629"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"registercleanup",children:"registerCleanup()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"registerCleanup"}),"(",(0,s.jsx)(n.code,{children:"cleanup"}),"): ",(0,s.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,s.jsx)(n.code,{children:"Disposable"})})]}),"\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:"cleanup"}),": ",(0,s.jsx)(n.a,{href:"/api/interfaces/ProviderCleanup",children:(0,s.jsx)(n.code,{children:"ProviderCleanup"})})]}),"\n",(0,s.jsx)(n.h4,{id:"returns-2",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.h4,{id:"defined-in-13",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L631",children:"packages/extension-api/src/extension-api.d.ts:631"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"registercontainerproviderconnection",children:"registerContainerProviderConnection()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"registerContainerProviderConnection"}),"(",(0,s.jsx)(n.code,{children:"connection"}),"): ",(0,s.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,s.jsx)(n.code,{children:"Disposable"})})]}),"\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:"connection"}),": ",(0,s.jsx)(n.a,{href:"/api/interfaces/ContainerProviderConnection",children:(0,s.jsx)(n.code,{children:"ContainerProviderConnection"})})]}),"\n",(0,s.jsx)(n.h4,{id:"returns-3",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.h4,{id:"defined-in-14",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L618",children:"packages/extension-api/src/extension-api.d.ts:618"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"registerinstallation",children:"registerInstallation()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"registerInstallation"}),"(",(0,s.jsx)(n.code,{children:"installation"}),"): ",(0,s.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,s.jsx)(n.code,{children:"Disposable"})})]}),"\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:"installation"}),": ",(0,s.jsx)(n.a,{href:"/api/interfaces/ProviderInstallation",children:(0,s.jsx)(n.code,{children:"ProviderInstallation"})})]}),"\n",(0,s.jsx)(n.h4,{id:"returns-4",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.h4,{id:"defined-in-15",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L623",children:"packages/extension-api/src/extension-api.d.ts:623"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"registerkubernetesproviderconnection",children:"registerKubernetesProviderConnection()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"registerKubernetesProviderConnection"}),"(",(0,s.jsx)(n.code,{children:"connection"}),"): ",(0,s.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,s.jsx)(n.code,{children:"Disposable"})})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"parameters-4",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(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",(0,s.jsx)(n.h4,{id:"returns-5",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.h4,{id:"defined-in-16",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L619",children:"packages/extension-api/src/extension-api.d.ts:619"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"registerlifecycle",children:"registerLifecycle()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"registerLifecycle"}),"(",(0,s.jsx)(n.code,{children:"lifecycle"}),"): ",(0,s.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,s.jsx)(n.code,{children:"Disposable"})})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"parameters-5",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"lifecycle"}),": ",(0,s.jsx)(n.a,{href:"/api/interfaces/ProviderLifecycle",children:(0,s.jsx)(n.code,{children:"ProviderLifecycle"})})]}),"\n",(0,s.jsx)(n.h4,{id:"returns-6",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.h4,{id:"defined-in-17",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L620",children:"packages/extension-api/src/extension-api.d.ts:620"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"registerupdate",children:"registerUpdate()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"registerUpdate"}),"(",(0,s.jsx)(n.code,{children:"update"}),"): ",(0,s.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,s.jsx)(n.code,{children:"Disposable"})})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"parameters-6",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"update"}),": ",(0,s.jsx)(n.a,{href:"/api/interfaces/ProviderUpdate",children:(0,s.jsx)(n.code,{children:"ProviderUpdate"})})]}),"\n",(0,s.jsx)(n.h4,{id:"returns-7",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.h4,{id:"defined-in-18",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L626",children:"packages/extension-api/src/extension-api.d.ts:626"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"setcontainerproviderconnectionfactory",children:"setContainerProviderConnectionFactory()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"setContainerProviderConnectionFactory"}),"(",(0,s.jsx)(n.code,{children:"containerProviderConnectionFactory"}),", ",(0,s.jsx)(n.code,{children:"connectionAuditor"}),"?): ",(0,s.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,s.jsx)(n.code,{children:"Disposable"})})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"parameters-7",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"containerProviderConnectionFactory"}),": ",(0,s.jsx)(n.a,{href:"/api/interfaces/ContainerProviderConnectionFactory",children:(0,s.jsx)(n.code,{children:"ContainerProviderConnectionFactory"})})]}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"connectionAuditor?"}),": ",(0,s.jsx)(n.a,{href:"/api/interfaces/Auditor",children:(0,s.jsx)(n.code,{children:"Auditor"})})]}),"\n",(0,s.jsx)(n.h4,{id:"returns-8",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.h4,{id:"defined-in-19",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L609",children:"packages/extension-api/src/extension-api.d.ts:609"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"setkubernetesproviderconnectionfactory",children:"setKubernetesProviderConnectionFactory()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"setKubernetesProviderConnectionFactory"}),"(",(0,s.jsx)(n.code,{children:"containerProviderConnectionFactory"}),", ",(0,s.jsx)(n.code,{children:"connectionAuditor"}),"?): ",(0,s.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,s.jsx)(n.code,{children:"Disposable"})})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"parameters-8",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"containerProviderConnectionFactory"}),": ",(0,s.jsx)(n.a,{href:"/api/interfaces/KubernetesProviderConnectionFactory",children:(0,s.jsx)(n.code,{children:"KubernetesProviderConnectionFactory"})})]}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"connectionAuditor?"}),": ",(0,s.jsx)(n.a,{href:"/api/interfaces/Auditor",children:(0,s.jsx)(n.code,{children:"Auditor"})})]}),"\n",(0,s.jsx)(n.h4,{id:"returns-9",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.h4,{id:"defined-in-20",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L613",children:"packages/extension-api/src/extension-api.d.ts:613"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"updatedetectionchecks",children:"updateDetectionChecks()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"updateDetectionChecks"}),"(",(0,s.jsx)(n.code,{children:"detectionChecks"}),"): ",(0,s.jsx)(n.code,{children:"void"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"parameters-9",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"detectionChecks"}),": ",(0,s.jsx)(n.a,{href:"/api/interfaces/ProviderDetectionCheck",children:(0,s.jsx)(n.code,{children:"ProviderDetectionCheck"})}),"[]"]}),"\n",(0,s.jsx)(n.h4,{id:"returns-10",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"void"})}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-21",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L654",children:"packages/extension-api/src/extension-api.d.ts:654"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"updatestatus",children:"updateStatus()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"updateStatus"}),"(",(0,s.jsx)(n.code,{children:"status"}),"): ",(0,s.jsx)(n.code,{children:"void"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"parameters-10",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"status"}),": ",(0,s.jsx)(n.a,{href:"/api/type-aliases/ProviderStatus",children:(0,s.jsx)(n.code,{children:"ProviderStatus"})})]}),"\n",(0,s.jsx)(n.h4,{id:"returns-11",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"void"})}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-22",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L637",children:"packages/extension-api/src/extension-api.d.ts:637"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"updateversion",children:"updateVersion()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"updateVersion"}),"(",(0,s.jsx)(n.code,{children:"version"}),"): ",(0,s.jsx)(n.code,{children:"void"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"parameters-11",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"version"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n",(0,s.jsx)(n.h4,{id:"returns-12",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"void"})}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-23",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L642",children:"packages/extension-api/src/extension-api.d.ts:642"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"updatewarnings",children:"updateWarnings()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"updateWarnings"}),"(",(0,s.jsx)(n.code,{children:"warnings"}),"): ",(0,s.jsx)(n.code,{children:"void"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"parameters-12",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"warnings"}),": ",(0,s.jsx)(n.a,{href:"/api/interfaces/ProviderInformation",children:(0,s.jsx)(n.code,{children:"ProviderInformation"})}),"[]"]}),"\n",(0,s.jsx)(n.h4,{id:"returns-13",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"void"})}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-24",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L658",children:"packages/extension-api/src/extension-api.d.ts:658"})})]})}function h(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},43023:(e,n,i)=>{i.d(n,{R:()=>a,x:()=>t});var s=i(63696);const r={},d=s.createContext(r);function a(e){const n=s.useContext(d);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function t(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:a(e.components),s.createElement(d.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[6704],{19168:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>t,contentTitle:()=>a,default:()=>h,frontMatter:()=>d,metadata:()=>c,toc:()=>o});var s=i(62540),r=i(43023);const d={},a="Interface: Provider",c={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"}},t={},o=[{value:"Properties",id:"properties",level:2},{value:"detectionChecks",id:"detectionchecks",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"id",id:"id",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"images",id:"images",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"links",id:"links",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"name",id:"name",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"onDidUpdateDetectionChecks",id:"ondidupdatedetectionchecks",level:3},{value:"Defined in",id:"defined-in-5",level:4},{value:"onDidUpdateStatus",id:"ondidupdatestatus",level:3},{value:"Defined in",id:"defined-in-6",level:4},{value:"onDidUpdateVersion",id:"ondidupdateversion",level:3},{value:"Defined in",id:"defined-in-7",level:4},{value:"status",id:"status",level:3},{value:"Defined in",id:"defined-in-8",level:4},{value:"version",id:"version",level:3},{value:"Defined in",id:"defined-in-9",level:4},{value:"warnings",id:"warnings",level:3},{value:"Defined in",id:"defined-in-10",level:4},{value:"Methods",id:"methods",level:2},{value:"dispose()",id:"dispose",level:3},{value:"Returns",id:"returns",level:4},{value:"Defined in",id:"defined-in-11",level:4},{value:"registerAutostart()",id:"registerautostart",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Defined in",id:"defined-in-12",level:4},{value:"registerCleanup()",id:"registercleanup",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-2",level:4},{value:"Defined in",id:"defined-in-13",level:4},{value:"registerContainerProviderConnection()",id:"registercontainerproviderconnection",level:3},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-3",level:4},{value:"Defined in",id:"defined-in-14",level:4},{value:"registerInstallation()",id:"registerinstallation",level:3},{value:"Parameters",id:"parameters-3",level:4},{value:"Returns",id:"returns-4",level:4},{value:"Defined in",id:"defined-in-15",level:4},{value:"registerKubernetesProviderConnection()",id:"registerkubernetesproviderconnection",level:3},{value:"Parameters",id:"parameters-4",level:4},{value:"Returns",id:"returns-5",level:4},{value:"Defined in",id:"defined-in-16",level:4},{value:"registerLifecycle()",id:"registerlifecycle",level:3},{value:"Parameters",id:"parameters-5",level:4},{value:"Returns",id:"returns-6",level:4},{value:"Defined in",id:"defined-in-17",level:4},{value:"registerUpdate()",id:"registerupdate",level:3},{value:"Parameters",id:"parameters-6",level:4},{value:"Returns",id:"returns-7",level:4},{value:"Defined in",id:"defined-in-18",level:4},{value:"setContainerProviderConnectionFactory()",id:"setcontainerproviderconnectionfactory",level:3},{value:"Parameters",id:"parameters-7",level:4},{value:"Returns",id:"returns-8",level:4},{value:"Defined in",id:"defined-in-19",level:4},{value:"setKubernetesProviderConnectionFactory()",id:"setkubernetesproviderconnectionfactory",level:3},{value:"Parameters",id:"parameters-8",level:4},{value:"Returns",id:"returns-9",level:4},{value:"Defined in",id:"defined-in-20",level:4},{value:"updateDetectionChecks()",id:"updatedetectionchecks",level:3},{value:"Parameters",id:"parameters-9",level:4},{value:"Returns",id:"returns-10",level:4},{value:"Defined in",id:"defined-in-21",level:4},{value:"updateStatus()",id:"updatestatus",level:3},{value:"Parameters",id:"parameters-10",level:4},{value:"Returns",id:"returns-11",level:4},{value:"Defined in",id:"defined-in-22",level:4},{value:"updateVersion()",id:"updateversion",level:3},{value:"Parameters",id:"parameters-11",level:4},{value:"Returns",id:"returns-12",level:4},{value:"Defined in",id:"defined-in-23",level:4},{value:"updateWarnings()",id:"updatewarnings",level:3},{value:"Parameters",id:"parameters-12",level:4},{value:"Returns",id:"returns-13",level:4},{value:"Defined in",id:"defined-in-24",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",p:"p",strong:"strong",...(0,r.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.header,{children:(0,s.jsx)(n.h1,{id:"interface-provider",children:"Interface: Provider"})}),"\n",(0,s.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,s.jsx)(n.h3,{id:"detectionchecks",children:"detectionChecks"}),"\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:"detectionChecks"}),": ",(0,s.jsx)(n.a,{href:"/api/interfaces/ProviderDetectionCheck",children:(0,s.jsx)(n.code,{children:"ProviderDetectionCheck"})}),"[]"]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L650",children:"packages/extension-api/src/extension-api.d.ts:650"})}),"\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.code,{children:"readonly"})," ",(0,s.jsx)(n.strong,{children:"id"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/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:"images",children:"images"}),"\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:"images"}),": ",(0,s.jsx)(n.a,{href:"/api/interfaces/ProviderImages",children:(0,s.jsx)(n.code,{children:"ProviderImages"})})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-2",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L645",children:"packages/extension-api/src/extension-api.d.ts:645"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"links",children:"links"}),"\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:"links"}),": ",(0,s.jsx)(n.a,{href:"/api/interfaces/Link",children:(0,s.jsx)(n.code,{children:"Link"})}),"[]"]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-3",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L647",children:"packages/extension-api/src/extension-api.d.ts:647"})}),"\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.code,{children:"readonly"})," ",(0,s.jsx)(n.strong,{children:"name"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-4",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/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:"ondidupdatedetectionchecks",children:"onDidUpdateDetectionChecks"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"onDidUpdateDetectionChecks"}),": ",(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/ProviderDetectionCheck",children:(0,s.jsx)(n.code,{children:"ProviderDetectionCheck"})}),"[]>"]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-5",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L661",children:"packages/extension-api/src/extension-api.d.ts:661"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"ondidupdatestatus",children:"onDidUpdateStatus"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"onDidUpdateStatus"}),": ",(0,s.jsx)(n.a,{href:"/api/interfaces/Event",children:(0,s.jsx)(n.code,{children:"Event"})}),"<",(0,s.jsx)(n.a,{href:"/api/type-aliases/ProviderStatus",children:(0,s.jsx)(n.code,{children:"ProviderStatus"})}),">"]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-6",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L638",children:"packages/extension-api/src/extension-api.d.ts:638"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"ondidupdateversion",children:"onDidUpdateVersion"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"onDidUpdateVersion"}),": ",(0,s.jsx)(n.a,{href:"/api/interfaces/Event",children:(0,s.jsx)(n.code,{children:"Event"})}),"<",(0,s.jsx)(n.code,{children:"string"}),">"]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-7",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L643",children:"packages/extension-api/src/extension-api.d.ts:643"})}),"\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.code,{children:"readonly"})," ",(0,s.jsx)(n.strong,{children:"status"}),": ",(0,s.jsx)(n.a,{href:"/api/type-aliases/ProviderStatus",children:(0,s.jsx)(n.code,{children:"ProviderStatus"})})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-8",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L636",children:"packages/extension-api/src/extension-api.d.ts:636"})}),"\n",(0,s.jsx)(n.hr,{}),"\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.code,{children:"readonly"})," ",(0,s.jsx)(n.strong,{children:"version"}),": ",(0,s.jsx)(n.code,{children:"undefined"})," | ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-9",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L641",children:"packages/extension-api/src/extension-api.d.ts:641"})}),"\n",(0,s.jsx)(n.hr,{}),"\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.code,{children:"readonly"})," ",(0,s.jsx)(n.strong,{children:"warnings"}),": ",(0,s.jsx)(n.a,{href:"/api/interfaces/ProviderInformation",children:(0,s.jsx)(n.code,{children:"ProviderInformation"})}),"[]"]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-10",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L657",children:"packages/extension-api/src/extension-api.d.ts:657"})}),"\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.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:"defined-in-11",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L633",children:"packages/extension-api/src/extension-api.d.ts:633"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"registerautostart",children:"registerAutostart()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"registerAutostart"}),"(",(0,s.jsx)(n.code,{children:"autostart"}),"): ",(0,s.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,s.jsx)(n.code,{children:"Disposable"})})]}),"\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:"autostart"}),": ",(0,s.jsx)(n.a,{href:"/api/interfaces/ProviderAutostart",children:(0,s.jsx)(n.code,{children:"ProviderAutostart"})})]}),"\n",(0,s.jsx)(n.h4,{id:"returns-1",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.h4,{id:"defined-in-12",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L629",children:"packages/extension-api/src/extension-api.d.ts:629"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"registercleanup",children:"registerCleanup()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"registerCleanup"}),"(",(0,s.jsx)(n.code,{children:"cleanup"}),"): ",(0,s.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,s.jsx)(n.code,{children:"Disposable"})})]}),"\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:"cleanup"}),": ",(0,s.jsx)(n.a,{href:"/api/interfaces/ProviderCleanup",children:(0,s.jsx)(n.code,{children:"ProviderCleanup"})})]}),"\n",(0,s.jsx)(n.h4,{id:"returns-2",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.h4,{id:"defined-in-13",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L631",children:"packages/extension-api/src/extension-api.d.ts:631"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"registercontainerproviderconnection",children:"registerContainerProviderConnection()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"registerContainerProviderConnection"}),"(",(0,s.jsx)(n.code,{children:"connection"}),"): ",(0,s.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,s.jsx)(n.code,{children:"Disposable"})})]}),"\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:"connection"}),": ",(0,s.jsx)(n.a,{href:"/api/interfaces/ContainerProviderConnection",children:(0,s.jsx)(n.code,{children:"ContainerProviderConnection"})})]}),"\n",(0,s.jsx)(n.h4,{id:"returns-3",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.h4,{id:"defined-in-14",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L618",children:"packages/extension-api/src/extension-api.d.ts:618"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"registerinstallation",children:"registerInstallation()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"registerInstallation"}),"(",(0,s.jsx)(n.code,{children:"installation"}),"): ",(0,s.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,s.jsx)(n.code,{children:"Disposable"})})]}),"\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:"installation"}),": ",(0,s.jsx)(n.a,{href:"/api/interfaces/ProviderInstallation",children:(0,s.jsx)(n.code,{children:"ProviderInstallation"})})]}),"\n",(0,s.jsx)(n.h4,{id:"returns-4",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.h4,{id:"defined-in-15",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L623",children:"packages/extension-api/src/extension-api.d.ts:623"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"registerkubernetesproviderconnection",children:"registerKubernetesProviderConnection()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"registerKubernetesProviderConnection"}),"(",(0,s.jsx)(n.code,{children:"connection"}),"): ",(0,s.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,s.jsx)(n.code,{children:"Disposable"})})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"parameters-4",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(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",(0,s.jsx)(n.h4,{id:"returns-5",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.h4,{id:"defined-in-16",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L619",children:"packages/extension-api/src/extension-api.d.ts:619"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"registerlifecycle",children:"registerLifecycle()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"registerLifecycle"}),"(",(0,s.jsx)(n.code,{children:"lifecycle"}),"): ",(0,s.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,s.jsx)(n.code,{children:"Disposable"})})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"parameters-5",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"lifecycle"}),": ",(0,s.jsx)(n.a,{href:"/api/interfaces/ProviderLifecycle",children:(0,s.jsx)(n.code,{children:"ProviderLifecycle"})})]}),"\n",(0,s.jsx)(n.h4,{id:"returns-6",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.h4,{id:"defined-in-17",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L620",children:"packages/extension-api/src/extension-api.d.ts:620"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"registerupdate",children:"registerUpdate()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"registerUpdate"}),"(",(0,s.jsx)(n.code,{children:"update"}),"): ",(0,s.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,s.jsx)(n.code,{children:"Disposable"})})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"parameters-6",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"update"}),": ",(0,s.jsx)(n.a,{href:"/api/interfaces/ProviderUpdate",children:(0,s.jsx)(n.code,{children:"ProviderUpdate"})})]}),"\n",(0,s.jsx)(n.h4,{id:"returns-7",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.h4,{id:"defined-in-18",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L626",children:"packages/extension-api/src/extension-api.d.ts:626"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"setcontainerproviderconnectionfactory",children:"setContainerProviderConnectionFactory()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"setContainerProviderConnectionFactory"}),"(",(0,s.jsx)(n.code,{children:"containerProviderConnectionFactory"}),", ",(0,s.jsx)(n.code,{children:"connectionAuditor"}),"?): ",(0,s.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,s.jsx)(n.code,{children:"Disposable"})})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"parameters-7",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"containerProviderConnectionFactory"}),": ",(0,s.jsx)(n.a,{href:"/api/interfaces/ContainerProviderConnectionFactory",children:(0,s.jsx)(n.code,{children:"ContainerProviderConnectionFactory"})})]}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"connectionAuditor?"}),": ",(0,s.jsx)(n.a,{href:"/api/interfaces/Auditor",children:(0,s.jsx)(n.code,{children:"Auditor"})})]}),"\n",(0,s.jsx)(n.h4,{id:"returns-8",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.h4,{id:"defined-in-19",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L609",children:"packages/extension-api/src/extension-api.d.ts:609"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"setkubernetesproviderconnectionfactory",children:"setKubernetesProviderConnectionFactory()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"setKubernetesProviderConnectionFactory"}),"(",(0,s.jsx)(n.code,{children:"containerProviderConnectionFactory"}),", ",(0,s.jsx)(n.code,{children:"connectionAuditor"}),"?): ",(0,s.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,s.jsx)(n.code,{children:"Disposable"})})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"parameters-8",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"containerProviderConnectionFactory"}),": ",(0,s.jsx)(n.a,{href:"/api/interfaces/KubernetesProviderConnectionFactory",children:(0,s.jsx)(n.code,{children:"KubernetesProviderConnectionFactory"})})]}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"connectionAuditor?"}),": ",(0,s.jsx)(n.a,{href:"/api/interfaces/Auditor",children:(0,s.jsx)(n.code,{children:"Auditor"})})]}),"\n",(0,s.jsx)(n.h4,{id:"returns-9",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.h4,{id:"defined-in-20",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L613",children:"packages/extension-api/src/extension-api.d.ts:613"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"updatedetectionchecks",children:"updateDetectionChecks()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"updateDetectionChecks"}),"(",(0,s.jsx)(n.code,{children:"detectionChecks"}),"): ",(0,s.jsx)(n.code,{children:"void"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"parameters-9",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"detectionChecks"}),": ",(0,s.jsx)(n.a,{href:"/api/interfaces/ProviderDetectionCheck",children:(0,s.jsx)(n.code,{children:"ProviderDetectionCheck"})}),"[]"]}),"\n",(0,s.jsx)(n.h4,{id:"returns-10",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"void"})}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-21",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L654",children:"packages/extension-api/src/extension-api.d.ts:654"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"updatestatus",children:"updateStatus()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"updateStatus"}),"(",(0,s.jsx)(n.code,{children:"status"}),"): ",(0,s.jsx)(n.code,{children:"void"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"parameters-10",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"status"}),": ",(0,s.jsx)(n.a,{href:"/api/type-aliases/ProviderStatus",children:(0,s.jsx)(n.code,{children:"ProviderStatus"})})]}),"\n",(0,s.jsx)(n.h4,{id:"returns-11",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"void"})}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-22",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L637",children:"packages/extension-api/src/extension-api.d.ts:637"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"updateversion",children:"updateVersion()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"updateVersion"}),"(",(0,s.jsx)(n.code,{children:"version"}),"): ",(0,s.jsx)(n.code,{children:"void"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"parameters-11",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"version"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n",(0,s.jsx)(n.h4,{id:"returns-12",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"void"})}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-23",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L642",children:"packages/extension-api/src/extension-api.d.ts:642"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"updatewarnings",children:"updateWarnings()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"updateWarnings"}),"(",(0,s.jsx)(n.code,{children:"warnings"}),"): ",(0,s.jsx)(n.code,{children:"void"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"parameters-12",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"warnings"}),": ",(0,s.jsx)(n.a,{href:"/api/interfaces/ProviderInformation",children:(0,s.jsx)(n.code,{children:"ProviderInformation"})}),"[]"]}),"\n",(0,s.jsx)(n.h4,{id:"returns-13",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"void"})}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-24",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L658",children:"packages/extension-api/src/extension-api.d.ts:658"})})]})}function h(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},43023:(e,n,i)=>{i.d(n,{R:()=>a,x:()=>c});var s=i(63696);const r={},d=s.createContext(r);function a(e){const n=s.useContext(d);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(d.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/1fbe0675.5c6c0dcb.js b/assets/js/1fbe0675.9cf6a829.js similarity index 88% rename from assets/js/1fbe0675.5c6c0dcb.js rename to assets/js/1fbe0675.9cf6a829.js index 7c8a391bdf7..1cfa26c58db 100644 --- a/assets/js/1fbe0675.5c6c0dcb.js +++ b/assets/js/1fbe0675.9cf6a829.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[97331],{24586:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>o,contentTitle:()=>a,default:()=>h,frontMatter:()=>c,metadata:()=>i,toc:()=>d});var s=n(62540),r=n(43023);const c={},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:"fs",permalink:"/api/namespaces/fs/"},next:{title:"imageChecker",permalink:"/api/namespaces/imageChecker/"}},o={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Defined in",id:"defined-in",level:2}];function l(e){const t={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",strong:"strong",...(0,r.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(t.header,{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:"defined-in",children:"Defined in"}),"\n",(0,s.jsx)(t.p,{children:(0,s.jsx)(t.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L1678",children:"packages/extension-api/src/extension-api.d.ts:1678"})})]})}function h(e={}){const{wrapper:t}={...(0,r.R)(),...e.components};return t?(0,s.jsx)(t,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},43023:(e,t,n)=>{n.d(t,{R:()=>a,x:()=>i});var s=n(63696);const r={},c=s.createContext(r);function a(e){const t=s.useContext(c);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:a(e.components),s.createElement(c.Provider,{value:t},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[97331],{24586:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>o,contentTitle:()=>a,default:()=>h,frontMatter:()=>c,metadata:()=>i,toc:()=>l});var s=n(62540),r=n(43023);const c={},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:"fs",permalink:"/api/namespaces/fs/"},next:{title:"imageChecker",permalink:"/api/namespaces/imageChecker/"}},o={},l=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Defined in",id:"defined-in",level:2}];function d(e){const t={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",strong:"strong",...(0,r.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(t.header,{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:"defined-in",children:"Defined in"}),"\n",(0,s.jsx)(t.p,{children:(0,s.jsx)(t.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L1678",children:"packages/extension-api/src/extension-api.d.ts:1678"})})]})}function h(e={}){const{wrapper:t}={...(0,r.R)(),...e.components};return t?(0,s.jsx)(t,{...e,children:(0,s.jsx)(d,{...e})}):d(e)}},43023:(e,t,n)=>{n.d(t,{R:()=>a,x:()=>i});var s=n(63696);const r={},c=s.createContext(r);function a(e){const t=s.useContext(c);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:a(e.components),s.createElement(c.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/1fc83a28.f01e0cf7.js b/assets/js/1fc83a28.db7344d0.js similarity index 91% rename from assets/js/1fc83a28.f01e0cf7.js rename to assets/js/1fc83a28.db7344d0.js index 7872e509900..7748ec327a0 100644 --- a/assets/js/1fc83a28.f01e0cf7.js +++ b/assets/js/1fc83a28.db7344d0.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[60441],{17105:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>a,contentTitle:()=>o,default:()=>l,frontMatter:()=>c,metadata:()=>r,toc:()=>d});var s=i(62540),t=i(43023);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:"Defined in",id:"defined-in",level:4},{value:"account",id:"account",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"id",id:"id",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"scopes",id:"scopes",level:3},{value:"Defined in",id:"defined-in-3",level:4}];function h(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",p:"p",strong:"strong",...(0,t.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.header,{children:(0,s.jsx)(n.h1,{id:"interface-authenticationsession",children:"Interface: AuthenticationSession"})}),"\n",(0,s.jsx)(n.p,{children:"Represents a session of a currently logged in user."}),"\n",(0,s.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,s.jsx)(n.h3,{id:"accesstoken",children:"accessToken"}),"\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:"accessToken"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The access token."}),"\n",(0,s.jsx)(n.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L3710",children:"packages/extension-api/src/extension-api.d.ts:3710"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"account",children:"account"}),"\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:"account"}),": ",(0,s.jsx)(n.a,{href:"/api/interfaces/AuthenticationSessionAccountInformation",children:(0,s.jsx)(n.code,{children:"AuthenticationSessionAccountInformation"})})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The account associated with the session."}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L3715",children:"packages/extension-api/src/extension-api.d.ts:3715"})}),"\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.code,{children:"readonly"})," ",(0,s.jsx)(n.strong,{children:"id"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The identifier of the authentication session."}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-2",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L3705",children:"packages/extension-api/src/extension-api.d.ts:3705"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"scopes",children:"scopes"}),"\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:"scopes"}),": readonly ",(0,s.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:["The permissions granted by the session's access token. Available scopes\nare defined by the ",(0,s.jsx)(n.a,{href:"#AuthenticationProvider",children:"AuthenticationProvider"}),"."]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-3",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L3721",children:"packages/extension-api/src/extension-api.d.ts:3721"})})]})}function l(e={}){const{wrapper:n}={...(0,t.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(h,{...e})}):h(e)}},43023:(e,n,i)=>{i.d(n,{R:()=>o,x:()=>r});var s=i(63696);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 +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[60441],{17105:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>a,contentTitle:()=>o,default:()=>l,frontMatter:()=>c,metadata:()=>r,toc:()=>d});var s=i(62540),t=i(43023);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:"Defined in",id:"defined-in",level:4},{value:"account",id:"account",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"id",id:"id",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"scopes",id:"scopes",level:3},{value:"Defined in",id:"defined-in-3",level:4}];function h(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",p:"p",strong:"strong",...(0,t.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.header,{children:(0,s.jsx)(n.h1,{id:"interface-authenticationsession",children:"Interface: AuthenticationSession"})}),"\n",(0,s.jsx)(n.p,{children:"Represents a session of a currently logged in user."}),"\n",(0,s.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,s.jsx)(n.h3,{id:"accesstoken",children:"accessToken"}),"\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:"accessToken"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The access token."}),"\n",(0,s.jsx)(n.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L3710",children:"packages/extension-api/src/extension-api.d.ts:3710"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"account",children:"account"}),"\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:"account"}),": ",(0,s.jsx)(n.a,{href:"/api/interfaces/AuthenticationSessionAccountInformation",children:(0,s.jsx)(n.code,{children:"AuthenticationSessionAccountInformation"})})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The account associated with the session."}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L3715",children:"packages/extension-api/src/extension-api.d.ts:3715"})}),"\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.code,{children:"readonly"})," ",(0,s.jsx)(n.strong,{children:"id"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The identifier of the authentication session."}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-2",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L3705",children:"packages/extension-api/src/extension-api.d.ts:3705"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"scopes",children:"scopes"}),"\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:"scopes"}),": readonly ",(0,s.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:["The permissions granted by the session's access token. Available scopes\nare defined by the ",(0,s.jsx)(n.a,{href:"#AuthenticationProvider",children:"AuthenticationProvider"}),"."]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-3",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L3721",children:"packages/extension-api/src/extension-api.d.ts:3721"})})]})}function l(e={}){const{wrapper:n}={...(0,t.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(h,{...e})}):h(e)}},43023:(e,n,i)=>{i.d(n,{R:()=>o,x:()=>r});var s=i(63696);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/22e2140b.40a20efd.js b/assets/js/22e2140b.f759648f.js similarity index 96% rename from assets/js/22e2140b.40a20efd.js rename to assets/js/22e2140b.f759648f.js index 40e4afa5bdc..db4579a02d5 100644 --- a/assets/js/22e2140b.40a20efd.js +++ b/assets/js/22e2140b.f759648f.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[16115],{97014:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>d,contentTitle:()=>a,default:()=>h,frontMatter:()=>s,metadata:()=>o,toc:()=>c});var t=r(62540),i=r(43023);const s={},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"}},d={},c=[{value:"Type Parameters",id:"type-parameters",level:2},{value:"Defined in",id:"defined-in",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",pre:"pre",strong:"strong",...(0,i.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.header,{children:(0,t.jsx)(n.h1,{id:"type-alias-providerresultt",children:"Type Alias: ProviderResult"})}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"ProviderResult"}),"<",(0,t.jsx)(n.code,{children:"T"}),">: ",(0,t.jsx)(n.code,{children:"T"})," | ",(0,t.jsx)(n.code,{children:"undefined"})," | ",(0,t.jsx)(n.code,{children:"Promise"}),"<",(0,t.jsx)(n.code,{children:"T"})," | ",(0,t.jsx)(n.code,{children:"undefined"}),">"]}),"\n"]}),"\n",(0,t.jsxs)(n.p,{children:["A provider result represents the values a provider, like the ",(0,t.jsx)(n.a,{href:"/api/interfaces/ImageCheckerProvider",children:(0,t.jsx)(n.code,{children:"ImageCheckerProvider"})}),",\nmay return. For once this is the actual result type ",(0,t.jsx)(n.code,{children:"T"}),", like ",(0,t.jsx)(n.code,{children:"ImageChecks"}),", or a Promise that resolves\nto that type ",(0,t.jsx)(n.code,{children:"T"}),". In addition, ",(0,t.jsx)(n.code,{children:"null"})," and ",(0,t.jsx)(n.code,{children:"undefined"})," can be returned - either directly or from a\nPromise."]}),"\n",(0,t.jsxs)(n.p,{children:["The snippets below are all valid implementations of the ",(0,t.jsx)(n.a,{href:"/api/interfaces/ImageCheckerProvider",children:(0,t.jsx)(n.code,{children:"ImageCheckerProvider"})}),":"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.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)(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.jsx)(n.h2,{id:"defined-in",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L276",children:"packages/extension-api/src/extension-api.d.ts:276"})})]})}function h(e={}){const{wrapper:n}={...(0,i.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},43023:(e,n,r)=>{r.d(n,{R:()=>a,x:()=>o});var t=r(63696);const i={},s=t.createContext(i);function a(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:a(e.components),t.createElement(s.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[16115],{97014:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>d,contentTitle:()=>a,default:()=>h,frontMatter:()=>s,metadata:()=>o,toc:()=>c});var t=r(62540),i=r(43023);const s={},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"}},d={},c=[{value:"Type Parameters",id:"type-parameters",level:2},{value:"Defined in",id:"defined-in",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",pre:"pre",strong:"strong",...(0,i.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.header,{children:(0,t.jsx)(n.h1,{id:"type-alias-providerresultt",children:"Type Alias: ProviderResult"})}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"ProviderResult"}),"<",(0,t.jsx)(n.code,{children:"T"}),">: ",(0,t.jsx)(n.code,{children:"T"})," | ",(0,t.jsx)(n.code,{children:"undefined"})," | ",(0,t.jsx)(n.code,{children:"Promise"}),"<",(0,t.jsx)(n.code,{children:"T"})," | ",(0,t.jsx)(n.code,{children:"undefined"}),">"]}),"\n"]}),"\n",(0,t.jsxs)(n.p,{children:["A provider result represents the values a provider, like the ",(0,t.jsx)(n.a,{href:"/api/interfaces/ImageCheckerProvider",children:(0,t.jsx)(n.code,{children:"ImageCheckerProvider"})}),",\nmay return. For once this is the actual result type ",(0,t.jsx)(n.code,{children:"T"}),", like ",(0,t.jsx)(n.code,{children:"ImageChecks"}),", or a Promise that resolves\nto that type ",(0,t.jsx)(n.code,{children:"T"}),". In addition, ",(0,t.jsx)(n.code,{children:"null"})," and ",(0,t.jsx)(n.code,{children:"undefined"})," can be returned - either directly or from a\nPromise."]}),"\n",(0,t.jsxs)(n.p,{children:["The snippets below are all valid implementations of the ",(0,t.jsx)(n.a,{href:"/api/interfaces/ImageCheckerProvider",children:(0,t.jsx)(n.code,{children:"ImageCheckerProvider"})}),":"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.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)(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.jsx)(n.h2,{id:"defined-in",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L276",children:"packages/extension-api/src/extension-api.d.ts:276"})})]})}function h(e={}){const{wrapper:n}={...(0,i.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},43023:(e,n,r)=>{r.d(n,{R:()=>a,x:()=>o});var t=r(63696);const i={},s=t.createContext(i);function a(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:a(e.components),t.createElement(s.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/2340b3ee.1bcefee7.js b/assets/js/2340b3ee.ed116807.js similarity index 96% rename from assets/js/2340b3ee.1bcefee7.js rename to assets/js/2340b3ee.ed116807.js index b7e8d89a346..f08af6530a4 100644 --- a/assets/js/2340b3ee.1bcefee7.js +++ b/assets/js/2340b3ee.ed116807.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[34293],{73100:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>d,contentTitle:()=>i,default:()=>p,frontMatter:()=>t,metadata:()=>o,toc:()=>a});var r=s(62540),c=s(43023);const t={},i="Function: exec()",o={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:"process",permalink:"/api/namespaces/process/"},next:{title:"provider",permalink:"/api/namespaces/provider/"}},d={},a=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Throws",id:"throws",level:2},{value:"Defined in",id:"defined-in",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",strong:"strong",...(0,c.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.header,{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:"defined-in",children:"Defined in"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L4137",children:"packages/extension-api/src/extension-api.d.ts:4137"})})]})}function p(e={}){const{wrapper:n}={...(0,c.R)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(l,{...e})}):l(e)}},43023:(e,n,s)=>{s.d(n,{R:()=>i,x:()=>o});var r=s(63696);const c={},t=r.createContext(c);function i(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(c):e.components||c:i(e.components),r.createElement(t.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[34293],{73100:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>d,contentTitle:()=>i,default:()=>p,frontMatter:()=>t,metadata:()=>o,toc:()=>a});var r=s(62540),c=s(43023);const t={},i="Function: exec()",o={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:"process",permalink:"/api/namespaces/process/"},next:{title:"provider",permalink:"/api/namespaces/provider/"}},d={},a=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Throws",id:"throws",level:2},{value:"Defined in",id:"defined-in",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",strong:"strong",...(0,c.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.header,{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:"defined-in",children:"Defined in"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L4137",children:"packages/extension-api/src/extension-api.d.ts:4137"})})]})}function p(e={}){const{wrapper:n}={...(0,c.R)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(l,{...e})}):l(e)}},43023:(e,n,s)=>{s.d(n,{R:()=>i,x:()=>o});var r=s(63696);const c={},t=r.createContext(c);function i(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(c):e.components||c:i(e.components),r.createElement(t.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/23a8e291.4d3eb74e.js b/assets/js/23a8e291.71c7a2e8.js similarity index 93% rename from assets/js/23a8e291.4d3eb74e.js rename to assets/js/23a8e291.71c7a2e8.js index 37405a6f1b8..b8da16be1c3 100644 --- a/assets/js/23a8e291.4d3eb74e.js +++ b/assets/js/23a8e291.71c7a2e8.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[12618],{66527:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>a,contentTitle:()=>o,default:()=>l,frontMatter:()=>s,metadata:()=>c,toc:()=>d});var t=i(62540),r=i(43023);const s={},o="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:"Defined in",id:"defined-in",level:4}];function h(e){const n={a:"a",blockquote:"blockquote",code:"code",em:"em",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",p:"p",strong:"strong",...(0,r.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.header,{children:(0,t.jsx)(n.h1,{id:"interface-configurationchangeevent",children:"Interface: ConfigurationChangeEvent"})}),"\n",(0,t.jsx)(n.p,{children:"An event describing the change in Configuration"}),"\n",(0,t.jsx)(n.h2,{id:"methods",children:"Methods"}),"\n",(0,t.jsx)(n.h3,{id:"affectsconfiguration",children:"affectsConfiguration()"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"affectsConfiguration"}),"(",(0,t.jsx)(n.code,{children:"section"}),", ",(0,t.jsx)(n.code,{children:"scope"}),"?): ",(0,t.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,t.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,t.jsx)(n.h4,{id:"parameters",children:"Parameters"}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"section"}),": ",(0,t.jsx)(n.code,{children:"string"})]}),"\n",(0,t.jsxs)(n.p,{children:["Configuration name, supports ",(0,t.jsx)(n.em,{children:"dotted"})," names."]}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"scope?"}),": ",(0,t.jsx)(n.a,{href:"/api/type-aliases/ConfigurationScope",children:(0,t.jsx)(n.code,{children:"ConfigurationScope"})})]}),"\n",(0,t.jsx)(n.p,{children:"A scope in which to check."}),"\n",(0,t.jsx)(n.h4,{id:"returns",children:"Returns"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.code,{children:"boolean"})}),"\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"true"})," if the given section has changed."]}),"\n",(0,t.jsx)(n.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L1016",children:"packages/extension-api/src/extension-api.d.ts:1016"})})]})}function l(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(h,{...e})}):h(e)}},43023:(e,n,i)=>{i.d(n,{R:()=>o,x:()=>c});var t=i(63696);const r={},s=t.createContext(r);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(r):e.components||r:o(e.components),t.createElement(s.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[12618],{66527:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>a,contentTitle:()=>o,default:()=>f,frontMatter:()=>s,metadata:()=>c,toc:()=>d});var t=i(62540),r=i(43023);const s={},o="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:"Defined in",id:"defined-in",level:4}];function h(e){const n={a:"a",blockquote:"blockquote",code:"code",em:"em",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",p:"p",strong:"strong",...(0,r.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.header,{children:(0,t.jsx)(n.h1,{id:"interface-configurationchangeevent",children:"Interface: ConfigurationChangeEvent"})}),"\n",(0,t.jsx)(n.p,{children:"An event describing the change in Configuration"}),"\n",(0,t.jsx)(n.h2,{id:"methods",children:"Methods"}),"\n",(0,t.jsx)(n.h3,{id:"affectsconfiguration",children:"affectsConfiguration()"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"affectsConfiguration"}),"(",(0,t.jsx)(n.code,{children:"section"}),", ",(0,t.jsx)(n.code,{children:"scope"}),"?): ",(0,t.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,t.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,t.jsx)(n.h4,{id:"parameters",children:"Parameters"}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"section"}),": ",(0,t.jsx)(n.code,{children:"string"})]}),"\n",(0,t.jsxs)(n.p,{children:["Configuration name, supports ",(0,t.jsx)(n.em,{children:"dotted"})," names."]}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"scope?"}),": ",(0,t.jsx)(n.a,{href:"/api/type-aliases/ConfigurationScope",children:(0,t.jsx)(n.code,{children:"ConfigurationScope"})})]}),"\n",(0,t.jsx)(n.p,{children:"A scope in which to check."}),"\n",(0,t.jsx)(n.h4,{id:"returns",children:"Returns"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.code,{children:"boolean"})}),"\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"true"})," if the given section has changed."]}),"\n",(0,t.jsx)(n.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L1016",children:"packages/extension-api/src/extension-api.d.ts:1016"})})]})}function f(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(h,{...e})}):h(e)}},43023:(e,n,i)=>{i.d(n,{R:()=>o,x:()=>c});var t=i(63696);const r={},s=t.createContext(r);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(r):e.components||r:o(e.components),t.createElement(s.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/24dadce3.17c3ec6c.js b/assets/js/24dadce3.a381bd21.js similarity index 78% rename from assets/js/24dadce3.17c3ec6c.js rename to assets/js/24dadce3.a381bd21.js index 665002621a1..862974213fb 100644 --- a/assets/js/24dadce3.17c3ec6c.js +++ b/assets/js/24dadce3.a381bd21.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[58775],{51190:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>o,default:()=>p,frontMatter:()=>c,metadata:()=>s,toc:()=>d});var i=t(62540),r=t(43023);const c={},o="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={},d=[{value:"Properties",id:"properties",level:2},{value:"log",id:"log",level:3},{value:"Defined in",id:"defined-in",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",p:"p",strong:"strong",...(0,r.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.header,{children:(0,i.jsx)(n.h1,{id:"interface-lifecyclecontext",children:"Interface: LifecycleContext"})}),"\n",(0,i.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(n.h3,{id:"log",children:"log"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"log"}),": ",(0,i.jsx)(n.a,{href:"/api/interfaces/Logger",children:(0,i.jsx)(n.code,{children:"Logger"})})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L339",children:"packages/extension-api/src/extension-api.d.ts:339"})})]})}function p(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},43023:(e,n,t)=>{t.d(n,{R:()=>o,x:()=>s});var i=t(63696);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 s(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:o(e.components),i.createElement(c.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[58775],{51190:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>o,default:()=>f,frontMatter:()=>c,metadata:()=>s,toc:()=>l});var i=t(62540),r=t(43023);const c={},o="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:"Defined in",id:"defined-in",level:4}];function d(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",p:"p",strong:"strong",...(0,r.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.header,{children:(0,i.jsx)(n.h1,{id:"interface-lifecyclecontext",children:"Interface: LifecycleContext"})}),"\n",(0,i.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(n.h3,{id:"log",children:"log"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"log"}),": ",(0,i.jsx)(n.a,{href:"/api/interfaces/Logger",children:(0,i.jsx)(n.code,{children:"Logger"})})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L339",children:"packages/extension-api/src/extension-api.d.ts:339"})})]})}function f(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(d,{...e})}):d(e)}},43023:(e,n,t)=>{t.d(n,{R:()=>o,x:()=>s});var i=t(63696);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 s(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/254d0ff5.b2f79b13.js b/assets/js/254d0ff5.97188e18.js similarity index 91% rename from assets/js/254d0ff5.b2f79b13.js rename to assets/js/254d0ff5.97188e18.js index 3cb7bbeb544..04987c98cf4 100644 --- a/assets/js/254d0ff5.b2f79b13.js +++ b/assets/js/254d0ff5.97188e18.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[77353],{55762:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>d,contentTitle:()=>s,default:()=>p,frontMatter:()=>t,metadata:()=>c,toc:()=>a});var r=i(62540),o=i(43023);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"}},d={},a=[{value:"Properties",id:"properties",level:2},{value:"icon?",id:"icon",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"logo?",id:"logo",level:3},{value:"Defined in",id:"defined-in-1",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",p:"p",strong:"strong",...(0,o.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.header,{children:(0,r.jsx)(n.h1,{id:"interface-providerimages",children:"Interface: ProviderImages"})}),"\n",(0,r.jsx)(n.h2,{id:"properties",children:"Properties"}),"\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"})," | ",(0,r.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L604",children:"packages/extension-api/src/extension-api.d.ts:604"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"logo",children:"logo?"}),"\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:"logo"}),": ",(0,r.jsx)(n.code,{children:"string"})," | ",(0,r.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L605",children:"packages/extension-api/src/extension-api.d.ts:605"})})]})}function p(e={}){const{wrapper:n}={...(0,o.R)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(l,{...e})}):l(e)}},43023:(e,n,i)=>{i.d(n,{R:()=>s,x:()=>c});var r=i(63696);const o={},t=r.createContext(o);function s(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(o):e.components||o:s(e.components),r.createElement(t.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[77353],{55762:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>d,contentTitle:()=>s,default:()=>p,frontMatter:()=>t,metadata:()=>c,toc:()=>a});var r=i(62540),o=i(43023);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"}},d={},a=[{value:"Properties",id:"properties",level:2},{value:"icon?",id:"icon",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"logo?",id:"logo",level:3},{value:"Defined in",id:"defined-in-1",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",p:"p",strong:"strong",...(0,o.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.header,{children:(0,r.jsx)(n.h1,{id:"interface-providerimages",children:"Interface: ProviderImages"})}),"\n",(0,r.jsx)(n.h2,{id:"properties",children:"Properties"}),"\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"})," | ",(0,r.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L604",children:"packages/extension-api/src/extension-api.d.ts:604"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"logo",children:"logo?"}),"\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:"logo"}),": ",(0,r.jsx)(n.code,{children:"string"})," | ",(0,r.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L605",children:"packages/extension-api/src/extension-api.d.ts:605"})})]})}function p(e={}){const{wrapper:n}={...(0,o.R)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(l,{...e})}):l(e)}},43023:(e,n,i)=>{i.d(n,{R:()=>s,x:()=>c});var r=i(63696);const o={},t=r.createContext(o);function s(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(o):e.components||o:s(e.components),r.createElement(t.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/271ff0d1.10913cdc.js b/assets/js/271ff0d1.2e9275a0.js similarity index 96% rename from assets/js/271ff0d1.10913cdc.js rename to assets/js/271ff0d1.2e9275a0.js index a8e3c7be97f..9461f9f5222 100644 --- a/assets/js/271ff0d1.10913cdc.js +++ b/assets/js/271ff0d1.2e9275a0.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[65608],{34371:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>a,contentTitle:()=>c,default:()=>p,frontMatter:()=>t,metadata:()=>r,toc:()=>d});var i=s(62540),o=s(43023);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:"Defined in",id:"defined-in",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",strong:"strong",...(0,o.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.header,{children:(0,i.jsx)(n.h1,{id:"function-showopendialog",children:"Function: showOpenDialog()"})}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"showOpenDialog"}),"(",(0,i.jsx)(n.code,{children:"options"}),"?): ",(0,i.jsx)(n.code,{children:"Promise"}),"<",(0,i.jsx)(n.a,{href:"/api/classes/Uri",children:(0,i.jsx)(n.code,{children:"Uri"})}),"[] | ",(0,i.jsx)(n.code,{children:"undefined"}),">"]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Shows a file open dialog to the user which allows to select a file\nfor opening-purposes."}),"\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/OpenDialogOptions",children:(0,i.jsx)(n.code,{children:"OpenDialogOptions"})})]}),"\n",(0,i.jsx)(n.p,{children:"Options that control the dialog."}),"\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/classes/Uri",children:(0,i.jsx)(n.code,{children:"Uri"})}),"[] | ",(0,i.jsx)(n.code,{children:"undefined"}),">"]}),"\n",(0,i.jsxs)(n.p,{children:["A promise that resolves to the selected resources or ",(0,i.jsx)(n.code,{children:"undefined"}),"."]}),"\n",(0,i.jsx)(n.h2,{id:"defined-in",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2014",children:"packages/extension-api/src/extension-api.d.ts:2014"})})]})}function p(e={}){const{wrapper:n}={...(0,o.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},43023:(e,n,s)=>{s.d(n,{R:()=>c,x:()=>r});var i=s(63696);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([[65608],{34371:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>a,contentTitle:()=>c,default:()=>p,frontMatter:()=>t,metadata:()=>r,toc:()=>d});var i=s(62540),o=s(43023);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:"Defined in",id:"defined-in",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",strong:"strong",...(0,o.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.header,{children:(0,i.jsx)(n.h1,{id:"function-showopendialog",children:"Function: showOpenDialog()"})}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"showOpenDialog"}),"(",(0,i.jsx)(n.code,{children:"options"}),"?): ",(0,i.jsx)(n.code,{children:"Promise"}),"<",(0,i.jsx)(n.a,{href:"/api/classes/Uri",children:(0,i.jsx)(n.code,{children:"Uri"})}),"[] | ",(0,i.jsx)(n.code,{children:"undefined"}),">"]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Shows a file open dialog to the user which allows to select a file\nfor opening-purposes."}),"\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/OpenDialogOptions",children:(0,i.jsx)(n.code,{children:"OpenDialogOptions"})})]}),"\n",(0,i.jsx)(n.p,{children:"Options that control the dialog."}),"\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/classes/Uri",children:(0,i.jsx)(n.code,{children:"Uri"})}),"[] | ",(0,i.jsx)(n.code,{children:"undefined"}),">"]}),"\n",(0,i.jsxs)(n.p,{children:["A promise that resolves to the selected resources or ",(0,i.jsx)(n.code,{children:"undefined"}),"."]}),"\n",(0,i.jsx)(n.h2,{id:"defined-in",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2014",children:"packages/extension-api/src/extension-api.d.ts:2014"})})]})}function p(e={}){const{wrapper:n}={...(0,o.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},43023:(e,n,s)=>{s.d(n,{R:()=>c,x:()=>r});var i=s(63696);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 diff --git a/assets/js/280646e4.537d51d8.js b/assets/js/280646e4.bf91385b.js similarity index 80% rename from assets/js/280646e4.537d51d8.js rename to assets/js/280646e4.bf91385b.js index 3dcdbaadec1..2908b14151f 100644 --- a/assets/js/280646e4.537d51d8.js +++ b/assets/js/280646e4.bf91385b.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[25670],{50557:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>l,contentTitle:()=>r,default:()=>o,frontMatter:()=>a,metadata:()=>c,toc:()=>h});var s=t(62540),i=t(43023);const a={},r="Interface: HealthCheckResults",c={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={},h=[{value:"Properties",id:"properties",level:2},{value:"FailingStreak",id:"failingstreak",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"Log",id:"log",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"Status",id:"status",level:3},{value:"Defined in",id:"defined-in-2",level:4}];function d(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",p:"p",strong:"strong",...(0,i.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.header,{children:(0,s.jsx)(n.h1,{id:"interface-healthcheckresults",children:"Interface: HealthCheckResults"})}),"\n",(0,s.jsx)(n.p,{children:"HealthCheckResults describes the results/logs from a healthcheck"}),"\n",(0,s.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,s.jsx)(n.h3,{id:"failingstreak",children:"FailingStreak"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"FailingStreak"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"FailingStreak is the number of consecutive failed healthchecks"}),"\n",(0,s.jsx)(n.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2513",children:"packages/extension-api/src/extension-api.d.ts:2513"})}),"\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.a,{href:"/api/interfaces/HealthCheckLog",children:(0,s.jsx)(n.code,{children:"HealthCheckLog"})}),"[]"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Log describes healthcheck attempts and results"}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2517",children:"packages/extension-api/src/extension-api.d.ts:2517"})}),"\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.p,{children:"Status is starting, healthy or unhealthy"}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-2",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2509",children:"packages/extension-api/src/extension-api.d.ts:2509"})})]})}function o(e={}){const{wrapper:n}={...(0,i.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(d,{...e})}):d(e)}},43023:(e,n,t)=>{t.d(n,{R:()=>r,x:()=>c});var s=t(63696);const i={},a=s.createContext(i);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(i):e.components||i:r(e.components),s.createElement(a.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[25670],{50557:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>l,contentTitle:()=>c,default:()=>d,frontMatter:()=>a,metadata:()=>r,toc:()=>h});var s=t(62540),i=t(43023);const a={},c="Interface: HealthCheckResults",r={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={},h=[{value:"Properties",id:"properties",level:2},{value:"FailingStreak",id:"failingstreak",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"Log",id:"log",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"Status",id:"status",level:3},{value:"Defined in",id:"defined-in-2",level:4}];function o(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",p:"p",strong:"strong",...(0,i.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.header,{children:(0,s.jsx)(n.h1,{id:"interface-healthcheckresults",children:"Interface: HealthCheckResults"})}),"\n",(0,s.jsx)(n.p,{children:"HealthCheckResults describes the results/logs from a healthcheck"}),"\n",(0,s.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,s.jsx)(n.h3,{id:"failingstreak",children:"FailingStreak"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"FailingStreak"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"FailingStreak is the number of consecutive failed healthchecks"}),"\n",(0,s.jsx)(n.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2513",children:"packages/extension-api/src/extension-api.d.ts:2513"})}),"\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.a,{href:"/api/interfaces/HealthCheckLog",children:(0,s.jsx)(n.code,{children:"HealthCheckLog"})}),"[]"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Log describes healthcheck attempts and results"}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2517",children:"packages/extension-api/src/extension-api.d.ts:2517"})}),"\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.p,{children:"Status is starting, healthy or unhealthy"}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-2",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2509",children:"packages/extension-api/src/extension-api.d.ts:2509"})})]})}function d(e={}){const{wrapper:n}={...(0,i.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(o,{...e})}):o(e)}},43023:(e,n,t)=>{t.d(n,{R:()=>c,x:()=>r});var s=t(63696);const i={},a=s.createContext(i);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(i):e.components||i:c(e.components),s.createElement(a.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/2bb2c1cd.0270841e.js b/assets/js/2bb2c1cd.4fab1170.js similarity index 97% rename from assets/js/2bb2c1cd.0270841e.js rename to assets/js/2bb2c1cd.4fab1170.js index c9cf0a33507..ad90f86e800 100644 --- a/assets/js/2bb2c1cd.0270841e.js +++ b/assets/js/2bb2c1cd.4fab1170.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[67402],{26413:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>d,contentTitle:()=>s,default:()=>l,frontMatter:()=>r,metadata:()=>c,toc:()=>a});var t=i(62540),o=i(43023);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"}},d={},a=[{value:"Properties",id:"properties",level:2},{value:"EndpointsConfig?",id:"endpointsconfig",level:3},{value:"Index Signature",id:"index-signature",level:4},{value:"Defined in",id:"defined-in",level:4}];function p(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",p:"p",strong:"strong",...(0,o.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.header,{children:(0,t.jsx)(n.h1,{id:"interface-networkingconfig",children:"Interface: NetworkingConfig"})}),"\n",(0,t.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,t.jsx)(n.h3,{id:"endpointsconfig",children:"EndpointsConfig?"}),"\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:"EndpointsConfig"}),": ",(0,t.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"index-signature",children:"Index Signature"}),"\n",(0,t.jsxs)(n.p,{children:["[",(0,t.jsx)(n.code,{children:"key"}),": ",(0,t.jsx)(n.code,{children:"string"}),"]: ",(0,t.jsx)(n.a,{href:"/api/interfaces/EndpointSettings",children:(0,t.jsx)(n.code,{children:"EndpointSettings"})})]}),"\n",(0,t.jsx)(n.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2836",children:"packages/extension-api/src/extension-api.d.ts:2836"})})]})}function l(e={}){const{wrapper:n}={...(0,o.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(p,{...e})}):p(e)}},43023:(e,n,i)=>{i.d(n,{R:()=>s,x:()=>c});var t=i(63696);const o={},r=t.createContext(o);function s(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(o):e.components||o:s(e.components),t.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[67402],{26413:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>d,contentTitle:()=>s,default:()=>l,frontMatter:()=>r,metadata:()=>c,toc:()=>a});var t=i(62540),o=i(43023);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"}},d={},a=[{value:"Properties",id:"properties",level:2},{value:"EndpointsConfig?",id:"endpointsconfig",level:3},{value:"Index Signature",id:"index-signature",level:4},{value:"Defined in",id:"defined-in",level:4}];function p(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",p:"p",strong:"strong",...(0,o.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.header,{children:(0,t.jsx)(n.h1,{id:"interface-networkingconfig",children:"Interface: NetworkingConfig"})}),"\n",(0,t.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,t.jsx)(n.h3,{id:"endpointsconfig",children:"EndpointsConfig?"}),"\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:"EndpointsConfig"}),": ",(0,t.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"index-signature",children:"Index Signature"}),"\n",(0,t.jsxs)(n.p,{children:["[",(0,t.jsx)(n.code,{children:"key"}),": ",(0,t.jsx)(n.code,{children:"string"}),"]: ",(0,t.jsx)(n.a,{href:"/api/interfaces/EndpointSettings",children:(0,t.jsx)(n.code,{children:"EndpointSettings"})})]}),"\n",(0,t.jsx)(n.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2836",children:"packages/extension-api/src/extension-api.d.ts:2836"})})]})}function l(e={}){const{wrapper:n}={...(0,o.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(p,{...e})}):p(e)}},43023:(e,n,i)=>{i.d(n,{R:()=>s,x:()=>c});var t=i(63696);const o={},r=t.createContext(o);function s(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(o):e.components||o:s(e.components),t.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/2cb13d6d.f3414af3.js b/assets/js/2cb13d6d.0fc12f7e.js similarity index 85% rename from assets/js/2cb13d6d.f3414af3.js rename to assets/js/2cb13d6d.0fc12f7e.js index f25c746a1cd..3111e03cff0 100644 --- a/assets/js/2cb13d6d.f3414af3.js +++ b/assets/js/2cb13d6d.0fc12f7e.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[78170],{89130:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>d,contentTitle:()=>a,default:()=>h,frontMatter:()=>r,metadata:()=>o,toc:()=>c});var t=i(62540),s=i(43023);const r={},a="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"}},d={},c=[{value:"Properties",id:"properties",level:2},{value:"major",id:"major",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"minor",id:"minor",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"op",id:"op",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"value",id:"value",level:3},{value:"Defined in",id:"defined-in-3",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",p:"p",strong:"strong",...(0,s.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.header,{children:(0,t.jsx)(n.h1,{id:"interface-blkiostatentry",children:"Interface: BlkioStatEntry"})}),"\n",(0,t.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,t.jsx)(n.h3,{id:"major",children:"major"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"major"}),": ",(0,t.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L3069",children:"packages/extension-api/src/extension-api.d.ts:3069"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"minor",children:"minor"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"minor"}),": ",(0,t.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L3070",children:"packages/extension-api/src/extension-api.d.ts:3070"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"op",children:"op"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"op"}),": ",(0,t.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"defined-in-2",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L3071",children:"packages/extension-api/src/extension-api.d.ts:3071"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"value",children:"value"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"value"}),": ",(0,t.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"defined-in-3",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L3072",children:"packages/extension-api/src/extension-api.d.ts:3072"})})]})}function h(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},43023:(e,n,i)=>{i.d(n,{R:()=>a,x:()=>o});var t=i(63696);const s={},r=t.createContext(s);function a(e){const n=t.useContext(r);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:a(e.components),t.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[78170],{89130:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>c,contentTitle:()=>a,default:()=>h,frontMatter:()=>r,metadata:()=>o,toc:()=>d});var t=i(62540),s=i(43023);const r={},a="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"}},c={},d=[{value:"Properties",id:"properties",level:2},{value:"major",id:"major",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"minor",id:"minor",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"op",id:"op",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"value",id:"value",level:3},{value:"Defined in",id:"defined-in-3",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",p:"p",strong:"strong",...(0,s.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.header,{children:(0,t.jsx)(n.h1,{id:"interface-blkiostatentry",children:"Interface: BlkioStatEntry"})}),"\n",(0,t.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,t.jsx)(n.h3,{id:"major",children:"major"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"major"}),": ",(0,t.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L3069",children:"packages/extension-api/src/extension-api.d.ts:3069"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"minor",children:"minor"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"minor"}),": ",(0,t.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L3070",children:"packages/extension-api/src/extension-api.d.ts:3070"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"op",children:"op"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"op"}),": ",(0,t.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"defined-in-2",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L3071",children:"packages/extension-api/src/extension-api.d.ts:3071"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"value",children:"value"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"value"}),": ",(0,t.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"defined-in-3",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L3072",children:"packages/extension-api/src/extension-api.d.ts:3072"})})]})}function h(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},43023:(e,n,i)=>{i.d(n,{R:()=>a,x:()=>o});var t=i(63696);const s={},r=t.createContext(s);function a(e){const n=t.useContext(r);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:a(e.components),t.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/30a9912a.d22aca15.js b/assets/js/30a9912a.e215b8fb.js similarity index 95% rename from assets/js/30a9912a.d22aca15.js rename to assets/js/30a9912a.e215b8fb.js index 340556271c8..a639fb3540c 100644 --- a/assets/js/30a9912a.d22aca15.js +++ b/assets/js/30a9912a.e215b8fb.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[16425],{17496:(e,i,s)=>{s.r(i),s.d(i,{assets:()=>c,contentTitle:()=>a,default:()=>h,frontMatter:()=>d,metadata:()=>l,toc:()=>t});var n=s(62540),r=s(43023);const d={},a="Interface: ImageFilesProvider",l={id:"interfaces/ImageFilesProvider",title:"Interface: ImageFilesProvider",description:"Provider returned to the extension when calling createImageFilesProvider",source:"@site/api/interfaces/ImageFilesProvider.md",sourceDirName:"interfaces",slug:"/interfaces/ImageFilesProvider",permalink:"/api/interfaces/ImageFilesProvider",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"ImageFilesCallbacks",permalink:"/api/interfaces/ImageFilesCallbacks"},next:{title:"ImageFilesProviderMetadata",permalink:"/api/interfaces/ImageFilesProviderMetadata"}},c={},t=[{value:"Extends",id:"extends",level:2},{value:"Methods",id:"methods",level:2},{value:"addDirectory()",id:"adddirectory",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"addFile()",id:"addfile",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"addOpaqueWhiteout()",id:"addopaquewhiteout",level:3},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"addSymlink()",id:"addsymlink",level:3},{value:"Parameters",id:"parameters-3",level:4},{value:"Returns",id:"returns-3",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"addWhiteout()",id:"addwhiteout",level:3},{value:"Parameters",id:"parameters-4",level:4},{value:"Returns",id:"returns-4",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"dispose()",id:"dispose",level:3},{value:"Returns",id:"returns-5",level:4},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in-5",level:4}];function o(e){const i={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",li:"li",p:"p",strong:"strong",ul:"ul",...(0,r.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(i.header,{children:(0,n.jsx)(i.h1,{id:"interface-imagefilesprovider",children:"Interface: ImageFilesProvider"})}),"\n",(0,n.jsxs)(i.p,{children:["Provider returned to the extension when calling createImageFilesProvider\nProvides helper functions for building the response of the ",(0,n.jsx)(i.code,{children:"createImageFilesProvider"})," callback"]}),"\n",(0,n.jsx)(i.h2,{id:"extends",children:"Extends"}),"\n",(0,n.jsxs)(i.ul,{children:["\n",(0,n.jsx)(i.li,{children:(0,n.jsx)(i.a,{href:"/api/classes/Disposable",children:(0,n.jsx)(i.code,{children:"Disposable"})})}),"\n"]}),"\n",(0,n.jsx)(i.h2,{id:"methods",children:"Methods"}),"\n",(0,n.jsx)(i.h3,{id:"adddirectory",children:"addDirectory()"}),"\n",(0,n.jsxs)(i.blockquote,{children:["\n",(0,n.jsxs)(i.p,{children:[(0,n.jsx)(i.strong,{children:"addDirectory"}),"(",(0,n.jsx)(i.code,{children:"layer"}),", ",(0,n.jsx)(i.code,{children:"opts"}),"): ",(0,n.jsx)(i.a,{href:"/api/interfaces/ImageFilesProvider",children:(0,n.jsx)(i.code,{children:"ImageFilesProvider"})})]}),"\n"]}),"\n",(0,n.jsx)(i.p,{children:"add a directory to the layer"}),"\n",(0,n.jsx)(i.h4,{id:"parameters",children:"Parameters"}),"\n",(0,n.jsxs)(i.p,{children:["\u2022 ",(0,n.jsx)(i.strong,{children:"layer"}),": ",(0,n.jsx)(i.a,{href:"/api/interfaces/ImageFilesystemLayer",children:(0,n.jsx)(i.code,{children:"ImageFilesystemLayer"})})]}),"\n",(0,n.jsxs)(i.p,{children:["\u2022 ",(0,n.jsx)(i.strong,{children:"opts"})]}),"\n",(0,n.jsxs)(i.p,{children:["\u2022 ",(0,n.jsx)(i.strong,{children:"opts.mode"}),": ",(0,n.jsx)(i.code,{children:"number"})]}),"\n",(0,n.jsxs)(i.p,{children:["\u2022 ",(0,n.jsx)(i.strong,{children:"opts.path"}),": ",(0,n.jsx)(i.code,{children:"string"})]}),"\n",(0,n.jsx)(i.h4,{id:"returns",children:"Returns"}),"\n",(0,n.jsx)(i.p,{children:(0,n.jsx)(i.a,{href:"/api/interfaces/ImageFilesProvider",children:(0,n.jsx)(i.code,{children:"ImageFilesProvider"})})}),"\n",(0,n.jsx)(i.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,n.jsx)(i.p,{children:(0,n.jsx)(i.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L809",children:"packages/extension-api/src/extension-api.d.ts:809"})}),"\n",(0,n.jsx)(i.hr,{}),"\n",(0,n.jsx)(i.h3,{id:"addfile",children:"addFile()"}),"\n",(0,n.jsxs)(i.blockquote,{children:["\n",(0,n.jsxs)(i.p,{children:[(0,n.jsx)(i.strong,{children:"addFile"}),"(",(0,n.jsx)(i.code,{children:"layer"}),", ",(0,n.jsx)(i.code,{children:"opts"}),"): ",(0,n.jsx)(i.a,{href:"/api/interfaces/ImageFilesProvider",children:(0,n.jsx)(i.code,{children:"ImageFilesProvider"})})]}),"\n"]}),"\n",(0,n.jsx)(i.p,{children:"add a file to the layer"}),"\n",(0,n.jsx)(i.h4,{id:"parameters-1",children:"Parameters"}),"\n",(0,n.jsxs)(i.p,{children:["\u2022 ",(0,n.jsx)(i.strong,{children:"layer"}),": ",(0,n.jsx)(i.a,{href:"/api/interfaces/ImageFilesystemLayer",children:(0,n.jsx)(i.code,{children:"ImageFilesystemLayer"})})]}),"\n",(0,n.jsxs)(i.p,{children:["\u2022 ",(0,n.jsx)(i.strong,{children:"opts"})]}),"\n",(0,n.jsxs)(i.p,{children:["\u2022 ",(0,n.jsx)(i.strong,{children:"opts.mode"}),": ",(0,n.jsx)(i.code,{children:"number"})]}),"\n",(0,n.jsxs)(i.p,{children:["\u2022 ",(0,n.jsx)(i.strong,{children:"opts.path"}),": ",(0,n.jsx)(i.code,{children:"string"})]}),"\n",(0,n.jsxs)(i.p,{children:["\u2022 ",(0,n.jsx)(i.strong,{children:"opts.size"}),": ",(0,n.jsx)(i.code,{children:"number"})]}),"\n",(0,n.jsx)(i.h4,{id:"returns-1",children:"Returns"}),"\n",(0,n.jsx)(i.p,{children:(0,n.jsx)(i.a,{href:"/api/interfaces/ImageFilesProvider",children:(0,n.jsx)(i.code,{children:"ImageFilesProvider"})})}),"\n",(0,n.jsx)(i.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,n.jsx)(i.p,{children:(0,n.jsx)(i.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L805",children:"packages/extension-api/src/extension-api.d.ts:805"})}),"\n",(0,n.jsx)(i.hr,{}),"\n",(0,n.jsx)(i.h3,{id:"addopaquewhiteout",children:"addOpaqueWhiteout()"}),"\n",(0,n.jsxs)(i.blockquote,{children:["\n",(0,n.jsxs)(i.p,{children:[(0,n.jsx)(i.strong,{children:"addOpaqueWhiteout"}),"(",(0,n.jsx)(i.code,{children:"layer"}),", ",(0,n.jsx)(i.code,{children:"path"}),"): ",(0,n.jsx)(i.a,{href:"/api/interfaces/ImageFilesProvider",children:(0,n.jsx)(i.code,{children:"ImageFilesProvider"})})]}),"\n"]}),"\n",(0,n.jsx)(i.p,{children:"add a complete directory to remove from previous layers"}),"\n",(0,n.jsx)(i.h4,{id:"parameters-2",children:"Parameters"}),"\n",(0,n.jsxs)(i.p,{children:["\u2022 ",(0,n.jsx)(i.strong,{children:"layer"}),": ",(0,n.jsx)(i.a,{href:"/api/interfaces/ImageFilesystemLayer",children:(0,n.jsx)(i.code,{children:"ImageFilesystemLayer"})})]}),"\n",(0,n.jsxs)(i.p,{children:["\u2022 ",(0,n.jsx)(i.strong,{children:"path"}),": ",(0,n.jsx)(i.code,{children:"string"})]}),"\n",(0,n.jsx)(i.h4,{id:"returns-2",children:"Returns"}),"\n",(0,n.jsx)(i.p,{children:(0,n.jsx)(i.a,{href:"/api/interfaces/ImageFilesProvider",children:(0,n.jsx)(i.code,{children:"ImageFilesProvider"})})}),"\n",(0,n.jsx)(i.h4,{id:"defined-in-2",children:"Defined in"}),"\n",(0,n.jsx)(i.p,{children:(0,n.jsx)(i.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L823",children:"packages/extension-api/src/extension-api.d.ts:823"})}),"\n",(0,n.jsx)(i.hr,{}),"\n",(0,n.jsx)(i.h3,{id:"addsymlink",children:"addSymlink()"}),"\n",(0,n.jsxs)(i.blockquote,{children:["\n",(0,n.jsxs)(i.p,{children:[(0,n.jsx)(i.strong,{children:"addSymlink"}),"(",(0,n.jsx)(i.code,{children:"layer"}),", ",(0,n.jsx)(i.code,{children:"opts"}),"): ",(0,n.jsx)(i.a,{href:"/api/interfaces/ImageFilesProvider",children:(0,n.jsx)(i.code,{children:"ImageFilesProvider"})})]}),"\n"]}),"\n",(0,n.jsx)(i.p,{children:"add a symbolic link to the layer"}),"\n",(0,n.jsx)(i.h4,{id:"parameters-3",children:"Parameters"}),"\n",(0,n.jsxs)(i.p,{children:["\u2022 ",(0,n.jsx)(i.strong,{children:"layer"}),": ",(0,n.jsx)(i.a,{href:"/api/interfaces/ImageFilesystemLayer",children:(0,n.jsx)(i.code,{children:"ImageFilesystemLayer"})})]}),"\n",(0,n.jsxs)(i.p,{children:["\u2022 ",(0,n.jsx)(i.strong,{children:"opts"})]}),"\n",(0,n.jsxs)(i.p,{children:["\u2022 ",(0,n.jsx)(i.strong,{children:"opts.linkPath"}),": ",(0,n.jsx)(i.code,{children:"string"})]}),"\n",(0,n.jsxs)(i.p,{children:["\u2022 ",(0,n.jsx)(i.strong,{children:"opts.mode"}),": ",(0,n.jsx)(i.code,{children:"number"})]}),"\n",(0,n.jsxs)(i.p,{children:["\u2022 ",(0,n.jsx)(i.strong,{children:"opts.path"}),": ",(0,n.jsx)(i.code,{children:"string"})]}),"\n",(0,n.jsx)(i.h4,{id:"returns-3",children:"Returns"}),"\n",(0,n.jsx)(i.p,{children:(0,n.jsx)(i.a,{href:"/api/interfaces/ImageFilesProvider",children:(0,n.jsx)(i.code,{children:"ImageFilesProvider"})})}),"\n",(0,n.jsx)(i.h4,{id:"defined-in-3",children:"Defined in"}),"\n",(0,n.jsx)(i.p,{children:(0,n.jsx)(i.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L813",children:"packages/extension-api/src/extension-api.d.ts:813"})}),"\n",(0,n.jsx)(i.hr,{}),"\n",(0,n.jsx)(i.h3,{id:"addwhiteout",children:"addWhiteout()"}),"\n",(0,n.jsxs)(i.blockquote,{children:["\n",(0,n.jsxs)(i.p,{children:[(0,n.jsx)(i.strong,{children:"addWhiteout"}),"(",(0,n.jsx)(i.code,{children:"layer"}),", ",(0,n.jsx)(i.code,{children:"path"}),"): ",(0,n.jsx)(i.a,{href:"/api/interfaces/ImageFilesProvider",children:(0,n.jsx)(i.code,{children:"ImageFilesProvider"})})]}),"\n"]}),"\n",(0,n.jsx)(i.p,{children:"add a file or directory to remove from previous layers"}),"\n",(0,n.jsx)(i.h4,{id:"parameters-4",children:"Parameters"}),"\n",(0,n.jsxs)(i.p,{children:["\u2022 ",(0,n.jsx)(i.strong,{children:"layer"}),": ",(0,n.jsx)(i.a,{href:"/api/interfaces/ImageFilesystemLayer",children:(0,n.jsx)(i.code,{children:"ImageFilesystemLayer"})})]}),"\n",(0,n.jsxs)(i.p,{children:["\u2022 ",(0,n.jsx)(i.strong,{children:"path"}),": ",(0,n.jsx)(i.code,{children:"string"})]}),"\n",(0,n.jsx)(i.h4,{id:"returns-4",children:"Returns"}),"\n",(0,n.jsx)(i.p,{children:(0,n.jsx)(i.a,{href:"/api/interfaces/ImageFilesProvider",children:(0,n.jsx)(i.code,{children:"ImageFilesProvider"})})}),"\n",(0,n.jsx)(i.h4,{id:"defined-in-4",children:"Defined in"}),"\n",(0,n.jsx)(i.p,{children:(0,n.jsx)(i.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L818",children:"packages/extension-api/src/extension-api.d.ts:818"})}),"\n",(0,n.jsx)(i.hr,{}),"\n",(0,n.jsx)(i.h3,{id:"dispose",children:"dispose()"}),"\n",(0,n.jsxs)(i.blockquote,{children:["\n",(0,n.jsxs)(i.p,{children:[(0,n.jsx)(i.strong,{children:"dispose"}),"(): ",(0,n.jsx)(i.code,{children:"void"})]}),"\n"]}),"\n",(0,n.jsx)(i.p,{children:"Dispose this object."}),"\n",(0,n.jsx)(i.h4,{id:"returns-5",children:"Returns"}),"\n",(0,n.jsx)(i.p,{children:(0,n.jsx)(i.code,{children:"void"})}),"\n",(0,n.jsx)(i.h4,{id:"inherited-from",children:"Inherited from"}),"\n",(0,n.jsxs)(i.p,{children:[(0,n.jsx)(i.a,{href:"/api/classes/Disposable",children:(0,n.jsx)(i.code,{children:"Disposable"})}),".",(0,n.jsx)(i.a,{href:"/api/classes/Disposable#dispose",children:(0,n.jsx)(i.code,{children:"dispose"})})]}),"\n",(0,n.jsx)(i.h4,{id:"defined-in-5",children:"Defined in"}),"\n",(0,n.jsx)(i.p,{children:(0,n.jsx)(i.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L97",children:"packages/extension-api/src/extension-api.d.ts:97"})})]})}function h(e={}){const{wrapper:i}={...(0,r.R)(),...e.components};return i?(0,n.jsx)(i,{...e,children:(0,n.jsx)(o,{...e})}):o(e)}},43023:(e,i,s)=>{s.d(i,{R:()=>a,x:()=>l});var n=s(63696);const r={},d=n.createContext(r);function a(e){const i=n.useContext(d);return n.useMemo((function(){return"function"==typeof e?e(i):{...i,...e}}),[i,e])}function l(e){let i;return i=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:a(e.components),n.createElement(d.Provider,{value:i},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[16425],{17496:(e,i,s)=>{s.r(i),s.d(i,{assets:()=>c,contentTitle:()=>a,default:()=>h,frontMatter:()=>d,metadata:()=>l,toc:()=>t});var n=s(62540),r=s(43023);const d={},a="Interface: ImageFilesProvider",l={id:"interfaces/ImageFilesProvider",title:"Interface: ImageFilesProvider",description:"Provider returned to the extension when calling createImageFilesProvider",source:"@site/api/interfaces/ImageFilesProvider.md",sourceDirName:"interfaces",slug:"/interfaces/ImageFilesProvider",permalink:"/api/interfaces/ImageFilesProvider",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"ImageFilesCallbacks",permalink:"/api/interfaces/ImageFilesCallbacks"},next:{title:"ImageFilesProviderMetadata",permalink:"/api/interfaces/ImageFilesProviderMetadata"}},c={},t=[{value:"Extends",id:"extends",level:2},{value:"Methods",id:"methods",level:2},{value:"addDirectory()",id:"adddirectory",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"addFile()",id:"addfile",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"addOpaqueWhiteout()",id:"addopaquewhiteout",level:3},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"addSymlink()",id:"addsymlink",level:3},{value:"Parameters",id:"parameters-3",level:4},{value:"Returns",id:"returns-3",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"addWhiteout()",id:"addwhiteout",level:3},{value:"Parameters",id:"parameters-4",level:4},{value:"Returns",id:"returns-4",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"dispose()",id:"dispose",level:3},{value:"Returns",id:"returns-5",level:4},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in-5",level:4}];function o(e){const i={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",li:"li",p:"p",strong:"strong",ul:"ul",...(0,r.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(i.header,{children:(0,n.jsx)(i.h1,{id:"interface-imagefilesprovider",children:"Interface: ImageFilesProvider"})}),"\n",(0,n.jsxs)(i.p,{children:["Provider returned to the extension when calling createImageFilesProvider\nProvides helper functions for building the response of the ",(0,n.jsx)(i.code,{children:"createImageFilesProvider"})," callback"]}),"\n",(0,n.jsx)(i.h2,{id:"extends",children:"Extends"}),"\n",(0,n.jsxs)(i.ul,{children:["\n",(0,n.jsx)(i.li,{children:(0,n.jsx)(i.a,{href:"/api/classes/Disposable",children:(0,n.jsx)(i.code,{children:"Disposable"})})}),"\n"]}),"\n",(0,n.jsx)(i.h2,{id:"methods",children:"Methods"}),"\n",(0,n.jsx)(i.h3,{id:"adddirectory",children:"addDirectory()"}),"\n",(0,n.jsxs)(i.blockquote,{children:["\n",(0,n.jsxs)(i.p,{children:[(0,n.jsx)(i.strong,{children:"addDirectory"}),"(",(0,n.jsx)(i.code,{children:"layer"}),", ",(0,n.jsx)(i.code,{children:"opts"}),"): ",(0,n.jsx)(i.a,{href:"/api/interfaces/ImageFilesProvider",children:(0,n.jsx)(i.code,{children:"ImageFilesProvider"})})]}),"\n"]}),"\n",(0,n.jsx)(i.p,{children:"add a directory to the layer"}),"\n",(0,n.jsx)(i.h4,{id:"parameters",children:"Parameters"}),"\n",(0,n.jsxs)(i.p,{children:["\u2022 ",(0,n.jsx)(i.strong,{children:"layer"}),": ",(0,n.jsx)(i.a,{href:"/api/interfaces/ImageFilesystemLayer",children:(0,n.jsx)(i.code,{children:"ImageFilesystemLayer"})})]}),"\n",(0,n.jsxs)(i.p,{children:["\u2022 ",(0,n.jsx)(i.strong,{children:"opts"})]}),"\n",(0,n.jsxs)(i.p,{children:["\u2022 ",(0,n.jsx)(i.strong,{children:"opts.mode"}),": ",(0,n.jsx)(i.code,{children:"number"})]}),"\n",(0,n.jsxs)(i.p,{children:["\u2022 ",(0,n.jsx)(i.strong,{children:"opts.path"}),": ",(0,n.jsx)(i.code,{children:"string"})]}),"\n",(0,n.jsx)(i.h4,{id:"returns",children:"Returns"}),"\n",(0,n.jsx)(i.p,{children:(0,n.jsx)(i.a,{href:"/api/interfaces/ImageFilesProvider",children:(0,n.jsx)(i.code,{children:"ImageFilesProvider"})})}),"\n",(0,n.jsx)(i.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,n.jsx)(i.p,{children:(0,n.jsx)(i.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L809",children:"packages/extension-api/src/extension-api.d.ts:809"})}),"\n",(0,n.jsx)(i.hr,{}),"\n",(0,n.jsx)(i.h3,{id:"addfile",children:"addFile()"}),"\n",(0,n.jsxs)(i.blockquote,{children:["\n",(0,n.jsxs)(i.p,{children:[(0,n.jsx)(i.strong,{children:"addFile"}),"(",(0,n.jsx)(i.code,{children:"layer"}),", ",(0,n.jsx)(i.code,{children:"opts"}),"): ",(0,n.jsx)(i.a,{href:"/api/interfaces/ImageFilesProvider",children:(0,n.jsx)(i.code,{children:"ImageFilesProvider"})})]}),"\n"]}),"\n",(0,n.jsx)(i.p,{children:"add a file to the layer"}),"\n",(0,n.jsx)(i.h4,{id:"parameters-1",children:"Parameters"}),"\n",(0,n.jsxs)(i.p,{children:["\u2022 ",(0,n.jsx)(i.strong,{children:"layer"}),": ",(0,n.jsx)(i.a,{href:"/api/interfaces/ImageFilesystemLayer",children:(0,n.jsx)(i.code,{children:"ImageFilesystemLayer"})})]}),"\n",(0,n.jsxs)(i.p,{children:["\u2022 ",(0,n.jsx)(i.strong,{children:"opts"})]}),"\n",(0,n.jsxs)(i.p,{children:["\u2022 ",(0,n.jsx)(i.strong,{children:"opts.mode"}),": ",(0,n.jsx)(i.code,{children:"number"})]}),"\n",(0,n.jsxs)(i.p,{children:["\u2022 ",(0,n.jsx)(i.strong,{children:"opts.path"}),": ",(0,n.jsx)(i.code,{children:"string"})]}),"\n",(0,n.jsxs)(i.p,{children:["\u2022 ",(0,n.jsx)(i.strong,{children:"opts.size"}),": ",(0,n.jsx)(i.code,{children:"number"})]}),"\n",(0,n.jsx)(i.h4,{id:"returns-1",children:"Returns"}),"\n",(0,n.jsx)(i.p,{children:(0,n.jsx)(i.a,{href:"/api/interfaces/ImageFilesProvider",children:(0,n.jsx)(i.code,{children:"ImageFilesProvider"})})}),"\n",(0,n.jsx)(i.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,n.jsx)(i.p,{children:(0,n.jsx)(i.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L805",children:"packages/extension-api/src/extension-api.d.ts:805"})}),"\n",(0,n.jsx)(i.hr,{}),"\n",(0,n.jsx)(i.h3,{id:"addopaquewhiteout",children:"addOpaqueWhiteout()"}),"\n",(0,n.jsxs)(i.blockquote,{children:["\n",(0,n.jsxs)(i.p,{children:[(0,n.jsx)(i.strong,{children:"addOpaqueWhiteout"}),"(",(0,n.jsx)(i.code,{children:"layer"}),", ",(0,n.jsx)(i.code,{children:"path"}),"): ",(0,n.jsx)(i.a,{href:"/api/interfaces/ImageFilesProvider",children:(0,n.jsx)(i.code,{children:"ImageFilesProvider"})})]}),"\n"]}),"\n",(0,n.jsx)(i.p,{children:"add a complete directory to remove from previous layers"}),"\n",(0,n.jsx)(i.h4,{id:"parameters-2",children:"Parameters"}),"\n",(0,n.jsxs)(i.p,{children:["\u2022 ",(0,n.jsx)(i.strong,{children:"layer"}),": ",(0,n.jsx)(i.a,{href:"/api/interfaces/ImageFilesystemLayer",children:(0,n.jsx)(i.code,{children:"ImageFilesystemLayer"})})]}),"\n",(0,n.jsxs)(i.p,{children:["\u2022 ",(0,n.jsx)(i.strong,{children:"path"}),": ",(0,n.jsx)(i.code,{children:"string"})]}),"\n",(0,n.jsx)(i.h4,{id:"returns-2",children:"Returns"}),"\n",(0,n.jsx)(i.p,{children:(0,n.jsx)(i.a,{href:"/api/interfaces/ImageFilesProvider",children:(0,n.jsx)(i.code,{children:"ImageFilesProvider"})})}),"\n",(0,n.jsx)(i.h4,{id:"defined-in-2",children:"Defined in"}),"\n",(0,n.jsx)(i.p,{children:(0,n.jsx)(i.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L823",children:"packages/extension-api/src/extension-api.d.ts:823"})}),"\n",(0,n.jsx)(i.hr,{}),"\n",(0,n.jsx)(i.h3,{id:"addsymlink",children:"addSymlink()"}),"\n",(0,n.jsxs)(i.blockquote,{children:["\n",(0,n.jsxs)(i.p,{children:[(0,n.jsx)(i.strong,{children:"addSymlink"}),"(",(0,n.jsx)(i.code,{children:"layer"}),", ",(0,n.jsx)(i.code,{children:"opts"}),"): ",(0,n.jsx)(i.a,{href:"/api/interfaces/ImageFilesProvider",children:(0,n.jsx)(i.code,{children:"ImageFilesProvider"})})]}),"\n"]}),"\n",(0,n.jsx)(i.p,{children:"add a symbolic link to the layer"}),"\n",(0,n.jsx)(i.h4,{id:"parameters-3",children:"Parameters"}),"\n",(0,n.jsxs)(i.p,{children:["\u2022 ",(0,n.jsx)(i.strong,{children:"layer"}),": ",(0,n.jsx)(i.a,{href:"/api/interfaces/ImageFilesystemLayer",children:(0,n.jsx)(i.code,{children:"ImageFilesystemLayer"})})]}),"\n",(0,n.jsxs)(i.p,{children:["\u2022 ",(0,n.jsx)(i.strong,{children:"opts"})]}),"\n",(0,n.jsxs)(i.p,{children:["\u2022 ",(0,n.jsx)(i.strong,{children:"opts.linkPath"}),": ",(0,n.jsx)(i.code,{children:"string"})]}),"\n",(0,n.jsxs)(i.p,{children:["\u2022 ",(0,n.jsx)(i.strong,{children:"opts.mode"}),": ",(0,n.jsx)(i.code,{children:"number"})]}),"\n",(0,n.jsxs)(i.p,{children:["\u2022 ",(0,n.jsx)(i.strong,{children:"opts.path"}),": ",(0,n.jsx)(i.code,{children:"string"})]}),"\n",(0,n.jsx)(i.h4,{id:"returns-3",children:"Returns"}),"\n",(0,n.jsx)(i.p,{children:(0,n.jsx)(i.a,{href:"/api/interfaces/ImageFilesProvider",children:(0,n.jsx)(i.code,{children:"ImageFilesProvider"})})}),"\n",(0,n.jsx)(i.h4,{id:"defined-in-3",children:"Defined in"}),"\n",(0,n.jsx)(i.p,{children:(0,n.jsx)(i.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L813",children:"packages/extension-api/src/extension-api.d.ts:813"})}),"\n",(0,n.jsx)(i.hr,{}),"\n",(0,n.jsx)(i.h3,{id:"addwhiteout",children:"addWhiteout()"}),"\n",(0,n.jsxs)(i.blockquote,{children:["\n",(0,n.jsxs)(i.p,{children:[(0,n.jsx)(i.strong,{children:"addWhiteout"}),"(",(0,n.jsx)(i.code,{children:"layer"}),", ",(0,n.jsx)(i.code,{children:"path"}),"): ",(0,n.jsx)(i.a,{href:"/api/interfaces/ImageFilesProvider",children:(0,n.jsx)(i.code,{children:"ImageFilesProvider"})})]}),"\n"]}),"\n",(0,n.jsx)(i.p,{children:"add a file or directory to remove from previous layers"}),"\n",(0,n.jsx)(i.h4,{id:"parameters-4",children:"Parameters"}),"\n",(0,n.jsxs)(i.p,{children:["\u2022 ",(0,n.jsx)(i.strong,{children:"layer"}),": ",(0,n.jsx)(i.a,{href:"/api/interfaces/ImageFilesystemLayer",children:(0,n.jsx)(i.code,{children:"ImageFilesystemLayer"})})]}),"\n",(0,n.jsxs)(i.p,{children:["\u2022 ",(0,n.jsx)(i.strong,{children:"path"}),": ",(0,n.jsx)(i.code,{children:"string"})]}),"\n",(0,n.jsx)(i.h4,{id:"returns-4",children:"Returns"}),"\n",(0,n.jsx)(i.p,{children:(0,n.jsx)(i.a,{href:"/api/interfaces/ImageFilesProvider",children:(0,n.jsx)(i.code,{children:"ImageFilesProvider"})})}),"\n",(0,n.jsx)(i.h4,{id:"defined-in-4",children:"Defined in"}),"\n",(0,n.jsx)(i.p,{children:(0,n.jsx)(i.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L818",children:"packages/extension-api/src/extension-api.d.ts:818"})}),"\n",(0,n.jsx)(i.hr,{}),"\n",(0,n.jsx)(i.h3,{id:"dispose",children:"dispose()"}),"\n",(0,n.jsxs)(i.blockquote,{children:["\n",(0,n.jsxs)(i.p,{children:[(0,n.jsx)(i.strong,{children:"dispose"}),"(): ",(0,n.jsx)(i.code,{children:"void"})]}),"\n"]}),"\n",(0,n.jsx)(i.p,{children:"Dispose this object."}),"\n",(0,n.jsx)(i.h4,{id:"returns-5",children:"Returns"}),"\n",(0,n.jsx)(i.p,{children:(0,n.jsx)(i.code,{children:"void"})}),"\n",(0,n.jsx)(i.h4,{id:"inherited-from",children:"Inherited from"}),"\n",(0,n.jsxs)(i.p,{children:[(0,n.jsx)(i.a,{href:"/api/classes/Disposable",children:(0,n.jsx)(i.code,{children:"Disposable"})}),".",(0,n.jsx)(i.a,{href:"/api/classes/Disposable#dispose",children:(0,n.jsx)(i.code,{children:"dispose"})})]}),"\n",(0,n.jsx)(i.h4,{id:"defined-in-5",children:"Defined in"}),"\n",(0,n.jsx)(i.p,{children:(0,n.jsx)(i.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L97",children:"packages/extension-api/src/extension-api.d.ts:97"})})]})}function h(e={}){const{wrapper:i}={...(0,r.R)(),...e.components};return i?(0,n.jsx)(i,{...e,children:(0,n.jsx)(o,{...e})}):o(e)}},43023:(e,i,s)=>{s.d(i,{R:()=>a,x:()=>l});var n=s(63696);const r={},d=n.createContext(r);function a(e){const i=n.useContext(d);return n.useMemo((function(){return"function"==typeof e?e(i):{...i,...e}}),[i,e])}function l(e){let i;return i=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:a(e.components),n.createElement(d.Provider,{value:i},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/3109d9d2.44f2bcef.js b/assets/js/3109d9d2.fbcf90c1.js similarity index 96% rename from assets/js/3109d9d2.44f2bcef.js rename to assets/js/3109d9d2.fbcf90c1.js index fd57d180edb..40252de9d2a 100644 --- a/assets/js/3109d9d2.44f2bcef.js +++ b/assets/js/3109d9d2.fbcf90c1.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[36049],{68989:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>d,contentTitle:()=>r,default:()=>h,frontMatter:()=>o,metadata:()=>t,toc:()=>l});var s=i(62540),c=i(43023);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:"Defined in",id:"defined-in",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:"Defined in",id:"defined-in-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:"Defined in",id:"defined-in-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:"Defined in",id:"defined-in-3",level:3}];function a(e){const n={a:"a",blockquote:"blockquote",code:"code",em:"em",h1:"h1",h2:"h2",h3:"h3",header:"header",p:"p",strong:"strong",...(0,c.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.header,{children:(0,s.jsx)(n.h1,{id:"function-showquickpick",children:"Function: showQuickPick()"})}),"\n",(0,s.jsx)(n.h2,{id:"showquickpickitems-options-token",children:"showQuickPick(items, options, token)"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"showQuickPick"}),"(",(0,s.jsx)(n.code,{children:"items"}),", ",(0,s.jsx)(n.code,{children:"options"}),", ",(0,s.jsx)(n.code,{children:"token"}),"?): ",(0,s.jsx)(n.code,{children:"Promise"}),"<",(0,s.jsx)(n.code,{children:"string"}),"[] | ",(0,s.jsx)(n.code,{children:"undefined"}),">"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Shows a selection list allowing multiple selections."}),"\n",(0,s.jsx)(n.h3,{id:"parameters",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"items"}),": readonly ",(0,s.jsx)(n.code,{children:"string"}),"[] | ",(0,s.jsx)(n.code,{children:"Promise"}),""]}),"\n",(0,s.jsx)(n.p,{children:"An array of strings, or a promise that resolves to an array of strings."}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"options"}),": ",(0,s.jsx)(n.a,{href:"/api/interfaces/QuickPickOptions",children:(0,s.jsx)(n.code,{children:"QuickPickOptions"})})," & ",(0,s.jsx)(n.code,{children:"object"})]}),"\n",(0,s.jsx)(n.p,{children:"Configures the behavior of the selection list."}),"\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.p,{children:"A token that can be used to signal cancellation."}),"\n",(0,s.jsx)(n.h3,{id:"returns",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"Promise"}),"<",(0,s.jsx)(n.code,{children:"string"}),"[] | ",(0,s.jsx)(n.code,{children:"undefined"}),">"]}),"\n",(0,s.jsxs)(n.p,{children:["A promise that resolves to the selected items or ",(0,s.jsx)(n.code,{children:"undefined"}),"."]}),"\n",(0,s.jsx)(n.h3,{id:"defined-in",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2033",children:"packages/extension-api/src/extension-api.d.ts:2033"})}),"\n",(0,s.jsx)(n.h2,{id:"showquickpickitems-options-token-1",children:"showQuickPick(items, options, token)"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"showQuickPick"}),"(",(0,s.jsx)(n.code,{children:"items"}),", ",(0,s.jsx)(n.code,{children:"options"}),"?, ",(0,s.jsx)(n.code,{children:"token"}),"?): ",(0,s.jsx)(n.code,{children:"Promise"}),"<",(0,s.jsx)(n.code,{children:"string"})," | ",(0,s.jsx)(n.code,{children:"undefined"}),">"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Shows a selection list."}),"\n",(0,s.jsx)(n.h3,{id:"parameters-1",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"items"}),": readonly ",(0,s.jsx)(n.code,{children:"string"}),"[] | ",(0,s.jsx)(n.code,{children:"Promise"}),""]}),"\n",(0,s.jsx)(n.p,{children:"An array of strings, or a promise that resolves to an array of strings."}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"options?"}),": ",(0,s.jsx)(n.a,{href:"/api/interfaces/QuickPickOptions",children:(0,s.jsx)(n.code,{children:"QuickPickOptions"})})]}),"\n",(0,s.jsx)(n.p,{children:"Configures the behavior of the selection list."}),"\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.p,{children:"A token that can be used to signal cancellation."}),"\n",(0,s.jsx)(n.h3,{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:"string"})," | ",(0,s.jsx)(n.code,{children:"undefined"}),">"]}),"\n",(0,s.jsxs)(n.p,{children:["A promise that resolves to the selection or ",(0,s.jsx)(n.code,{children:"undefined"}),"."]}),"\n",(0,s.jsx)(n.h3,{id:"defined-in-1",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2047",children:"packages/extension-api/src/extension-api.d.ts:2047"})}),"\n",(0,s.jsx)(n.h2,{id:"showquickpickitems-options-token-2",children:"showQuickPick(items, options, token)"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"showQuickPick"}),"<",(0,s.jsx)(n.code,{children:"T"}),">(",(0,s.jsx)(n.code,{children:"items"}),", ",(0,s.jsx)(n.code,{children:"options"}),", ",(0,s.jsx)(n.code,{children:"token"}),"?): ",(0,s.jsx)(n.code,{children:"Promise"}),"<",(0,s.jsx)(n.code,{children:"T"}),"[] | ",(0,s.jsx)(n.code,{children:"undefined"}),">"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Shows a selection list allowing multiple selections."}),"\n",(0,s.jsx)(n.h3,{id:"type-parameters",children:"Type Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"T"})," ",(0,s.jsx)(n.em,{children:"extends"})," ",(0,s.jsx)(n.a,{href:"/api/interfaces/QuickPickItem",children:(0,s.jsx)(n.code,{children:"QuickPickItem"})})]}),"\n",(0,s.jsx)(n.h3,{id:"parameters-2",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"items"}),": readonly ",(0,s.jsx)(n.code,{children:"T"}),"[] | ",(0,s.jsx)(n.code,{children:"Promise"}),""]}),"\n",(0,s.jsx)(n.p,{children:"An array of items, or a promise that resolves to an array of items."}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"options"}),": ",(0,s.jsx)(n.a,{href:"/api/interfaces/QuickPickOptions",children:(0,s.jsx)(n.code,{children:"QuickPickOptions"})})," & ",(0,s.jsx)(n.code,{children:"object"})]}),"\n",(0,s.jsx)(n.p,{children:"Configures the behavior of the selection list."}),"\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.p,{children:"A token that can be used to signal cancellation."}),"\n",(0,s.jsx)(n.h3,{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:"T"}),"[] | ",(0,s.jsx)(n.code,{children:"undefined"}),">"]}),"\n",(0,s.jsxs)(n.p,{children:["A promise that resolves to the selected items or ",(0,s.jsx)(n.code,{children:"undefined"}),"."]}),"\n",(0,s.jsx)(n.h3,{id:"defined-in-2",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2061",children:"packages/extension-api/src/extension-api.d.ts:2061"})}),"\n",(0,s.jsx)(n.h2,{id:"showquickpickitems-options-token-3",children:"showQuickPick(items, options, token)"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"showQuickPick"}),"<",(0,s.jsx)(n.code,{children:"T"}),">(",(0,s.jsx)(n.code,{children:"items"}),", ",(0,s.jsx)(n.code,{children:"options"}),"?, ",(0,s.jsx)(n.code,{children:"token"}),"?): ",(0,s.jsx)(n.code,{children:"Promise"}),"<",(0,s.jsx)(n.code,{children:"T"})," | ",(0,s.jsx)(n.code,{children:"undefined"}),">"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Shows a selection list."}),"\n",(0,s.jsx)(n.h3,{id:"type-parameters-1",children:"Type Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"T"})," ",(0,s.jsx)(n.em,{children:"extends"})," ",(0,s.jsx)(n.a,{href:"/api/interfaces/QuickPickItem",children:(0,s.jsx)(n.code,{children:"QuickPickItem"})})]}),"\n",(0,s.jsx)(n.h3,{id:"parameters-3",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"items"}),": readonly ",(0,s.jsx)(n.code,{children:"T"}),"[] | ",(0,s.jsx)(n.code,{children:"Promise"}),""]}),"\n",(0,s.jsx)(n.p,{children:"An array of items, or a promise that resolves to an array of items."}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"options?"}),": ",(0,s.jsx)(n.a,{href:"/api/interfaces/QuickPickOptions",children:(0,s.jsx)(n.code,{children:"QuickPickOptions"})})]}),"\n",(0,s.jsx)(n.p,{children:"Configures the behavior of the selection list."}),"\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.p,{children:"A token that can be used to signal cancellation."}),"\n",(0,s.jsx)(n.h3,{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:"T"})," | ",(0,s.jsx)(n.code,{children:"undefined"}),">"]}),"\n",(0,s.jsxs)(n.p,{children:["A promise that resolves to the selected item or ",(0,s.jsx)(n.code,{children:"undefined"}),"."]}),"\n",(0,s.jsx)(n.h3,{id:"defined-in-3",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2075",children:"packages/extension-api/src/extension-api.d.ts:2075"})})]})}function h(e={}){const{wrapper:n}={...(0,c.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(a,{...e})}):a(e)}},43023:(e,n,i)=>{i.d(n,{R:()=>r,x:()=>t});var s=i(63696);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 t(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 +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[36049],{68989:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>d,contentTitle:()=>r,default:()=>h,frontMatter:()=>o,metadata:()=>t,toc:()=>l});var s=i(62540),c=i(43023);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:"Defined in",id:"defined-in",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:"Defined in",id:"defined-in-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:"Defined in",id:"defined-in-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:"Defined in",id:"defined-in-3",level:3}];function a(e){const n={a:"a",blockquote:"blockquote",code:"code",em:"em",h1:"h1",h2:"h2",h3:"h3",header:"header",p:"p",strong:"strong",...(0,c.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.header,{children:(0,s.jsx)(n.h1,{id:"function-showquickpick",children:"Function: showQuickPick()"})}),"\n",(0,s.jsx)(n.h2,{id:"showquickpickitems-options-token",children:"showQuickPick(items, options, token)"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"showQuickPick"}),"(",(0,s.jsx)(n.code,{children:"items"}),", ",(0,s.jsx)(n.code,{children:"options"}),", ",(0,s.jsx)(n.code,{children:"token"}),"?): ",(0,s.jsx)(n.code,{children:"Promise"}),"<",(0,s.jsx)(n.code,{children:"string"}),"[] | ",(0,s.jsx)(n.code,{children:"undefined"}),">"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Shows a selection list allowing multiple selections."}),"\n",(0,s.jsx)(n.h3,{id:"parameters",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"items"}),": readonly ",(0,s.jsx)(n.code,{children:"string"}),"[] | ",(0,s.jsx)(n.code,{children:"Promise"}),""]}),"\n",(0,s.jsx)(n.p,{children:"An array of strings, or a promise that resolves to an array of strings."}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"options"}),": ",(0,s.jsx)(n.a,{href:"/api/interfaces/QuickPickOptions",children:(0,s.jsx)(n.code,{children:"QuickPickOptions"})})," & ",(0,s.jsx)(n.code,{children:"object"})]}),"\n",(0,s.jsx)(n.p,{children:"Configures the behavior of the selection list."}),"\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.p,{children:"A token that can be used to signal cancellation."}),"\n",(0,s.jsx)(n.h3,{id:"returns",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"Promise"}),"<",(0,s.jsx)(n.code,{children:"string"}),"[] | ",(0,s.jsx)(n.code,{children:"undefined"}),">"]}),"\n",(0,s.jsxs)(n.p,{children:["A promise that resolves to the selected items or ",(0,s.jsx)(n.code,{children:"undefined"}),"."]}),"\n",(0,s.jsx)(n.h3,{id:"defined-in",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2033",children:"packages/extension-api/src/extension-api.d.ts:2033"})}),"\n",(0,s.jsx)(n.h2,{id:"showquickpickitems-options-token-1",children:"showQuickPick(items, options, token)"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"showQuickPick"}),"(",(0,s.jsx)(n.code,{children:"items"}),", ",(0,s.jsx)(n.code,{children:"options"}),"?, ",(0,s.jsx)(n.code,{children:"token"}),"?): ",(0,s.jsx)(n.code,{children:"Promise"}),"<",(0,s.jsx)(n.code,{children:"string"})," | ",(0,s.jsx)(n.code,{children:"undefined"}),">"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Shows a selection list."}),"\n",(0,s.jsx)(n.h3,{id:"parameters-1",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"items"}),": readonly ",(0,s.jsx)(n.code,{children:"string"}),"[] | ",(0,s.jsx)(n.code,{children:"Promise"}),""]}),"\n",(0,s.jsx)(n.p,{children:"An array of strings, or a promise that resolves to an array of strings."}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"options?"}),": ",(0,s.jsx)(n.a,{href:"/api/interfaces/QuickPickOptions",children:(0,s.jsx)(n.code,{children:"QuickPickOptions"})})]}),"\n",(0,s.jsx)(n.p,{children:"Configures the behavior of the selection list."}),"\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.p,{children:"A token that can be used to signal cancellation."}),"\n",(0,s.jsx)(n.h3,{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:"string"})," | ",(0,s.jsx)(n.code,{children:"undefined"}),">"]}),"\n",(0,s.jsxs)(n.p,{children:["A promise that resolves to the selection or ",(0,s.jsx)(n.code,{children:"undefined"}),"."]}),"\n",(0,s.jsx)(n.h3,{id:"defined-in-1",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2047",children:"packages/extension-api/src/extension-api.d.ts:2047"})}),"\n",(0,s.jsx)(n.h2,{id:"showquickpickitems-options-token-2",children:"showQuickPick(items, options, token)"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"showQuickPick"}),"<",(0,s.jsx)(n.code,{children:"T"}),">(",(0,s.jsx)(n.code,{children:"items"}),", ",(0,s.jsx)(n.code,{children:"options"}),", ",(0,s.jsx)(n.code,{children:"token"}),"?): ",(0,s.jsx)(n.code,{children:"Promise"}),"<",(0,s.jsx)(n.code,{children:"T"}),"[] | ",(0,s.jsx)(n.code,{children:"undefined"}),">"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Shows a selection list allowing multiple selections."}),"\n",(0,s.jsx)(n.h3,{id:"type-parameters",children:"Type Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"T"})," ",(0,s.jsx)(n.em,{children:"extends"})," ",(0,s.jsx)(n.a,{href:"/api/interfaces/QuickPickItem",children:(0,s.jsx)(n.code,{children:"QuickPickItem"})})]}),"\n",(0,s.jsx)(n.h3,{id:"parameters-2",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"items"}),": readonly ",(0,s.jsx)(n.code,{children:"T"}),"[] | ",(0,s.jsx)(n.code,{children:"Promise"}),""]}),"\n",(0,s.jsx)(n.p,{children:"An array of items, or a promise that resolves to an array of items."}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"options"}),": ",(0,s.jsx)(n.a,{href:"/api/interfaces/QuickPickOptions",children:(0,s.jsx)(n.code,{children:"QuickPickOptions"})})," & ",(0,s.jsx)(n.code,{children:"object"})]}),"\n",(0,s.jsx)(n.p,{children:"Configures the behavior of the selection list."}),"\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.p,{children:"A token that can be used to signal cancellation."}),"\n",(0,s.jsx)(n.h3,{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:"T"}),"[] | ",(0,s.jsx)(n.code,{children:"undefined"}),">"]}),"\n",(0,s.jsxs)(n.p,{children:["A promise that resolves to the selected items or ",(0,s.jsx)(n.code,{children:"undefined"}),"."]}),"\n",(0,s.jsx)(n.h3,{id:"defined-in-2",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2061",children:"packages/extension-api/src/extension-api.d.ts:2061"})}),"\n",(0,s.jsx)(n.h2,{id:"showquickpickitems-options-token-3",children:"showQuickPick(items, options, token)"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"showQuickPick"}),"<",(0,s.jsx)(n.code,{children:"T"}),">(",(0,s.jsx)(n.code,{children:"items"}),", ",(0,s.jsx)(n.code,{children:"options"}),"?, ",(0,s.jsx)(n.code,{children:"token"}),"?): ",(0,s.jsx)(n.code,{children:"Promise"}),"<",(0,s.jsx)(n.code,{children:"T"})," | ",(0,s.jsx)(n.code,{children:"undefined"}),">"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Shows a selection list."}),"\n",(0,s.jsx)(n.h3,{id:"type-parameters-1",children:"Type Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"T"})," ",(0,s.jsx)(n.em,{children:"extends"})," ",(0,s.jsx)(n.a,{href:"/api/interfaces/QuickPickItem",children:(0,s.jsx)(n.code,{children:"QuickPickItem"})})]}),"\n",(0,s.jsx)(n.h3,{id:"parameters-3",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"items"}),": readonly ",(0,s.jsx)(n.code,{children:"T"}),"[] | ",(0,s.jsx)(n.code,{children:"Promise"}),""]}),"\n",(0,s.jsx)(n.p,{children:"An array of items, or a promise that resolves to an array of items."}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"options?"}),": ",(0,s.jsx)(n.a,{href:"/api/interfaces/QuickPickOptions",children:(0,s.jsx)(n.code,{children:"QuickPickOptions"})})]}),"\n",(0,s.jsx)(n.p,{children:"Configures the behavior of the selection list."}),"\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.p,{children:"A token that can be used to signal cancellation."}),"\n",(0,s.jsx)(n.h3,{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:"T"})," | ",(0,s.jsx)(n.code,{children:"undefined"}),">"]}),"\n",(0,s.jsxs)(n.p,{children:["A promise that resolves to the selected item or ",(0,s.jsx)(n.code,{children:"undefined"}),"."]}),"\n",(0,s.jsx)(n.h3,{id:"defined-in-3",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2075",children:"packages/extension-api/src/extension-api.d.ts:2075"})})]})}function h(e={}){const{wrapper:n}={...(0,c.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(a,{...e})}):a(e)}},43023:(e,n,i)=>{i.d(n,{R:()=>r,x:()=>t});var s=i(63696);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 t(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/3132913e.153d7036.js b/assets/js/3132913e.962ac72e.js similarity index 94% rename from assets/js/3132913e.153d7036.js rename to assets/js/3132913e.962ac72e.js index bb41e2e7b1b..c784f881e51 100644 --- a/assets/js/3132913e.153d7036.js +++ b/assets/js/3132913e.962ac72e.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[64374],{25476:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>d,contentTitle:()=>r,default:()=>h,frontMatter:()=>a,metadata:()=>o,toc:()=>l});var s=i(62540),t=i(43023);const a={},r="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"}},d={},l=[{value:"Properties",id:"properties",level:2},{value:"defaultUri?",id:"defaulturi",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"filters?",id:"filters",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"saveLabel?",id:"savelabel",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"title?",id:"title",level:3},{value:"Defined in",id:"defined-in-3",level:4}];function c(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",p:"p",strong:"strong",...(0,t.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.header,{children:(0,s.jsx)(n.h1,{id:"interface-savedialogoptions",children:"Interface: SaveDialogOptions"})}),"\n",(0,s.jsx)(n.p,{children:"Options to configure the behaviour of a file save 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:"defined-in",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L1853",children:"packages/extension-api/src/extension-api.d.ts:1853"})}),"\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:"defined-in-1",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L1863",children:"packages/extension-api/src/extension-api.d.ts:1863"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"savelabel",children:"saveLabel?"}),"\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:"saveLabel"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"A human-readable string for the save button."}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-2",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L1858",children:"packages/extension-api/src/extension-api.d.ts:1858"})}),"\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:"defined-in-3",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L1871",children:"packages/extension-api/src/extension-api.d.ts:1871"})})]})}function h(e={}){const{wrapper:n}={...(0,t.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(c,{...e})}):c(e)}},43023:(e,n,i)=>{i.d(n,{R:()=>r,x:()=>o});var s=i(63696);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 o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:r(e.components),s.createElement(a.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[64374],{25476:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>d,contentTitle:()=>r,default:()=>h,frontMatter:()=>a,metadata:()=>o,toc:()=>l});var s=i(62540),t=i(43023);const a={},r="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"}},d={},l=[{value:"Properties",id:"properties",level:2},{value:"defaultUri?",id:"defaulturi",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"filters?",id:"filters",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"saveLabel?",id:"savelabel",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"title?",id:"title",level:3},{value:"Defined in",id:"defined-in-3",level:4}];function c(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",p:"p",strong:"strong",...(0,t.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.header,{children:(0,s.jsx)(n.h1,{id:"interface-savedialogoptions",children:"Interface: SaveDialogOptions"})}),"\n",(0,s.jsx)(n.p,{children:"Options to configure the behaviour of a file save 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:"defined-in",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L1853",children:"packages/extension-api/src/extension-api.d.ts:1853"})}),"\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:"defined-in-1",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L1863",children:"packages/extension-api/src/extension-api.d.ts:1863"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"savelabel",children:"saveLabel?"}),"\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:"saveLabel"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"A human-readable string for the save button."}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-2",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L1858",children:"packages/extension-api/src/extension-api.d.ts:1858"})}),"\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:"defined-in-3",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L1871",children:"packages/extension-api/src/extension-api.d.ts:1871"})})]})}function h(e={}){const{wrapper:n}={...(0,t.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(c,{...e})}):c(e)}},43023:(e,n,i)=>{i.d(n,{R:()=>r,x:()=>o});var s=i(63696);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 o(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/35300761.bb5d790d.js b/assets/js/35300761.c85306b1.js similarity index 89% rename from assets/js/35300761.bb5d790d.js rename to assets/js/35300761.c85306b1.js index 5a3eab35cdd..0538d84a5f9 100644 --- a/assets/js/35300761.bb5d790d.js +++ b/assets/js/35300761.c85306b1.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[2026],{87777:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>r,contentTitle:()=>t,default:()=>h,frontMatter:()=>c,metadata:()=>a,toc:()=>l});var s=i(62540),d=i(43023);const c={},t="Interface: MenuItem",a={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"}},r={},l=[{value:"Properties",id:"properties",level:2},{value:"checked?",id:"checked",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"enabled?",id:"enabled",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"icon?",id:"icon",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"id",id:"id",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"label?",id:"label",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"submenu?",id:"submenu",level:3},{value:"Defined in",id:"defined-in-5",level:4},{value:"type?",id:"type",level:3},{value:"Defined in",id:"defined-in-6",level:4},{value:"visible?",id:"visible",level:3},{value:"Defined in",id:"defined-in-7",level:4}];function o(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",p:"p",strong:"strong",...(0,d.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.header,{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:"defined-in",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/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:"defined-in-1",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/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:"defined-in-2",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/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:"defined-in-3",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/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:"defined-in-4",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/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:"defined-in-5",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/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:"defined-in-6",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/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:"defined-in-7",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/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,d.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(o,{...e})}):o(e)}},43023:(e,n,i)=>{i.d(n,{R:()=>t,x:()=>a});var s=i(63696);const d={},c=s.createContext(d);function t(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(d):e.components||d:t(e.components),s.createElement(c.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[2026],{87777:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>r,contentTitle:()=>t,default:()=>h,frontMatter:()=>c,metadata:()=>a,toc:()=>l});var s=i(62540),d=i(43023);const c={},t="Interface: MenuItem",a={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"}},r={},l=[{value:"Properties",id:"properties",level:2},{value:"checked?",id:"checked",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"enabled?",id:"enabled",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"icon?",id:"icon",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"id",id:"id",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"label?",id:"label",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"submenu?",id:"submenu",level:3},{value:"Defined in",id:"defined-in-5",level:4},{value:"type?",id:"type",level:3},{value:"Defined in",id:"defined-in-6",level:4},{value:"visible?",id:"visible",level:3},{value:"Defined in",id:"defined-in-7",level:4}];function o(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",p:"p",strong:"strong",...(0,d.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.header,{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:"defined-in",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/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:"defined-in-1",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/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:"defined-in-2",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/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:"defined-in-3",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/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:"defined-in-4",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/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:"defined-in-5",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/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:"defined-in-6",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/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:"defined-in-7",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/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,d.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(o,{...e})}):o(e)}},43023:(e,n,i)=>{i.d(n,{R:()=>t,x:()=>a});var s=i(63696);const d={},c=s.createContext(d);function t(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(d):e.components||d:t(e.components),s.createElement(c.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/382e0557.e71f029d.js b/assets/js/382e0557.22fe314c.js similarity index 95% rename from assets/js/382e0557.e71f029d.js rename to assets/js/382e0557.22fe314c.js index e0a01d8af29..7522d5fba99 100644 --- a/assets/js/382e0557.e71f029d.js +++ b/assets/js/382e0557.22fe314c.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[56500],{94125:(e,s,t)=>{t.r(s),t.d(s,{assets:()=>o,contentTitle:()=>a,default:()=>m,frontMatter:()=>i,metadata:()=>c,toc:()=>l});var n=t(62540),r=t(43023);const i={},a="Interface: ImageFilesystemLayers",c={id:"interfaces/ImageFilesystemLayers",title:"Interface: ImageFilesystemLayers",description:"the complete list of filesystem layers",source:"@site/api/interfaces/ImageFilesystemLayers.md",sourceDirName:"interfaces",slug:"/interfaces/ImageFilesystemLayers",permalink:"/api/interfaces/ImageFilesystemLayers",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"ImageFilesystemLayer",permalink:"/api/interfaces/ImageFilesystemLayer"},next:{title:"ImageInfo",permalink:"/api/interfaces/ImageInfo"}},o={},l=[{value:"Properties",id:"properties",level:2},{value:"layers",id:"layers",level:3},{value:"Defined in",id:"defined-in",level:4}];function d(e){const s={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",p:"p",strong:"strong",...(0,r.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(s.header,{children:(0,n.jsx)(s.h1,{id:"interface-imagefilesystemlayers",children:"Interface: ImageFilesystemLayers"})}),"\n",(0,n.jsx)(s.p,{children:"the complete list of filesystem layers"}),"\n",(0,n.jsx)(s.h2,{id:"properties",children:"Properties"}),"\n",(0,n.jsx)(s.h3,{id:"layers",children:"layers"}),"\n",(0,n.jsxs)(s.blockquote,{children:["\n",(0,n.jsxs)(s.p,{children:[(0,n.jsx)(s.strong,{children:"layers"}),": ",(0,n.jsx)(s.a,{href:"/api/interfaces/ImageFilesystemLayer",children:(0,n.jsx)(s.code,{children:"ImageFilesystemLayer"})}),"[]"]}),"\n"]}),"\n",(0,n.jsx)(s.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,n.jsx)(s.p,{children:(0,n.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L781",children:"packages/extension-api/src/extension-api.d.ts:781"})})]})}function m(e={}){const{wrapper:s}={...(0,r.R)(),...e.components};return s?(0,n.jsx)(s,{...e,children:(0,n.jsx)(d,{...e})}):d(e)}},43023:(e,s,t)=>{t.d(s,{R:()=>a,x:()=>c});var n=t(63696);const r={},i=n.createContext(r);function a(e){const s=n.useContext(i);return n.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:a(e.components),n.createElement(i.Provider,{value:s},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[56500],{94125:(e,s,t)=>{t.r(s),t.d(s,{assets:()=>o,contentTitle:()=>a,default:()=>m,frontMatter:()=>i,metadata:()=>c,toc:()=>l});var n=t(62540),r=t(43023);const i={},a="Interface: ImageFilesystemLayers",c={id:"interfaces/ImageFilesystemLayers",title:"Interface: ImageFilesystemLayers",description:"the complete list of filesystem layers",source:"@site/api/interfaces/ImageFilesystemLayers.md",sourceDirName:"interfaces",slug:"/interfaces/ImageFilesystemLayers",permalink:"/api/interfaces/ImageFilesystemLayers",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"ImageFilesystemLayer",permalink:"/api/interfaces/ImageFilesystemLayer"},next:{title:"ImageInfo",permalink:"/api/interfaces/ImageInfo"}},o={},l=[{value:"Properties",id:"properties",level:2},{value:"layers",id:"layers",level:3},{value:"Defined in",id:"defined-in",level:4}];function d(e){const s={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",p:"p",strong:"strong",...(0,r.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(s.header,{children:(0,n.jsx)(s.h1,{id:"interface-imagefilesystemlayers",children:"Interface: ImageFilesystemLayers"})}),"\n",(0,n.jsx)(s.p,{children:"the complete list of filesystem layers"}),"\n",(0,n.jsx)(s.h2,{id:"properties",children:"Properties"}),"\n",(0,n.jsx)(s.h3,{id:"layers",children:"layers"}),"\n",(0,n.jsxs)(s.blockquote,{children:["\n",(0,n.jsxs)(s.p,{children:[(0,n.jsx)(s.strong,{children:"layers"}),": ",(0,n.jsx)(s.a,{href:"/api/interfaces/ImageFilesystemLayer",children:(0,n.jsx)(s.code,{children:"ImageFilesystemLayer"})}),"[]"]}),"\n"]}),"\n",(0,n.jsx)(s.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,n.jsx)(s.p,{children:(0,n.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L781",children:"packages/extension-api/src/extension-api.d.ts:781"})})]})}function m(e={}){const{wrapper:s}={...(0,r.R)(),...e.components};return s?(0,n.jsx)(s,{...e,children:(0,n.jsx)(d,{...e})}):d(e)}},43023:(e,s,t)=>{t.d(s,{R:()=>a,x:()=>c});var n=t(63696);const r={},i=n.createContext(r);function a(e){const s=n.useContext(i);return n.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:a(e.components),n.createElement(i.Provider,{value:s},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/3866940b.09e20270.js b/assets/js/3866940b.7e34ec18.js similarity index 91% rename from assets/js/3866940b.09e20270.js rename to assets/js/3866940b.7e34ec18.js index 9a2925dc04c..d209962a00c 100644 --- a/assets/js/3866940b.09e20270.js +++ b/assets/js/3866940b.7e34ec18.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[42607],{63408:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>d,contentTitle:()=>o,default:()=>p,frontMatter:()=>s,metadata:()=>a,toc:()=>c});var r=i(62540),t=i(43023);const s={},o="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"}},d={},c=[{value:"Properties",id:"properties",level:2},{value:"details?",id:"details",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"name",id:"name",level:3},{value:"Defined in",id:"defined-in-1",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",p:"p",strong:"strong",...(0,t.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.header,{children:(0,r.jsx)(n.h1,{id:"interface-providerinformation",children:"Interface: ProviderInformation"})}),"\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:"defined-in",children:"Defined in"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L302",children:"packages/extension-api/src/extension-api.d.ts:302"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"name",children:"name"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"name"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/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,t.R)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(l,{...e})}):l(e)}},43023:(e,n,i)=>{i.d(n,{R:()=>o,x:()=>a});var r=i(63696);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([[42607],{63408:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>d,contentTitle:()=>o,default:()=>p,frontMatter:()=>s,metadata:()=>a,toc:()=>c});var r=i(62540),t=i(43023);const s={},o="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"}},d={},c=[{value:"Properties",id:"properties",level:2},{value:"details?",id:"details",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"name",id:"name",level:3},{value:"Defined in",id:"defined-in-1",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",p:"p",strong:"strong",...(0,t.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.header,{children:(0,r.jsx)(n.h1,{id:"interface-providerinformation",children:"Interface: ProviderInformation"})}),"\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:"defined-in",children:"Defined in"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L302",children:"packages/extension-api/src/extension-api.d.ts:302"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"name",children:"name"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"name"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/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,t.R)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(l,{...e})}):l(e)}},43023:(e,n,i)=>{i.d(n,{R:()=>o,x:()=>a});var r=i(63696);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/39ae3791.05d4fffb.js b/assets/js/39ae3791.33385c54.js similarity index 93% rename from assets/js/39ae3791.05d4fffb.js rename to assets/js/39ae3791.33385c54.js index e940aab8263..708c23c076a 100644 --- a/assets/js/39ae3791.05d4fffb.js +++ b/assets/js/39ae3791.33385c54.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[74937],{4542:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>a,contentTitle:()=>d,default:()=>h,frontMatter:()=>t,metadata:()=>c,toc:()=>o});var s=i(62540),r=i(43023);const t={},d="Interface: ProviderLifecycle",c={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"}},a={},o=[{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:"Defined in",id:"defined-in",level:4},{value:"start()",id:"start",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"status()",id:"status",level:3},{value:"Returns",id:"returns-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"stop()",id:"stop",level:3},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-3",level:4},{value:"Defined in",id:"defined-in-3",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",p:"p",strong:"strong",...(0,r.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.header,{children:(0,s.jsx)(n.h1,{id:"interface-providerlifecycle",children:"Interface: ProviderLifecycle"})}),"\n",(0,s.jsx)(n.h2,{id:"methods",children:"Methods"}),"\n",(0,s.jsx)(n.h3,{id:"initialize",children:"initialize()?"}),"\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:"initialize"}),"(",(0,s.jsx)(n.code,{children:"initContext"}),"): ",(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:"initContext"}),": ",(0,s.jsx)(n.a,{href:"/api/interfaces/LifecycleContext",children:(0,s.jsx)(n.code,{children:"LifecycleContext"})})]}),"\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:"defined-in",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L292",children:"packages/extension-api/src/extension-api.d.ts:292"})}),"\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:"startContext"}),"): ",(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:"startContext"}),": ",(0,s.jsx)(n.a,{href:"/api/interfaces/LifecycleContext",children:(0,s.jsx)(n.code,{children:"LifecycleContext"})})]}),"\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:"defined-in-1",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L293",children:"packages/extension-api/src/extension-api.d.ts:293"})}),"\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/ProviderStatus",children:(0,s.jsx)(n.code,{children:"ProviderStatus"})})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"returns-2",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"/api/type-aliases/ProviderStatus",children:(0,s.jsx)(n.code,{children:"ProviderStatus"})})}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-2",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L295",children:"packages/extension-api/src/extension-api.d.ts:295"})}),"\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.strong,{children:"stop"}),"(",(0,s.jsx)(n.code,{children:"stopContext"}),"): ",(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:"stopContext"}),": ",(0,s.jsx)(n.a,{href:"/api/interfaces/LifecycleContext",children:(0,s.jsx)(n.code,{children:"LifecycleContext"})})]}),"\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:"defined-in-3",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/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,r.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},43023:(e,n,i)=>{i.d(n,{R:()=>d,x:()=>c});var s=i(63696);const r={},t=s.createContext(r);function d(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:d(e.components),s.createElement(t.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[74937],{4542:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>a,contentTitle:()=>d,default:()=>h,frontMatter:()=>t,metadata:()=>c,toc:()=>o});var s=i(62540),r=i(43023);const t={},d="Interface: ProviderLifecycle",c={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"}},a={},o=[{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:"Defined in",id:"defined-in",level:4},{value:"start()",id:"start",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"status()",id:"status",level:3},{value:"Returns",id:"returns-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"stop()",id:"stop",level:3},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-3",level:4},{value:"Defined in",id:"defined-in-3",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",p:"p",strong:"strong",...(0,r.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.header,{children:(0,s.jsx)(n.h1,{id:"interface-providerlifecycle",children:"Interface: ProviderLifecycle"})}),"\n",(0,s.jsx)(n.h2,{id:"methods",children:"Methods"}),"\n",(0,s.jsx)(n.h3,{id:"initialize",children:"initialize()?"}),"\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:"initialize"}),"(",(0,s.jsx)(n.code,{children:"initContext"}),"): ",(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:"initContext"}),": ",(0,s.jsx)(n.a,{href:"/api/interfaces/LifecycleContext",children:(0,s.jsx)(n.code,{children:"LifecycleContext"})})]}),"\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:"defined-in",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L292",children:"packages/extension-api/src/extension-api.d.ts:292"})}),"\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:"startContext"}),"): ",(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:"startContext"}),": ",(0,s.jsx)(n.a,{href:"/api/interfaces/LifecycleContext",children:(0,s.jsx)(n.code,{children:"LifecycleContext"})})]}),"\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:"defined-in-1",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L293",children:"packages/extension-api/src/extension-api.d.ts:293"})}),"\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/ProviderStatus",children:(0,s.jsx)(n.code,{children:"ProviderStatus"})})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"returns-2",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"/api/type-aliases/ProviderStatus",children:(0,s.jsx)(n.code,{children:"ProviderStatus"})})}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-2",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L295",children:"packages/extension-api/src/extension-api.d.ts:295"})}),"\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.strong,{children:"stop"}),"(",(0,s.jsx)(n.code,{children:"stopContext"}),"): ",(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:"stopContext"}),": ",(0,s.jsx)(n.a,{href:"/api/interfaces/LifecycleContext",children:(0,s.jsx)(n.code,{children:"LifecycleContext"})})]}),"\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:"defined-in-3",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/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,r.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},43023:(e,n,i)=>{i.d(n,{R:()=>d,x:()=>c});var s=i(63696);const r={},t=s.createContext(r);function d(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:d(e.components),s.createElement(t.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/3a38a610.87fddd26.js b/assets/js/3a38a610.4ff9d5c2.js similarity index 82% rename from assets/js/3a38a610.87fddd26.js rename to assets/js/3a38a610.4ff9d5c2.js index 0192ca5cd6a..38461fba5f8 100644 --- a/assets/js/3a38a610.87fddd26.js +++ b/assets/js/3a38a610.4ff9d5c2.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[25492],{83728:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>c,contentTitle:()=>r,default:()=>h,frontMatter:()=>a,metadata:()=>t,toc:()=>l});var s=i(62540),d=i(43023);const a={},r="Interface: ImageInfo",t={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:"ImageFilesystemLayers",permalink:"/api/interfaces/ImageFilesystemLayers"},next:{title:"ImageInspectInfo",permalink:"/api/interfaces/ImageInspectInfo"}},c={},l=[{value:"Properties",id:"properties",level:2},{value:"Containers",id:"containers",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"Created",id:"created",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"Digest",id:"digest",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"History?",id:"history",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"Id",id:"id",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"Labels",id:"labels",level:3},{value:"Index Signature",id:"index-signature",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"ParentId",id:"parentid",level:3},{value:"Defined in",id:"defined-in-6",level:4},{value:"RepoDigests?",id:"repodigests",level:3},{value:"Defined in",id:"defined-in-7",level:4},{value:"RepoTags",id:"repotags",level:3},{value:"Defined in",id:"defined-in-8",level:4},{value:"SharedSize",id:"sharedsize",level:3},{value:"Defined in",id:"defined-in-9",level:4},{value:"Size",id:"size",level:3},{value:"Defined in",id:"defined-in-10",level:4},{value:"VirtualSize",id:"virtualsize",level:3},{value:"Defined in",id:"defined-in-11",level:4},{value:"engineId",id:"engineid",level:3},{value:"Defined in",id:"defined-in-12",level:4},{value:"engineName",id:"enginename",level:3},{value:"Defined in",id:"defined-in-13",level:4},{value:"isManifest?",id:"ismanifest",level:3},{value:"Defined in",id:"defined-in-14",level:4}];function o(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",p:"p",strong:"strong",...(0,d.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.header,{children:(0,s.jsx)(n.h1,{id:"interface-imageinfo",children:"Interface: ImageInfo"})}),"\n",(0,s.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,s.jsx)(n.h3,{id:"containers",children:"Containers"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Containers"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2169",children:"packages/extension-api/src/extension-api.d.ts:2169"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"created",children:"Created"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Created"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2164",children:"packages/extension-api/src/extension-api.d.ts:2164"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"digest",children:"Digest"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Digest"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-2",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2171",children:"packages/extension-api/src/extension-api.d.ts:2171"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"history",children:"History?"}),"\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:"History"}),": ",(0,s.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-3",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2170",children:"packages/extension-api/src/extension-api.d.ts:2170"})}),"\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:"defined-in-4",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2160",children:"packages/extension-api/src/extension-api.d.ts:2160"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"labels",children:"Labels"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Labels"}),": ",(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:"label"}),": ",(0,s.jsx)(n.code,{children:"string"}),"]: ",(0,s.jsx)(n.code,{children:"string"})]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-5",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2168",children:"packages/extension-api/src/extension-api.d.ts:2168"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"parentid",children:"ParentId"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"ParentId"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-6",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2161",children:"packages/extension-api/src/extension-api.d.ts:2161"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"repodigests",children:"RepoDigests?"}),"\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:"RepoDigests"}),": ",(0,s.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-7",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2163",children:"packages/extension-api/src/extension-api.d.ts:2163"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"repotags",children:"RepoTags"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"RepoTags"}),": ",(0,s.jsx)(n.code,{children:"undefined"})," | ",(0,s.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-8",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2162",children:"packages/extension-api/src/extension-api.d.ts:2162"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"sharedsize",children:"SharedSize"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"SharedSize"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-9",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2167",children:"packages/extension-api/src/extension-api.d.ts:2167"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"size",children:"Size"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Size"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-10",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2165",children:"packages/extension-api/src/extension-api.d.ts:2165"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"virtualsize",children:"VirtualSize"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"VirtualSize"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-11",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2166",children:"packages/extension-api/src/extension-api.d.ts:2166"})}),"\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.h4,{id:"defined-in-12",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2158",children:"packages/extension-api/src/extension-api.d.ts:2158"})}),"\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.h4,{id:"defined-in-13",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2159",children:"packages/extension-api/src/extension-api.d.ts:2159"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"ismanifest",children:"isManifest?"}),"\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:"isManifest"}),": ",(0,s.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-14",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2174",children:"packages/extension-api/src/extension-api.d.ts:2174"})})]})}function h(e={}){const{wrapper:n}={...(0,d.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(o,{...e})}):o(e)}},43023:(e,n,i)=>{i.d(n,{R:()=>r,x:()=>t});var s=i(63696);const d={},a=s.createContext(d);function r(e){const n=s.useContext(a);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(d):e.components||d:r(e.components),s.createElement(a.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[25492],{83728:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>t,contentTitle:()=>r,default:()=>h,frontMatter:()=>a,metadata:()=>c,toc:()=>l});var s=i(62540),d=i(43023);const a={},r="Interface: ImageInfo",c={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:"ImageFilesystemLayers",permalink:"/api/interfaces/ImageFilesystemLayers"},next:{title:"ImageInspectInfo",permalink:"/api/interfaces/ImageInspectInfo"}},t={},l=[{value:"Properties",id:"properties",level:2},{value:"Containers",id:"containers",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"Created",id:"created",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"Digest",id:"digest",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"History?",id:"history",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"Id",id:"id",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"Labels",id:"labels",level:3},{value:"Index Signature",id:"index-signature",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"ParentId",id:"parentid",level:3},{value:"Defined in",id:"defined-in-6",level:4},{value:"RepoDigests?",id:"repodigests",level:3},{value:"Defined in",id:"defined-in-7",level:4},{value:"RepoTags",id:"repotags",level:3},{value:"Defined in",id:"defined-in-8",level:4},{value:"SharedSize",id:"sharedsize",level:3},{value:"Defined in",id:"defined-in-9",level:4},{value:"Size",id:"size",level:3},{value:"Defined in",id:"defined-in-10",level:4},{value:"VirtualSize",id:"virtualsize",level:3},{value:"Defined in",id:"defined-in-11",level:4},{value:"engineId",id:"engineid",level:3},{value:"Defined in",id:"defined-in-12",level:4},{value:"engineName",id:"enginename",level:3},{value:"Defined in",id:"defined-in-13",level:4},{value:"isManifest?",id:"ismanifest",level:3},{value:"Defined in",id:"defined-in-14",level:4}];function o(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",p:"p",strong:"strong",...(0,d.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.header,{children:(0,s.jsx)(n.h1,{id:"interface-imageinfo",children:"Interface: ImageInfo"})}),"\n",(0,s.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,s.jsx)(n.h3,{id:"containers",children:"Containers"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Containers"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2169",children:"packages/extension-api/src/extension-api.d.ts:2169"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"created",children:"Created"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Created"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2164",children:"packages/extension-api/src/extension-api.d.ts:2164"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"digest",children:"Digest"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Digest"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-2",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2171",children:"packages/extension-api/src/extension-api.d.ts:2171"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"history",children:"History?"}),"\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:"History"}),": ",(0,s.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-3",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2170",children:"packages/extension-api/src/extension-api.d.ts:2170"})}),"\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:"defined-in-4",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2160",children:"packages/extension-api/src/extension-api.d.ts:2160"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"labels",children:"Labels"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Labels"}),": ",(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:"label"}),": ",(0,s.jsx)(n.code,{children:"string"}),"]: ",(0,s.jsx)(n.code,{children:"string"})]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-5",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2168",children:"packages/extension-api/src/extension-api.d.ts:2168"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"parentid",children:"ParentId"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"ParentId"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-6",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2161",children:"packages/extension-api/src/extension-api.d.ts:2161"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"repodigests",children:"RepoDigests?"}),"\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:"RepoDigests"}),": ",(0,s.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-7",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2163",children:"packages/extension-api/src/extension-api.d.ts:2163"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"repotags",children:"RepoTags"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"RepoTags"}),": ",(0,s.jsx)(n.code,{children:"undefined"})," | ",(0,s.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-8",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2162",children:"packages/extension-api/src/extension-api.d.ts:2162"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"sharedsize",children:"SharedSize"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"SharedSize"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-9",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2167",children:"packages/extension-api/src/extension-api.d.ts:2167"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"size",children:"Size"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Size"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-10",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2165",children:"packages/extension-api/src/extension-api.d.ts:2165"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"virtualsize",children:"VirtualSize"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"VirtualSize"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-11",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2166",children:"packages/extension-api/src/extension-api.d.ts:2166"})}),"\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.h4,{id:"defined-in-12",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2158",children:"packages/extension-api/src/extension-api.d.ts:2158"})}),"\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.h4,{id:"defined-in-13",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2159",children:"packages/extension-api/src/extension-api.d.ts:2159"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"ismanifest",children:"isManifest?"}),"\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:"isManifest"}),": ",(0,s.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-14",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2174",children:"packages/extension-api/src/extension-api.d.ts:2174"})})]})}function h(e={}){const{wrapper:n}={...(0,d.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(o,{...e})}):o(e)}},43023:(e,n,i)=>{i.d(n,{R:()=>r,x:()=>c});var s=i(63696);const d={},a=s.createContext(d);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(d):e.components||d:r(e.components),s.createElement(a.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/3ba80b69.ba92eb3d.js b/assets/js/3ba80b69.e8e68567.js similarity index 79% rename from assets/js/3ba80b69.ba92eb3d.js rename to assets/js/3ba80b69.e8e68567.js index f5389ef9080..d12aff9285c 100644 --- a/assets/js/3ba80b69.ba92eb3d.js +++ b/assets/js/3ba80b69.e8e68567.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[7766],{71493:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>d,default:()=>l,frontMatter:()=>r,metadata:()=>c,toc:()=>o});var i=t(62540),s=t(43023);const r={},d="Interface: HealthCheckLog",c={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={},o=[{value:"Properties",id:"properties",level:2},{value:"End",id:"end",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"ExitCode",id:"exitcode",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"Output",id:"output",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"Start",id:"start",level:3},{value:"Defined in",id:"defined-in-3",level:4}];function h(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",p:"p",strong:"strong",...(0,s.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.header,{children:(0,i.jsx)(n.h1,{id:"interface-healthchecklog",children:"Interface: HealthCheckLog"})}),"\n",(0,i.jsx)(n.p,{children:"HealthCheckLog describes the results of a single healthcheck"}),"\n",(0,i.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(n.h3,{id:"end",children:"End"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"End"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"End time as a string"}),"\n",(0,i.jsx)(n.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2531",children:"packages/extension-api/src/extension-api.d.ts:2531"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{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.p,{children:"Exitcode is 0 or 1"}),"\n",(0,i.jsx)(n.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2535",children:"packages/extension-api/src/extension-api.d.ts:2535"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"output",children:"Output"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Output"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Output is the stdout/stderr from the healthcheck command"}),"\n",(0,i.jsx)(n.h4,{id:"defined-in-2",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2539",children:"packages/extension-api/src/extension-api.d.ts:2539"})}),"\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.strong,{children:"Start"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Start time as string"}),"\n",(0,i.jsx)(n.h4,{id:"defined-in-3",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2527",children:"packages/extension-api/src/extension-api.d.ts:2527"})})]})}function l(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(h,{...e})}):h(e)}},43023:(e,n,t)=>{t.d(n,{R:()=>d,x:()=>c});var i=t(63696);const s={},r=i.createContext(s);function d(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:d(e.components),i.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[7766],{71493:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>r,default:()=>l,frontMatter:()=>c,metadata:()=>d,toc:()=>o});var i=t(62540),s=t(43023);const c={},r="Interface: HealthCheckLog",d={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={},o=[{value:"Properties",id:"properties",level:2},{value:"End",id:"end",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"ExitCode",id:"exitcode",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"Output",id:"output",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"Start",id:"start",level:3},{value:"Defined in",id:"defined-in-3",level:4}];function h(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",p:"p",strong:"strong",...(0,s.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.header,{children:(0,i.jsx)(n.h1,{id:"interface-healthchecklog",children:"Interface: HealthCheckLog"})}),"\n",(0,i.jsx)(n.p,{children:"HealthCheckLog describes the results of a single healthcheck"}),"\n",(0,i.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(n.h3,{id:"end",children:"End"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"End"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"End time as a string"}),"\n",(0,i.jsx)(n.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2531",children:"packages/extension-api/src/extension-api.d.ts:2531"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{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.p,{children:"Exitcode is 0 or 1"}),"\n",(0,i.jsx)(n.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2535",children:"packages/extension-api/src/extension-api.d.ts:2535"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"output",children:"Output"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Output"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Output is the stdout/stderr from the healthcheck command"}),"\n",(0,i.jsx)(n.h4,{id:"defined-in-2",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2539",children:"packages/extension-api/src/extension-api.d.ts:2539"})}),"\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.strong,{children:"Start"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Start time as string"}),"\n",(0,i.jsx)(n.h4,{id:"defined-in-3",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2527",children:"packages/extension-api/src/extension-api.d.ts:2527"})})]})}function l(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(h,{...e})}):h(e)}},43023:(e,n,t)=>{t.d(n,{R:()=>r,x:()=>d});var i=t(63696);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 d(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/3d6cee82.e091d01b.js b/assets/js/3d6cee82.bfb1eaf6.js similarity index 95% rename from assets/js/3d6cee82.e091d01b.js rename to assets/js/3d6cee82.bfb1eaf6.js index 666ad3ceec6..af1407129a0 100644 --- a/assets/js/3d6cee82.e091d01b.js +++ b/assets/js/3d6cee82.bfb1eaf6.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[93655],{2176:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>c,contentTitle:()=>r,default:()=>u,frontMatter:()=>o,metadata:()=>a,toc:()=>d});var t=s(62540),i=s(43023);const o={},r="Function: pushManifest()",a={id:"namespaces/containerEngine/functions/pushManifest",title:"Function: pushManifest()",description:"pushManifest(options): Promise\\",source:"@site/api/namespaces/containerEngine/functions/pushManifest.md",sourceDirName:"namespaces/containerEngine/functions",slug:"/namespaces/containerEngine/functions/pushManifest",permalink:"/api/namespaces/containerEngine/functions/pushManifest",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"pushImage",permalink:"/api/namespaces/containerEngine/functions/pushImage"},next:{title:"removeManifest",permalink:"/api/namespaces/containerEngine/functions/removeManifest"}},c={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Defined in",id:"defined-in",level:2}];function p(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",strong:"strong",...(0,i.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.header,{children:(0,t.jsx)(n.h1,{id:"function-pushmanifest",children:"Function: pushManifest()"})}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"pushManifest"}),"(",(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.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/ManifestPushOptions",children:(0,t.jsx)(n.code,{children:"ManifestPushOptions"})})]}),"\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:"defined-in",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L3694",children:"packages/extension-api/src/extension-api.d.ts:3694"})})]})}function u(e={}){const{wrapper:n}={...(0,i.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(p,{...e})}):p(e)}},43023:(e,n,s)=>{s.d(n,{R:()=>r,x:()=>a});var t=s(63696);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 a(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([[93655],{2176:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>c,contentTitle:()=>r,default:()=>u,frontMatter:()=>o,metadata:()=>a,toc:()=>d});var t=s(62540),i=s(43023);const o={},r="Function: pushManifest()",a={id:"namespaces/containerEngine/functions/pushManifest",title:"Function: pushManifest()",description:"pushManifest(options): Promise\\",source:"@site/api/namespaces/containerEngine/functions/pushManifest.md",sourceDirName:"namespaces/containerEngine/functions",slug:"/namespaces/containerEngine/functions/pushManifest",permalink:"/api/namespaces/containerEngine/functions/pushManifest",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"pushImage",permalink:"/api/namespaces/containerEngine/functions/pushImage"},next:{title:"removeManifest",permalink:"/api/namespaces/containerEngine/functions/removeManifest"}},c={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Defined in",id:"defined-in",level:2}];function p(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",strong:"strong",...(0,i.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.header,{children:(0,t.jsx)(n.h1,{id:"function-pushmanifest",children:"Function: pushManifest()"})}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"pushManifest"}),"(",(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.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/ManifestPushOptions",children:(0,t.jsx)(n.code,{children:"ManifestPushOptions"})})]}),"\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:"defined-in",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L3694",children:"packages/extension-api/src/extension-api.d.ts:3694"})})]})}function u(e={}){const{wrapper:n}={...(0,i.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(p,{...e})}):p(e)}},43023:(e,n,s)=>{s.d(n,{R:()=>r,x:()=>a});var t=s(63696);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 a(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/3e2b82eb.d76138d6.js b/assets/js/3e2b82eb.fd107078.js similarity index 83% rename from assets/js/3e2b82eb.d76138d6.js rename to assets/js/3e2b82eb.fd107078.js index 75b20e0b691..38acf6a2940 100644 --- a/assets/js/3e2b82eb.d76138d6.js +++ b/assets/js/3e2b82eb.fd107078.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[2172],{90544:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>c,contentTitle:()=>a,default:()=>u,frontMatter:()=>s,metadata:()=>r,toc:()=>d});var t=i(62540),o=i(43023);const s={},a="Function: navigateToVolume()",r={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"}},c={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Defined in",id:"defined-in",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",strong:"strong",...(0,o.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.header,{children:(0,t.jsx)(n.h1,{id:"function-navigatetovolume",children:"Function: navigateToVolume()"})}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"navigateToVolume"}),"(",(0,t.jsx)(n.code,{children:"name"}),", ",(0,t.jsx)(n.code,{children:"engineId"}),"): ",(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:"name"}),": ",(0,t.jsx)(n.code,{children:"string"})]}),"\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.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:"defined-in",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L4516",children:"packages/extension-api/src/extension-api.d.ts:4516"})})]})}function u(e={}){const{wrapper:n}={...(0,o.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},43023:(e,n,i)=>{i.d(n,{R:()=>a,x:()=>r});var t=i(63696);const o={},s=t.createContext(o);function a(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:a(e.components),t.createElement(s.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[2172],{90544:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>r,contentTitle:()=>a,default:()=>u,frontMatter:()=>s,metadata:()=>c,toc:()=>d});var t=i(62540),o=i(43023);const s={},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:"Defined in",id:"defined-in",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",strong:"strong",...(0,o.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.header,{children:(0,t.jsx)(n.h1,{id:"function-navigatetovolume",children:"Function: navigateToVolume()"})}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"navigateToVolume"}),"(",(0,t.jsx)(n.code,{children:"name"}),", ",(0,t.jsx)(n.code,{children:"engineId"}),"): ",(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:"name"}),": ",(0,t.jsx)(n.code,{children:"string"})]}),"\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.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:"defined-in",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L4516",children:"packages/extension-api/src/extension-api.d.ts:4516"})})]})}function u(e={}){const{wrapper:n}={...(0,o.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},43023:(e,n,i)=>{i.d(n,{R:()=>a,x:()=>c});var t=i(63696);const o={},s=t.createContext(o);function a(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:a(e.components),t.createElement(s.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/3f66023b.0b191cd9.js b/assets/js/3f66023b.eb031895.js similarity index 83% rename from assets/js/3f66023b.0b191cd9.js rename to assets/js/3f66023b.eb031895.js index fe777ff7b34..ce6d042d821 100644 --- a/assets/js/3f66023b.0b191cd9.js +++ b/assets/js/3f66023b.eb031895.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[66045],{28530:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>c,contentTitle:()=>a,default:()=>h,frontMatter:()=>t,metadata:()=>r,toc:()=>o});var s=i(62540),d=i(43023);const t={},a="Interface: ContainerInfo",r={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"}},c={},o=[{value:"Properties",id:"properties",level:2},{value:"Command",id:"command",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"Created",id:"created",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"HostConfig",id:"hostconfig",level:3},{value:"NetworkMode",id:"networkmode",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"Id",id:"id",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"Image",id:"image",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"ImageID",id:"imageid",level:3},{value:"Defined in",id:"defined-in-5",level:4},{value:"Labels",id:"labels",level:3},{value:"Index Signature",id:"index-signature",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"Mounts",id:"mounts",level:3},{value:"Defined in",id:"defined-in-7",level:4},{value:"Names",id:"names",level:3},{value:"Defined in",id:"defined-in-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:"Defined in",id:"defined-in-9",level:4},{value:"Ports",id:"ports",level:3},{value:"Defined in",id:"defined-in-10",level:4},{value:"State",id:"state",level:3},{value:"Defined in",id:"defined-in-11",level:4},{value:"Status",id:"status",level:3},{value:"Defined in",id:"defined-in-12",level:4},{value:"engineId",id:"engineid",level:3},{value:"Defined in",id:"defined-in-13",level:4},{value:"engineName",id:"enginename",level:3},{value:"Defined in",id:"defined-in-14",level:4},{value:"engineType",id:"enginetype",level:3},{value:"Defined in",id:"defined-in-15",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",h5:"h5",header:"header",hr:"hr",p:"p",strong:"strong",...(0,d.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.header,{children:(0,s.jsx)(n.h1,{id:"interface-containerinfo",children:"Interface: ContainerInfo"})}),"\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.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2293",children:"packages/extension-api/src/extension-api.d.ts:2293"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"created",children:"Created"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Created"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2294",children:"packages/extension-api/src/extension-api.d.ts:2294"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"hostconfig",children:"HostConfig"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"HostConfig"}),": ",(0,s.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"networkmode",children:"NetworkMode"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"NetworkMode"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-2",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2299",children:"packages/extension-api/src/extension-api.d.ts:2299"})}),"\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:"defined-in-3",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2289",children:"packages/extension-api/src/extension-api.d.ts:2289"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"image",children:"Image"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Image"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-4",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2291",children:"packages/extension-api/src/extension-api.d.ts:2291"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"imageid",children:"ImageID"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"ImageID"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-5",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2292",children:"packages/extension-api/src/extension-api.d.ts:2292"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"labels",children:"Labels"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Labels"}),": ",(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:"label"}),": ",(0,s.jsx)(n.code,{children:"string"}),"]: ",(0,s.jsx)(n.code,{children:"string"})]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-6",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2296",children:"packages/extension-api/src/extension-api.d.ts:2296"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"mounts",children:"Mounts"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Mounts"}),": ",(0,s.jsx)(n.code,{children:"object"}),"[]"]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-7",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2305",children:"packages/extension-api/src/extension-api.d.ts:2305"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"names",children:"Names"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Names"}),": ",(0,s.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-8",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2290",children:"packages/extension-api/src/extension-api.d.ts:2290"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"networksettings",children:"NetworkSettings"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"NetworkSettings"}),": ",(0,s.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"networks",children:"Networks"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Networks"}),": ",(0,s.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,s.jsx)(n.h5,{id:"index-signature-1",children:"Index Signature"}),"\n",(0,s.jsxs)(n.p,{children:["[",(0,s.jsx)(n.code,{children:"networkType"}),": ",(0,s.jsx)(n.code,{children:"string"}),"]: ",(0,s.jsx)(n.a,{href:"/api/interfaces/NetworkInfo",children:(0,s.jsx)(n.code,{children:"NetworkInfo"})})]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-9",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2302",children:"packages/extension-api/src/extension-api.d.ts:2302"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"ports",children:"Ports"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Ports"}),": ",(0,s.jsx)(n.a,{href:"/api/interfaces/Port",children:(0,s.jsx)(n.code,{children:"Port"})}),"[]"]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-10",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2295",children:"packages/extension-api/src/extension-api.d.ts:2295"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"state",children:"State"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"State"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-11",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2297",children:"packages/extension-api/src/extension-api.d.ts:2297"})}),"\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:"defined-in-12",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2298",children:"packages/extension-api/src/extension-api.d.ts:2298"})}),"\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.h4,{id:"defined-in-13",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2286",children:"packages/extension-api/src/extension-api.d.ts:2286"})}),"\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.h4,{id:"defined-in-14",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2287",children:"packages/extension-api/src/extension-api.d.ts:2287"})}),"\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.h4,{id:"defined-in-15",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2288",children:"packages/extension-api/src/extension-api.d.ts:2288"})})]})}function h(e={}){const{wrapper:n}={...(0,d.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},43023:(e,n,i)=>{i.d(n,{R:()=>a,x:()=>r});var s=i(63696);const d={},t=s.createContext(d);function a(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(d):e.components||d:a(e.components),s.createElement(t.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[66045],{28530:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>r,contentTitle:()=>a,default:()=>h,frontMatter:()=>t,metadata:()=>c,toc:()=>o});var s=i(62540),d=i(43023);const t={},a="Interface: ContainerInfo",c={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"}},r={},o=[{value:"Properties",id:"properties",level:2},{value:"Command",id:"command",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"Created",id:"created",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"HostConfig",id:"hostconfig",level:3},{value:"NetworkMode",id:"networkmode",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"Id",id:"id",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"Image",id:"image",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"ImageID",id:"imageid",level:3},{value:"Defined in",id:"defined-in-5",level:4},{value:"Labels",id:"labels",level:3},{value:"Index Signature",id:"index-signature",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"Mounts",id:"mounts",level:3},{value:"Defined in",id:"defined-in-7",level:4},{value:"Names",id:"names",level:3},{value:"Defined in",id:"defined-in-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:"Defined in",id:"defined-in-9",level:4},{value:"Ports",id:"ports",level:3},{value:"Defined in",id:"defined-in-10",level:4},{value:"State",id:"state",level:3},{value:"Defined in",id:"defined-in-11",level:4},{value:"Status",id:"status",level:3},{value:"Defined in",id:"defined-in-12",level:4},{value:"engineId",id:"engineid",level:3},{value:"Defined in",id:"defined-in-13",level:4},{value:"engineName",id:"enginename",level:3},{value:"Defined in",id:"defined-in-14",level:4},{value:"engineType",id:"enginetype",level:3},{value:"Defined in",id:"defined-in-15",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",h5:"h5",header:"header",hr:"hr",p:"p",strong:"strong",...(0,d.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.header,{children:(0,s.jsx)(n.h1,{id:"interface-containerinfo",children:"Interface: ContainerInfo"})}),"\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.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2293",children:"packages/extension-api/src/extension-api.d.ts:2293"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"created",children:"Created"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Created"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2294",children:"packages/extension-api/src/extension-api.d.ts:2294"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"hostconfig",children:"HostConfig"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"HostConfig"}),": ",(0,s.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"networkmode",children:"NetworkMode"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"NetworkMode"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-2",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2299",children:"packages/extension-api/src/extension-api.d.ts:2299"})}),"\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:"defined-in-3",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2289",children:"packages/extension-api/src/extension-api.d.ts:2289"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"image",children:"Image"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Image"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-4",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2291",children:"packages/extension-api/src/extension-api.d.ts:2291"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"imageid",children:"ImageID"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"ImageID"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-5",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2292",children:"packages/extension-api/src/extension-api.d.ts:2292"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"labels",children:"Labels"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Labels"}),": ",(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:"label"}),": ",(0,s.jsx)(n.code,{children:"string"}),"]: ",(0,s.jsx)(n.code,{children:"string"})]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-6",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2296",children:"packages/extension-api/src/extension-api.d.ts:2296"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"mounts",children:"Mounts"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Mounts"}),": ",(0,s.jsx)(n.code,{children:"object"}),"[]"]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-7",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2305",children:"packages/extension-api/src/extension-api.d.ts:2305"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"names",children:"Names"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Names"}),": ",(0,s.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-8",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2290",children:"packages/extension-api/src/extension-api.d.ts:2290"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"networksettings",children:"NetworkSettings"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"NetworkSettings"}),": ",(0,s.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"networks",children:"Networks"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Networks"}),": ",(0,s.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,s.jsx)(n.h5,{id:"index-signature-1",children:"Index Signature"}),"\n",(0,s.jsxs)(n.p,{children:["[",(0,s.jsx)(n.code,{children:"networkType"}),": ",(0,s.jsx)(n.code,{children:"string"}),"]: ",(0,s.jsx)(n.a,{href:"/api/interfaces/NetworkInfo",children:(0,s.jsx)(n.code,{children:"NetworkInfo"})})]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-9",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2302",children:"packages/extension-api/src/extension-api.d.ts:2302"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"ports",children:"Ports"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Ports"}),": ",(0,s.jsx)(n.a,{href:"/api/interfaces/Port",children:(0,s.jsx)(n.code,{children:"Port"})}),"[]"]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-10",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2295",children:"packages/extension-api/src/extension-api.d.ts:2295"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"state",children:"State"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"State"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-11",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2297",children:"packages/extension-api/src/extension-api.d.ts:2297"})}),"\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:"defined-in-12",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2298",children:"packages/extension-api/src/extension-api.d.ts:2298"})}),"\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.h4,{id:"defined-in-13",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2286",children:"packages/extension-api/src/extension-api.d.ts:2286"})}),"\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.h4,{id:"defined-in-14",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2287",children:"packages/extension-api/src/extension-api.d.ts:2287"})}),"\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.h4,{id:"defined-in-15",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2288",children:"packages/extension-api/src/extension-api.d.ts:2288"})})]})}function h(e={}){const{wrapper:n}={...(0,d.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},43023:(e,n,i)=>{i.d(n,{R:()=>a,x:()=>c});var s=i(63696);const d={},t=s.createContext(d);function a(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(d):e.components||d:a(e.components),s.createElement(t.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/3f797343.b9f35c84.js b/assets/js/3f797343.1c8c5232.js similarity index 94% rename from assets/js/3f797343.b9f35c84.js rename to assets/js/3f797343.1c8c5232.js index 3addecdfb65..a3b0a8293d8 100644 --- a/assets/js/3f797343.b9f35c84.js +++ b/assets/js/3f797343.1c8c5232.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[43665],{77041:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>a,contentTitle:()=>s,default:()=>p,frontMatter:()=>o,metadata:()=>c,toc:()=>d});var t=i(62540),r=i(43023);const o={},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:"Defined in",id:"defined-in",level:4},{value:"token?",id:"token",level:3},{value:"Defined in",id:"defined-in-1",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",p:"p",strong:"strong",...(0,r.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.header,{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:"defined-in",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L589",children:"packages/extension-api/src/extension-api.d.ts:589"})}),"\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:"defined-in-1",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L590",children:"packages/extension-api/src/extension-api.d.ts:590"})})]})}function p(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},43023:(e,n,i)=>{i.d(n,{R:()=>s,x:()=>c});var t=i(63696);const r={},o=t.createContext(r);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(r):e.components||r:s(e.components),t.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[43665],{77041:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>a,contentTitle:()=>s,default:()=>p,frontMatter:()=>o,metadata:()=>c,toc:()=>d});var t=i(62540),r=i(43023);const o={},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:"Defined in",id:"defined-in",level:4},{value:"token?",id:"token",level:3},{value:"Defined in",id:"defined-in-1",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",p:"p",strong:"strong",...(0,r.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.header,{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:"defined-in",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L589",children:"packages/extension-api/src/extension-api.d.ts:589"})}),"\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:"defined-in-1",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L590",children:"packages/extension-api/src/extension-api.d.ts:590"})})]})}function p(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},43023:(e,n,i)=>{i.d(n,{R:()=>s,x:()=>c});var t=i(63696);const r={},o=t.createContext(r);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(r):e.components||r:s(e.components),t.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/40d377be.43a445e1.js b/assets/js/40d377be.f890c78e.js similarity index 88% rename from assets/js/40d377be.43a445e1.js rename to assets/js/40d377be.f890c78e.js index 851d52c843a..37ed3809c50 100644 --- a/assets/js/40d377be.43a445e1.js +++ b/assets/js/40d377be.f890c78e.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[54333],{57968:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>o,contentTitle:()=>r,default:()=>p,frontMatter:()=>a,metadata:()=>d,toc:()=>c});var s=i(62540),t=i(43023);const a={},r="Interface: ManifestCreateOptions",d={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"}},o={},c=[{value:"Properties",id:"properties",level:2},{value:"all?",id:"all",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"amend?",id:"amend",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"images",id:"images",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"name",id:"name",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"provider?",id:"provider",level:3},{value:"Defined in",id:"defined-in-4",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",p:"p",strong:"strong",...(0,t.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.header,{children:(0,s.jsx)(n.h1,{id:"interface-manifestcreateoptions",children:"Interface: ManifestCreateOptions"})}),"\n",(0,s.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,s.jsx)(n.h3,{id:"all",children:"all?"}),"\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:"all"}),": ",(0,s.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L436",children:"packages/extension-api/src/extension-api.d.ts:436"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"amend",children:"amend?"}),"\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:"amend"}),": ",(0,s.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L435",children:"packages/extension-api/src/extension-api.d.ts:435"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"images",children:"images"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"images"}),": ",(0,s.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-2",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L433",children:"packages/extension-api/src/extension-api.d.ts:433"})}),"\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:"defined-in-3",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L434",children:"packages/extension-api/src/extension-api.d.ts:434"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"provider",children:"provider?"}),"\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:"provider"}),": ",(0,s.jsx)(n.a,{href:"/api/interfaces/ContainerProviderConnection",children:(0,s.jsx)(n.code,{children:"ContainerProviderConnection"})})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-4",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L439",children:"packages/extension-api/src/extension-api.d.ts:439"})})]})}function p(e={}){const{wrapper:n}={...(0,t.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},43023:(e,n,i)=>{i.d(n,{R:()=>r,x:()=>d});var s=i(63696);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 d(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:r(e.components),s.createElement(a.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[54333],{57968:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>o,contentTitle:()=>r,default:()=>p,frontMatter:()=>a,metadata:()=>d,toc:()=>c});var s=i(62540),t=i(43023);const a={},r="Interface: ManifestCreateOptions",d={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"}},o={},c=[{value:"Properties",id:"properties",level:2},{value:"all?",id:"all",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"amend?",id:"amend",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"images",id:"images",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"name",id:"name",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"provider?",id:"provider",level:3},{value:"Defined in",id:"defined-in-4",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",p:"p",strong:"strong",...(0,t.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.header,{children:(0,s.jsx)(n.h1,{id:"interface-manifestcreateoptions",children:"Interface: ManifestCreateOptions"})}),"\n",(0,s.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,s.jsx)(n.h3,{id:"all",children:"all?"}),"\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:"all"}),": ",(0,s.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L436",children:"packages/extension-api/src/extension-api.d.ts:436"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"amend",children:"amend?"}),"\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:"amend"}),": ",(0,s.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L435",children:"packages/extension-api/src/extension-api.d.ts:435"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"images",children:"images"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"images"}),": ",(0,s.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-2",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L433",children:"packages/extension-api/src/extension-api.d.ts:433"})}),"\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:"defined-in-3",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L434",children:"packages/extension-api/src/extension-api.d.ts:434"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"provider",children:"provider?"}),"\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:"provider"}),": ",(0,s.jsx)(n.a,{href:"/api/interfaces/ContainerProviderConnection",children:(0,s.jsx)(n.code,{children:"ContainerProviderConnection"})})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-4",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L439",children:"packages/extension-api/src/extension-api.d.ts:439"})})]})}function p(e={}){const{wrapper:n}={...(0,t.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},43023:(e,n,i)=>{i.d(n,{R:()=>r,x:()=>d});var s=i(63696);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 d(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/416d4fcf.d6be3ff6.js b/assets/js/416d4fcf.92783c64.js similarity index 93% rename from assets/js/416d4fcf.d6be3ff6.js rename to assets/js/416d4fcf.92783c64.js index 4fd75c4582b..5d60054354b 100644 --- a/assets/js/416d4fcf.d6be3ff6.js +++ b/assets/js/416d4fcf.92783c64.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[53125],{59595:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>c,contentTitle:()=>s,default:()=>h,frontMatter:()=>a,metadata:()=>o,toc:()=>d});var t=i(62540),r=i(43023);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:"Defined in",id:"defined-in",level:4},{value:"id",id:"id",level:3},{value:"Defined in",id:"defined-in-1",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",p:"p",strong:"strong",...(0,r.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.header,{children:(0,t.jsx)(n.h1,{id:"interface-containercreateresult",children:"Interface: ContainerCreateResult"})}),"\n",(0,t.jsxs)(n.p,{children:["Information about the container created by calling the ",(0,t.jsx)(n.a,{href:"/api/namespaces/containerEngine/functions/createContainer",children:"containerEngine.createContainer"})," method"]}),"\n",(0,t.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,t.jsx)(n.h3,{id:"engineid",children:"engineId"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"engineId"}),": ",(0,t.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"the engineId where the container is running"}),"\n",(0,t.jsx)(n.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L3054",children:"packages/extension-api/src/extension-api.d.ts:3054"})}),"\n",(0,t.jsx)(n.hr,{}),"\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.jsxs)(n.p,{children:["a string uniquely identifying the created container, which can be used to execute other methods on the container (",(0,t.jsx)(n.a,{href:"/api/namespaces/containerEngine/functions/deleteContainer",children:"containerEngine.deleteContainer"}),", ",(0,t.jsx)(n.a,{href:"/api/namespaces/containerEngine/functions/inspectContainer",children:"containerEngine.inspectContainer"}),", ",(0,t.jsx)(n.a,{href:"/api/namespaces/containerEngine/functions/startContainer",children:"containerEngine.startContainer"}),", ",(0,t.jsx)(n.a,{href:"/api/namespaces/containerEngine/functions/stopContainer",children:"containerEngine.stopContainer"}),", ",(0,t.jsx)(n.a,{href:"/api/namespaces/containerEngine/functions/logsContainer",children:"containerEngine.logsContainer"}),")"]}),"\n",(0,t.jsx)(n.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L3050",children:"packages/extension-api/src/extension-api.d.ts:3050"})})]})}function h(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},43023:(e,n,i)=>{i.d(n,{R:()=>s,x:()=>o});var t=i(63696);const r={},a=t.createContext(r);function s(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:s(e.components),t.createElement(a.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[53125],{59595:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>c,contentTitle:()=>s,default:()=>h,frontMatter:()=>a,metadata:()=>o,toc:()=>d});var t=i(62540),r=i(43023);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:"Defined in",id:"defined-in",level:4},{value:"id",id:"id",level:3},{value:"Defined in",id:"defined-in-1",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",p:"p",strong:"strong",...(0,r.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.header,{children:(0,t.jsx)(n.h1,{id:"interface-containercreateresult",children:"Interface: ContainerCreateResult"})}),"\n",(0,t.jsxs)(n.p,{children:["Information about the container created by calling the ",(0,t.jsx)(n.a,{href:"/api/namespaces/containerEngine/functions/createContainer",children:"containerEngine.createContainer"})," method"]}),"\n",(0,t.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,t.jsx)(n.h3,{id:"engineid",children:"engineId"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"engineId"}),": ",(0,t.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"the engineId where the container is running"}),"\n",(0,t.jsx)(n.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L3054",children:"packages/extension-api/src/extension-api.d.ts:3054"})}),"\n",(0,t.jsx)(n.hr,{}),"\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.jsxs)(n.p,{children:["a string uniquely identifying the created container, which can be used to execute other methods on the container (",(0,t.jsx)(n.a,{href:"/api/namespaces/containerEngine/functions/deleteContainer",children:"containerEngine.deleteContainer"}),", ",(0,t.jsx)(n.a,{href:"/api/namespaces/containerEngine/functions/inspectContainer",children:"containerEngine.inspectContainer"}),", ",(0,t.jsx)(n.a,{href:"/api/namespaces/containerEngine/functions/startContainer",children:"containerEngine.startContainer"}),", ",(0,t.jsx)(n.a,{href:"/api/namespaces/containerEngine/functions/stopContainer",children:"containerEngine.stopContainer"}),", ",(0,t.jsx)(n.a,{href:"/api/namespaces/containerEngine/functions/logsContainer",children:"containerEngine.logsContainer"}),")"]}),"\n",(0,t.jsx)(n.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L3050",children:"packages/extension-api/src/extension-api.d.ts:3050"})})]})}function h(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},43023:(e,n,i)=>{i.d(n,{R:()=>s,x:()=>o});var t=i(63696);const r={},a=t.createContext(r);function s(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:s(e.components),t.createElement(a.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/41b2e801.aad08605.js b/assets/js/41b2e801.95839f24.js similarity index 96% rename from assets/js/41b2e801.aad08605.js rename to assets/js/41b2e801.95839f24.js index 33510576afd..d9f3fb3f9ab 100644 --- a/assets/js/41b2e801.aad08605.js +++ b/assets/js/41b2e801.95839f24.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[49244],{18170:(e,r,n)=>{n.r(r),n.d(r,{assets:()=>o,contentTitle:()=>t,default:()=>l,frontMatter:()=>a,metadata:()=>c,toc:()=>d});var i=n(62540),s=n(43023);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:"imageChecker",permalink:"/api/namespaces/imageChecker/"},next:{title:"kubernetes",permalink:"/api/namespaces/kubernetes/"}},o={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Defined in",id:"defined-in",level:2}];function h(e){const r={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",strong:"strong",...(0,s.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(r.header,{children:(0,i.jsx)(r.h1,{id:"function-registerimagecheckerprovider",children:"Function: registerImageCheckerProvider()"})}),"\n",(0,i.jsxs)(r.blockquote,{children:["\n",(0,i.jsxs)(r.p,{children:[(0,i.jsx)(r.strong,{children:"registerImageCheckerProvider"}),"(",(0,i.jsx)(r.code,{children:"imageCheckerProvider"}),", ",(0,i.jsx)(r.code,{children:"metadata"}),"?): ",(0,i.jsx)(r.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(r.code,{children:"Disposable"})})]}),"\n"]}),"\n",(0,i.jsx)(r.p,{children:"Register the extension as an Image Checker."}),"\n",(0,i.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,i.jsx)(r.h2,{id:"parameters",children:"Parameters"}),"\n",(0,i.jsxs)(r.p,{children:["\u2022 ",(0,i.jsx)(r.strong,{children:"imageCheckerProvider"}),": ",(0,i.jsx)(r.a,{href:"/api/interfaces/ImageCheckerProvider",children:(0,i.jsx)(r.code,{children:"ImageCheckerProvider"})})]}),"\n",(0,i.jsxs)(r.p,{children:["an object implementing the ",(0,i.jsx)(r.code,{children:"ImageCheckerProvider"})," interface"]}),"\n",(0,i.jsxs)(r.p,{children:["\u2022 ",(0,i.jsx)(r.strong,{children:"metadata?"}),": ",(0,i.jsx)(r.a,{href:"/api/interfaces/ImageCheckerProviderMetadata",children:(0,i.jsx)(r.code,{children:"ImageCheckerProviderMetadata"})})]}),"\n",(0,i.jsx)(r.p,{children:"optional metadata attached to this provider"}),"\n",(0,i.jsx)(r.h2,{id:"returns",children:"Returns"}),"\n",(0,i.jsx)(r.p,{children:(0,i.jsx)(r.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(r.code,{children:"Disposable"})})}),"\n",(0,i.jsx)(r.p,{children:"A disposable that unregisters this provider when being disposed"}),"\n",(0,i.jsx)(r.h2,{id:"defined-in",children:"Defined in"}),"\n",(0,i.jsx)(r.p,{children:(0,i.jsx)(r.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L4490",children:"packages/extension-api/src/extension-api.d.ts:4490"})})]})}function l(e={}){const{wrapper:r}={...(0,s.R)(),...e.components};return r?(0,i.jsx)(r,{...e,children:(0,i.jsx)(h,{...e})}):h(e)}},43023:(e,r,n)=>{n.d(r,{R:()=>t,x:()=>c});var i=n(63696);const s={},a=i.createContext(s);function t(e){const r=i.useContext(a);return i.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:t(e.components),i.createElement(a.Provider,{value:r},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[49244],{18170:(e,r,n)=>{n.r(r),n.d(r,{assets:()=>o,contentTitle:()=>t,default:()=>l,frontMatter:()=>a,metadata:()=>c,toc:()=>d});var i=n(62540),s=n(43023);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:"imageChecker",permalink:"/api/namespaces/imageChecker/"},next:{title:"kubernetes",permalink:"/api/namespaces/kubernetes/"}},o={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Defined in",id:"defined-in",level:2}];function h(e){const r={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",strong:"strong",...(0,s.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(r.header,{children:(0,i.jsx)(r.h1,{id:"function-registerimagecheckerprovider",children:"Function: registerImageCheckerProvider()"})}),"\n",(0,i.jsxs)(r.blockquote,{children:["\n",(0,i.jsxs)(r.p,{children:[(0,i.jsx)(r.strong,{children:"registerImageCheckerProvider"}),"(",(0,i.jsx)(r.code,{children:"imageCheckerProvider"}),", ",(0,i.jsx)(r.code,{children:"metadata"}),"?): ",(0,i.jsx)(r.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(r.code,{children:"Disposable"})})]}),"\n"]}),"\n",(0,i.jsx)(r.p,{children:"Register the extension as an Image Checker."}),"\n",(0,i.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,i.jsx)(r.h2,{id:"parameters",children:"Parameters"}),"\n",(0,i.jsxs)(r.p,{children:["\u2022 ",(0,i.jsx)(r.strong,{children:"imageCheckerProvider"}),": ",(0,i.jsx)(r.a,{href:"/api/interfaces/ImageCheckerProvider",children:(0,i.jsx)(r.code,{children:"ImageCheckerProvider"})})]}),"\n",(0,i.jsxs)(r.p,{children:["an object implementing the ",(0,i.jsx)(r.code,{children:"ImageCheckerProvider"})," interface"]}),"\n",(0,i.jsxs)(r.p,{children:["\u2022 ",(0,i.jsx)(r.strong,{children:"metadata?"}),": ",(0,i.jsx)(r.a,{href:"/api/interfaces/ImageCheckerProviderMetadata",children:(0,i.jsx)(r.code,{children:"ImageCheckerProviderMetadata"})})]}),"\n",(0,i.jsx)(r.p,{children:"optional metadata attached to this provider"}),"\n",(0,i.jsx)(r.h2,{id:"returns",children:"Returns"}),"\n",(0,i.jsx)(r.p,{children:(0,i.jsx)(r.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(r.code,{children:"Disposable"})})}),"\n",(0,i.jsx)(r.p,{children:"A disposable that unregisters this provider when being disposed"}),"\n",(0,i.jsx)(r.h2,{id:"defined-in",children:"Defined in"}),"\n",(0,i.jsx)(r.p,{children:(0,i.jsx)(r.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L4490",children:"packages/extension-api/src/extension-api.d.ts:4490"})})]})}function l(e={}){const{wrapper:r}={...(0,s.R)(),...e.components};return r?(0,i.jsx)(r,{...e,children:(0,i.jsx)(h,{...e})}):h(e)}},43023:(e,r,n)=>{n.d(r,{R:()=>t,x:()=>c});var i=n(63696);const s={},a=i.createContext(s);function t(e){const r=i.useContext(a);return i.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:t(e.components),i.createElement(a.Provider,{value:r},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/423842d7.13faa63f.js b/assets/js/423842d7.c7ef4c84.js similarity index 96% rename from assets/js/423842d7.13faa63f.js rename to assets/js/423842d7.c7ef4c84.js index 83435fb8e95..c33ecadff73 100644 --- a/assets/js/423842d7.13faa63f.js +++ b/assets/js/423842d7.c7ef4c84.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[69725],{50406:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>o,default:()=>p,frontMatter:()=>i,metadata:()=>c,toc:()=>d});var r=t(62540),s=t(43023);const i={},o="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={},d=[{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:"Defined in",id:"defined-in",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",header:"header",p:"p",strong:"strong",...(0,s.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.header,{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:"defined-in",children:"Defined in"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2140",children:"packages/extension-api/src/extension-api.d.ts:2140"})})]})}function p(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(l,{...e})}):l(e)}},43023:(e,n,t)=>{t.d(n,{R:()=>o,x:()=>c});var r=t(63696);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 +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[69725],{50406:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>o,default:()=>p,frontMatter:()=>i,metadata:()=>c,toc:()=>d});var r=t(62540),s=t(43023);const i={},o="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={},d=[{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:"Defined in",id:"defined-in",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",header:"header",p:"p",strong:"strong",...(0,s.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.header,{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:"defined-in",children:"Defined in"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2140",children:"packages/extension-api/src/extension-api.d.ts:2140"})})]})}function p(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(l,{...e})}):l(e)}},43023:(e,n,t)=>{t.d(n,{R:()=>o,x:()=>c});var r=t(63696);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/42b67a8e.00c64008.js b/assets/js/42b67a8e.e043536a.js similarity index 81% rename from assets/js/42b67a8e.00c64008.js rename to assets/js/42b67a8e.e043536a.js index 659e890fc66..3d8e4840529 100644 --- a/assets/js/42b67a8e.00c64008.js +++ b/assets/js/42b67a8e.e043536a.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[61036],{32470:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>c,contentTitle:()=>o,default:()=>p,frontMatter:()=>r,metadata:()=>a,toc:()=>d});var i=t(62540),s=t(43023);const r={},o="Interface: HostRestartPolicy",a={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"}},c={},d=[{value:"Properties",id:"properties",level:2},{value:"MaximumRetryCount?",id:"maximumretrycount",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"Name",id:"name",level:3},{value:"Defined in",id:"defined-in-1",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",p:"p",strong:"strong",...(0,s.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.header,{children:(0,i.jsx)(n.h1,{id:"interface-hostrestartpolicy",children:"Interface: HostRestartPolicy"})}),"\n",(0,i.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(n.h3,{id:"maximumretrycount",children:"MaximumRetryCount?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"MaximumRetryCount"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/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:"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:"defined-in-1",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2385",children:"packages/extension-api/src/extension-api.d.ts:2385"})})]})}function p(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},43023:(e,n,t)=>{t.d(n,{R:()=>o,x:()=>a});var i=t(63696);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([[61036],{32470:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>o,default:()=>p,frontMatter:()=>r,metadata:()=>c,toc:()=>d});var i=t(62540),s=t(43023);const r={},o="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:"Defined in",id:"defined-in",level:4},{value:"Name",id:"name",level:3},{value:"Defined in",id:"defined-in-1",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",p:"p",strong:"strong",...(0,s.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.header,{children:(0,i.jsx)(n.h1,{id:"interface-hostrestartpolicy",children:"Interface: HostRestartPolicy"})}),"\n",(0,i.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(n.h3,{id:"maximumretrycount",children:"MaximumRetryCount?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"MaximumRetryCount"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/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:"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:"defined-in-1",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2385",children:"packages/extension-api/src/extension-api.d.ts:2385"})})]})}function p(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},43023:(e,n,t)=>{t.d(n,{R:()=>o,x:()=>c});var i=t(63696);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/43be69c9.24a8a188.js b/assets/js/43be69c9.c1514293.js similarity index 92% rename from assets/js/43be69c9.24a8a188.js rename to assets/js/43be69c9.c1514293.js index f3fc1e74f71..f9d90a3bc02 100644 --- a/assets/js/43be69c9.24a8a188.js +++ b/assets/js/43be69c9.c1514293.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[76228],{42924:(e,i,n)=>{n.r(i),n.d(i,{assets:()=>a,contentTitle:()=>d,default:()=>l,frontMatter:()=>c,metadata:()=>r,toc:()=>o});var s=n(62540),t=n(43023);const c={},d="Interface: QuickPickItem",r={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={},o=[{value:"Properties",id:"properties",level:2},{value:"alwaysShow?",id:"alwaysshow",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"buttons?",id:"buttons",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"description?",id:"description",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"detail?",id:"detail",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"kind?",id:"kind",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"label",id:"label",level:3},{value:"Defined in",id:"defined-in-5",level:4},{value:"picked?",id:"picked",level:3},{value:"See",id:"see",level:4},{value:"Defined in",id:"defined-in-6",level:4}];function h(e){const i={a:"a",blockquote:"blockquote",code:"code",em:"em",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",p:"p",strong:"strong",...(0,t.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(i.header,{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:"defined-in",children:"Defined in"}),"\n",(0,s.jsx)(i.p,{children:(0,s.jsx)(i.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L1329",children:"packages/extension-api/src/extension-api.d.ts:1329"})}),"\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:"defined-in-1",children:"Defined in"}),"\n",(0,s.jsx)(i.p,{children:(0,s.jsx)(i.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L1339",children:"packages/extension-api/src/extension-api.d.ts:1339"})}),"\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:"defined-in-2",children:"Defined in"}),"\n",(0,s.jsx)(i.p,{children:(0,s.jsx)(i.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L1301",children:"packages/extension-api/src/extension-api.d.ts:1301"})}),"\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:"defined-in-3",children:"Defined in"}),"\n",(0,s.jsx)(i.p,{children:(0,s.jsx)(i.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L1309",children:"packages/extension-api/src/extension-api.d.ts:1309"})}),"\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:"defined-in-4",children:"Defined in"}),"\n",(0,s.jsx)(i.p,{children:(0,s.jsx)(i.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L1293",children:"packages/extension-api/src/extension-api.d.ts:1293"})}),"\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:"defined-in-5",children:"Defined in"}),"\n",(0,s.jsx)(i.p,{children:(0,s.jsx)(i.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L1287",children:"packages/extension-api/src/extension-api.d.ts:1287"})}),"\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:"defined-in-6",children:"Defined in"}),"\n",(0,s.jsx)(i.p,{children:(0,s.jsx)(i.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L1322",children:"packages/extension-api/src/extension-api.d.ts:1322"})})]})}function l(e={}){const{wrapper:i}={...(0,t.R)(),...e.components};return i?(0,s.jsx)(i,{...e,children:(0,s.jsx)(h,{...e})}):h(e)}},43023:(e,i,n)=>{n.d(i,{R:()=>d,x:()=>r});var s=n(63696);const t={},c=s.createContext(t);function d(e){const i=s.useContext(c);return s.useMemo((function(){return"function"==typeof e?e(i):{...i,...e}}),[i,e])}function r(e){let i;return i=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:d(e.components),s.createElement(c.Provider,{value:i},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[76228],{42924:(e,i,n)=>{n.r(i),n.d(i,{assets:()=>a,contentTitle:()=>d,default:()=>l,frontMatter:()=>c,metadata:()=>r,toc:()=>o});var s=n(62540),t=n(43023);const c={},d="Interface: QuickPickItem",r={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={},o=[{value:"Properties",id:"properties",level:2},{value:"alwaysShow?",id:"alwaysshow",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"buttons?",id:"buttons",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"description?",id:"description",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"detail?",id:"detail",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"kind?",id:"kind",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"label",id:"label",level:3},{value:"Defined in",id:"defined-in-5",level:4},{value:"picked?",id:"picked",level:3},{value:"See",id:"see",level:4},{value:"Defined in",id:"defined-in-6",level:4}];function h(e){const i={a:"a",blockquote:"blockquote",code:"code",em:"em",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",p:"p",strong:"strong",...(0,t.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(i.header,{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:"defined-in",children:"Defined in"}),"\n",(0,s.jsx)(i.p,{children:(0,s.jsx)(i.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L1329",children:"packages/extension-api/src/extension-api.d.ts:1329"})}),"\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:"defined-in-1",children:"Defined in"}),"\n",(0,s.jsx)(i.p,{children:(0,s.jsx)(i.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L1339",children:"packages/extension-api/src/extension-api.d.ts:1339"})}),"\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:"defined-in-2",children:"Defined in"}),"\n",(0,s.jsx)(i.p,{children:(0,s.jsx)(i.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L1301",children:"packages/extension-api/src/extension-api.d.ts:1301"})}),"\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:"defined-in-3",children:"Defined in"}),"\n",(0,s.jsx)(i.p,{children:(0,s.jsx)(i.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L1309",children:"packages/extension-api/src/extension-api.d.ts:1309"})}),"\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:"defined-in-4",children:"Defined in"}),"\n",(0,s.jsx)(i.p,{children:(0,s.jsx)(i.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L1293",children:"packages/extension-api/src/extension-api.d.ts:1293"})}),"\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:"defined-in-5",children:"Defined in"}),"\n",(0,s.jsx)(i.p,{children:(0,s.jsx)(i.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L1287",children:"packages/extension-api/src/extension-api.d.ts:1287"})}),"\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:"defined-in-6",children:"Defined in"}),"\n",(0,s.jsx)(i.p,{children:(0,s.jsx)(i.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L1322",children:"packages/extension-api/src/extension-api.d.ts:1322"})})]})}function l(e={}){const{wrapper:i}={...(0,t.R)(),...e.components};return i?(0,s.jsx)(i,{...e,children:(0,s.jsx)(h,{...e})}):h(e)}},43023:(e,i,n)=>{n.d(i,{R:()=>d,x:()=>r});var s=n(63696);const t={},c=s.createContext(t);function d(e){const i=s.useContext(c);return s.useMemo((function(){return"function"==typeof e?e(i):{...i,...e}}),[i,e])}function r(e){let i;return i=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:d(e.components),s.createElement(c.Provider,{value:i},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/43f3fe28.60e01bd6.js b/assets/js/43f3fe28.0f7ab352.js similarity index 92% rename from assets/js/43f3fe28.60e01bd6.js rename to assets/js/43f3fe28.0f7ab352.js index 73410120ada..af93c2f93c4 100644 --- a/assets/js/43f3fe28.60e01bd6.js +++ b/assets/js/43f3fe28.0f7ab352.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[43164],{28149:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>d,contentTitle:()=>t,default:()=>h,frontMatter:()=>l,metadata:()=>o,toc:()=>c});var s=i(62540),r=i(43023);const l={},t="Interface: CliToolInstaller",o={id:"interfaces/CliToolInstaller",title:"Interface: CliToolInstaller",description:"Properties",source:"@site/api/interfaces/CliToolInstaller.md",sourceDirName:"interfaces",slug:"/interfaces/CliToolInstaller",permalink:"/api/interfaces/CliToolInstaller",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"CliToolInfo",permalink:"/api/interfaces/CliToolInfo"},next:{title:"CliToolOptions",permalink:"/api/interfaces/CliToolOptions"}},d={},c=[{value:"Properties",id:"properties",level:2},{value:"doInstall()",id:"doinstall",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"doUninstall()",id:"douninstall",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"selectVersion()",id:"selectversion",level:3},{value:"Returns",id:"returns-2",level:4},{value:"Defined in",id:"defined-in-2",level:4}];function a(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",p:"p",strong:"strong",...(0,r.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.header,{children:(0,s.jsx)(n.h1,{id:"interface-clitoolinstaller",children:"Interface: CliToolInstaller"})}),"\n",(0,s.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,s.jsx)(n.h3,{id:"doinstall",children:"doInstall()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"doInstall"}),": (",(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:"defined-in",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L4358",children:"packages/extension-api/src/extension-api.d.ts:4358"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"douninstall",children:"doUninstall()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"doUninstall"}),": (",(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-1",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:"defined-in-1",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L4359",children:"packages/extension-api/src/extension-api.d.ts:4359"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"selectversion",children:"selectVersion()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"selectVersion"}),": () => ",(0,s.jsx)(n.code,{children:"Promise"}),"<",(0,s.jsx)(n.code,{children:"string"}),">"]}),"\n"]}),"\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:"string"}),">"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-2",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L4357",children:"packages/extension-api/src/extension-api.d.ts:4357"})})]})}function h(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(a,{...e})}):a(e)}},43023:(e,n,i)=>{i.d(n,{R:()=>t,x:()=>o});var s=i(63696);const r={},l=s.createContext(r);function t(e){const n=s.useContext(l);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(l.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[43164],{28149:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>d,contentTitle:()=>t,default:()=>h,frontMatter:()=>l,metadata:()=>o,toc:()=>c});var s=i(62540),r=i(43023);const l={},t="Interface: CliToolInstaller",o={id:"interfaces/CliToolInstaller",title:"Interface: CliToolInstaller",description:"Properties",source:"@site/api/interfaces/CliToolInstaller.md",sourceDirName:"interfaces",slug:"/interfaces/CliToolInstaller",permalink:"/api/interfaces/CliToolInstaller",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"CliToolInfo",permalink:"/api/interfaces/CliToolInfo"},next:{title:"CliToolOptions",permalink:"/api/interfaces/CliToolOptions"}},d={},c=[{value:"Properties",id:"properties",level:2},{value:"doInstall()",id:"doinstall",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"doUninstall()",id:"douninstall",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"selectVersion()",id:"selectversion",level:3},{value:"Returns",id:"returns-2",level:4},{value:"Defined in",id:"defined-in-2",level:4}];function a(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",p:"p",strong:"strong",...(0,r.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.header,{children:(0,s.jsx)(n.h1,{id:"interface-clitoolinstaller",children:"Interface: CliToolInstaller"})}),"\n",(0,s.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,s.jsx)(n.h3,{id:"doinstall",children:"doInstall()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"doInstall"}),": (",(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:"defined-in",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L4358",children:"packages/extension-api/src/extension-api.d.ts:4358"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"douninstall",children:"doUninstall()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"doUninstall"}),": (",(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-1",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:"defined-in-1",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L4359",children:"packages/extension-api/src/extension-api.d.ts:4359"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"selectversion",children:"selectVersion()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"selectVersion"}),": () => ",(0,s.jsx)(n.code,{children:"Promise"}),"<",(0,s.jsx)(n.code,{children:"string"}),">"]}),"\n"]}),"\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:"string"}),">"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-2",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L4357",children:"packages/extension-api/src/extension-api.d.ts:4357"})})]})}function h(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(a,{...e})}):a(e)}},43023:(e,n,i)=>{i.d(n,{R:()=>t,x:()=>o});var s=i(63696);const r={},l=s.createContext(r);function t(e){const n=s.useContext(l);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(l.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/44287967.dbe4df9e.js b/assets/js/44287967.a26b0af7.js similarity index 98% rename from assets/js/44287967.dbe4df9e.js rename to assets/js/44287967.a26b0af7.js index a6584fda943..2da22b0ee5e 100644 --- a/assets/js/44287967.dbe4df9e.js +++ b/assets/js/44287967.a26b0af7.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[22496],{54143:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>c,contentTitle:()=>r,default:()=>p,frontMatter:()=>a,metadata:()=>o,toc:()=>d});var t=s(62540),i=s(43023);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={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Example",id:"example",level:2},{value:"Defined in",id:"defined-in",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",pre:"pre",strong:"strong",...(0,i.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.header,{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:"defined-in",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L3527",children:"packages/extension-api/src/extension-api.d.ts:3527"})})]})}function p(e={}){const{wrapper:n}={...(0,i.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},43023:(e,n,s)=>{s.d(n,{R:()=>r,x:()=>o});var t=s(63696);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([[22496],{54143:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>c,contentTitle:()=>r,default:()=>p,frontMatter:()=>a,metadata:()=>o,toc:()=>d});var t=s(62540),i=s(43023);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={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Example",id:"example",level:2},{value:"Defined in",id:"defined-in",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",pre:"pre",strong:"strong",...(0,i.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.header,{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:"defined-in",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L3527",children:"packages/extension-api/src/extension-api.d.ts:3527"})})]})}function p(e={}){const{wrapper:n}={...(0,i.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},43023:(e,n,s)=>{s.d(n,{R:()=>r,x:()=>o});var t=s(63696);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.7a2fcb35.js b/assets/js/456c0e28.a122a075.js similarity index 82% rename from assets/js/456c0e28.7a2fcb35.js rename to assets/js/456c0e28.a122a075.js index 38c97cbd435..f938000601e 100644 --- a/assets/js/456c0e28.7a2fcb35.js +++ b/assets/js/456c0e28.a122a075.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[50740],{19051:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>a,contentTitle:()=>o,default:()=>p,frontMatter:()=>r,metadata:()=>d,toc:()=>c});var t=i(62540),s=i(43023);const r={},o="Interface: PodContainerInfo",d={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={},c=[{value:"Properties",id:"properties",level:2},{value:"Id",id:"id",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"Names",id:"names",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"Status",id:"status",level:3},{value:"Defined in",id:"defined-in-2",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",p:"p",strong:"strong",...(0,s.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.header,{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:"defined-in",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2340",children:"packages/extension-api/src/extension-api.d.ts:2340"})}),"\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:"defined-in-1",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2341",children:"packages/extension-api/src/extension-api.d.ts:2341"})}),"\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:"defined-in-2",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2342",children:"packages/extension-api/src/extension-api.d.ts:2342"})})]})}function p(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},43023:(e,n,i)=>{i.d(n,{R:()=>o,x:()=>d});var t=i(63696);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 d(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 +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[50740],{19051:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>d,contentTitle:()=>o,default:()=>p,frontMatter:()=>r,metadata:()=>a,toc:()=>c});var t=i(62540),s=i(43023);const r={},o="Interface: PodContainerInfo",a={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"}},d={},c=[{value:"Properties",id:"properties",level:2},{value:"Id",id:"id",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"Names",id:"names",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"Status",id:"status",level:3},{value:"Defined in",id:"defined-in-2",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",p:"p",strong:"strong",...(0,s.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.header,{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:"defined-in",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2340",children:"packages/extension-api/src/extension-api.d.ts:2340"})}),"\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:"defined-in-1",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2341",children:"packages/extension-api/src/extension-api.d.ts:2341"})}),"\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:"defined-in-2",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2342",children:"packages/extension-api/src/extension-api.d.ts:2342"})})]})}function p(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},43023:(e,n,i)=>{i.d(n,{R:()=>o,x:()=>a});var t=i(63696);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 a(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/46669adc.5034f00d.js b/assets/js/46669adc.21f58b85.js similarity index 76% rename from assets/js/46669adc.5034f00d.js rename to assets/js/46669adc.21f58b85.js index 5d93a28eb4f..2a9b18880c8 100644 --- a/assets/js/46669adc.5034f00d.js +++ b/assets/js/46669adc.21f58b85.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[39164],{8123:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>o,contentTitle:()=>d,default:()=>p,frontMatter:()=>s,metadata:()=>c,toc:()=>a});var i=t(62540),r=t(43023);const s={},d="Interface: AuditRecord",c={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"}},o={},a=[{value:"Properties",id:"properties",level:2},{value:"record",id:"record",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"type",id:"type",level:3},{value:"Defined in",id:"defined-in-1",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",p:"p",strong:"strong",...(0,r.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.header,{children:(0,i.jsx)(n.h1,{id:"interface-auditrecord",children:"Interface: AuditRecord"})}),"\n",(0,i.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(n.h3,{id:"record",children:"record"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"record"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L516",children:"packages/extension-api/src/extension-api.d.ts:516"})}),"\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.code,{children:'"error"'})," | ",(0,i.jsx)(n.code,{children:'"info"'})," | ",(0,i.jsx)(n.code,{children:'"warning"'})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L515",children:"packages/extension-api/src/extension-api.d.ts:515"})})]})}function p(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},43023:(e,n,t)=>{t.d(n,{R:()=>d,x:()=>c});var i=t(63696);const r={},s=i.createContext(r);function d(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(r):e.components||r:d(e.components),i.createElement(s.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[39164],{8123:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>o,contentTitle:()=>c,default:()=>p,frontMatter:()=>s,metadata:()=>d,toc:()=>a});var i=t(62540),r=t(43023);const s={},c="Interface: AuditRecord",d={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"}},o={},a=[{value:"Properties",id:"properties",level:2},{value:"record",id:"record",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"type",id:"type",level:3},{value:"Defined in",id:"defined-in-1",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",p:"p",strong:"strong",...(0,r.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.header,{children:(0,i.jsx)(n.h1,{id:"interface-auditrecord",children:"Interface: AuditRecord"})}),"\n",(0,i.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(n.h3,{id:"record",children:"record"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"record"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L516",children:"packages/extension-api/src/extension-api.d.ts:516"})}),"\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.code,{children:'"error"'})," | ",(0,i.jsx)(n.code,{children:'"info"'})," | ",(0,i.jsx)(n.code,{children:'"warning"'})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L515",children:"packages/extension-api/src/extension-api.d.ts:515"})})]})}function p(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},43023:(e,n,t)=>{t.d(n,{R:()=>c,x:()=>d});var i=t(63696);const r={},s=i.createContext(r);function c(e){const n=i.useContext(s);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(s.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/46b3c144.d5d085e3.js b/assets/js/46b3c144.b8af3d43.js similarity index 87% rename from assets/js/46b3c144.d5d085e3.js rename to assets/js/46b3c144.b8af3d43.js index d04f3f034df..66a137e3f73 100644 --- a/assets/js/46b3c144.d5d085e3.js +++ b/assets/js/46b3c144.b8af3d43.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[5556],{40343:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>a,contentTitle:()=>r,default:()=>l,frontMatter:()=>o,metadata:()=>d,toc:()=>c});var t=i(62540),s=i(43023);const o={},r="Interface: PodCreatePortOptions",d={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={},c=[{value:"Properties",id:"properties",level:2},{value:"container_port",id:"container_port",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"host_ip",id:"host_ip",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"host_port",id:"host_port",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"protocol",id:"protocol",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"range",id:"range",level:3},{value:"Defined in",id:"defined-in-4",level:4}];function p(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",p:"p",strong:"strong",...(0,s.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.header,{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:"defined-in",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/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:"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:"defined-in-1",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/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_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:"defined-in-2",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/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:"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:"defined-in-3",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L372",children:"packages/extension-api/src/extension-api.d.ts:372"})}),"\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:"defined-in-4",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L373",children:"packages/extension-api/src/extension-api.d.ts:373"})})]})}function l(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(p,{...e})}):p(e)}},43023:(e,n,i)=>{i.d(n,{R:()=>r,x:()=>d});var t=i(63696);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 d(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([[5556],{40343:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>c,contentTitle:()=>r,default:()=>l,frontMatter:()=>o,metadata:()=>d,toc:()=>a});var t=i(62540),s=i(43023);const o={},r="Interface: PodCreatePortOptions",d={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"}},c={},a=[{value:"Properties",id:"properties",level:2},{value:"container_port",id:"container_port",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"host_ip",id:"host_ip",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"host_port",id:"host_port",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"protocol",id:"protocol",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"range",id:"range",level:3},{value:"Defined in",id:"defined-in-4",level:4}];function p(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",p:"p",strong:"strong",...(0,s.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.header,{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:"defined-in",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/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:"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:"defined-in-1",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/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_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:"defined-in-2",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/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:"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:"defined-in-3",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L372",children:"packages/extension-api/src/extension-api.d.ts:372"})}),"\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:"defined-in-4",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L373",children:"packages/extension-api/src/extension-api.d.ts:373"})})]})}function l(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(p,{...e})}):p(e)}},43023:(e,n,i)=>{i.d(n,{R:()=>r,x:()=>d});var t=i(63696);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 d(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/494e8e75.1d1085a7.js b/assets/js/494e8e75.360f7b21.js similarity index 97% rename from assets/js/494e8e75.1d1085a7.js rename to assets/js/494e8e75.360f7b21.js index b93e8a0832c..89784f66cb4 100644 --- a/assets/js/494e8e75.1d1085a7.js +++ b/assets/js/494e8e75.360f7b21.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[95314],{17426:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>s,default:()=>l,frontMatter:()=>o,metadata:()=>c,toc:()=>d});var r=t(62540),i=t(43023);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:"Defined in",id:"defined-in",level:4}];function p(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",p:"p",strong:"strong",...(0,i.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.header,{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:"defined-in",children:"Defined in"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L709",children:"packages/extension-api/src/extension-api.d.ts:709"})})]})}function l(e={}){const{wrapper:n}={...(0,i.R)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(p,{...e})}):p(e)}},43023:(e,n,t)=>{t.d(n,{R:()=>s,x:()=>c});var r=t(63696);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([[95314],{17426:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>s,default:()=>l,frontMatter:()=>o,metadata:()=>c,toc:()=>d});var r=t(62540),i=t(43023);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:"Defined in",id:"defined-in",level:4}];function p(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",p:"p",strong:"strong",...(0,i.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.header,{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:"defined-in",children:"Defined in"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L709",children:"packages/extension-api/src/extension-api.d.ts:709"})})]})}function l(e={}){const{wrapper:n}={...(0,i.R)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(p,{...e})}):p(e)}},43023:(e,n,t)=>{t.d(n,{R:()=>s,x:()=>c});var r=t(63696);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.c99d8a90.js b/assets/js/49bee2be.76fc0204.js similarity index 95% rename from assets/js/49bee2be.c99d8a90.js rename to assets/js/49bee2be.76fc0204.js index 8c2f4335515..e2d18fe1ca5 100644 --- a/assets/js/49bee2be.c99d8a90.js +++ b/assets/js/49bee2be.76fc0204.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[57915],{79262:(n,e,t)=>{t.r(e),t.d(e,{assets:()=>c,contentTitle:()=>s,default:()=>l,frontMatter:()=>o,metadata:()=>r,toc:()=>d});var i=t(62540),a=t(43023);const o={},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={},d=[{value:"Returns",id:"returns",level:2},{value:"Defined in",id:"defined-in",level:2}];function u(n){const e={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",strong:"strong",...(0,a.R)(),...n.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(e.header,{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:"defined-in",children:"Defined in"}),"\n",(0,i.jsx)(e.p,{children:(0,i.jsx)(e.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L4498",children:"packages/extension-api/src/extension-api.d.ts:4498"})})]})}function l(n={}){const{wrapper:e}={...(0,a.R)(),...n.components};return e?(0,i.jsx)(e,{...n,children:(0,i.jsx)(u,{...n})}):u(n)}},43023:(n,e,t)=>{t.d(e,{R:()=>s,x:()=>r});var i=t(63696);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([[57915],{79262:(n,e,t)=>{t.r(e),t.d(e,{assets:()=>c,contentTitle:()=>s,default:()=>l,frontMatter:()=>o,metadata:()=>r,toc:()=>d});var i=t(62540),a=t(43023);const o={},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={},d=[{value:"Returns",id:"returns",level:2},{value:"Defined in",id:"defined-in",level:2}];function u(n){const e={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",strong:"strong",...(0,a.R)(),...n.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(e.header,{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:"defined-in",children:"Defined in"}),"\n",(0,i.jsx)(e.p,{children:(0,i.jsx)(e.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L4498",children:"packages/extension-api/src/extension-api.d.ts:4498"})})]})}function l(n={}){const{wrapper:e}={...(0,a.R)(),...n.components};return e?(0,i.jsx)(e,{...n,children:(0,i.jsx)(u,{...n})}):u(n)}},43023:(n,e,t)=>{t.d(e,{R:()=>s,x:()=>r});var i=t(63696);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/49d9416a.4b57632d.js b/assets/js/49d9416a.2d59657e.js similarity index 98% rename from assets/js/49d9416a.4b57632d.js rename to assets/js/49d9416a.2d59657e.js index 338eef87bbe..63b1d1cebea 100644 --- a/assets/js/49d9416a.4b57632d.js +++ b/assets/js/49d9416a.2d59657e.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[74457],{77742:(n,e,t)=>{t.r(e),t.d(e,{assets:()=>c,contentTitle:()=>a,default:()=>h,frontMatter:()=>r,metadata:()=>o,toc:()=>d});var i=t(62540),s=t(43023);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:"Defined in",id:"defined-in",level:2}];function l(n){const e={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",strong:"strong",...(0,s.R)(),...n.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(e.header,{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:"defined-in",children:"Defined in"}),"\n",(0,i.jsx)(e.p,{children:(0,i.jsx)(e.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L3492",children:"packages/extension-api/src/extension-api.d.ts:3492"})})]})}function h(n={}){const{wrapper:e}={...(0,s.R)(),...n.components};return e?(0,i.jsx)(e,{...n,children:(0,i.jsx)(l,{...n})}):l(n)}},43023:(n,e,t)=>{t.d(e,{R:()=>a,x:()=>o});var i=t(63696);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([[74457],{77742:(n,e,t)=>{t.r(e),t.d(e,{assets:()=>c,contentTitle:()=>a,default:()=>h,frontMatter:()=>r,metadata:()=>o,toc:()=>d});var i=t(62540),s=t(43023);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:"Defined in",id:"defined-in",level:2}];function l(n){const e={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",strong:"strong",...(0,s.R)(),...n.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(e.header,{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:"defined-in",children:"Defined in"}),"\n",(0,i.jsx)(e.p,{children:(0,i.jsx)(e.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L3492",children:"packages/extension-api/src/extension-api.d.ts:3492"})})]})}function h(n={}){const{wrapper:e}={...(0,s.R)(),...n.components};return e?(0,i.jsx)(e,{...n,children:(0,i.jsx)(l,{...n})}):l(n)}},43023:(n,e,t)=>{t.d(e,{R:()=>a,x:()=>o});var i=t(63696);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/4b39f818.405c3f77.js b/assets/js/4b39f818.6259f6ef.js similarity index 94% rename from assets/js/4b39f818.405c3f77.js rename to assets/js/4b39f818.6259f6ef.js index bd7cfe110e0..94757fd9615 100644 --- a/assets/js/4b39f818.405c3f77.js +++ b/assets/js/4b39f818.6259f6ef.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[5276],{38497:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>r,contentTitle:()=>l,default:()=>p,frontMatter:()=>s,metadata:()=>a,toc:()=>c});var o=t(62540),i=t(43023);const s={},l="Type Alias: CliToolInstallationSource",a={id:"type-aliases/CliToolInstallationSource",title:"Type Alias: CliToolInstallationSource",description:'CliToolInstallationSource: "extension" \\| "external"',source:"@site/api/type-aliases/CliToolInstallationSource.md",sourceDirName:"type-aliases",slug:"/type-aliases/CliToolInstallationSource",permalink:"/api/type-aliases/CliToolInstallationSource",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"CheckResultLink",permalink:"/api/type-aliases/CheckResultLink"},next:{title:"CliToolState",permalink:"/api/type-aliases/CliToolState"}},r={},c=[{value:"Defined in",id:"defined-in",level:2}];function d(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",strong:"strong",...(0,i.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(n.header,{children:(0,o.jsx)(n.h1,{id:"type-alias-clitoolinstallationsource",children:"Type Alias: CliToolInstallationSource"})}),"\n",(0,o.jsxs)(n.blockquote,{children:["\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.strong,{children:"CliToolInstallationSource"}),": ",(0,o.jsx)(n.code,{children:'"extension"'})," | ",(0,o.jsx)(n.code,{children:'"external"'})]}),"\n"]}),"\n",(0,o.jsx)(n.h2,{id:"defined-in",children:"Defined in"}),"\n",(0,o.jsx)(n.p,{children:(0,o.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L4303",children:"packages/extension-api/src/extension-api.d.ts:4303"})})]})}function p(e={}){const{wrapper:n}={...(0,i.R)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(d,{...e})}):d(e)}},43023:(e,n,t)=>{t.d(n,{R:()=>l,x:()=>a});var o=t(63696);const i={},s=o.createContext(i);function l(e){const n=o.useContext(s);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:l(e.components),o.createElement(s.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[5276],{38497:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>r,contentTitle:()=>l,default:()=>p,frontMatter:()=>s,metadata:()=>a,toc:()=>c});var o=t(62540),i=t(43023);const s={},l="Type Alias: CliToolInstallationSource",a={id:"type-aliases/CliToolInstallationSource",title:"Type Alias: CliToolInstallationSource",description:'CliToolInstallationSource: "extension" \\| "external"',source:"@site/api/type-aliases/CliToolInstallationSource.md",sourceDirName:"type-aliases",slug:"/type-aliases/CliToolInstallationSource",permalink:"/api/type-aliases/CliToolInstallationSource",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"CheckResultLink",permalink:"/api/type-aliases/CheckResultLink"},next:{title:"CliToolState",permalink:"/api/type-aliases/CliToolState"}},r={},c=[{value:"Defined in",id:"defined-in",level:2}];function d(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",strong:"strong",...(0,i.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(n.header,{children:(0,o.jsx)(n.h1,{id:"type-alias-clitoolinstallationsource",children:"Type Alias: CliToolInstallationSource"})}),"\n",(0,o.jsxs)(n.blockquote,{children:["\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.strong,{children:"CliToolInstallationSource"}),": ",(0,o.jsx)(n.code,{children:'"extension"'})," | ",(0,o.jsx)(n.code,{children:'"external"'})]}),"\n"]}),"\n",(0,o.jsx)(n.h2,{id:"defined-in",children:"Defined in"}),"\n",(0,o.jsx)(n.p,{children:(0,o.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L4303",children:"packages/extension-api/src/extension-api.d.ts:4303"})})]})}function p(e={}){const{wrapper:n}={...(0,i.R)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(d,{...e})}):d(e)}},43023:(e,n,t)=>{t.d(n,{R:()=>l,x:()=>a});var o=t(63696);const i={},s=o.createContext(i);function l(e){const n=o.useContext(s);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:l(e.components),o.createElement(s.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/4c217c25.f70c8a52.js b/assets/js/4c217c25.6a00e784.js similarity index 88% rename from assets/js/4c217c25.f70c8a52.js rename to assets/js/4c217c25.6a00e784.js index d3211890e13..62399b223a1 100644 --- a/assets/js/4c217c25.f70c8a52.js +++ b/assets/js/4c217c25.6a00e784.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[57778],{45737:(n,e,i)=>{i.r(e),i.d(e,{assets:()=>c,contentTitle:()=>r,default:()=>p,frontMatter:()=>o,metadata:()=>a,toc:()=>d});var t=i(62540),s=i(43023);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={},d=[{value:"Returns",id:"returns",level:2},{value:"Defined in",id:"defined-in",level:2}];function l(n){const e={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",strong:"strong",...(0,s.R)(),...n.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(e.header,{children:(0,t.jsx)(e.h1,{id:"function-listcontainers",children:"Function: listContainers()"})}),"\n",(0,t.jsxs)(e.blockquote,{children:["\n",(0,t.jsxs)(e.p,{children:[(0,t.jsx)(e.strong,{children:"listContainers"}),"(): ",(0,t.jsx)(e.code,{children:"Promise"}),"<",(0,t.jsx)(e.a,{href:"/api/interfaces/ContainerInfo",children:(0,t.jsx)(e.code,{children:"ContainerInfo"})}),"[]>"]}),"\n"]}),"\n",(0,t.jsx)(e.p,{children:"Returns the list of containers across all container engines, in any state (running or not)."}),"\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/ContainerInfo",children:(0,t.jsx)(e.code,{children:"ContainerInfo"})}),"[]>"]}),"\n",(0,t.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,t.jsx)(e.a,{href:"/api/namespaces/containerEngine/functions/inspectContainer",children:"containerEngine.inspectContainer"})," method."]}),"\n",(0,t.jsx)(e.h2,{id:"defined-in",children:"Defined in"}),"\n",(0,t.jsx)(e.p,{children:(0,t.jsx)(e.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L3463",children:"packages/extension-api/src/extension-api.d.ts:3463"})})]})}function p(n={}){const{wrapper:e}={...(0,s.R)(),...n.components};return e?(0,t.jsx)(e,{...n,children:(0,t.jsx)(l,{...n})}):l(n)}},43023:(n,e,i)=>{i.d(e,{R:()=>r,x:()=>a});var t=i(63696);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 a(n){let e;return e=n.disableParentContext?"function"==typeof n.components?n.components(s):n.components||s:r(n.components),t.createElement(o.Provider,{value:e},n.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[57778],{45737:(n,e,i)=>{i.r(e),i.d(e,{assets:()=>c,contentTitle:()=>r,default:()=>p,frontMatter:()=>o,metadata:()=>a,toc:()=>l});var t=i(62540),s=i(43023);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:"Defined in",id:"defined-in",level:2}];function d(n){const e={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",strong:"strong",...(0,s.R)(),...n.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(e.header,{children:(0,t.jsx)(e.h1,{id:"function-listcontainers",children:"Function: listContainers()"})}),"\n",(0,t.jsxs)(e.blockquote,{children:["\n",(0,t.jsxs)(e.p,{children:[(0,t.jsx)(e.strong,{children:"listContainers"}),"(): ",(0,t.jsx)(e.code,{children:"Promise"}),"<",(0,t.jsx)(e.a,{href:"/api/interfaces/ContainerInfo",children:(0,t.jsx)(e.code,{children:"ContainerInfo"})}),"[]>"]}),"\n"]}),"\n",(0,t.jsx)(e.p,{children:"Returns the list of containers across all container engines, in any state (running or not)."}),"\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/ContainerInfo",children:(0,t.jsx)(e.code,{children:"ContainerInfo"})}),"[]>"]}),"\n",(0,t.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,t.jsx)(e.a,{href:"/api/namespaces/containerEngine/functions/inspectContainer",children:"containerEngine.inspectContainer"})," method."]}),"\n",(0,t.jsx)(e.h2,{id:"defined-in",children:"Defined in"}),"\n",(0,t.jsx)(e.p,{children:(0,t.jsx)(e.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L3463",children:"packages/extension-api/src/extension-api.d.ts:3463"})})]})}function p(n={}){const{wrapper:e}={...(0,s.R)(),...n.components};return e?(0,t.jsx)(e,{...n,children:(0,t.jsx)(d,{...n})}):d(n)}},43023:(n,e,i)=>{i.d(e,{R:()=>r,x:()=>a});var t=i(63696);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 a(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/4c5becac.b0f466a3.js b/assets/js/4c5becac.2a43877b.js similarity index 94% rename from assets/js/4c5becac.b0f466a3.js rename to assets/js/4c5becac.2a43877b.js index ee26fa4c908..33df9dc458f 100644 --- a/assets/js/4c5becac.b0f466a3.js +++ b/assets/js/4c5becac.2a43877b.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[68833],{55353:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>l,contentTitle:()=>d,default:()=>h,frontMatter:()=>r,metadata:()=>c,toc:()=>o});var t=s(62540),i=s(43023);const r={},d="Class: EventEmitter",c={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"}},l={},o=[{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:"Defined in",id:"defined-in",level:4},{value:"Methods",id:"methods",level:2},{value:"dispose()",id:"dispose",level:3},{value:"Returns",id:"returns-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"fire()",id:"fire",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns-2",level:4},{value:"Defined in",id:"defined-in-2",level:4}];function a(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",p:"p",strong:"strong",...(0,i.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.header,{children:(0,t.jsx)(n.h1,{id:"class-eventemittert",children:"Class: EventEmitter"})}),"\n",(0,t.jsxs)(n.p,{children:["A class to create and manage an ",(0,t.jsx)(n.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)(n.p,{children:"Use this class to send events inside extension or provide API to the other\nextensions."}),"\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.jsx)(n.h2,{id:"constructors",children:"Constructors"}),"\n",(0,t.jsx)(n.h3,{id:"new-eventemitter",children:"new EventEmitter()"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"new EventEmitter"}),"<",(0,t.jsx)(n.code,{children:"T"}),">(): ",(0,t.jsx)(n.a,{href:"/api/classes/EventEmitter",children:(0,t.jsx)(n.code,{children:"EventEmitter"})}),"<",(0,t.jsx)(n.code,{children:"T"}),">"]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"returns",children:"Returns"}),"\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.a,{href:"/api/classes/EventEmitter",children:(0,t.jsx)(n.code,{children:"EventEmitter"})}),"<",(0,t.jsx)(n.code,{children:"T"}),">"]}),"\n",(0,t.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,t.jsx)(n.h3,{id:"event",children:"event"}),"\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.a,{href:"/api/interfaces/Event",children:(0,t.jsx)(n.code,{children:"Event"})}),"<",(0,t.jsx)(n.code,{children:"T"}),">"]}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"For the public to allow to subscribe to events from this Emitter"}),"\n",(0,t.jsx)(n.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L139",children:"packages/extension-api/src/extension-api.d.ts:139"})}),"\n",(0,t.jsx)(n.h2,{id:"methods",children:"Methods"}),"\n",(0,t.jsx)(n.h3,{id:"dispose",children:"dispose()"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"dispose"}),"(): ",(0,t.jsx)(n.code,{children:"void"})]}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"Dispose by removing registered listeners"}),"\n",(0,t.jsx)(n.h4,{id:"returns-1",children:"Returns"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.code,{children:"void"})}),"\n",(0,t.jsx)(n.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L148",children:"packages/extension-api/src/extension-api.d.ts:148"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"fire",children:"fire()"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"fire"}),"(",(0,t.jsx)(n.code,{children:"data"}),"): ",(0,t.jsx)(n.code,{children:"void"})]}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"To fire an event to the subscribers"}),"\n",(0,t.jsx)(n.h4,{id:"parameters",children:"Parameters"}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"data"}),": ",(0,t.jsx)(n.code,{children:"T"})]}),"\n",(0,t.jsx)(n.p,{children:"The event to send to the registered listeners"}),"\n",(0,t.jsx)(n.h4,{id:"returns-2",children:"Returns"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.code,{children:"void"})}),"\n",(0,t.jsx)(n.h4,{id:"defined-in-2",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L144",children:"packages/extension-api/src/extension-api.d.ts:144"})})]})}function h(e={}){const{wrapper:n}={...(0,i.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(a,{...e})}):a(e)}},43023:(e,n,s)=>{s.d(n,{R:()=>d,x:()=>c});var t=s(63696);const i={},r=t.createContext(i);function d(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:d(e.components),t.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[68833],{55353:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>l,contentTitle:()=>d,default:()=>h,frontMatter:()=>r,metadata:()=>c,toc:()=>o});var t=s(62540),i=s(43023);const r={},d="Class: EventEmitter",c={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"}},l={},o=[{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:"Defined in",id:"defined-in",level:4},{value:"Methods",id:"methods",level:2},{value:"dispose()",id:"dispose",level:3},{value:"Returns",id:"returns-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"fire()",id:"fire",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns-2",level:4},{value:"Defined in",id:"defined-in-2",level:4}];function a(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",p:"p",strong:"strong",...(0,i.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.header,{children:(0,t.jsx)(n.h1,{id:"class-eventemittert",children:"Class: EventEmitter"})}),"\n",(0,t.jsxs)(n.p,{children:["A class to create and manage an ",(0,t.jsx)(n.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)(n.p,{children:"Use this class to send events inside extension or provide API to the other\nextensions."}),"\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.jsx)(n.h2,{id:"constructors",children:"Constructors"}),"\n",(0,t.jsx)(n.h3,{id:"new-eventemitter",children:"new EventEmitter()"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"new EventEmitter"}),"<",(0,t.jsx)(n.code,{children:"T"}),">(): ",(0,t.jsx)(n.a,{href:"/api/classes/EventEmitter",children:(0,t.jsx)(n.code,{children:"EventEmitter"})}),"<",(0,t.jsx)(n.code,{children:"T"}),">"]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"returns",children:"Returns"}),"\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.a,{href:"/api/classes/EventEmitter",children:(0,t.jsx)(n.code,{children:"EventEmitter"})}),"<",(0,t.jsx)(n.code,{children:"T"}),">"]}),"\n",(0,t.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,t.jsx)(n.h3,{id:"event",children:"event"}),"\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.a,{href:"/api/interfaces/Event",children:(0,t.jsx)(n.code,{children:"Event"})}),"<",(0,t.jsx)(n.code,{children:"T"}),">"]}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"For the public to allow to subscribe to events from this Emitter"}),"\n",(0,t.jsx)(n.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L139",children:"packages/extension-api/src/extension-api.d.ts:139"})}),"\n",(0,t.jsx)(n.h2,{id:"methods",children:"Methods"}),"\n",(0,t.jsx)(n.h3,{id:"dispose",children:"dispose()"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"dispose"}),"(): ",(0,t.jsx)(n.code,{children:"void"})]}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"Dispose by removing registered listeners"}),"\n",(0,t.jsx)(n.h4,{id:"returns-1",children:"Returns"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.code,{children:"void"})}),"\n",(0,t.jsx)(n.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L148",children:"packages/extension-api/src/extension-api.d.ts:148"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"fire",children:"fire()"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"fire"}),"(",(0,t.jsx)(n.code,{children:"data"}),"): ",(0,t.jsx)(n.code,{children:"void"})]}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"To fire an event to the subscribers"}),"\n",(0,t.jsx)(n.h4,{id:"parameters",children:"Parameters"}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"data"}),": ",(0,t.jsx)(n.code,{children:"T"})]}),"\n",(0,t.jsx)(n.p,{children:"The event to send to the registered listeners"}),"\n",(0,t.jsx)(n.h4,{id:"returns-2",children:"Returns"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.code,{children:"void"})}),"\n",(0,t.jsx)(n.h4,{id:"defined-in-2",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L144",children:"packages/extension-api/src/extension-api.d.ts:144"})})]})}function h(e={}){const{wrapper:n}={...(0,i.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(a,{...e})}):a(e)}},43023:(e,n,s)=>{s.d(n,{R:()=>d,x:()=>c});var t=s(63696);const i={},r=t.createContext(i);function d(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:d(e.components),t.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/4f425ff4.7966511a.js b/assets/js/4f425ff4.64bffbbe.js similarity index 88% rename from assets/js/4f425ff4.7966511a.js rename to assets/js/4f425ff4.64bffbbe.js index 9f4a5271882..735e2226502 100644 --- a/assets/js/4f425ff4.7966511a.js +++ b/assets/js/4f425ff4.64bffbbe.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[55780],{94039:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>c,contentTitle:()=>r,default:()=>p,frontMatter:()=>o,metadata:()=>a,toc:()=>d});var i=s(62540),t=s(43023);const o={},r="Function: onDidUpdateContainerConnection()",a={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"}},c={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Defined in",id:"defined-in",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",strong:"strong",...(0,t.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.header,{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:"defined-in",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L833",children:"packages/extension-api/src/extension-api.d.ts:833"})})]})}function p(e={}){const{wrapper:n}={...(0,t.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},43023:(e,n,s)=>{s.d(n,{R:()=>r,x:()=>a});var i=s(63696);const t={},o=i.createContext(t);function r(e){const n=i.useContext(o);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function a(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:r(e.components),i.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[55780],{94039:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>a,contentTitle:()=>r,default:()=>p,frontMatter:()=>o,metadata:()=>c,toc:()=>d});var i=s(62540),t=s(43023);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:"Defined in",id:"defined-in",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",strong:"strong",...(0,t.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.header,{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:"defined-in",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L833",children:"packages/extension-api/src/extension-api.d.ts:833"})})]})}function p(e={}){const{wrapper:n}={...(0,t.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},43023:(e,n,s)=>{s.d(n,{R:()=>r,x:()=>c});var i=s(63696);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.f09ade23.js b/assets/js/4f9e8711.b1f62579.js similarity index 85% rename from assets/js/4f9e8711.f09ade23.js rename to assets/js/4f9e8711.b1f62579.js index f7eaf4c9ad7..6aabc8da41c 100644 --- a/assets/js/4f9e8711.f09ade23.js +++ b/assets/js/4f9e8711.b1f62579.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[69586],{1764:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>s,contentTitle:()=>c,default:()=>h,frontMatter:()=>o,metadata:()=>d,toc:()=>a});var t=i(62540),r=i(43023);const o={},c="Interface: ProviderConnectionFactory",d={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"}},s={},a=[{value:"Extended by",id:"extended-by",level:2},{value:"Properties",id:"properties",level:2},{value:"creationButtonTitle?",id:"creationbuttontitle",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"creationDisplayName?",id:"creationdisplayname",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"Methods",id:"methods",level:2},{value:"initialize()?",id:"initialize",level:3},{value:"Returns",id:"returns",level:4},{value:"Defined in",id:"defined-in-2",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",li:"li",p:"p",strong:"strong",ul:"ul",...(0,r.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.header,{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:"defined-in",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L499",children:"packages/extension-api/src/extension-api.d.ts:499"})}),"\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:"defined-in-1",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L496",children:"packages/extension-api/src/extension-api.d.ts:496"})}),"\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:"defined-in-2",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L493",children:"packages/extension-api/src/extension-api.d.ts:493"})})]})}function h(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},43023:(e,n,i)=>{i.d(n,{R:()=>c,x:()=>d});var t=i(63696);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 d(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([[69586],{1764:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>d,contentTitle:()=>c,default:()=>h,frontMatter:()=>o,metadata:()=>s,toc:()=>a});var t=i(62540),r=i(43023);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:"Defined in",id:"defined-in",level:4},{value:"creationDisplayName?",id:"creationdisplayname",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"Methods",id:"methods",level:2},{value:"initialize()?",id:"initialize",level:3},{value:"Returns",id:"returns",level:4},{value:"Defined in",id:"defined-in-2",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",li:"li",p:"p",strong:"strong",ul:"ul",...(0,r.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.header,{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:"defined-in",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L499",children:"packages/extension-api/src/extension-api.d.ts:499"})}),"\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:"defined-in-1",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L496",children:"packages/extension-api/src/extension-api.d.ts:496"})}),"\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:"defined-in-2",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L493",children:"packages/extension-api/src/extension-api.d.ts:493"})})]})}function h(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},43023:(e,n,i)=>{i.d(n,{R:()=>c,x:()=>s});var t=i(63696);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.7917b32c.js b/assets/js/5046ea8f.81d7b184.js similarity index 95% rename from assets/js/5046ea8f.7917b32c.js rename to assets/js/5046ea8f.81d7b184.js index 208c96b1042..3d8910a0f47 100644 --- a/assets/js/5046ea8f.7917b32c.js +++ b/assets/js/5046ea8f.81d7b184.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[8078],{86114:(e,s,n)=>{n.r(s),n.d(s,{assets:()=>o,contentTitle:()=>c,default:()=>u,frontMatter:()=>i,metadata:()=>a,toc:()=>d});var t=n(62540),r=n(43023);const i={},c="Function: suggestRegistry()",a={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"}},o={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Defined in",id:"defined-in",level:2}];function g(e){const s={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",strong:"strong",...(0,r.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(s.header,{children:(0,t.jsx)(s.h1,{id:"function-suggestregistry",children:"Function: suggestRegistry()"})}),"\n",(0,t.jsxs)(s.blockquote,{children:["\n",(0,t.jsxs)(s.p,{children:[(0,t.jsx)(s.strong,{children:"suggestRegistry"}),"(",(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/RegistrySuggestedProvider",children:(0,t.jsx)(s.code,{children:"RegistrySuggestedProvider"})})]}),"\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:"defined-in",children:"Defined in"}),"\n",(0,t.jsx)(s.p,{children:(0,t.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L929",children:"packages/extension-api/src/extension-api.d.ts:929"})})]})}function u(e={}){const{wrapper:s}={...(0,r.R)(),...e.components};return s?(0,t.jsx)(s,{...e,children:(0,t.jsx)(g,{...e})}):g(e)}},43023:(e,s,n)=>{n.d(s,{R:()=>c,x:()=>a});var t=n(63696);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 a(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([[8078],{86114:(e,s,n)=>{n.r(s),n.d(s,{assets:()=>o,contentTitle:()=>c,default:()=>u,frontMatter:()=>i,metadata:()=>a,toc:()=>d});var t=n(62540),r=n(43023);const i={},c="Function: suggestRegistry()",a={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"}},o={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Defined in",id:"defined-in",level:2}];function g(e){const s={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",strong:"strong",...(0,r.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(s.header,{children:(0,t.jsx)(s.h1,{id:"function-suggestregistry",children:"Function: suggestRegistry()"})}),"\n",(0,t.jsxs)(s.blockquote,{children:["\n",(0,t.jsxs)(s.p,{children:[(0,t.jsx)(s.strong,{children:"suggestRegistry"}),"(",(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/RegistrySuggestedProvider",children:(0,t.jsx)(s.code,{children:"RegistrySuggestedProvider"})})]}),"\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:"defined-in",children:"Defined in"}),"\n",(0,t.jsx)(s.p,{children:(0,t.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L929",children:"packages/extension-api/src/extension-api.d.ts:929"})})]})}function u(e={}){const{wrapper:s}={...(0,r.R)(),...e.components};return s?(0,t.jsx)(s,{...e,children:(0,t.jsx)(g,{...e})}):g(e)}},43023:(e,s,n)=>{n.d(s,{R:()=>c,x:()=>a});var t=n(63696);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 a(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/54d805e4.743494aa.js b/assets/js/54d805e4.42b1404a.js similarity index 88% rename from assets/js/54d805e4.743494aa.js rename to assets/js/54d805e4.42b1404a.js index 91b8f37f58b..1f5785a3fa0 100644 --- a/assets/js/54d805e4.743494aa.js +++ b/assets/js/54d805e4.42b1404a.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[73946],{46371:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>a,contentTitle:()=>o,default:()=>h,frontMatter:()=>r,metadata:()=>d,toc:()=>c});var s=i(62540),t=i(43023);const r={},o="Interface: VolumeListInfo",d={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={},c=[{value:"Properties",id:"properties",level:2},{value:"Volumes",id:"volumes",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"Warnings",id:"warnings",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"engineId",id:"engineid",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"engineName",id:"enginename",level:3},{value:"Defined in",id:"defined-in-3",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",p:"p",strong:"strong",...(0,t.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.header,{children:(0,s.jsx)(n.h1,{id:"interface-volumelistinfo",children:"Interface: VolumeListInfo"})}),"\n",(0,s.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,s.jsx)(n.h3,{id:"volumes",children:"Volumes"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Volumes"}),": ",(0,s.jsx)(n.a,{href:"/api/interfaces/VolumeInfo",children:(0,s.jsx)(n.code,{children:"VolumeInfo"})}),"[]"]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L3418",children:"packages/extension-api/src/extension-api.d.ts:3418"})}),"\n",(0,s.jsx)(n.hr,{}),"\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.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L3419",children:"packages/extension-api/src/extension-api.d.ts:3419"})}),"\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.h4,{id:"defined-in-2",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L3420",children:"packages/extension-api/src/extension-api.d.ts:3420"})}),"\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.h4,{id:"defined-in-3",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L3421",children:"packages/extension-api/src/extension-api.d.ts:3421"})})]})}function h(e={}){const{wrapper:n}={...(0,t.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},43023:(e,n,i)=>{i.d(n,{R:()=>o,x:()=>d});var s=i(63696);const t={},r=s.createContext(t);function o(e){const n=s.useContext(r);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(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[73946],{46371:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>a,contentTitle:()=>o,default:()=>h,frontMatter:()=>r,metadata:()=>d,toc:()=>c});var s=i(62540),t=i(43023);const r={},o="Interface: VolumeListInfo",d={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={},c=[{value:"Properties",id:"properties",level:2},{value:"Volumes",id:"volumes",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"Warnings",id:"warnings",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"engineId",id:"engineid",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"engineName",id:"enginename",level:3},{value:"Defined in",id:"defined-in-3",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",p:"p",strong:"strong",...(0,t.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.header,{children:(0,s.jsx)(n.h1,{id:"interface-volumelistinfo",children:"Interface: VolumeListInfo"})}),"\n",(0,s.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,s.jsx)(n.h3,{id:"volumes",children:"Volumes"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Volumes"}),": ",(0,s.jsx)(n.a,{href:"/api/interfaces/VolumeInfo",children:(0,s.jsx)(n.code,{children:"VolumeInfo"})}),"[]"]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L3418",children:"packages/extension-api/src/extension-api.d.ts:3418"})}),"\n",(0,s.jsx)(n.hr,{}),"\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.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L3419",children:"packages/extension-api/src/extension-api.d.ts:3419"})}),"\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.h4,{id:"defined-in-2",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L3420",children:"packages/extension-api/src/extension-api.d.ts:3420"})}),"\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.h4,{id:"defined-in-3",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L3421",children:"packages/extension-api/src/extension-api.d.ts:3421"})})]})}function h(e={}){const{wrapper:n}={...(0,t.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},43023:(e,n,i)=>{i.d(n,{R:()=>o,x:()=>d});var s=i(63696);const t={},r=s.createContext(t);function o(e){const n=s.useContext(r);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(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/56a9df4f.bc21343a.js b/assets/js/56a9df4f.b40c8018.js similarity index 92% rename from assets/js/56a9df4f.bc21343a.js rename to assets/js/56a9df4f.b40c8018.js index 0c9f5ac3b61..3184556bf57 100644 --- a/assets/js/56a9df4f.bc21343a.js +++ b/assets/js/56a9df4f.b40c8018.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[17656],{55247:(e,i,n)=>{n.r(i),n.d(i,{assets:()=>c,contentTitle:()=>a,default:()=>o,frontMatter:()=>r,metadata:()=>l,toc:()=>t});var d=n(62540),s=n(43023);const r={},a="Interface: ImageFileSymlink",l={id:"interfaces/ImageFileSymlink",title:"Interface: ImageFileSymlink",description:"the description of a symlink in an image filesystem layer",source:"@site/api/interfaces/ImageFileSymlink.md",sourceDirName:"interfaces",slug:"/interfaces/ImageFileSymlink",permalink:"/api/interfaces/ImageFileSymlink",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"ImageFile",permalink:"/api/interfaces/ImageFile"},next:{title:"ImageFilesCallbacks",permalink:"/api/interfaces/ImageFilesCallbacks"}},c={},t=[{value:"Extends",id:"extends",level:2},{value:"Properties",id:"properties",level:2},{value:"atime",id:"atime",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"ctime",id:"ctime",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"gid",id:"gid",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"linkPath",id:"linkpath",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"mode",id:"mode",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"mtime",id:"mtime",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"path",id:"path",level:3},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"size",id:"size",level:3},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-7",level:4},{value:"type",id:"type",level:3},{value:"Overrides",id:"overrides",level:4},{value:"Defined in",id:"defined-in-8",level:4},{value:"uid",id:"uid",level:3},{value:"Inherited from",id:"inherited-from-7",level:4},{value:"Defined in",id:"defined-in-9",level:4}];function h(e){const i={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",li:"li",p:"p",strong:"strong",ul:"ul",...(0,s.R)(),...e.components};return(0,d.jsxs)(d.Fragment,{children:[(0,d.jsx)(i.header,{children:(0,d.jsx)(i.h1,{id:"interface-imagefilesymlink",children:"Interface: ImageFileSymlink"})}),"\n",(0,d.jsx)(i.p,{children:"the description of a symlink in an image filesystem layer"}),"\n",(0,d.jsx)(i.h2,{id:"extends",children:"Extends"}),"\n",(0,d.jsxs)(i.ul,{children:["\n",(0,d.jsx)(i.li,{children:(0,d.jsx)(i.a,{href:"/api/interfaces/ImageFile",children:(0,d.jsx)(i.code,{children:"ImageFile"})})}),"\n"]}),"\n",(0,d.jsx)(i.h2,{id:"properties",children:"Properties"}),"\n",(0,d.jsx)(i.h3,{id:"atime",children:"atime"}),"\n",(0,d.jsxs)(i.blockquote,{children:["\n",(0,d.jsxs)(i.p,{children:[(0,d.jsx)(i.strong,{children:"atime"}),": ",(0,d.jsx)(i.code,{children:"Date"})]}),"\n"]}),"\n",(0,d.jsx)(i.h4,{id:"inherited-from",children:"Inherited from"}),"\n",(0,d.jsxs)(i.p,{children:[(0,d.jsx)(i.a,{href:"/api/interfaces/ImageFile",children:(0,d.jsx)(i.code,{children:"ImageFile"})}),".",(0,d.jsx)(i.a,{href:"/api/interfaces/ImageFile#atime",children:(0,d.jsx)(i.code,{children:"atime"})})]}),"\n",(0,d.jsx)(i.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,d.jsx)(i.p,{children:(0,d.jsx)(i.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L738",children:"packages/extension-api/src/extension-api.d.ts:738"})}),"\n",(0,d.jsx)(i.hr,{}),"\n",(0,d.jsx)(i.h3,{id:"ctime",children:"ctime"}),"\n",(0,d.jsxs)(i.blockquote,{children:["\n",(0,d.jsxs)(i.p,{children:[(0,d.jsx)(i.strong,{children:"ctime"}),": ",(0,d.jsx)(i.code,{children:"Date"})]}),"\n"]}),"\n",(0,d.jsx)(i.h4,{id:"inherited-from-1",children:"Inherited from"}),"\n",(0,d.jsxs)(i.p,{children:[(0,d.jsx)(i.a,{href:"/api/interfaces/ImageFile",children:(0,d.jsx)(i.code,{children:"ImageFile"})}),".",(0,d.jsx)(i.a,{href:"/api/interfaces/ImageFile#ctime",children:(0,d.jsx)(i.code,{children:"ctime"})})]}),"\n",(0,d.jsx)(i.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,d.jsx)(i.p,{children:(0,d.jsx)(i.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L737",children:"packages/extension-api/src/extension-api.d.ts:737"})}),"\n",(0,d.jsx)(i.hr,{}),"\n",(0,d.jsx)(i.h3,{id:"gid",children:"gid"}),"\n",(0,d.jsxs)(i.blockquote,{children:["\n",(0,d.jsxs)(i.p,{children:[(0,d.jsx)(i.strong,{children:"gid"}),": ",(0,d.jsx)(i.code,{children:"number"})]}),"\n"]}),"\n",(0,d.jsx)(i.h4,{id:"inherited-from-2",children:"Inherited from"}),"\n",(0,d.jsxs)(i.p,{children:[(0,d.jsx)(i.a,{href:"/api/interfaces/ImageFile",children:(0,d.jsx)(i.code,{children:"ImageFile"})}),".",(0,d.jsx)(i.a,{href:"/api/interfaces/ImageFile#gid",children:(0,d.jsx)(i.code,{children:"gid"})})]}),"\n",(0,d.jsx)(i.h4,{id:"defined-in-2",children:"Defined in"}),"\n",(0,d.jsx)(i.p,{children:(0,d.jsx)(i.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L735",children:"packages/extension-api/src/extension-api.d.ts:735"})}),"\n",(0,d.jsx)(i.hr,{}),"\n",(0,d.jsx)(i.h3,{id:"linkpath",children:"linkPath"}),"\n",(0,d.jsxs)(i.blockquote,{children:["\n",(0,d.jsxs)(i.p,{children:[(0,d.jsx)(i.strong,{children:"linkPath"}),": ",(0,d.jsx)(i.code,{children:"string"})]}),"\n"]}),"\n",(0,d.jsx)(i.h4,{id:"defined-in-3",children:"Defined in"}),"\n",(0,d.jsx)(i.p,{children:(0,d.jsx)(i.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L748",children:"packages/extension-api/src/extension-api.d.ts:748"})}),"\n",(0,d.jsx)(i.hr,{}),"\n",(0,d.jsx)(i.h3,{id:"mode",children:"mode"}),"\n",(0,d.jsxs)(i.blockquote,{children:["\n",(0,d.jsxs)(i.p,{children:[(0,d.jsx)(i.strong,{children:"mode"}),": ",(0,d.jsx)(i.code,{children:"number"})]}),"\n"]}),"\n",(0,d.jsx)(i.h4,{id:"inherited-from-3",children:"Inherited from"}),"\n",(0,d.jsxs)(i.p,{children:[(0,d.jsx)(i.a,{href:"/api/interfaces/ImageFile",children:(0,d.jsx)(i.code,{children:"ImageFile"})}),".",(0,d.jsx)(i.a,{href:"/api/interfaces/ImageFile#mode",children:(0,d.jsx)(i.code,{children:"mode"})})]}),"\n",(0,d.jsx)(i.h4,{id:"defined-in-4",children:"Defined in"}),"\n",(0,d.jsx)(i.p,{children:(0,d.jsx)(i.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L733",children:"packages/extension-api/src/extension-api.d.ts:733"})}),"\n",(0,d.jsx)(i.hr,{}),"\n",(0,d.jsx)(i.h3,{id:"mtime",children:"mtime"}),"\n",(0,d.jsxs)(i.blockquote,{children:["\n",(0,d.jsxs)(i.p,{children:[(0,d.jsx)(i.strong,{children:"mtime"}),": ",(0,d.jsx)(i.code,{children:"Date"})]}),"\n"]}),"\n",(0,d.jsx)(i.h4,{id:"inherited-from-4",children:"Inherited from"}),"\n",(0,d.jsxs)(i.p,{children:[(0,d.jsx)(i.a,{href:"/api/interfaces/ImageFile",children:(0,d.jsx)(i.code,{children:"ImageFile"})}),".",(0,d.jsx)(i.a,{href:"/api/interfaces/ImageFile#mtime",children:(0,d.jsx)(i.code,{children:"mtime"})})]}),"\n",(0,d.jsx)(i.h4,{id:"defined-in-5",children:"Defined in"}),"\n",(0,d.jsx)(i.p,{children:(0,d.jsx)(i.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L739",children:"packages/extension-api/src/extension-api.d.ts:739"})}),"\n",(0,d.jsx)(i.hr,{}),"\n",(0,d.jsx)(i.h3,{id:"path",children:"path"}),"\n",(0,d.jsxs)(i.blockquote,{children:["\n",(0,d.jsxs)(i.p,{children:[(0,d.jsx)(i.strong,{children:"path"}),": ",(0,d.jsx)(i.code,{children:"string"})]}),"\n"]}),"\n",(0,d.jsx)(i.h4,{id:"inherited-from-5",children:"Inherited from"}),"\n",(0,d.jsxs)(i.p,{children:[(0,d.jsx)(i.a,{href:"/api/interfaces/ImageFile",children:(0,d.jsx)(i.code,{children:"ImageFile"})}),".",(0,d.jsx)(i.a,{href:"/api/interfaces/ImageFile#path",children:(0,d.jsx)(i.code,{children:"path"})})]}),"\n",(0,d.jsx)(i.h4,{id:"defined-in-6",children:"Defined in"}),"\n",(0,d.jsx)(i.p,{children:(0,d.jsx)(i.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L730",children:"packages/extension-api/src/extension-api.d.ts:730"})}),"\n",(0,d.jsx)(i.hr,{}),"\n",(0,d.jsx)(i.h3,{id:"size",children:"size"}),"\n",(0,d.jsxs)(i.blockquote,{children:["\n",(0,d.jsxs)(i.p,{children:[(0,d.jsx)(i.strong,{children:"size"}),": ",(0,d.jsx)(i.code,{children:"number"})]}),"\n"]}),"\n",(0,d.jsx)(i.h4,{id:"inherited-from-6",children:"Inherited from"}),"\n",(0,d.jsxs)(i.p,{children:[(0,d.jsx)(i.a,{href:"/api/interfaces/ImageFile",children:(0,d.jsx)(i.code,{children:"ImageFile"})}),".",(0,d.jsx)(i.a,{href:"/api/interfaces/ImageFile#size",children:(0,d.jsx)(i.code,{children:"size"})})]}),"\n",(0,d.jsx)(i.h4,{id:"defined-in-7",children:"Defined in"}),"\n",(0,d.jsx)(i.p,{children:(0,d.jsx)(i.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L736",children:"packages/extension-api/src/extension-api.d.ts:736"})}),"\n",(0,d.jsx)(i.hr,{}),"\n",(0,d.jsx)(i.h3,{id:"type",children:"type"}),"\n",(0,d.jsxs)(i.blockquote,{children:["\n",(0,d.jsxs)(i.p,{children:[(0,d.jsx)(i.strong,{children:"type"}),": ",(0,d.jsx)(i.code,{children:'"symlink"'})]}),"\n"]}),"\n",(0,d.jsx)(i.h4,{id:"overrides",children:"Overrides"}),"\n",(0,d.jsxs)(i.p,{children:[(0,d.jsx)(i.a,{href:"/api/interfaces/ImageFile",children:(0,d.jsx)(i.code,{children:"ImageFile"})}),".",(0,d.jsx)(i.a,{href:"/api/interfaces/ImageFile#type",children:(0,d.jsx)(i.code,{children:"type"})})]}),"\n",(0,d.jsx)(i.h4,{id:"defined-in-8",children:"Defined in"}),"\n",(0,d.jsx)(i.p,{children:(0,d.jsx)(i.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L746",children:"packages/extension-api/src/extension-api.d.ts:746"})}),"\n",(0,d.jsx)(i.hr,{}),"\n",(0,d.jsx)(i.h3,{id:"uid",children:"uid"}),"\n",(0,d.jsxs)(i.blockquote,{children:["\n",(0,d.jsxs)(i.p,{children:[(0,d.jsx)(i.strong,{children:"uid"}),": ",(0,d.jsx)(i.code,{children:"number"})]}),"\n"]}),"\n",(0,d.jsx)(i.h4,{id:"inherited-from-7",children:"Inherited from"}),"\n",(0,d.jsxs)(i.p,{children:[(0,d.jsx)(i.a,{href:"/api/interfaces/ImageFile",children:(0,d.jsx)(i.code,{children:"ImageFile"})}),".",(0,d.jsx)(i.a,{href:"/api/interfaces/ImageFile#uid",children:(0,d.jsx)(i.code,{children:"uid"})})]}),"\n",(0,d.jsx)(i.h4,{id:"defined-in-9",children:"Defined in"}),"\n",(0,d.jsx)(i.p,{children:(0,d.jsx)(i.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L734",children:"packages/extension-api/src/extension-api.d.ts:734"})})]})}function o(e={}){const{wrapper:i}={...(0,s.R)(),...e.components};return i?(0,d.jsx)(i,{...e,children:(0,d.jsx)(h,{...e})}):h(e)}},43023:(e,i,n)=>{n.d(i,{R:()=>a,x:()=>l});var d=n(63696);const s={},r=d.createContext(s);function a(e){const i=d.useContext(r);return d.useMemo((function(){return"function"==typeof e?e(i):{...i,...e}}),[i,e])}function l(e){let i;return i=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:a(e.components),d.createElement(r.Provider,{value:i},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[17656],{55247:(e,i,n)=>{n.r(i),n.d(i,{assets:()=>c,contentTitle:()=>a,default:()=>o,frontMatter:()=>r,metadata:()=>l,toc:()=>t});var d=n(62540),s=n(43023);const r={},a="Interface: ImageFileSymlink",l={id:"interfaces/ImageFileSymlink",title:"Interface: ImageFileSymlink",description:"the description of a symlink in an image filesystem layer",source:"@site/api/interfaces/ImageFileSymlink.md",sourceDirName:"interfaces",slug:"/interfaces/ImageFileSymlink",permalink:"/api/interfaces/ImageFileSymlink",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"ImageFile",permalink:"/api/interfaces/ImageFile"},next:{title:"ImageFilesCallbacks",permalink:"/api/interfaces/ImageFilesCallbacks"}},c={},t=[{value:"Extends",id:"extends",level:2},{value:"Properties",id:"properties",level:2},{value:"atime",id:"atime",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"ctime",id:"ctime",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"gid",id:"gid",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"linkPath",id:"linkpath",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"mode",id:"mode",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"mtime",id:"mtime",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"path",id:"path",level:3},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"size",id:"size",level:3},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-7",level:4},{value:"type",id:"type",level:3},{value:"Overrides",id:"overrides",level:4},{value:"Defined in",id:"defined-in-8",level:4},{value:"uid",id:"uid",level:3},{value:"Inherited from",id:"inherited-from-7",level:4},{value:"Defined in",id:"defined-in-9",level:4}];function h(e){const i={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",li:"li",p:"p",strong:"strong",ul:"ul",...(0,s.R)(),...e.components};return(0,d.jsxs)(d.Fragment,{children:[(0,d.jsx)(i.header,{children:(0,d.jsx)(i.h1,{id:"interface-imagefilesymlink",children:"Interface: ImageFileSymlink"})}),"\n",(0,d.jsx)(i.p,{children:"the description of a symlink in an image filesystem layer"}),"\n",(0,d.jsx)(i.h2,{id:"extends",children:"Extends"}),"\n",(0,d.jsxs)(i.ul,{children:["\n",(0,d.jsx)(i.li,{children:(0,d.jsx)(i.a,{href:"/api/interfaces/ImageFile",children:(0,d.jsx)(i.code,{children:"ImageFile"})})}),"\n"]}),"\n",(0,d.jsx)(i.h2,{id:"properties",children:"Properties"}),"\n",(0,d.jsx)(i.h3,{id:"atime",children:"atime"}),"\n",(0,d.jsxs)(i.blockquote,{children:["\n",(0,d.jsxs)(i.p,{children:[(0,d.jsx)(i.strong,{children:"atime"}),": ",(0,d.jsx)(i.code,{children:"Date"})]}),"\n"]}),"\n",(0,d.jsx)(i.h4,{id:"inherited-from",children:"Inherited from"}),"\n",(0,d.jsxs)(i.p,{children:[(0,d.jsx)(i.a,{href:"/api/interfaces/ImageFile",children:(0,d.jsx)(i.code,{children:"ImageFile"})}),".",(0,d.jsx)(i.a,{href:"/api/interfaces/ImageFile#atime",children:(0,d.jsx)(i.code,{children:"atime"})})]}),"\n",(0,d.jsx)(i.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,d.jsx)(i.p,{children:(0,d.jsx)(i.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L738",children:"packages/extension-api/src/extension-api.d.ts:738"})}),"\n",(0,d.jsx)(i.hr,{}),"\n",(0,d.jsx)(i.h3,{id:"ctime",children:"ctime"}),"\n",(0,d.jsxs)(i.blockquote,{children:["\n",(0,d.jsxs)(i.p,{children:[(0,d.jsx)(i.strong,{children:"ctime"}),": ",(0,d.jsx)(i.code,{children:"Date"})]}),"\n"]}),"\n",(0,d.jsx)(i.h4,{id:"inherited-from-1",children:"Inherited from"}),"\n",(0,d.jsxs)(i.p,{children:[(0,d.jsx)(i.a,{href:"/api/interfaces/ImageFile",children:(0,d.jsx)(i.code,{children:"ImageFile"})}),".",(0,d.jsx)(i.a,{href:"/api/interfaces/ImageFile#ctime",children:(0,d.jsx)(i.code,{children:"ctime"})})]}),"\n",(0,d.jsx)(i.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,d.jsx)(i.p,{children:(0,d.jsx)(i.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L737",children:"packages/extension-api/src/extension-api.d.ts:737"})}),"\n",(0,d.jsx)(i.hr,{}),"\n",(0,d.jsx)(i.h3,{id:"gid",children:"gid"}),"\n",(0,d.jsxs)(i.blockquote,{children:["\n",(0,d.jsxs)(i.p,{children:[(0,d.jsx)(i.strong,{children:"gid"}),": ",(0,d.jsx)(i.code,{children:"number"})]}),"\n"]}),"\n",(0,d.jsx)(i.h4,{id:"inherited-from-2",children:"Inherited from"}),"\n",(0,d.jsxs)(i.p,{children:[(0,d.jsx)(i.a,{href:"/api/interfaces/ImageFile",children:(0,d.jsx)(i.code,{children:"ImageFile"})}),".",(0,d.jsx)(i.a,{href:"/api/interfaces/ImageFile#gid",children:(0,d.jsx)(i.code,{children:"gid"})})]}),"\n",(0,d.jsx)(i.h4,{id:"defined-in-2",children:"Defined in"}),"\n",(0,d.jsx)(i.p,{children:(0,d.jsx)(i.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L735",children:"packages/extension-api/src/extension-api.d.ts:735"})}),"\n",(0,d.jsx)(i.hr,{}),"\n",(0,d.jsx)(i.h3,{id:"linkpath",children:"linkPath"}),"\n",(0,d.jsxs)(i.blockquote,{children:["\n",(0,d.jsxs)(i.p,{children:[(0,d.jsx)(i.strong,{children:"linkPath"}),": ",(0,d.jsx)(i.code,{children:"string"})]}),"\n"]}),"\n",(0,d.jsx)(i.h4,{id:"defined-in-3",children:"Defined in"}),"\n",(0,d.jsx)(i.p,{children:(0,d.jsx)(i.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L748",children:"packages/extension-api/src/extension-api.d.ts:748"})}),"\n",(0,d.jsx)(i.hr,{}),"\n",(0,d.jsx)(i.h3,{id:"mode",children:"mode"}),"\n",(0,d.jsxs)(i.blockquote,{children:["\n",(0,d.jsxs)(i.p,{children:[(0,d.jsx)(i.strong,{children:"mode"}),": ",(0,d.jsx)(i.code,{children:"number"})]}),"\n"]}),"\n",(0,d.jsx)(i.h4,{id:"inherited-from-3",children:"Inherited from"}),"\n",(0,d.jsxs)(i.p,{children:[(0,d.jsx)(i.a,{href:"/api/interfaces/ImageFile",children:(0,d.jsx)(i.code,{children:"ImageFile"})}),".",(0,d.jsx)(i.a,{href:"/api/interfaces/ImageFile#mode",children:(0,d.jsx)(i.code,{children:"mode"})})]}),"\n",(0,d.jsx)(i.h4,{id:"defined-in-4",children:"Defined in"}),"\n",(0,d.jsx)(i.p,{children:(0,d.jsx)(i.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L733",children:"packages/extension-api/src/extension-api.d.ts:733"})}),"\n",(0,d.jsx)(i.hr,{}),"\n",(0,d.jsx)(i.h3,{id:"mtime",children:"mtime"}),"\n",(0,d.jsxs)(i.blockquote,{children:["\n",(0,d.jsxs)(i.p,{children:[(0,d.jsx)(i.strong,{children:"mtime"}),": ",(0,d.jsx)(i.code,{children:"Date"})]}),"\n"]}),"\n",(0,d.jsx)(i.h4,{id:"inherited-from-4",children:"Inherited from"}),"\n",(0,d.jsxs)(i.p,{children:[(0,d.jsx)(i.a,{href:"/api/interfaces/ImageFile",children:(0,d.jsx)(i.code,{children:"ImageFile"})}),".",(0,d.jsx)(i.a,{href:"/api/interfaces/ImageFile#mtime",children:(0,d.jsx)(i.code,{children:"mtime"})})]}),"\n",(0,d.jsx)(i.h4,{id:"defined-in-5",children:"Defined in"}),"\n",(0,d.jsx)(i.p,{children:(0,d.jsx)(i.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L739",children:"packages/extension-api/src/extension-api.d.ts:739"})}),"\n",(0,d.jsx)(i.hr,{}),"\n",(0,d.jsx)(i.h3,{id:"path",children:"path"}),"\n",(0,d.jsxs)(i.blockquote,{children:["\n",(0,d.jsxs)(i.p,{children:[(0,d.jsx)(i.strong,{children:"path"}),": ",(0,d.jsx)(i.code,{children:"string"})]}),"\n"]}),"\n",(0,d.jsx)(i.h4,{id:"inherited-from-5",children:"Inherited from"}),"\n",(0,d.jsxs)(i.p,{children:[(0,d.jsx)(i.a,{href:"/api/interfaces/ImageFile",children:(0,d.jsx)(i.code,{children:"ImageFile"})}),".",(0,d.jsx)(i.a,{href:"/api/interfaces/ImageFile#path",children:(0,d.jsx)(i.code,{children:"path"})})]}),"\n",(0,d.jsx)(i.h4,{id:"defined-in-6",children:"Defined in"}),"\n",(0,d.jsx)(i.p,{children:(0,d.jsx)(i.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L730",children:"packages/extension-api/src/extension-api.d.ts:730"})}),"\n",(0,d.jsx)(i.hr,{}),"\n",(0,d.jsx)(i.h3,{id:"size",children:"size"}),"\n",(0,d.jsxs)(i.blockquote,{children:["\n",(0,d.jsxs)(i.p,{children:[(0,d.jsx)(i.strong,{children:"size"}),": ",(0,d.jsx)(i.code,{children:"number"})]}),"\n"]}),"\n",(0,d.jsx)(i.h4,{id:"inherited-from-6",children:"Inherited from"}),"\n",(0,d.jsxs)(i.p,{children:[(0,d.jsx)(i.a,{href:"/api/interfaces/ImageFile",children:(0,d.jsx)(i.code,{children:"ImageFile"})}),".",(0,d.jsx)(i.a,{href:"/api/interfaces/ImageFile#size",children:(0,d.jsx)(i.code,{children:"size"})})]}),"\n",(0,d.jsx)(i.h4,{id:"defined-in-7",children:"Defined in"}),"\n",(0,d.jsx)(i.p,{children:(0,d.jsx)(i.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L736",children:"packages/extension-api/src/extension-api.d.ts:736"})}),"\n",(0,d.jsx)(i.hr,{}),"\n",(0,d.jsx)(i.h3,{id:"type",children:"type"}),"\n",(0,d.jsxs)(i.blockquote,{children:["\n",(0,d.jsxs)(i.p,{children:[(0,d.jsx)(i.strong,{children:"type"}),": ",(0,d.jsx)(i.code,{children:'"symlink"'})]}),"\n"]}),"\n",(0,d.jsx)(i.h4,{id:"overrides",children:"Overrides"}),"\n",(0,d.jsxs)(i.p,{children:[(0,d.jsx)(i.a,{href:"/api/interfaces/ImageFile",children:(0,d.jsx)(i.code,{children:"ImageFile"})}),".",(0,d.jsx)(i.a,{href:"/api/interfaces/ImageFile#type",children:(0,d.jsx)(i.code,{children:"type"})})]}),"\n",(0,d.jsx)(i.h4,{id:"defined-in-8",children:"Defined in"}),"\n",(0,d.jsx)(i.p,{children:(0,d.jsx)(i.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L746",children:"packages/extension-api/src/extension-api.d.ts:746"})}),"\n",(0,d.jsx)(i.hr,{}),"\n",(0,d.jsx)(i.h3,{id:"uid",children:"uid"}),"\n",(0,d.jsxs)(i.blockquote,{children:["\n",(0,d.jsxs)(i.p,{children:[(0,d.jsx)(i.strong,{children:"uid"}),": ",(0,d.jsx)(i.code,{children:"number"})]}),"\n"]}),"\n",(0,d.jsx)(i.h4,{id:"inherited-from-7",children:"Inherited from"}),"\n",(0,d.jsxs)(i.p,{children:[(0,d.jsx)(i.a,{href:"/api/interfaces/ImageFile",children:(0,d.jsx)(i.code,{children:"ImageFile"})}),".",(0,d.jsx)(i.a,{href:"/api/interfaces/ImageFile#uid",children:(0,d.jsx)(i.code,{children:"uid"})})]}),"\n",(0,d.jsx)(i.h4,{id:"defined-in-9",children:"Defined in"}),"\n",(0,d.jsx)(i.p,{children:(0,d.jsx)(i.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L734",children:"packages/extension-api/src/extension-api.d.ts:734"})})]})}function o(e={}){const{wrapper:i}={...(0,s.R)(),...e.components};return i?(0,d.jsx)(i,{...e,children:(0,d.jsx)(h,{...e})}):h(e)}},43023:(e,i,n)=>{n.d(i,{R:()=>a,x:()=>l});var d=n(63696);const s={},r=d.createContext(s);function a(e){const i=d.useContext(r);return d.useMemo((function(){return"function"==typeof e?e(i):{...i,...e}}),[i,e])}function l(e){let i;return i=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:a(e.components),d.createElement(r.Provider,{value:i},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/57a8015d.ac62bb11.js b/assets/js/57a8015d.ae7e76ac.js similarity index 98% rename from assets/js/57a8015d.ac62bb11.js rename to assets/js/57a8015d.ae7e76ac.js index 9ab322fd8e2..6fdc67ad3ee 100644 --- a/assets/js/57a8015d.ac62bb11.js +++ b/assets/js/57a8015d.ae7e76ac.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[96170],{87523:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>r,contentTitle:()=>o,default:()=>v,frontMatter:()=>a,metadata:()=>c,toc:()=>d});var s=i(62540),t=i(43023);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:"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:"Defined in",id:"defined-in",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",header:"header",li:"li",p:"p",strong:"strong",ul:"ul",...(0,t.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.header,{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:"defined-in",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L4532",children:"packages/extension-api/src/extension-api.d.ts:4532"})})]})}function v(e={}){const{wrapper:n}={...(0,t.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},43023:(e,n,i)=>{i.d(n,{R:()=>o,x:()=>c});var s=i(63696);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([[96170],{87523:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>r,contentTitle:()=>o,default:()=>v,frontMatter:()=>a,metadata:()=>c,toc:()=>d});var s=i(62540),t=i(43023);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:"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:"Defined in",id:"defined-in",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",header:"header",li:"li",p:"p",strong:"strong",ul:"ul",...(0,t.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.header,{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:"defined-in",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L4532",children:"packages/extension-api/src/extension-api.d.ts:4532"})})]})}function v(e={}){const{wrapper:n}={...(0,t.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},43023:(e,n,i)=>{i.d(n,{R:()=>o,x:()=>c});var s=i(63696);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.dc7274a2.js b/assets/js/57dba496.0f1160d7.js similarity index 92% rename from assets/js/57dba496.dc7274a2.js rename to assets/js/57dba496.0f1160d7.js index 75b4ea9c690..99aa9666627 100644 --- a/assets/js/57dba496.dc7274a2.js +++ b/assets/js/57dba496.0f1160d7.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[88499],{75712:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>o,contentTitle:()=>d,default:()=>h,frontMatter:()=>t,metadata:()=>c,toc:()=>l});var s=i(62540),r=i(43023);const t={},d="Interface: PullEvent",c={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"}},o={},l=[{value:"Properties",id:"properties",level:2},{value:"error?",id:"error",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"errorDetails?",id:"errordetails",level:3},{value:"message?",id:"message",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"id?",id:"id",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"progress?",id:"progress",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"progressDetail?",id:"progressdetail",level:3},{value:"current?",id:"current",level:4},{value:"total?",id:"total",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"status?",id:"status",level:3},{value:"Defined in",id:"defined-in-5",level:4},{value:"stream?",id:"stream",level:3},{value:"Defined in",id:"defined-in-6",level:4}];function a(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",p:"p",strong:"strong",...(0,r.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.header,{children:(0,s.jsx)(n.h1,{id:"interface-pullevent",children:"Interface: PullEvent"})}),"\n",(0,s.jsx)(n.h2,{id:"properties",children:"Properties"}),"\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.code,{children:"optional"})," ",(0,s.jsx)(n.strong,{children:"error"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2690",children:"packages/extension-api/src/extension-api.d.ts:2690"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"errordetails",children:"errorDetails?"}),"\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:"errorDetails"}),": ",(0,s.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"message",children:"message?"}),"\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:"message"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2691",children:"packages/extension-api/src/extension-api.d.ts:2691"})}),"\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.code,{children:"optional"})," ",(0,s.jsx)(n.strong,{children:"id"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-2",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2683",children:"packages/extension-api/src/extension-api.d.ts:2683"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"progress",children:"progress?"}),"\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:"progress"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-3",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2685",children:"packages/extension-api/src/extension-api.d.ts:2685"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"progressdetail",children:"progressDetail?"}),"\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:"progressDetail"}),": ",(0,s.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{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:"total",children:"total?"}),"\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:"total"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-4",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2686",children:"packages/extension-api/src/extension-api.d.ts:2686"})}),"\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.code,{children:"optional"})," ",(0,s.jsx)(n.strong,{children:"status"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-5",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2684",children:"packages/extension-api/src/extension-api.d.ts:2684"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"stream",children:"stream?"}),"\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:"stream"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-6",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2682",children:"packages/extension-api/src/extension-api.d.ts:2682"})})]})}function h(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(a,{...e})}):a(e)}},43023:(e,n,i)=>{i.d(n,{R:()=>d,x:()=>c});var s=i(63696);const r={},t=s.createContext(r);function d(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:d(e.components),s.createElement(t.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[88499],{75712:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>o,contentTitle:()=>d,default:()=>h,frontMatter:()=>t,metadata:()=>c,toc:()=>l});var s=i(62540),r=i(43023);const t={},d="Interface: PullEvent",c={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"}},o={},l=[{value:"Properties",id:"properties",level:2},{value:"error?",id:"error",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"errorDetails?",id:"errordetails",level:3},{value:"message?",id:"message",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"id?",id:"id",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"progress?",id:"progress",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"progressDetail?",id:"progressdetail",level:3},{value:"current?",id:"current",level:4},{value:"total?",id:"total",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"status?",id:"status",level:3},{value:"Defined in",id:"defined-in-5",level:4},{value:"stream?",id:"stream",level:3},{value:"Defined in",id:"defined-in-6",level:4}];function a(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",p:"p",strong:"strong",...(0,r.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.header,{children:(0,s.jsx)(n.h1,{id:"interface-pullevent",children:"Interface: PullEvent"})}),"\n",(0,s.jsx)(n.h2,{id:"properties",children:"Properties"}),"\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.code,{children:"optional"})," ",(0,s.jsx)(n.strong,{children:"error"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2690",children:"packages/extension-api/src/extension-api.d.ts:2690"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"errordetails",children:"errorDetails?"}),"\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:"errorDetails"}),": ",(0,s.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"message",children:"message?"}),"\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:"message"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2691",children:"packages/extension-api/src/extension-api.d.ts:2691"})}),"\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.code,{children:"optional"})," ",(0,s.jsx)(n.strong,{children:"id"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-2",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2683",children:"packages/extension-api/src/extension-api.d.ts:2683"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"progress",children:"progress?"}),"\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:"progress"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-3",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2685",children:"packages/extension-api/src/extension-api.d.ts:2685"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"progressdetail",children:"progressDetail?"}),"\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:"progressDetail"}),": ",(0,s.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{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:"total",children:"total?"}),"\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:"total"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-4",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2686",children:"packages/extension-api/src/extension-api.d.ts:2686"})}),"\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.code,{children:"optional"})," ",(0,s.jsx)(n.strong,{children:"status"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-5",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2684",children:"packages/extension-api/src/extension-api.d.ts:2684"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"stream",children:"stream?"}),"\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:"stream"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-6",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2682",children:"packages/extension-api/src/extension-api.d.ts:2682"})})]})}function h(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(a,{...e})}):a(e)}},43023:(e,n,i)=>{i.d(n,{R:()=>d,x:()=>c});var s=i(63696);const r={},t=s.createContext(r);function d(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:d(e.components),s.createElement(t.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/57e01cd5.dc3646b8.js b/assets/js/57e01cd5.b6ea49b4.js similarity index 97% rename from assets/js/57e01cd5.dc3646b8.js rename to assets/js/57e01cd5.b6ea49b4.js index 4e0e4476311..ff79e74ce51 100644 --- a/assets/js/57e01cd5.dc3646b8.js +++ b/assets/js/57e01cd5.b6ea49b4.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[94209],{94834:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>o,contentTitle:()=>r,default:()=>p,frontMatter:()=>i,metadata:()=>l,toc:()=>c});var a=n(62540),s=n(43023);const i={},r="Type Alias: StatusBarAlignment",l={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"}},o={},c=[{value:"Defined in",id:"defined-in",level:2}];function d(e){const t={a:"a",blockquote:"blockquote",code:"code",em:"em",h1:"h1",h2:"h2",header:"header",p:"p",strong:"strong",...(0,s.R)(),...e.components};return(0,a.jsxs)(a.Fragment,{children:[(0,a.jsx)(t.header,{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:"defined-in",children:"Defined in"}),"\n",(0,a.jsx)(t.p,{children:(0,a.jsx)(t.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L1491",children:"packages/extension-api/src/extension-api.d.ts:1491"})})]})}function p(e={}){const{wrapper:t}={...(0,s.R)(),...e.components};return t?(0,a.jsx)(t,{...e,children:(0,a.jsx)(d,{...e})}):d(e)}},43023:(e,t,n)=>{n.d(t,{R:()=>r,x:()=>l});var a=n(63696);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 l(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([[94209],{94834:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>o,contentTitle:()=>r,default:()=>p,frontMatter:()=>i,metadata:()=>l,toc:()=>c});var a=n(62540),s=n(43023);const i={},r="Type Alias: StatusBarAlignment",l={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"}},o={},c=[{value:"Defined in",id:"defined-in",level:2}];function d(e){const t={a:"a",blockquote:"blockquote",code:"code",em:"em",h1:"h1",h2:"h2",header:"header",p:"p",strong:"strong",...(0,s.R)(),...e.components};return(0,a.jsxs)(a.Fragment,{children:[(0,a.jsx)(t.header,{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:"defined-in",children:"Defined in"}),"\n",(0,a.jsx)(t.p,{children:(0,a.jsx)(t.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L1491",children:"packages/extension-api/src/extension-api.d.ts:1491"})})]})}function p(e={}){const{wrapper:t}={...(0,s.R)(),...e.components};return t?(0,a.jsx)(t,{...e,children:(0,a.jsx)(d,{...e})}):d(e)}},43023:(e,t,n)=>{n.d(t,{R:()=>r,x:()=>l});var a=n(63696);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 l(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.8acec8ac.js b/assets/js/5a7aef43.413eeb80.js similarity index 95% rename from assets/js/5a7aef43.8acec8ac.js rename to assets/js/5a7aef43.413eeb80.js index bbed058ac39..d6dd18a1bbd 100644 --- a/assets/js/5a7aef43.8acec8ac.js +++ b/assets/js/5a7aef43.413eeb80.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[15607],{85116:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>r,contentTitle:()=>o,default:()=>p,frontMatter:()=>s,metadata:()=>c,toc:()=>d});var a=t(62540),i=t(43023);const s={},o="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:"Defined in",id:"defined-in",level:2}];function u(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",strong:"strong",...(0,i.R)(),...e.components};return(0,a.jsxs)(a.Fragment,{children:[(0,a.jsx)(n.header,{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:"defined-in",children:"Defined in"}),"\n",(0,a.jsx)(n.p,{children:(0,a.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L4509",children:"packages/extension-api/src/extension-api.d.ts:4509"})})]})}function p(e={}){const{wrapper:n}={...(0,i.R)(),...e.components};return n?(0,a.jsx)(n,{...e,children:(0,a.jsx)(u,{...e})}):u(e)}},43023:(e,n,t)=>{t.d(n,{R:()=>o,x:()=>c});var a=t(63696);const i={},s=a.createContext(i);function o(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(i):e.components||i:o(e.components),a.createElement(s.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[15607],{85116:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>r,contentTitle:()=>o,default:()=>p,frontMatter:()=>s,metadata:()=>c,toc:()=>d});var a=t(62540),i=t(43023);const s={},o="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:"Defined in",id:"defined-in",level:2}];function u(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",strong:"strong",...(0,i.R)(),...e.components};return(0,a.jsxs)(a.Fragment,{children:[(0,a.jsx)(n.header,{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:"defined-in",children:"Defined in"}),"\n",(0,a.jsx)(n.p,{children:(0,a.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L4509",children:"packages/extension-api/src/extension-api.d.ts:4509"})})]})}function p(e={}){const{wrapper:n}={...(0,i.R)(),...e.components};return n?(0,a.jsx)(n,{...e,children:(0,a.jsx)(u,{...e})}):u(e)}},43023:(e,n,t)=>{t.d(n,{R:()=>o,x:()=>c});var a=t(63696);const i={},s=a.createContext(i);function o(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(i):e.components||i:o(e.components),a.createElement(s.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/5a9a7a02.f95f5405.js b/assets/js/5a9a7a02.fef2f70c.js similarity index 97% rename from assets/js/5a9a7a02.f95f5405.js rename to assets/js/5a9a7a02.fef2f70c.js index 36edd1e5837..f70198fa61a 100644 --- a/assets/js/5a9a7a02.f95f5405.js +++ b/assets/js/5a9a7a02.fef2f70c.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[18445],{38220:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>c,default:()=>u,frontMatter:()=>o,metadata:()=>r,toc:()=>d});var s=t(62540),i=t(43023);const o={},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={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Defined in",id:"defined-in",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",strong:"strong",...(0,i.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.header,{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:"defined-in",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L3678",children:"packages/extension-api/src/extension-api.d.ts:3678"})})]})}function u(e={}){const{wrapper:n}={...(0,i.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},43023:(e,n,t)=>{t.d(n,{R:()=>c,x:()=>r});var s=t(63696);const i={},o=s.createContext(i);function c(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:c(e.components),s.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[18445],{38220:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>c,default:()=>u,frontMatter:()=>o,metadata:()=>r,toc:()=>d});var s=t(62540),i=t(43023);const o={},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={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Defined in",id:"defined-in",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",strong:"strong",...(0,i.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.header,{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:"defined-in",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L3678",children:"packages/extension-api/src/extension-api.d.ts:3678"})})]})}function u(e={}){const{wrapper:n}={...(0,i.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},43023:(e,n,t)=>{t.d(n,{R:()=>c,x:()=>r});var s=t(63696);const i={},o=s.createContext(i);function c(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:c(e.components),s.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/5b10a003.df6ca68a.js b/assets/js/5b10a003.06726e81.js similarity index 89% rename from assets/js/5b10a003.df6ca68a.js rename to assets/js/5b10a003.06726e81.js index ab6e71be71e..8a7f17a0750 100644 --- a/assets/js/5b10a003.df6ca68a.js +++ b/assets/js/5b10a003.06726e81.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[43425],{33767:(e,i,n)=>{n.r(i),n.d(i,{assets:()=>a,contentTitle:()=>c,default:()=>h,frontMatter:()=>t,metadata:()=>d,toc:()=>o});var s=n(62540),r=n(43023);const t={},c="Interface: BlkioStats",d={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={},o=[{value:"Properties",id:"properties",level:2},{value:"io_merged_recursive",id:"io_merged_recursive",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"io_queue_recursive",id:"io_queue_recursive",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"io_service_bytes_recursive",id:"io_service_bytes_recursive",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"io_service_time_recursive",id:"io_service_time_recursive",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"io_serviced_recursive",id:"io_serviced_recursive",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"io_time_recursive",id:"io_time_recursive",level:3},{value:"Defined in",id:"defined-in-5",level:4},{value:"io_wait_time_recursive",id:"io_wait_time_recursive",level:3},{value:"Defined in",id:"defined-in-6",level:4},{value:"sectors_recursive",id:"sectors_recursive",level:3},{value:"Defined in",id:"defined-in-7",level:4}];function l(e){const i={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",p:"p",strong:"strong",...(0,r.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(i.header,{children:(0,s.jsx)(i.h1,{id:"interface-blkiostats",children:"Interface: BlkioStats"})}),"\n",(0,s.jsx)(i.h2,{id:"properties",children:"Properties"}),"\n",(0,s.jsx)(i.h3,{id:"io_merged_recursive",children:"io_merged_recursive"}),"\n",(0,s.jsxs)(i.blockquote,{children:["\n",(0,s.jsxs)(i.p,{children:[(0,s.jsx)(i.strong,{children:"io_merged_recursive"}),": ",(0,s.jsx)(i.a,{href:"/api/interfaces/BlkioStatEntry",children:(0,s.jsx)(i.code,{children:"BlkioStatEntry"})}),"[]"]}),"\n"]}),"\n",(0,s.jsx)(i.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,s.jsx)(i.p,{children:(0,s.jsx)(i.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L3081",children:"packages/extension-api/src/extension-api.d.ts:3081"})}),"\n",(0,s.jsx)(i.hr,{}),"\n",(0,s.jsx)(i.h3,{id:"io_queue_recursive",children:"io_queue_recursive"}),"\n",(0,s.jsxs)(i.blockquote,{children:["\n",(0,s.jsxs)(i.p,{children:[(0,s.jsx)(i.strong,{children:"io_queue_recursive"}),": ",(0,s.jsx)(i.a,{href:"/api/interfaces/BlkioStatEntry",children:(0,s.jsx)(i.code,{children:"BlkioStatEntry"})}),"[]"]}),"\n"]}),"\n",(0,s.jsx)(i.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,s.jsx)(i.p,{children:(0,s.jsx)(i.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L3078",children:"packages/extension-api/src/extension-api.d.ts:3078"})}),"\n",(0,s.jsx)(i.hr,{}),"\n",(0,s.jsx)(i.h3,{id:"io_service_bytes_recursive",children:"io_service_bytes_recursive"}),"\n",(0,s.jsxs)(i.blockquote,{children:["\n",(0,s.jsxs)(i.p,{children:[(0,s.jsx)(i.strong,{children:"io_service_bytes_recursive"}),": ",(0,s.jsx)(i.a,{href:"/api/interfaces/BlkioStatEntry",children:(0,s.jsx)(i.code,{children:"BlkioStatEntry"})}),"[]"]}),"\n"]}),"\n",(0,s.jsx)(i.h4,{id:"defined-in-2",children:"Defined in"}),"\n",(0,s.jsx)(i.p,{children:(0,s.jsx)(i.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L3076",children:"packages/extension-api/src/extension-api.d.ts:3076"})}),"\n",(0,s.jsx)(i.hr,{}),"\n",(0,s.jsx)(i.h3,{id:"io_service_time_recursive",children:"io_service_time_recursive"}),"\n",(0,s.jsxs)(i.blockquote,{children:["\n",(0,s.jsxs)(i.p,{children:[(0,s.jsx)(i.strong,{children:"io_service_time_recursive"}),": ",(0,s.jsx)(i.a,{href:"/api/interfaces/BlkioStatEntry",children:(0,s.jsx)(i.code,{children:"BlkioStatEntry"})}),"[]"]}),"\n"]}),"\n",(0,s.jsx)(i.h4,{id:"defined-in-3",children:"Defined in"}),"\n",(0,s.jsx)(i.p,{children:(0,s.jsx)(i.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L3079",children:"packages/extension-api/src/extension-api.d.ts:3079"})}),"\n",(0,s.jsx)(i.hr,{}),"\n",(0,s.jsx)(i.h3,{id:"io_serviced_recursive",children:"io_serviced_recursive"}),"\n",(0,s.jsxs)(i.blockquote,{children:["\n",(0,s.jsxs)(i.p,{children:[(0,s.jsx)(i.strong,{children:"io_serviced_recursive"}),": ",(0,s.jsx)(i.a,{href:"/api/interfaces/BlkioStatEntry",children:(0,s.jsx)(i.code,{children:"BlkioStatEntry"})}),"[]"]}),"\n"]}),"\n",(0,s.jsx)(i.h4,{id:"defined-in-4",children:"Defined in"}),"\n",(0,s.jsx)(i.p,{children:(0,s.jsx)(i.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L3077",children:"packages/extension-api/src/extension-api.d.ts:3077"})}),"\n",(0,s.jsx)(i.hr,{}),"\n",(0,s.jsx)(i.h3,{id:"io_time_recursive",children:"io_time_recursive"}),"\n",(0,s.jsxs)(i.blockquote,{children:["\n",(0,s.jsxs)(i.p,{children:[(0,s.jsx)(i.strong,{children:"io_time_recursive"}),": ",(0,s.jsx)(i.a,{href:"/api/interfaces/BlkioStatEntry",children:(0,s.jsx)(i.code,{children:"BlkioStatEntry"})}),"[]"]}),"\n"]}),"\n",(0,s.jsx)(i.h4,{id:"defined-in-5",children:"Defined in"}),"\n",(0,s.jsx)(i.p,{children:(0,s.jsx)(i.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L3082",children:"packages/extension-api/src/extension-api.d.ts:3082"})}),"\n",(0,s.jsx)(i.hr,{}),"\n",(0,s.jsx)(i.h3,{id:"io_wait_time_recursive",children:"io_wait_time_recursive"}),"\n",(0,s.jsxs)(i.blockquote,{children:["\n",(0,s.jsxs)(i.p,{children:[(0,s.jsx)(i.strong,{children:"io_wait_time_recursive"}),": ",(0,s.jsx)(i.a,{href:"/api/interfaces/BlkioStatEntry",children:(0,s.jsx)(i.code,{children:"BlkioStatEntry"})}),"[]"]}),"\n"]}),"\n",(0,s.jsx)(i.h4,{id:"defined-in-6",children:"Defined in"}),"\n",(0,s.jsx)(i.p,{children:(0,s.jsx)(i.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L3080",children:"packages/extension-api/src/extension-api.d.ts:3080"})}),"\n",(0,s.jsx)(i.hr,{}),"\n",(0,s.jsx)(i.h3,{id:"sectors_recursive",children:"sectors_recursive"}),"\n",(0,s.jsxs)(i.blockquote,{children:["\n",(0,s.jsxs)(i.p,{children:[(0,s.jsx)(i.strong,{children:"sectors_recursive"}),": ",(0,s.jsx)(i.a,{href:"/api/interfaces/BlkioStatEntry",children:(0,s.jsx)(i.code,{children:"BlkioStatEntry"})}),"[]"]}),"\n"]}),"\n",(0,s.jsx)(i.h4,{id:"defined-in-7",children:"Defined in"}),"\n",(0,s.jsx)(i.p,{children:(0,s.jsx)(i.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L3083",children:"packages/extension-api/src/extension-api.d.ts:3083"})})]})}function h(e={}){const{wrapper:i}={...(0,r.R)(),...e.components};return i?(0,s.jsx)(i,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},43023:(e,i,n)=>{n.d(i,{R:()=>c,x:()=>d});var s=n(63696);const r={},t=s.createContext(r);function c(e){const i=s.useContext(t);return s.useMemo((function(){return"function"==typeof e?e(i):{...i,...e}}),[i,e])}function d(e){let i;return i=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:c(e.components),s.createElement(t.Provider,{value:i},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[43425],{33767:(e,i,n)=>{n.r(i),n.d(i,{assets:()=>a,contentTitle:()=>c,default:()=>h,frontMatter:()=>t,metadata:()=>d,toc:()=>o});var s=n(62540),r=n(43023);const t={},c="Interface: BlkioStats",d={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={},o=[{value:"Properties",id:"properties",level:2},{value:"io_merged_recursive",id:"io_merged_recursive",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"io_queue_recursive",id:"io_queue_recursive",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"io_service_bytes_recursive",id:"io_service_bytes_recursive",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"io_service_time_recursive",id:"io_service_time_recursive",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"io_serviced_recursive",id:"io_serviced_recursive",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"io_time_recursive",id:"io_time_recursive",level:3},{value:"Defined in",id:"defined-in-5",level:4},{value:"io_wait_time_recursive",id:"io_wait_time_recursive",level:3},{value:"Defined in",id:"defined-in-6",level:4},{value:"sectors_recursive",id:"sectors_recursive",level:3},{value:"Defined in",id:"defined-in-7",level:4}];function l(e){const i={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",p:"p",strong:"strong",...(0,r.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(i.header,{children:(0,s.jsx)(i.h1,{id:"interface-blkiostats",children:"Interface: BlkioStats"})}),"\n",(0,s.jsx)(i.h2,{id:"properties",children:"Properties"}),"\n",(0,s.jsx)(i.h3,{id:"io_merged_recursive",children:"io_merged_recursive"}),"\n",(0,s.jsxs)(i.blockquote,{children:["\n",(0,s.jsxs)(i.p,{children:[(0,s.jsx)(i.strong,{children:"io_merged_recursive"}),": ",(0,s.jsx)(i.a,{href:"/api/interfaces/BlkioStatEntry",children:(0,s.jsx)(i.code,{children:"BlkioStatEntry"})}),"[]"]}),"\n"]}),"\n",(0,s.jsx)(i.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,s.jsx)(i.p,{children:(0,s.jsx)(i.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L3081",children:"packages/extension-api/src/extension-api.d.ts:3081"})}),"\n",(0,s.jsx)(i.hr,{}),"\n",(0,s.jsx)(i.h3,{id:"io_queue_recursive",children:"io_queue_recursive"}),"\n",(0,s.jsxs)(i.blockquote,{children:["\n",(0,s.jsxs)(i.p,{children:[(0,s.jsx)(i.strong,{children:"io_queue_recursive"}),": ",(0,s.jsx)(i.a,{href:"/api/interfaces/BlkioStatEntry",children:(0,s.jsx)(i.code,{children:"BlkioStatEntry"})}),"[]"]}),"\n"]}),"\n",(0,s.jsx)(i.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,s.jsx)(i.p,{children:(0,s.jsx)(i.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L3078",children:"packages/extension-api/src/extension-api.d.ts:3078"})}),"\n",(0,s.jsx)(i.hr,{}),"\n",(0,s.jsx)(i.h3,{id:"io_service_bytes_recursive",children:"io_service_bytes_recursive"}),"\n",(0,s.jsxs)(i.blockquote,{children:["\n",(0,s.jsxs)(i.p,{children:[(0,s.jsx)(i.strong,{children:"io_service_bytes_recursive"}),": ",(0,s.jsx)(i.a,{href:"/api/interfaces/BlkioStatEntry",children:(0,s.jsx)(i.code,{children:"BlkioStatEntry"})}),"[]"]}),"\n"]}),"\n",(0,s.jsx)(i.h4,{id:"defined-in-2",children:"Defined in"}),"\n",(0,s.jsx)(i.p,{children:(0,s.jsx)(i.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L3076",children:"packages/extension-api/src/extension-api.d.ts:3076"})}),"\n",(0,s.jsx)(i.hr,{}),"\n",(0,s.jsx)(i.h3,{id:"io_service_time_recursive",children:"io_service_time_recursive"}),"\n",(0,s.jsxs)(i.blockquote,{children:["\n",(0,s.jsxs)(i.p,{children:[(0,s.jsx)(i.strong,{children:"io_service_time_recursive"}),": ",(0,s.jsx)(i.a,{href:"/api/interfaces/BlkioStatEntry",children:(0,s.jsx)(i.code,{children:"BlkioStatEntry"})}),"[]"]}),"\n"]}),"\n",(0,s.jsx)(i.h4,{id:"defined-in-3",children:"Defined in"}),"\n",(0,s.jsx)(i.p,{children:(0,s.jsx)(i.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L3079",children:"packages/extension-api/src/extension-api.d.ts:3079"})}),"\n",(0,s.jsx)(i.hr,{}),"\n",(0,s.jsx)(i.h3,{id:"io_serviced_recursive",children:"io_serviced_recursive"}),"\n",(0,s.jsxs)(i.blockquote,{children:["\n",(0,s.jsxs)(i.p,{children:[(0,s.jsx)(i.strong,{children:"io_serviced_recursive"}),": ",(0,s.jsx)(i.a,{href:"/api/interfaces/BlkioStatEntry",children:(0,s.jsx)(i.code,{children:"BlkioStatEntry"})}),"[]"]}),"\n"]}),"\n",(0,s.jsx)(i.h4,{id:"defined-in-4",children:"Defined in"}),"\n",(0,s.jsx)(i.p,{children:(0,s.jsx)(i.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L3077",children:"packages/extension-api/src/extension-api.d.ts:3077"})}),"\n",(0,s.jsx)(i.hr,{}),"\n",(0,s.jsx)(i.h3,{id:"io_time_recursive",children:"io_time_recursive"}),"\n",(0,s.jsxs)(i.blockquote,{children:["\n",(0,s.jsxs)(i.p,{children:[(0,s.jsx)(i.strong,{children:"io_time_recursive"}),": ",(0,s.jsx)(i.a,{href:"/api/interfaces/BlkioStatEntry",children:(0,s.jsx)(i.code,{children:"BlkioStatEntry"})}),"[]"]}),"\n"]}),"\n",(0,s.jsx)(i.h4,{id:"defined-in-5",children:"Defined in"}),"\n",(0,s.jsx)(i.p,{children:(0,s.jsx)(i.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L3082",children:"packages/extension-api/src/extension-api.d.ts:3082"})}),"\n",(0,s.jsx)(i.hr,{}),"\n",(0,s.jsx)(i.h3,{id:"io_wait_time_recursive",children:"io_wait_time_recursive"}),"\n",(0,s.jsxs)(i.blockquote,{children:["\n",(0,s.jsxs)(i.p,{children:[(0,s.jsx)(i.strong,{children:"io_wait_time_recursive"}),": ",(0,s.jsx)(i.a,{href:"/api/interfaces/BlkioStatEntry",children:(0,s.jsx)(i.code,{children:"BlkioStatEntry"})}),"[]"]}),"\n"]}),"\n",(0,s.jsx)(i.h4,{id:"defined-in-6",children:"Defined in"}),"\n",(0,s.jsx)(i.p,{children:(0,s.jsx)(i.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L3080",children:"packages/extension-api/src/extension-api.d.ts:3080"})}),"\n",(0,s.jsx)(i.hr,{}),"\n",(0,s.jsx)(i.h3,{id:"sectors_recursive",children:"sectors_recursive"}),"\n",(0,s.jsxs)(i.blockquote,{children:["\n",(0,s.jsxs)(i.p,{children:[(0,s.jsx)(i.strong,{children:"sectors_recursive"}),": ",(0,s.jsx)(i.a,{href:"/api/interfaces/BlkioStatEntry",children:(0,s.jsx)(i.code,{children:"BlkioStatEntry"})}),"[]"]}),"\n"]}),"\n",(0,s.jsx)(i.h4,{id:"defined-in-7",children:"Defined in"}),"\n",(0,s.jsx)(i.p,{children:(0,s.jsx)(i.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L3083",children:"packages/extension-api/src/extension-api.d.ts:3083"})})]})}function h(e={}){const{wrapper:i}={...(0,r.R)(),...e.components};return i?(0,s.jsx)(i,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},43023:(e,i,n)=>{n.d(i,{R:()=>c,x:()=>d});var s=n(63696);const r={},t=s.createContext(r);function c(e){const i=s.useContext(t);return s.useMemo((function(){return"function"==typeof e?e(i):{...i,...e}}),[i,e])}function d(e){let i;return i=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:c(e.components),s.createElement(t.Provider,{value:i},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/5b7d9ef2.160cb4ae.js b/assets/js/5b7d9ef2.5d5a57ca.js similarity index 94% rename from assets/js/5b7d9ef2.160cb4ae.js rename to assets/js/5b7d9ef2.5d5a57ca.js index 658d9b678a4..d8ac1ecddcd 100644 --- a/assets/js/5b7d9ef2.160cb4ae.js +++ b/assets/js/5b7d9ef2.5d5a57ca.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[44693],{38105:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>c,contentTitle:()=>a,default:()=>l,frontMatter:()=>o,metadata:()=>i,toc:()=>p});var r=t(62540),s=t(43023);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:"Defined in",id:"defined-in",level:2}];function d(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",strong:"strong",...(0,s.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.header,{children:(0,r.jsx)(n.h1,{id:"type-alias-kubernetesgeneratortype",children:"Type Alias: KubernetesGeneratorType"})}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"KubernetesGeneratorType"}),": ",(0,r.jsx)(n.code,{children:'"Compose"'})," | ",(0,r.jsx)(n.code,{children:'"Pod"'})," | ",(0,r.jsx)(n.code,{children:'"Container"'})]}),"\n"]}),"\n",(0,r.jsx)(n.h2,{id:"defined-in",children:"Defined in"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2131",children:"packages/extension-api/src/extension-api.d.ts:2131"})})]})}function l(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(d,{...e})}):d(e)}},43023:(e,n,t)=>{t.d(n,{R:()=>a,x:()=>i});var r=t(63696);const s={},o=r.createContext(s);function a(e){const n=r.useContext(o);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(s):e.components||s:a(e.components),r.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[44693],{38105:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>c,contentTitle:()=>a,default:()=>l,frontMatter:()=>o,metadata:()=>i,toc:()=>p});var r=t(62540),s=t(43023);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:"Defined in",id:"defined-in",level:2}];function d(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",strong:"strong",...(0,s.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.header,{children:(0,r.jsx)(n.h1,{id:"type-alias-kubernetesgeneratortype",children:"Type Alias: KubernetesGeneratorType"})}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"KubernetesGeneratorType"}),": ",(0,r.jsx)(n.code,{children:'"Compose"'})," | ",(0,r.jsx)(n.code,{children:'"Pod"'})," | ",(0,r.jsx)(n.code,{children:'"Container"'})]}),"\n"]}),"\n",(0,r.jsx)(n.h2,{id:"defined-in",children:"Defined in"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2131",children:"packages/extension-api/src/extension-api.d.ts:2131"})})]})}function l(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(d,{...e})}):d(e)}},43023:(e,n,t)=>{t.d(n,{R:()=>a,x:()=>i});var r=t(63696);const s={},o=r.createContext(s);function a(e){const n=r.useContext(o);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(s):e.components||s:a(e.components),r.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/5bc09a53.a616dee9.js b/assets/js/5bc09a53.727e6ee1.js similarity index 93% rename from assets/js/5bc09a53.a616dee9.js rename to assets/js/5bc09a53.727e6ee1.js index 2ce3ef23f57..6a28fc5e31b 100644 --- a/assets/js/5bc09a53.a616dee9.js +++ b/assets/js/5bc09a53.727e6ee1.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[69597],{42145:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>l,contentTitle:()=>r,default:()=>h,frontMatter:()=>a,metadata:()=>c,toc:()=>o});var t=i(62540),s=i(43023);const a={},r="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"}},l={},o=[{value:"Properties",id:"properties",level:2},{value:"Interval?",id:"interval",level:3},{value:"Example",id:"example",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"Retries?",id:"retries",level:3},{value:"Example",id:"example-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"StartPeriod?",id:"startperiod",level:3},{value:"Example",id:"example-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"Test?",id:"test",level:3},{value:"Examples",id:"examples",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"Timeout?",id:"timeout",level:3},{value:"Example",id:"example-3",level:4},{value:"Defined in",id:"defined-in-4",level:4}];function d(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",p:"p",pre:"pre",strong:"strong",...(0,s.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.header,{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:"defined-in",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2727",children:"packages/extension-api/src/extension-api.d.ts:2727"})}),"\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:"defined-in-1",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2755",children:"packages/extension-api/src/extension-api.d.ts:2755"})}),"\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:"defined-in-2",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2746",children:"packages/extension-api/src/extension-api.d.ts:2746"})}),"\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:"defined-in-3",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2718",children:"packages/extension-api/src/extension-api.d.ts:2718"})}),"\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:"defined-in-4",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2736",children:"packages/extension-api/src/extension-api.d.ts:2736"})})]})}function h(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(d,{...e})}):d(e)}},43023:(e,n,i)=>{i.d(n,{R:()=>r,x:()=>c});var t=i(63696);const s={},a=t.createContext(s);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(s):e.components||s:r(e.components),t.createElement(a.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[69597],{42145:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>l,contentTitle:()=>r,default:()=>h,frontMatter:()=>a,metadata:()=>c,toc:()=>o});var t=i(62540),s=i(43023);const a={},r="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"}},l={},o=[{value:"Properties",id:"properties",level:2},{value:"Interval?",id:"interval",level:3},{value:"Example",id:"example",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"Retries?",id:"retries",level:3},{value:"Example",id:"example-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"StartPeriod?",id:"startperiod",level:3},{value:"Example",id:"example-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"Test?",id:"test",level:3},{value:"Examples",id:"examples",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"Timeout?",id:"timeout",level:3},{value:"Example",id:"example-3",level:4},{value:"Defined in",id:"defined-in-4",level:4}];function d(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",p:"p",pre:"pre",strong:"strong",...(0,s.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.header,{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:"defined-in",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2727",children:"packages/extension-api/src/extension-api.d.ts:2727"})}),"\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:"defined-in-1",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2755",children:"packages/extension-api/src/extension-api.d.ts:2755"})}),"\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:"defined-in-2",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2746",children:"packages/extension-api/src/extension-api.d.ts:2746"})}),"\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:"defined-in-3",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2718",children:"packages/extension-api/src/extension-api.d.ts:2718"})}),"\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:"defined-in-4",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2736",children:"packages/extension-api/src/extension-api.d.ts:2736"})})]})}function h(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(d,{...e})}):d(e)}},43023:(e,n,i)=>{i.d(n,{R:()=>r,x:()=>c});var t=i(63696);const s={},a=t.createContext(s);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(s):e.components||s:r(e.components),t.createElement(a.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/5c0f0993.9aac335c.js b/assets/js/5c0f0993.27698a25.js similarity index 95% rename from assets/js/5c0f0993.9aac335c.js rename to assets/js/5c0f0993.27698a25.js index 1639c504925..c16d867a826 100644 --- a/assets/js/5c0f0993.9aac335c.js +++ b/assets/js/5c0f0993.27698a25.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[772],{38063:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>c,contentTitle:()=>d,default:()=>h,frontMatter:()=>i,metadata:()=>a,toc:()=>l});var s=r(62540),t=r(43023);const i={},d="Interface: TelemetrySender",a={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"}},c={},l=[{value:"Methods",id:"methods",level:2},{value:"flush()?",id:"flush",level:3},{value:"Returns",id:"returns",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"sendErrorData()",id:"senderrordata",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"sendEventData()",id:"sendeventdata",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-2",level:4},{value:"Defined in",id:"defined-in-2",level:4}];function o(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",p:"p",strong:"strong",...(0,t.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.header,{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:"defined-in",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L4243",children:"packages/extension-api/src/extension-api.d.ts:4243"})}),"\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:"defined-in-1",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L4237",children:"packages/extension-api/src/extension-api.d.ts:4237"})}),"\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:"defined-in-2",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L4228",children:"packages/extension-api/src/extension-api.d.ts:4228"})})]})}function h(e={}){const{wrapper:n}={...(0,t.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(o,{...e})}):o(e)}},43023:(e,n,r)=>{r.d(n,{R:()=>d,x:()=>a});var s=r(63696);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 a(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:d(e.components),s.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[772],{38063:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>c,contentTitle:()=>d,default:()=>h,frontMatter:()=>i,metadata:()=>a,toc:()=>l});var s=r(62540),t=r(43023);const i={},d="Interface: TelemetrySender",a={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"}},c={},l=[{value:"Methods",id:"methods",level:2},{value:"flush()?",id:"flush",level:3},{value:"Returns",id:"returns",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"sendErrorData()",id:"senderrordata",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"sendEventData()",id:"sendeventdata",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-2",level:4},{value:"Defined in",id:"defined-in-2",level:4}];function o(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",p:"p",strong:"strong",...(0,t.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.header,{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:"defined-in",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L4243",children:"packages/extension-api/src/extension-api.d.ts:4243"})}),"\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:"defined-in-1",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L4237",children:"packages/extension-api/src/extension-api.d.ts:4237"})}),"\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:"defined-in-2",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L4228",children:"packages/extension-api/src/extension-api.d.ts:4228"})})]})}function h(e={}){const{wrapper:n}={...(0,t.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(o,{...e})}):o(e)}},43023:(e,n,r)=>{r.d(n,{R:()=>d,x:()=>a});var s=r(63696);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 a(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.ab24268d.js b/assets/js/5db8318c.e5aacc51.js similarity index 98% rename from assets/js/5db8318c.ab24268d.js rename to assets/js/5db8318c.e5aacc51.js index c0a88957bbd..c13454add08 100644 --- a/assets/js/5db8318c.ab24268d.js +++ b/assets/js/5db8318c.e5aacc51.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[17853],{1440:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>o,contentTitle:()=>r,default:()=>l,frontMatter:()=>a,metadata:()=>c,toc:()=>d});var t=s(62540),i=s(43023);const a={},r="Function: registerCommand()",c={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:"configuration",permalink:"/api/namespaces/configuration/"}},o={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Throws",id:"throws",level:2},{value:"Defined in",id:"defined-in",level:2}];function m(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",strong:"strong",...(0,i.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.header,{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:"defined-in",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L675",children:"packages/extension-api/src/extension-api.d.ts:675"})})]})}function l(e={}){const{wrapper:n}={...(0,i.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(m,{...e})}):m(e)}},43023:(e,n,s)=>{s.d(n,{R:()=>r,x:()=>c});var t=s(63696);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([[17853],{1440:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>o,contentTitle:()=>r,default:()=>l,frontMatter:()=>a,metadata:()=>c,toc:()=>d});var t=s(62540),i=s(43023);const a={},r="Function: registerCommand()",c={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:"configuration",permalink:"/api/namespaces/configuration/"}},o={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Throws",id:"throws",level:2},{value:"Defined in",id:"defined-in",level:2}];function m(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",strong:"strong",...(0,i.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.header,{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:"defined-in",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L675",children:"packages/extension-api/src/extension-api.d.ts:675"})})]})}function l(e={}){const{wrapper:n}={...(0,i.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(m,{...e})}):m(e)}},43023:(e,n,s)=>{s.d(n,{R:()=>r,x:()=>c});var t=s(63696);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 diff --git a/assets/js/5e30269e.d6a8fa39.js b/assets/js/5e30269e.c6ca280a.js similarity index 97% rename from assets/js/5e30269e.d6a8fa39.js rename to assets/js/5e30269e.c6ca280a.js index cbaaa09746d..f3ffb2e0fee 100644 --- a/assets/js/5e30269e.d6a8fa39.js +++ b/assets/js/5e30269e.c6ca280a.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[53410],{79657:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>d,contentTitle:()=>o,default:()=>p,frontMatter:()=>i,metadata:()=>a,toc:()=>c});var s=n(62540),r=n(43023);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"}},d={},c=[{value:"Defined in",id:"defined-in",level:2}];function l(e){const t={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",strong:"strong",...(0,r.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(t.header,{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:"defined-in",children:"Defined in"}),"\n",(0,s.jsx)(t.p,{children:(0,s.jsx)(t.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/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.R)(),...e.components};return t?(0,s.jsx)(t,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},43023:(e,t,n)=>{n.d(t,{R:()=>o,x:()=>a});var s=n(63696);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([[53410],{79657:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>d,contentTitle:()=>o,default:()=>p,frontMatter:()=>i,metadata:()=>a,toc:()=>c});var s=n(62540),r=n(43023);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"}},d={},c=[{value:"Defined in",id:"defined-in",level:2}];function l(e){const t={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",strong:"strong",...(0,r.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(t.header,{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:"defined-in",children:"Defined in"}),"\n",(0,s.jsx)(t.p,{children:(0,s.jsx)(t.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/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.R)(),...e.components};return t?(0,s.jsx)(t,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},43023:(e,t,n)=>{n.d(t,{R:()=>o,x:()=>a});var s=n(63696);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.07245d3f.js b/assets/js/5e486140.bb4473e0.js similarity index 95% rename from assets/js/5e486140.07245d3f.js rename to assets/js/5e486140.bb4473e0.js index 9198f8aa249..28a37c22895 100644 --- a/assets/js/5e486140.07245d3f.js +++ b/assets/js/5e486140.bb4473e0.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[56898],{91365:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>a,contentTitle:()=>c,default:()=>u,frontMatter:()=>o,metadata:()=>r,toc:()=>d});var t=s(62540),i=s(43023);const o={},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:"Defined in",id:"defined-in",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",strong:"strong",...(0,i.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.header,{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:"defined-in",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L3687",children:"packages/extension-api/src/extension-api.d.ts:3687"})})]})}function u(e={}){const{wrapper:n}={...(0,i.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},43023:(e,n,s)=>{s.d(n,{R:()=>c,x:()=>r});var t=s(63696);const i={},o=t.createContext(i);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(i):e.components||i:c(e.components),t.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[56898],{91365:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>a,contentTitle:()=>c,default:()=>u,frontMatter:()=>o,metadata:()=>r,toc:()=>d});var t=s(62540),i=s(43023);const o={},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:"Defined in",id:"defined-in",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",strong:"strong",...(0,i.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.header,{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:"defined-in",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L3687",children:"packages/extension-api/src/extension-api.d.ts:3687"})})]})}function u(e={}){const{wrapper:n}={...(0,i.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},43023:(e,n,s)=>{s.d(n,{R:()=>c,x:()=>r});var t=s(63696);const i={},o=t.createContext(i);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(i):e.components||i:c(e.components),t.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/5e8fbcdf.e3183753.js b/assets/js/5e8fbcdf.4645a505.js similarity index 88% rename from assets/js/5e8fbcdf.e3183753.js rename to assets/js/5e8fbcdf.4645a505.js index a1de9b07c91..0cb17c0313e 100644 --- a/assets/js/5e8fbcdf.e3183753.js +++ b/assets/js/5e8fbcdf.4645a505.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[99872],{59200:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>o,contentTitle:()=>t,default:()=>h,frontMatter:()=>r,metadata:()=>a,toc:()=>c});var s=i(62540),d=i(43023);const r={},t="Interface: BuildImageOptions",a={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"}},o={},c=[{value:"Properties",id:"properties",level:2},{value:"abortController?",id:"abortcontroller",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"buildargs?",id:"buildargs",level:3},{value:"Index Signature",id:"index-signature",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"cachefrom?",id:"cachefrom",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"containerFile?",id:"containerfile",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"cpuperiod?",id:"cpuperiod",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"cpuquota?",id:"cpuquota",level:3},{value:"Defined in",id:"defined-in-5",level:4},{value:"cpusetcpus?",id:"cpusetcpus",level:3},{value:"Defined in",id:"defined-in-6",level:4},{value:"cpushares?",id:"cpushares",level:3},{value:"Defined in",id:"defined-in-7",level:4},{value:"extrahosts?",id:"extrahosts",level:3},{value:"Defined in",id:"defined-in-8",level:4},{value:"forcerm?",id:"forcerm",level:3},{value:"Defined in",id:"defined-in-9",level:4},{value:"labels?",id:"labels",level:3},{value:"Index Signature",id:"index-signature-1",level:4},{value:"Defined in",id:"defined-in-10",level:4},{value:"memory?",id:"memory",level:3},{value:"Defined in",id:"defined-in-11",level:4},{value:"memswap?",id:"memswap",level:3},{value:"Defined in",id:"defined-in-12",level:4},{value:"networkmode?",id:"networkmode",level:3},{value:"Defined in",id:"defined-in-13",level:4},{value:"nocache?",id:"nocache",level:3},{value:"Defined in",id:"defined-in-14",level:4},{value:"outputs?",id:"outputs",level:3},{value:"Defined in",id:"defined-in-15",level:4},{value:"platform?",id:"platform",level:3},{value:"Defined in",id:"defined-in-16",level:4},{value:"provider?",id:"provider",level:3},{value:"Defined in",id:"defined-in-17",level:4},{value:"pull?",id:"pull",level:3},{value:"Defined in",id:"defined-in-18",level:4},{value:"q?",id:"q",level:3},{value:"Defined in",id:"defined-in-19",level:4},{value:"remote?",id:"remote",level:3},{value:"Defined in",id:"defined-in-20",level:4},{value:"rm?",id:"rm",level:3},{value:"Defined in",id:"defined-in-21",level:4},{value:"shmsize?",id:"shmsize",level:3},{value:"Defined in",id:"defined-in-22",level:4},{value:"squash?",id:"squash",level:3},{value:"Defined in",id:"defined-in-23",level:4},{value:"tag?",id:"tag",level:3},{value:"Defined in",id:"defined-in-24",level:4},{value:"target?",id:"target",level:3},{value:"Defined in",id:"defined-in-25",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",p:"p",strong:"strong",...(0,d.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.header,{children:(0,s.jsx)(n.h1,{id:"interface-buildimageoptions",children:"Interface: BuildImageOptions"})}),"\n",(0,s.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,s.jsx)(n.h3,{id:"abortcontroller",children:"abortController?"}),"\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:"abortController"}),": ",(0,s.jsx)(n.code,{children:"AbortController"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The abort controller for running the build image operation"}),"\n",(0,s.jsx)(n.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/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:"buildargs",children:"buildargs?"}),"\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:"buildargs"}),": ",(0,s.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,s.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,s.jsx)(n.code,{children:"Dockerfile"})," RUN instruction, or for variable\nexpansion in other ",(0,s.jsx)(n.code,{children:"Dockerfilev"})," instructions. This is not meant for passing secret values.\nFor example, the build arg ",(0,s.jsx)(n.code,{children:"FOO=bar"})," would become ",(0,s.jsx)(n.code,{children:'{"FOO":"bar"}'})," in JSON. This would result in the query\nparameter ",(0,s.jsx)(n.code,{children:'buildargs={"FOO":"bar"}'}),". Note that ",(0,s.jsx)(n.code,{children:'{"FOO":"bar"}'})," should be URI component encoded."]}),"\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:"defined-in-1",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L3295",children:"packages/extension-api/src/extension-api.d.ts:3295"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"cachefrom",children:"cachefrom?"}),"\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:"cachefrom"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"JSON array of images used for build cache resolution."}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-2",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L3237",children:"packages/extension-api/src/extension-api.d.ts:3237"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"containerfile",children:"containerFile?"}),"\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:"containerFile"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Specifies a Containerfile which contains instructions for building the image"}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-3",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/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:"cpuperiod",children:"cpuperiod?"}),"\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:"cpuperiod"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The length of a CPU period in microseconds."}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-4",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L3281",children:"packages/extension-api/src/extension-api.d.ts:3281"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"cpuquota",children:"cpuquota?"}),"\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:"cpuquota"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Microseconds of CPU time that the container can get in a CPU period."}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-5",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L3286",children:"packages/extension-api/src/extension-api.d.ts:3286"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"cpusetcpus",children:"cpusetcpus?"}),"\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:"cpusetcpus"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"CPUs in which to allow execution (e.g., 0-3, 0,1)."}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-6",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L3276",children:"packages/extension-api/src/extension-api.d.ts:3276"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"cpushares",children:"cpushares?"}),"\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:"cpushares"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"CPU shares (relative weight)."}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-7",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L3271",children:"packages/extension-api/src/extension-api.d.ts:3271"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"extrahosts",children:"extrahosts?"}),"\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:"extrahosts"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Extra hosts to add to /etc/hosts"}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-8",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L3216",children:"packages/extension-api/src/extension-api.d.ts:3216"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"forcerm",children:"forcerm?"}),"\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:"forcerm"}),": ",(0,s.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Default: false"}),"\n",(0,s.jsx)(n.p,{children:"Always remove intermediate containers, even upon failure."}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-9",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L3256",children:"packages/extension-api/src/extension-api.d.ts:3256"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"labels",children:"labels?"}),"\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:"labels"}),": ",(0,s.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Arbitrary key/value labels to set on the image, as a JSON map of string pairs."}),"\n",(0,s.jsx)(n.h4,{id:"index-signature-1",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:"defined-in-10",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L3310",children:"packages/extension-api/src/extension-api.d.ts:3310"})}),"\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:"Set memory limit for build."}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-11",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L3261",children:"packages/extension-api/src/extension-api.d.ts:3261"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"memswap",children:"memswap?"}),"\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:"memswap"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Total memory (memory + swap). Set as -1 to disable swap."}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-12",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L3266",children:"packages/extension-api/src/extension-api.d.ts:3266"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"networkmode",children:"networkmode?"}),"\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:"networkmode"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:["Sets the networking mode for the run commands during build. Supported standard values are: ",(0,s.jsx)(n.code,{children:"bridge"}),",\n",(0,s.jsx)(n.code,{children:"host"}),", ",(0,s.jsx)(n.code,{children:"none"}),", and ",(0,s.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,s.jsx)(n.h4,{id:"defined-in-13",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L3317",children:"packages/extension-api/src/extension-api.d.ts:3317"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"nocache",children:"nocache?"}),"\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:"nocache"}),": ",(0,s.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Default: false"}),"\n",(0,s.jsx)(n.p,{children:"Do not use the cache when building the image."}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-14",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L3338",children:"packages/extension-api/src/extension-api.d.ts:3338"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"outputs",children:"outputs?"}),"\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:"outputs"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:'Default: ""'}),"\n",(0,s.jsx)(n.p,{children:"BuildKit output configuration"}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-15",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L3331",children:"packages/extension-api/src/extension-api.d.ts:3331"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"platform",children:"platform?"}),"\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:"platform"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.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,s.jsx)(n.h4,{id:"defined-in-16",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L3201",children:"packages/extension-api/src/extension-api.d.ts:3201"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"provider",children:"provider?"}),"\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:"provider"}),": ",(0,s.jsx)(n.a,{href:"/api/interfaces/ContainerProviderConnection",children:(0,s.jsx)(n.code,{children:"ContainerProviderConnection"})})]}),"\n"]}),"\n",(0,s.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,s.jsx)(n.h4,{id:"defined-in-17",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L3206",children:"packages/extension-api/src/extension-api.d.ts:3206"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"pull",children:"pull?"}),"\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:"pull"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Attempt to pull the image even if an older image exists locally."}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-18",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L3242",children:"packages/extension-api/src/extension-api.d.ts:3242"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"q",children:"q?"}),"\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:"q"}),": ",(0,s.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Default: false"}),"\n",(0,s.jsx)(n.p,{children:"Suppress verbose build output."}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-19",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L3232",children:"packages/extension-api/src/extension-api.d.ts:3232"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"remote",children:"remote?"}),"\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:"remote"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.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,s.jsx)(n.h4,{id:"defined-in-20",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L3225",children:"packages/extension-api/src/extension-api.d.ts:3225"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"rm",children:"rm?"}),"\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:"rm"}),": ",(0,s.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Default: true"}),"\n",(0,s.jsx)(n.p,{children:"Remove intermediate containers after a successful build."}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-21",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L3249",children:"packages/extension-api/src/extension-api.d.ts:3249"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"shmsize",children:"shmsize?"}),"\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:"shmsize"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:["Size of ",(0,s.jsx)(n.code,{children:"/dev/shm"})," in bytes. The size must be greater than 0. If omitted the system uses 64MB."]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-22",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L3300",children:"packages/extension-api/src/extension-api.d.ts:3300"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"squash",children:"squash?"}),"\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:"squash"}),": ",(0,s.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Squash the resulting images layers into a single layer."}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-23",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L3305",children:"packages/extension-api/src/extension-api.d.ts:3305"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"tag",children:"tag?"}),"\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:"tag"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Specifies the name which is assigned to the resulting image if the build process completes successfully"}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-24",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L3196",children:"packages/extension-api/src/extension-api.d.ts:3196"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"target",children:"target?"}),"\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:"target"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:'Default: ""'}),"\n",(0,s.jsx)(n.p,{children:"Target build stage"}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-25",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L3324",children:"packages/extension-api/src/extension-api.d.ts:3324"})})]})}function h(e={}){const{wrapper:n}={...(0,d.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},43023:(e,n,i)=>{i.d(n,{R:()=>t,x:()=>a});var s=i(63696);const d={},r=s.createContext(d);function t(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(d):e.components||d:t(e.components),s.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[99872],{59200:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>c,contentTitle:()=>t,default:()=>h,frontMatter:()=>r,metadata:()=>a,toc:()=>o});var s=i(62540),d=i(43023);const r={},t="Interface: BuildImageOptions",a={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"}},c={},o=[{value:"Properties",id:"properties",level:2},{value:"abortController?",id:"abortcontroller",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"buildargs?",id:"buildargs",level:3},{value:"Index Signature",id:"index-signature",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"cachefrom?",id:"cachefrom",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"containerFile?",id:"containerfile",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"cpuperiod?",id:"cpuperiod",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"cpuquota?",id:"cpuquota",level:3},{value:"Defined in",id:"defined-in-5",level:4},{value:"cpusetcpus?",id:"cpusetcpus",level:3},{value:"Defined in",id:"defined-in-6",level:4},{value:"cpushares?",id:"cpushares",level:3},{value:"Defined in",id:"defined-in-7",level:4},{value:"extrahosts?",id:"extrahosts",level:3},{value:"Defined in",id:"defined-in-8",level:4},{value:"forcerm?",id:"forcerm",level:3},{value:"Defined in",id:"defined-in-9",level:4},{value:"labels?",id:"labels",level:3},{value:"Index Signature",id:"index-signature-1",level:4},{value:"Defined in",id:"defined-in-10",level:4},{value:"memory?",id:"memory",level:3},{value:"Defined in",id:"defined-in-11",level:4},{value:"memswap?",id:"memswap",level:3},{value:"Defined in",id:"defined-in-12",level:4},{value:"networkmode?",id:"networkmode",level:3},{value:"Defined in",id:"defined-in-13",level:4},{value:"nocache?",id:"nocache",level:3},{value:"Defined in",id:"defined-in-14",level:4},{value:"outputs?",id:"outputs",level:3},{value:"Defined in",id:"defined-in-15",level:4},{value:"platform?",id:"platform",level:3},{value:"Defined in",id:"defined-in-16",level:4},{value:"provider?",id:"provider",level:3},{value:"Defined in",id:"defined-in-17",level:4},{value:"pull?",id:"pull",level:3},{value:"Defined in",id:"defined-in-18",level:4},{value:"q?",id:"q",level:3},{value:"Defined in",id:"defined-in-19",level:4},{value:"remote?",id:"remote",level:3},{value:"Defined in",id:"defined-in-20",level:4},{value:"rm?",id:"rm",level:3},{value:"Defined in",id:"defined-in-21",level:4},{value:"shmsize?",id:"shmsize",level:3},{value:"Defined in",id:"defined-in-22",level:4},{value:"squash?",id:"squash",level:3},{value:"Defined in",id:"defined-in-23",level:4},{value:"tag?",id:"tag",level:3},{value:"Defined in",id:"defined-in-24",level:4},{value:"target?",id:"target",level:3},{value:"Defined in",id:"defined-in-25",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",p:"p",strong:"strong",...(0,d.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.header,{children:(0,s.jsx)(n.h1,{id:"interface-buildimageoptions",children:"Interface: BuildImageOptions"})}),"\n",(0,s.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,s.jsx)(n.h3,{id:"abortcontroller",children:"abortController?"}),"\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:"abortController"}),": ",(0,s.jsx)(n.code,{children:"AbortController"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The abort controller for running the build image operation"}),"\n",(0,s.jsx)(n.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/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:"buildargs",children:"buildargs?"}),"\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:"buildargs"}),": ",(0,s.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,s.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,s.jsx)(n.code,{children:"Dockerfile"})," RUN instruction, or for variable\nexpansion in other ",(0,s.jsx)(n.code,{children:"Dockerfilev"})," instructions. This is not meant for passing secret values.\nFor example, the build arg ",(0,s.jsx)(n.code,{children:"FOO=bar"})," would become ",(0,s.jsx)(n.code,{children:'{"FOO":"bar"}'})," in JSON. This would result in the query\nparameter ",(0,s.jsx)(n.code,{children:'buildargs={"FOO":"bar"}'}),". Note that ",(0,s.jsx)(n.code,{children:'{"FOO":"bar"}'})," should be URI component encoded."]}),"\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:"defined-in-1",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L3295",children:"packages/extension-api/src/extension-api.d.ts:3295"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"cachefrom",children:"cachefrom?"}),"\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:"cachefrom"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"JSON array of images used for build cache resolution."}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-2",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L3237",children:"packages/extension-api/src/extension-api.d.ts:3237"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"containerfile",children:"containerFile?"}),"\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:"containerFile"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Specifies a Containerfile which contains instructions for building the image"}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-3",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/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:"cpuperiod",children:"cpuperiod?"}),"\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:"cpuperiod"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The length of a CPU period in microseconds."}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-4",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L3281",children:"packages/extension-api/src/extension-api.d.ts:3281"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"cpuquota",children:"cpuquota?"}),"\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:"cpuquota"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Microseconds of CPU time that the container can get in a CPU period."}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-5",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L3286",children:"packages/extension-api/src/extension-api.d.ts:3286"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"cpusetcpus",children:"cpusetcpus?"}),"\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:"cpusetcpus"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"CPUs in which to allow execution (e.g., 0-3, 0,1)."}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-6",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L3276",children:"packages/extension-api/src/extension-api.d.ts:3276"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"cpushares",children:"cpushares?"}),"\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:"cpushares"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"CPU shares (relative weight)."}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-7",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L3271",children:"packages/extension-api/src/extension-api.d.ts:3271"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"extrahosts",children:"extrahosts?"}),"\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:"extrahosts"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Extra hosts to add to /etc/hosts"}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-8",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L3216",children:"packages/extension-api/src/extension-api.d.ts:3216"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"forcerm",children:"forcerm?"}),"\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:"forcerm"}),": ",(0,s.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Default: false"}),"\n",(0,s.jsx)(n.p,{children:"Always remove intermediate containers, even upon failure."}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-9",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L3256",children:"packages/extension-api/src/extension-api.d.ts:3256"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"labels",children:"labels?"}),"\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:"labels"}),": ",(0,s.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Arbitrary key/value labels to set on the image, as a JSON map of string pairs."}),"\n",(0,s.jsx)(n.h4,{id:"index-signature-1",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:"defined-in-10",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L3310",children:"packages/extension-api/src/extension-api.d.ts:3310"})}),"\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:"Set memory limit for build."}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-11",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L3261",children:"packages/extension-api/src/extension-api.d.ts:3261"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"memswap",children:"memswap?"}),"\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:"memswap"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Total memory (memory + swap). Set as -1 to disable swap."}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-12",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L3266",children:"packages/extension-api/src/extension-api.d.ts:3266"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"networkmode",children:"networkmode?"}),"\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:"networkmode"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:["Sets the networking mode for the run commands during build. Supported standard values are: ",(0,s.jsx)(n.code,{children:"bridge"}),",\n",(0,s.jsx)(n.code,{children:"host"}),", ",(0,s.jsx)(n.code,{children:"none"}),", and ",(0,s.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,s.jsx)(n.h4,{id:"defined-in-13",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L3317",children:"packages/extension-api/src/extension-api.d.ts:3317"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"nocache",children:"nocache?"}),"\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:"nocache"}),": ",(0,s.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Default: false"}),"\n",(0,s.jsx)(n.p,{children:"Do not use the cache when building the image."}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-14",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L3338",children:"packages/extension-api/src/extension-api.d.ts:3338"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"outputs",children:"outputs?"}),"\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:"outputs"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:'Default: ""'}),"\n",(0,s.jsx)(n.p,{children:"BuildKit output configuration"}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-15",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L3331",children:"packages/extension-api/src/extension-api.d.ts:3331"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"platform",children:"platform?"}),"\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:"platform"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.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,s.jsx)(n.h4,{id:"defined-in-16",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L3201",children:"packages/extension-api/src/extension-api.d.ts:3201"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"provider",children:"provider?"}),"\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:"provider"}),": ",(0,s.jsx)(n.a,{href:"/api/interfaces/ContainerProviderConnection",children:(0,s.jsx)(n.code,{children:"ContainerProviderConnection"})})]}),"\n"]}),"\n",(0,s.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,s.jsx)(n.h4,{id:"defined-in-17",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L3206",children:"packages/extension-api/src/extension-api.d.ts:3206"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"pull",children:"pull?"}),"\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:"pull"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Attempt to pull the image even if an older image exists locally."}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-18",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L3242",children:"packages/extension-api/src/extension-api.d.ts:3242"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"q",children:"q?"}),"\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:"q"}),": ",(0,s.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Default: false"}),"\n",(0,s.jsx)(n.p,{children:"Suppress verbose build output."}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-19",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L3232",children:"packages/extension-api/src/extension-api.d.ts:3232"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"remote",children:"remote?"}),"\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:"remote"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.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,s.jsx)(n.h4,{id:"defined-in-20",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L3225",children:"packages/extension-api/src/extension-api.d.ts:3225"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"rm",children:"rm?"}),"\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:"rm"}),": ",(0,s.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Default: true"}),"\n",(0,s.jsx)(n.p,{children:"Remove intermediate containers after a successful build."}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-21",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L3249",children:"packages/extension-api/src/extension-api.d.ts:3249"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"shmsize",children:"shmsize?"}),"\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:"shmsize"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:["Size of ",(0,s.jsx)(n.code,{children:"/dev/shm"})," in bytes. The size must be greater than 0. If omitted the system uses 64MB."]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-22",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L3300",children:"packages/extension-api/src/extension-api.d.ts:3300"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"squash",children:"squash?"}),"\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:"squash"}),": ",(0,s.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Squash the resulting images layers into a single layer."}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-23",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L3305",children:"packages/extension-api/src/extension-api.d.ts:3305"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"tag",children:"tag?"}),"\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:"tag"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Specifies the name which is assigned to the resulting image if the build process completes successfully"}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-24",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L3196",children:"packages/extension-api/src/extension-api.d.ts:3196"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"target",children:"target?"}),"\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:"target"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:'Default: ""'}),"\n",(0,s.jsx)(n.p,{children:"Target build stage"}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-25",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L3324",children:"packages/extension-api/src/extension-api.d.ts:3324"})})]})}function h(e={}){const{wrapper:n}={...(0,d.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},43023:(e,n,i)=>{i.d(n,{R:()=>t,x:()=>a});var s=i(63696);const d={},r=s.createContext(d);function t(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(d):e.components||d:t(e.components),s.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/604e05e4.a47dbf58.js b/assets/js/604e05e4.8b003852.js similarity index 87% rename from assets/js/604e05e4.a47dbf58.js rename to assets/js/604e05e4.8b003852.js index f54223dbbed..14a3942e55e 100644 --- a/assets/js/604e05e4.a47dbf58.js +++ b/assets/js/604e05e4.8b003852.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[90418],{16635:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>c,contentTitle:()=>r,default:()=>h,frontMatter:()=>a,metadata:()=>t,toc:()=>o});var s=i(62540),d=i(43023);const a={},r="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"}},c={},o=[{value:"Properties",id:"properties",level:2},{value:"Aliases?",id:"aliases",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"EndpointID",id:"endpointid",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"Gateway",id:"gateway",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"GlobalIPv6Address",id:"globalipv6address",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"GlobalIPv6PrefixLen",id:"globalipv6prefixlen",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"IPAMConfig?",id:"ipamconfig",level:3},{value:"Defined in",id:"defined-in-5",level:4},{value:"IPAddress",id:"ipaddress",level:3},{value:"Defined in",id:"defined-in-6",level:4},{value:"IPPrefixLen",id:"ipprefixlen",level:3},{value:"Defined in",id:"defined-in-7",level:4},{value:"IPv6Gateway",id:"ipv6gateway",level:3},{value:"Defined in",id:"defined-in-8",level:4},{value:"Links?",id:"links",level:3},{value:"Defined in",id:"defined-in-9",level:4},{value:"MacAddress",id:"macaddress",level:3},{value:"Defined in",id:"defined-in-10",level:4},{value:"NetworkID",id:"networkid",level:3},{value:"Defined in",id:"defined-in-11",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",p:"p",strong:"strong",...(0,d.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.header,{children:(0,s.jsx)(n.h1,{id:"interface-networkinfo",children:"Interface: NetworkInfo"})}),"\n",(0,s.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,s.jsx)(n.h3,{id:"aliases",children:"Aliases?"}),"\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:"Aliases"}),": ",(0,s.jsx)(n.code,{children:"unknown"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2327",children:"packages/extension-api/src/extension-api.d.ts:2327"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"endpointid",children:"EndpointID"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"EndpointID"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2329",children:"packages/extension-api/src/extension-api.d.ts:2329"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"gateway",children:"Gateway"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Gateway"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-2",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2330",children:"packages/extension-api/src/extension-api.d.ts:2330"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"globalipv6address",children:"GlobalIPv6Address"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"GlobalIPv6Address"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-3",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2334",children:"packages/extension-api/src/extension-api.d.ts:2334"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"globalipv6prefixlen",children:"GlobalIPv6PrefixLen"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"GlobalIPv6PrefixLen"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-4",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2335",children:"packages/extension-api/src/extension-api.d.ts:2335"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"ipamconfig",children:"IPAMConfig?"}),"\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:"IPAMConfig"}),": ",(0,s.jsx)(n.code,{children:"unknown"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-5",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2325",children:"packages/extension-api/src/extension-api.d.ts:2325"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"ipaddress",children:"IPAddress"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"IPAddress"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-6",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2331",children:"packages/extension-api/src/extension-api.d.ts:2331"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"ipprefixlen",children:"IPPrefixLen"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"IPPrefixLen"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-7",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2332",children:"packages/extension-api/src/extension-api.d.ts:2332"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"ipv6gateway",children:"IPv6Gateway"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"IPv6Gateway"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-8",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2333",children:"packages/extension-api/src/extension-api.d.ts:2333"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"links",children:"Links?"}),"\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:"Links"}),": ",(0,s.jsx)(n.code,{children:"unknown"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-9",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2326",children:"packages/extension-api/src/extension-api.d.ts:2326"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"macaddress",children:"MacAddress"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"MacAddress"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-10",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2336",children:"packages/extension-api/src/extension-api.d.ts:2336"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"networkid",children:"NetworkID"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"NetworkID"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-11",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2328",children:"packages/extension-api/src/extension-api.d.ts:2328"})})]})}function h(e={}){const{wrapper:n}={...(0,d.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},43023:(e,n,i)=>{i.d(n,{R:()=>r,x:()=>t});var s=i(63696);const d={},a=s.createContext(d);function r(e){const n=s.useContext(a);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(d):e.components||d:r(e.components),s.createElement(a.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[90418],{16635:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>c,contentTitle:()=>r,default:()=>h,frontMatter:()=>a,metadata:()=>t,toc:()=>o});var s=i(62540),d=i(43023);const a={},r="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"}},c={},o=[{value:"Properties",id:"properties",level:2},{value:"Aliases?",id:"aliases",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"EndpointID",id:"endpointid",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"Gateway",id:"gateway",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"GlobalIPv6Address",id:"globalipv6address",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"GlobalIPv6PrefixLen",id:"globalipv6prefixlen",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"IPAMConfig?",id:"ipamconfig",level:3},{value:"Defined in",id:"defined-in-5",level:4},{value:"IPAddress",id:"ipaddress",level:3},{value:"Defined in",id:"defined-in-6",level:4},{value:"IPPrefixLen",id:"ipprefixlen",level:3},{value:"Defined in",id:"defined-in-7",level:4},{value:"IPv6Gateway",id:"ipv6gateway",level:3},{value:"Defined in",id:"defined-in-8",level:4},{value:"Links?",id:"links",level:3},{value:"Defined in",id:"defined-in-9",level:4},{value:"MacAddress",id:"macaddress",level:3},{value:"Defined in",id:"defined-in-10",level:4},{value:"NetworkID",id:"networkid",level:3},{value:"Defined in",id:"defined-in-11",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",p:"p",strong:"strong",...(0,d.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.header,{children:(0,s.jsx)(n.h1,{id:"interface-networkinfo",children:"Interface: NetworkInfo"})}),"\n",(0,s.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,s.jsx)(n.h3,{id:"aliases",children:"Aliases?"}),"\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:"Aliases"}),": ",(0,s.jsx)(n.code,{children:"unknown"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2327",children:"packages/extension-api/src/extension-api.d.ts:2327"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"endpointid",children:"EndpointID"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"EndpointID"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2329",children:"packages/extension-api/src/extension-api.d.ts:2329"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"gateway",children:"Gateway"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Gateway"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-2",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2330",children:"packages/extension-api/src/extension-api.d.ts:2330"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"globalipv6address",children:"GlobalIPv6Address"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"GlobalIPv6Address"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-3",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2334",children:"packages/extension-api/src/extension-api.d.ts:2334"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"globalipv6prefixlen",children:"GlobalIPv6PrefixLen"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"GlobalIPv6PrefixLen"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-4",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2335",children:"packages/extension-api/src/extension-api.d.ts:2335"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"ipamconfig",children:"IPAMConfig?"}),"\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:"IPAMConfig"}),": ",(0,s.jsx)(n.code,{children:"unknown"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-5",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2325",children:"packages/extension-api/src/extension-api.d.ts:2325"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"ipaddress",children:"IPAddress"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"IPAddress"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-6",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2331",children:"packages/extension-api/src/extension-api.d.ts:2331"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"ipprefixlen",children:"IPPrefixLen"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"IPPrefixLen"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-7",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2332",children:"packages/extension-api/src/extension-api.d.ts:2332"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"ipv6gateway",children:"IPv6Gateway"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"IPv6Gateway"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-8",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2333",children:"packages/extension-api/src/extension-api.d.ts:2333"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"links",children:"Links?"}),"\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:"Links"}),": ",(0,s.jsx)(n.code,{children:"unknown"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-9",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2326",children:"packages/extension-api/src/extension-api.d.ts:2326"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"macaddress",children:"MacAddress"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"MacAddress"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-10",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2336",children:"packages/extension-api/src/extension-api.d.ts:2336"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"networkid",children:"NetworkID"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"NetworkID"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-11",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2328",children:"packages/extension-api/src/extension-api.d.ts:2328"})})]})}function h(e={}){const{wrapper:n}={...(0,d.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},43023:(e,n,i)=>{i.d(n,{R:()=>r,x:()=>t});var s=i(63696);const d={},a=s.createContext(d);function r(e){const n=s.useContext(a);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(d):e.components||d:r(e.components),s.createElement(a.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/60c82955.8e488dc8.js b/assets/js/60c82955.79d076a7.js similarity index 92% rename from assets/js/60c82955.8e488dc8.js rename to assets/js/60c82955.79d076a7.js index 13591073450..74c0286e332 100644 --- a/assets/js/60c82955.8e488dc8.js +++ b/assets/js/60c82955.79d076a7.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[28341],{32997:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>a,contentTitle:()=>l,default:()=>h,frontMatter:()=>r,metadata:()=>o,toc:()=>c});var s=i(62540),d=i(43023);const r={},l="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:"CliToolInfo",permalink:"/api/interfaces/CliToolInfo"}},a={},c=[{value:"Extends",id:"extends",level:2},{value:"Properties",id:"properties",level:2},{value:"displayName",id:"displayname",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"extensionInfo",id:"extensioninfo",level:3},{value:"id",id:"id",level:4},{value:"label",id:"label",level:4},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"id",id:"id-1",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"images",id:"images",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"markdownDescription",id:"markdowndescription",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"name",id:"name",level:3},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"onDidUninstall",id:"ondiduninstall",level:3},{value:"Defined in",id:"defined-in-6",level:4},{value:"onDidUpdateVersion",id:"ondidupdateversion",level:3},{value:"Defined in",id:"defined-in-7",level:4},{value:"state",id:"state",level:3},{value:"Defined in",id:"defined-in-8",level:4},{value:"version?",id:"version",level:3},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-9",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-7",level:4},{value:"Defined in",id:"defined-in-10",level:4},{value:"registerInstaller()",id:"registerinstaller",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Defined in",id:"defined-in-11",level:4},{value:"registerUpdate()",id:"registerupdate",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-2",level:4},{value:"Defined in",id:"defined-in-12",level:4},{value:"updateVersion()",id:"updateversion",level:3},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-3",level:4},{value:"Defined in",id:"defined-in-13",level:4}];function t(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",li:"li",p:"p",strong:"strong",ul:"ul",...(0,d.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.header,{children:(0,s.jsx)(n.h1,{id:"interface-clitool",children:"Interface: CliTool"})}),"\n",(0,s.jsx)(n.h2,{id:"extends",children:"Extends"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.a,{href:"/api/interfaces/CliToolInfo",children:(0,s.jsx)(n.code,{children:"CliToolInfo"})}),".",(0,s.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,s.jsx)(n.code,{children:"Disposable"})})]}),"\n"]}),"\n",(0,s.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,s.jsx)(n.h3,{id:"displayname",children:"displayName"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"displayName"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"inherited-from",children:"Inherited from"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.a,{href:"/api/interfaces/CliToolInfo",children:(0,s.jsx)(n.code,{children:"CliToolInfo"})}),".",(0,s.jsx)(n.a,{href:"/api/interfaces/CliToolInfo#displayname",children:(0,s.jsx)(n.code,{children:"displayName"})})]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L4381",children:"packages/extension-api/src/extension-api.d.ts:4381"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"extensioninfo",children:"extensionInfo"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"extensionInfo"}),": ",(0,s.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{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:"label",children:"label"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"label"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"inherited-from-1",children:"Inherited from"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.a,{href:"/api/interfaces/CliToolInfo",children:(0,s.jsx)(n.code,{children:"CliToolInfo"})}),".",(0,s.jsx)(n.a,{href:"/api/interfaces/CliToolInfo#extensioninfo",children:(0,s.jsx)(n.code,{children:"extensionInfo"})})]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L4385",children:"packages/extension-api/src/extension-api.d.ts:4385"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"id-1",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:"inherited-from-2",children:"Inherited from"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.a,{href:"/api/interfaces/CliToolInfo",children:(0,s.jsx)(n.code,{children:"CliToolInfo"})}),".",(0,s.jsx)(n.a,{href:"/api/interfaces/CliToolInfo#id-1",children:(0,s.jsx)(n.code,{children:"id"})})]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-2",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L4379",children:"packages/extension-api/src/extension-api.d.ts:4379"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"images",children:"images"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"images"}),": ",(0,s.jsx)(n.a,{href:"/api/interfaces/ProviderImages",children:(0,s.jsx)(n.code,{children:"ProviderImages"})})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"inherited-from-3",children:"Inherited from"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.a,{href:"/api/interfaces/CliToolInfo",children:(0,s.jsx)(n.code,{children:"CliToolInfo"})}),".",(0,s.jsx)(n.a,{href:"/api/interfaces/CliToolInfo#images",children:(0,s.jsx)(n.code,{children:"images"})})]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-3",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L4383",children:"packages/extension-api/src/extension-api.d.ts:4383"})}),"\n",(0,s.jsx)(n.hr,{}),"\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.strong,{children:"markdownDescription"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"inherited-from-4",children:"Inherited from"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.a,{href:"/api/interfaces/CliToolInfo",children:(0,s.jsx)(n.code,{children:"CliToolInfo"})}),".",(0,s.jsx)(n.a,{href:"/api/interfaces/CliToolInfo#markdowndescription",children:(0,s.jsx)(n.code,{children:"markdownDescription"})})]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-4",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L4382",children:"packages/extension-api/src/extension-api.d.ts:4382"})}),"\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:"inherited-from-5",children:"Inherited from"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.a,{href:"/api/interfaces/CliToolInfo",children:(0,s.jsx)(n.code,{children:"CliToolInfo"})}),".",(0,s.jsx)(n.a,{href:"/api/interfaces/CliToolInfo#name",children:(0,s.jsx)(n.code,{children:"name"})})]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-5",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L4380",children:"packages/extension-api/src/extension-api.d.ts:4380"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"ondiduninstall",children:"onDidUninstall"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"onDidUninstall"}),": ",(0,s.jsx)(n.a,{href:"/api/interfaces/Event",children:(0,s.jsx)(n.code,{children:"Event"})}),"<",(0,s.jsx)(n.code,{children:"void"}),">"]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-6",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L4369",children:"packages/extension-api/src/extension-api.d.ts:4369"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"ondidupdateversion",children:"onDidUpdateVersion"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"onDidUpdateVersion"}),": ",(0,s.jsx)(n.a,{href:"/api/interfaces/Event",children:(0,s.jsx)(n.code,{children:"Event"})}),"<",(0,s.jsx)(n.code,{children:"string"}),">"]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-7",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L4367",children:"packages/extension-api/src/extension-api.d.ts:4367"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"state",children:"state"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"state"}),": ",(0,s.jsx)(n.code,{children:'"registered"'})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-8",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L4365",children:"packages/extension-api/src/extension-api.d.ts:4365"})}),"\n",(0,s.jsx)(n.hr,{}),"\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.code,{children:"optional"})," ",(0,s.jsx)(n.strong,{children:"version"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"inherited-from-6",children:"Inherited from"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.a,{href:"/api/interfaces/CliToolInfo",children:(0,s.jsx)(n.code,{children:"CliToolInfo"})}),".",(0,s.jsx)(n.a,{href:"/api/interfaces/CliToolInfo#version",children:(0,s.jsx)(n.code,{children:"version"})})]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-9",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L4384",children:"packages/extension-api/src/extension-api.d.ts:4384"})}),"\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."}),"\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:"inherited-from-7",children:"Inherited from"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,s.jsx)(n.code,{children:"Disposable"})}),".",(0,s.jsx)(n.a,{href:"/api/classes/Disposable#dispose",children:(0,s.jsx)(n.code,{children:"dispose"})})]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-10",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L97",children:"packages/extension-api/src/extension-api.d.ts:97"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"registerinstaller",children:"registerInstaller()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"registerInstaller"}),"(",(0,s.jsx)(n.code,{children:"installer"}),"): ",(0,s.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,s.jsx)(n.code,{children:"Disposable"})})]}),"\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:"installer"}),": ",(0,s.jsx)(n.a,{href:"/api/interfaces/CliToolInstaller",children:(0,s.jsx)(n.code,{children:"CliToolInstaller"})})]}),"\n",(0,s.jsx)(n.h4,{id:"returns-1",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.h4,{id:"defined-in-11",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L4375",children:"packages/extension-api/src/extension-api.d.ts:4375"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"registerupdate",children:"registerUpdate()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"registerUpdate"}),"(",(0,s.jsx)(n.code,{children:"update"}),"): ",(0,s.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,s.jsx)(n.code,{children:"Disposable"})})]}),"\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:"update"}),": ",(0,s.jsx)(n.a,{href:"/api/interfaces/CliToolUpdate",children:(0,s.jsx)(n.code,{children:"CliToolUpdate"})})," | ",(0,s.jsx)(n.a,{href:"/api/interfaces/CliToolSelectUpdate",children:(0,s.jsx)(n.code,{children:"CliToolSelectUpdate"})})]}),"\n",(0,s.jsx)(n.h4,{id:"returns-2",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.h4,{id:"defined-in-12",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L4372",children:"packages/extension-api/src/extension-api.d.ts:4372"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"updateversion",children:"updateVersion()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"updateVersion"}),"(",(0,s.jsx)(n.code,{children:"version"}),"): ",(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:"version"}),": ",(0,s.jsx)(n.a,{href:"/api/interfaces/CliToolUpdateOptions",children:(0,s.jsx)(n.code,{children:"CliToolUpdateOptions"})})]}),"\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:"defined-in-13",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L4366",children:"packages/extension-api/src/extension-api.d.ts:4366"})})]})}function h(e={}){const{wrapper:n}={...(0,d.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(t,{...e})}):t(e)}},43023:(e,n,i)=>{i.d(n,{R:()=>l,x:()=>o});var s=i(63696);const d={},r=s.createContext(d);function l(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(d):e.components||d:l(e.components),s.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[28341],{32997:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>a,contentTitle:()=>l,default:()=>h,frontMatter:()=>r,metadata:()=>o,toc:()=>c});var s=i(62540),d=i(43023);const r={},l="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:"CliToolInfo",permalink:"/api/interfaces/CliToolInfo"}},a={},c=[{value:"Extends",id:"extends",level:2},{value:"Properties",id:"properties",level:2},{value:"displayName",id:"displayname",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"extensionInfo",id:"extensioninfo",level:3},{value:"id",id:"id",level:4},{value:"label",id:"label",level:4},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"id",id:"id-1",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"images",id:"images",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"markdownDescription",id:"markdowndescription",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"name",id:"name",level:3},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"onDidUninstall",id:"ondiduninstall",level:3},{value:"Defined in",id:"defined-in-6",level:4},{value:"onDidUpdateVersion",id:"ondidupdateversion",level:3},{value:"Defined in",id:"defined-in-7",level:4},{value:"state",id:"state",level:3},{value:"Defined in",id:"defined-in-8",level:4},{value:"version?",id:"version",level:3},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-9",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-7",level:4},{value:"Defined in",id:"defined-in-10",level:4},{value:"registerInstaller()",id:"registerinstaller",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Defined in",id:"defined-in-11",level:4},{value:"registerUpdate()",id:"registerupdate",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-2",level:4},{value:"Defined in",id:"defined-in-12",level:4},{value:"updateVersion()",id:"updateversion",level:3},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-3",level:4},{value:"Defined in",id:"defined-in-13",level:4}];function t(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",li:"li",p:"p",strong:"strong",ul:"ul",...(0,d.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.header,{children:(0,s.jsx)(n.h1,{id:"interface-clitool",children:"Interface: CliTool"})}),"\n",(0,s.jsx)(n.h2,{id:"extends",children:"Extends"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.a,{href:"/api/interfaces/CliToolInfo",children:(0,s.jsx)(n.code,{children:"CliToolInfo"})}),".",(0,s.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,s.jsx)(n.code,{children:"Disposable"})})]}),"\n"]}),"\n",(0,s.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,s.jsx)(n.h3,{id:"displayname",children:"displayName"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"displayName"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"inherited-from",children:"Inherited from"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.a,{href:"/api/interfaces/CliToolInfo",children:(0,s.jsx)(n.code,{children:"CliToolInfo"})}),".",(0,s.jsx)(n.a,{href:"/api/interfaces/CliToolInfo#displayname",children:(0,s.jsx)(n.code,{children:"displayName"})})]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L4381",children:"packages/extension-api/src/extension-api.d.ts:4381"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"extensioninfo",children:"extensionInfo"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"extensionInfo"}),": ",(0,s.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{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:"label",children:"label"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"label"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"inherited-from-1",children:"Inherited from"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.a,{href:"/api/interfaces/CliToolInfo",children:(0,s.jsx)(n.code,{children:"CliToolInfo"})}),".",(0,s.jsx)(n.a,{href:"/api/interfaces/CliToolInfo#extensioninfo",children:(0,s.jsx)(n.code,{children:"extensionInfo"})})]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L4385",children:"packages/extension-api/src/extension-api.d.ts:4385"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"id-1",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:"inherited-from-2",children:"Inherited from"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.a,{href:"/api/interfaces/CliToolInfo",children:(0,s.jsx)(n.code,{children:"CliToolInfo"})}),".",(0,s.jsx)(n.a,{href:"/api/interfaces/CliToolInfo#id-1",children:(0,s.jsx)(n.code,{children:"id"})})]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-2",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L4379",children:"packages/extension-api/src/extension-api.d.ts:4379"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"images",children:"images"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"images"}),": ",(0,s.jsx)(n.a,{href:"/api/interfaces/ProviderImages",children:(0,s.jsx)(n.code,{children:"ProviderImages"})})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"inherited-from-3",children:"Inherited from"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.a,{href:"/api/interfaces/CliToolInfo",children:(0,s.jsx)(n.code,{children:"CliToolInfo"})}),".",(0,s.jsx)(n.a,{href:"/api/interfaces/CliToolInfo#images",children:(0,s.jsx)(n.code,{children:"images"})})]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-3",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L4383",children:"packages/extension-api/src/extension-api.d.ts:4383"})}),"\n",(0,s.jsx)(n.hr,{}),"\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.strong,{children:"markdownDescription"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"inherited-from-4",children:"Inherited from"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.a,{href:"/api/interfaces/CliToolInfo",children:(0,s.jsx)(n.code,{children:"CliToolInfo"})}),".",(0,s.jsx)(n.a,{href:"/api/interfaces/CliToolInfo#markdowndescription",children:(0,s.jsx)(n.code,{children:"markdownDescription"})})]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-4",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L4382",children:"packages/extension-api/src/extension-api.d.ts:4382"})}),"\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:"inherited-from-5",children:"Inherited from"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.a,{href:"/api/interfaces/CliToolInfo",children:(0,s.jsx)(n.code,{children:"CliToolInfo"})}),".",(0,s.jsx)(n.a,{href:"/api/interfaces/CliToolInfo#name",children:(0,s.jsx)(n.code,{children:"name"})})]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-5",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L4380",children:"packages/extension-api/src/extension-api.d.ts:4380"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"ondiduninstall",children:"onDidUninstall"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"onDidUninstall"}),": ",(0,s.jsx)(n.a,{href:"/api/interfaces/Event",children:(0,s.jsx)(n.code,{children:"Event"})}),"<",(0,s.jsx)(n.code,{children:"void"}),">"]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-6",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L4369",children:"packages/extension-api/src/extension-api.d.ts:4369"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"ondidupdateversion",children:"onDidUpdateVersion"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"onDidUpdateVersion"}),": ",(0,s.jsx)(n.a,{href:"/api/interfaces/Event",children:(0,s.jsx)(n.code,{children:"Event"})}),"<",(0,s.jsx)(n.code,{children:"string"}),">"]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-7",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L4367",children:"packages/extension-api/src/extension-api.d.ts:4367"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"state",children:"state"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"state"}),": ",(0,s.jsx)(n.code,{children:'"registered"'})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-8",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L4365",children:"packages/extension-api/src/extension-api.d.ts:4365"})}),"\n",(0,s.jsx)(n.hr,{}),"\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.code,{children:"optional"})," ",(0,s.jsx)(n.strong,{children:"version"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"inherited-from-6",children:"Inherited from"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.a,{href:"/api/interfaces/CliToolInfo",children:(0,s.jsx)(n.code,{children:"CliToolInfo"})}),".",(0,s.jsx)(n.a,{href:"/api/interfaces/CliToolInfo#version",children:(0,s.jsx)(n.code,{children:"version"})})]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-9",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L4384",children:"packages/extension-api/src/extension-api.d.ts:4384"})}),"\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."}),"\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:"inherited-from-7",children:"Inherited from"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,s.jsx)(n.code,{children:"Disposable"})}),".",(0,s.jsx)(n.a,{href:"/api/classes/Disposable#dispose",children:(0,s.jsx)(n.code,{children:"dispose"})})]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-10",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L97",children:"packages/extension-api/src/extension-api.d.ts:97"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"registerinstaller",children:"registerInstaller()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"registerInstaller"}),"(",(0,s.jsx)(n.code,{children:"installer"}),"): ",(0,s.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,s.jsx)(n.code,{children:"Disposable"})})]}),"\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:"installer"}),": ",(0,s.jsx)(n.a,{href:"/api/interfaces/CliToolInstaller",children:(0,s.jsx)(n.code,{children:"CliToolInstaller"})})]}),"\n",(0,s.jsx)(n.h4,{id:"returns-1",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.h4,{id:"defined-in-11",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L4375",children:"packages/extension-api/src/extension-api.d.ts:4375"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"registerupdate",children:"registerUpdate()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"registerUpdate"}),"(",(0,s.jsx)(n.code,{children:"update"}),"): ",(0,s.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,s.jsx)(n.code,{children:"Disposable"})})]}),"\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:"update"}),": ",(0,s.jsx)(n.a,{href:"/api/interfaces/CliToolUpdate",children:(0,s.jsx)(n.code,{children:"CliToolUpdate"})})," | ",(0,s.jsx)(n.a,{href:"/api/interfaces/CliToolSelectUpdate",children:(0,s.jsx)(n.code,{children:"CliToolSelectUpdate"})})]}),"\n",(0,s.jsx)(n.h4,{id:"returns-2",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.h4,{id:"defined-in-12",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L4372",children:"packages/extension-api/src/extension-api.d.ts:4372"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"updateversion",children:"updateVersion()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"updateVersion"}),"(",(0,s.jsx)(n.code,{children:"version"}),"): ",(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:"version"}),": ",(0,s.jsx)(n.a,{href:"/api/interfaces/CliToolUpdateOptions",children:(0,s.jsx)(n.code,{children:"CliToolUpdateOptions"})})]}),"\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:"defined-in-13",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L4366",children:"packages/extension-api/src/extension-api.d.ts:4366"})})]})}function h(e={}){const{wrapper:n}={...(0,d.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(t,{...e})}):t(e)}},43023:(e,n,i)=>{i.d(n,{R:()=>l,x:()=>o});var s=i(63696);const d={},r=s.createContext(d);function l(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(d):e.components||d:l(e.components),s.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/610f2c47.a88297e7.js b/assets/js/610f2c47.2b0d1574.js similarity index 98% rename from assets/js/610f2c47.a88297e7.js rename to assets/js/610f2c47.2b0d1574.js index d1ddad802c6..b839fb590d6 100644 --- a/assets/js/610f2c47.a88297e7.js +++ b/assets/js/610f2c47.2b0d1574.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[16344],{15206:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>d,contentTitle:()=>r,default:()=>p,frontMatter:()=>o,metadata:()=>c,toc:()=>a});var t=s(62540),i=s(43023);const o={},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:"Defined in",id:"defined-in",level:2}];function h(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",strong:"strong",...(0,i.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.header,{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:"defined-in",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2005",children:"packages/extension-api/src/extension-api.d.ts:2005"})})]})}function p(e={}){const{wrapper:n}={...(0,i.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(h,{...e})}):h(e)}},43023:(e,n,s)=>{s.d(n,{R:()=>r,x:()=>c});var t=s(63696);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([[16344],{15206:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>d,contentTitle:()=>r,default:()=>p,frontMatter:()=>o,metadata:()=>c,toc:()=>a});var t=s(62540),i=s(43023);const o={},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:"Defined in",id:"defined-in",level:2}];function h(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",strong:"strong",...(0,i.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.header,{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:"defined-in",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2005",children:"packages/extension-api/src/extension-api.d.ts:2005"})})]})}function p(e={}){const{wrapper:n}={...(0,i.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(h,{...e})}):h(e)}},43023:(e,n,s)=>{s.d(n,{R:()=>r,x:()=>c});var t=s(63696);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/612345e6.1ee3f276.js b/assets/js/612345e6.91f73475.js similarity index 95% rename from assets/js/612345e6.1ee3f276.js rename to assets/js/612345e6.91f73475.js index ec9bf1559e0..9761a045f9f 100644 --- a/assets/js/612345e6.1ee3f276.js +++ b/assets/js/612345e6.91f73475.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[83405],{7132:(n,e,t)=>{t.r(e),t.d(e,{assets:()=>c,contentTitle:()=>s,default:()=>l,frontMatter:()=>a,metadata:()=>r,toc:()=>d});var i=t(62540),o=t(43023);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:"Defined in",id:"defined-in",level:2}];function u(n){const e={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",strong:"strong",...(0,o.R)(),...n.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(e.header,{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:"defined-in",children:"Defined in"}),"\n",(0,i.jsx)(e.p,{children:(0,i.jsx)(e.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L4524",children:"packages/extension-api/src/extension-api.d.ts:4524"})})]})}function l(n={}){const{wrapper:e}={...(0,o.R)(),...n.components};return e?(0,i.jsx)(e,{...n,children:(0,i.jsx)(u,{...n})}):u(n)}},43023:(n,e,t)=>{t.d(e,{R:()=>s,x:()=>r});var i=t(63696);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([[83405],{7132:(n,e,t)=>{t.r(e),t.d(e,{assets:()=>c,contentTitle:()=>s,default:()=>l,frontMatter:()=>a,metadata:()=>r,toc:()=>d});var i=t(62540),o=t(43023);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:"Defined in",id:"defined-in",level:2}];function u(n){const e={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",strong:"strong",...(0,o.R)(),...n.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(e.header,{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:"defined-in",children:"Defined in"}),"\n",(0,i.jsx)(e.p,{children:(0,i.jsx)(e.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L4524",children:"packages/extension-api/src/extension-api.d.ts:4524"})})]})}function l(n={}){const{wrapper:e}={...(0,o.R)(),...n.components};return e?(0,i.jsx)(e,{...n,children:(0,i.jsx)(u,{...n})}):u(n)}},43023:(n,e,t)=>{t.d(e,{R:()=>s,x:()=>r});var i=t(63696);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.2950f7b3.js b/assets/js/62e21724.2c863a20.js similarity index 96% rename from assets/js/62e21724.2950f7b3.js rename to assets/js/62e21724.2c863a20.js index cb2619c20e2..b8d6b880136 100644 --- a/assets/js/62e21724.2950f7b3.js +++ b/assets/js/62e21724.2c863a20.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[17796],{6812:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>r,default:()=>p,frontMatter:()=>c,metadata:()=>s,toc:()=>d});var i=t(62540),o=t(43023);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={},d=[{value:"Properties",id:"properties",level:2},{value:"iconPath",id:"iconpath",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"tooltip?",id:"tooltip",level:3},{value:"Defined in",id:"defined-in-1",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",p:"p",strong:"strong",...(0,o.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.header,{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:"defined-in",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L1228",children:"packages/extension-api/src/extension-api.d.ts:1228"})}),"\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:"readonly"})," ",(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:"An optional tooltip."}),"\n",(0,i.jsx)(n.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L1233",children:"packages/extension-api/src/extension-api.d.ts:1233"})})]})}function p(e={}){const{wrapper:n}={...(0,o.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},43023:(e,n,t)=>{t.d(n,{R:()=>r,x:()=>s});var i=t(63696);const o={},c=i.createContext(o);function r(e){const n=i.useContext(c);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function s(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:r(e.components),i.createElement(c.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[17796],{6812:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>r,default:()=>p,frontMatter:()=>c,metadata:()=>s,toc:()=>d});var i=t(62540),o=t(43023);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={},d=[{value:"Properties",id:"properties",level:2},{value:"iconPath",id:"iconpath",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"tooltip?",id:"tooltip",level:3},{value:"Defined in",id:"defined-in-1",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",p:"p",strong:"strong",...(0,o.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.header,{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:"defined-in",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L1228",children:"packages/extension-api/src/extension-api.d.ts:1228"})}),"\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:"readonly"})," ",(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:"An optional tooltip."}),"\n",(0,i.jsx)(n.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L1233",children:"packages/extension-api/src/extension-api.d.ts:1233"})})]})}function p(e={}){const{wrapper:n}={...(0,o.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},43023:(e,n,t)=>{t.d(n,{R:()=>r,x:()=>s});var i=t(63696);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.d947ca26.js b/assets/js/640277b9.1b32454b.js similarity index 78% rename from assets/js/640277b9.d947ca26.js rename to assets/js/640277b9.1b32454b.js index d2c57aa4ada..c6fe710abf2 100644 --- a/assets/js/640277b9.d947ca26.js +++ b/assets/js/640277b9.1b32454b.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[8826],{8782:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>a,contentTitle:()=>r,default:()=>u,frontMatter:()=>o,metadata:()=>c,toc:()=>d});var i=s(62540),t=s(43023);const o={},r="Function: listWebviews()",c={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:"Defined in",id:"defined-in",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",strong:"strong",...(0,t.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.header,{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:"defined-in",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2098",children:"packages/extension-api/src/extension-api.d.ts:2098"})})]})}function u(e={}){const{wrapper:n}={...(0,t.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},43023:(e,n,s)=>{s.d(n,{R:()=>r,x:()=>c});var i=s(63696);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([[8826],{8782:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>a,contentTitle:()=>c,default:()=>u,frontMatter:()=>o,metadata:()=>r,toc:()=>d});var i=s(62540),t=s(43023);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:"Defined in",id:"defined-in",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",strong:"strong",...(0,t.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.header,{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:"defined-in",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2098",children:"packages/extension-api/src/extension-api.d.ts:2098"})})]})}function u(e={}){const{wrapper:n}={...(0,t.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},43023:(e,n,s)=>{s.d(n,{R:()=>c,x:()=>r});var i=s(63696);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.190148e6.js b/assets/js/64134c03.67794c44.js similarity index 78% rename from assets/js/64134c03.190148e6.js rename to assets/js/64134c03.67794c44.js index e91b597a221..ab2b4bc35e6 100644 --- a/assets/js/64134c03.190148e6.js +++ b/assets/js/64134c03.67794c44.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[41789],{75657:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>c,contentTitle:()=>a,default:()=>p,frontMatter:()=>o,metadata:()=>r,toc:()=>d});var s=t(62540),i=t(43023);const o={},a="Function: isEnabled()",r={id:"namespaces/proxy/functions/isEnabled",title:"Function: isEnabled()",description:"isEnabled(): boolean",source:"@site/api/namespaces/proxy/functions/isEnabled.md",sourceDirName:"namespaces/proxy/functions",slug:"/namespaces/proxy/functions/isEnabled",permalink:"/api/namespaces/proxy/functions/isEnabled",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"getProxySettings",permalink:"/api/namespaces/proxy/functions/getProxySettings"},next:{title:"onDidStateChange",permalink:"/api/namespaces/proxy/functions/onDidStateChange"}},c={},d=[{value:"Returns",id:"returns",level:2},{value:"Defined in",id:"defined-in",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",strong:"strong",...(0,i.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.header,{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:"defined-in",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L880",children:"packages/extension-api/src/extension-api.d.ts:880"})})]})}function p(e={}){const{wrapper:n}={...(0,i.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},43023:(e,n,t)=>{t.d(n,{R:()=>a,x:()=>r});var s=t(63696);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([[41789],{75657:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>r,contentTitle:()=>a,default:()=>p,frontMatter:()=>o,metadata:()=>c,toc:()=>d});var s=t(62540),i=t(43023);const o={},a="Function: isEnabled()",c={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:"Defined in",id:"defined-in",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",strong:"strong",...(0,i.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.header,{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:"defined-in",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L880",children:"packages/extension-api/src/extension-api.d.ts:880"})})]})}function p(e={}){const{wrapper:n}={...(0,i.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},43023:(e,n,t)=>{t.d(n,{R:()=>a,x:()=>c});var s=t(63696);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 c(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/6477cdc2.e9b7f0a4.js b/assets/js/6477cdc2.7ffaa466.js similarity index 98% rename from assets/js/6477cdc2.e9b7f0a4.js rename to assets/js/6477cdc2.7ffaa466.js index e67045e4a9e..73c7cdb2084 100644 --- a/assets/js/6477cdc2.e9b7f0a4.js +++ b/assets/js/6477cdc2.7ffaa466.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[37561],{16612:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>a,contentTitle:()=>o,default:()=>p,frontMatter:()=>i,metadata:()=>c,toc:()=>l});var t=r(62540),s=r(43023);const i={},o="Function: createTelemetryLogger()",c={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:"Defined in",id:"defined-in",level:2}];function d(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",strong:"strong",...(0,s.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.header,{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:"defined-in",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L4021",children:"packages/extension-api/src/extension-api.d.ts:4021"})})]})}function p(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(d,{...e})}):d(e)}},43023:(e,n,r)=>{r.d(n,{R:()=>o,x:()=>c});var t=r(63696);const s={},i=t.createContext(s);function o(e){const n=t.useContext(i);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:o(e.components),t.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[37561],{16612:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>a,contentTitle:()=>o,default:()=>p,frontMatter:()=>i,metadata:()=>c,toc:()=>l});var t=r(62540),s=r(43023);const i={},o="Function: createTelemetryLogger()",c={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:"Defined in",id:"defined-in",level:2}];function d(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",strong:"strong",...(0,s.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.header,{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:"defined-in",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L4021",children:"packages/extension-api/src/extension-api.d.ts:4021"})})]})}function p(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(d,{...e})}):d(e)}},43023:(e,n,r)=>{r.d(n,{R:()=>o,x:()=>c});var t=r(63696);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/6494b798.934c1752.js b/assets/js/6494b798.d69822eb.js similarity index 94% rename from assets/js/6494b798.934c1752.js rename to assets/js/6494b798.d69822eb.js index 67b673c0c0f..b7019c275dd 100644 --- a/assets/js/6494b798.934c1752.js +++ b/assets/js/6494b798.d69822eb.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[20228],{18606:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>c,contentTitle:()=>r,default:()=>p,frontMatter:()=>a,metadata:()=>o,toc:()=>d});var i=s(62540),t=s(43023);const a={},r="Variable: isWindows",o={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:"Defined in",id:"defined-in",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",strong:"strong",...(0,t.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.header,{children:(0,i.jsx)(n.h1,{id:"variable-iswindows",children:"Variable: isWindows"})}),"\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:"isWindows"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Flag indicating whether we are running on the Windows operating system."}),"\n",(0,i.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,i.jsx)(n.h2,{id:"defined-in",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L3984",children:"packages/extension-api/src/extension-api.d.ts:3984"})})]})}function p(e={}){const{wrapper:n}={...(0,t.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},43023:(e,n,s)=>{s.d(n,{R:()=>r,x:()=>o});var i=s(63696);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 +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[20228],{18606:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>c,contentTitle:()=>r,default:()=>p,frontMatter:()=>a,metadata:()=>o,toc:()=>d});var i=s(62540),t=s(43023);const a={},r="Variable: isWindows",o={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:"Defined in",id:"defined-in",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",strong:"strong",...(0,t.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.header,{children:(0,i.jsx)(n.h1,{id:"variable-iswindows",children:"Variable: isWindows"})}),"\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:"isWindows"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Flag indicating whether we are running on the Windows operating system."}),"\n",(0,i.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,i.jsx)(n.h2,{id:"defined-in",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L3984",children:"packages/extension-api/src/extension-api.d.ts:3984"})})]})}function p(e={}){const{wrapper:n}={...(0,t.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},43023:(e,n,s)=>{s.d(n,{R:()=>r,x:()=>o});var i=s(63696);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/64bd32f2.4098990e.js b/assets/js/64bd32f2.c6c97e18.js similarity index 96% rename from assets/js/64bd32f2.4098990e.js rename to assets/js/64bd32f2.c6c97e18.js index 3120652ba15..2005457255b 100644 --- a/assets/js/64bd32f2.4098990e.js +++ b/assets/js/64bd32f2.c6c97e18.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[35644],{89048:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>o,contentTitle:()=>r,default:()=>l,frontMatter:()=>c,metadata:()=>a,toc:()=>d});var s=i(62540),t=i(43023);const c={},r="Function: inspectManifest()",a={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"}},o={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Defined in",id:"defined-in",level:2}];function p(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",strong:"strong",...(0,t.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.header,{children:(0,s.jsx)(n.h1,{id:"function-inspectmanifest",children:"Function: inspectManifest()"})}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"inspectManifest"}),"(",(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/ManifestInspectInfo",children:(0,s.jsx)(n.code,{children:"ManifestInspectInfo"})}),">"]}),"\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:"id"}),": ",(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.a,{href:"/api/interfaces/ManifestInspectInfo",children:(0,s.jsx)(n.code,{children:"ManifestInspectInfo"})}),">"]}),"\n",(0,s.jsx)(n.h2,{id:"defined-in",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L3693",children:"packages/extension-api/src/extension-api.d.ts:3693"})})]})}function l(e={}){const{wrapper:n}={...(0,t.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(p,{...e})}):p(e)}},43023:(e,n,i)=>{i.d(n,{R:()=>r,x:()=>a});var s=i(63696);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 a(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 +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[35644],{89048:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>o,contentTitle:()=>r,default:()=>l,frontMatter:()=>c,metadata:()=>a,toc:()=>d});var s=i(62540),t=i(43023);const c={},r="Function: inspectManifest()",a={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"}},o={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Defined in",id:"defined-in",level:2}];function p(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",strong:"strong",...(0,t.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.header,{children:(0,s.jsx)(n.h1,{id:"function-inspectmanifest",children:"Function: inspectManifest()"})}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"inspectManifest"}),"(",(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/ManifestInspectInfo",children:(0,s.jsx)(n.code,{children:"ManifestInspectInfo"})}),">"]}),"\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:"id"}),": ",(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.a,{href:"/api/interfaces/ManifestInspectInfo",children:(0,s.jsx)(n.code,{children:"ManifestInspectInfo"})}),">"]}),"\n",(0,s.jsx)(n.h2,{id:"defined-in",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L3693",children:"packages/extension-api/src/extension-api.d.ts:3693"})})]})}function l(e={}){const{wrapper:n}={...(0,t.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(p,{...e})}):p(e)}},43023:(e,n,i)=>{i.d(n,{R:()=>r,x:()=>a});var s=i(63696);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 a(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/67386898.0446f9f3.js b/assets/js/67386898.12c542c6.js similarity index 92% rename from assets/js/67386898.0446f9f3.js rename to assets/js/67386898.12c542c6.js index 6c247782a52..7e912c3f049 100644 --- a/assets/js/67386898.0446f9f3.js +++ b/assets/js/67386898.12c542c6.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[67962],{6249:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>c,contentTitle:()=>s,default:()=>l,frontMatter:()=>o,metadata:()=>a,toc:()=>d});var i=t(62540),r=t(43023);const o={},s="Interface: VolumeCreateOptions",a={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"}},c={},d=[{value:"Properties",id:"properties",level:2},{value:"Name",id:"name",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"provider?",id:"provider",level:3},{value:"Defined in",id:"defined-in-1",level:4}];function p(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",p:"p",strong:"strong",...(0,r.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.header,{children:(0,i.jsx)(n.h1,{id:"interface-volumecreateoptions",children:"Interface: VolumeCreateOptions"})}),"\n",(0,i.jsx)(n.h2,{id:"properties",children:"Properties"}),"\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:"defined-in",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L3425",children:"packages/extension-api/src/extension-api.d.ts:3425"})}),"\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:"defined-in-1",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L3427",children:"packages/extension-api/src/extension-api.d.ts:3427"})})]})}function l(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(p,{...e})}):p(e)}},43023:(e,n,t)=>{t.d(n,{R:()=>s,x:()=>a});var i=t(63696);const r={},o=i.createContext(r);function s(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:s(e.components),i.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[67962],{6249:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>c,contentTitle:()=>s,default:()=>l,frontMatter:()=>o,metadata:()=>a,toc:()=>d});var i=t(62540),r=t(43023);const o={},s="Interface: VolumeCreateOptions",a={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"}},c={},d=[{value:"Properties",id:"properties",level:2},{value:"Name",id:"name",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"provider?",id:"provider",level:3},{value:"Defined in",id:"defined-in-1",level:4}];function p(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",p:"p",strong:"strong",...(0,r.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.header,{children:(0,i.jsx)(n.h1,{id:"interface-volumecreateoptions",children:"Interface: VolumeCreateOptions"})}),"\n",(0,i.jsx)(n.h2,{id:"properties",children:"Properties"}),"\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:"defined-in",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L3425",children:"packages/extension-api/src/extension-api.d.ts:3425"})}),"\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:"defined-in-1",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L3427",children:"packages/extension-api/src/extension-api.d.ts:3427"})})]})}function l(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(p,{...e})}):p(e)}},43023:(e,n,t)=>{t.d(n,{R:()=>s,x:()=>a});var i=t(63696);const r={},o=i.createContext(r);function s(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:s(e.components),i.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/6763d4e0.4ee6f5f4.js b/assets/js/6763d4e0.fac34dd7.js similarity index 97% rename from assets/js/6763d4e0.4ee6f5f4.js rename to assets/js/6763d4e0.fac34dd7.js index f30f03d5458..f7aea0d5a16 100644 --- a/assets/js/6763d4e0.4ee6f5f4.js +++ b/assets/js/6763d4e0.fac34dd7.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[75056],{85361:(n,e,i)=>{i.r(e),i.d(e,{assets:()=>a,contentTitle:()=>r,default:()=>p,frontMatter:()=>o,metadata:()=>c,toc:()=>d});var t=i(62540),s=i(43023);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:"Defined in",id:"defined-in",level:2}];function l(n){const e={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",strong:"strong",...(0,s.R)(),...n.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(e.header,{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:"defined-in",children:"Defined in"}),"\n",(0,t.jsx)(e.p,{children:(0,t.jsx)(e.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L3648",children:"packages/extension-api/src/extension-api.d.ts:3648"})})]})}function p(n={}){const{wrapper:e}={...(0,s.R)(),...n.components};return e?(0,t.jsx)(e,{...n,children:(0,t.jsx)(l,{...n})}):l(n)}},43023:(n,e,i)=>{i.d(e,{R:()=>r,x:()=>c});var t=i(63696);const s={},o=t.createContext(s);function r(n){const e=t.useContext(o);return t.useMemo((function(){return"function"==typeof n?n(e):{...e,...n}}),[e,n])}function c(n){let e;return e=n.disableParentContext?"function"==typeof n.components?n.components(s):n.components||s:r(n.components),t.createElement(o.Provider,{value:e},n.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[75056],{85361:(n,e,i)=>{i.r(e),i.d(e,{assets:()=>a,contentTitle:()=>r,default:()=>p,frontMatter:()=>o,metadata:()=>c,toc:()=>d});var t=i(62540),s=i(43023);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:"Defined in",id:"defined-in",level:2}];function l(n){const e={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",strong:"strong",...(0,s.R)(),...n.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(e.header,{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:"defined-in",children:"Defined in"}),"\n",(0,t.jsx)(e.p,{children:(0,t.jsx)(e.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L3648",children:"packages/extension-api/src/extension-api.d.ts:3648"})})]})}function p(n={}){const{wrapper:e}={...(0,s.R)(),...n.components};return e?(0,t.jsx)(e,{...n,children:(0,t.jsx)(l,{...n})}):l(n)}},43023:(n,e,i)=>{i.d(e,{R:()=>r,x:()=>c});var t=i(63696);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.16f35e3b.js b/assets/js/6774f806.e6aa73be.js similarity index 82% rename from assets/js/6774f806.16f35e3b.js rename to assets/js/6774f806.e6aa73be.js index ff2bad0c675..b9194dcacac 100644 --- a/assets/js/6774f806.16f35e3b.js +++ b/assets/js/6774f806.e6aa73be.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[89507],{80867:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>a,contentTitle:()=>s,default:()=>p,frontMatter:()=>o,metadata:()=>c,toc:()=>l});var t=i(62540),r=i(43023);const o={},s="Function: pullImage()",c={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:"Defined in",id:"defined-in",level:2}];function d(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",strong:"strong",...(0,r.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.header,{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:"defined-in",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L3625",children:"packages/extension-api/src/extension-api.d.ts:3625"})})]})}function p(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(d,{...e})}):d(e)}},43023:(e,n,i)=>{i.d(n,{R:()=>s,x:()=>c});var t=i(63696);const r={},o=t.createContext(r);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(r):e.components||r:s(e.components),t.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[89507],{80867:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>a,contentTitle:()=>o,default:()=>p,frontMatter:()=>c,metadata:()=>s,toc:()=>l});var t=i(62540),r=i(43023);const c={},o="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:"Defined in",id:"defined-in",level:2}];function d(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",strong:"strong",...(0,r.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.header,{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:"defined-in",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L3625",children:"packages/extension-api/src/extension-api.d.ts:3625"})})]})}function p(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(d,{...e})}):d(e)}},43023:(e,n,i)=>{i.d(n,{R:()=>o,x:()=>s});var t=i(63696);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 s(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/67eba1be.715f2571.js b/assets/js/67eba1be.39c7e55f.js similarity index 84% rename from assets/js/67eba1be.715f2571.js rename to assets/js/67eba1be.39c7e55f.js index b22b385d81d..dbcb0f1a5fa 100644 --- a/assets/js/67eba1be.715f2571.js +++ b/assets/js/67eba1be.39c7e55f.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[81634],{37764:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>r,contentTitle:()=>a,default:()=>h,frontMatter:()=>d,metadata:()=>o,toc:()=>c});var t=i(62540),s=i(43023);const d={},a="Interface: Command",o={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"}},r={},c=[{value:"Properties",id:"properties",level:2},{value:"arguments?",id:"arguments",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"command",id:"command",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"title",id:"title",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"tooltip?",id:"tooltip",level:3},{value:"Defined in",id:"defined-in-3",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",p:"p",strong:"strong",...(0,s.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.header,{children:(0,t.jsx)(n.h1,{id:"interface-command",children:"Interface: Command"})}),"\n",(0,t.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,t.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,t.jsx)(n.h3,{id:"arguments",children:"arguments?"}),"\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:"arguments"}),": ",(0,t.jsx)(n.code,{children:"any"}),"[]"]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L55",children:"packages/extension-api/src/extension-api.d.ts:55"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"command",children:"command"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"command"}),": ",(0,t.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L52",children:"packages/extension-api/src/extension-api.d.ts:52"})}),"\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:"defined-in-2",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L51",children:"packages/extension-api/src/extension-api.d.ts:51"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"tooltip",children:"tooltip?"}),"\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:"tooltip"}),": ",(0,t.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"defined-in-3",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L53",children:"packages/extension-api/src/extension-api.d.ts:53"})})]})}function h(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},43023:(e,n,i)=>{i.d(n,{R:()=>a,x:()=>o});var t=i(63696);const s={},d=t.createContext(s);function a(e){const n=t.useContext(d);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:a(e.components),t.createElement(d.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[81634],{37764:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>r,contentTitle:()=>d,default:()=>h,frontMatter:()=>a,metadata:()=>o,toc:()=>c});var t=i(62540),s=i(43023);const a={},d="Interface: Command",o={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"}},r={},c=[{value:"Properties",id:"properties",level:2},{value:"arguments?",id:"arguments",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"command",id:"command",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"title",id:"title",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"tooltip?",id:"tooltip",level:3},{value:"Defined in",id:"defined-in-3",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",p:"p",strong:"strong",...(0,s.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.header,{children:(0,t.jsx)(n.h1,{id:"interface-command",children:"Interface: Command"})}),"\n",(0,t.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,t.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,t.jsx)(n.h3,{id:"arguments",children:"arguments?"}),"\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:"arguments"}),": ",(0,t.jsx)(n.code,{children:"any"}),"[]"]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L55",children:"packages/extension-api/src/extension-api.d.ts:55"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"command",children:"command"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"command"}),": ",(0,t.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L52",children:"packages/extension-api/src/extension-api.d.ts:52"})}),"\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:"defined-in-2",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L51",children:"packages/extension-api/src/extension-api.d.ts:51"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"tooltip",children:"tooltip?"}),"\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:"tooltip"}),": ",(0,t.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"defined-in-3",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L53",children:"packages/extension-api/src/extension-api.d.ts:53"})})]})}function h(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},43023:(e,n,i)=>{i.d(n,{R:()=>d,x:()=>o});var t=i(63696);const s={},a=t.createContext(s);function d(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(s):e.components||s:d(e.components),t.createElement(a.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/67fccd64.b7405619.js b/assets/js/67fccd64.9c63e23b.js similarity index 84% rename from assets/js/67fccd64.b7405619.js rename to assets/js/67fccd64.9c63e23b.js index 28e4ee392df..d5072057152 100644 --- a/assets/js/67fccd64.b7405619.js +++ b/assets/js/67fccd64.9c63e23b.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[8936],{54783:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>c,contentTitle:()=>a,default:()=>h,frontMatter:()=>d,metadata:()=>r,toc:()=>o});var s=i(62540),t=i(43023);const d={},a="Interface: ContainerStatsInfo",r={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"}},c={},o=[{value:"Properties",id:"properties",level:2},{value:"blkio_stats?",id:"blkio_stats",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"cpu_stats",id:"cpu_stats",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"engineId",id:"engineid",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"engineName",id:"enginename",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"memory_stats",id:"memory_stats",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"networks",id:"networks",level:3},{value:"Defined in",id:"defined-in-5",level:4},{value:"num_procs",id:"num_procs",level:3},{value:"Defined in",id:"defined-in-6",level:4},{value:"pids_stats?",id:"pids_stats",level:3},{value:"Defined in",id:"defined-in-7",level:4},{value:"precpu_stats",id:"precpu_stats",level:3},{value:"Defined in",id:"defined-in-8",level:4},{value:"preread",id:"preread",level:3},{value:"Defined in",id:"defined-in-9",level:4},{value:"read",id:"read",level:3},{value:"Defined in",id:"defined-in-10",level:4},{value:"storage_stats?",id:"storage_stats",level:3},{value:"Defined in",id:"defined-in-11",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",p:"p",strong:"strong",...(0,t.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.header,{children:(0,s.jsx)(n.h1,{id:"interface-containerstatsinfo",children:"Interface: ContainerStatsInfo"})}),"\n",(0,s.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,s.jsx)(n.h3,{id:"blkio_stats",children:"blkio_stats?"}),"\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:"blkio_stats"}),": ",(0,s.jsx)(n.a,{href:"/api/interfaces/BlkioStats",children:(0,s.jsx)(n.code,{children:"BlkioStats"})})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L3178",children:"packages/extension-api/src/extension-api.d.ts:3178"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"cpu_stats",children:"cpu_stats"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"cpu_stats"}),": ",(0,s.jsx)(n.a,{href:"/api/interfaces/CPUStats",children:(0,s.jsx)(n.code,{children:"CPUStats"})})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/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:"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.h4,{id:"defined-in-2",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L3173",children:"packages/extension-api/src/extension-api.d.ts:3173"})}),"\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.h4,{id:"defined-in-3",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L3174",children:"packages/extension-api/src/extension-api.d.ts:3174"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"memory_stats",children:"memory_stats"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"memory_stats"}),": ",(0,s.jsx)(n.a,{href:"/api/interfaces/MemoryStats",children:(0,s.jsx)(n.code,{children:"MemoryStats"})})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-4",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L3182",children:"packages/extension-api/src/extension-api.d.ts:3182"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"networks",children:"networks"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"networks"}),": ",(0,s.jsx)(n.a,{href:"/api/interfaces/NetworkStats",children:(0,s.jsx)(n.code,{children:"NetworkStats"})})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-5",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L3181",children:"packages/extension-api/src/extension-api.d.ts:3181"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"num_procs",children:"num_procs"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"num_procs"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-6",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/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:"pids_stats",children:"pids_stats?"}),"\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:"pids_stats"}),": ",(0,s.jsx)(n.a,{href:"/api/interfaces/PidsStats",children:(0,s.jsx)(n.code,{children:"PidsStats"})})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-7",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L3177",children:"packages/extension-api/src/extension-api.d.ts:3177"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"precpu_stats",children:"precpu_stats"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"precpu_stats"}),": ",(0,s.jsx)(n.a,{href:"/api/interfaces/CPUStats",children:(0,s.jsx)(n.code,{children:"CPUStats"})})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-8",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L3184",children:"packages/extension-api/src/extension-api.d.ts:3184"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"preread",children:"preread"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"preread"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-9",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L3176",children:"packages/extension-api/src/extension-api.d.ts:3176"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"read",children:"read"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"read"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-10",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L3175",children:"packages/extension-api/src/extension-api.d.ts:3175"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"storage_stats",children:"storage_stats?"}),"\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:"storage_stats"}),": ",(0,s.jsx)(n.a,{href:"/api/interfaces/StorageStats",children:(0,s.jsx)(n.code,{children:"StorageStats"})})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-11",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L3180",children:"packages/extension-api/src/extension-api.d.ts:3180"})})]})}function h(e={}){const{wrapper:n}={...(0,t.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},43023:(e,n,i)=>{i.d(n,{R:()=>a,x:()=>r});var s=i(63696);const t={},d=s.createContext(t);function a(e){const n=s.useContext(d);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:a(e.components),s.createElement(d.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[8936],{54783:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>c,contentTitle:()=>d,default:()=>h,frontMatter:()=>a,metadata:()=>r,toc:()=>o});var s=i(62540),t=i(43023);const a={},d="Interface: ContainerStatsInfo",r={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"}},c={},o=[{value:"Properties",id:"properties",level:2},{value:"blkio_stats?",id:"blkio_stats",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"cpu_stats",id:"cpu_stats",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"engineId",id:"engineid",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"engineName",id:"enginename",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"memory_stats",id:"memory_stats",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"networks",id:"networks",level:3},{value:"Defined in",id:"defined-in-5",level:4},{value:"num_procs",id:"num_procs",level:3},{value:"Defined in",id:"defined-in-6",level:4},{value:"pids_stats?",id:"pids_stats",level:3},{value:"Defined in",id:"defined-in-7",level:4},{value:"precpu_stats",id:"precpu_stats",level:3},{value:"Defined in",id:"defined-in-8",level:4},{value:"preread",id:"preread",level:3},{value:"Defined in",id:"defined-in-9",level:4},{value:"read",id:"read",level:3},{value:"Defined in",id:"defined-in-10",level:4},{value:"storage_stats?",id:"storage_stats",level:3},{value:"Defined in",id:"defined-in-11",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",p:"p",strong:"strong",...(0,t.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.header,{children:(0,s.jsx)(n.h1,{id:"interface-containerstatsinfo",children:"Interface: ContainerStatsInfo"})}),"\n",(0,s.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,s.jsx)(n.h3,{id:"blkio_stats",children:"blkio_stats?"}),"\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:"blkio_stats"}),": ",(0,s.jsx)(n.a,{href:"/api/interfaces/BlkioStats",children:(0,s.jsx)(n.code,{children:"BlkioStats"})})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L3178",children:"packages/extension-api/src/extension-api.d.ts:3178"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"cpu_stats",children:"cpu_stats"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"cpu_stats"}),": ",(0,s.jsx)(n.a,{href:"/api/interfaces/CPUStats",children:(0,s.jsx)(n.code,{children:"CPUStats"})})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/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:"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.h4,{id:"defined-in-2",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L3173",children:"packages/extension-api/src/extension-api.d.ts:3173"})}),"\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.h4,{id:"defined-in-3",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L3174",children:"packages/extension-api/src/extension-api.d.ts:3174"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"memory_stats",children:"memory_stats"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"memory_stats"}),": ",(0,s.jsx)(n.a,{href:"/api/interfaces/MemoryStats",children:(0,s.jsx)(n.code,{children:"MemoryStats"})})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-4",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L3182",children:"packages/extension-api/src/extension-api.d.ts:3182"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"networks",children:"networks"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"networks"}),": ",(0,s.jsx)(n.a,{href:"/api/interfaces/NetworkStats",children:(0,s.jsx)(n.code,{children:"NetworkStats"})})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-5",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L3181",children:"packages/extension-api/src/extension-api.d.ts:3181"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"num_procs",children:"num_procs"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"num_procs"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-6",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/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:"pids_stats",children:"pids_stats?"}),"\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:"pids_stats"}),": ",(0,s.jsx)(n.a,{href:"/api/interfaces/PidsStats",children:(0,s.jsx)(n.code,{children:"PidsStats"})})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-7",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L3177",children:"packages/extension-api/src/extension-api.d.ts:3177"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"precpu_stats",children:"precpu_stats"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"precpu_stats"}),": ",(0,s.jsx)(n.a,{href:"/api/interfaces/CPUStats",children:(0,s.jsx)(n.code,{children:"CPUStats"})})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-8",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L3184",children:"packages/extension-api/src/extension-api.d.ts:3184"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"preread",children:"preread"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"preread"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-9",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L3176",children:"packages/extension-api/src/extension-api.d.ts:3176"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"read",children:"read"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"read"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-10",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L3175",children:"packages/extension-api/src/extension-api.d.ts:3175"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"storage_stats",children:"storage_stats?"}),"\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:"storage_stats"}),": ",(0,s.jsx)(n.a,{href:"/api/interfaces/StorageStats",children:(0,s.jsx)(n.code,{children:"StorageStats"})})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-11",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L3180",children:"packages/extension-api/src/extension-api.d.ts:3180"})})]})}function h(e={}){const{wrapper:n}={...(0,t.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},43023:(e,n,i)=>{i.d(n,{R:()=>d,x:()=>r});var s=i(63696);const t={},a=s.createContext(t);function d(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:d(e.components),s.createElement(a.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/688ee267.2e419df6.js b/assets/js/688ee267.ace7ce81.js similarity index 96% rename from assets/js/688ee267.2e419df6.js rename to assets/js/688ee267.ace7ce81.js index 1731a2320dd..6eaaa641eaa 100644 --- a/assets/js/688ee267.2e419df6.js +++ b/assets/js/688ee267.ace7ce81.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[71728],{13683:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>c,contentTitle:()=>o,default:()=>l,frontMatter:()=>a,metadata:()=>r,toc:()=>d});var i=s(62540),t=s(43023);const a={},o="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:"Defined in",id:"defined-in",level:2}];function h(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",strong:"strong",...(0,t.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.header,{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.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:"defined-in",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L3944",children:"packages/extension-api/src/extension-api.d.ts:3944"})})]})}function l(e={}){const{wrapper:n}={...(0,t.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(h,{...e})}):h(e)}},43023:(e,n,s)=>{s.d(n,{R:()=>o,x:()=>r});var i=s(63696);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([[71728],{13683:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>c,contentTitle:()=>o,default:()=>l,frontMatter:()=>a,metadata:()=>r,toc:()=>d});var i=s(62540),t=s(43023);const a={},o="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:"Defined in",id:"defined-in",level:2}];function h(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",strong:"strong",...(0,t.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.header,{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.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:"defined-in",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L3944",children:"packages/extension-api/src/extension-api.d.ts:3944"})})]})}function l(e={}){const{wrapper:n}={...(0,t.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(h,{...e})}):h(e)}},43023:(e,n,s)=>{s.d(n,{R:()=>o,x:()=>r});var i=s(63696);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 diff --git a/assets/js/6a1fe514.e5365227.js b/assets/js/6a1fe514.c01159fa.js similarity index 91% rename from assets/js/6a1fe514.e5365227.js rename to assets/js/6a1fe514.c01159fa.js index b689941b0a9..2cf2e1cbba8 100644 --- a/assets/js/6a1fe514.e5365227.js +++ b/assets/js/6a1fe514.c01159fa.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[96220],{93894:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>c,contentTitle:()=>d,default:()=>p,frontMatter:()=>t,metadata:()=>o,toc:()=>a});var r=i(62540),s=i(43023);const t={},d="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"}},c={},a=[{value:"Properties",id:"properties",level:2},{value:"icon?",id:"icon",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"name",id:"name",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"url",id:"url",level:3},{value:"Defined in",id:"defined-in-2",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",p:"p",strong:"strong",...(0,s.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.header,{children:(0,r.jsx)(n.h1,{id:"interface-registrysuggestedprovider",children:"Interface: RegistrySuggestedProvider"})}),"\n",(0,r.jsx)(n.h2,{id:"properties",children:"Properties"}),"\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:"defined-in",children:"Defined in"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L892",children:"packages/extension-api/src/extension-api.d.ts:892"})}),"\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:"defined-in-1",children:"Defined in"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L888",children:"packages/extension-api/src/extension-api.d.ts:888"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"url",children:"url"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"url"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"defined-in-2",children:"Defined in"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L889",children:"packages/extension-api/src/extension-api.d.ts:889"})})]})}function p(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(l,{...e})}):l(e)}},43023:(e,n,i)=>{i.d(n,{R:()=>d,x:()=>o});var r=i(63696);const s={},t=r.createContext(s);function d(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(s):e.components||s:d(e.components),r.createElement(t.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[96220],{93894:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>c,contentTitle:()=>d,default:()=>p,frontMatter:()=>t,metadata:()=>o,toc:()=>a});var r=i(62540),s=i(43023);const t={},d="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"}},c={},a=[{value:"Properties",id:"properties",level:2},{value:"icon?",id:"icon",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"name",id:"name",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"url",id:"url",level:3},{value:"Defined in",id:"defined-in-2",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",p:"p",strong:"strong",...(0,s.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.header,{children:(0,r.jsx)(n.h1,{id:"interface-registrysuggestedprovider",children:"Interface: RegistrySuggestedProvider"})}),"\n",(0,r.jsx)(n.h2,{id:"properties",children:"Properties"}),"\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:"defined-in",children:"Defined in"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L892",children:"packages/extension-api/src/extension-api.d.ts:892"})}),"\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:"defined-in-1",children:"Defined in"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L888",children:"packages/extension-api/src/extension-api.d.ts:888"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"url",children:"url"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"url"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"defined-in-2",children:"Defined in"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L889",children:"packages/extension-api/src/extension-api.d.ts:889"})})]})}function p(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(l,{...e})}):l(e)}},43023:(e,n,i)=>{i.d(n,{R:()=>d,x:()=>o});var r=i(63696);const s={},t=r.createContext(s);function d(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(s):e.components||s:d(e.components),r.createElement(t.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/6aa0b043.5c9ed67a.js b/assets/js/6aa0b043.f7d1efa5.js similarity index 96% rename from assets/js/6aa0b043.5c9ed67a.js rename to assets/js/6aa0b043.f7d1efa5.js index a938661e6da..d221538508e 100644 --- a/assets/js/6aa0b043.5c9ed67a.js +++ b/assets/js/6aa0b043.f7d1efa5.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[7406],{25609:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>d,contentTitle:()=>c,default:()=>p,frontMatter:()=>t,metadata:()=>s,toc:()=>a});var r=i(62540),o=i(43023);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:"Defined in",id:"defined-in",level:4},{value:"providerId",id:"providerid",level:3},{value:"Defined in",id:"defined-in-1",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",p:"p",strong:"strong",...(0,o.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.header,{children:(0,r.jsx)(n.h1,{id:"interface-providercontainerconnection",children:"Interface: ProviderContainerConnection"})}),"\n",(0,r.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,r.jsx)(n.h3,{id:"connection",children:"connection"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(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"]}),"\n",(0,r.jsx)(n.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L723",children:"packages/extension-api/src/extension-api.d.ts:723"})}),"\n",(0,r.jsx)(n.hr,{}),"\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:"defined-in-1",children:"Defined in"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L722",children:"packages/extension-api/src/extension-api.d.ts:722"})})]})}function p(e={}){const{wrapper:n}={...(0,o.R)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(l,{...e})}):l(e)}},43023:(e,n,i)=>{i.d(n,{R:()=>c,x:()=>s});var r=i(63696);const o={},t=r.createContext(o);function c(e){const n=r.useContext(t);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function s(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:c(e.components),r.createElement(t.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[7406],{25609:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>d,contentTitle:()=>c,default:()=>p,frontMatter:()=>t,metadata:()=>s,toc:()=>a});var r=i(62540),o=i(43023);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:"Defined in",id:"defined-in",level:4},{value:"providerId",id:"providerid",level:3},{value:"Defined in",id:"defined-in-1",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",p:"p",strong:"strong",...(0,o.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.header,{children:(0,r.jsx)(n.h1,{id:"interface-providercontainerconnection",children:"Interface: ProviderContainerConnection"})}),"\n",(0,r.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,r.jsx)(n.h3,{id:"connection",children:"connection"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(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"]}),"\n",(0,r.jsx)(n.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L723",children:"packages/extension-api/src/extension-api.d.ts:723"})}),"\n",(0,r.jsx)(n.hr,{}),"\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:"defined-in-1",children:"Defined in"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L722",children:"packages/extension-api/src/extension-api.d.ts:722"})})]})}function p(e={}){const{wrapper:n}={...(0,o.R)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(l,{...e})}):l(e)}},43023:(e,n,i)=>{i.d(n,{R:()=>c,x:()=>s});var r=i(63696);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/6e30ac7b.5a27fc2c.js b/assets/js/6e30ac7b.9a42ea49.js similarity index 90% rename from assets/js/6e30ac7b.5a27fc2c.js rename to assets/js/6e30ac7b.9a42ea49.js index 5924aa29aaf..cfa7ddab204 100644 --- a/assets/js/6e30ac7b.5a27fc2c.js +++ b/assets/js/6e30ac7b.9a42ea49.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[94054],{40445:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>r,contentTitle:()=>o,default:()=>h,frontMatter:()=>c,metadata:()=>d,toc:()=>a});var t=i(62540),s=i(43023);const c={},o="Interface: QuickPickOptions",d={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"}},r={},a=[{value:"Properties",id:"properties",level:2},{value:"canPickMany?",id:"canpickmany",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"ignoreFocusOut?",id:"ignorefocusout",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"matchOnDescription?",id:"matchondescription",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"matchOnDetail?",id:"matchondetail",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"placeHolder?",id:"placeholder",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"title?",id:"title",level:3},{value:"Defined in",id:"defined-in-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:"Defined in",id:"defined-in-6",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",p:"p",strong:"strong",...(0,s.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.header,{children:(0,t.jsx)(n.h1,{id:"interface-quickpickoptions",children:"Interface: QuickPickOptions"})}),"\n",(0,t.jsx)(n.p,{children:"Options to configure the behavior of the quick pick UI."}),"\n",(0,t.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,t.jsx)(n.h3,{id:"canpickmany",children:"canPickMany?"}),"\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:"canPickMany"}),": ",(0,t.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,t.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,t.jsx)(n.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L1269",children:"packages/extension-api/src/extension-api.d.ts:1269"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"ignorefocusout",children:"ignoreFocusOut?"}),"\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:"ignoreFocusOut"}),": ",(0,t.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,t.jsxs)(n.p,{children:["Set to ",(0,t.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,t.jsx)(n.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L1264",children:"packages/extension-api/src/extension-api.d.ts:1264"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"matchondescription",children:"matchOnDescription?"}),"\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:"matchOnDescription"}),": ",(0,t.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"An optional flag to include the description when filtering the picks."}),"\n",(0,t.jsx)(n.h4,{id:"defined-in-2",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L1248",children:"packages/extension-api/src/extension-api.d.ts:1248"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"matchondetail",children:"matchOnDetail?"}),"\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:"matchOnDetail"}),": ",(0,t.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"An optional flag to include the detail when filtering the picks."}),"\n",(0,t.jsx)(n.h4,{id:"defined-in-3",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L1253",children:"packages/extension-api/src/extension-api.d.ts:1253"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"placeholder",children:"placeHolder?"}),"\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:"placeHolder"}),": ",(0,t.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,t.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,t.jsx)(n.h4,{id:"defined-in-4",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L1258",children:"packages/extension-api/src/extension-api.d.ts:1258"})}),"\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:"An optional string that represents the title of the quick pick."}),"\n",(0,t.jsx)(n.h4,{id:"defined-in-5",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L1243",children:"packages/extension-api/src/extension-api.d.ts:1243"})}),"\n",(0,t.jsx)(n.h2,{id:"methods",children:"Methods"}),"\n",(0,t.jsx)(n.h3,{id:"ondidselectitem",children:"onDidSelectItem()?"}),"\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:"onDidSelectItem"}),"(",(0,t.jsx)(n.code,{children:"item"}),"): ",(0,t.jsx)(n.code,{children:"any"})]}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"An optional function that is invoked whenever an item is selected."}),"\n",(0,t.jsx)(n.h4,{id:"parameters",children:"Parameters"}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"item"}),": ",(0,t.jsx)(n.code,{children:"string"})," | ",(0,t.jsx)(n.a,{href:"/api/interfaces/QuickPickItem",children:(0,t.jsx)(n.code,{children:"QuickPickItem"})})]}),"\n",(0,t.jsx)(n.h4,{id:"returns",children:"Returns"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.code,{children:"any"})}),"\n",(0,t.jsx)(n.h4,{id:"defined-in-6",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L1275",children:"packages/extension-api/src/extension-api.d.ts:1275"})})]})}function h(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},43023:(e,n,i)=>{i.d(n,{R:()=>o,x:()=>d});var t=i(63696);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 d(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([[94054],{40445:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>r,contentTitle:()=>o,default:()=>h,frontMatter:()=>c,metadata:()=>d,toc:()=>a});var t=i(62540),s=i(43023);const c={},o="Interface: QuickPickOptions",d={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"}},r={},a=[{value:"Properties",id:"properties",level:2},{value:"canPickMany?",id:"canpickmany",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"ignoreFocusOut?",id:"ignorefocusout",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"matchOnDescription?",id:"matchondescription",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"matchOnDetail?",id:"matchondetail",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"placeHolder?",id:"placeholder",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"title?",id:"title",level:3},{value:"Defined in",id:"defined-in-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:"Defined in",id:"defined-in-6",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",p:"p",strong:"strong",...(0,s.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.header,{children:(0,t.jsx)(n.h1,{id:"interface-quickpickoptions",children:"Interface: QuickPickOptions"})}),"\n",(0,t.jsx)(n.p,{children:"Options to configure the behavior of the quick pick UI."}),"\n",(0,t.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,t.jsx)(n.h3,{id:"canpickmany",children:"canPickMany?"}),"\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:"canPickMany"}),": ",(0,t.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,t.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,t.jsx)(n.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L1269",children:"packages/extension-api/src/extension-api.d.ts:1269"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"ignorefocusout",children:"ignoreFocusOut?"}),"\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:"ignoreFocusOut"}),": ",(0,t.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,t.jsxs)(n.p,{children:["Set to ",(0,t.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,t.jsx)(n.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L1264",children:"packages/extension-api/src/extension-api.d.ts:1264"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"matchondescription",children:"matchOnDescription?"}),"\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:"matchOnDescription"}),": ",(0,t.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"An optional flag to include the description when filtering the picks."}),"\n",(0,t.jsx)(n.h4,{id:"defined-in-2",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L1248",children:"packages/extension-api/src/extension-api.d.ts:1248"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"matchondetail",children:"matchOnDetail?"}),"\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:"matchOnDetail"}),": ",(0,t.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"An optional flag to include the detail when filtering the picks."}),"\n",(0,t.jsx)(n.h4,{id:"defined-in-3",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L1253",children:"packages/extension-api/src/extension-api.d.ts:1253"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"placeholder",children:"placeHolder?"}),"\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:"placeHolder"}),": ",(0,t.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,t.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,t.jsx)(n.h4,{id:"defined-in-4",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L1258",children:"packages/extension-api/src/extension-api.d.ts:1258"})}),"\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:"An optional string that represents the title of the quick pick."}),"\n",(0,t.jsx)(n.h4,{id:"defined-in-5",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L1243",children:"packages/extension-api/src/extension-api.d.ts:1243"})}),"\n",(0,t.jsx)(n.h2,{id:"methods",children:"Methods"}),"\n",(0,t.jsx)(n.h3,{id:"ondidselectitem",children:"onDidSelectItem()?"}),"\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:"onDidSelectItem"}),"(",(0,t.jsx)(n.code,{children:"item"}),"): ",(0,t.jsx)(n.code,{children:"any"})]}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"An optional function that is invoked whenever an item is selected."}),"\n",(0,t.jsx)(n.h4,{id:"parameters",children:"Parameters"}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"item"}),": ",(0,t.jsx)(n.code,{children:"string"})," | ",(0,t.jsx)(n.a,{href:"/api/interfaces/QuickPickItem",children:(0,t.jsx)(n.code,{children:"QuickPickItem"})})]}),"\n",(0,t.jsx)(n.h4,{id:"returns",children:"Returns"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.code,{children:"any"})}),"\n",(0,t.jsx)(n.h4,{id:"defined-in-6",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L1275",children:"packages/extension-api/src/extension-api.d.ts:1275"})})]})}function h(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},43023:(e,n,i)=>{i.d(n,{R:()=>o,x:()=>d});var t=i(63696);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 d(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 diff --git a/assets/js/6e92edd9.200d5588.js b/assets/js/6e92edd9.5f371511.js similarity index 96% rename from assets/js/6e92edd9.200d5588.js rename to assets/js/6e92edd9.5f371511.js index 681d0998b42..c5b14b43e39 100644 --- a/assets/js/6e92edd9.200d5588.js +++ b/assets/js/6e92edd9.5f371511.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[90735],{89695:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>a,contentTitle:()=>t,default:()=>h,frontMatter:()=>d,metadata:()=>c,toc:()=>l});var s=i(62540),r=i(43023);const d={},t="Interface: Configuration",c={id:"interfaces/Configuration",title:"Interface: Configuration",description:"Indexable",source:"@site/api/interfaces/Configuration.md",sourceDirName:"interfaces",slug:"/interfaces/Configuration",permalink:"/api/interfaces/Configuration",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Command",permalink:"/api/interfaces/Command"},next:{title:"ConfigurationChangeEvent",permalink:"/api/interfaces/ConfigurationChangeEvent"}},a={},l=[{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:"Defined in",id:"defined-in",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:"Defined in",id:"defined-in-1",level:5},{value:"has()",id:"has",level:3},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"update()",id:"update",level:3},{value:"Parameters",id:"parameters-3",level:4},{value:"Returns",id:"returns-3",level:4},{value:"Defined in",id:"defined-in-3",level:4}];function o(e){const n={a:"a",blockquote:"blockquote",code:"code",em:"em",h1:"h1",h2:"h2",h3:"h3",h4:"h4",h5:"h5",header:"header",hr:"hr",p:"p",strong:"strong",...(0,r.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.header,{children:(0,s.jsx)(n.h1,{id:"interface-configuration",children:"Interface: Configuration"})}),"\n",(0,s.jsx)(n.h2,{id:"indexable",children:"Indexable"}),"\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:"any"})]}),"\n",(0,s.jsx)(n.h2,{id:"methods",children:"Methods"}),"\n",(0,s.jsx)(n.h3,{id:"get",children:"get()"}),"\n",(0,s.jsx)(n.h4,{id:"getsection",children:"get(section)"}),"\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:"T"}),">(",(0,s.jsx)(n.code,{children:"section"}),"): ",(0,s.jsx)(n.code,{children:"undefined"})," | ",(0,s.jsx)(n.code,{children:"T"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Return a value from this configuration."}),"\n",(0,s.jsx)(n.h5,{id:"type-parameters",children:"Type Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"T"})]}),"\n",(0,s.jsx)(n.h5,{id:"parameters",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"section"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n",(0,s.jsxs)(n.p,{children:["Configuration name, supports ",(0,s.jsx)(n.em,{children:"dotted"})," names."]}),"\n",(0,s.jsx)(n.h5,{id:"returns",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"undefined"})," | ",(0,s.jsx)(n.code,{children:"T"})]}),"\n",(0,s.jsxs)(n.p,{children:["The value ",(0,s.jsx)(n.code,{children:"section"})," denotes or ",(0,s.jsx)(n.code,{children:"undefined"}),"."]}),"\n",(0,s.jsx)(n.h5,{id:"defined-in",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L972",children:"packages/extension-api/src/extension-api.d.ts:972"})}),"\n",(0,s.jsx)(n.h4,{id:"getsection-defaultvalue",children:"get(section, defaultValue)"}),"\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:"T"}),">(",(0,s.jsx)(n.code,{children:"section"}),", ",(0,s.jsx)(n.code,{children:"defaultValue"}),"): ",(0,s.jsx)(n.code,{children:"T"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Return a value from this configuration."}),"\n",(0,s.jsx)(n.h5,{id:"type-parameters-1",children:"Type Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"T"})]}),"\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:"section"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n",(0,s.jsxs)(n.p,{children:["Configuration name, supports ",(0,s.jsx)(n.em,{children:"dotted"})," names."]}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"defaultValue"}),": ",(0,s.jsx)(n.code,{children:"T"})]}),"\n",(0,s.jsxs)(n.p,{children:["A value should be returned when no value could be found, is ",(0,s.jsx)(n.code,{children:"undefined"}),"."]}),"\n",(0,s.jsx)(n.h5,{id:"returns-1",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"T"})}),"\n",(0,s.jsxs)(n.p,{children:["The value ",(0,s.jsx)(n.code,{children:"section"})," denotes or the default."]}),"\n",(0,s.jsx)(n.h5,{id:"defined-in-1",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L981",children:"packages/extension-api/src/extension-api.d.ts:981"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"has",children:"has()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"has"}),"(",(0,s.jsx)(n.code,{children:"section"}),"): ",(0,s.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Check if this configuration has a certain value."}),"\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:"section"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n",(0,s.jsxs)(n.p,{children:["Configuration name, supports ",(0,s.jsx)(n.em,{children:"dotted"})," names."]}),"\n",(0,s.jsx)(n.h4,{id:"returns-2",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"boolean"})}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"true"})," if the section doesn't resolve to ",(0,s.jsx)(n.code,{children:"undefined"}),"."]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-2",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L989",children:"packages/extension-api/src/extension-api.d.ts:989"})}),"\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:"section"}),", ",(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:"Update a configuration value. The updated configuration values are persisted."}),"\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:"section"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\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.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:"defined-in-3",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L995",children:"packages/extension-api/src/extension-api.d.ts:995"})})]})}function h(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(o,{...e})}):o(e)}},43023:(e,n,i)=>{i.d(n,{R:()=>t,x:()=>c});var s=i(63696);const r={},d=s.createContext(r);function t(e){const n=s.useContext(d);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(d.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[90735],{89695:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>a,contentTitle:()=>t,default:()=>h,frontMatter:()=>d,metadata:()=>c,toc:()=>l});var s=i(62540),r=i(43023);const d={},t="Interface: Configuration",c={id:"interfaces/Configuration",title:"Interface: Configuration",description:"Indexable",source:"@site/api/interfaces/Configuration.md",sourceDirName:"interfaces",slug:"/interfaces/Configuration",permalink:"/api/interfaces/Configuration",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Command",permalink:"/api/interfaces/Command"},next:{title:"ConfigurationChangeEvent",permalink:"/api/interfaces/ConfigurationChangeEvent"}},a={},l=[{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:"Defined in",id:"defined-in",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:"Defined in",id:"defined-in-1",level:5},{value:"has()",id:"has",level:3},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"update()",id:"update",level:3},{value:"Parameters",id:"parameters-3",level:4},{value:"Returns",id:"returns-3",level:4},{value:"Defined in",id:"defined-in-3",level:4}];function o(e){const n={a:"a",blockquote:"blockquote",code:"code",em:"em",h1:"h1",h2:"h2",h3:"h3",h4:"h4",h5:"h5",header:"header",hr:"hr",p:"p",strong:"strong",...(0,r.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.header,{children:(0,s.jsx)(n.h1,{id:"interface-configuration",children:"Interface: Configuration"})}),"\n",(0,s.jsx)(n.h2,{id:"indexable",children:"Indexable"}),"\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:"any"})]}),"\n",(0,s.jsx)(n.h2,{id:"methods",children:"Methods"}),"\n",(0,s.jsx)(n.h3,{id:"get",children:"get()"}),"\n",(0,s.jsx)(n.h4,{id:"getsection",children:"get(section)"}),"\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:"T"}),">(",(0,s.jsx)(n.code,{children:"section"}),"): ",(0,s.jsx)(n.code,{children:"undefined"})," | ",(0,s.jsx)(n.code,{children:"T"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Return a value from this configuration."}),"\n",(0,s.jsx)(n.h5,{id:"type-parameters",children:"Type Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"T"})]}),"\n",(0,s.jsx)(n.h5,{id:"parameters",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"section"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n",(0,s.jsxs)(n.p,{children:["Configuration name, supports ",(0,s.jsx)(n.em,{children:"dotted"})," names."]}),"\n",(0,s.jsx)(n.h5,{id:"returns",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"undefined"})," | ",(0,s.jsx)(n.code,{children:"T"})]}),"\n",(0,s.jsxs)(n.p,{children:["The value ",(0,s.jsx)(n.code,{children:"section"})," denotes or ",(0,s.jsx)(n.code,{children:"undefined"}),"."]}),"\n",(0,s.jsx)(n.h5,{id:"defined-in",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L972",children:"packages/extension-api/src/extension-api.d.ts:972"})}),"\n",(0,s.jsx)(n.h4,{id:"getsection-defaultvalue",children:"get(section, defaultValue)"}),"\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:"T"}),">(",(0,s.jsx)(n.code,{children:"section"}),", ",(0,s.jsx)(n.code,{children:"defaultValue"}),"): ",(0,s.jsx)(n.code,{children:"T"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Return a value from this configuration."}),"\n",(0,s.jsx)(n.h5,{id:"type-parameters-1",children:"Type Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"T"})]}),"\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:"section"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n",(0,s.jsxs)(n.p,{children:["Configuration name, supports ",(0,s.jsx)(n.em,{children:"dotted"})," names."]}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"defaultValue"}),": ",(0,s.jsx)(n.code,{children:"T"})]}),"\n",(0,s.jsxs)(n.p,{children:["A value should be returned when no value could be found, is ",(0,s.jsx)(n.code,{children:"undefined"}),"."]}),"\n",(0,s.jsx)(n.h5,{id:"returns-1",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"T"})}),"\n",(0,s.jsxs)(n.p,{children:["The value ",(0,s.jsx)(n.code,{children:"section"})," denotes or the default."]}),"\n",(0,s.jsx)(n.h5,{id:"defined-in-1",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L981",children:"packages/extension-api/src/extension-api.d.ts:981"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"has",children:"has()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"has"}),"(",(0,s.jsx)(n.code,{children:"section"}),"): ",(0,s.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Check if this configuration has a certain value."}),"\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:"section"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n",(0,s.jsxs)(n.p,{children:["Configuration name, supports ",(0,s.jsx)(n.em,{children:"dotted"})," names."]}),"\n",(0,s.jsx)(n.h4,{id:"returns-2",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"boolean"})}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"true"})," if the section doesn't resolve to ",(0,s.jsx)(n.code,{children:"undefined"}),"."]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-2",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L989",children:"packages/extension-api/src/extension-api.d.ts:989"})}),"\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:"section"}),", ",(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:"Update a configuration value. The updated configuration values are persisted."}),"\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:"section"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\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.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:"defined-in-3",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L995",children:"packages/extension-api/src/extension-api.d.ts:995"})})]})}function h(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(o,{...e})}):o(e)}},43023:(e,n,i)=>{i.d(n,{R:()=>t,x:()=>c});var s=i(63696);const r={},d=s.createContext(r);function t(e){const n=s.useContext(d);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(d.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/6eafe0c7.ff9c875c.js b/assets/js/6eafe0c7.809fe20f.js similarity index 89% rename from assets/js/6eafe0c7.ff9c875c.js rename to assets/js/6eafe0c7.809fe20f.js index 1a3c94f6670..57d22a2abca 100644 --- a/assets/js/6eafe0c7.ff9c875c.js +++ b/assets/js/6eafe0c7.809fe20f.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[16256],{76741:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>c,contentTitle:()=>r,default:()=>h,frontMatter:()=>a,metadata:()=>t,toc:()=>o});var s=i(62540),d=i(43023);const a={},r="Interface: EndpointSettings",t={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"}},c={},o=[{value:"Properties",id:"properties",level:2},{value:"Aliases?",id:"aliases",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"DNSNames?",id:"dnsnames",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"DriverOpts?",id:"driveropts",level:3},{value:"Index Signature",id:"index-signature",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"EndpointID?",id:"endpointid",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"Gateway?",id:"gateway",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"GlobalIPv6Address?",id:"globalipv6address",level:3},{value:"Defined in",id:"defined-in-5",level:4},{value:"GlobalIPv6PrefixLen?",id:"globalipv6prefixlen",level:3},{value:"Defined in",id:"defined-in-6",level:4},{value:"IPAMConfig?",id:"ipamconfig",level:3},{value:"Defined in",id:"defined-in-7",level:4},{value:"IPAddress?",id:"ipaddress",level:3},{value:"Defined in",id:"defined-in-8",level:4},{value:"IPPrefixLen?",id:"ipprefixlen",level:3},{value:"Defined in",id:"defined-in-9",level:4},{value:"IPv6Gateway?",id:"ipv6gateway",level:3},{value:"Defined in",id:"defined-in-10",level:4},{value:"Links?",id:"links",level:3},{value:"Defined in",id:"defined-in-11",level:4},{value:"MacAddress?",id:"macaddress",level:3},{value:"Defined in",id:"defined-in-12",level:4},{value:"NetworkID?",id:"networkid",level:3},{value:"Defined in",id:"defined-in-13",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",p:"p",strong:"strong",...(0,d.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.header,{children:(0,s.jsx)(n.h1,{id:"interface-endpointsettings",children:"Interface: EndpointSettings"})}),"\n",(0,s.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,s.jsx)(n.h3,{id:"aliases",children:"Aliases?"}),"\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:"Aliases"}),": ",(0,s.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2777",children:"packages/extension-api/src/extension-api.d.ts:2777"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"dnsnames",children:"DNSNames?"}),"\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:"DNSNames"}),": ",(0,s.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,s.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,s.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,s.jsx)(n.code,{children:"."}),". For instance, if container name is ",(0,s.jsx)(n.code,{children:"my.ctr"})," and the network is named\n",(0,s.jsx)(n.code,{children:"testnet"}),", ",(0,s.jsx)(n.code,{children:"DNSNames"})," will contain ",(0,s.jsx)(n.code,{children:"my.ctr"})," and the FQDN will be ",(0,s.jsx)(n.code,{children:"my.ctr.testnet"}),"."]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2832",children:"packages/extension-api/src/extension-api.d.ts:2832"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"driveropts",children:"DriverOpts?"}),"\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:"DriverOpts"}),": ",(0,s.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,s.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,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:"defined-in-2",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2822",children:"packages/extension-api/src/extension-api.d.ts:2822"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"endpointid",children:"EndpointID?"}),"\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:"EndpointID"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Unique ID for the service endpoint in a Sandbox."}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-3",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2787",children:"packages/extension-api/src/extension-api.d.ts:2787"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"gateway",children:"Gateway?"}),"\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:"Gateway"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Gateway address for this network."}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-4",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2792",children:"packages/extension-api/src/extension-api.d.ts:2792"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"globalipv6address",children:"GlobalIPv6Address?"}),"\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:"GlobalIPv6Address"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Global IPv6 address."}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-5",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2812",children:"packages/extension-api/src/extension-api.d.ts:2812"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"globalipv6prefixlen",children:"GlobalIPv6PrefixLen?"}),"\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:"GlobalIPv6PrefixLen"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Mask length of the global IPv6 address."}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-6",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2817",children:"packages/extension-api/src/extension-api.d.ts:2817"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"ipamconfig",children:"IPAMConfig?"}),"\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:"IPAMConfig"}),": ",(0,s.jsx)(n.a,{href:"/api/interfaces/EndpointIPAMConfig",children:(0,s.jsx)(n.code,{children:"EndpointIPAMConfig"})})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"EndpointIPAMConfig represents an endpoint's IPAM configuration."}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-7",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2768",children:"packages/extension-api/src/extension-api.d.ts:2768"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"ipaddress",children:"IPAddress?"}),"\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:"IPAddress"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"IPv4 address."}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-8",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2797",children:"packages/extension-api/src/extension-api.d.ts:2797"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"ipprefixlen",children:"IPPrefixLen?"}),"\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:"IPPrefixLen"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Mask length of the IPv4 address."}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-9",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2802",children:"packages/extension-api/src/extension-api.d.ts:2802"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"ipv6gateway",children:"IPv6Gateway?"}),"\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:"IPv6Gateway"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"IPv6 gateway address."}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-10",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2807",children:"packages/extension-api/src/extension-api.d.ts:2807"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"links",children:"Links?"}),"\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:"Links"}),": ",(0,s.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-11",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2770",children:"packages/extension-api/src/extension-api.d.ts:2770"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"macaddress",children:"MacAddress?"}),"\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:"MacAddress"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"MAC address for the endpoint on this network. The network driver might ignore this parameter."}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-12",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2775",children:"packages/extension-api/src/extension-api.d.ts:2775"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"networkid",children:"NetworkID?"}),"\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:"NetworkID"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Unique ID of the network."}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-13",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2782",children:"packages/extension-api/src/extension-api.d.ts:2782"})})]})}function h(e={}){const{wrapper:n}={...(0,d.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},43023:(e,n,i)=>{i.d(n,{R:()=>r,x:()=>t});var s=i(63696);const d={},a=s.createContext(d);function r(e){const n=s.useContext(a);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(d):e.components||d:r(e.components),s.createElement(a.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[16256],{76741:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>c,contentTitle:()=>r,default:()=>h,frontMatter:()=>a,metadata:()=>t,toc:()=>o});var s=i(62540),d=i(43023);const a={},r="Interface: EndpointSettings",t={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"}},c={},o=[{value:"Properties",id:"properties",level:2},{value:"Aliases?",id:"aliases",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"DNSNames?",id:"dnsnames",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"DriverOpts?",id:"driveropts",level:3},{value:"Index Signature",id:"index-signature",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"EndpointID?",id:"endpointid",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"Gateway?",id:"gateway",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"GlobalIPv6Address?",id:"globalipv6address",level:3},{value:"Defined in",id:"defined-in-5",level:4},{value:"GlobalIPv6PrefixLen?",id:"globalipv6prefixlen",level:3},{value:"Defined in",id:"defined-in-6",level:4},{value:"IPAMConfig?",id:"ipamconfig",level:3},{value:"Defined in",id:"defined-in-7",level:4},{value:"IPAddress?",id:"ipaddress",level:3},{value:"Defined in",id:"defined-in-8",level:4},{value:"IPPrefixLen?",id:"ipprefixlen",level:3},{value:"Defined in",id:"defined-in-9",level:4},{value:"IPv6Gateway?",id:"ipv6gateway",level:3},{value:"Defined in",id:"defined-in-10",level:4},{value:"Links?",id:"links",level:3},{value:"Defined in",id:"defined-in-11",level:4},{value:"MacAddress?",id:"macaddress",level:3},{value:"Defined in",id:"defined-in-12",level:4},{value:"NetworkID?",id:"networkid",level:3},{value:"Defined in",id:"defined-in-13",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",p:"p",strong:"strong",...(0,d.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.header,{children:(0,s.jsx)(n.h1,{id:"interface-endpointsettings",children:"Interface: EndpointSettings"})}),"\n",(0,s.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,s.jsx)(n.h3,{id:"aliases",children:"Aliases?"}),"\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:"Aliases"}),": ",(0,s.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2777",children:"packages/extension-api/src/extension-api.d.ts:2777"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"dnsnames",children:"DNSNames?"}),"\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:"DNSNames"}),": ",(0,s.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,s.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,s.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,s.jsx)(n.code,{children:"."}),". For instance, if container name is ",(0,s.jsx)(n.code,{children:"my.ctr"})," and the network is named\n",(0,s.jsx)(n.code,{children:"testnet"}),", ",(0,s.jsx)(n.code,{children:"DNSNames"})," will contain ",(0,s.jsx)(n.code,{children:"my.ctr"})," and the FQDN will be ",(0,s.jsx)(n.code,{children:"my.ctr.testnet"}),"."]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2832",children:"packages/extension-api/src/extension-api.d.ts:2832"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"driveropts",children:"DriverOpts?"}),"\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:"DriverOpts"}),": ",(0,s.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,s.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,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:"defined-in-2",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2822",children:"packages/extension-api/src/extension-api.d.ts:2822"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"endpointid",children:"EndpointID?"}),"\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:"EndpointID"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Unique ID for the service endpoint in a Sandbox."}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-3",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2787",children:"packages/extension-api/src/extension-api.d.ts:2787"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"gateway",children:"Gateway?"}),"\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:"Gateway"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Gateway address for this network."}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-4",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2792",children:"packages/extension-api/src/extension-api.d.ts:2792"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"globalipv6address",children:"GlobalIPv6Address?"}),"\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:"GlobalIPv6Address"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Global IPv6 address."}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-5",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2812",children:"packages/extension-api/src/extension-api.d.ts:2812"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"globalipv6prefixlen",children:"GlobalIPv6PrefixLen?"}),"\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:"GlobalIPv6PrefixLen"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Mask length of the global IPv6 address."}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-6",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2817",children:"packages/extension-api/src/extension-api.d.ts:2817"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"ipamconfig",children:"IPAMConfig?"}),"\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:"IPAMConfig"}),": ",(0,s.jsx)(n.a,{href:"/api/interfaces/EndpointIPAMConfig",children:(0,s.jsx)(n.code,{children:"EndpointIPAMConfig"})})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"EndpointIPAMConfig represents an endpoint's IPAM configuration."}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-7",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2768",children:"packages/extension-api/src/extension-api.d.ts:2768"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"ipaddress",children:"IPAddress?"}),"\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:"IPAddress"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"IPv4 address."}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-8",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2797",children:"packages/extension-api/src/extension-api.d.ts:2797"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"ipprefixlen",children:"IPPrefixLen?"}),"\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:"IPPrefixLen"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Mask length of the IPv4 address."}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-9",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2802",children:"packages/extension-api/src/extension-api.d.ts:2802"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"ipv6gateway",children:"IPv6Gateway?"}),"\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:"IPv6Gateway"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"IPv6 gateway address."}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-10",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2807",children:"packages/extension-api/src/extension-api.d.ts:2807"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"links",children:"Links?"}),"\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:"Links"}),": ",(0,s.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-11",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2770",children:"packages/extension-api/src/extension-api.d.ts:2770"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"macaddress",children:"MacAddress?"}),"\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:"MacAddress"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"MAC address for the endpoint on this network. The network driver might ignore this parameter."}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-12",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2775",children:"packages/extension-api/src/extension-api.d.ts:2775"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"networkid",children:"NetworkID?"}),"\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:"NetworkID"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Unique ID of the network."}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-13",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2782",children:"packages/extension-api/src/extension-api.d.ts:2782"})})]})}function h(e={}){const{wrapper:n}={...(0,d.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},43023:(e,n,i)=>{i.d(n,{R:()=>r,x:()=>t});var s=i(63696);const d={},a=s.createContext(d);function r(e){const n=s.useContext(a);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(d):e.components||d:r(e.components),s.createElement(a.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/70bd0abb.e42ad9ff.js b/assets/js/70bd0abb.7d0969f3.js similarity index 96% rename from assets/js/70bd0abb.e42ad9ff.js rename to assets/js/70bd0abb.7d0969f3.js index ccef0d054bb..667de1b7f2d 100644 --- a/assets/js/70bd0abb.e42ad9ff.js +++ b/assets/js/70bd0abb.7d0969f3.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[44413],{14132:(e,r,i)=>{i.r(r),i.d(r,{assets:()=>d,contentTitle:()=>t,default:()=>p,frontMatter:()=>a,metadata:()=>c,toc:()=>o});var n=i(62540),s=i(43023);const a={},t="Function: createImageFilesProvider()",c={id:"namespaces/provider/functions/createImageFilesProvider",title:"Function: createImageFilesProvider()",description:"createImageFilesProvider(imageFilesCallbacks, metadata?): ImageFilesProvider",source:"@site/api/namespaces/provider/functions/createImageFilesProvider.md",sourceDirName:"namespaces/provider/functions",slug:"/namespaces/provider/functions/createImageFilesProvider",permalink:"/api/namespaces/provider/functions/createImageFilesProvider",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"provider",permalink:"/api/namespaces/provider/"},next:{title:"createProvider",permalink:"/api/namespaces/provider/functions/createProvider"}},d={},o=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Defined in",id:"defined-in",level:2}];function l(e){const r={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",strong:"strong",...(0,s.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(r.header,{children:(0,n.jsx)(r.h1,{id:"function-createimagefilesprovider",children:"Function: createImageFilesProvider()"})}),"\n",(0,n.jsxs)(r.blockquote,{children:["\n",(0,n.jsxs)(r.p,{children:[(0,n.jsx)(r.strong,{children:"createImageFilesProvider"}),"(",(0,n.jsx)(r.code,{children:"imageFilesCallbacks"}),", ",(0,n.jsx)(r.code,{children:"metadata"}),"?): ",(0,n.jsx)(r.a,{href:"/api/interfaces/ImageFilesProvider",children:(0,n.jsx)(r.code,{children:"ImageFilesProvider"})})]}),"\n"]}),"\n",(0,n.jsx)(r.p,{children:(0,n.jsx)(r.strong,{children:(0,n.jsx)(r.code,{children:"Beta"})})}),"\n",(0,n.jsx)(r.p,{children:"Register the extension as an Image Files provider."}),"\n",(0,n.jsx)(r.p,{children:"As an image files provider, a provider needs to implement a specific interface, so the core\napplication can call the provider with specific tasks when necessary."}),"\n",(0,n.jsx)(r.h2,{id:"parameters",children:"Parameters"}),"\n",(0,n.jsxs)(r.p,{children:["\u2022 ",(0,n.jsx)(r.strong,{children:"imageFilesCallbacks"}),": ",(0,n.jsx)(r.a,{href:"/api/interfaces/ImageFilesCallbacks",children:(0,n.jsx)(r.code,{children:"ImageFilesCallbacks"})})]}),"\n",(0,n.jsxs)(r.p,{children:["an object implementing the ",(0,n.jsx)(r.code,{children:"ImageFilesProvider"})," interface"]}),"\n",(0,n.jsxs)(r.p,{children:["\u2022 ",(0,n.jsx)(r.strong,{children:"metadata?"}),": ",(0,n.jsx)(r.a,{href:"/api/interfaces/ImageFilesProviderMetadata",children:(0,n.jsx)(r.code,{children:"ImageFilesProviderMetadata"})})]}),"\n",(0,n.jsx)(r.p,{children:"optional metadata attached to this provider"}),"\n",(0,n.jsx)(r.h2,{id:"returns",children:"Returns"}),"\n",(0,n.jsx)(r.p,{children:(0,n.jsx)(r.a,{href:"/api/interfaces/ImageFilesProvider",children:(0,n.jsx)(r.code,{children:"ImageFilesProvider"})})}),"\n",(0,n.jsx)(r.p,{children:"A disposable that unregisters this provider when being disposed"}),"\n",(0,n.jsx)(r.h2,{id:"defined-in",children:"Defined in"}),"\n",(0,n.jsx)(r.p,{children:(0,n.jsx)(r.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L861",children:"packages/extension-api/src/extension-api.d.ts:861"})})]})}function p(e={}){const{wrapper:r}={...(0,s.R)(),...e.components};return r?(0,n.jsx)(r,{...e,children:(0,n.jsx)(l,{...e})}):l(e)}},43023:(e,r,i)=>{i.d(r,{R:()=>t,x:()=>c});var n=i(63696);const s={},a=n.createContext(s);function t(e){const r=n.useContext(a);return n.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:t(e.components),n.createElement(a.Provider,{value:r},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[44413],{14132:(e,r,i)=>{i.r(r),i.d(r,{assets:()=>d,contentTitle:()=>t,default:()=>p,frontMatter:()=>a,metadata:()=>c,toc:()=>o});var n=i(62540),s=i(43023);const a={},t="Function: createImageFilesProvider()",c={id:"namespaces/provider/functions/createImageFilesProvider",title:"Function: createImageFilesProvider()",description:"createImageFilesProvider(imageFilesCallbacks, metadata?): ImageFilesProvider",source:"@site/api/namespaces/provider/functions/createImageFilesProvider.md",sourceDirName:"namespaces/provider/functions",slug:"/namespaces/provider/functions/createImageFilesProvider",permalink:"/api/namespaces/provider/functions/createImageFilesProvider",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"provider",permalink:"/api/namespaces/provider/"},next:{title:"createProvider",permalink:"/api/namespaces/provider/functions/createProvider"}},d={},o=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Defined in",id:"defined-in",level:2}];function l(e){const r={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",strong:"strong",...(0,s.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(r.header,{children:(0,n.jsx)(r.h1,{id:"function-createimagefilesprovider",children:"Function: createImageFilesProvider()"})}),"\n",(0,n.jsxs)(r.blockquote,{children:["\n",(0,n.jsxs)(r.p,{children:[(0,n.jsx)(r.strong,{children:"createImageFilesProvider"}),"(",(0,n.jsx)(r.code,{children:"imageFilesCallbacks"}),", ",(0,n.jsx)(r.code,{children:"metadata"}),"?): ",(0,n.jsx)(r.a,{href:"/api/interfaces/ImageFilesProvider",children:(0,n.jsx)(r.code,{children:"ImageFilesProvider"})})]}),"\n"]}),"\n",(0,n.jsx)(r.p,{children:(0,n.jsx)(r.strong,{children:(0,n.jsx)(r.code,{children:"Beta"})})}),"\n",(0,n.jsx)(r.p,{children:"Register the extension as an Image Files provider."}),"\n",(0,n.jsx)(r.p,{children:"As an image files provider, a provider needs to implement a specific interface, so the core\napplication can call the provider with specific tasks when necessary."}),"\n",(0,n.jsx)(r.h2,{id:"parameters",children:"Parameters"}),"\n",(0,n.jsxs)(r.p,{children:["\u2022 ",(0,n.jsx)(r.strong,{children:"imageFilesCallbacks"}),": ",(0,n.jsx)(r.a,{href:"/api/interfaces/ImageFilesCallbacks",children:(0,n.jsx)(r.code,{children:"ImageFilesCallbacks"})})]}),"\n",(0,n.jsxs)(r.p,{children:["an object implementing the ",(0,n.jsx)(r.code,{children:"ImageFilesProvider"})," interface"]}),"\n",(0,n.jsxs)(r.p,{children:["\u2022 ",(0,n.jsx)(r.strong,{children:"metadata?"}),": ",(0,n.jsx)(r.a,{href:"/api/interfaces/ImageFilesProviderMetadata",children:(0,n.jsx)(r.code,{children:"ImageFilesProviderMetadata"})})]}),"\n",(0,n.jsx)(r.p,{children:"optional metadata attached to this provider"}),"\n",(0,n.jsx)(r.h2,{id:"returns",children:"Returns"}),"\n",(0,n.jsx)(r.p,{children:(0,n.jsx)(r.a,{href:"/api/interfaces/ImageFilesProvider",children:(0,n.jsx)(r.code,{children:"ImageFilesProvider"})})}),"\n",(0,n.jsx)(r.p,{children:"A disposable that unregisters this provider when being disposed"}),"\n",(0,n.jsx)(r.h2,{id:"defined-in",children:"Defined in"}),"\n",(0,n.jsx)(r.p,{children:(0,n.jsx)(r.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L861",children:"packages/extension-api/src/extension-api.d.ts:861"})})]})}function p(e={}){const{wrapper:r}={...(0,s.R)(),...e.components};return r?(0,n.jsx)(r,{...e,children:(0,n.jsx)(l,{...e})}):l(e)}},43023:(e,r,i)=>{i.d(r,{R:()=>t,x:()=>c});var n=i(63696);const s={},a=n.createContext(s);function t(e){const r=n.useContext(a);return n.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:t(e.components),n.createElement(a.Provider,{value:r},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/70e3b13c.a0c340fa.js b/assets/js/70e3b13c.528cbd7c.js similarity index 95% rename from assets/js/70e3b13c.a0c340fa.js rename to assets/js/70e3b13c.528cbd7c.js index 408b6f37d9b..124dfcc6447 100644 --- a/assets/js/70e3b13c.a0c340fa.js +++ b/assets/js/70e3b13c.528cbd7c.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[13579],{58449:(e,s,r)=>{r.r(s),r.d(s,{assets:()=>o,contentTitle:()=>c,default:()=>p,frontMatter:()=>i,metadata:()=>a,toc:()=>d});var n=r(62540),t=r(43023);const i={},c="Function: registerRegistry()",a={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"}},o={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Defined in",id:"defined-in",level:2}];function l(e){const s={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",strong:"strong",...(0,t.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(s.header,{children:(0,n.jsx)(s.h1,{id:"function-registerregistry",children:"Function: registerRegistry()"})}),"\n",(0,n.jsxs)(s.blockquote,{children:["\n",(0,n.jsxs)(s.p,{children:[(0,n.jsx)(s.strong,{children:"registerRegistry"}),"(",(0,n.jsx)(s.code,{children:"registry"}),"): ",(0,n.jsx)(s.a,{href:"/api/classes/Disposable",children:(0,n.jsx)(s.code,{children:"Disposable"})})]}),"\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.a,{href:"/api/classes/Disposable",children:(0,n.jsx)(s.code,{children:"Disposable"})})}),"\n",(0,n.jsx)(s.h2,{id:"defined-in",children:"Defined in"}),"\n",(0,n.jsx)(s.p,{children:(0,n.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L923",children:"packages/extension-api/src/extension-api.d.ts:923"})})]})}function p(e={}){const{wrapper:s}={...(0,t.R)(),...e.components};return s?(0,n.jsx)(s,{...e,children:(0,n.jsx)(l,{...e})}):l(e)}},43023:(e,s,r)=>{r.d(s,{R:()=>c,x:()=>a});var n=r(63696);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 a(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([[13579],{58449:(e,s,r)=>{r.r(s),r.d(s,{assets:()=>o,contentTitle:()=>c,default:()=>p,frontMatter:()=>i,metadata:()=>a,toc:()=>d});var n=r(62540),t=r(43023);const i={},c="Function: registerRegistry()",a={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"}},o={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Defined in",id:"defined-in",level:2}];function l(e){const s={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",strong:"strong",...(0,t.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(s.header,{children:(0,n.jsx)(s.h1,{id:"function-registerregistry",children:"Function: registerRegistry()"})}),"\n",(0,n.jsxs)(s.blockquote,{children:["\n",(0,n.jsxs)(s.p,{children:[(0,n.jsx)(s.strong,{children:"registerRegistry"}),"(",(0,n.jsx)(s.code,{children:"registry"}),"): ",(0,n.jsx)(s.a,{href:"/api/classes/Disposable",children:(0,n.jsx)(s.code,{children:"Disposable"})})]}),"\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.a,{href:"/api/classes/Disposable",children:(0,n.jsx)(s.code,{children:"Disposable"})})}),"\n",(0,n.jsx)(s.h2,{id:"defined-in",children:"Defined in"}),"\n",(0,n.jsx)(s.p,{children:(0,n.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L923",children:"packages/extension-api/src/extension-api.d.ts:923"})})]})}function p(e={}){const{wrapper:s}={...(0,t.R)(),...e.components};return s?(0,n.jsx)(s,{...e,children:(0,n.jsx)(l,{...e})}):l(e)}},43023:(e,s,r)=>{r.d(s,{R:()=>c,x:()=>a});var n=r(63696);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 a(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/714e70d1.6b94b4bf.js b/assets/js/714e70d1.487b1c99.js similarity index 86% rename from assets/js/714e70d1.6b94b4bf.js rename to assets/js/714e70d1.487b1c99.js index af191401d67..b0d640ca175 100644 --- a/assets/js/714e70d1.6b94b4bf.js +++ b/assets/js/714e70d1.487b1c99.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[80714],{83502:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>o,contentTitle:()=>d,default:()=>h,frontMatter:()=>r,metadata:()=>a,toc:()=>c});var t=i(62540),s=i(43023);const r={},d="Interface: ProviderEvent",a={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"}},o={},c=[{value:"Properties",id:"properties",level:2},{value:"id",id:"id",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"name",id:"name",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"status",id:"status",level:3},{value:"Defined in",id:"defined-in-2",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",p:"p",strong:"strong",...(0,s.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.header,{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:"defined-in",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L691",children:"packages/extension-api/src/extension-api.d.ts:691"})}),"\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:"defined-in-1",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L692",children:"packages/extension-api/src/extension-api.d.ts:692"})}),"\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:"defined-in-2",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L693",children:"packages/extension-api/src/extension-api.d.ts:693"})})]})}function h(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},43023:(e,n,i)=>{i.d(n,{R:()=>d,x:()=>a});var t=i(63696);const s={},r=t.createContext(s);function d(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(s):e.components||s:d(e.components),t.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[80714],{83502:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>c,contentTitle:()=>d,default:()=>h,frontMatter:()=>r,metadata:()=>a,toc:()=>o});var t=i(62540),s=i(43023);const r={},d="Interface: ProviderEvent",a={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"}},c={},o=[{value:"Properties",id:"properties",level:2},{value:"id",id:"id",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"name",id:"name",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"status",id:"status",level:3},{value:"Defined in",id:"defined-in-2",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",p:"p",strong:"strong",...(0,s.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.header,{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:"defined-in",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L691",children:"packages/extension-api/src/extension-api.d.ts:691"})}),"\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:"defined-in-1",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L692",children:"packages/extension-api/src/extension-api.d.ts:692"})}),"\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:"defined-in-2",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L693",children:"packages/extension-api/src/extension-api.d.ts:693"})})]})}function h(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},43023:(e,n,i)=>{i.d(n,{R:()=>d,x:()=>a});var t=i(63696);const s={},r=t.createContext(s);function d(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(s):e.components||s:d(e.components),t.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/71748509.3c5b06f4.js b/assets/js/71748509.0501485a.js similarity index 95% rename from assets/js/71748509.3c5b06f4.js rename to assets/js/71748509.0501485a.js index 664bd2fd34d..81f4093e2e8 100644 --- a/assets/js/71748509.3c5b06f4.js +++ b/assets/js/71748509.0501485a.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[33294],{58950:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>a,contentTitle:()=>c,default:()=>l,frontMatter:()=>i,metadata:()=>o,toc:()=>d});var s=r(62540),t=r(43023);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:"tray",permalink:"/api/namespaces/tray/"}},a={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Defined in",id:"defined-in",level:2}];function u(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",strong:"strong",...(0,t.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.header,{children:(0,s.jsx)(n.h1,{id:"function-unregisterregistry",children:"Function: unregisterRegistry()"})}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"unregisterRegistry"}),"(",(0,s.jsx)(n.code,{children:"registry"}),"): ",(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:"registry"}),": ",(0,s.jsx)(n.a,{href:"/api/interfaces/Registry",children:(0,s.jsx)(n.code,{children:"Registry"})})]}),"\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:"defined-in",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L926",children:"packages/extension-api/src/extension-api.d.ts:926"})})]})}function l(e={}){const{wrapper:n}={...(0,t.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(u,{...e})}):u(e)}},43023:(e,n,r)=>{r.d(n,{R:()=>c,x:()=>o});var s=r(63696);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([[33294],{58950:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>a,contentTitle:()=>c,default:()=>l,frontMatter:()=>i,metadata:()=>o,toc:()=>d});var s=r(62540),t=r(43023);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:"tray",permalink:"/api/namespaces/tray/"}},a={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Defined in",id:"defined-in",level:2}];function u(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",strong:"strong",...(0,t.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.header,{children:(0,s.jsx)(n.h1,{id:"function-unregisterregistry",children:"Function: unregisterRegistry()"})}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"unregisterRegistry"}),"(",(0,s.jsx)(n.code,{children:"registry"}),"): ",(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:"registry"}),": ",(0,s.jsx)(n.a,{href:"/api/interfaces/Registry",children:(0,s.jsx)(n.code,{children:"Registry"})})]}),"\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:"defined-in",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L926",children:"packages/extension-api/src/extension-api.d.ts:926"})})]})}function l(e={}){const{wrapper:n}={...(0,t.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(u,{...e})}):u(e)}},43023:(e,n,r)=>{r.d(n,{R:()=>c,x:()=>o});var s=r(63696);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/71c7597c.64b2bda1.js b/assets/js/71c7597c.5057d28e.js similarity index 95% rename from assets/js/71c7597c.64b2bda1.js rename to assets/js/71c7597c.5057d28e.js index fc0ebad6195..336bbfe92ec 100644 --- a/assets/js/71c7597c.64b2bda1.js +++ b/assets/js/71c7597c.5057d28e.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[48909],{48468:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>a,contentTitle:()=>o,default:()=>p,frontMatter:()=>r,metadata:()=>c,toc:()=>d});var s=i(62540),t=i(43023);const r={},o="Function: removeManifest()",c={id:"namespaces/containerEngine/functions/removeManifest",title:"Function: removeManifest()",description:"removeManifest(engineId, id): Promise\\",source:"@site/api/namespaces/containerEngine/functions/removeManifest.md",sourceDirName:"namespaces/containerEngine/functions",slug:"/namespaces/containerEngine/functions/removeManifest",permalink:"/api/namespaces/containerEngine/functions/removeManifest",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"pushManifest",permalink:"/api/namespaces/containerEngine/functions/pushManifest"},next:{title:"removePod",permalink:"/api/namespaces/containerEngine/functions/removePod"}},a={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Defined in",id:"defined-in",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",strong:"strong",...(0,t.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.header,{children:(0,s.jsx)(n.h1,{id:"function-removemanifest",children:"Function: removeManifest()"})}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"removeManifest"}),"(",(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.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:"id"}),": ",(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:"defined-in",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L3695",children:"packages/extension-api/src/extension-api.d.ts:3695"})})]})}function p(e={}){const{wrapper:n}={...(0,t.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},43023:(e,n,i)=>{i.d(n,{R:()=>o,x:()=>c});var s=i(63696);const t={},r=s.createContext(t);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(t):e.components||t:o(e.components),s.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[48909],{48468:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>a,contentTitle:()=>o,default:()=>p,frontMatter:()=>r,metadata:()=>c,toc:()=>d});var s=i(62540),t=i(43023);const r={},o="Function: removeManifest()",c={id:"namespaces/containerEngine/functions/removeManifest",title:"Function: removeManifest()",description:"removeManifest(engineId, id): Promise\\",source:"@site/api/namespaces/containerEngine/functions/removeManifest.md",sourceDirName:"namespaces/containerEngine/functions",slug:"/namespaces/containerEngine/functions/removeManifest",permalink:"/api/namespaces/containerEngine/functions/removeManifest",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"pushManifest",permalink:"/api/namespaces/containerEngine/functions/pushManifest"},next:{title:"removePod",permalink:"/api/namespaces/containerEngine/functions/removePod"}},a={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Defined in",id:"defined-in",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",strong:"strong",...(0,t.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.header,{children:(0,s.jsx)(n.h1,{id:"function-removemanifest",children:"Function: removeManifest()"})}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"removeManifest"}),"(",(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.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:"id"}),": ",(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:"defined-in",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L3695",children:"packages/extension-api/src/extension-api.d.ts:3695"})})]})}function p(e={}){const{wrapper:n}={...(0,t.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},43023:(e,n,i)=>{i.d(n,{R:()=>o,x:()=>c});var s=i(63696);const t={},r=s.createContext(t);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(t):e.components||t:o(e.components),s.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/7258860f.8f8035ab.js b/assets/js/7258860f.30af2c7f.js similarity index 97% rename from assets/js/7258860f.8f8035ab.js rename to assets/js/7258860f.30af2c7f.js index c86272eb63a..63c61751735 100644 --- a/assets/js/7258860f.8f8035ab.js +++ b/assets/js/7258860f.30af2c7f.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[1603],{78863:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>c,contentTitle:()=>r,default:()=>h,frontMatter:()=>o,metadata:()=>a,toc:()=>d});var t=i(62540),s=i(43023);const o={},r="Function: logsContainer()",a={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"}},c={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Defined in",id:"defined-in",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",strong:"strong",...(0,s.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.header,{children:(0,t.jsx)(n.h1,{id:"function-logscontainer",children:"Function: logsContainer()"})}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"logsContainer"}),"(",(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.code,{children:"void"}),">"]}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"Get the streamed logs of a 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 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.jsxs)(n.p,{children:["the function called when new logs are emitted or new events happen on the stream. The value of ",(0,t.jsx)(n.code,{children:"name"})," can be either ",(0,t.jsx)(n.code,{children:"data"})," (and ",(0,t.jsx)(n.code,{children:"data"})," contains the logs), or ",(0,t.jsx)(n.code,{children:"end"})," indicating the end of the stream, or ",(0,t.jsx)(n.code,{children:"first-message"})," indicating no data has been emitted yet on the stream."]}),"\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:"defined-in",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L3501",children:"packages/extension-api/src/extension-api.d.ts:3501"})})]})}function h(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},43023:(e,n,i)=>{i.d(n,{R:()=>r,x:()=>a});var t=i(63696);const s={},o=t.createContext(s);function r(e){const n=t.useContext(o);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function a(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:r(e.components),t.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[1603],{78863:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>c,contentTitle:()=>r,default:()=>h,frontMatter:()=>o,metadata:()=>a,toc:()=>d});var t=i(62540),s=i(43023);const o={},r="Function: logsContainer()",a={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"}},c={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Defined in",id:"defined-in",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",strong:"strong",...(0,s.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.header,{children:(0,t.jsx)(n.h1,{id:"function-logscontainer",children:"Function: logsContainer()"})}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"logsContainer"}),"(",(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.code,{children:"void"}),">"]}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"Get the streamed logs of a 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 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.jsxs)(n.p,{children:["the function called when new logs are emitted or new events happen on the stream. The value of ",(0,t.jsx)(n.code,{children:"name"})," can be either ",(0,t.jsx)(n.code,{children:"data"})," (and ",(0,t.jsx)(n.code,{children:"data"})," contains the logs), or ",(0,t.jsx)(n.code,{children:"end"})," indicating the end of the stream, or ",(0,t.jsx)(n.code,{children:"first-message"})," indicating no data has been emitted yet on the stream."]}),"\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:"defined-in",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L3501",children:"packages/extension-api/src/extension-api.d.ts:3501"})})]})}function h(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},43023:(e,n,i)=>{i.d(n,{R:()=>r,x:()=>a});var t=i(63696);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/73f18a6f.61b096b7.js b/assets/js/73f18a6f.105a4bda.js similarity index 95% rename from assets/js/73f18a6f.61b096b7.js rename to assets/js/73f18a6f.105a4bda.js index d1dd9217f41..094fba42ba5 100644 --- a/assets/js/73f18a6f.61b096b7.js +++ b/assets/js/73f18a6f.105a4bda.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[73267],{87276:(e,r,n)=>{n.r(r),n.d(r,{assets:()=>a,contentTitle:()=>s,default:()=>l,frontMatter:()=>o,metadata:()=>c,toc:()=>d});var i=n(62540),t=n(43023);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:"createImageFilesProvider",permalink:"/api/namespaces/provider/functions/createImageFilesProvider"},next:{title:"getContainerConnections",permalink:"/api/namespaces/provider/functions/getContainerConnections"}},a={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Defined in",id:"defined-in",level:2}];function p(e){const r={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",strong:"strong",...(0,t.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(r.header,{children:(0,i.jsx)(r.h1,{id:"function-createprovider",children:"Function: createProvider()"})}),"\n",(0,i.jsxs)(r.blockquote,{children:["\n",(0,i.jsxs)(r.p,{children:[(0,i.jsx)(r.strong,{children:"createProvider"}),"(",(0,i.jsx)(r.code,{children:"provider"}),"): ",(0,i.jsx)(r.a,{href:"/api/interfaces/Provider",children:(0,i.jsx)(r.code,{children:"Provider"})})]}),"\n"]}),"\n",(0,i.jsx)(r.h2,{id:"parameters",children:"Parameters"}),"\n",(0,i.jsxs)(r.p,{children:["\u2022 ",(0,i.jsx)(r.strong,{children:"provider"}),": ",(0,i.jsx)(r.a,{href:"/api/interfaces/ProviderOptions",children:(0,i.jsx)(r.code,{children:"ProviderOptions"})})]}),"\n",(0,i.jsx)(r.h2,{id:"returns",children:"Returns"}),"\n",(0,i.jsx)(r.p,{children:(0,i.jsx)(r.a,{href:"/api/interfaces/Provider",children:(0,i.jsx)(r.code,{children:"Provider"})})}),"\n",(0,i.jsx)(r.h2,{id:"defined-in",children:"Defined in"}),"\n",(0,i.jsx)(r.p,{children:(0,i.jsx)(r.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L831",children:"packages/extension-api/src/extension-api.d.ts:831"})})]})}function l(e={}){const{wrapper:r}={...(0,t.R)(),...e.components};return r?(0,i.jsx)(r,{...e,children:(0,i.jsx)(p,{...e})}):p(e)}},43023:(e,r,n)=>{n.d(r,{R:()=>s,x:()=>c});var i=n(63696);const t={},o=i.createContext(t);function s(e){const r=i.useContext(o);return i.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(t):e.components||t:s(e.components),i.createElement(o.Provider,{value:r},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[73267],{87276:(e,r,n)=>{n.r(r),n.d(r,{assets:()=>a,contentTitle:()=>s,default:()=>l,frontMatter:()=>o,metadata:()=>c,toc:()=>d});var i=n(62540),t=n(43023);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:"createImageFilesProvider",permalink:"/api/namespaces/provider/functions/createImageFilesProvider"},next:{title:"getContainerConnections",permalink:"/api/namespaces/provider/functions/getContainerConnections"}},a={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Defined in",id:"defined-in",level:2}];function p(e){const r={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",strong:"strong",...(0,t.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(r.header,{children:(0,i.jsx)(r.h1,{id:"function-createprovider",children:"Function: createProvider()"})}),"\n",(0,i.jsxs)(r.blockquote,{children:["\n",(0,i.jsxs)(r.p,{children:[(0,i.jsx)(r.strong,{children:"createProvider"}),"(",(0,i.jsx)(r.code,{children:"provider"}),"): ",(0,i.jsx)(r.a,{href:"/api/interfaces/Provider",children:(0,i.jsx)(r.code,{children:"Provider"})})]}),"\n"]}),"\n",(0,i.jsx)(r.h2,{id:"parameters",children:"Parameters"}),"\n",(0,i.jsxs)(r.p,{children:["\u2022 ",(0,i.jsx)(r.strong,{children:"provider"}),": ",(0,i.jsx)(r.a,{href:"/api/interfaces/ProviderOptions",children:(0,i.jsx)(r.code,{children:"ProviderOptions"})})]}),"\n",(0,i.jsx)(r.h2,{id:"returns",children:"Returns"}),"\n",(0,i.jsx)(r.p,{children:(0,i.jsx)(r.a,{href:"/api/interfaces/Provider",children:(0,i.jsx)(r.code,{children:"Provider"})})}),"\n",(0,i.jsx)(r.h2,{id:"defined-in",children:"Defined in"}),"\n",(0,i.jsx)(r.p,{children:(0,i.jsx)(r.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L831",children:"packages/extension-api/src/extension-api.d.ts:831"})})]})}function l(e={}){const{wrapper:r}={...(0,t.R)(),...e.components};return r?(0,i.jsx)(r,{...e,children:(0,i.jsx)(p,{...e})}):p(e)}},43023:(e,r,n)=>{n.d(r,{R:()=>s,x:()=>c});var i=n(63696);const t={},o=i.createContext(t);function s(e){const r=i.useContext(o);return i.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(t):e.components||t:s(e.components),i.createElement(o.Provider,{value:r},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/73f9658e.ab7eb03f.js b/assets/js/73f9658e.5ae8f46f.js similarity index 98% rename from assets/js/73f9658e.ab7eb03f.js rename to assets/js/73f9658e.5ae8f46f.js index a7c306c1126..a3f1c041586 100644 --- a/assets/js/73f9658e.ab7eb03f.js +++ b/assets/js/73f9658e.5ae8f46f.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[89904],{56792:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>o,contentTitle:()=>r,default:()=>l,frontMatter:()=>a,metadata:()=>c,toc:()=>d});var i=s(62540),t=s(43023);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:"pushManifest",permalink:"/api/namespaces/containerEngine/functions/pushManifest"}},o={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Defined in",id:"defined-in",level:2}];function h(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",strong:"strong",...(0,t.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.header,{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:"defined-in",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L3611",children:"packages/extension-api/src/extension-api.d.ts:3611"})})]})}function l(e={}){const{wrapper:n}={...(0,t.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(h,{...e})}):h(e)}},43023:(e,n,s)=>{s.d(n,{R:()=>r,x:()=>c});var i=s(63696);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([[89904],{56792:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>o,contentTitle:()=>r,default:()=>l,frontMatter:()=>a,metadata:()=>c,toc:()=>d});var i=s(62540),t=s(43023);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:"pushManifest",permalink:"/api/namespaces/containerEngine/functions/pushManifest"}},o={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Defined in",id:"defined-in",level:2}];function h(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",strong:"strong",...(0,t.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.header,{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:"defined-in",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L3611",children:"packages/extension-api/src/extension-api.d.ts:3611"})})]})}function l(e={}){const{wrapper:n}={...(0,t.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(h,{...e})}):h(e)}},43023:(e,n,s)=>{s.d(n,{R:()=>r,x:()=>c});var i=s(63696);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.9add0cab.js b/assets/js/74b658de.a150bc7e.js similarity index 95% rename from assets/js/74b658de.9add0cab.js rename to assets/js/74b658de.a150bc7e.js index 698666ce47f..dfdfd427c5d 100644 --- a/assets/js/74b658de.9add0cab.js +++ b/assets/js/74b658de.a150bc7e.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[23960],{19574:(e,n,o)=>{o.r(n),o.d(n,{assets:()=>d,contentTitle:()=>t,default:()=>p,frontMatter:()=>s,metadata:()=>c,toc:()=>a});var i=o(62540),r=o(43023);const s={},t="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:"removeManifest",permalink:"/api/namespaces/containerEngine/functions/removeManifest"},next:{title:"replicatePodmanContainer",permalink:"/api/namespaces/containerEngine/functions/replicatePodmanContainer"}},d={},a=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Defined in",id:"defined-in",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",strong:"strong",...(0,r.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.header,{children:(0,i.jsx)(n.h1,{id:"function-removepod",children:"Function: removePod()"})}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"removePod"}),"(",(0,i.jsx)(n.code,{children:"engineId"}),", ",(0,i.jsx)(n.code,{children:"podId"}),"): ",(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:"engineId"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"podId"}),": ",(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:"defined-in",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L3689",children:"packages/extension-api/src/extension-api.d.ts:3689"})})]})}function p(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},43023:(e,n,o)=>{o.d(n,{R:()=>t,x:()=>c});var i=o(63696);const r={},s=i.createContext(r);function t(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(r):e.components||r:t(e.components),i.createElement(s.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[23960],{19574:(e,n,o)=>{o.r(n),o.d(n,{assets:()=>d,contentTitle:()=>t,default:()=>p,frontMatter:()=>s,metadata:()=>c,toc:()=>a});var i=o(62540),r=o(43023);const s={},t="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:"removeManifest",permalink:"/api/namespaces/containerEngine/functions/removeManifest"},next:{title:"replicatePodmanContainer",permalink:"/api/namespaces/containerEngine/functions/replicatePodmanContainer"}},d={},a=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Defined in",id:"defined-in",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",strong:"strong",...(0,r.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.header,{children:(0,i.jsx)(n.h1,{id:"function-removepod",children:"Function: removePod()"})}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"removePod"}),"(",(0,i.jsx)(n.code,{children:"engineId"}),", ",(0,i.jsx)(n.code,{children:"podId"}),"): ",(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:"engineId"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"podId"}),": ",(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:"defined-in",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L3689",children:"packages/extension-api/src/extension-api.d.ts:3689"})})]})}function p(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},43023:(e,n,o)=>{o.d(n,{R:()=>t,x:()=>c});var i=o(63696);const r={},s=i.createContext(r);function t(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(r):e.components||r:t(e.components),i.createElement(s.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/7500e360.8a2b8f41.js b/assets/js/7500e360.288552aa.js similarity index 96% rename from assets/js/7500e360.8a2b8f41.js rename to assets/js/7500e360.288552aa.js index 7063cee145f..820bf6d243b 100644 --- a/assets/js/7500e360.8a2b8f41.js +++ b/assets/js/7500e360.288552aa.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[53225],{22798:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>c,contentTitle:()=>a,default:()=>h,frontMatter:()=>t,metadata:()=>r,toc:()=>d});var i=s(62540),o=s(43023);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:"Defined in",id:"defined-in",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",strong:"strong",...(0,o.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.header,{children:(0,i.jsx)(n.h1,{id:"function-showsavedialog",children:"Function: showSaveDialog()"})}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"showSaveDialog"}),"(",(0,i.jsx)(n.code,{children:"options"}),"?): ",(0,i.jsx)(n.code,{children:"Promise"}),"<",(0,i.jsx)(n.a,{href:"/api/classes/Uri",children:(0,i.jsx)(n.code,{children:"Uri"})})," | ",(0,i.jsx)(n.code,{children:"undefined"}),">"]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Shows a file save dialog to the user which allows to select a file\nfor saving-purposes."}),"\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/SaveDialogOptions",children:(0,i.jsx)(n.code,{children:"SaveDialogOptions"})})]}),"\n",(0,i.jsx)(n.p,{children:"Options that control the dialog."}),"\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/classes/Uri",children:(0,i.jsx)(n.code,{children:"Uri"})})," | ",(0,i.jsx)(n.code,{children:"undefined"}),">"]}),"\n",(0,i.jsxs)(n.p,{children:["A promise that resolves to the selected resource or ",(0,i.jsx)(n.code,{children:"undefined"}),"."]}),"\n",(0,i.jsx)(n.h2,{id:"defined-in",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2023",children:"packages/extension-api/src/extension-api.d.ts:2023"})})]})}function h(e={}){const{wrapper:n}={...(0,o.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},43023:(e,n,s)=>{s.d(n,{R:()=>a,x:()=>r});var i=s(63696);const o={},t=i.createContext(o);function a(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:a(e.components),i.createElement(t.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[53225],{22798:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>c,contentTitle:()=>a,default:()=>h,frontMatter:()=>t,metadata:()=>r,toc:()=>d});var i=s(62540),o=s(43023);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:"Defined in",id:"defined-in",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",strong:"strong",...(0,o.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.header,{children:(0,i.jsx)(n.h1,{id:"function-showsavedialog",children:"Function: showSaveDialog()"})}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"showSaveDialog"}),"(",(0,i.jsx)(n.code,{children:"options"}),"?): ",(0,i.jsx)(n.code,{children:"Promise"}),"<",(0,i.jsx)(n.a,{href:"/api/classes/Uri",children:(0,i.jsx)(n.code,{children:"Uri"})})," | ",(0,i.jsx)(n.code,{children:"undefined"}),">"]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Shows a file save dialog to the user which allows to select a file\nfor saving-purposes."}),"\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/SaveDialogOptions",children:(0,i.jsx)(n.code,{children:"SaveDialogOptions"})})]}),"\n",(0,i.jsx)(n.p,{children:"Options that control the dialog."}),"\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/classes/Uri",children:(0,i.jsx)(n.code,{children:"Uri"})})," | ",(0,i.jsx)(n.code,{children:"undefined"}),">"]}),"\n",(0,i.jsxs)(n.p,{children:["A promise that resolves to the selected resource or ",(0,i.jsx)(n.code,{children:"undefined"}),"."]}),"\n",(0,i.jsx)(n.h2,{id:"defined-in",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2023",children:"packages/extension-api/src/extension-api.d.ts:2023"})})]})}function h(e={}){const{wrapper:n}={...(0,o.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},43023:(e,n,s)=>{s.d(n,{R:()=>a,x:()=>r});var i=s(63696);const o={},t=i.createContext(o);function a(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:a(e.components),i.createElement(t.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/7547d3bb.e2429649.js b/assets/js/7547d3bb.bc3984f2.js similarity index 97% rename from assets/js/7547d3bb.e2429649.js rename to assets/js/7547d3bb.bc3984f2.js index bb6b69fe25d..69aea03b649 100644 --- a/assets/js/7547d3bb.e2429649.js +++ b/assets/js/7547d3bb.bc3984f2.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[35111],{45082:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>a,contentTitle:()=>s,default:()=>p,frontMatter:()=>o,metadata:()=>c,toc:()=>d});var t=r(62540),i=r(43023);const o={},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:"Defined in",id:"defined-in",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",p:"p",strong:"strong",...(0,i.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.header,{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:"defined-in",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L585",children:"packages/extension-api/src/extension-api.d.ts:585"})})]})}function p(e={}){const{wrapper:n}={...(0,i.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},43023:(e,n,r)=>{r.d(n,{R:()=>s,x:()=>c});var t=r(63696);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([[35111],{45082:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>a,contentTitle:()=>s,default:()=>p,frontMatter:()=>o,metadata:()=>c,toc:()=>d});var t=r(62540),i=r(43023);const o={},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:"Defined in",id:"defined-in",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",p:"p",strong:"strong",...(0,i.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.header,{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:"defined-in",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L585",children:"packages/extension-api/src/extension-api.d.ts:585"})})]})}function p(e={}){const{wrapper:n}={...(0,i.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},43023:(e,n,r)=>{r.d(n,{R:()=>s,x:()=>c});var t=r(63696);const i={},o=t.createContext(i);function s(e){const n=t.useContext(o);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:s(e.components),t.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/786fee93.29544406.js b/assets/js/786fee93.5c81ae7e.js similarity index 94% rename from assets/js/786fee93.29544406.js rename to assets/js/786fee93.5c81ae7e.js index 5b9b03b8f9c..c0181378b39 100644 --- a/assets/js/786fee93.29544406.js +++ b/assets/js/786fee93.5c81ae7e.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[43140],{71529:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>o,contentTitle:()=>r,default:()=>u,frontMatter:()=>t,metadata:()=>c,toc:()=>l});var s=i(62540),a=i(43023);const t={},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:"Defined in",id:"defined-in",level:2}];function d(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",strong:"strong",...(0,a.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.header,{children:(0,s.jsx)(n.h1,{id:"variable-islinux",children:"Variable: isLinux"})}),"\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:"isLinux"}),": ",(0,s.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Flag indicating whether we are running on a Linux operating system."}),"\n",(0,s.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,s.jsx)(n.h2,{id:"defined-in",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L3992",children:"packages/extension-api/src/extension-api.d.ts:3992"})})]})}function u(e={}){const{wrapper:n}={...(0,a.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(d,{...e})}):d(e)}},43023:(e,n,i)=>{i.d(n,{R:()=>r,x:()=>c});var s=i(63696);const a={},t=s.createContext(a);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(a):e.components||a:r(e.components),s.createElement(t.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[43140],{71529:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>o,contentTitle:()=>r,default:()=>u,frontMatter:()=>t,metadata:()=>c,toc:()=>l});var s=i(62540),a=i(43023);const t={},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:"Defined in",id:"defined-in",level:2}];function d(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",strong:"strong",...(0,a.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.header,{children:(0,s.jsx)(n.h1,{id:"variable-islinux",children:"Variable: isLinux"})}),"\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:"isLinux"}),": ",(0,s.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Flag indicating whether we are running on a Linux operating system."}),"\n",(0,s.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,s.jsx)(n.h2,{id:"defined-in",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L3992",children:"packages/extension-api/src/extension-api.d.ts:3992"})})]})}function u(e={}){const{wrapper:n}={...(0,a.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(d,{...e})}):d(e)}},43023:(e,n,i)=>{i.d(n,{R:()=>r,x:()=>c});var s=i(63696);const a={},t=s.createContext(a);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(a):e.components||a:r(e.components),s.createElement(t.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/79f18c88.9d03dc1c.js b/assets/js/79f18c88.8893bdd6.js similarity index 94% rename from assets/js/79f18c88.9d03dc1c.js rename to assets/js/79f18c88.8893bdd6.js index 9e995f8152a..48364e1589a 100644 --- a/assets/js/79f18c88.9d03dc1c.js +++ b/assets/js/79f18c88.8893bdd6.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[68171],{10980:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>o,contentTitle:()=>a,default:()=>h,frontMatter:()=>r,metadata:()=>d,toc:()=>c});var s=i(62540),t=i(43023);const r={},a="Interface: ContainerAuthInfo",d={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"}},o={},c=[{value:"Properties",id:"properties",level:2},{value:"email?",id:"email",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"password",id:"password",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"serveraddress",id:"serveraddress",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"username",id:"username",level:3},{value:"Defined in",id:"defined-in-3",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",p:"p",strong:"strong",...(0,t.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.header,{children:(0,s.jsx)(n.h1,{id:"interface-containerauthinfo",children:"Interface: ContainerAuthInfo"})}),"\n",(0,s.jsx)(n.p,{children:"Authentication credentials, used when pushing an image to a registry"}),"\n",(0,s.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,s.jsx)(n.h3,{id:"email",children:"email?"}),"\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:"email"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2678",children:"packages/extension-api/src/extension-api.d.ts:2678"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"password",children:"password"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"password"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2676",children:"packages/extension-api/src/extension-api.d.ts:2676"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"serveraddress",children:"serveraddress"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"serveraddress"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-2",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2677",children:"packages/extension-api/src/extension-api.d.ts:2677"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"username",children:"username"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"username"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-3",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2675",children:"packages/extension-api/src/extension-api.d.ts:2675"})})]})}function h(e={}){const{wrapper:n}={...(0,t.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},43023:(e,n,i)=>{i.d(n,{R:()=>a,x:()=>d});var s=i(63696);const t={},r=s.createContext(t);function a(e){const n=s.useContext(r);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:a(e.components),s.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[68171],{10980:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>o,contentTitle:()=>a,default:()=>h,frontMatter:()=>r,metadata:()=>d,toc:()=>c});var s=i(62540),t=i(43023);const r={},a="Interface: ContainerAuthInfo",d={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"}},o={},c=[{value:"Properties",id:"properties",level:2},{value:"email?",id:"email",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"password",id:"password",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"serveraddress",id:"serveraddress",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"username",id:"username",level:3},{value:"Defined in",id:"defined-in-3",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",p:"p",strong:"strong",...(0,t.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.header,{children:(0,s.jsx)(n.h1,{id:"interface-containerauthinfo",children:"Interface: ContainerAuthInfo"})}),"\n",(0,s.jsx)(n.p,{children:"Authentication credentials, used when pushing an image to a registry"}),"\n",(0,s.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,s.jsx)(n.h3,{id:"email",children:"email?"}),"\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:"email"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2678",children:"packages/extension-api/src/extension-api.d.ts:2678"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"password",children:"password"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"password"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2676",children:"packages/extension-api/src/extension-api.d.ts:2676"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"serveraddress",children:"serveraddress"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"serveraddress"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-2",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2677",children:"packages/extension-api/src/extension-api.d.ts:2677"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"username",children:"username"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"username"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-3",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2675",children:"packages/extension-api/src/extension-api.d.ts:2675"})})]})}function h(e={}){const{wrapper:n}={...(0,t.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},43023:(e,n,i)=>{i.d(n,{R:()=>a,x:()=>d});var s=i(63696);const t={},r=s.createContext(t);function a(e){const n=s.useContext(r);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:a(e.components),s.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/7aa856d6.48ac0baa.js b/assets/js/7aa856d6.f065ff33.js similarity index 93% rename from assets/js/7aa856d6.48ac0baa.js rename to assets/js/7aa856d6.f065ff33.js index 37aec72c117..0507e49d58d 100644 --- a/assets/js/7aa856d6.48ac0baa.js +++ b/assets/js/7aa856d6.f065ff33.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[54727],{5630:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>c,contentTitle:()=>o,default:()=>p,frontMatter:()=>i,metadata:()=>a,toc:()=>d});var r=t(62540),s=t(43023);const i={},o="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={},d=[{value:"Defined in",id:"defined-in",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",strong:"strong",...(0,s.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.header,{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:"defined-in",children:"Defined in"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L42",children:"packages/extension-api/src/extension-api.d.ts:42"})})]})}function p(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(l,{...e})}):l(e)}},43023:(e,n,t)=>{t.d(n,{R:()=>o,x:()=>a});var r=t(63696);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 a(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 +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[54727],{5630:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>c,contentTitle:()=>o,default:()=>p,frontMatter:()=>i,metadata:()=>a,toc:()=>d});var r=t(62540),s=t(43023);const i={},o="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={},d=[{value:"Defined in",id:"defined-in",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",strong:"strong",...(0,s.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.header,{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:"defined-in",children:"Defined in"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L42",children:"packages/extension-api/src/extension-api.d.ts:42"})})]})}function p(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(l,{...e})}):l(e)}},43023:(e,n,t)=>{t.d(n,{R:()=>o,x:()=>a});var r=t(63696);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 a(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/7bef3f04.3cac711d.js b/assets/js/7bef3f04.1dd7488d.js similarity index 98% rename from assets/js/7bef3f04.3cac711d.js rename to assets/js/7bef3f04.1dd7488d.js index d2f07b0afdd..8a8ef07f65e 100644 --- a/assets/js/7bef3f04.3cac711d.js +++ b/assets/js/7bef3f04.1dd7488d.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[70542],{47671:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>a,contentTitle:()=>o,default:()=>p,frontMatter:()=>r,metadata:()=>c,toc:()=>d});var s=i(62540),t=i(43023);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:"Defined in",id:"defined-in",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",strong:"strong",...(0,t.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.header,{children:(0,s.jsx)(n.h1,{id:"function-ondidregistercontainerconnection",children:"Function: onDidRegisterContainerConnection()"})}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"onDidRegisterContainerConnection"}),"(",(0,s.jsx)(n.code,{children:"listener"}),", ",(0,s.jsx)(n.code,{children:"thisArgs"}),"?, ",(0,s.jsx)(n.code,{children:"disposables"}),"?): ",(0,s.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,s.jsx)(n.code,{children:"Disposable"})})]}),"\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:"listener"})]}),"\n",(0,s.jsx)(n.p,{children:"The listener function will be called when the event happens."}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"thisArgs?"}),": ",(0,s.jsx)(n.code,{children:"any"})]}),"\n",(0,s.jsxs)(n.p,{children:["The ",(0,s.jsx)(n.code,{children:"this"}),"-argument which will be used when calling the event listener."]}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"disposables?"}),": ",(0,s.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,s.jsx)(n.code,{children:"Disposable"})}),"[]"]}),"\n",(0,s.jsxs)(n.p,{children:["An array to which a ",(0,s.jsx)(n.a,{href:"/api/classes/Disposable",children:"Disposable"})," will be added."]}),"\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.p,{children:"A disposable which unsubscribes the event listener."}),"\n",(0,s.jsx)(n.h2,{id:"defined-in",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L836",children:"packages/extension-api/src/extension-api.d.ts:836"})})]})}function p(e={}){const{wrapper:n}={...(0,t.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},43023:(e,n,i)=>{i.d(n,{R:()=>o,x:()=>c});var s=i(63696);const t={},r=s.createContext(t);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(t):e.components||t:o(e.components),s.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[70542],{47671:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>a,contentTitle:()=>o,default:()=>p,frontMatter:()=>r,metadata:()=>c,toc:()=>d});var s=i(62540),t=i(43023);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:"Defined in",id:"defined-in",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",strong:"strong",...(0,t.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.header,{children:(0,s.jsx)(n.h1,{id:"function-ondidregistercontainerconnection",children:"Function: onDidRegisterContainerConnection()"})}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"onDidRegisterContainerConnection"}),"(",(0,s.jsx)(n.code,{children:"listener"}),", ",(0,s.jsx)(n.code,{children:"thisArgs"}),"?, ",(0,s.jsx)(n.code,{children:"disposables"}),"?): ",(0,s.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,s.jsx)(n.code,{children:"Disposable"})})]}),"\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:"listener"})]}),"\n",(0,s.jsx)(n.p,{children:"The listener function will be called when the event happens."}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"thisArgs?"}),": ",(0,s.jsx)(n.code,{children:"any"})]}),"\n",(0,s.jsxs)(n.p,{children:["The ",(0,s.jsx)(n.code,{children:"this"}),"-argument which will be used when calling the event listener."]}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"disposables?"}),": ",(0,s.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,s.jsx)(n.code,{children:"Disposable"})}),"[]"]}),"\n",(0,s.jsxs)(n.p,{children:["An array to which a ",(0,s.jsx)(n.a,{href:"/api/classes/Disposable",children:"Disposable"})," will be added."]}),"\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.p,{children:"A disposable which unsubscribes the event listener."}),"\n",(0,s.jsx)(n.h2,{id:"defined-in",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L836",children:"packages/extension-api/src/extension-api.d.ts:836"})})]})}function p(e={}){const{wrapper:n}={...(0,t.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},43023:(e,n,i)=>{i.d(n,{R:()=>o,x:()=>c});var s=i(63696);const t={},r=s.createContext(t);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(t):e.components||t:o(e.components),s.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/7c7a772e.8b9f5fad.js b/assets/js/7c7a772e.62b54e2d.js similarity index 91% rename from assets/js/7c7a772e.8b9f5fad.js rename to assets/js/7c7a772e.62b54e2d.js index 5a7a9f51cc2..d33d6d329a8 100644 --- a/assets/js/7c7a772e.8b9f5fad.js +++ b/assets/js/7c7a772e.62b54e2d.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[38788],{24902:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>r,contentTitle:()=>t,default:()=>h,frontMatter:()=>a,metadata:()=>c,toc:()=>l});var s=i(62540),d=i(43023);const a={},t="Interface: WebviewPanel",c={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"}},r={},l=[{value:"Properties",id:"properties",level:2},{value:"active",id:"active",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"iconPath?",id:"iconpath",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"onDidChangeViewState",id:"ondidchangeviewstate",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"onDidDispose",id:"ondiddispose",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"title",id:"title",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"viewType",id:"viewtype",level:3},{value:"Defined in",id:"defined-in-5",level:4},{value:"visible",id:"visible",level:3},{value:"Defined in",id:"defined-in-6",level:4},{value:"webview",id:"webview",level:3},{value:"Defined in",id:"defined-in-7",level:4},{value:"Methods",id:"methods",level:2},{value:"dispose()",id:"dispose",level:3},{value:"Returns",id:"returns",level:4},{value:"Defined in",id:"defined-in-8",level:4},{value:"reveal()",id:"reveal",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Defined in",id:"defined-in-9",level:4}];function o(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",p:"p",strong:"strong",...(0,d.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.header,{children:(0,s.jsx)(n.h1,{id:"interface-webviewpanel",children:"Interface: WebviewPanel"})}),"\n",(0,s.jsx)(n.p,{children:"A panel that contains a webview."}),"\n",(0,s.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,s.jsx)(n.h3,{id:"active",children:"active"}),"\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:"active"}),": ",(0,s.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Whether the panel is active (focused by the user)."}),"\n",(0,s.jsx)(n.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L1774",children:"packages/extension-api/src/extension-api.d.ts:1774"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"iconpath",children:"iconPath?"}),"\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:"iconPath"}),": ",(0,s.jsx)(n.a,{href:"/api/classes/Uri",children:(0,s.jsx)(n.code,{children:"Uri"})})," | ",(0,s.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Icon for the panel shown in UI."}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L1753",children:"packages/extension-api/src/extension-api.d.ts:1753"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"ondidchangeviewstate",children:"onDidChangeViewState"}),"\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:"onDidChangeViewState"}),": ",(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/WebviewPanelOnDidChangeViewStateEvent",children:(0,s.jsx)(n.code,{children:"WebviewPanelOnDidChangeViewStateEvent"})}),">"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Fired when the panel's view state changes."}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-2",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L1784",children:"packages/extension-api/src/extension-api.d.ts:1784"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"ondiddispose",children:"onDidDispose"}),"\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:"onDidDispose"}),": ",(0,s.jsx)(n.a,{href:"/api/interfaces/Event",children:(0,s.jsx)(n.code,{children:"Event"})}),"<",(0,s.jsx)(n.code,{children:"void"}),">"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Fired when the panel is disposed."}),"\n",(0,s.jsxs)(n.p,{children:["This may be because the user closed the panel or because ",(0,s.jsx)(n.code,{children:".dispose()"})," was\ncalled on it."]}),"\n",(0,s.jsx)(n.p,{children:"Trying to use the panel after it has been disposed throws an exception."}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-3",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L1794",children:"packages/extension-api/src/extension-api.d.ts:1794"})}),"\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.p,{children:"Title of the panel shown in UI."}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-4",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L1748",children:"packages/extension-api/src/extension-api.d.ts:1748"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"viewtype",children:"viewType"}),"\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:"viewType"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Identifies the type of the webview panel."}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-5",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L1743",children:"packages/extension-api/src/extension-api.d.ts:1743"})}),"\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:"readonly"})," ",(0,s.jsx)(n.strong,{children:"visible"}),": ",(0,s.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Whether the panel is visible."}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-6",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L1779",children:"packages/extension-api/src/extension-api.d.ts:1779"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"webview",children:"webview"}),"\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:"webview"}),": ",(0,s.jsx)(n.a,{href:"/api/interfaces/Webview",children:(0,s.jsx)(n.code,{children:"Webview"})})]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.a,{href:"/api/interfaces/Webview",children:(0,s.jsx)(n.code,{children:"Webview"})})," belonging to the panel."]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-7",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L1769",children:"packages/extension-api/src/extension-api.d.ts:1769"})}),"\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 of the webview panel."}),"\n",(0,s.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,s.jsx)(n.code,{children:"onDispose"})," event."]}),"\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:"defined-in-8",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L1809",children:"packages/extension-api/src/extension-api.d.ts:1809"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"reveal",children:"reveal()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"reveal"}),"(",(0,s.jsx)(n.code,{children:"preserveFocus"}),"?): ",(0,s.jsx)(n.code,{children:"void"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Show the webview panel."}),"\n",(0,s.jsx)(n.h4,{id:"parameters",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"preserveFocus?"}),": ",(0,s.jsx)(n.code,{children:"boolean"})]}),"\n",(0,s.jsxs)(n.p,{children:["When ",(0,s.jsx)(n.code,{children:"true"}),", the webview will not take focus."]}),"\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:"defined-in-9",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L1800",children:"packages/extension-api/src/extension-api.d.ts:1800"})})]})}function h(e={}){const{wrapper:n}={...(0,d.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(o,{...e})}):o(e)}},43023:(e,n,i)=>{i.d(n,{R:()=>t,x:()=>c});var s=i(63696);const d={},a=s.createContext(d);function t(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(d):e.components||d:t(e.components),s.createElement(a.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[38788],{24902:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>r,contentTitle:()=>t,default:()=>h,frontMatter:()=>a,metadata:()=>c,toc:()=>l});var s=i(62540),d=i(43023);const a={},t="Interface: WebviewPanel",c={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"}},r={},l=[{value:"Properties",id:"properties",level:2},{value:"active",id:"active",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"iconPath?",id:"iconpath",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"onDidChangeViewState",id:"ondidchangeviewstate",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"onDidDispose",id:"ondiddispose",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"title",id:"title",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"viewType",id:"viewtype",level:3},{value:"Defined in",id:"defined-in-5",level:4},{value:"visible",id:"visible",level:3},{value:"Defined in",id:"defined-in-6",level:4},{value:"webview",id:"webview",level:3},{value:"Defined in",id:"defined-in-7",level:4},{value:"Methods",id:"methods",level:2},{value:"dispose()",id:"dispose",level:3},{value:"Returns",id:"returns",level:4},{value:"Defined in",id:"defined-in-8",level:4},{value:"reveal()",id:"reveal",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Defined in",id:"defined-in-9",level:4}];function o(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",p:"p",strong:"strong",...(0,d.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.header,{children:(0,s.jsx)(n.h1,{id:"interface-webviewpanel",children:"Interface: WebviewPanel"})}),"\n",(0,s.jsx)(n.p,{children:"A panel that contains a webview."}),"\n",(0,s.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,s.jsx)(n.h3,{id:"active",children:"active"}),"\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:"active"}),": ",(0,s.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Whether the panel is active (focused by the user)."}),"\n",(0,s.jsx)(n.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L1774",children:"packages/extension-api/src/extension-api.d.ts:1774"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"iconpath",children:"iconPath?"}),"\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:"iconPath"}),": ",(0,s.jsx)(n.a,{href:"/api/classes/Uri",children:(0,s.jsx)(n.code,{children:"Uri"})})," | ",(0,s.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Icon for the panel shown in UI."}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L1753",children:"packages/extension-api/src/extension-api.d.ts:1753"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"ondidchangeviewstate",children:"onDidChangeViewState"}),"\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:"onDidChangeViewState"}),": ",(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/WebviewPanelOnDidChangeViewStateEvent",children:(0,s.jsx)(n.code,{children:"WebviewPanelOnDidChangeViewStateEvent"})}),">"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Fired when the panel's view state changes."}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-2",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L1784",children:"packages/extension-api/src/extension-api.d.ts:1784"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"ondiddispose",children:"onDidDispose"}),"\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:"onDidDispose"}),": ",(0,s.jsx)(n.a,{href:"/api/interfaces/Event",children:(0,s.jsx)(n.code,{children:"Event"})}),"<",(0,s.jsx)(n.code,{children:"void"}),">"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Fired when the panel is disposed."}),"\n",(0,s.jsxs)(n.p,{children:["This may be because the user closed the panel or because ",(0,s.jsx)(n.code,{children:".dispose()"})," was\ncalled on it."]}),"\n",(0,s.jsx)(n.p,{children:"Trying to use the panel after it has been disposed throws an exception."}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-3",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L1794",children:"packages/extension-api/src/extension-api.d.ts:1794"})}),"\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.p,{children:"Title of the panel shown in UI."}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-4",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L1748",children:"packages/extension-api/src/extension-api.d.ts:1748"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"viewtype",children:"viewType"}),"\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:"viewType"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Identifies the type of the webview panel."}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-5",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L1743",children:"packages/extension-api/src/extension-api.d.ts:1743"})}),"\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:"readonly"})," ",(0,s.jsx)(n.strong,{children:"visible"}),": ",(0,s.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Whether the panel is visible."}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-6",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L1779",children:"packages/extension-api/src/extension-api.d.ts:1779"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"webview",children:"webview"}),"\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:"webview"}),": ",(0,s.jsx)(n.a,{href:"/api/interfaces/Webview",children:(0,s.jsx)(n.code,{children:"Webview"})})]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.a,{href:"/api/interfaces/Webview",children:(0,s.jsx)(n.code,{children:"Webview"})})," belonging to the panel."]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-7",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L1769",children:"packages/extension-api/src/extension-api.d.ts:1769"})}),"\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 of the webview panel."}),"\n",(0,s.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,s.jsx)(n.code,{children:"onDispose"})," event."]}),"\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:"defined-in-8",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L1809",children:"packages/extension-api/src/extension-api.d.ts:1809"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"reveal",children:"reveal()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"reveal"}),"(",(0,s.jsx)(n.code,{children:"preserveFocus"}),"?): ",(0,s.jsx)(n.code,{children:"void"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Show the webview panel."}),"\n",(0,s.jsx)(n.h4,{id:"parameters",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"preserveFocus?"}),": ",(0,s.jsx)(n.code,{children:"boolean"})]}),"\n",(0,s.jsxs)(n.p,{children:["When ",(0,s.jsx)(n.code,{children:"true"}),", the webview will not take focus."]}),"\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:"defined-in-9",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L1800",children:"packages/extension-api/src/extension-api.d.ts:1800"})})]})}function h(e={}){const{wrapper:n}={...(0,d.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(o,{...e})}):o(e)}},43023:(e,n,i)=>{i.d(n,{R:()=>t,x:()=>c});var s=i(63696);const d={},a=s.createContext(d);function t(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(d):e.components||d:t(e.components),s.createElement(a.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/7cde3c49.936a1144.js b/assets/js/7cde3c49.483b5683.js similarity index 84% rename from assets/js/7cde3c49.936a1144.js rename to assets/js/7cde3c49.483b5683.js index 93b626c73cc..4821c25780e 100644 --- a/assets/js/7cde3c49.936a1144.js +++ b/assets/js/7cde3c49.483b5683.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[49819],{56144:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>s,default:()=>p,frontMatter:()=>r,metadata:()=>c,toc:()=>d});var o=t(62540),i=t(43023);const r={},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={},d=[{value:"Properties",id:"properties",level:2},{value:"provider?",id:"provider",level:3},{value:"Defined in",id:"defined-in",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",p:"p",strong:"strong",...(0,i.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(n.header,{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:"defined-in",children:"Defined in"}),"\n",(0,o.jsx)(n.p,{children:(0,o.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L3432",children:"packages/extension-api/src/extension-api.d.ts:3432"})})]})}function p(e={}){const{wrapper:n}={...(0,i.R)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(l,{...e})}):l(e)}},43023:(e,n,t)=>{t.d(n,{R:()=>s,x:()=>c});var o=t(63696);const i={},r=o.createContext(i);function s(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(i):e.components||i:s(e.components),o.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[49819],{56144:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>s,default:()=>p,frontMatter:()=>r,metadata:()=>c,toc:()=>l});var o=t(62540),i=t(43023);const r={},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:"Defined in",id:"defined-in",level:4}];function d(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",p:"p",strong:"strong",...(0,i.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(n.header,{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:"defined-in",children:"Defined in"}),"\n",(0,o.jsx)(n.p,{children:(0,o.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L3432",children:"packages/extension-api/src/extension-api.d.ts:3432"})})]})}function p(e={}){const{wrapper:n}={...(0,i.R)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(d,{...e})}):d(e)}},43023:(e,n,t)=>{t.d(n,{R:()=>s,x:()=>c});var o=t(63696);const i={},r=o.createContext(i);function s(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(i):e.components||i:s(e.components),o.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/7d9edfb8.7a273432.js b/assets/js/7d9edfb8.b92e6925.js similarity index 98% rename from assets/js/7d9edfb8.7a273432.js rename to assets/js/7d9edfb8.b92e6925.js index 7a2d4776cd7..8834744239c 100644 --- a/assets/js/7d9edfb8.7a273432.js +++ b/assets/js/7d9edfb8.b92e6925.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[94692],{32475:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>c,contentTitle:()=>o,default:()=>p,frontMatter:()=>a,metadata:()=>r,toc:()=>l});var i=s(62540),t=s(43023);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:"Defined in",id:"defined-in",level:2}];function d(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",pre:"pre",strong:"strong",...(0,t.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.header,{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:"defined-in",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L3589",children:"packages/extension-api/src/extension-api.d.ts:3589"})})]})}function p(e={}){const{wrapper:n}={...(0,t.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(d,{...e})}):d(e)}},43023:(e,n,s)=>{s.d(n,{R:()=>o,x:()=>r});var i=s(63696);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([[94692],{32475:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>c,contentTitle:()=>o,default:()=>p,frontMatter:()=>a,metadata:()=>r,toc:()=>l});var i=s(62540),t=s(43023);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:"Defined in",id:"defined-in",level:2}];function d(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",pre:"pre",strong:"strong",...(0,t.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.header,{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:"defined-in",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L3589",children:"packages/extension-api/src/extension-api.d.ts:3589"})})]})}function p(e={}){const{wrapper:n}={...(0,t.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(d,{...e})}):d(e)}},43023:(e,n,s)=>{s.d(n,{R:()=>o,x:()=>r});var i=s(63696);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 diff --git a/assets/js/7e2ae3df.2ed3b61d.js b/assets/js/7e2ae3df.da94dc06.js similarity index 98% rename from assets/js/7e2ae3df.2ed3b61d.js rename to assets/js/7e2ae3df.da94dc06.js index a0295f38471..c5548a60f58 100644 --- a/assets/js/7e2ae3df.2ed3b61d.js +++ b/assets/js/7e2ae3df.da94dc06.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[8870],{81510:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>c,contentTitle:()=>o,default:()=>l,frontMatter:()=>s,metadata:()=>a,toc:()=>d});var r=i(62540),t=i(43023);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:"cli",permalink:"/api/namespaces/cli/"}},c={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Defined in",id:"defined-in",level:2}];function h(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",strong:"strong",...(0,t.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.header,{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.p,{children:"Additional options for the provider."}),"\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:"defined-in",children:"Defined in"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L3958",children:"packages/extension-api/src/extension-api.d.ts:3958"})})]})}function l(e={}){const{wrapper:n}={...(0,t.R)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(h,{...e})}):h(e)}},43023:(e,n,i)=>{i.d(n,{R:()=>o,x:()=>a});var r=i(63696);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([[8870],{81510:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>c,contentTitle:()=>o,default:()=>l,frontMatter:()=>s,metadata:()=>a,toc:()=>d});var r=i(62540),t=i(43023);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:"cli",permalink:"/api/namespaces/cli/"}},c={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Defined in",id:"defined-in",level:2}];function h(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",strong:"strong",...(0,t.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.header,{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.p,{children:"Additional options for the provider."}),"\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:"defined-in",children:"Defined in"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L3958",children:"packages/extension-api/src/extension-api.d.ts:3958"})})]})}function l(e={}){const{wrapper:n}={...(0,t.R)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(h,{...e})}):h(e)}},43023:(e,n,i)=>{i.d(n,{R:()=>o,x:()=>a});var r=i(63696);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.be224f18.js b/assets/js/7e5a2776.51f4171d.js similarity index 95% rename from assets/js/7e5a2776.be224f18.js rename to assets/js/7e5a2776.51f4171d.js index 89e7bfa6409..51a2c5173d7 100644 --- a/assets/js/7e5a2776.be224f18.js +++ b/assets/js/7e5a2776.51f4171d.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[91643],{12100:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>a,contentTitle:()=>t,default:()=>h,frontMatter:()=>r,metadata:()=>c,toc:()=>l});var s=i(62540),d=i(43023);const r={},t="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"}},a={},l=[{value:"Extends",id:"extends",level:2},{value:"Properties",id:"properties",level:2},{value:"onDidChange",id:"ondidchange",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"onDidCreate",id:"ondidcreate",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"onDidDelete",id:"ondiddelete",level:3},{value:"Defined in",id:"defined-in-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:"Defined in",id:"defined-in-3",level:4}];function o(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",li:"li",p:"p",strong:"strong",ul:"ul",...(0,d.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.header,{children:(0,s.jsx)(n.h1,{id:"interface-filesystemwatcher",children:"Interface: FileSystemWatcher"})}),"\n",(0,s.jsx)(n.p,{children:"Notifies changes on files or folders."}),"\n",(0,s.jsx)(n.h2,{id:"extends",children:"Extends"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,s.jsx)(n.code,{children:"Disposable"})})}),"\n"]}),"\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.code,{children:"readonly"})," ",(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/classes/Uri",children:(0,s.jsx)(n.code,{children:"Uri"})}),">"]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L1673",children:"packages/extension-api/src/extension-api.d.ts:1673"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"ondidcreate",children:"onDidCreate"}),"\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:"onDidCreate"}),": ",(0,s.jsx)(n.a,{href:"/api/interfaces/Event",children:(0,s.jsx)(n.code,{children:"Event"})}),"<",(0,s.jsx)(n.a,{href:"/api/classes/Uri",children:(0,s.jsx)(n.code,{children:"Uri"})}),">"]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L1672",children:"packages/extension-api/src/extension-api.d.ts:1672"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"ondiddelete",children:"onDidDelete"}),"\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:"onDidDelete"}),": ",(0,s.jsx)(n.a,{href:"/api/interfaces/Event",children:(0,s.jsx)(n.code,{children:"Event"})}),"<",(0,s.jsx)(n.a,{href:"/api/classes/Uri",children:(0,s.jsx)(n.code,{children:"Uri"})}),">"]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-2",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L1674",children:"packages/extension-api/src/extension-api.d.ts:1674"})}),"\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."}),"\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:"inherited-from",children:"Inherited from"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,s.jsx)(n.code,{children:"Disposable"})}),".",(0,s.jsx)(n.a,{href:"/api/classes/Disposable#dispose",children:(0,s.jsx)(n.code,{children:"dispose"})})]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-3",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/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,d.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(o,{...e})}):o(e)}},43023:(e,n,i)=>{i.d(n,{R:()=>t,x:()=>c});var s=i(63696);const d={},r=s.createContext(d);function t(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(d):e.components||d:t(e.components),s.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[91643],{12100:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>a,contentTitle:()=>t,default:()=>h,frontMatter:()=>r,metadata:()=>c,toc:()=>l});var s=i(62540),d=i(43023);const r={},t="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"}},a={},l=[{value:"Extends",id:"extends",level:2},{value:"Properties",id:"properties",level:2},{value:"onDidChange",id:"ondidchange",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"onDidCreate",id:"ondidcreate",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"onDidDelete",id:"ondiddelete",level:3},{value:"Defined in",id:"defined-in-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:"Defined in",id:"defined-in-3",level:4}];function o(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",li:"li",p:"p",strong:"strong",ul:"ul",...(0,d.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.header,{children:(0,s.jsx)(n.h1,{id:"interface-filesystemwatcher",children:"Interface: FileSystemWatcher"})}),"\n",(0,s.jsx)(n.p,{children:"Notifies changes on files or folders."}),"\n",(0,s.jsx)(n.h2,{id:"extends",children:"Extends"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,s.jsx)(n.code,{children:"Disposable"})})}),"\n"]}),"\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.code,{children:"readonly"})," ",(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/classes/Uri",children:(0,s.jsx)(n.code,{children:"Uri"})}),">"]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L1673",children:"packages/extension-api/src/extension-api.d.ts:1673"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"ondidcreate",children:"onDidCreate"}),"\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:"onDidCreate"}),": ",(0,s.jsx)(n.a,{href:"/api/interfaces/Event",children:(0,s.jsx)(n.code,{children:"Event"})}),"<",(0,s.jsx)(n.a,{href:"/api/classes/Uri",children:(0,s.jsx)(n.code,{children:"Uri"})}),">"]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L1672",children:"packages/extension-api/src/extension-api.d.ts:1672"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"ondiddelete",children:"onDidDelete"}),"\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:"onDidDelete"}),": ",(0,s.jsx)(n.a,{href:"/api/interfaces/Event",children:(0,s.jsx)(n.code,{children:"Event"})}),"<",(0,s.jsx)(n.a,{href:"/api/classes/Uri",children:(0,s.jsx)(n.code,{children:"Uri"})}),">"]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-2",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L1674",children:"packages/extension-api/src/extension-api.d.ts:1674"})}),"\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."}),"\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:"inherited-from",children:"Inherited from"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,s.jsx)(n.code,{children:"Disposable"})}),".",(0,s.jsx)(n.a,{href:"/api/classes/Disposable#dispose",children:(0,s.jsx)(n.code,{children:"dispose"})})]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-3",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/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,d.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(o,{...e})}):o(e)}},43023:(e,n,i)=>{i.d(n,{R:()=>t,x:()=>c});var s=i(63696);const d={},r=s.createContext(d);function t(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(d):e.components||d:t(e.components),s.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/7f0476bd.c676d743.js b/assets/js/7f0476bd.52d2b245.js similarity index 92% rename from assets/js/7f0476bd.c676d743.js rename to assets/js/7f0476bd.52d2b245.js index dfd2285c636..829851997e7 100644 --- a/assets/js/7f0476bd.c676d743.js +++ b/assets/js/7f0476bd.52d2b245.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[87577],{97726:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>a,contentTitle:()=>d,default:()=>h,frontMatter:()=>t,metadata:()=>c,toc:()=>o});var s=i(62540),r=i(43023);const t={},d="Interface: Webview",c={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={},o=[{value:"Properties",id:"properties",level:2},{value:"cspSource",id:"cspsource",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"html",id:"html",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"onDidReceiveMessage",id:"ondidreceivemessage",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"options",id:"options",level:3},{value:"Defined in",id:"defined-in-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:"Defined in",id:"defined-in-4",level:4},{value:"postMessage()",id:"postmessage",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Defined in",id:"defined-in-5",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",p:"p",strong:"strong",...(0,r.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.header,{children:(0,s.jsx)(n.h1,{id:"interface-webview",children:"Interface: Webview"})}),"\n",(0,s.jsx)(n.p,{children:"Displays html content, similarly to an iframe."}),"\n",(0,s.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,s.jsx)(n.h3,{id:"cspsource",children:"cspSource"}),"\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:"cspSource"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Content security policy source for webview resources."}),"\n",(0,s.jsx)(n.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L1733",children:"packages/extension-api/src/extension-api.d.ts:1733"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"html",children:"html"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"html"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"HTML contents of the webview."}),"\n",(0,s.jsx)(n.p,{children:"This should be a complete, valid html document. Changing this property causes the webview to be reloaded."}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L1710",children:"packages/extension-api/src/extension-api.d.ts:1710"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"ondidreceivemessage",children:"onDidReceiveMessage"}),"\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:"onDidReceiveMessage"}),": ",(0,s.jsx)(n.a,{href:"/api/interfaces/Event",children:(0,s.jsx)(n.code,{children:"Event"})}),"<",(0,s.jsx)(n.code,{children:"unknown"}),">"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Fired when the webview content posts a message."}),"\n",(0,s.jsx)(n.p,{children:"Webview content can post strings or json serializable objects back to an extension."}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-2",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L1717",children:"packages/extension-api/src/extension-api.d.ts:1717"})}),"\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.strong,{children:"options"}),": ",(0,s.jsx)(n.a,{href:"/api/interfaces/WebviewOptions",children:(0,s.jsx)(n.code,{children:"WebviewOptions"})})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Content settings for the webview."}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-3",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L1702",children:"packages/extension-api/src/extension-api.d.ts:1702"})}),"\n",(0,s.jsx)(n.h2,{id:"methods",children:"Methods"}),"\n",(0,s.jsx)(n.h3,{id:"aswebviewuri",children:"asWebviewUri()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"asWebviewUri"}),"(",(0,s.jsx)(n.code,{children:"localResource"}),"): ",(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:"Convert a uri for the local file system to one that can be used inside webviews."}),"\n",(0,s.jsx)(n.h4,{id:"parameters",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"localResource"}),": ",(0,s.jsx)(n.a,{href:"/api/classes/Uri",children:(0,s.jsx)(n.code,{children:"Uri"})})]}),"\n",(0,s.jsx)(n.h4,{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.h4,{id:"defined-in-4",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L1727",children:"packages/extension-api/src/extension-api.d.ts:1727"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"postmessage",children:"postMessage()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"postMessage"}),"(",(0,s.jsx)(n.code,{children:"message"}),"): ",(0,s.jsx)(n.code,{children:"Promise"}),"<",(0,s.jsx)(n.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Post a message to the webview content."}),"\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:"message"}),": ",(0,s.jsx)(n.code,{children:"unknown"})]}),"\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:"boolean"}),">"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-5",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L1722",children:"packages/extension-api/src/extension-api.d.ts:1722"})})]})}function h(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},43023:(e,n,i)=>{i.d(n,{R:()=>d,x:()=>c});var s=i(63696);const r={},t=s.createContext(r);function d(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:d(e.components),s.createElement(t.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[87577],{97726:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>a,contentTitle:()=>d,default:()=>h,frontMatter:()=>t,metadata:()=>c,toc:()=>o});var s=i(62540),r=i(43023);const t={},d="Interface: Webview",c={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={},o=[{value:"Properties",id:"properties",level:2},{value:"cspSource",id:"cspsource",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"html",id:"html",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"onDidReceiveMessage",id:"ondidreceivemessage",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"options",id:"options",level:3},{value:"Defined in",id:"defined-in-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:"Defined in",id:"defined-in-4",level:4},{value:"postMessage()",id:"postmessage",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Defined in",id:"defined-in-5",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",p:"p",strong:"strong",...(0,r.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.header,{children:(0,s.jsx)(n.h1,{id:"interface-webview",children:"Interface: Webview"})}),"\n",(0,s.jsx)(n.p,{children:"Displays html content, similarly to an iframe."}),"\n",(0,s.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,s.jsx)(n.h3,{id:"cspsource",children:"cspSource"}),"\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:"cspSource"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Content security policy source for webview resources."}),"\n",(0,s.jsx)(n.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L1733",children:"packages/extension-api/src/extension-api.d.ts:1733"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"html",children:"html"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"html"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"HTML contents of the webview."}),"\n",(0,s.jsx)(n.p,{children:"This should be a complete, valid html document. Changing this property causes the webview to be reloaded."}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L1710",children:"packages/extension-api/src/extension-api.d.ts:1710"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"ondidreceivemessage",children:"onDidReceiveMessage"}),"\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:"onDidReceiveMessage"}),": ",(0,s.jsx)(n.a,{href:"/api/interfaces/Event",children:(0,s.jsx)(n.code,{children:"Event"})}),"<",(0,s.jsx)(n.code,{children:"unknown"}),">"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Fired when the webview content posts a message."}),"\n",(0,s.jsx)(n.p,{children:"Webview content can post strings or json serializable objects back to an extension."}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-2",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L1717",children:"packages/extension-api/src/extension-api.d.ts:1717"})}),"\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.strong,{children:"options"}),": ",(0,s.jsx)(n.a,{href:"/api/interfaces/WebviewOptions",children:(0,s.jsx)(n.code,{children:"WebviewOptions"})})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Content settings for the webview."}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-3",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L1702",children:"packages/extension-api/src/extension-api.d.ts:1702"})}),"\n",(0,s.jsx)(n.h2,{id:"methods",children:"Methods"}),"\n",(0,s.jsx)(n.h3,{id:"aswebviewuri",children:"asWebviewUri()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"asWebviewUri"}),"(",(0,s.jsx)(n.code,{children:"localResource"}),"): ",(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:"Convert a uri for the local file system to one that can be used inside webviews."}),"\n",(0,s.jsx)(n.h4,{id:"parameters",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"localResource"}),": ",(0,s.jsx)(n.a,{href:"/api/classes/Uri",children:(0,s.jsx)(n.code,{children:"Uri"})})]}),"\n",(0,s.jsx)(n.h4,{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.h4,{id:"defined-in-4",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L1727",children:"packages/extension-api/src/extension-api.d.ts:1727"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"postmessage",children:"postMessage()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"postMessage"}),"(",(0,s.jsx)(n.code,{children:"message"}),"): ",(0,s.jsx)(n.code,{children:"Promise"}),"<",(0,s.jsx)(n.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Post a message to the webview content."}),"\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:"message"}),": ",(0,s.jsx)(n.code,{children:"unknown"})]}),"\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:"boolean"}),">"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-5",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L1722",children:"packages/extension-api/src/extension-api.d.ts:1722"})})]})}function h(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},43023:(e,n,i)=>{i.d(n,{R:()=>d,x:()=>c});var s=i(63696);const r={},t=s.createContext(r);function d(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:d(e.components),s.createElement(t.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/7fa133e1.2e8e6003.js b/assets/js/7fa133e1.3faef52f.js similarity index 90% rename from assets/js/7fa133e1.2e8e6003.js rename to assets/js/7fa133e1.3faef52f.js index aa35ba8cf73..d6cba37752d 100644 --- a/assets/js/7fa133e1.2e8e6003.js +++ b/assets/js/7fa133e1.3faef52f.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[40098],{72688:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>o,contentTitle:()=>d,default:()=>h,frontMatter:()=>c,metadata:()=>r,toc:()=>a});var t=i(62540),s=i(43023);const c={},d="Interface: CustomPickItem",r={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"}},o={},a=[{value:"Properties",id:"properties",level:2},{value:"description?",id:"description",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"markDownContent",id:"markdowncontent",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"sections?",id:"sections",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"selected?",id:"selected",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"title",id:"title",level:3},{value:"Defined in",id:"defined-in-4",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",p:"p",strong:"strong",...(0,s.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.header,{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:"defined-in",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L1375",children:"packages/extension-api/src/extension-api.d.ts:1375"})}),"\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:"defined-in-1",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L1379",children:"packages/extension-api/src/extension-api.d.ts:1379"})}),"\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:"defined-in-2",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L1383",children:"packages/extension-api/src/extension-api.d.ts:1383"})}),"\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:"defined-in-3",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L1387",children:"packages/extension-api/src/extension-api.d.ts:1387"})}),"\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:"defined-in-4",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L1371",children:"packages/extension-api/src/extension-api.d.ts:1371"})})]})}function h(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},43023:(e,n,i)=>{i.d(n,{R:()=>d,x:()=>r});var t=i(63696);const s={},c=t.createContext(s);function d(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(s):e.components||s:d(e.components),t.createElement(c.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[40098],{72688:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>o,contentTitle:()=>d,default:()=>h,frontMatter:()=>c,metadata:()=>r,toc:()=>a});var t=i(62540),s=i(43023);const c={},d="Interface: CustomPickItem",r={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"}},o={},a=[{value:"Properties",id:"properties",level:2},{value:"description?",id:"description",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"markDownContent",id:"markdowncontent",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"sections?",id:"sections",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"selected?",id:"selected",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"title",id:"title",level:3},{value:"Defined in",id:"defined-in-4",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",p:"p",strong:"strong",...(0,s.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.header,{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:"defined-in",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L1375",children:"packages/extension-api/src/extension-api.d.ts:1375"})}),"\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:"defined-in-1",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L1379",children:"packages/extension-api/src/extension-api.d.ts:1379"})}),"\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:"defined-in-2",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L1383",children:"packages/extension-api/src/extension-api.d.ts:1383"})}),"\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:"defined-in-3",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L1387",children:"packages/extension-api/src/extension-api.d.ts:1387"})}),"\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:"defined-in-4",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L1371",children:"packages/extension-api/src/extension-api.d.ts:1371"})})]})}function h(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},43023:(e,n,i)=>{i.d(n,{R:()=>d,x:()=>r});var t=i(63696);const s={},c=t.createContext(s);function d(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(s):e.components||s:d(e.components),t.createElement(c.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/814402d7.0375673c.js b/assets/js/814402d7.7a700f4a.js similarity index 93% rename from assets/js/814402d7.0375673c.js rename to assets/js/814402d7.7a700f4a.js index 0b3c6b9f55b..ce89e95d697 100644 --- a/assets/js/814402d7.0375673c.js +++ b/assets/js/814402d7.7a700f4a.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[30487],{6933:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>d,contentTitle:()=>a,default:()=>l,frontMatter:()=>o,metadata:()=>r,toc:()=>c});var t=i(62540),s=i(43023);const o={},a="Interface: AuthenticationProviderAuthenticationSessionsChangeEvent",r={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"}},d={},c=[{value:"Properties",id:"properties",level:2},{value:"added?",id:"added",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"changed?",id:"changed",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"removed?",id:"removed",level:3},{value:"Defined in",id:"defined-in-2",level:4}];function h(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",p:"p",strong:"strong",...(0,s.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.header,{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:"readonly"})," ",(0,t.jsx)(n.code,{children:"optional"})," ",(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:"defined-in",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L3839",children:"packages/extension-api/src/extension-api.d.ts:3839"})}),"\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:"readonly"})," ",(0,t.jsx)(n.code,{children:"optional"})," ",(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:"defined-in-1",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L3851",children:"packages/extension-api/src/extension-api.d.ts:3851"})}),"\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:"readonly"})," ",(0,t.jsx)(n.code,{children:"optional"})," ",(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:"defined-in-2",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L3844",children:"packages/extension-api/src/extension-api.d.ts:3844"})})]})}function l(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(h,{...e})}):h(e)}},43023:(e,n,i)=>{i.d(n,{R:()=>a,x:()=>r});var t=i(63696);const s={},o=t.createContext(s);function a(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:a(e.components),t.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[30487],{6933:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>d,contentTitle:()=>a,default:()=>l,frontMatter:()=>o,metadata:()=>r,toc:()=>c});var t=i(62540),s=i(43023);const o={},a="Interface: AuthenticationProviderAuthenticationSessionsChangeEvent",r={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"}},d={},c=[{value:"Properties",id:"properties",level:2},{value:"added?",id:"added",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"changed?",id:"changed",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"removed?",id:"removed",level:3},{value:"Defined in",id:"defined-in-2",level:4}];function h(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",p:"p",strong:"strong",...(0,s.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.header,{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:"readonly"})," ",(0,t.jsx)(n.code,{children:"optional"})," ",(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:"defined-in",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L3839",children:"packages/extension-api/src/extension-api.d.ts:3839"})}),"\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:"readonly"})," ",(0,t.jsx)(n.code,{children:"optional"})," ",(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:"defined-in-1",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L3851",children:"packages/extension-api/src/extension-api.d.ts:3851"})}),"\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:"readonly"})," ",(0,t.jsx)(n.code,{children:"optional"})," ",(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:"defined-in-2",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L3844",children:"packages/extension-api/src/extension-api.d.ts:3844"})})]})}function l(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(h,{...e})}):h(e)}},43023:(e,n,i)=>{i.d(n,{R:()=>a,x:()=>r});var t=i(63696);const s={},o=t.createContext(s);function a(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:a(e.components),t.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/814d49b7.ce39587b.js b/assets/js/814d49b7.6d76dd65.js similarity index 80% rename from assets/js/814d49b7.ce39587b.js rename to assets/js/814d49b7.6d76dd65.js index 7dc0e2a7e9b..94715398636 100644 --- a/assets/js/814d49b7.ce39587b.js +++ b/assets/js/814d49b7.6d76dd65.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[66622],{89152:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>r,contentTitle:()=>d,default:()=>p,frontMatter:()=>o,metadata:()=>a,toc:()=>l});var s=i(62540),t=i(43023);const o={},d="Interface: CliToolUpdateOptions",a={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"}},r={},l=[{value:"Properties",id:"properties",level:2},{value:"displayName?",id:"displayname",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"images?",id:"images",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"installationSource?",id:"installationsource",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"markdownDescription?",id:"markdowndescription",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"path?",id:"path",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"version",id:"version",level:3},{value:"Defined in",id:"defined-in-5",level:4}];function c(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",p:"p",strong:"strong",...(0,t.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.header,{children:(0,s.jsx)(n.h1,{id:"interface-clitoolupdateoptions",children:"Interface: CliToolUpdateOptions"})}),"\n",(0,s.jsx)(n.p,{children:"Options to update CliTool instance"}),"\n",(0,s.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,s.jsx)(n.h3,{id:"displayname",children:"displayName?"}),"\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:"displayName"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L4339",children:"packages/extension-api/src/extension-api.d.ts:4339"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"images",children:"images?"}),"\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:"images"}),": ",(0,s.jsx)(n.a,{href:"/api/interfaces/ProviderImages",children:(0,s.jsx)(n.code,{children:"ProviderImages"})})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L4341",children:"packages/extension-api/src/extension-api.d.ts:4341"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"installationsource",children:"installationSource?"}),"\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:"installationSource"}),": ",(0,s.jsx)(n.a,{href:"/api/type-aliases/CliToolInstallationSource",children:(0,s.jsx)(n.code,{children:"CliToolInstallationSource"})})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-2",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L4343",children:"packages/extension-api/src/extension-api.d.ts:4343"})}),"\n",(0,s.jsx)(n.hr,{}),"\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.h4,{id:"defined-in-3",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L4340",children:"packages/extension-api/src/extension-api.d.ts:4340"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"path",children:"path?"}),"\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:"path"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-4",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L4342",children:"packages/extension-api/src/extension-api.d.ts:4342"})}),"\n",(0,s.jsx)(n.hr,{}),"\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:"defined-in-5",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L4338",children:"packages/extension-api/src/extension-api.d.ts:4338"})})]})}function p(e={}){const{wrapper:n}={...(0,t.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(c,{...e})}):c(e)}},43023:(e,n,i)=>{i.d(n,{R:()=>d,x:()=>a});var s=i(63696);const t={},o=s.createContext(t);function d(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:d(e.components),s.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[66622],{89152:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>r,contentTitle:()=>a,default:()=>p,frontMatter:()=>o,metadata:()=>d,toc:()=>c});var s=i(62540),t=i(43023);const o={},a="Interface: CliToolUpdateOptions",d={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"}},r={},c=[{value:"Properties",id:"properties",level:2},{value:"displayName?",id:"displayname",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"images?",id:"images",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"installationSource?",id:"installationsource",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"markdownDescription?",id:"markdowndescription",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"path?",id:"path",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"version",id:"version",level:3},{value:"Defined in",id:"defined-in-5",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",p:"p",strong:"strong",...(0,t.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.header,{children:(0,s.jsx)(n.h1,{id:"interface-clitoolupdateoptions",children:"Interface: CliToolUpdateOptions"})}),"\n",(0,s.jsx)(n.p,{children:"Options to update CliTool instance"}),"\n",(0,s.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,s.jsx)(n.h3,{id:"displayname",children:"displayName?"}),"\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:"displayName"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L4339",children:"packages/extension-api/src/extension-api.d.ts:4339"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"images",children:"images?"}),"\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:"images"}),": ",(0,s.jsx)(n.a,{href:"/api/interfaces/ProviderImages",children:(0,s.jsx)(n.code,{children:"ProviderImages"})})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L4341",children:"packages/extension-api/src/extension-api.d.ts:4341"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"installationsource",children:"installationSource?"}),"\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:"installationSource"}),": ",(0,s.jsx)(n.a,{href:"/api/type-aliases/CliToolInstallationSource",children:(0,s.jsx)(n.code,{children:"CliToolInstallationSource"})})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-2",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L4343",children:"packages/extension-api/src/extension-api.d.ts:4343"})}),"\n",(0,s.jsx)(n.hr,{}),"\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.h4,{id:"defined-in-3",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L4340",children:"packages/extension-api/src/extension-api.d.ts:4340"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"path",children:"path?"}),"\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:"path"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-4",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L4342",children:"packages/extension-api/src/extension-api.d.ts:4342"})}),"\n",(0,s.jsx)(n.hr,{}),"\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:"defined-in-5",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L4338",children:"packages/extension-api/src/extension-api.d.ts:4338"})})]})}function p(e={}){const{wrapper:n}={...(0,t.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},43023:(e,n,i)=>{i.d(n,{R:()=>a,x:()=>d});var s=i(63696);const t={},o=s.createContext(t);function a(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(t):e.components||t:a(e.components),s.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/81b69ac7.ab480ad4.js b/assets/js/81b69ac7.71480871.js similarity index 88% rename from assets/js/81b69ac7.ab480ad4.js rename to assets/js/81b69ac7.71480871.js index a9b88332713..0a583126b90 100644 --- a/assets/js/81b69ac7.ab480ad4.js +++ b/assets/js/81b69ac7.71480871.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[33582],{31784:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>c,contentTitle:()=>d,default:()=>h,frontMatter:()=>o,metadata:()=>s,toc:()=>a});var r=i(62540),t=i(43023);const o={},d="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"}},c={},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:"Defined in",id:"defined-in",level:4},{value:"creationDisplayName?",id:"creationdisplayname",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-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:"Defined in",id:"defined-in-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:"Defined in",id:"defined-in-3",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",li:"li",p:"p",strong:"strong",ul:"ul",...(0,t.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.header,{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:"defined-in",children:"Defined in"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L499",children:"packages/extension-api/src/extension-api.d.ts:499"})}),"\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:"defined-in-1",children:"Defined in"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L496",children:"packages/extension-api/src/extension-api.d.ts:496"})}),"\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:"defined-in-2",children:"Defined in"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L511",children:"packages/extension-api/src/extension-api.d.ts:511"})}),"\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:"defined-in-3",children:"Defined in"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L493",children:"packages/extension-api/src/extension-api.d.ts:493"})})]})}function h(e={}){const{wrapper:n}={...(0,t.R)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(l,{...e})}):l(e)}},43023:(e,n,i)=>{i.d(n,{R:()=>d,x:()=>s});var r=i(63696);const t={},o=r.createContext(t);function d(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:d(e.components),r.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[33582],{31784:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>d,contentTitle:()=>c,default:()=>h,frontMatter:()=>o,metadata:()=>s,toc:()=>a});var r=i(62540),t=i(43023);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:"Defined in",id:"defined-in",level:4},{value:"creationDisplayName?",id:"creationdisplayname",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-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:"Defined in",id:"defined-in-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:"Defined in",id:"defined-in-3",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",li:"li",p:"p",strong:"strong",ul:"ul",...(0,t.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.header,{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:"defined-in",children:"Defined in"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L499",children:"packages/extension-api/src/extension-api.d.ts:499"})}),"\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:"defined-in-1",children:"Defined in"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L496",children:"packages/extension-api/src/extension-api.d.ts:496"})}),"\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:"defined-in-2",children:"Defined in"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L511",children:"packages/extension-api/src/extension-api.d.ts:511"})}),"\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:"defined-in-3",children:"Defined in"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L493",children:"packages/extension-api/src/extension-api.d.ts:493"})})]})}function h(e={}){const{wrapper:n}={...(0,t.R)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(l,{...e})}):l(e)}},43023:(e,n,i)=>{i.d(n,{R:()=>c,x:()=>s});var r=i(63696);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.6aa47739.js b/assets/js/82170cf7.8fc6886c.js similarity index 96% rename from assets/js/82170cf7.6aa47739.js rename to assets/js/82170cf7.8fc6886c.js index 92fe1377989..b12ca59c4ac 100644 --- a/assets/js/82170cf7.6aa47739.js +++ b/assets/js/82170cf7.8fc6886c.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[24915],{33646:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>o,contentTitle:()=>r,default:()=>p,frontMatter:()=>c,metadata:()=>a,toc:()=>d});var i=t(62540),s=t(43023);const c={},r="Function: getImageInspect()",a={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"}},o={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Defined in",id:"defined-in",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",strong:"strong",...(0,s.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.header,{children:(0,i.jsx)(n.h1,{id:"function-getimageinspect",children:"Function: getImageInspect()"})}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"getImageInspect"}),"(",(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.a,{href:"/api/interfaces/ImageInspectInfo",children:(0,i.jsx)(n.code,{children:"ImageInspectInfo"})}),">"]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Return low-level information about an image"}),"\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.a,{href:"/api/interfaces/ImageInspectInfo",children:(0,i.jsx)(n.code,{children:"ImageInspectInfo"})}),">"]}),"\n",(0,i.jsx)(n.p,{children:"A promise resolving to a structure containing the image information"}),"\n",(0,i.jsx)(n.h2,{id:"defined-in",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L3646",children:"packages/extension-api/src/extension-api.d.ts:3646"})})]})}function p(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},43023:(e,n,t)=>{t.d(n,{R:()=>r,x:()=>a});var i=t(63696);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([[24915],{33646:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>o,contentTitle:()=>r,default:()=>p,frontMatter:()=>c,metadata:()=>a,toc:()=>d});var i=t(62540),s=t(43023);const c={},r="Function: getImageInspect()",a={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"}},o={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Defined in",id:"defined-in",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",strong:"strong",...(0,s.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.header,{children:(0,i.jsx)(n.h1,{id:"function-getimageinspect",children:"Function: getImageInspect()"})}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"getImageInspect"}),"(",(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.a,{href:"/api/interfaces/ImageInspectInfo",children:(0,i.jsx)(n.code,{children:"ImageInspectInfo"})}),">"]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Return low-level information about an image"}),"\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.a,{href:"/api/interfaces/ImageInspectInfo",children:(0,i.jsx)(n.code,{children:"ImageInspectInfo"})}),">"]}),"\n",(0,i.jsx)(n.p,{children:"A promise resolving to a structure containing the image information"}),"\n",(0,i.jsx)(n.h2,{id:"defined-in",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L3646",children:"packages/extension-api/src/extension-api.d.ts:3646"})})]})}function p(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},43023:(e,n,t)=>{t.d(n,{R:()=>r,x:()=>a});var i=t(63696);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 diff --git a/assets/js/825ec378.4a5937d3.js b/assets/js/825ec378.0fcfad82.js similarity index 87% rename from assets/js/825ec378.4a5937d3.js rename to assets/js/825ec378.0fcfad82.js index 4b5ba3e5148..ce575a68c9a 100644 --- a/assets/js/825ec378.4a5937d3.js +++ b/assets/js/825ec378.0fcfad82.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[95696],{70084:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>a,contentTitle:()=>o,default:()=>u,frontMatter:()=>s,metadata:()=>c,toc:()=>d});var t=i(62540),r=i(43023);const s={},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:"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:"Defined in",id:"defined-in",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",strong:"strong",...(0,r.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.header,{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:"defined-in",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L3556",children:"packages/extension-api/src/extension-api.d.ts:3556"})})]})}function u(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},43023:(e,n,i)=>{i.d(n,{R:()=>o,x:()=>c});var t=i(63696);const r={},s=t.createContext(r);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(r):e.components||r:o(e.components),t.createElement(s.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[95696],{70084:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>a,contentTitle:()=>c,default:()=>u,frontMatter:()=>s,metadata:()=>o,toc:()=>d});var t=i(62540),r=i(43023);const s={},c="Function: buildImage()",o={id:"namespaces/containerEngine/functions/buildImage",title:"Function: buildImage()",description:"buildImage(context, eventCollect, options?): Promise\\",source:"@site/api/namespaces/containerEngine/functions/buildImage.md",sourceDirName:"namespaces/containerEngine/functions",slug:"/namespaces/containerEngine/functions/buildImage",permalink:"/api/namespaces/containerEngine/functions/buildImage",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"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:"Defined in",id:"defined-in",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",strong:"strong",...(0,r.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.header,{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:"defined-in",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L3556",children:"packages/extension-api/src/extension-api.d.ts:3556"})})]})}function u(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},43023:(e,n,i)=>{i.d(n,{R:()=>c,x:()=>o});var t=i(63696);const r={},s=t.createContext(r);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(r):e.components||r:c(e.components),t.createElement(s.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/8519c2b0.810d7e0f.js b/assets/js/8519c2b0.9dcb01f6.js similarity index 98% rename from assets/js/8519c2b0.810d7e0f.js rename to assets/js/8519c2b0.9dcb01f6.js index 4384fdad9f1..bdf6d8249e6 100644 --- a/assets/js/8519c2b0.810d7e0f.js +++ b/assets/js/8519c2b0.9dcb01f6.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[92749],{12550:(e,s,n)=>{n.r(s),n.d(s,{assets:()=>a,contentTitle:()=>t,default:()=>h,frontMatter:()=>o,metadata:()=>c,toc:()=>d});var r=n(62540),i=n(43023);const o={},t="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:"Defined in",id:"defined-in",level:2}];function l(e){const s={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",strong:"strong",...(0,i.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(s.header,{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:"defined-in",children:"Defined in"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L1913",children:"packages/extension-api/src/extension-api.d.ts:1913"})})]})}function h(e={}){const{wrapper:s}={...(0,i.R)(),...e.components};return s?(0,r.jsx)(s,{...e,children:(0,r.jsx)(l,{...e})}):l(e)}},43023:(e,s,n)=>{n.d(s,{R:()=>t,x:()=>c});var r=n(63696);const i={},o=r.createContext(i);function t(e){const s=r.useContext(o);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(i):e.components||i:t(e.components),r.createElement(o.Provider,{value:s},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[92749],{12550:(e,s,n)=>{n.r(s),n.d(s,{assets:()=>a,contentTitle:()=>t,default:()=>h,frontMatter:()=>o,metadata:()=>c,toc:()=>d});var r=n(62540),i=n(43023);const o={},t="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:"Defined in",id:"defined-in",level:2}];function l(e){const s={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",strong:"strong",...(0,i.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(s.header,{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:"defined-in",children:"Defined in"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L1913",children:"packages/extension-api/src/extension-api.d.ts:1913"})})]})}function h(e={}){const{wrapper:s}={...(0,i.R)(),...e.components};return s?(0,r.jsx)(s,{...e,children:(0,r.jsx)(l,{...e})}):l(e)}},43023:(e,s,n)=>{n.d(s,{R:()=>t,x:()=>c});var r=n(63696);const i={},o=r.createContext(i);function t(e){const s=r.useContext(o);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(i):e.components||i:t(e.components),r.createElement(o.Provider,{value:s},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/86e64757.7ee90816.js b/assets/js/86e64757.59408388.js similarity index 94% rename from assets/js/86e64757.7ee90816.js rename to assets/js/86e64757.59408388.js index 5d36a006bf2..c68dec12d50 100644 --- a/assets/js/86e64757.7ee90816.js +++ b/assets/js/86e64757.59408388.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[64679],{92287:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>l,contentTitle:()=>r,default:()=>p,frontMatter:()=>i,metadata:()=>o,toc:()=>c});var t=s(62540),a=s(43023);const i={},r="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"}},l={},c=[{value:"Defined in",id:"defined-in",level:2}];function d(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",strong:"strong",...(0,a.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.header,{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:"defined-in",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L3998",children:"packages/extension-api/src/extension-api.d.ts:3998"})})]})}function p(e={}){const{wrapper:n}={...(0,a.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(d,{...e})}):d(e)}},43023:(e,n,s)=>{s.d(n,{R:()=>r,x:()=>o});var t=s(63696);const a={},i=t.createContext(a);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(a):e.components||a:r(e.components),t.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[64679],{92287:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>l,contentTitle:()=>r,default:()=>p,frontMatter:()=>i,metadata:()=>o,toc:()=>c});var t=s(62540),a=s(43023);const i={},r="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"}},l={},c=[{value:"Defined in",id:"defined-in",level:2}];function d(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",strong:"strong",...(0,a.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.header,{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:"defined-in",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L3998",children:"packages/extension-api/src/extension-api.d.ts:3998"})})]})}function p(e={}){const{wrapper:n}={...(0,a.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(d,{...e})}):d(e)}},43023:(e,n,s)=>{s.d(n,{R:()=>r,x:()=>o});var t=s(63696);const a={},i=t.createContext(a);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(a):e.components||a:r(e.components),t.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/86f8c256.a2b971b1.js b/assets/js/86f8c256.ccac3db3.js similarity index 91% rename from assets/js/86f8c256.a2b971b1.js rename to assets/js/86f8c256.ccac3db3.js index 61a4dcd9b9d..70d17112a30 100644 --- a/assets/js/86f8c256.a2b971b1.js +++ b/assets/js/86f8c256.ccac3db3.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[95505],{46186:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>t,contentTitle:()=>c,default:()=>h,frontMatter:()=>r,metadata:()=>l,toc:()=>o});var s=i(62540),d=i(43023);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"}},t={},o=[{value:"Properties",id:"properties",level:2},{value:"Architecture",id:"architecture",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"Author",id:"author",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"Comment",id:"comment",level:3},{value:"Defined in",id:"defined-in-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:"Defined in",id:"defined-in-3",level:4},{value:"Container",id:"container",level:3},{value:"Defined in",id:"defined-in-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:"Defined in",id:"defined-in-5",level:4},{value:"Created",id:"created",level:3},{value:"Defined in",id:"defined-in-6",level:4},{value:"DockerVersion",id:"dockerversion",level:3},{value:"Defined in",id:"defined-in-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:"Defined in",id:"defined-in-8",level:4},{value:"Id",id:"id",level:3},{value:"Defined in",id:"defined-in-9",level:4},{value:"Os",id:"os",level:3},{value:"Defined in",id:"defined-in-10",level:4},{value:"Parent",id:"parent",level:3},{value:"Defined in",id:"defined-in-11",level:4},{value:"RepoDigests",id:"repodigests",level:3},{value:"Defined in",id:"defined-in-12",level:4},{value:"RepoTags",id:"repotags",level:3},{value:"Defined in",id:"defined-in-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:"Defined in",id:"defined-in-14",level:4},{value:"Size",id:"size",level:3},{value:"Defined in",id:"defined-in-15",level:4},{value:"VirtualSize",id:"virtualsize",level:3},{value:"Defined in",id:"defined-in-16",level:4},{value:"engineId",id:"engineid",level:3},{value:"Defined in",id:"defined-in-17",level:4},{value:"engineName",id:"enginename",level:3},{value:"Defined in",id:"defined-in-18",level:4}];function a(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",h5:"h5",header:"header",hr:"hr",p:"p",strong:"strong",...(0,d.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.header,{children:(0,s.jsx)(n.h1,{id:"interface-imageinspectinfo",children:"Interface: ImageInspectInfo"})}),"\n",(0,s.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,s.jsx)(n.h3,{id:"architecture",children:"Architecture"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Architecture"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2231",children:"packages/extension-api/src/extension-api.d.ts:2231"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"author",children:"Author"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Author"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2209",children:"packages/extension-api/src/extension-api.d.ts:2209"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"comment",children:"Comment"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Comment"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-2",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2184",children:"packages/extension-api/src/extension-api.d.ts:2184"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"config",children:"Config"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Config"}),": ",(0,s.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"argsescaped",children:"ArgsEscaped"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"ArgsEscaped"}),": ",(0,s.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"attachstderr",children:"AttachStderr"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"AttachStderr"}),": ",(0,s.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"attachstdin",children:"AttachStdin"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"AttachStdin"}),": ",(0,s.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"attachstdout",children:"AttachStdout"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"AttachStdout"}),": ",(0,s.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"cmd",children:"Cmd"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Cmd"}),": ",(0,s.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"domainname",children:"Domainname"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Domainname"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"entrypoint",children:"Entrypoint?"}),"\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:"Entrypoint"}),": ",(0,s.jsx)(n.code,{children:"string"})," | ",(0,s.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"env",children:"Env"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Env"}),": ",(0,s.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"exposedports",children:"ExposedPorts"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"ExposedPorts"}),": ",(0,s.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,s.jsx)(n.h5,{id:"index-signature",children:"Index Signature"}),"\n",(0,s.jsxs)(n.p,{children:["[",(0,s.jsx)(n.code,{children:"portAndProtocol"}),": ",(0,s.jsx)(n.code,{children:"string"}),"]: ",(0,s.jsx)(n.code,{children:"unknown"})]}),"\n",(0,s.jsx)(n.h4,{id:"hostname",children:"Hostname"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Hostname"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"image",children:"Image"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Image"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"labels",children:"Labels"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Labels"}),": ",(0,s.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,s.jsx)(n.h5,{id:"index-signature-1",children:"Index Signature"}),"\n",(0,s.jsxs)(n.p,{children:["[",(0,s.jsx)(n.code,{children:"label"}),": ",(0,s.jsx)(n.code,{children:"string"}),"]: ",(0,s.jsx)(n.code,{children:"string"})]}),"\n",(0,s.jsx)(n.h4,{id:"onbuild",children:"OnBuild"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"OnBuild"}),": ",(0,s.jsx)(n.code,{children:"unknown"}),"[]"]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"openstdin",children:"OpenStdin"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"OpenStdin"}),": ",(0,s.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"stdinonce",children:"StdinOnce"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"StdinOnce"}),": ",(0,s.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"tty",children:"Tty"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Tty"}),": ",(0,s.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"user",children:"User"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"User"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"volumes",children:"Volumes"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Volumes"}),": ",(0,s.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,s.jsx)(n.h5,{id:"index-signature-2",children:"Index Signature"}),"\n",(0,s.jsxs)(n.p,{children:["[",(0,s.jsx)(n.code,{children:"path"}),": ",(0,s.jsx)(n.code,{children:"string"}),"]: ",(0,s.jsx)(n.code,{children:"unknown"})]}),"\n",(0,s.jsx)(n.h4,{id:"workingdir",children:"WorkingDir"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"WorkingDir"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-3",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2210",children:"packages/extension-api/src/extension-api.d.ts:2210"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"container",children:"Container"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Container"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-4",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2186",children:"packages/extension-api/src/extension-api.d.ts:2186"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"containerconfig",children:"ContainerConfig"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"ContainerConfig"}),": ",(0,s.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"argsescaped-1",children:"ArgsEscaped"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"ArgsEscaped"}),": ",(0,s.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"attachstderr-1",children:"AttachStderr"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"AttachStderr"}),": ",(0,s.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"attachstdin-1",children:"AttachStdin"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"AttachStdin"}),": ",(0,s.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"attachstdout-1",children:"AttachStdout"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"AttachStdout"}),": ",(0,s.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"cmd-1",children:"Cmd"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Cmd"}),": ",(0,s.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"domainname-1",children:"Domainname"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Domainname"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"entrypoint-1",children:"Entrypoint?"}),"\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:"Entrypoint"}),": ",(0,s.jsx)(n.code,{children:"string"})," | ",(0,s.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"env-1",children:"Env"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Env"}),": ",(0,s.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"exposedports-1",children:"ExposedPorts"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"ExposedPorts"}),": ",(0,s.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,s.jsx)(n.h5,{id:"index-signature-3",children:"Index Signature"}),"\n",(0,s.jsxs)(n.p,{children:["[",(0,s.jsx)(n.code,{children:"portAndProtocol"}),": ",(0,s.jsx)(n.code,{children:"string"}),"]: ",(0,s.jsx)(n.code,{children:"unknown"})]}),"\n",(0,s.jsx)(n.h4,{id:"hostname-1",children:"Hostname"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Hostname"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"image-1",children:"Image"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Image"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"labels-1",children:"Labels"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Labels"}),": ",(0,s.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,s.jsx)(n.h5,{id:"index-signature-4",children:"Index Signature"}),"\n",(0,s.jsxs)(n.p,{children:["[",(0,s.jsx)(n.code,{children:"label"}),": ",(0,s.jsx)(n.code,{children:"string"}),"]: ",(0,s.jsx)(n.code,{children:"string"})]}),"\n",(0,s.jsx)(n.h4,{id:"onbuild-1",children:"OnBuild?"}),"\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:"OnBuild"}),": ",(0,s.jsx)(n.code,{children:"unknown"}),"[]"]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"openstdin-1",children:"OpenStdin"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"OpenStdin"}),": ",(0,s.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"stdinonce-1",children:"StdinOnce"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"StdinOnce"}),": ",(0,s.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"tty-1",children:"Tty"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Tty"}),": ",(0,s.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"user-1",children:"User"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"User"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"volumes-1",children:"Volumes"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Volumes"}),": ",(0,s.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,s.jsx)(n.h5,{id:"index-signature-5",children:"Index Signature"}),"\n",(0,s.jsxs)(n.p,{children:["[",(0,s.jsx)(n.code,{children:"path"}),": ",(0,s.jsx)(n.code,{children:"string"}),"]: ",(0,s.jsx)(n.code,{children:"unknown"})]}),"\n",(0,s.jsx)(n.h4,{id:"workingdir-1",children:"WorkingDir"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"WorkingDir"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-5",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2187",children:"packages/extension-api/src/extension-api.d.ts:2187"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"created",children:"Created"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Created"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-6",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2185",children:"packages/extension-api/src/extension-api.d.ts:2185"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"dockerversion",children:"DockerVersion"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"DockerVersion"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-7",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2208",children:"packages/extension-api/src/extension-api.d.ts:2208"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"graphdriver",children:"GraphDriver"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"GraphDriver"}),": ",(0,s.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"data",children:"Data"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Data"}),": ",(0,s.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"datadeviceid",children:"Data.DeviceId"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"DeviceId"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"datadevicename",children:"Data.DeviceName"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"DeviceName"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"datadevicesize",children:"Data.DeviceSize"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"DeviceSize"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{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:"defined-in-8",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2235",children:"packages/extension-api/src/extension-api.d.ts:2235"})}),"\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:"defined-in-9",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2180",children:"packages/extension-api/src/extension-api.d.ts:2180"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"os",children:"Os"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Os"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-10",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2232",children:"packages/extension-api/src/extension-api.d.ts:2232"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"parent",children:"Parent"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Parent"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-11",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2183",children:"packages/extension-api/src/extension-api.d.ts:2183"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"repodigests",children:"RepoDigests"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"RepoDigests"}),": ",(0,s.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-12",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2182",children:"packages/extension-api/src/extension-api.d.ts:2182"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"repotags",children:"RepoTags"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"RepoTags"}),": ",(0,s.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-13",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2181",children:"packages/extension-api/src/extension-api.d.ts:2181"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"rootfs",children:"RootFS"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"RootFS"}),": ",(0,s.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"baselayer",children:"BaseLayer?"}),"\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:"BaseLayer"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"layers",children:"Layers?"}),"\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:"Layers"}),": ",(0,s.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"type",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:"defined-in-14",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2243",children:"packages/extension-api/src/extension-api.d.ts:2243"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"size",children:"Size"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Size"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-15",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2233",children:"packages/extension-api/src/extension-api.d.ts:2233"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"virtualsize",children:"VirtualSize"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"VirtualSize"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-16",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2234",children:"packages/extension-api/src/extension-api.d.ts:2234"})}),"\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.h4,{id:"defined-in-17",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2178",children:"packages/extension-api/src/extension-api.d.ts:2178"})}),"\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.h4,{id:"defined-in-18",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2179",children:"packages/extension-api/src/extension-api.d.ts:2179"})})]})}function h(e={}){const{wrapper:n}={...(0,d.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(a,{...e})}):a(e)}},43023:(e,n,i)=>{i.d(n,{R:()=>c,x:()=>l});var s=i(63696);const d={},r=s.createContext(d);function c(e){const n=s.useContext(r);return s.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),s.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[95505],{46186:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>t,contentTitle:()=>r,default:()=>h,frontMatter:()=>c,metadata:()=>l,toc:()=>o});var s=i(62540),d=i(43023);const c={},r="Interface: ImageInspectInfo",l={id:"interfaces/ImageInspectInfo",title:"Interface: ImageInspectInfo",description:"Properties",source:"@site/api/interfaces/ImageInspectInfo.md",sourceDirName:"interfaces",slug:"/interfaces/ImageInspectInfo",permalink:"/api/interfaces/ImageInspectInfo",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"ImageInfo",permalink:"/api/interfaces/ImageInfo"},next:{title:"InputBoxOptions",permalink:"/api/interfaces/InputBoxOptions"}},t={},o=[{value:"Properties",id:"properties",level:2},{value:"Architecture",id:"architecture",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"Author",id:"author",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"Comment",id:"comment",level:3},{value:"Defined in",id:"defined-in-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:"Defined in",id:"defined-in-3",level:4},{value:"Container",id:"container",level:3},{value:"Defined in",id:"defined-in-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:"Defined in",id:"defined-in-5",level:4},{value:"Created",id:"created",level:3},{value:"Defined in",id:"defined-in-6",level:4},{value:"DockerVersion",id:"dockerversion",level:3},{value:"Defined in",id:"defined-in-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:"Defined in",id:"defined-in-8",level:4},{value:"Id",id:"id",level:3},{value:"Defined in",id:"defined-in-9",level:4},{value:"Os",id:"os",level:3},{value:"Defined in",id:"defined-in-10",level:4},{value:"Parent",id:"parent",level:3},{value:"Defined in",id:"defined-in-11",level:4},{value:"RepoDigests",id:"repodigests",level:3},{value:"Defined in",id:"defined-in-12",level:4},{value:"RepoTags",id:"repotags",level:3},{value:"Defined in",id:"defined-in-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:"Defined in",id:"defined-in-14",level:4},{value:"Size",id:"size",level:3},{value:"Defined in",id:"defined-in-15",level:4},{value:"VirtualSize",id:"virtualsize",level:3},{value:"Defined in",id:"defined-in-16",level:4},{value:"engineId",id:"engineid",level:3},{value:"Defined in",id:"defined-in-17",level:4},{value:"engineName",id:"enginename",level:3},{value:"Defined in",id:"defined-in-18",level:4}];function a(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",h5:"h5",header:"header",hr:"hr",p:"p",strong:"strong",...(0,d.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.header,{children:(0,s.jsx)(n.h1,{id:"interface-imageinspectinfo",children:"Interface: ImageInspectInfo"})}),"\n",(0,s.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,s.jsx)(n.h3,{id:"architecture",children:"Architecture"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Architecture"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2231",children:"packages/extension-api/src/extension-api.d.ts:2231"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"author",children:"Author"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Author"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2209",children:"packages/extension-api/src/extension-api.d.ts:2209"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"comment",children:"Comment"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Comment"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-2",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2184",children:"packages/extension-api/src/extension-api.d.ts:2184"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"config",children:"Config"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Config"}),": ",(0,s.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"argsescaped",children:"ArgsEscaped"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"ArgsEscaped"}),": ",(0,s.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"attachstderr",children:"AttachStderr"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"AttachStderr"}),": ",(0,s.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"attachstdin",children:"AttachStdin"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"AttachStdin"}),": ",(0,s.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"attachstdout",children:"AttachStdout"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"AttachStdout"}),": ",(0,s.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"cmd",children:"Cmd"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Cmd"}),": ",(0,s.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"domainname",children:"Domainname"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Domainname"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"entrypoint",children:"Entrypoint?"}),"\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:"Entrypoint"}),": ",(0,s.jsx)(n.code,{children:"string"})," | ",(0,s.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"env",children:"Env"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Env"}),": ",(0,s.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"exposedports",children:"ExposedPorts"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"ExposedPorts"}),": ",(0,s.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,s.jsx)(n.h5,{id:"index-signature",children:"Index Signature"}),"\n",(0,s.jsxs)(n.p,{children:["[",(0,s.jsx)(n.code,{children:"portAndProtocol"}),": ",(0,s.jsx)(n.code,{children:"string"}),"]: ",(0,s.jsx)(n.code,{children:"unknown"})]}),"\n",(0,s.jsx)(n.h4,{id:"hostname",children:"Hostname"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Hostname"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"image",children:"Image"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Image"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"labels",children:"Labels"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Labels"}),": ",(0,s.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,s.jsx)(n.h5,{id:"index-signature-1",children:"Index Signature"}),"\n",(0,s.jsxs)(n.p,{children:["[",(0,s.jsx)(n.code,{children:"label"}),": ",(0,s.jsx)(n.code,{children:"string"}),"]: ",(0,s.jsx)(n.code,{children:"string"})]}),"\n",(0,s.jsx)(n.h4,{id:"onbuild",children:"OnBuild"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"OnBuild"}),": ",(0,s.jsx)(n.code,{children:"unknown"}),"[]"]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"openstdin",children:"OpenStdin"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"OpenStdin"}),": ",(0,s.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"stdinonce",children:"StdinOnce"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"StdinOnce"}),": ",(0,s.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"tty",children:"Tty"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Tty"}),": ",(0,s.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"user",children:"User"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"User"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"volumes",children:"Volumes"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Volumes"}),": ",(0,s.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,s.jsx)(n.h5,{id:"index-signature-2",children:"Index Signature"}),"\n",(0,s.jsxs)(n.p,{children:["[",(0,s.jsx)(n.code,{children:"path"}),": ",(0,s.jsx)(n.code,{children:"string"}),"]: ",(0,s.jsx)(n.code,{children:"unknown"})]}),"\n",(0,s.jsx)(n.h4,{id:"workingdir",children:"WorkingDir"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"WorkingDir"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-3",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2210",children:"packages/extension-api/src/extension-api.d.ts:2210"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"container",children:"Container"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Container"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-4",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2186",children:"packages/extension-api/src/extension-api.d.ts:2186"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"containerconfig",children:"ContainerConfig"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"ContainerConfig"}),": ",(0,s.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"argsescaped-1",children:"ArgsEscaped"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"ArgsEscaped"}),": ",(0,s.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"attachstderr-1",children:"AttachStderr"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"AttachStderr"}),": ",(0,s.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"attachstdin-1",children:"AttachStdin"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"AttachStdin"}),": ",(0,s.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"attachstdout-1",children:"AttachStdout"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"AttachStdout"}),": ",(0,s.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"cmd-1",children:"Cmd"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Cmd"}),": ",(0,s.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"domainname-1",children:"Domainname"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Domainname"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"entrypoint-1",children:"Entrypoint?"}),"\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:"Entrypoint"}),": ",(0,s.jsx)(n.code,{children:"string"})," | ",(0,s.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"env-1",children:"Env"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Env"}),": ",(0,s.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"exposedports-1",children:"ExposedPorts"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"ExposedPorts"}),": ",(0,s.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,s.jsx)(n.h5,{id:"index-signature-3",children:"Index Signature"}),"\n",(0,s.jsxs)(n.p,{children:["[",(0,s.jsx)(n.code,{children:"portAndProtocol"}),": ",(0,s.jsx)(n.code,{children:"string"}),"]: ",(0,s.jsx)(n.code,{children:"unknown"})]}),"\n",(0,s.jsx)(n.h4,{id:"hostname-1",children:"Hostname"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Hostname"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"image-1",children:"Image"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Image"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"labels-1",children:"Labels"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Labels"}),": ",(0,s.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,s.jsx)(n.h5,{id:"index-signature-4",children:"Index Signature"}),"\n",(0,s.jsxs)(n.p,{children:["[",(0,s.jsx)(n.code,{children:"label"}),": ",(0,s.jsx)(n.code,{children:"string"}),"]: ",(0,s.jsx)(n.code,{children:"string"})]}),"\n",(0,s.jsx)(n.h4,{id:"onbuild-1",children:"OnBuild?"}),"\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:"OnBuild"}),": ",(0,s.jsx)(n.code,{children:"unknown"}),"[]"]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"openstdin-1",children:"OpenStdin"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"OpenStdin"}),": ",(0,s.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"stdinonce-1",children:"StdinOnce"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"StdinOnce"}),": ",(0,s.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"tty-1",children:"Tty"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Tty"}),": ",(0,s.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"user-1",children:"User"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"User"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"volumes-1",children:"Volumes"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Volumes"}),": ",(0,s.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,s.jsx)(n.h5,{id:"index-signature-5",children:"Index Signature"}),"\n",(0,s.jsxs)(n.p,{children:["[",(0,s.jsx)(n.code,{children:"path"}),": ",(0,s.jsx)(n.code,{children:"string"}),"]: ",(0,s.jsx)(n.code,{children:"unknown"})]}),"\n",(0,s.jsx)(n.h4,{id:"workingdir-1",children:"WorkingDir"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"WorkingDir"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-5",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2187",children:"packages/extension-api/src/extension-api.d.ts:2187"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"created",children:"Created"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Created"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-6",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2185",children:"packages/extension-api/src/extension-api.d.ts:2185"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"dockerversion",children:"DockerVersion"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"DockerVersion"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-7",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2208",children:"packages/extension-api/src/extension-api.d.ts:2208"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"graphdriver",children:"GraphDriver"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"GraphDriver"}),": ",(0,s.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"data",children:"Data"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Data"}),": ",(0,s.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"datadeviceid",children:"Data.DeviceId"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"DeviceId"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"datadevicename",children:"Data.DeviceName"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"DeviceName"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"datadevicesize",children:"Data.DeviceSize"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"DeviceSize"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{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:"defined-in-8",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2235",children:"packages/extension-api/src/extension-api.d.ts:2235"})}),"\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:"defined-in-9",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2180",children:"packages/extension-api/src/extension-api.d.ts:2180"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"os",children:"Os"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Os"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-10",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2232",children:"packages/extension-api/src/extension-api.d.ts:2232"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"parent",children:"Parent"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Parent"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-11",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2183",children:"packages/extension-api/src/extension-api.d.ts:2183"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"repodigests",children:"RepoDigests"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"RepoDigests"}),": ",(0,s.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-12",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2182",children:"packages/extension-api/src/extension-api.d.ts:2182"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"repotags",children:"RepoTags"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"RepoTags"}),": ",(0,s.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-13",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2181",children:"packages/extension-api/src/extension-api.d.ts:2181"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"rootfs",children:"RootFS"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"RootFS"}),": ",(0,s.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"baselayer",children:"BaseLayer?"}),"\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:"BaseLayer"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"layers",children:"Layers?"}),"\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:"Layers"}),": ",(0,s.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"type",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:"defined-in-14",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2243",children:"packages/extension-api/src/extension-api.d.ts:2243"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"size",children:"Size"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Size"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-15",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2233",children:"packages/extension-api/src/extension-api.d.ts:2233"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"virtualsize",children:"VirtualSize"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"VirtualSize"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-16",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2234",children:"packages/extension-api/src/extension-api.d.ts:2234"})}),"\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.h4,{id:"defined-in-17",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2178",children:"packages/extension-api/src/extension-api.d.ts:2178"})}),"\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.h4,{id:"defined-in-18",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2179",children:"packages/extension-api/src/extension-api.d.ts:2179"})})]})}function h(e={}){const{wrapper:n}={...(0,d.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(a,{...e})}):a(e)}},43023:(e,n,i)=>{i.d(n,{R:()=>r,x:()=>l});var s=i(63696);const d={},c=s.createContext(d);function r(e){const n=s.useContext(c);return s.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),s.createElement(c.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/871ce139.ac4518c5.js b/assets/js/871ce139.3c20e387.js similarity index 94% rename from assets/js/871ce139.ac4518c5.js rename to assets/js/871ce139.3c20e387.js index 9e221ffb64f..5bba4d301af 100644 --- a/assets/js/871ce139.ac4518c5.js +++ b/assets/js/871ce139.3c20e387.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[12978],{46629:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>c,contentTitle:()=>s,default:()=>l,frontMatter:()=>o,metadata:()=>a,toc:()=>d});var r=n(62540),i=n(43023);const o={},s="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={},d=[{value:"Properties",id:"properties",level:2},{value:"Name",id:"name",level:3},{value:"Defined in",id:"defined-in",level:4}];function p(e){const t={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",p:"p",strong:"strong",...(0,i.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(t.header,{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:"defined-in",children:"Defined in"}),"\n",(0,r.jsx)(t.p,{children:(0,r.jsx)(t.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L3351",children:"packages/extension-api/src/extension-api.d.ts:3351"})})]})}function l(e={}){const{wrapper:t}={...(0,i.R)(),...e.components};return t?(0,r.jsx)(t,{...e,children:(0,r.jsx)(p,{...e})}):p(e)}},43023:(e,t,n)=>{n.d(t,{R:()=>s,x:()=>a});var r=n(63696);const i={},o=r.createContext(i);function s(e){const t=r.useContext(o);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(i):e.components||i:s(e.components),r.createElement(o.Provider,{value:t},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[12978],{46629:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>c,contentTitle:()=>s,default:()=>l,frontMatter:()=>o,metadata:()=>a,toc:()=>d});var r=n(62540),i=n(43023);const o={},s="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={},d=[{value:"Properties",id:"properties",level:2},{value:"Name",id:"name",level:3},{value:"Defined in",id:"defined-in",level:4}];function p(e){const t={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",p:"p",strong:"strong",...(0,i.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(t.header,{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:"defined-in",children:"Defined in"}),"\n",(0,r.jsx)(t.p,{children:(0,r.jsx)(t.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L3351",children:"packages/extension-api/src/extension-api.d.ts:3351"})})]})}function l(e={}){const{wrapper:t}={...(0,i.R)(),...e.components};return t?(0,r.jsx)(t,{...e,children:(0,r.jsx)(p,{...e})}):p(e)}},43023:(e,t,n)=>{n.d(t,{R:()=>s,x:()=>a});var r=n(63696);const i={},o=r.createContext(i);function s(e){const t=r.useContext(o);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(i):e.components||i:s(e.components),r.createElement(o.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/873d332f.de5513fd.js b/assets/js/873d332f.8e6a6347.js similarity index 85% rename from assets/js/873d332f.de5513fd.js rename to assets/js/873d332f.8e6a6347.js index ea65ee2c89f..ef3469cd9ba 100644 --- a/assets/js/873d332f.de5513fd.js +++ b/assets/js/873d332f.8e6a6347.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[54691],{97681:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>a,contentTitle:()=>l,default:()=>h,frontMatter:()=>o,metadata:()=>r,toc:()=>t});var s=i(62540),d=i(43023);const o={},l="Interface: CliToolInfo",r={id:"interfaces/CliToolInfo",title:"Interface: CliToolInfo",description:"Extended by",source:"@site/api/interfaces/CliToolInfo.md",sourceDirName:"interfaces",slug:"/interfaces/CliToolInfo",permalink:"/api/interfaces/CliToolInfo",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"CliTool",permalink:"/api/interfaces/CliTool"},next:{title:"CliToolInstaller",permalink:"/api/interfaces/CliToolInstaller"}},a={},t=[{value:"Extended by",id:"extended-by",level:2},{value:"Properties",id:"properties",level:2},{value:"displayName",id:"displayname",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"extensionInfo",id:"extensioninfo",level:3},{value:"id",id:"id",level:4},{value:"label",id:"label",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"id",id:"id-1",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"images",id:"images",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"markdownDescription",id:"markdowndescription",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"name",id:"name",level:3},{value:"Defined in",id:"defined-in-5",level:4},{value:"version?",id:"version",level:3},{value:"Defined in",id:"defined-in-6",level:4}];function c(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",li:"li",p:"p",strong:"strong",ul:"ul",...(0,d.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.header,{children:(0,s.jsx)(n.h1,{id:"interface-clitoolinfo",children:"Interface: CliToolInfo"})}),"\n",(0,s.jsx)(n.h2,{id:"extended-by",children:"Extended by"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.a,{href:"/api/interfaces/CliTool",children:(0,s.jsx)(n.code,{children:"CliTool"})})}),"\n"]}),"\n",(0,s.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,s.jsx)(n.h3,{id:"displayname",children:"displayName"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"displayName"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L4381",children:"packages/extension-api/src/extension-api.d.ts:4381"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"extensioninfo",children:"extensionInfo"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"extensionInfo"}),": ",(0,s.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{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:"label",children:"label"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"label"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L4385",children:"packages/extension-api/src/extension-api.d.ts:4385"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"id-1",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:"defined-in-2",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L4379",children:"packages/extension-api/src/extension-api.d.ts:4379"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"images",children:"images"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"images"}),": ",(0,s.jsx)(n.a,{href:"/api/interfaces/ProviderImages",children:(0,s.jsx)(n.code,{children:"ProviderImages"})})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-3",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L4383",children:"packages/extension-api/src/extension-api.d.ts:4383"})}),"\n",(0,s.jsx)(n.hr,{}),"\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.strong,{children:"markdownDescription"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-4",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L4382",children:"packages/extension-api/src/extension-api.d.ts:4382"})}),"\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:"defined-in-5",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L4380",children:"packages/extension-api/src/extension-api.d.ts:4380"})}),"\n",(0,s.jsx)(n.hr,{}),"\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.code,{children:"optional"})," ",(0,s.jsx)(n.strong,{children:"version"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-6",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L4384",children:"packages/extension-api/src/extension-api.d.ts:4384"})})]})}function h(e={}){const{wrapper:n}={...(0,d.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(c,{...e})}):c(e)}},43023:(e,n,i)=>{i.d(n,{R:()=>l,x:()=>r});var s=i(63696);const d={},o=s.createContext(d);function l(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(d):e.components||d:l(e.components),s.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[54691],{97681:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>c,contentTitle:()=>l,default:()=>h,frontMatter:()=>o,metadata:()=>r,toc:()=>a});var s=i(62540),d=i(43023);const o={},l="Interface: CliToolInfo",r={id:"interfaces/CliToolInfo",title:"Interface: CliToolInfo",description:"Extended by",source:"@site/api/interfaces/CliToolInfo.md",sourceDirName:"interfaces",slug:"/interfaces/CliToolInfo",permalink:"/api/interfaces/CliToolInfo",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"CliTool",permalink:"/api/interfaces/CliTool"},next:{title:"CliToolInstaller",permalink:"/api/interfaces/CliToolInstaller"}},c={},a=[{value:"Extended by",id:"extended-by",level:2},{value:"Properties",id:"properties",level:2},{value:"displayName",id:"displayname",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"extensionInfo",id:"extensioninfo",level:3},{value:"id",id:"id",level:4},{value:"label",id:"label",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"id",id:"id-1",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"images",id:"images",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"markdownDescription",id:"markdowndescription",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"name",id:"name",level:3},{value:"Defined in",id:"defined-in-5",level:4},{value:"version?",id:"version",level:3},{value:"Defined in",id:"defined-in-6",level:4}];function t(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",li:"li",p:"p",strong:"strong",ul:"ul",...(0,d.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.header,{children:(0,s.jsx)(n.h1,{id:"interface-clitoolinfo",children:"Interface: CliToolInfo"})}),"\n",(0,s.jsx)(n.h2,{id:"extended-by",children:"Extended by"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.a,{href:"/api/interfaces/CliTool",children:(0,s.jsx)(n.code,{children:"CliTool"})})}),"\n"]}),"\n",(0,s.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,s.jsx)(n.h3,{id:"displayname",children:"displayName"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"displayName"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L4381",children:"packages/extension-api/src/extension-api.d.ts:4381"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"extensioninfo",children:"extensionInfo"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"extensionInfo"}),": ",(0,s.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{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:"label",children:"label"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"label"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L4385",children:"packages/extension-api/src/extension-api.d.ts:4385"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"id-1",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:"defined-in-2",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L4379",children:"packages/extension-api/src/extension-api.d.ts:4379"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"images",children:"images"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"images"}),": ",(0,s.jsx)(n.a,{href:"/api/interfaces/ProviderImages",children:(0,s.jsx)(n.code,{children:"ProviderImages"})})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-3",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L4383",children:"packages/extension-api/src/extension-api.d.ts:4383"})}),"\n",(0,s.jsx)(n.hr,{}),"\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.strong,{children:"markdownDescription"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-4",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L4382",children:"packages/extension-api/src/extension-api.d.ts:4382"})}),"\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:"defined-in-5",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L4380",children:"packages/extension-api/src/extension-api.d.ts:4380"})}),"\n",(0,s.jsx)(n.hr,{}),"\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.code,{children:"optional"})," ",(0,s.jsx)(n.strong,{children:"version"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-6",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L4384",children:"packages/extension-api/src/extension-api.d.ts:4384"})})]})}function h(e={}){const{wrapper:n}={...(0,d.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(t,{...e})}):t(e)}},43023:(e,n,i)=>{i.d(n,{R:()=>l,x:()=>r});var s=i(63696);const d={},o=s.createContext(d);function l(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(d):e.components||d:l(e.components),s.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/874690d0.31a5cfd3.js b/assets/js/874690d0.ae978a69.js similarity index 92% rename from assets/js/874690d0.31a5cfd3.js rename to assets/js/874690d0.ae978a69.js index 6804748d0e6..4d2aa6b8f51 100644 --- a/assets/js/874690d0.31a5cfd3.js +++ b/assets/js/874690d0.ae978a69.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[88041],{67629:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>o,contentTitle:()=>a,default:()=>h,frontMatter:()=>d,metadata:()=>r,toc:()=>c});var s=i(62540),t=i(43023);const d={},a="Interface: StatusBarItem",r={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"}},o={},c=[{value:"Properties",id:"properties",level:2},{value:"alignment",id:"alignment",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"command?",id:"command",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"commandArgs?",id:"commandargs",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"enabled",id:"enabled",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"iconClass?",id:"iconclass",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"priority",id:"priority",level:3},{value:"Defined in",id:"defined-in-5",level:4},{value:"text?",id:"text",level:3},{value:"Defined in",id:"defined-in-6",level:4},{value:"tooltip?",id:"tooltip",level:3},{value:"Defined in",id:"defined-in-7",level:4},{value:"Methods",id:"methods",level:2},{value:"dispose()",id:"dispose",level:3},{value:"Returns",id:"returns",level:4},{value:"Defined in",id:"defined-in-8",level:4},{value:"hide()",id:"hide",level:3},{value:"Returns",id:"returns-1",level:4},{value:"Defined in",id:"defined-in-9",level:4},{value:"show()",id:"show",level:3},{value:"Returns",id:"returns-2",level:4},{value:"Defined in",id:"defined-in-10",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",p:"p",strong:"strong",...(0,t.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.header,{children:(0,s.jsx)(n.h1,{id:"interface-statusbaritem",children:"Interface: StatusBarItem"})}),"\n",(0,s.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,s.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,s.jsx)(n.h3,{id:"alignment",children:"alignment"}),"\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:"alignment"}),": ",(0,s.jsx)(n.a,{href:"/api/type-aliases/StatusBarAlignment",children:(0,s.jsx)(n.code,{children:"StatusBarAlignment"})})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The alignment of this item."}),"\n",(0,s.jsx)(n.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L1506",children:"packages/extension-api/src/extension-api.d.ts:1506"})}),"\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.code,{children:"optional"})," ",(0,s.jsx)(n.strong,{children:"command"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:["The identifier of a command, previously registered with ",(0,s.jsx)(n.a,{href:"/api/namespaces/commands/functions/registerCommand",children:"commands.registerCommand"}),", to run on click."]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L1534",children:"packages/extension-api/src/extension-api.d.ts:1534"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"commandargs",children:"commandArgs?"}),"\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:"commandArgs"}),": ",(0,s.jsx)(n.code,{children:"any"}),"[]"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Arguments that the command handler should be invoked with."}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-2",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L1539",children:"packages/extension-api/src/extension-api.d.ts:1539"})}),"\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.strong,{children:"enabled"}),": ",(0,s.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,s.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,s.jsx)(n.h4,{id:"defined-in-3",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L1530",children:"packages/extension-api/src/extension-api.d.ts:1530"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"iconclass",children:"iconClass?"}),"\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:"iconClass"}),": ",(0,s.jsx)(n.code,{children:"string"})," | ",(0,s.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,s.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,s.jsx)(n.h4,{id:"defined-in-4",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L1525",children:"packages/extension-api/src/extension-api.d.ts:1525"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"priority",children:"priority"}),"\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:"priority"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.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,s.jsx)(n.h4,{id:"defined-in-5",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L1511",children:"packages/extension-api/src/extension-api.d.ts:1511"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"text",children:"text?"}),"\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:"text"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The text to show for the entry."}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-6",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L1515",children:"packages/extension-api/src/extension-api.d.ts:1515"})}),"\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.p,{children:"The tooltip text when you hover over this entry."}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-7",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L1519",children:"packages/extension-api/src/extension-api.d.ts:1519"})}),"\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.jsxs)(n.p,{children:["Dispose and free associated resources. Call\n",(0,s.jsx)(n.a,{href:"/api/interfaces/StatusBarItem#hide",children:"StatusBarItem.hide"}),"."]}),"\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:"defined-in-8",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L1553",children:"packages/extension-api/src/extension-api.d.ts:1553"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"hide",children:"hide()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"hide"}),"(): ",(0,s.jsx)(n.code,{children:"void"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Hides the entry in the status bar."}),"\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:"defined-in-9",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L1547",children:"packages/extension-api/src/extension-api.d.ts:1547"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"show",children:"show()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"show"}),"(): ",(0,s.jsx)(n.code,{children:"void"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Shows the entry in the status bar."}),"\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:"defined-in-10",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L1543",children:"packages/extension-api/src/extension-api.d.ts:1543"})})]})}function h(e={}){const{wrapper:n}={...(0,t.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},43023:(e,n,i)=>{i.d(n,{R:()=>a,x:()=>r});var s=i(63696);const t={},d=s.createContext(t);function a(e){const n=s.useContext(d);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:a(e.components),s.createElement(d.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[88041],{67629:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>o,contentTitle:()=>a,default:()=>h,frontMatter:()=>d,metadata:()=>r,toc:()=>c});var s=i(62540),t=i(43023);const d={},a="Interface: StatusBarItem",r={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"}},o={},c=[{value:"Properties",id:"properties",level:2},{value:"alignment",id:"alignment",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"command?",id:"command",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"commandArgs?",id:"commandargs",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"enabled",id:"enabled",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"iconClass?",id:"iconclass",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"priority",id:"priority",level:3},{value:"Defined in",id:"defined-in-5",level:4},{value:"text?",id:"text",level:3},{value:"Defined in",id:"defined-in-6",level:4},{value:"tooltip?",id:"tooltip",level:3},{value:"Defined in",id:"defined-in-7",level:4},{value:"Methods",id:"methods",level:2},{value:"dispose()",id:"dispose",level:3},{value:"Returns",id:"returns",level:4},{value:"Defined in",id:"defined-in-8",level:4},{value:"hide()",id:"hide",level:3},{value:"Returns",id:"returns-1",level:4},{value:"Defined in",id:"defined-in-9",level:4},{value:"show()",id:"show",level:3},{value:"Returns",id:"returns-2",level:4},{value:"Defined in",id:"defined-in-10",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",p:"p",strong:"strong",...(0,t.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.header,{children:(0,s.jsx)(n.h1,{id:"interface-statusbaritem",children:"Interface: StatusBarItem"})}),"\n",(0,s.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,s.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,s.jsx)(n.h3,{id:"alignment",children:"alignment"}),"\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:"alignment"}),": ",(0,s.jsx)(n.a,{href:"/api/type-aliases/StatusBarAlignment",children:(0,s.jsx)(n.code,{children:"StatusBarAlignment"})})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The alignment of this item."}),"\n",(0,s.jsx)(n.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L1506",children:"packages/extension-api/src/extension-api.d.ts:1506"})}),"\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.code,{children:"optional"})," ",(0,s.jsx)(n.strong,{children:"command"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:["The identifier of a command, previously registered with ",(0,s.jsx)(n.a,{href:"/api/namespaces/commands/functions/registerCommand",children:"commands.registerCommand"}),", to run on click."]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L1534",children:"packages/extension-api/src/extension-api.d.ts:1534"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"commandargs",children:"commandArgs?"}),"\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:"commandArgs"}),": ",(0,s.jsx)(n.code,{children:"any"}),"[]"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Arguments that the command handler should be invoked with."}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-2",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L1539",children:"packages/extension-api/src/extension-api.d.ts:1539"})}),"\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.strong,{children:"enabled"}),": ",(0,s.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,s.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,s.jsx)(n.h4,{id:"defined-in-3",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L1530",children:"packages/extension-api/src/extension-api.d.ts:1530"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"iconclass",children:"iconClass?"}),"\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:"iconClass"}),": ",(0,s.jsx)(n.code,{children:"string"})," | ",(0,s.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,s.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,s.jsx)(n.h4,{id:"defined-in-4",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L1525",children:"packages/extension-api/src/extension-api.d.ts:1525"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"priority",children:"priority"}),"\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:"priority"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.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,s.jsx)(n.h4,{id:"defined-in-5",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L1511",children:"packages/extension-api/src/extension-api.d.ts:1511"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"text",children:"text?"}),"\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:"text"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The text to show for the entry."}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-6",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L1515",children:"packages/extension-api/src/extension-api.d.ts:1515"})}),"\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.p,{children:"The tooltip text when you hover over this entry."}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-7",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L1519",children:"packages/extension-api/src/extension-api.d.ts:1519"})}),"\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.jsxs)(n.p,{children:["Dispose and free associated resources. Call\n",(0,s.jsx)(n.a,{href:"/api/interfaces/StatusBarItem#hide",children:"StatusBarItem.hide"}),"."]}),"\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:"defined-in-8",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L1553",children:"packages/extension-api/src/extension-api.d.ts:1553"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"hide",children:"hide()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"hide"}),"(): ",(0,s.jsx)(n.code,{children:"void"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Hides the entry in the status bar."}),"\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:"defined-in-9",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L1547",children:"packages/extension-api/src/extension-api.d.ts:1547"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"show",children:"show()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"show"}),"(): ",(0,s.jsx)(n.code,{children:"void"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Shows the entry in the status bar."}),"\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:"defined-in-10",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L1543",children:"packages/extension-api/src/extension-api.d.ts:1543"})})]})}function h(e={}){const{wrapper:n}={...(0,t.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},43023:(e,n,i)=>{i.d(n,{R:()=>a,x:()=>r});var s=i(63696);const t={},d=s.createContext(t);function a(e){const n=s.useContext(d);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:a(e.components),s.createElement(d.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/8785b74d.538df7a9.js b/assets/js/8785b74d.1cd69543.js similarity index 91% rename from assets/js/8785b74d.538df7a9.js rename to assets/js/8785b74d.1cd69543.js index 94a03b1f91a..92481d1f23f 100644 --- a/assets/js/8785b74d.538df7a9.js +++ b/assets/js/8785b74d.1cd69543.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[56576],{69238:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>l,contentTitle:()=>t,default:()=>h,frontMatter:()=>d,metadata:()=>a,toc:()=>o});var s=r(62540),i=r(43023);const d={},t="Interface: TelemetryLogger",a={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={},o=[{value:"Properties",id:"properties",level:2},{value:"isErrorsEnabled",id:"iserrorsenabled",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"isUsageEnabled",id:"isusageenabled",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"onDidChangeEnableStates",id:"ondidchangeenablestates",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"Methods",id:"methods",level:2},{value:"dispose()",id:"dispose",level:3},{value:"Returns",id:"returns",level:4},{value:"Defined in",id:"defined-in-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:"Defined in",id:"defined-in-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:"Defined in",id:"defined-in-5",level:5},{value:"logUsage()",id:"logusage",level:3},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-3",level:4},{value:"Defined in",id:"defined-in-6",level:4}];function c(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",h5:"h5",header:"header",hr:"hr",li:"li",p:"p",strong:"strong",ul:"ul",...(0,i.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.header,{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:"defined-in",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L4178",children:"packages/extension-api/src/extension-api.d.ts:4178"})}),"\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:"defined-in-1",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L4173",children:"packages/extension-api/src/extension-api.d.ts:4173"})}),"\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:"defined-in-2",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L4168",children:"packages/extension-api/src/extension-api.d.ts:4168"})}),"\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:"defined-in-3",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L4213",children:"packages/extension-api/src/extension-api.d.ts:4213"})}),"\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:"defined-in-4",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L4200",children:"packages/extension-api/src/extension-api.d.ts:4200"})}),"\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:"defined-in-5",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L4208",children:"packages/extension-api/src/extension-api.d.ts:4208"})}),"\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:"defined-in-6",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L4189",children:"packages/extension-api/src/extension-api.d.ts:4189"})})]})}function h(e={}){const{wrapper:n}={...(0,i.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(c,{...e})}):c(e)}},43023:(e,n,r)=>{r.d(n,{R:()=>t,x:()=>a});var s=r(63696);const i={},d=s.createContext(i);function t(e){const n=s.useContext(d);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:t(e.components),s.createElement(d.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[56576],{69238:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>l,contentTitle:()=>d,default:()=>h,frontMatter:()=>t,metadata:()=>a,toc:()=>o});var s=r(62540),i=r(43023);const t={},d="Interface: TelemetryLogger",a={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={},o=[{value:"Properties",id:"properties",level:2},{value:"isErrorsEnabled",id:"iserrorsenabled",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"isUsageEnabled",id:"isusageenabled",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"onDidChangeEnableStates",id:"ondidchangeenablestates",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"Methods",id:"methods",level:2},{value:"dispose()",id:"dispose",level:3},{value:"Returns",id:"returns",level:4},{value:"Defined in",id:"defined-in-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:"Defined in",id:"defined-in-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:"Defined in",id:"defined-in-5",level:5},{value:"logUsage()",id:"logusage",level:3},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-3",level:4},{value:"Defined in",id:"defined-in-6",level:4}];function c(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",h5:"h5",header:"header",hr:"hr",li:"li",p:"p",strong:"strong",ul:"ul",...(0,i.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.header,{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:"defined-in",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L4178",children:"packages/extension-api/src/extension-api.d.ts:4178"})}),"\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:"defined-in-1",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L4173",children:"packages/extension-api/src/extension-api.d.ts:4173"})}),"\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:"defined-in-2",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L4168",children:"packages/extension-api/src/extension-api.d.ts:4168"})}),"\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:"defined-in-3",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L4213",children:"packages/extension-api/src/extension-api.d.ts:4213"})}),"\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:"defined-in-4",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L4200",children:"packages/extension-api/src/extension-api.d.ts:4200"})}),"\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:"defined-in-5",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L4208",children:"packages/extension-api/src/extension-api.d.ts:4208"})}),"\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:"defined-in-6",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L4189",children:"packages/extension-api/src/extension-api.d.ts:4189"})})]})}function h(e={}){const{wrapper:n}={...(0,i.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(c,{...e})}):c(e)}},43023:(e,n,r)=>{r.d(n,{R:()=>d,x:()=>a});var s=r(63696);const i={},t=s.createContext(i);function d(e){const n=s.useContext(t);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:d(e.components),s.createElement(t.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/878aa0e7.9b8dbe13.js b/assets/js/878aa0e7.17e767a5.js similarity index 97% rename from assets/js/878aa0e7.9b8dbe13.js rename to assets/js/878aa0e7.17e767a5.js index 4b0defbc878..fed76d5bc97 100644 --- a/assets/js/878aa0e7.9b8dbe13.js +++ b/assets/js/878aa0e7.17e767a5.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[10010],{18744:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>c,contentTitle:()=>s,default:()=>l,frontMatter:()=>r,metadata:()=>a,toc:()=>d});var o=t(62540),i=t(43023);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={},d=[{value:"Defined in",id:"defined-in",level:2}];function p(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",strong:"strong",...(0,i.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(n.header,{children:(0,o.jsx)(n.h1,{id:"type-alias-configurationscope",children:"Type Alias: ConfigurationScope"})}),"\n",(0,o.jsxs)(n.blockquote,{children:["\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.strong,{children:"ConfigurationScope"}),": ",(0,o.jsx)(n.code,{children:"string"})," | ",(0,o.jsx)(n.a,{href:"/api/interfaces/ContainerProviderConnection",children:(0,o.jsx)(n.code,{children:"ContainerProviderConnection"})})," | ",(0,o.jsx)(n.a,{href:"/api/interfaces/KubernetesProviderConnection",children:(0,o.jsx)(n.code,{children:"KubernetesProviderConnection"})})]}),"\n"]}),"\n",(0,o.jsx)(n.p,{children:"The configuration scope"}),"\n",(0,o.jsx)(n.h2,{id:"defined-in",children:"Defined in"}),"\n",(0,o.jsx)(n.p,{children:(0,o.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L963",children:"packages/extension-api/src/extension-api.d.ts:963"})})]})}function l(e={}){const{wrapper:n}={...(0,i.R)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(p,{...e})}):p(e)}},43023:(e,n,t)=>{t.d(n,{R:()=>s,x:()=>a});var o=t(63696);const i={},r=o.createContext(i);function s(e){const n=o.useContext(r);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:s(e.components),o.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[10010],{18744:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>c,contentTitle:()=>s,default:()=>l,frontMatter:()=>r,metadata:()=>a,toc:()=>d});var o=t(62540),i=t(43023);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={},d=[{value:"Defined in",id:"defined-in",level:2}];function p(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",strong:"strong",...(0,i.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(n.header,{children:(0,o.jsx)(n.h1,{id:"type-alias-configurationscope",children:"Type Alias: ConfigurationScope"})}),"\n",(0,o.jsxs)(n.blockquote,{children:["\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.strong,{children:"ConfigurationScope"}),": ",(0,o.jsx)(n.code,{children:"string"})," | ",(0,o.jsx)(n.a,{href:"/api/interfaces/ContainerProviderConnection",children:(0,o.jsx)(n.code,{children:"ContainerProviderConnection"})})," | ",(0,o.jsx)(n.a,{href:"/api/interfaces/KubernetesProviderConnection",children:(0,o.jsx)(n.code,{children:"KubernetesProviderConnection"})})]}),"\n"]}),"\n",(0,o.jsx)(n.p,{children:"The configuration scope"}),"\n",(0,o.jsx)(n.h2,{id:"defined-in",children:"Defined in"}),"\n",(0,o.jsx)(n.p,{children:(0,o.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L963",children:"packages/extension-api/src/extension-api.d.ts:963"})})]})}function l(e={}){const{wrapper:n}={...(0,i.R)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(p,{...e})}):p(e)}},43023:(e,n,t)=>{t.d(n,{R:()=>s,x:()=>a});var o=t(63696);const i={},r=o.createContext(i);function s(e){const n=o.useContext(r);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:s(e.components),o.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/87a5fc8a.06ded9a9.js b/assets/js/87a5fc8a.6f2bfba9.js similarity index 74% rename from assets/js/87a5fc8a.06ded9a9.js rename to assets/js/87a5fc8a.6f2bfba9.js index 48bdf5c2489..2ec1dba50c1 100644 --- a/assets/js/87a5fc8a.06ded9a9.js +++ b/assets/js/87a5fc8a.6f2bfba9.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[2334],{27492:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>o,default:()=>p,frontMatter:()=>r,metadata:()=>c,toc:()=>d});var i=t(62540),s=t(43023);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:"Defined in",id:"defined-in",level:4},{value:"limit?",id:"limit",level:3},{value:"Defined in",id:"defined-in-1",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",p:"p",strong:"strong",...(0,s.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.header,{children:(0,i.jsx)(n.h1,{id:"interface-pidsstats",children:"Interface: PidsStats"})}),"\n",(0,i.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(n.h3,{id:"current",children:"current?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"current"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L3064",children:"packages/extension-api/src/extension-api.d.ts:3064"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"limit",children:"limit?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"limit"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L3065",children:"packages/extension-api/src/extension-api.d.ts:3065"})})]})}function p(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},43023:(e,n,t)=>{t.d(n,{R:()=>o,x:()=>c});var i=t(63696);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([[2334],{27492:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>c,default:()=>p,frontMatter:()=>r,metadata:()=>o,toc:()=>d});var i=t(62540),s=t(43023);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:"Defined in",id:"defined-in",level:4},{value:"limit?",id:"limit",level:3},{value:"Defined in",id:"defined-in-1",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",p:"p",strong:"strong",...(0,s.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.header,{children:(0,i.jsx)(n.h1,{id:"interface-pidsstats",children:"Interface: PidsStats"})}),"\n",(0,i.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(n.h3,{id:"current",children:"current?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"current"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L3064",children:"packages/extension-api/src/extension-api.d.ts:3064"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"limit",children:"limit?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"limit"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L3065",children:"packages/extension-api/src/extension-api.d.ts:3065"})})]})}function p(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},43023:(e,n,t)=>{t.d(n,{R:()=>c,x:()=>o});var i=t(63696);const s={},r=i.createContext(s);function c(e){const n=i.useContext(r);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:c(e.components),i.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/883e2c3c.70088570.js b/assets/js/883e2c3c.a3408c5e.js similarity index 95% rename from assets/js/883e2c3c.70088570.js rename to assets/js/883e2c3c.a3408c5e.js index f8e1e59f5e6..3f1259a2cdc 100644 --- a/assets/js/883e2c3c.70088570.js +++ b/assets/js/883e2c3c.a3408c5e.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[35272],{93274:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>o,default:()=>p,frontMatter:()=>r,metadata:()=>c,toc:()=>d});var s=t(62540),i=t(43023);const r={},o="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:"Defined in",id:"defined-in",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",strong:"strong",...(0,i.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.header,{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:"defined-in",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L3686",children:"packages/extension-api/src/extension-api.d.ts:3686"})})]})}function p(e={}){const{wrapper:n}={...(0,i.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},43023:(e,n,t)=>{t.d(n,{R:()=>o,x:()=>c});var s=t(63696);const i={},r=s.createContext(i);function o(e){const n=s.useContext(r);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:o(e.components),s.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[35272],{93274:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>o,default:()=>p,frontMatter:()=>r,metadata:()=>c,toc:()=>d});var s=t(62540),i=t(43023);const r={},o="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:"Defined in",id:"defined-in",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",strong:"strong",...(0,i.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.header,{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:"defined-in",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L3686",children:"packages/extension-api/src/extension-api.d.ts:3686"})})]})}function p(e={}){const{wrapper:n}={...(0,i.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},43023:(e,n,t)=>{t.d(n,{R:()=>o,x:()=>c});var s=t(63696);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/8a864d1e.25c36262.js b/assets/js/8a864d1e.5d0c1ef6.js similarity index 94% rename from assets/js/8a864d1e.25c36262.js rename to assets/js/8a864d1e.5d0c1ef6.js index d0942b0b874..75be74ac68c 100644 --- a/assets/js/8a864d1e.25c36262.js +++ b/assets/js/8a864d1e.5d0c1ef6.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[42950],{36437:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>c,contentTitle:()=>r,default:()=>l,frontMatter:()=>s,metadata:()=>a,toc:()=>d});var i=t(62540),o=t(43023);const s={},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:"Defined in",id:"defined-in",level:2}];function p(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",strong:"strong",...(0,o.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.header,{children:(0,i.jsx)(n.h1,{id:"type-alias-providerconnectionstatus",children:"Type Alias: ProviderConnectionStatus"})}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"ProviderConnectionStatus"}),": ",(0,i.jsx)(n.code,{children:'"started"'})," | ",(0,i.jsx)(n.code,{children:'"stopped"'})," | ",(0,i.jsx)(n.code,{children:'"starting"'})," | ",(0,i.jsx)(n.code,{children:'"stopping"'})," | ",(0,i.jsx)(n.code,{children:'"unknown"'})]}),"\n"]}),"\n",(0,i.jsx)(n.h2,{id:"defined-in",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L327",children:"packages/extension-api/src/extension-api.d.ts:327"})})]})}function l(e={}){const{wrapper:n}={...(0,o.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(p,{...e})}):p(e)}},43023:(e,n,t)=>{t.d(n,{R:()=>r,x:()=>a});var i=t(63696);const o={},s=i.createContext(o);function r(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:r(e.components),i.createElement(s.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[42950],{36437:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>c,contentTitle:()=>r,default:()=>l,frontMatter:()=>s,metadata:()=>a,toc:()=>d});var i=t(62540),o=t(43023);const s={},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:"Defined in",id:"defined-in",level:2}];function p(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",strong:"strong",...(0,o.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.header,{children:(0,i.jsx)(n.h1,{id:"type-alias-providerconnectionstatus",children:"Type Alias: ProviderConnectionStatus"})}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"ProviderConnectionStatus"}),": ",(0,i.jsx)(n.code,{children:'"started"'})," | ",(0,i.jsx)(n.code,{children:'"stopped"'})," | ",(0,i.jsx)(n.code,{children:'"starting"'})," | ",(0,i.jsx)(n.code,{children:'"stopping"'})," | ",(0,i.jsx)(n.code,{children:'"unknown"'})]}),"\n"]}),"\n",(0,i.jsx)(n.h2,{id:"defined-in",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L327",children:"packages/extension-api/src/extension-api.d.ts:327"})})]})}function l(e={}){const{wrapper:n}={...(0,o.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(p,{...e})}):p(e)}},43023:(e,n,t)=>{t.d(n,{R:()=>r,x:()=>a});var i=t(63696);const o={},s=i.createContext(o);function r(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:r(e.components),i.createElement(s.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/8abd0ba5.881101de.js b/assets/js/8abd0ba5.32852fb1.js similarity index 81% rename from assets/js/8abd0ba5.881101de.js rename to assets/js/8abd0ba5.32852fb1.js index e90abe33b8c..ba143ff370f 100644 --- a/assets/js/8abd0ba5.881101de.js +++ b/assets/js/8abd0ba5.32852fb1.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[5004],{69575:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>c,default:()=>h,frontMatter:()=>r,metadata:()=>o,toc:()=>d});var i=t(62540),s=t(43023);const r={},c="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:"Defined in",id:"defined-in",level:4},{value:"markDownContent?",id:"markdowncontent",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"title",id:"title",level:3},{value:"Defined in",id:"defined-in-2",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",p:"p",strong:"strong",...(0,s.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.header,{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:"defined-in",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L1355",children:"packages/extension-api/src/extension-api.d.ts:1355"})}),"\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:"defined-in-1",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/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:"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:"defined-in-2",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L1350",children:"packages/extension-api/src/extension-api.d.ts:1350"})})]})}function h(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},43023:(e,n,t)=>{t.d(n,{R:()=>c,x:()=>o});var i=t(63696);const s={},r=i.createContext(s);function c(e){const n=i.useContext(r);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:c(e.components),i.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[5004],{69575:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>r,default:()=>h,frontMatter:()=>c,metadata:()=>o,toc:()=>d});var i=t(62540),s=t(43023);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:"Defined in",id:"defined-in",level:4},{value:"markDownContent?",id:"markdowncontent",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"title",id:"title",level:3},{value:"Defined in",id:"defined-in-2",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",p:"p",strong:"strong",...(0,s.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.header,{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:"defined-in",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L1355",children:"packages/extension-api/src/extension-api.d.ts:1355"})}),"\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:"defined-in-1",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/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:"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:"defined-in-2",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L1350",children:"packages/extension-api/src/extension-api.d.ts:1350"})})]})}function h(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},43023:(e,n,t)=>{t.d(n,{R:()=>r,x:()=>o});var i=t(63696);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.1b31d04b.js b/assets/js/8b4ba22f.9a7b01f0.js similarity index 92% rename from assets/js/8b4ba22f.1b31d04b.js rename to assets/js/8b4ba22f.9a7b01f0.js index 5b808cfe7fc..4f281724630 100644 --- a/assets/js/8b4ba22f.1b31d04b.js +++ b/assets/js/8b4ba22f.9a7b01f0.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[46850],{77024:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>a,contentTitle:()=>o,default:()=>p,frontMatter:()=>s,metadata:()=>d,toc:()=>c});var t=i(62540),r=i(43023);const s={},o="Interface: CliToolUpdate",d={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:"CliToolSelectUpdate",permalink:"/api/interfaces/CliToolSelectUpdate"},next:{title:"CliToolUpdateOptions",permalink:"/api/interfaces/CliToolUpdateOptions"}},a={},c=[{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:"Defined in",id:"defined-in",level:4},{value:"version",id:"version",level:3},{value:"Defined in",id:"defined-in-1",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",p:"p",strong:"strong",...(0,r.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.header,{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:"defined-in",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L4348",children:"packages/extension-api/src/extension-api.d.ts:4348"})}),"\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:"defined-in-1",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L4347",children:"packages/extension-api/src/extension-api.d.ts:4347"})})]})}function p(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},43023:(e,n,i)=>{i.d(n,{R:()=>o,x:()=>d});var t=i(63696);const r={},s=t.createContext(r);function o(e){const n=t.useContext(s);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function d(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:o(e.components),t.createElement(s.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[46850],{77024:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>a,contentTitle:()=>o,default:()=>p,frontMatter:()=>s,metadata:()=>d,toc:()=>c});var t=i(62540),r=i(43023);const s={},o="Interface: CliToolUpdate",d={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:"CliToolSelectUpdate",permalink:"/api/interfaces/CliToolSelectUpdate"},next:{title:"CliToolUpdateOptions",permalink:"/api/interfaces/CliToolUpdateOptions"}},a={},c=[{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:"Defined in",id:"defined-in",level:4},{value:"version",id:"version",level:3},{value:"Defined in",id:"defined-in-1",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",p:"p",strong:"strong",...(0,r.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.header,{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:"defined-in",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L4348",children:"packages/extension-api/src/extension-api.d.ts:4348"})}),"\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:"defined-in-1",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L4347",children:"packages/extension-api/src/extension-api.d.ts:4347"})})]})}function p(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},43023:(e,n,i)=>{i.d(n,{R:()=>o,x:()=>d});var t=i(63696);const r={},s=t.createContext(r);function o(e){const n=t.useContext(s);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function d(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:o(e.components),t.createElement(s.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/8c6c72f9.49c42fe7.js b/assets/js/8c6c72f9.7edff533.js similarity index 94% rename from assets/js/8c6c72f9.49c42fe7.js rename to assets/js/8c6c72f9.7edff533.js index 14f3f6da671..cfad09ad540 100644 --- a/assets/js/8c6c72f9.49c42fe7.js +++ b/assets/js/8c6c72f9.7edff533.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[90305],{79529:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>r,contentTitle:()=>c,default:()=>p,frontMatter:()=>a,metadata:()=>o,toc:()=>l});var i=t(62540),s=t(43023);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:"CliToolInstallationSource",permalink:"/api/type-aliases/CliToolInstallationSource"}},r={},l=[{value:"Defined in",id:"defined-in",level:2}];function d(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",strong:"strong",...(0,s.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.header,{children:(0,i.jsx)(n.h1,{id:"type-alias-checkresultlink",children:"Type Alias: CheckResultLink"})}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"CheckResultLink"}),": ",(0,i.jsx)(n.a,{href:"/api/interfaces/Link",children:(0,i.jsx)(n.code,{children:"Link"})})]}),"\n"]}),"\n",(0,i.jsx)(n.h2,{id:"defined-in",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L537",children:"packages/extension-api/src/extension-api.d.ts:537"})})]})}function p(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(d,{...e})}):d(e)}},43023:(e,n,t)=>{t.d(n,{R:()=>c,x:()=>o});var i=t(63696);const s={},a=i.createContext(s);function c(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(s):e.components||s:c(e.components),i.createElement(a.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[90305],{79529:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>r,contentTitle:()=>c,default:()=>p,frontMatter:()=>a,metadata:()=>o,toc:()=>l});var i=t(62540),s=t(43023);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:"CliToolInstallationSource",permalink:"/api/type-aliases/CliToolInstallationSource"}},r={},l=[{value:"Defined in",id:"defined-in",level:2}];function d(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",strong:"strong",...(0,s.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.header,{children:(0,i.jsx)(n.h1,{id:"type-alias-checkresultlink",children:"Type Alias: CheckResultLink"})}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"CheckResultLink"}),": ",(0,i.jsx)(n.a,{href:"/api/interfaces/Link",children:(0,i.jsx)(n.code,{children:"Link"})})]}),"\n"]}),"\n",(0,i.jsx)(n.h2,{id:"defined-in",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L537",children:"packages/extension-api/src/extension-api.d.ts:537"})})]})}function p(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(d,{...e})}):d(e)}},43023:(e,n,t)=>{t.d(n,{R:()=>c,x:()=>o});var i=t(63696);const s={},a=i.createContext(s);function c(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(s):e.components||s:c(e.components),i.createElement(a.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/8c8ef21f.cef627e9.js b/assets/js/8c8ef21f.df0876ec.js similarity index 80% rename from assets/js/8c8ef21f.cef627e9.js rename to assets/js/8c8ef21f.df0876ec.js index e9a678a2857..8f2537a0def 100644 --- a/assets/js/8c8ef21f.cef627e9.js +++ b/assets/js/8c8ef21f.df0876ec.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[58796],{28625:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>o,contentTitle:()=>c,default:()=>p,frontMatter:()=>r,metadata:()=>d,toc:()=>a});var t=i(62540),s=i(43023);const r={},c="Interface: Link",d={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"}},o={},a=[{value:"Properties",id:"properties",level:2},{value:"group?",id:"group",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"title",id:"title",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"url",id:"url",level:3},{value:"Defined in",id:"defined-in-2",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",p:"p",strong:"strong",...(0,s.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.header,{children:(0,t.jsx)(n.h1,{id:"interface-link",children:"Interface: Link"})}),"\n",(0,t.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,t.jsx)(n.h3,{id:"group",children:"group?"}),"\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:"group"}),": ",(0,t.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L535",children:"packages/extension-api/src/extension-api.d.ts:535"})}),"\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:"defined-in-1",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L533",children:"packages/extension-api/src/extension-api.d.ts:533"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"url",children:"url"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"url"}),": ",(0,t.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"defined-in-2",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L534",children:"packages/extension-api/src/extension-api.d.ts:534"})})]})}function p(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},43023:(e,n,i)=>{i.d(n,{R:()=>c,x:()=>d});var t=i(63696);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 d(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([[58796],{28625:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>d,contentTitle:()=>c,default:()=>p,frontMatter:()=>r,metadata:()=>o,toc:()=>a});var t=i(62540),s=i(43023);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"}},d={},a=[{value:"Properties",id:"properties",level:2},{value:"group?",id:"group",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"title",id:"title",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"url",id:"url",level:3},{value:"Defined in",id:"defined-in-2",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",p:"p",strong:"strong",...(0,s.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.header,{children:(0,t.jsx)(n.h1,{id:"interface-link",children:"Interface: Link"})}),"\n",(0,t.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,t.jsx)(n.h3,{id:"group",children:"group?"}),"\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:"group"}),": ",(0,t.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L535",children:"packages/extension-api/src/extension-api.d.ts:535"})}),"\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:"defined-in-1",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L533",children:"packages/extension-api/src/extension-api.d.ts:533"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"url",children:"url"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"url"}),": ",(0,t.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"defined-in-2",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L534",children:"packages/extension-api/src/extension-api.d.ts:534"})})]})}function p(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},43023:(e,n,i)=>{i.d(n,{R:()=>c,x:()=>o});var t=i(63696);const s={},r=t.createContext(s);function c(e){const n=t.useContext(r);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:c(e.components),t.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/8cb0269b.15542aa7.js b/assets/js/8cb0269b.256bca2e.js similarity index 93% rename from assets/js/8cb0269b.15542aa7.js rename to assets/js/8cb0269b.256bca2e.js index ffdc4e38fcf..115d9261bd7 100644 --- a/assets/js/8cb0269b.15542aa7.js +++ b/assets/js/8cb0269b.256bca2e.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[70423],{44817:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>h,contentTitle:()=>t,default:()=>o,frontMatter:()=>d,metadata:()=>c,toc:()=>a});var i=s(62540),r=s(43023);const d={},t="Class: Uri",c={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={},a=[{value:"Properties",id:"properties",level:2},{value:"authority",id:"authority",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"fragment",id:"fragment",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"fsPath",id:"fspath",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"path",id:"path",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"query",id:"query",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"scheme",id:"scheme",level:3},{value:"Defined in",id:"defined-in-5",level:4},{value:"Methods",id:"methods",level:2},{value:"toString()",id:"tostring",level:3},{value:"Returns",id:"returns",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"with()",id:"with",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Defined in",id:"defined-in-7",level:4},{value:"file()",id:"file",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-2",level:4},{value:"Defined in",id:"defined-in-8",level:4},{value:"joinPath()",id:"joinpath",level:3},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-3",level:4},{value:"Defined in",id:"defined-in-9",level:4},{value:"parse()",id:"parse",level:3},{value:"Parameters",id:"parameters-3",level:4},{value:"Returns",id:"returns-4",level:4},{value:"See",id:"see",level:4},{value:"Defined in",id:"defined-in-10",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",em:"em",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",p:"p",pre:"pre",strong:"strong",...(0,r.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.header,{children:(0,i.jsx)(n.h1,{id:"class-uri",children:"Class: Uri"})}),"\n",(0,i.jsx)(n.p,{children:"Resource identifier for a resource"}),"\n",(0,i.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(n.h3,{id:"authority",children:"authority"}),"\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:"authority"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Authority is the ",(0,i.jsx)(n.code,{children:"www.example.com"})," part of ",(0,i.jsx)(n.code,{children:"http://www.example.com/some/path?query#fragment"}),".\nThe part between the first double slashes and the next slash."]}),"\n",(0,i.jsx)(n.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L1606",children:"packages/extension-api/src/extension-api.d.ts:1606"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"fragment",children:"fragment"}),"\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:"fragment"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Fragment is the ",(0,i.jsx)(n.code,{children:"fragment"})," part of ",(0,i.jsx)(n.code,{children:"http://www.example.com/some/path?query#fragment"}),"."]}),"\n",(0,i.jsx)(n.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L1626",children:"packages/extension-api/src/extension-api.d.ts:1626"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"fspath",children:"fsPath"}),"\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:"fsPath"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"The string representing the corresponding file system path of this Uri."}),"\n",(0,i.jsx)(n.h4,{id:"defined-in-2",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L1616",children:"packages/extension-api/src/extension-api.d.ts:1616"})}),"\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:"readonly"})," ",(0,i.jsx)(n.strong,{children:"path"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Path is the ",(0,i.jsx)(n.code,{children:"/some/path"})," part of ",(0,i.jsx)(n.code,{children:"http://www.example.com/some/path?query#fragment"}),"."]}),"\n",(0,i.jsx)(n.h4,{id:"defined-in-3",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L1611",children:"packages/extension-api/src/extension-api.d.ts:1611"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"query",children:"query"}),"\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:"query"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Query is the ",(0,i.jsx)(n.code,{children:"query"})," part of ",(0,i.jsx)(n.code,{children:"http://www.example.com/some/path?query#fragment"}),"."]}),"\n",(0,i.jsx)(n.h4,{id:"defined-in-4",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L1621",children:"packages/extension-api/src/extension-api.d.ts:1621"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"scheme",children:"scheme"}),"\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:"scheme"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Scheme is the ",(0,i.jsx)(n.code,{children:"http"})," part of ",(0,i.jsx)(n.code,{children:"http://www.example.com/some/path?query#fragment"}),".\nThe part before the first colon."]}),"\n",(0,i.jsx)(n.h4,{id:"defined-in-5",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L1600",children:"packages/extension-api/src/extension-api.d.ts:1600"})}),"\n",(0,i.jsx)(n.h2,{id:"methods",children:"Methods"}),"\n",(0,i.jsx)(n.h3,{id:"tostring",children:"toString()"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"toString"}),"(): ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"returns",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"string"})}),"\n",(0,i.jsx)(n.h4,{id:"defined-in-6",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L1665",children:"packages/extension-api/src/extension-api.d.ts:1665"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"with",children:"with()"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"with"}),"(",(0,i.jsx)(n.code,{children:"change"}),"): ",(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:"Derive a new Uri from this Uri."}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.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,i.jsx)(n.h4,{id:"parameters",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"change"})]}),"\n",(0,i.jsxs)(n.p,{children:["An object that describes a change to this Uri. To unset components use ",(0,i.jsx)(n.code,{children:"undefined"})," or\nthe empty string."]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"change.authority?"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n",(0,i.jsx)(n.p,{children:"The new authority, defaults to this Uri's authority."}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"change.fragment?"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n",(0,i.jsx)(n.p,{children:"The new fragment, defaults to this Uri's fragment."}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"change.path?"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n",(0,i.jsx)(n.p,{children:"The new path, defaults to this Uri's path."}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"change.query?"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n",(0,i.jsx)(n.p,{children:"The new query, defaults to this Uri's query."}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"change.scheme?"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n",(0,i.jsx)(n.p,{children:"The new scheme, defaults to this Uri's scheme."}),"\n",(0,i.jsx)(n.h4,{id:"returns-1",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"/api/classes/Uri",children:(0,i.jsx)(n.code,{children:"Uri"})})}),"\n",(0,i.jsxs)(n.p,{children:["A new Uri that reflects the given change. Will return ",(0,i.jsx)(n.code,{children:"this"})," Uri if the change\nis not changing anything."]}),"\n",(0,i.jsx)(n.h4,{id:"defined-in-7",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L1642",children:"packages/extension-api/src/extension-api.d.ts:1642"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"file",children:"file()"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"static"})," ",(0,i.jsx)(n.strong,{children:"file"}),"(",(0,i.jsx)(n.code,{children:"path"}),"): ",(0,i.jsx)(n.a,{href:"/api/classes/Uri",children:(0,i.jsx)(n.code,{children:"Uri"})})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Create an URI from a file system path. The ",(0,i.jsx)(n.a,{href:"/api/classes/Uri#scheme",children:"scheme"}),"\nwill be ",(0,i.jsx)(n.code,{children:"file"}),"."]}),"\n",(0,i.jsx)(n.h4,{id:"parameters-1",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"path"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n",(0,i.jsx)(n.h4,{id:"returns-2",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"/api/classes/Uri",children:(0,i.jsx)(n.code,{children:"Uri"})})}),"\n",(0,i.jsx)(n.h4,{id:"defined-in-8",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L1579",children:"packages/extension-api/src/extension-api.d.ts:1579"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"joinpath",children:"joinPath()"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"static"})," ",(0,i.jsx)(n.strong,{children:"joinPath"}),"(",(0,i.jsx)(n.code,{children:"base"}),", ...",(0,i.jsx)(n.code,{children:"pathSegments"}),"): ",(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:"Create a new uri which path is the result of joining\nthe path of the base uri with the provided path segments."}),"\n",(0,i.jsx)(n.h4,{id:"parameters-2",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"base"}),": ",(0,i.jsx)(n.a,{href:"/api/classes/Uri",children:(0,i.jsx)(n.code,{children:"Uri"})})]}),"\n",(0,i.jsx)(n.p,{children:"An uri. Must have a path."}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ...",(0,i.jsx)(n.strong,{children:"pathSegments"}),": ",(0,i.jsx)(n.code,{children:"string"}),"[]"]}),"\n",(0,i.jsx)(n.p,{children:"One more more path fragments"}),"\n",(0,i.jsx)(n.h4,{id:"returns-3",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"/api/classes/Uri",children:(0,i.jsx)(n.code,{children:"Uri"})})}),"\n",(0,i.jsx)(n.p,{children:"A new uri which path is joined with the given fragments"}),"\n",(0,i.jsx)(n.h4,{id:"defined-in-9",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L1589",children:"packages/extension-api/src/extension-api.d.ts:1589"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"parse",children:"parse()"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"static"})," ",(0,i.jsx)(n.strong,{children:"parse"}),"(",(0,i.jsx)(n.code,{children:"value"}),", ",(0,i.jsx)(n.code,{children:"strict"}),"?): ",(0,i.jsx)(n.a,{href:"/api/classes/Uri",children:(0,i.jsx)(n.code,{children:"Uri"})})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Create an URI from a string, e.g. ",(0,i.jsx)(n.code,{children:"http://www.example.com/some/path"}),",\n",(0,i.jsx)(n.code,{children:"file:///usr/home"}),", or ",(0,i.jsx)(n.code,{children:"scheme:with/path"}),"."]}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.em,{children:"Note"})," that for a while uris without a ",(0,i.jsx)(n.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,i.jsx)(n.code,{children:"strict"}),"-argument has been added. We ",(0,i.jsx)(n.em,{children:"strongly"})," advise to use it, e.g. ",(0,i.jsx)(n.code,{children:"Uri.parse('my:uri', true)"})]}),"\n",(0,i.jsx)(n.h4,{id:"parameters-3",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 string value of an Uri."}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"strict?"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n",(0,i.jsxs)(n.p,{children:["Throw an error when ",(0,i.jsx)(n.code,{children:"value"})," is empty or when no ",(0,i.jsx)(n.code,{children:"scheme"})," can be parsed."]}),"\n",(0,i.jsx)(n.h4,{id:"returns-4",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"/api/classes/Uri",children:(0,i.jsx)(n.code,{children:"Uri"})})}),"\n",(0,i.jsx)(n.p,{children:"A new Uri instance."}),"\n",(0,i.jsx)(n.h4,{id:"see",children:"See"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"/api/classes/Uri#tostring",children:"Uri.toString"})}),"\n",(0,i.jsx)(n.h4,{id:"defined-in-10",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L1573",children:"packages/extension-api/src/extension-api.d.ts:1573"})})]})}function o(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},43023:(e,n,s)=>{s.d(n,{R:()=>t,x:()=>c});var i=s(63696);const r={},d=i.createContext(r);function t(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:t(e.components),i.createElement(d.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[70423],{44817:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>h,contentTitle:()=>t,default:()=>o,frontMatter:()=>d,metadata:()=>c,toc:()=>a});var i=s(62540),r=s(43023);const d={},t="Class: Uri",c={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={},a=[{value:"Properties",id:"properties",level:2},{value:"authority",id:"authority",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"fragment",id:"fragment",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"fsPath",id:"fspath",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"path",id:"path",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"query",id:"query",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"scheme",id:"scheme",level:3},{value:"Defined in",id:"defined-in-5",level:4},{value:"Methods",id:"methods",level:2},{value:"toString()",id:"tostring",level:3},{value:"Returns",id:"returns",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"with()",id:"with",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Defined in",id:"defined-in-7",level:4},{value:"file()",id:"file",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-2",level:4},{value:"Defined in",id:"defined-in-8",level:4},{value:"joinPath()",id:"joinpath",level:3},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-3",level:4},{value:"Defined in",id:"defined-in-9",level:4},{value:"parse()",id:"parse",level:3},{value:"Parameters",id:"parameters-3",level:4},{value:"Returns",id:"returns-4",level:4},{value:"See",id:"see",level:4},{value:"Defined in",id:"defined-in-10",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",em:"em",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",p:"p",pre:"pre",strong:"strong",...(0,r.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.header,{children:(0,i.jsx)(n.h1,{id:"class-uri",children:"Class: Uri"})}),"\n",(0,i.jsx)(n.p,{children:"Resource identifier for a resource"}),"\n",(0,i.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(n.h3,{id:"authority",children:"authority"}),"\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:"authority"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Authority is the ",(0,i.jsx)(n.code,{children:"www.example.com"})," part of ",(0,i.jsx)(n.code,{children:"http://www.example.com/some/path?query#fragment"}),".\nThe part between the first double slashes and the next slash."]}),"\n",(0,i.jsx)(n.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L1606",children:"packages/extension-api/src/extension-api.d.ts:1606"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"fragment",children:"fragment"}),"\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:"fragment"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Fragment is the ",(0,i.jsx)(n.code,{children:"fragment"})," part of ",(0,i.jsx)(n.code,{children:"http://www.example.com/some/path?query#fragment"}),"."]}),"\n",(0,i.jsx)(n.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L1626",children:"packages/extension-api/src/extension-api.d.ts:1626"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"fspath",children:"fsPath"}),"\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:"fsPath"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"The string representing the corresponding file system path of this Uri."}),"\n",(0,i.jsx)(n.h4,{id:"defined-in-2",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L1616",children:"packages/extension-api/src/extension-api.d.ts:1616"})}),"\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:"readonly"})," ",(0,i.jsx)(n.strong,{children:"path"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Path is the ",(0,i.jsx)(n.code,{children:"/some/path"})," part of ",(0,i.jsx)(n.code,{children:"http://www.example.com/some/path?query#fragment"}),"."]}),"\n",(0,i.jsx)(n.h4,{id:"defined-in-3",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L1611",children:"packages/extension-api/src/extension-api.d.ts:1611"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"query",children:"query"}),"\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:"query"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Query is the ",(0,i.jsx)(n.code,{children:"query"})," part of ",(0,i.jsx)(n.code,{children:"http://www.example.com/some/path?query#fragment"}),"."]}),"\n",(0,i.jsx)(n.h4,{id:"defined-in-4",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L1621",children:"packages/extension-api/src/extension-api.d.ts:1621"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"scheme",children:"scheme"}),"\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:"scheme"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Scheme is the ",(0,i.jsx)(n.code,{children:"http"})," part of ",(0,i.jsx)(n.code,{children:"http://www.example.com/some/path?query#fragment"}),".\nThe part before the first colon."]}),"\n",(0,i.jsx)(n.h4,{id:"defined-in-5",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L1600",children:"packages/extension-api/src/extension-api.d.ts:1600"})}),"\n",(0,i.jsx)(n.h2,{id:"methods",children:"Methods"}),"\n",(0,i.jsx)(n.h3,{id:"tostring",children:"toString()"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"toString"}),"(): ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"returns",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"string"})}),"\n",(0,i.jsx)(n.h4,{id:"defined-in-6",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L1665",children:"packages/extension-api/src/extension-api.d.ts:1665"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"with",children:"with()"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"with"}),"(",(0,i.jsx)(n.code,{children:"change"}),"): ",(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:"Derive a new Uri from this Uri."}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.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,i.jsx)(n.h4,{id:"parameters",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"change"})]}),"\n",(0,i.jsxs)(n.p,{children:["An object that describes a change to this Uri. To unset components use ",(0,i.jsx)(n.code,{children:"undefined"})," or\nthe empty string."]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"change.authority?"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n",(0,i.jsx)(n.p,{children:"The new authority, defaults to this Uri's authority."}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"change.fragment?"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n",(0,i.jsx)(n.p,{children:"The new fragment, defaults to this Uri's fragment."}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"change.path?"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n",(0,i.jsx)(n.p,{children:"The new path, defaults to this Uri's path."}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"change.query?"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n",(0,i.jsx)(n.p,{children:"The new query, defaults to this Uri's query."}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"change.scheme?"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n",(0,i.jsx)(n.p,{children:"The new scheme, defaults to this Uri's scheme."}),"\n",(0,i.jsx)(n.h4,{id:"returns-1",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"/api/classes/Uri",children:(0,i.jsx)(n.code,{children:"Uri"})})}),"\n",(0,i.jsxs)(n.p,{children:["A new Uri that reflects the given change. Will return ",(0,i.jsx)(n.code,{children:"this"})," Uri if the change\nis not changing anything."]}),"\n",(0,i.jsx)(n.h4,{id:"defined-in-7",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L1642",children:"packages/extension-api/src/extension-api.d.ts:1642"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"file",children:"file()"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"static"})," ",(0,i.jsx)(n.strong,{children:"file"}),"(",(0,i.jsx)(n.code,{children:"path"}),"): ",(0,i.jsx)(n.a,{href:"/api/classes/Uri",children:(0,i.jsx)(n.code,{children:"Uri"})})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Create an URI from a file system path. The ",(0,i.jsx)(n.a,{href:"/api/classes/Uri#scheme",children:"scheme"}),"\nwill be ",(0,i.jsx)(n.code,{children:"file"}),"."]}),"\n",(0,i.jsx)(n.h4,{id:"parameters-1",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"path"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n",(0,i.jsx)(n.h4,{id:"returns-2",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"/api/classes/Uri",children:(0,i.jsx)(n.code,{children:"Uri"})})}),"\n",(0,i.jsx)(n.h4,{id:"defined-in-8",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L1579",children:"packages/extension-api/src/extension-api.d.ts:1579"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"joinpath",children:"joinPath()"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"static"})," ",(0,i.jsx)(n.strong,{children:"joinPath"}),"(",(0,i.jsx)(n.code,{children:"base"}),", ...",(0,i.jsx)(n.code,{children:"pathSegments"}),"): ",(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:"Create a new uri which path is the result of joining\nthe path of the base uri with the provided path segments."}),"\n",(0,i.jsx)(n.h4,{id:"parameters-2",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"base"}),": ",(0,i.jsx)(n.a,{href:"/api/classes/Uri",children:(0,i.jsx)(n.code,{children:"Uri"})})]}),"\n",(0,i.jsx)(n.p,{children:"An uri. Must have a path."}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ...",(0,i.jsx)(n.strong,{children:"pathSegments"}),": ",(0,i.jsx)(n.code,{children:"string"}),"[]"]}),"\n",(0,i.jsx)(n.p,{children:"One more more path fragments"}),"\n",(0,i.jsx)(n.h4,{id:"returns-3",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"/api/classes/Uri",children:(0,i.jsx)(n.code,{children:"Uri"})})}),"\n",(0,i.jsx)(n.p,{children:"A new uri which path is joined with the given fragments"}),"\n",(0,i.jsx)(n.h4,{id:"defined-in-9",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L1589",children:"packages/extension-api/src/extension-api.d.ts:1589"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"parse",children:"parse()"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"static"})," ",(0,i.jsx)(n.strong,{children:"parse"}),"(",(0,i.jsx)(n.code,{children:"value"}),", ",(0,i.jsx)(n.code,{children:"strict"}),"?): ",(0,i.jsx)(n.a,{href:"/api/classes/Uri",children:(0,i.jsx)(n.code,{children:"Uri"})})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Create an URI from a string, e.g. ",(0,i.jsx)(n.code,{children:"http://www.example.com/some/path"}),",\n",(0,i.jsx)(n.code,{children:"file:///usr/home"}),", or ",(0,i.jsx)(n.code,{children:"scheme:with/path"}),"."]}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.em,{children:"Note"})," that for a while uris without a ",(0,i.jsx)(n.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,i.jsx)(n.code,{children:"strict"}),"-argument has been added. We ",(0,i.jsx)(n.em,{children:"strongly"})," advise to use it, e.g. ",(0,i.jsx)(n.code,{children:"Uri.parse('my:uri', true)"})]}),"\n",(0,i.jsx)(n.h4,{id:"parameters-3",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 string value of an Uri."}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"strict?"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n",(0,i.jsxs)(n.p,{children:["Throw an error when ",(0,i.jsx)(n.code,{children:"value"})," is empty or when no ",(0,i.jsx)(n.code,{children:"scheme"})," can be parsed."]}),"\n",(0,i.jsx)(n.h4,{id:"returns-4",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"/api/classes/Uri",children:(0,i.jsx)(n.code,{children:"Uri"})})}),"\n",(0,i.jsx)(n.p,{children:"A new Uri instance."}),"\n",(0,i.jsx)(n.h4,{id:"see",children:"See"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"/api/classes/Uri#tostring",children:"Uri.toString"})}),"\n",(0,i.jsx)(n.h4,{id:"defined-in-10",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L1573",children:"packages/extension-api/src/extension-api.d.ts:1573"})})]})}function o(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},43023:(e,n,s)=>{s.d(n,{R:()=>t,x:()=>c});var i=s(63696);const r={},d=i.createContext(r);function t(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:t(e.components),i.createElement(d.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/8ccdb99f.e7c57212.js b/assets/js/8ccdb99f.bf60ff99.js similarity index 78% rename from assets/js/8ccdb99f.e7c57212.js rename to assets/js/8ccdb99f.bf60ff99.js index 00caa736f14..809a0fe2468 100644 --- a/assets/js/8ccdb99f.e7c57212.js +++ b/assets/js/8ccdb99f.bf60ff99.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[55251],{97261:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>r,contentTitle:()=>a,default:()=>p,frontMatter:()=>i,metadata:()=>c,toc:()=>d});var s=t(62540),o=t(43023);const i={},a="Type Alias: MountConsistency",c={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:"Defined in",id:"defined-in",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",strong:"strong",...(0,o.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.header,{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:"defined-in",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2391",children:"packages/extension-api/src/extension-api.d.ts:2391"})})]})}function p(e={}){const{wrapper:n}={...(0,o.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},43023:(e,n,t)=>{t.d(n,{R:()=>a,x:()=>c});var s=t(63696);const o={},i=s.createContext(o);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(o):e.components||o:a(e.components),s.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[55251],{97261:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>r,contentTitle:()=>c,default:()=>p,frontMatter:()=>i,metadata:()=>a,toc:()=>d});var s=t(62540),o=t(43023);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:"Defined in",id:"defined-in",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",strong:"strong",...(0,o.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.header,{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:"defined-in",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2391",children:"packages/extension-api/src/extension-api.d.ts:2391"})})]})}function p(e={}){const{wrapper:n}={...(0,o.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},43023:(e,n,t)=>{t.d(n,{R:()=>c,x:()=>a});var s=t(63696);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.ca60cfe7.js b/assets/js/8dbb6800.b3e80772.js similarity index 97% rename from assets/js/8dbb6800.ca60cfe7.js rename to assets/js/8dbb6800.b3e80772.js index 4dd26400b31..8f9357921cc 100644 --- a/assets/js/8dbb6800.ca60cfe7.js +++ b/assets/js/8dbb6800.b3e80772.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[36901],{93654:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>a,contentTitle:()=>c,default:()=>u,frontMatter:()=>o,metadata:()=>r,toc:()=>l});var t=s(62540),i=s(43023);const o={},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:"Defined in",id:"defined-in",level:2}];function d(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",strong:"strong",...(0,i.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.header,{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:"defined-in",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L3676",children:"packages/extension-api/src/extension-api.d.ts:3676"})})]})}function u(e={}){const{wrapper:n}={...(0,i.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(d,{...e})}):d(e)}},43023:(e,n,s)=>{s.d(n,{R:()=>c,x:()=>r});var t=s(63696);const i={},o=t.createContext(i);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(i):e.components||i:c(e.components),t.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[36901],{93654:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>a,contentTitle:()=>c,default:()=>u,frontMatter:()=>o,metadata:()=>r,toc:()=>l});var t=s(62540),i=s(43023);const o={},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:"Defined in",id:"defined-in",level:2}];function d(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",strong:"strong",...(0,i.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.header,{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:"defined-in",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L3676",children:"packages/extension-api/src/extension-api.d.ts:3676"})})]})}function u(e={}){const{wrapper:n}={...(0,i.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(d,{...e})}):d(e)}},43023:(e,n,s)=>{s.d(n,{R:()=>c,x:()=>r});var t=s(63696);const i={},o=t.createContext(i);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(i):e.components||i:c(e.components),t.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/8eeedb31.d7c36038.js b/assets/js/8eeedb31.3c86e0eb.js similarity index 97% rename from assets/js/8eeedb31.d7c36038.js rename to assets/js/8eeedb31.3c86e0eb.js index c3bcfb97210..61de81f309e 100644 --- a/assets/js/8eeedb31.d7c36038.js +++ b/assets/js/8eeedb31.3c86e0eb.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[34318],{19188:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>d,contentTitle:()=>r,default:()=>h,frontMatter:()=>s,metadata:()=>c,toc:()=>o});var i=t(62540),a=t(43023);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"}},d={},o=[{value:"Properties",id:"properties",level:2},{value:"webviewPanel",id:"webviewpanel",level:3},{value:"Defined in",id:"defined-in",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",p:"p",strong:"strong",...(0,a.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.header,{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:"defined-in",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L1881",children:"packages/extension-api/src/extension-api.d.ts:1881"})})]})}function h(e={}){const{wrapper:n}={...(0,a.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},43023:(e,n,t)=>{t.d(n,{R:()=>r,x:()=>c});var i=t(63696);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([[34318],{19188:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>d,contentTitle:()=>r,default:()=>h,frontMatter:()=>s,metadata:()=>c,toc:()=>o});var i=t(62540),a=t(43023);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"}},d={},o=[{value:"Properties",id:"properties",level:2},{value:"webviewPanel",id:"webviewpanel",level:3},{value:"Defined in",id:"defined-in",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",p:"p",strong:"strong",...(0,a.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.header,{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:"defined-in",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L1881",children:"packages/extension-api/src/extension-api.d.ts:1881"})})]})}function h(e={}){const{wrapper:n}={...(0,a.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},43023:(e,n,t)=>{t.d(n,{R:()=>r,x:()=>c});var i=t(63696);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.3b2e9222.js b/assets/js/905702d2.8f59f3fa.js similarity index 95% rename from assets/js/905702d2.3b2e9222.js rename to assets/js/905702d2.8f59f3fa.js index 7262044b1fe..8ad46dde05b 100644 --- a/assets/js/905702d2.3b2e9222.js +++ b/assets/js/905702d2.8f59f3fa.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[78664],{59115:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>o,contentTitle:()=>a,default:()=>l,frontMatter:()=>i,metadata:()=>c,toc:()=>d});var s=t(62540),r=t(43023);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:"tray",permalink:"/api/namespaces/tray/"},next:{title:"registerProviderMenuItem",permalink:"/api/namespaces/tray/functions/registerProviderMenuItem"}},o={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Defined in",id:"defined-in",level:2}];function u(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",strong:"strong",...(0,r.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.header,{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:"defined-in",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L941",children:"packages/extension-api/src/extension-api.d.ts:941"})})]})}function l(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(u,{...e})}):u(e)}},43023:(e,n,t)=>{t.d(n,{R:()=>a,x:()=>c});var s=t(63696);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([[78664],{59115:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>o,contentTitle:()=>a,default:()=>l,frontMatter:()=>i,metadata:()=>c,toc:()=>d});var s=t(62540),r=t(43023);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:"tray",permalink:"/api/namespaces/tray/"},next:{title:"registerProviderMenuItem",permalink:"/api/namespaces/tray/functions/registerProviderMenuItem"}},o={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Defined in",id:"defined-in",level:2}];function u(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",strong:"strong",...(0,r.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.header,{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:"defined-in",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L941",children:"packages/extension-api/src/extension-api.d.ts:941"})})]})}function l(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(u,{...e})}):u(e)}},43023:(e,n,t)=>{t.d(n,{R:()=>a,x:()=>c});var s=t(63696);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.f60afe76.js b/assets/js/91008145.04970eef.js similarity index 95% rename from assets/js/91008145.f60afe76.js rename to assets/js/91008145.04970eef.js index a9dad378511..60f93616ff2 100644 --- a/assets/js/91008145.f60afe76.js +++ b/assets/js/91008145.04970eef.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[74013],{56522:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>r,default:()=>p,frontMatter:()=>o,metadata:()=>c,toc:()=>d});var s=t(62540),i=t(43023);const o={},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={},d=[{value:"Returns",id:"returns",level:2},{value:"Defined in",id:"defined-in",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",strong:"strong",...(0,i.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.header,{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:"defined-in",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L3670",children:"packages/extension-api/src/extension-api.d.ts:3670"})})]})}function p(e={}){const{wrapper:n}={...(0,i.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},43023:(e,n,t)=>{t.d(n,{R:()=>r,x:()=>c});var s=t(63696);const i={},o=s.createContext(i);function r(e){const n=s.useContext(o);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:r(e.components),s.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[74013],{56522:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>r,default:()=>p,frontMatter:()=>o,metadata:()=>c,toc:()=>d});var s=t(62540),i=t(43023);const o={},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={},d=[{value:"Returns",id:"returns",level:2},{value:"Defined in",id:"defined-in",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",strong:"strong",...(0,i.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.header,{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:"defined-in",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L3670",children:"packages/extension-api/src/extension-api.d.ts:3670"})})]})}function p(e={}){const{wrapper:n}={...(0,i.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},43023:(e,n,t)=>{t.d(n,{R:()=>r,x:()=>c});var s=t(63696);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/91392348.0d52704b.js b/assets/js/91392348.5ce3e01f.js similarity index 95% rename from assets/js/91392348.0d52704b.js rename to assets/js/91392348.5ce3e01f.js index 4e29cf73a1a..6ccbb63a416 100644 --- a/assets/js/91392348.0d52704b.js +++ b/assets/js/91392348.5ce3e01f.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[25320],{52867:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>s,default:()=>l,frontMatter:()=>o,metadata:()=>c,toc:()=>d});var r=t(62540),i=t(43023);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:"Defined in",id:"defined-in",level:4}];function p(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",p:"p",strong:"strong",...(0,i.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.header,{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:"defined-in",children:"Defined in"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L712",children:"packages/extension-api/src/extension-api.d.ts:712"})})]})}function l(e={}){const{wrapper:n}={...(0,i.R)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(p,{...e})}):p(e)}},43023:(e,n,t)=>{t.d(n,{R:()=>s,x:()=>c});var r=t(63696);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([[25320],{52867:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>s,default:()=>l,frontMatter:()=>o,metadata:()=>c,toc:()=>d});var r=t(62540),i=t(43023);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:"Defined in",id:"defined-in",level:4}];function p(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",p:"p",strong:"strong",...(0,i.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.header,{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:"defined-in",children:"Defined in"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L712",children:"packages/extension-api/src/extension-api.d.ts:712"})})]})}function l(e={}){const{wrapper:n}={...(0,i.R)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(p,{...e})}):p(e)}},43023:(e,n,t)=>{t.d(n,{R:()=>s,x:()=>c});var r=t(63696);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.682c8736.js b/assets/js/91fe1403.8932e8d2.js similarity index 97% rename from assets/js/91fe1403.682c8736.js rename to assets/js/91fe1403.8932e8d2.js index eba82cd693c..0920e310abc 100644 --- a/assets/js/91fe1403.682c8736.js +++ b/assets/js/91fe1403.8932e8d2.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[70062],{67577:(e,n,a)=>{a.r(n),a.d(n,{assets:()=>o,contentTitle:()=>t,default:()=>p,frontMatter:()=>r,metadata:()=>c,toc:()=>d});var i=a(62540),s=a(43023);const r={},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:"env",permalink:"/api/namespaces/env/"},next:{title:"isLinux",permalink:"/api/namespaces/env/variables/isLinux"}},o={},d=[{value:"Defined in",id:"defined-in",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",strong:"strong",...(0,s.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.header,{children:(0,i.jsx)(n.h1,{id:"variable-clipboard",children:"Variable: clipboard"})}),"\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:"clipboard"}),": ",(0,i.jsx)(n.a,{href:"/api/interfaces/Clipboard",children:(0,i.jsx)(n.code,{children:"Clipboard"})})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"The system clipboard."}),"\n",(0,i.jsx)(n.h2,{id:"defined-in",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L4026",children:"packages/extension-api/src/extension-api.d.ts:4026"})})]})}function p(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},43023:(e,n,a)=>{a.d(n,{R:()=>t,x:()=>c});var i=a(63696);const s={},r=i.createContext(s);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(s):e.components||s:t(e.components),i.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[70062],{67577:(e,n,a)=>{a.r(n),a.d(n,{assets:()=>o,contentTitle:()=>t,default:()=>p,frontMatter:()=>r,metadata:()=>c,toc:()=>d});var i=a(62540),s=a(43023);const r={},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:"env",permalink:"/api/namespaces/env/"},next:{title:"isLinux",permalink:"/api/namespaces/env/variables/isLinux"}},o={},d=[{value:"Defined in",id:"defined-in",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",strong:"strong",...(0,s.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.header,{children:(0,i.jsx)(n.h1,{id:"variable-clipboard",children:"Variable: clipboard"})}),"\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:"clipboard"}),": ",(0,i.jsx)(n.a,{href:"/api/interfaces/Clipboard",children:(0,i.jsx)(n.code,{children:"Clipboard"})})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"The system clipboard."}),"\n",(0,i.jsx)(n.h2,{id:"defined-in",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L4026",children:"packages/extension-api/src/extension-api.d.ts:4026"})})]})}function p(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},43023:(e,n,a)=>{a.d(n,{R:()=>t,x:()=>c});var i=a(63696);const s={},r=i.createContext(s);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(s):e.components||s:t(e.components),i.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/920c2ac2.6c4f181c.js b/assets/js/920c2ac2.73e679c9.js similarity index 90% rename from assets/js/920c2ac2.6c4f181c.js rename to assets/js/920c2ac2.73e679c9.js index 1dfcc4a2edb..369e31f163d 100644 --- a/assets/js/920c2ac2.6c4f181c.js +++ b/assets/js/920c2ac2.73e679c9.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[74361],{70659:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>a,contentTitle:()=>c,default:()=>h,frontMatter:()=>t,metadata:()=>d,toc:()=>r});var s=i(62540),l=i(43023);const t={},c="Interface: MemoryStats",d={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:"ManifestPushOptions",permalink:"/api/interfaces/ManifestPushOptions"},next:{title:"MenuItem",permalink:"/api/interfaces/MenuItem"}},a={},r=[{value:"Properties",id:"properties",level:2},{value:"commitbytes?",id:"commitbytes",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"commitpeakbytes?",id:"commitpeakbytes",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"failcnt",id:"failcnt",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"limit",id:"limit",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"max_usage",id:"max_usage",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"privateworkingset?",id:"privateworkingset",level:3},{value:"Defined in",id:"defined-in-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:"Defined in",id:"defined-in-6",level:4},{value:"usage",id:"usage",level:3},{value:"Defined in",id:"defined-in-7",level:4}];function o(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",p:"p",strong:"strong",...(0,l.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.header,{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:"defined-in",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L3147",children:"packages/extension-api/src/extension-api.d.ts:3147"})}),"\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:"defined-in-1",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L3148",children:"packages/extension-api/src/extension-api.d.ts:3148"})}),"\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:"defined-in-2",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L3143",children:"packages/extension-api/src/extension-api.d.ts:3143"})}),"\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:"defined-in-3",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L3144",children:"packages/extension-api/src/extension-api.d.ts:3144"})}),"\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:"defined-in-4",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L3141",children:"packages/extension-api/src/extension-api.d.ts:3141"})}),"\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:"defined-in-5",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L3149",children:"packages/extension-api/src/extension-api.d.ts:3149"})}),"\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:"defined-in-6",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L3110",children:"packages/extension-api/src/extension-api.d.ts:3110"})}),"\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:"defined-in-7",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L3142",children:"packages/extension-api/src/extension-api.d.ts:3142"})})]})}function h(e={}){const{wrapper:n}={...(0,l.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(o,{...e})}):o(e)}},43023:(e,n,i)=>{i.d(n,{R:()=>c,x:()=>d});var s=i(63696);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 d(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(l):e.components||l:c(e.components),s.createElement(t.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[74361],{70659:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>d,contentTitle:()=>c,default:()=>h,frontMatter:()=>t,metadata:()=>a,toc:()=>r});var s=i(62540),l=i(43023);const t={},c="Interface: MemoryStats",a={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:"ManifestPushOptions",permalink:"/api/interfaces/ManifestPushOptions"},next:{title:"MenuItem",permalink:"/api/interfaces/MenuItem"}},d={},r=[{value:"Properties",id:"properties",level:2},{value:"commitbytes?",id:"commitbytes",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"commitpeakbytes?",id:"commitpeakbytes",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"failcnt",id:"failcnt",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"limit",id:"limit",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"max_usage",id:"max_usage",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"privateworkingset?",id:"privateworkingset",level:3},{value:"Defined in",id:"defined-in-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:"Defined in",id:"defined-in-6",level:4},{value:"usage",id:"usage",level:3},{value:"Defined in",id:"defined-in-7",level:4}];function o(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",p:"p",strong:"strong",...(0,l.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.header,{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:"defined-in",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L3147",children:"packages/extension-api/src/extension-api.d.ts:3147"})}),"\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:"defined-in-1",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L3148",children:"packages/extension-api/src/extension-api.d.ts:3148"})}),"\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:"defined-in-2",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L3143",children:"packages/extension-api/src/extension-api.d.ts:3143"})}),"\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:"defined-in-3",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L3144",children:"packages/extension-api/src/extension-api.d.ts:3144"})}),"\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:"defined-in-4",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L3141",children:"packages/extension-api/src/extension-api.d.ts:3141"})}),"\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:"defined-in-5",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L3149",children:"packages/extension-api/src/extension-api.d.ts:3149"})}),"\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:"defined-in-6",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L3110",children:"packages/extension-api/src/extension-api.d.ts:3110"})}),"\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:"defined-in-7",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L3142",children:"packages/extension-api/src/extension-api.d.ts:3142"})})]})}function h(e={}){const{wrapper:n}={...(0,l.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(o,{...e})}):o(e)}},43023:(e,n,i)=>{i.d(n,{R:()=>c,x:()=>a});var s=i(63696);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 a(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.5b57bafc.js b/assets/js/927c84a6.b6fb981e.js similarity index 95% rename from assets/js/927c84a6.5b57bafc.js rename to assets/js/927c84a6.b6fb981e.js index 76192ae5290..3e6892be447 100644 --- a/assets/js/927c84a6.5b57bafc.js +++ b/assets/js/927c84a6.b6fb981e.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[79405],{39200:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>d,contentTitle:()=>c,default:()=>h,frontMatter:()=>r,metadata:()=>o,toc:()=>a});var t=i(62540),s=i(43023);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"}},d={},a=[{value:"Properties",id:"properties",level:2},{value:"id",id:"id",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"title",id:"title",level:3},{value:"Defined in",id:"defined-in-1",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",p:"p",strong:"strong",...(0,s.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.header,{children:(0,t.jsx)(n.h1,{id:"interface-checkresultfixcommand",children:"Interface: CheckResultFixCommand"})}),"\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:"defined-in",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L540",children:"packages/extension-api/src/extension-api.d.ts:540"})}),"\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:"defined-in-1",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L541",children:"packages/extension-api/src/extension-api.d.ts:541"})})]})}function h(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},43023:(e,n,i)=>{i.d(n,{R:()=>c,x:()=>o});var t=i(63696);const s={},r=t.createContext(s);function c(e){const n=t.useContext(r);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:c(e.components),t.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[79405],{39200:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>d,contentTitle:()=>c,default:()=>h,frontMatter:()=>r,metadata:()=>o,toc:()=>a});var t=i(62540),s=i(43023);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"}},d={},a=[{value:"Properties",id:"properties",level:2},{value:"id",id:"id",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"title",id:"title",level:3},{value:"Defined in",id:"defined-in-1",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",p:"p",strong:"strong",...(0,s.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.header,{children:(0,t.jsx)(n.h1,{id:"interface-checkresultfixcommand",children:"Interface: CheckResultFixCommand"})}),"\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:"defined-in",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L540",children:"packages/extension-api/src/extension-api.d.ts:540"})}),"\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:"defined-in-1",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L541",children:"packages/extension-api/src/extension-api.d.ts:541"})})]})}function h(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},43023:(e,n,i)=>{i.d(n,{R:()=>c,x:()=>o});var t=i(63696);const s={},r=t.createContext(s);function c(e){const n=t.useContext(r);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:c(e.components),t.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/9286a297.3c016d49.js b/assets/js/9286a297.f610180a.js similarity index 98% rename from assets/js/9286a297.3c016d49.js rename to assets/js/9286a297.f610180a.js index 21cb86aa3fe..69621c40517 100644 --- a/assets/js/9286a297.3c016d49.js +++ b/assets/js/9286a297.f610180a.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[81497],{35676:(n,e,i)=>{i.r(e),i.d(e,{assets:()=>s,contentTitle:()=>r,default:()=>p,frontMatter:()=>a,metadata:()=>c,toc:()=>d});var t=i(62540),o=i(43023);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:"Defined in",id:"defined-in",level:2}];function l(n){const e={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",strong:"strong",...(0,o.R)(),...n.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(e.header,{children:(0,t.jsx)(e.h1,{id:"function-navigatetoeditprovidercontainerconnection",children:"Function: navigateToEditProviderContainerConnection()"})}),"\n",(0,t.jsxs)(e.blockquote,{children:["\n",(0,t.jsxs)(e.p,{children:[(0,t.jsx)(e.strong,{children:"navigateToEditProviderContainerConnection"}),"(",(0,t.jsx)(e.code,{children:"connection"}),"): ",(0,t.jsx)(e.code,{children:"Promise"}),"<",(0,t.jsx)(e.code,{children:"void"}),">"]}),"\n"]}),"\n",(0,t.jsx)(e.p,{children:"Navigate to the Edit Provider Container Connection page"}),"\n",(0,t.jsx)(e.h2,{id:"parameters",children:"Parameters"}),"\n",(0,t.jsxs)(e.p,{children:["\u2022 ",(0,t.jsx)(e.strong,{children:"connection"}),": ",(0,t.jsx)(e.a,{href:"/api/interfaces/ProviderContainerConnection",children:(0,t.jsx)(e.code,{children:"ProviderContainerConnection"})})]}),"\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:"defined-in",children:"Defined in"}),"\n",(0,t.jsx)(e.p,{children:(0,t.jsx)(e.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L4546",children:"packages/extension-api/src/extension-api.d.ts:4546"})})]})}function p(n={}){const{wrapper:e}={...(0,o.R)(),...n.components};return e?(0,t.jsx)(e,{...n,children:(0,t.jsx)(l,{...n})}):l(n)}},43023:(n,e,i)=>{i.d(e,{R:()=>r,x:()=>c});var t=i(63696);const o={},a=t.createContext(o);function r(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(o):n.components||o:r(n.components),t.createElement(a.Provider,{value:e},n.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[81497],{35676:(n,e,i)=>{i.r(e),i.d(e,{assets:()=>s,contentTitle:()=>r,default:()=>p,frontMatter:()=>a,metadata:()=>c,toc:()=>d});var t=i(62540),o=i(43023);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:"Defined in",id:"defined-in",level:2}];function l(n){const e={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",strong:"strong",...(0,o.R)(),...n.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(e.header,{children:(0,t.jsx)(e.h1,{id:"function-navigatetoeditprovidercontainerconnection",children:"Function: navigateToEditProviderContainerConnection()"})}),"\n",(0,t.jsxs)(e.blockquote,{children:["\n",(0,t.jsxs)(e.p,{children:[(0,t.jsx)(e.strong,{children:"navigateToEditProviderContainerConnection"}),"(",(0,t.jsx)(e.code,{children:"connection"}),"): ",(0,t.jsx)(e.code,{children:"Promise"}),"<",(0,t.jsx)(e.code,{children:"void"}),">"]}),"\n"]}),"\n",(0,t.jsx)(e.p,{children:"Navigate to the Edit Provider Container Connection page"}),"\n",(0,t.jsx)(e.h2,{id:"parameters",children:"Parameters"}),"\n",(0,t.jsxs)(e.p,{children:["\u2022 ",(0,t.jsx)(e.strong,{children:"connection"}),": ",(0,t.jsx)(e.a,{href:"/api/interfaces/ProviderContainerConnection",children:(0,t.jsx)(e.code,{children:"ProviderContainerConnection"})})]}),"\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:"defined-in",children:"Defined in"}),"\n",(0,t.jsx)(e.p,{children:(0,t.jsx)(e.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L4546",children:"packages/extension-api/src/extension-api.d.ts:4546"})})]})}function p(n={}){const{wrapper:e}={...(0,o.R)(),...n.components};return e?(0,t.jsx)(e,{...n,children:(0,t.jsx)(l,{...n})}):l(n)}},43023:(n,e,i)=>{i.d(e,{R:()=>r,x:()=>c});var t=i(63696);const o={},a=t.createContext(o);function r(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(o):n.components||o:r(n.components),t.createElement(a.Provider,{value:e},n.children)}}}]); \ No newline at end of file diff --git a/assets/js/92b08985.d6d70d3b.js b/assets/js/92b08985.6da183a6.js similarity index 81% rename from assets/js/92b08985.d6d70d3b.js rename to assets/js/92b08985.6da183a6.js index 213278bada6..68dc28436cb 100644 --- a/assets/js/92b08985.d6d70d3b.js +++ b/assets/js/92b08985.6da183a6.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[95044],{41080:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>o,contentTitle:()=>r,default:()=>p,frontMatter:()=>t,metadata:()=>a,toc:()=>c});var s=i(62540),d=i(43023);const t={},r="Interface: NetworkContainer",a={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"}},o={},c=[{value:"Properties",id:"properties",level:2},{value:"EndpointID",id:"endpointid",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"IPv4Address",id:"ipv4address",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"IPv6Address",id:"ipv6address",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"MacAddress",id:"macaddress",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"Name",id:"name",level:3},{value:"Defined in",id:"defined-in-4",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",p:"p",strong:"strong",...(0,d.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.header,{children:(0,s.jsx)(n.h1,{id:"interface-networkcontainer",children:"Interface: NetworkContainer"})}),"\n",(0,s.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,s.jsx)(n.h3,{id:"endpointid",children:"EndpointID"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"EndpointID"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2252",children:"packages/extension-api/src/extension-api.d.ts:2252"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"ipv4address",children:"IPv4Address"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"IPv4Address"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2254",children:"packages/extension-api/src/extension-api.d.ts:2254"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"ipv6address",children:"IPv6Address"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"IPv6Address"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-2",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2255",children:"packages/extension-api/src/extension-api.d.ts:2255"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"macaddress",children:"MacAddress"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"MacAddress"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-3",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2253",children:"packages/extension-api/src/extension-api.d.ts:2253"})}),"\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:"defined-in-4",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2251",children:"packages/extension-api/src/extension-api.d.ts:2251"})})]})}function p(e={}){const{wrapper:n}={...(0,d.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},43023:(e,n,i)=>{i.d(n,{R:()=>r,x:()=>a});var s=i(63696);const d={},t=s.createContext(d);function r(e){const n=s.useContext(t);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(d):e.components||d:r(e.components),s.createElement(t.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[95044],{41080:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>c,contentTitle:()=>r,default:()=>p,frontMatter:()=>d,metadata:()=>a,toc:()=>o});var s=i(62540),t=i(43023);const d={},r="Interface: NetworkContainer",a={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"}},c={},o=[{value:"Properties",id:"properties",level:2},{value:"EndpointID",id:"endpointid",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"IPv4Address",id:"ipv4address",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"IPv6Address",id:"ipv6address",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"MacAddress",id:"macaddress",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"Name",id:"name",level:3},{value:"Defined in",id:"defined-in-4",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",p:"p",strong:"strong",...(0,t.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.header,{children:(0,s.jsx)(n.h1,{id:"interface-networkcontainer",children:"Interface: NetworkContainer"})}),"\n",(0,s.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,s.jsx)(n.h3,{id:"endpointid",children:"EndpointID"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"EndpointID"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2252",children:"packages/extension-api/src/extension-api.d.ts:2252"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"ipv4address",children:"IPv4Address"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"IPv4Address"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2254",children:"packages/extension-api/src/extension-api.d.ts:2254"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"ipv6address",children:"IPv6Address"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"IPv6Address"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-2",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2255",children:"packages/extension-api/src/extension-api.d.ts:2255"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"macaddress",children:"MacAddress"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"MacAddress"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-3",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2253",children:"packages/extension-api/src/extension-api.d.ts:2253"})}),"\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:"defined-in-4",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2251",children:"packages/extension-api/src/extension-api.d.ts:2251"})})]})}function p(e={}){const{wrapper:n}={...(0,t.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},43023:(e,n,i)=>{i.d(n,{R:()=>r,x:()=>a});var s=i(63696);const t={},d=s.createContext(t);function r(e){const n=s.useContext(d);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:r(e.components),s.createElement(d.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/92d7df62.f4dfb03c.js b/assets/js/92d7df62.566158e9.js similarity index 97% rename from assets/js/92d7df62.f4dfb03c.js rename to assets/js/92d7df62.566158e9.js index 67222e6e4cb..06b6c3c912f 100644 --- a/assets/js/92d7df62.f4dfb03c.js +++ b/assets/js/92d7df62.566158e9.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[64179],{27083:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>a,contentTitle:()=>d,default:()=>l,frontMatter:()=>r,metadata:()=>c,toc:()=>o});var i=n(62540),s=n(43023);const r={},d="Interface: Auditor",c={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"}},a={},o=[{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:"Defined in",id:"defined-in",level:4}];function u(e){const t={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",p:"p",strong:"strong",...(0,s.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(t.header,{children:(0,i.jsx)(t.h1,{id:"interface-auditor",children:"Interface: Auditor"})}),"\n",(0,i.jsx)(t.h2,{id:"methods",children:"Methods"}),"\n",(0,i.jsx)(t.h3,{id:"audititems",children:"auditItems()"}),"\n",(0,i.jsxs)(t.blockquote,{children:["\n",(0,i.jsxs)(t.p,{children:[(0,i.jsx)(t.strong,{children:"auditItems"}),"(",(0,i.jsx)(t.code,{children:"items"}),"): ",(0,i.jsx)(t.code,{children:"Promise"}),"<",(0,i.jsx)(t.a,{href:"/api/interfaces/AuditResult",children:(0,i.jsx)(t.code,{children:"AuditResult"})}),">"]}),"\n"]}),"\n",(0,i.jsx)(t.h4,{id:"parameters",children:"Parameters"}),"\n",(0,i.jsxs)(t.p,{children:["\u2022 ",(0,i.jsx)(t.strong,{children:"items"}),": ",(0,i.jsx)(t.a,{href:"/api/interfaces/AuditRequestItems",children:(0,i.jsx)(t.code,{children:"AuditRequestItems"})})]}),"\n",(0,i.jsx)(t.h4,{id:"returns",children:"Returns"}),"\n",(0,i.jsxs)(t.p,{children:[(0,i.jsx)(t.code,{children:"Promise"}),"<",(0,i.jsx)(t.a,{href:"/api/interfaces/AuditResult",children:(0,i.jsx)(t.code,{children:"AuditResult"})}),">"]}),"\n",(0,i.jsx)(t.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,i.jsx)(t.p,{children:(0,i.jsx)(t.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L529",children:"packages/extension-api/src/extension-api.d.ts:529"})})]})}function l(e={}){const{wrapper:t}={...(0,s.R)(),...e.components};return t?(0,i.jsx)(t,{...e,children:(0,i.jsx)(u,{...e})}):u(e)}},43023:(e,t,n)=>{n.d(t,{R:()=>d,x:()=>c});var i=n(63696);const s={},r=i.createContext(s);function d(e){const t=i.useContext(r);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(s):e.components||s:d(e.components),i.createElement(r.Provider,{value:t},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[64179],{27083:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>a,contentTitle:()=>d,default:()=>l,frontMatter:()=>r,metadata:()=>c,toc:()=>o});var i=n(62540),s=n(43023);const r={},d="Interface: Auditor",c={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"}},a={},o=[{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:"Defined in",id:"defined-in",level:4}];function u(e){const t={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",p:"p",strong:"strong",...(0,s.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(t.header,{children:(0,i.jsx)(t.h1,{id:"interface-auditor",children:"Interface: Auditor"})}),"\n",(0,i.jsx)(t.h2,{id:"methods",children:"Methods"}),"\n",(0,i.jsx)(t.h3,{id:"audititems",children:"auditItems()"}),"\n",(0,i.jsxs)(t.blockquote,{children:["\n",(0,i.jsxs)(t.p,{children:[(0,i.jsx)(t.strong,{children:"auditItems"}),"(",(0,i.jsx)(t.code,{children:"items"}),"): ",(0,i.jsx)(t.code,{children:"Promise"}),"<",(0,i.jsx)(t.a,{href:"/api/interfaces/AuditResult",children:(0,i.jsx)(t.code,{children:"AuditResult"})}),">"]}),"\n"]}),"\n",(0,i.jsx)(t.h4,{id:"parameters",children:"Parameters"}),"\n",(0,i.jsxs)(t.p,{children:["\u2022 ",(0,i.jsx)(t.strong,{children:"items"}),": ",(0,i.jsx)(t.a,{href:"/api/interfaces/AuditRequestItems",children:(0,i.jsx)(t.code,{children:"AuditRequestItems"})})]}),"\n",(0,i.jsx)(t.h4,{id:"returns",children:"Returns"}),"\n",(0,i.jsxs)(t.p,{children:[(0,i.jsx)(t.code,{children:"Promise"}),"<",(0,i.jsx)(t.a,{href:"/api/interfaces/AuditResult",children:(0,i.jsx)(t.code,{children:"AuditResult"})}),">"]}),"\n",(0,i.jsx)(t.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,i.jsx)(t.p,{children:(0,i.jsx)(t.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L529",children:"packages/extension-api/src/extension-api.d.ts:529"})})]})}function l(e={}){const{wrapper:t}={...(0,s.R)(),...e.components};return t?(0,i.jsx)(t,{...e,children:(0,i.jsx)(u,{...e})}):u(e)}},43023:(e,t,n)=>{n.d(t,{R:()=>d,x:()=>c});var i=n(63696);const s={},r=i.createContext(s);function d(e){const t=i.useContext(r);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(s):e.components||s:d(e.components),i.createElement(r.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/931e3b0a.2ba77572.js b/assets/js/931e3b0a.f3bb935b.js similarity index 81% rename from assets/js/931e3b0a.2ba77572.js rename to assets/js/931e3b0a.f3bb935b.js index 912f4fded36..c84fad7a591 100644 --- a/assets/js/931e3b0a.2ba77572.js +++ b/assets/js/931e3b0a.f3bb935b.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[93891],{79645:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>c,contentTitle:()=>o,default:()=>l,frontMatter:()=>s,metadata:()=>d,toc:()=>a});var i=t(62540),r=t(43023);const s={},o="Interface: PortBinding",d={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"}},c={},a=[{value:"Properties",id:"properties",level:2},{value:"HostIp?",id:"hostip",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"HostPort?",id:"hostport",level:3},{value:"Defined in",id:"defined-in-1",level:4}];function p(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",p:"p",strong:"strong",...(0,r.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.header,{children:(0,i.jsx)(n.h1,{id:"interface-portbinding",children:"Interface: PortBinding"})}),"\n",(0,i.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(n.h3,{id:"hostip",children:"HostIp?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"HostIp"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2376",children:"packages/extension-api/src/extension-api.d.ts:2376"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"hostport",children:"HostPort?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"HostPort"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2377",children:"packages/extension-api/src/extension-api.d.ts:2377"})})]})}function l(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(p,{...e})}):p(e)}},43023:(e,n,t)=>{t.d(n,{R:()=>o,x:()=>d});var i=t(63696);const r={},s=i.createContext(r);function o(e){const n=i.useContext(s);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(s.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[93891],{79645:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>d,contentTitle:()=>o,default:()=>l,frontMatter:()=>s,metadata:()=>c,toc:()=>a});var i=t(62540),r=t(43023);const s={},o="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"}},d={},a=[{value:"Properties",id:"properties",level:2},{value:"HostIp?",id:"hostip",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"HostPort?",id:"hostport",level:3},{value:"Defined in",id:"defined-in-1",level:4}];function p(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",p:"p",strong:"strong",...(0,r.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.header,{children:(0,i.jsx)(n.h1,{id:"interface-portbinding",children:"Interface: PortBinding"})}),"\n",(0,i.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(n.h3,{id:"hostip",children:"HostIp?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"HostIp"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2376",children:"packages/extension-api/src/extension-api.d.ts:2376"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"hostport",children:"HostPort?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"HostPort"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2377",children:"packages/extension-api/src/extension-api.d.ts:2377"})})]})}function l(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(p,{...e})}):p(e)}},43023:(e,n,t)=>{t.d(n,{R:()=>o,x:()=>c});var i=t(63696);const r={},s=i.createContext(r);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(r):e.components||r:o(e.components),i.createElement(s.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/94324b0e.e545997a.js b/assets/js/94324b0e.8e17c1ee.js similarity index 95% rename from assets/js/94324b0e.e545997a.js rename to assets/js/94324b0e.8e17c1ee.js index 21f736cbbfb..58cb2208e61 100644 --- a/assets/js/94324b0e.e545997a.js +++ b/assets/js/94324b0e.8e17c1ee.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[9072],{86263:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>i,default:()=>u,frontMatter:()=>r,metadata:()=>c,toc:()=>d});var s=t(62540),o=t(43023);const r={},i="Function: createVolume()",c={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={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Defined in",id:"defined-in",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",strong:"strong",...(0,o.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.header,{children:(0,s.jsx)(n.h1,{id:"function-createvolume",children:"Function: createVolume()"})}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"createVolume"}),"(",(0,s.jsx)(n.code,{children:"options"}),"?): ",(0,s.jsx)(n.code,{children:"Promise"}),"<",(0,s.jsx)(n.a,{href:"/api/interfaces/VolumeCreateResponseInfo",children:(0,s.jsx)(n.code,{children:"VolumeCreateResponseInfo"})}),">"]}),"\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/VolumeCreateOptions",children:(0,s.jsx)(n.code,{children:"VolumeCreateOptions"})})]}),"\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/VolumeCreateResponseInfo",children:(0,s.jsx)(n.code,{children:"VolumeCreateResponseInfo"})}),">"]}),"\n",(0,s.jsx)(n.h2,{id:"defined-in",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L3677",children:"packages/extension-api/src/extension-api.d.ts:3677"})})]})}function u(e={}){const{wrapper:n}={...(0,o.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},43023:(e,n,t)=>{t.d(n,{R:()=>i,x:()=>c});var s=t(63696);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([[9072],{86263:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>i,default:()=>u,frontMatter:()=>r,metadata:()=>c,toc:()=>d});var s=t(62540),o=t(43023);const r={},i="Function: createVolume()",c={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={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Defined in",id:"defined-in",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",strong:"strong",...(0,o.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.header,{children:(0,s.jsx)(n.h1,{id:"function-createvolume",children:"Function: createVolume()"})}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"createVolume"}),"(",(0,s.jsx)(n.code,{children:"options"}),"?): ",(0,s.jsx)(n.code,{children:"Promise"}),"<",(0,s.jsx)(n.a,{href:"/api/interfaces/VolumeCreateResponseInfo",children:(0,s.jsx)(n.code,{children:"VolumeCreateResponseInfo"})}),">"]}),"\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/VolumeCreateOptions",children:(0,s.jsx)(n.code,{children:"VolumeCreateOptions"})})]}),"\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/VolumeCreateResponseInfo",children:(0,s.jsx)(n.code,{children:"VolumeCreateResponseInfo"})}),">"]}),"\n",(0,s.jsx)(n.h2,{id:"defined-in",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L3677",children:"packages/extension-api/src/extension-api.d.ts:3677"})})]})}function u(e={}){const{wrapper:n}={...(0,o.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},43023:(e,n,t)=>{t.d(n,{R:()=>i,x:()=>c});var s=t(63696);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/95646edb.3ebe70b6.js b/assets/js/95646edb.a1f5bd24.js similarity index 96% rename from assets/js/95646edb.3ebe70b6.js rename to assets/js/95646edb.a1f5bd24.js index 46f77f55f1b..83a37511248 100644 --- a/assets/js/95646edb.3ebe70b6.js +++ b/assets/js/95646edb.a1f5bd24.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[64558],{30998:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>a,contentTitle:()=>c,default:()=>h,frontMatter:()=>r,metadata:()=>o,toc:()=>l});var i=s(62540),t=s(43023);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:"Defined in",id:"defined-in",level:2}];function d(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",strong:"strong",...(0,t.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.header,{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:"defined-in",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L3668",children:"packages/extension-api/src/extension-api.d.ts:3668"})})]})}function h(e={}){const{wrapper:n}={...(0,t.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(d,{...e})}):d(e)}},43023:(e,n,s)=>{s.d(n,{R:()=>c,x:()=>o});var i=s(63696);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([[64558],{30998:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>a,contentTitle:()=>c,default:()=>h,frontMatter:()=>r,metadata:()=>o,toc:()=>l});var i=s(62540),t=s(43023);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:"Defined in",id:"defined-in",level:2}];function d(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",strong:"strong",...(0,t.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.header,{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:"defined-in",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L3668",children:"packages/extension-api/src/extension-api.d.ts:3668"})})]})}function h(e={}){const{wrapper:n}={...(0,t.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(d,{...e})}):d(e)}},43023:(e,n,s)=>{s.d(n,{R:()=>c,x:()=>o});var i=s(63696);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.df480da6.js b/assets/js/97c7db18.dac6b774.js similarity index 95% rename from assets/js/97c7db18.df480da6.js rename to assets/js/97c7db18.dac6b774.js index 115084dffa8..d6c9b4ebfda 100644 --- a/assets/js/97c7db18.df480da6.js +++ b/assets/js/97c7db18.dac6b774.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[72972],{39663:(n,e,t)=>{t.r(e),t.d(e,{assets:()=>c,contentTitle:()=>s,default:()=>l,frontMatter:()=>o,metadata:()=>r,toc:()=>d});var i=t(62540),a=t(43023);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:"Defined in",id:"defined-in",level:2}];function p(n){const e={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",strong:"strong",...(0,a.R)(),...n.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(e.header,{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:"defined-in",children:"Defined in"}),"\n",(0,i.jsx)(e.p,{children:(0,i.jsx)(e.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L4504",children:"packages/extension-api/src/extension-api.d.ts:4504"})})]})}function l(n={}){const{wrapper:e}={...(0,a.R)(),...n.components};return e?(0,i.jsx)(e,{...n,children:(0,i.jsx)(p,{...n})}):p(n)}},43023:(n,e,t)=>{t.d(e,{R:()=>s,x:()=>r});var i=t(63696);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([[72972],{39663:(n,e,t)=>{t.r(e),t.d(e,{assets:()=>c,contentTitle:()=>s,default:()=>l,frontMatter:()=>o,metadata:()=>r,toc:()=>d});var i=t(62540),a=t(43023);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:"Defined in",id:"defined-in",level:2}];function p(n){const e={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",strong:"strong",...(0,a.R)(),...n.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(e.header,{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:"defined-in",children:"Defined in"}),"\n",(0,i.jsx)(e.p,{children:(0,i.jsx)(e.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L4504",children:"packages/extension-api/src/extension-api.d.ts:4504"})})]})}function l(n={}){const{wrapper:e}={...(0,a.R)(),...n.components};return e?(0,i.jsx)(e,{...n,children:(0,i.jsx)(p,{...n})}):p(n)}},43023:(n,e,t)=>{t.d(e,{R:()=>s,x:()=>r});var i=t(63696);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.b3f60952.js b/assets/js/97d49594.cae37401.js similarity index 98% rename from assets/js/97d49594.b3f60952.js rename to assets/js/97d49594.cae37401.js index ebccbf2cb4a..712b3e53dd0 100644 --- a/assets/js/97d49594.b3f60952.js +++ b/assets/js/97d49594.cae37401.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[73318],{18158:(n,e,i)=>{i.r(e),i.d(e,{assets:()=>a,contentTitle:()=>o,default:()=>l,frontMatter:()=>r,metadata:()=>c,toc:()=>d});var t=i(62540),s=i(43023);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:"Defined in",id:"defined-in",level:2}];function p(n){const e={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",strong:"strong",...(0,s.R)(),...n.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(e.header,{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:"defined-in",children:"Defined in"}),"\n",(0,t.jsx)(e.p,{children:(0,t.jsx)(e.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L3472",children:"packages/extension-api/src/extension-api.d.ts:3472"})})]})}function l(n={}){const{wrapper:e}={...(0,s.R)(),...n.components};return e?(0,t.jsx)(e,{...n,children:(0,t.jsx)(p,{...n})}):p(n)}},43023:(n,e,i)=>{i.d(e,{R:()=>o,x:()=>c});var t=i(63696);const s={},r=t.createContext(s);function o(n){const e=t.useContext(r);return t.useMemo((function(){return"function"==typeof n?n(e):{...e,...n}}),[e,n])}function c(n){let e;return e=n.disableParentContext?"function"==typeof n.components?n.components(s):n.components||s:o(n.components),t.createElement(r.Provider,{value:e},n.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[73318],{18158:(n,e,i)=>{i.r(e),i.d(e,{assets:()=>a,contentTitle:()=>o,default:()=>l,frontMatter:()=>r,metadata:()=>c,toc:()=>d});var t=i(62540),s=i(43023);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:"Defined in",id:"defined-in",level:2}];function p(n){const e={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",strong:"strong",...(0,s.R)(),...n.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(e.header,{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:"defined-in",children:"Defined in"}),"\n",(0,t.jsx)(e.p,{children:(0,t.jsx)(e.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L3472",children:"packages/extension-api/src/extension-api.d.ts:3472"})})]})}function l(n={}){const{wrapper:e}={...(0,s.R)(),...n.components};return e?(0,t.jsx)(e,{...n,children:(0,t.jsx)(p,{...n})}):p(n)}},43023:(n,e,i)=>{i.d(e,{R:()=>o,x:()=>c});var t=i(63696);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.a2dd54be.js b/assets/js/97eb992d.d695cef5.js similarity index 86% rename from assets/js/97eb992d.a2dd54be.js rename to assets/js/97eb992d.d695cef5.js index ca6687fb977..ae12529e73d 100644 --- a/assets/js/97eb992d.a2dd54be.js +++ b/assets/js/97eb992d.d695cef5.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[39498],{46079:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>t,contentTitle:()=>a,default:()=>h,frontMatter:()=>r,metadata:()=>c,toc:()=>o});var s=i(62540),d=i(43023);const r={},a="Interface: NetworkInspectInfo",c={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={},o=[{value:"Properties",id:"properties",level:2},{value:"Attachable",id:"attachable",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"ConfigFrom?",id:"configfrom",level:3},{value:"Network",id:"network",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"ConfigOnly",id:"configonly",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"Containers?",id:"containers",level:3},{value:"Index Signature",id:"index-signature",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"Created",id:"created",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"Driver",id:"driver",level:3},{value:"Defined in",id:"defined-in-5",level:4},{value:"EnableIPv6",id:"enableipv6",level:3},{value:"Defined in",id:"defined-in-6",level:4},{value:"IPAM?",id:"ipam",level:3},{value:"Defined in",id:"defined-in-7",level:4},{value:"Id",id:"id",level:3},{value:"Defined in",id:"defined-in-8",level:4},{value:"Ingress",id:"ingress",level:3},{value:"Defined in",id:"defined-in-9",level:4},{value:"Internal",id:"internal",level:3},{value:"Defined in",id:"defined-in-10",level:4},{value:"Labels?",id:"labels",level:3},{value:"Index Signature",id:"index-signature-1",level:4},{value:"Defined in",id:"defined-in-11",level:4},{value:"Name",id:"name",level:3},{value:"Defined in",id:"defined-in-12",level:4},{value:"Options?",id:"options",level:3},{value:"Index Signature",id:"index-signature-2",level:4},{value:"Defined in",id:"defined-in-13",level:4},{value:"Scope",id:"scope",level:3},{value:"Defined in",id:"defined-in-14",level:4},{value:"engineId",id:"engineid",level:3},{value:"Defined in",id:"defined-in-15",level:4},{value:"engineName",id:"enginename",level:3},{value:"Defined in",id:"defined-in-16",level:4},{value:"engineType",id:"enginetype",level:3},{value:"Defined in",id:"defined-in-17",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",p:"p",strong:"strong",...(0,d.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.header,{children:(0,s.jsx)(n.h1,{id:"interface-networkinspectinfo",children:"Interface: NetworkInspectInfo"})}),"\n",(0,s.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,s.jsx)(n.h3,{id:"attachable",children:"Attachable"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Attachable"}),": ",(0,s.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2276",children:"packages/extension-api/src/extension-api.d.ts:2276"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"configfrom",children:"ConfigFrom?"}),"\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:"ConfigFrom"}),": ",(0,s.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"network",children:"Network"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Network"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2278",children:"packages/extension-api/src/extension-api.d.ts:2278"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"configonly",children:"ConfigOnly"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"ConfigOnly"}),": ",(0,s.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-2",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2279",children:"packages/extension-api/src/extension-api.d.ts:2279"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"containers",children:"Containers?"}),"\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:"Containers"}),": ",(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:"id"}),": ",(0,s.jsx)(n.code,{children:"string"}),"]: ",(0,s.jsx)(n.a,{href:"/api/interfaces/NetworkContainer",children:(0,s.jsx)(n.code,{children:"NetworkContainer"})})]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-3",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2280",children:"packages/extension-api/src/extension-api.d.ts:2280"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"created",children:"Created"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Created"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-4",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2270",children:"packages/extension-api/src/extension-api.d.ts:2270"})}),"\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.strong,{children:"Driver"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-5",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2272",children:"packages/extension-api/src/extension-api.d.ts:2272"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"enableipv6",children:"EnableIPv6"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"EnableIPv6"}),": ",(0,s.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-6",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2273",children:"packages/extension-api/src/extension-api.d.ts:2273"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"ipam",children:"IPAM?"}),"\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:"IPAM"}),": ",(0,s.jsx)(n.a,{href:"/api/interfaces/IPAM",children:(0,s.jsx)(n.code,{children:"IPAM"})})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-7",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2274",children:"packages/extension-api/src/extension-api.d.ts:2274"})}),"\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:"defined-in-8",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2269",children:"packages/extension-api/src/extension-api.d.ts:2269"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"ingress",children:"Ingress"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Ingress"}),": ",(0,s.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-9",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2277",children:"packages/extension-api/src/extension-api.d.ts:2277"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"internal",children:"Internal"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Internal"}),": ",(0,s.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-10",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2275",children:"packages/extension-api/src/extension-api.d.ts:2275"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"labels",children:"Labels?"}),"\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:"Labels"}),": ",(0,s.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"index-signature-1",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:"defined-in-11",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2282",children:"packages/extension-api/src/extension-api.d.ts:2282"})}),"\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:"defined-in-12",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2268",children:"packages/extension-api/src/extension-api.d.ts:2268"})}),"\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-2",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:"defined-in-13",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2281",children:"packages/extension-api/src/extension-api.d.ts:2281"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"scope",children:"Scope"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Scope"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-14",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2271",children:"packages/extension-api/src/extension-api.d.ts:2271"})}),"\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.h4,{id:"defined-in-15",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2265",children:"packages/extension-api/src/extension-api.d.ts:2265"})}),"\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.h4,{id:"defined-in-16",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2266",children:"packages/extension-api/src/extension-api.d.ts:2266"})}),"\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.h4,{id:"defined-in-17",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2267",children:"packages/extension-api/src/extension-api.d.ts:2267"})})]})}function h(e={}){const{wrapper:n}={...(0,d.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},43023:(e,n,i)=>{i.d(n,{R:()=>a,x:()=>c});var s=i(63696);const d={},r=s.createContext(d);function a(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(d):e.components||d:a(e.components),s.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[39498],{46079:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>t,contentTitle:()=>r,default:()=>h,frontMatter:()=>c,metadata:()=>a,toc:()=>o});var s=i(62540),d=i(43023);const c={},r="Interface: NetworkInspectInfo",a={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={},o=[{value:"Properties",id:"properties",level:2},{value:"Attachable",id:"attachable",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"ConfigFrom?",id:"configfrom",level:3},{value:"Network",id:"network",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"ConfigOnly",id:"configonly",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"Containers?",id:"containers",level:3},{value:"Index Signature",id:"index-signature",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"Created",id:"created",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"Driver",id:"driver",level:3},{value:"Defined in",id:"defined-in-5",level:4},{value:"EnableIPv6",id:"enableipv6",level:3},{value:"Defined in",id:"defined-in-6",level:4},{value:"IPAM?",id:"ipam",level:3},{value:"Defined in",id:"defined-in-7",level:4},{value:"Id",id:"id",level:3},{value:"Defined in",id:"defined-in-8",level:4},{value:"Ingress",id:"ingress",level:3},{value:"Defined in",id:"defined-in-9",level:4},{value:"Internal",id:"internal",level:3},{value:"Defined in",id:"defined-in-10",level:4},{value:"Labels?",id:"labels",level:3},{value:"Index Signature",id:"index-signature-1",level:4},{value:"Defined in",id:"defined-in-11",level:4},{value:"Name",id:"name",level:3},{value:"Defined in",id:"defined-in-12",level:4},{value:"Options?",id:"options",level:3},{value:"Index Signature",id:"index-signature-2",level:4},{value:"Defined in",id:"defined-in-13",level:4},{value:"Scope",id:"scope",level:3},{value:"Defined in",id:"defined-in-14",level:4},{value:"engineId",id:"engineid",level:3},{value:"Defined in",id:"defined-in-15",level:4},{value:"engineName",id:"enginename",level:3},{value:"Defined in",id:"defined-in-16",level:4},{value:"engineType",id:"enginetype",level:3},{value:"Defined in",id:"defined-in-17",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",p:"p",strong:"strong",...(0,d.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.header,{children:(0,s.jsx)(n.h1,{id:"interface-networkinspectinfo",children:"Interface: NetworkInspectInfo"})}),"\n",(0,s.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,s.jsx)(n.h3,{id:"attachable",children:"Attachable"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Attachable"}),": ",(0,s.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2276",children:"packages/extension-api/src/extension-api.d.ts:2276"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"configfrom",children:"ConfigFrom?"}),"\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:"ConfigFrom"}),": ",(0,s.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"network",children:"Network"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Network"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2278",children:"packages/extension-api/src/extension-api.d.ts:2278"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"configonly",children:"ConfigOnly"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"ConfigOnly"}),": ",(0,s.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-2",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2279",children:"packages/extension-api/src/extension-api.d.ts:2279"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"containers",children:"Containers?"}),"\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:"Containers"}),": ",(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:"id"}),": ",(0,s.jsx)(n.code,{children:"string"}),"]: ",(0,s.jsx)(n.a,{href:"/api/interfaces/NetworkContainer",children:(0,s.jsx)(n.code,{children:"NetworkContainer"})})]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-3",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2280",children:"packages/extension-api/src/extension-api.d.ts:2280"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"created",children:"Created"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Created"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-4",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2270",children:"packages/extension-api/src/extension-api.d.ts:2270"})}),"\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.strong,{children:"Driver"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-5",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2272",children:"packages/extension-api/src/extension-api.d.ts:2272"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"enableipv6",children:"EnableIPv6"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"EnableIPv6"}),": ",(0,s.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-6",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2273",children:"packages/extension-api/src/extension-api.d.ts:2273"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"ipam",children:"IPAM?"}),"\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:"IPAM"}),": ",(0,s.jsx)(n.a,{href:"/api/interfaces/IPAM",children:(0,s.jsx)(n.code,{children:"IPAM"})})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-7",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2274",children:"packages/extension-api/src/extension-api.d.ts:2274"})}),"\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:"defined-in-8",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2269",children:"packages/extension-api/src/extension-api.d.ts:2269"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"ingress",children:"Ingress"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Ingress"}),": ",(0,s.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-9",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2277",children:"packages/extension-api/src/extension-api.d.ts:2277"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"internal",children:"Internal"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Internal"}),": ",(0,s.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-10",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2275",children:"packages/extension-api/src/extension-api.d.ts:2275"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"labels",children:"Labels?"}),"\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:"Labels"}),": ",(0,s.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"index-signature-1",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:"defined-in-11",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2282",children:"packages/extension-api/src/extension-api.d.ts:2282"})}),"\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:"defined-in-12",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2268",children:"packages/extension-api/src/extension-api.d.ts:2268"})}),"\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-2",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:"defined-in-13",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2281",children:"packages/extension-api/src/extension-api.d.ts:2281"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"scope",children:"Scope"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Scope"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-14",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2271",children:"packages/extension-api/src/extension-api.d.ts:2271"})}),"\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.h4,{id:"defined-in-15",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2265",children:"packages/extension-api/src/extension-api.d.ts:2265"})}),"\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.h4,{id:"defined-in-16",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2266",children:"packages/extension-api/src/extension-api.d.ts:2266"})}),"\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.h4,{id:"defined-in-17",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2267",children:"packages/extension-api/src/extension-api.d.ts:2267"})})]})}function h(e={}){const{wrapper:n}={...(0,d.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},43023:(e,n,i)=>{i.d(n,{R:()=>r,x:()=>a});var s=i(63696);const d={},c=s.createContext(d);function r(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(d):e.components||d:r(e.components),s.createElement(c.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/981d19db.139797b9.js b/assets/js/981d19db.d1785594.js similarity index 97% rename from assets/js/981d19db.139797b9.js rename to assets/js/981d19db.d1785594.js index 36f6c768204..46375dab999 100644 --- a/assets/js/981d19db.139797b9.js +++ b/assets/js/981d19db.d1785594.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[48279],{45529:(e,n,a)=>{a.r(n),a.d(n,{assets:()=>c,contentTitle:()=>l,default:()=>p,frontMatter:()=>i,metadata:()=>o,toc:()=>r});var t=a(62540),s=a(43023);const i={},l="Variable: all",o={id:"namespaces/cli/variables/all",title:"Variable: all",description:"const all: readonly CliToolInfo[]",source:"@site/api/namespaces/cli/variables/all.md",sourceDirName:"namespaces/cli/variables",slug:"/namespaces/cli/variables/all",permalink:"/api/namespaces/cli/variables/all",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"cli",permalink:"/api/namespaces/cli/"},next:{title:"createCliTool",permalink:"/api/namespaces/cli/functions/createCliTool"}},c={},r=[{value:"Defined in",id:"defined-in",level:2}];function d(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",strong:"strong",...(0,s.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.header,{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/CliToolInfo",children:(0,t.jsx)(n.code,{children:"CliToolInfo"})}),"[]"]}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"All cli tools currently known to the system."}),"\n",(0,t.jsx)(n.h2,{id:"defined-in",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L4414",children:"packages/extension-api/src/extension-api.d.ts:4414"})})]})}function p(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(d,{...e})}):d(e)}},43023:(e,n,a)=>{a.d(n,{R:()=>l,x:()=>o});var t=a(63696);const s={},i=t.createContext(s);function l(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:l(e.components),t.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[48279],{45529:(e,n,a)=>{a.r(n),a.d(n,{assets:()=>c,contentTitle:()=>l,default:()=>p,frontMatter:()=>i,metadata:()=>o,toc:()=>r});var t=a(62540),s=a(43023);const i={},l="Variable: all",o={id:"namespaces/cli/variables/all",title:"Variable: all",description:"const all: readonly CliToolInfo[]",source:"@site/api/namespaces/cli/variables/all.md",sourceDirName:"namespaces/cli/variables",slug:"/namespaces/cli/variables/all",permalink:"/api/namespaces/cli/variables/all",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"cli",permalink:"/api/namespaces/cli/"},next:{title:"createCliTool",permalink:"/api/namespaces/cli/functions/createCliTool"}},c={},r=[{value:"Defined in",id:"defined-in",level:2}];function d(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",strong:"strong",...(0,s.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.header,{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/CliToolInfo",children:(0,t.jsx)(n.code,{children:"CliToolInfo"})}),"[]"]}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"All cli tools currently known to the system."}),"\n",(0,t.jsx)(n.h2,{id:"defined-in",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L4414",children:"packages/extension-api/src/extension-api.d.ts:4414"})})]})}function p(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(d,{...e})}):d(e)}},43023:(e,n,a)=>{a.d(n,{R:()=>l,x:()=>o});var t=a(63696);const s={},i=t.createContext(s);function l(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:l(e.components),t.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/98ced590.5593af1c.js b/assets/js/98ced590.d54e161f.js similarity index 95% rename from assets/js/98ced590.5593af1c.js rename to assets/js/98ced590.d54e161f.js index 84be3fcb693..59a13ce4c18 100644 --- a/assets/js/98ced590.5593af1c.js +++ b/assets/js/98ced590.d54e161f.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[85462],{94867:(n,e,i)=>{i.r(e),i.d(e,{assets:()=>c,contentTitle:()=>r,default:()=>u,frontMatter:()=>o,metadata:()=>s,toc:()=>d});var t=i(62540),a=i(43023);const o={},r="Function: navigateToContainerTerminal()",s={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:"Defined in",id:"defined-in",level:2}];function l(n){const e={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",strong:"strong",...(0,a.R)(),...n.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(e.header,{children:(0,t.jsx)(e.h1,{id:"function-navigatetocontainerterminal",children:"Function: navigateToContainerTerminal()"})}),"\n",(0,t.jsxs)(e.blockquote,{children:["\n",(0,t.jsxs)(e.p,{children:[(0,t.jsx)(e.strong,{children:"navigateToContainerTerminal"}),"(",(0,t.jsx)(e.code,{children:"id"}),"): ",(0,t.jsx)(e.code,{children:"Promise"}),"<",(0,t.jsx)(e.code,{children:"void"}),">"]}),"\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:"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.code,{children:"void"}),">"]}),"\n",(0,t.jsx)(e.h2,{id:"defined-in",children:"Defined in"}),"\n",(0,t.jsx)(e.p,{children:(0,t.jsx)(e.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L4506",children:"packages/extension-api/src/extension-api.d.ts:4506"})})]})}function u(n={}){const{wrapper:e}={...(0,a.R)(),...n.components};return e?(0,t.jsx)(e,{...n,children:(0,t.jsx)(l,{...n})}):l(n)}},43023:(n,e,i)=>{i.d(e,{R:()=>r,x:()=>s});var t=i(63696);const a={},o=t.createContext(a);function r(n){const e=t.useContext(o);return t.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:r(n.components),t.createElement(o.Provider,{value:e},n.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[85462],{94867:(n,e,i)=>{i.r(e),i.d(e,{assets:()=>c,contentTitle:()=>r,default:()=>u,frontMatter:()=>o,metadata:()=>s,toc:()=>d});var t=i(62540),a=i(43023);const o={},r="Function: navigateToContainerTerminal()",s={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:"Defined in",id:"defined-in",level:2}];function l(n){const e={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",strong:"strong",...(0,a.R)(),...n.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(e.header,{children:(0,t.jsx)(e.h1,{id:"function-navigatetocontainerterminal",children:"Function: navigateToContainerTerminal()"})}),"\n",(0,t.jsxs)(e.blockquote,{children:["\n",(0,t.jsxs)(e.p,{children:[(0,t.jsx)(e.strong,{children:"navigateToContainerTerminal"}),"(",(0,t.jsx)(e.code,{children:"id"}),"): ",(0,t.jsx)(e.code,{children:"Promise"}),"<",(0,t.jsx)(e.code,{children:"void"}),">"]}),"\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:"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.code,{children:"void"}),">"]}),"\n",(0,t.jsx)(e.h2,{id:"defined-in",children:"Defined in"}),"\n",(0,t.jsx)(e.p,{children:(0,t.jsx)(e.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L4506",children:"packages/extension-api/src/extension-api.d.ts:4506"})})]})}function u(n={}){const{wrapper:e}={...(0,a.R)(),...n.components};return e?(0,t.jsx)(e,{...n,children:(0,t.jsx)(l,{...n})}):l(n)}},43023:(n,e,i)=>{i.d(e,{R:()=>r,x:()=>s});var t=i(63696);const a={},o=t.createContext(a);function r(n){const e=t.useContext(o);return t.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:r(n.components),t.createElement(o.Provider,{value:e},n.children)}}}]); \ No newline at end of file diff --git a/assets/js/9a22c80d.b5e3e719.js b/assets/js/9a22c80d.89dbfcb3.js similarity index 94% rename from assets/js/9a22c80d.b5e3e719.js rename to assets/js/9a22c80d.89dbfcb3.js index cc3de0ea606..284a0c8b0e4 100644 --- a/assets/js/9a22c80d.b5e3e719.js +++ b/assets/js/9a22c80d.89dbfcb3.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[12248],{31393:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>c,contentTitle:()=>o,default:()=>p,frontMatter:()=>i,metadata:()=>r,toc:()=>l});var t=s(62540),a=s(43023);const i={},o="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:"extensions",permalink:"/api/namespaces/extensions/"},next:{title:"getExtension",permalink:"/api/namespaces/extensions/functions/getExtension"}},c={},l=[{value:"Defined in",id:"defined-in",level:2}];function d(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",strong:"strong",...(0,a.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.header,{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:"defined-in",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/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.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(d,{...e})}):d(e)}},43023:(e,n,s)=>{s.d(n,{R:()=>o,x:()=>r});var t=s(63696);const a={},i=t.createContext(a);function o(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(a):e.components||a:o(e.components),t.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[12248],{31393:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>c,contentTitle:()=>o,default:()=>p,frontMatter:()=>i,metadata:()=>r,toc:()=>l});var t=s(62540),a=s(43023);const i={},o="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:"extensions",permalink:"/api/namespaces/extensions/"},next:{title:"getExtension",permalink:"/api/namespaces/extensions/functions/getExtension"}},c={},l=[{value:"Defined in",id:"defined-in",level:2}];function d(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",strong:"strong",...(0,a.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.header,{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:"defined-in",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/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.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(d,{...e})}):d(e)}},43023:(e,n,s)=>{s.d(n,{R:()=>o,x:()=>r});var t=s(63696);const a={},i=t.createContext(a);function o(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(a):e.components||a:o(e.components),t.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/9af13eab.074366e1.js b/assets/js/9af13eab.694eae48.js similarity index 95% rename from assets/js/9af13eab.074366e1.js rename to assets/js/9af13eab.694eae48.js index 8eec0827205..771fa11a884 100644 --- a/assets/js/9af13eab.074366e1.js +++ b/assets/js/9af13eab.694eae48.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[1647],{90577:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>s,default:()=>u,frontMatter:()=>r,metadata:()=>c,toc:()=>d});var o=t(62540),i=t(43023);const r={},s="Function: getContainerConnections()",c={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:"Defined in",id:"defined-in",level:2}];function p(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",strong:"strong",...(0,i.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(n.header,{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:"defined-in",children:"Defined in"}),"\n",(0,o.jsx)(n.p,{children:(0,o.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L837",children:"packages/extension-api/src/extension-api.d.ts:837"})})]})}function u(e={}){const{wrapper:n}={...(0,i.R)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(p,{...e})}):p(e)}},43023:(e,n,t)=>{t.d(n,{R:()=>s,x:()=>c});var o=t(63696);const i={},r=o.createContext(i);function s(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(i):e.components||i:s(e.components),o.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[1647],{90577:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>s,default:()=>u,frontMatter:()=>r,metadata:()=>c,toc:()=>d});var o=t(62540),i=t(43023);const r={},s="Function: getContainerConnections()",c={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:"Defined in",id:"defined-in",level:2}];function p(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",strong:"strong",...(0,i.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(n.header,{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:"defined-in",children:"Defined in"}),"\n",(0,o.jsx)(n.p,{children:(0,o.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L837",children:"packages/extension-api/src/extension-api.d.ts:837"})})]})}function u(e={}){const{wrapper:n}={...(0,i.R)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(p,{...e})}):p(e)}},43023:(e,n,t)=>{t.d(n,{R:()=>s,x:()=>c});var o=t(63696);const i={},r=o.createContext(i);function s(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(i):e.components||i:s(e.components),o.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/9c540f0b.a6ad9d29.js b/assets/js/9c540f0b.2174f7e5.js similarity index 91% rename from assets/js/9c540f0b.a6ad9d29.js rename to assets/js/9c540f0b.2174f7e5.js index 1f6bf86dd0d..a6de5e04a69 100644 --- a/assets/js/9c540f0b.a6ad9d29.js +++ b/assets/js/9c540f0b.2174f7e5.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[13680],{657:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>c,contentTitle:()=>t,default:()=>h,frontMatter:()=>o,metadata:()=>r,toc:()=>l});var s=i(62540),d=i(43023);const o={},t="Interface: MountSettings",r={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"}},c={},l=[{value:"Properties",id:"properties",level:2},{value:"BindOptions?",id:"bindoptions",level:3},{value:"Propagation",id:"propagation",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"Consistency?",id:"consistency",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"Mode?",id:"mode",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"ReadOnly?",id:"readonly",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"Source",id:"source",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"Target",id:"target",level:3},{value:"Defined in",id:"defined-in-5",level:4},{value:"TmpfsOptions?",id:"tmpfsoptions",level:3},{value:"Mode",id:"mode-1",level:4},{value:"SizeBytes",id:"sizebytes",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"Type",id:"type",level:3},{value:"Defined in",id:"defined-in-7",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:"Defined in",id:"defined-in-8",level:4}];function a(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",h5:"h5",header:"header",hr:"hr",p:"p",strong:"strong",...(0,d.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.header,{children:(0,s.jsx)(n.h1,{id:"interface-mountsettings",children:"Interface: MountSettings"})}),"\n",(0,s.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,s.jsx)(n.h3,{id:"bindoptions",children:"BindOptions?"}),"\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:"BindOptions"}),": ",(0,s.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"propagation",children:"Propagation"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Propagation"}),": ",(0,s.jsx)(n.a,{href:"/api/type-aliases/MountPropagation",children:(0,s.jsx)(n.code,{children:"MountPropagation"})})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2402",children:"packages/extension-api/src/extension-api.d.ts:2402"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"consistency",children:"Consistency?"}),"\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:"Consistency"}),": ",(0,s.jsx)(n.a,{href:"/api/type-aliases/MountConsistency",children:(0,s.jsx)(n.code,{children:"MountConsistency"})})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2400",children:"packages/extension-api/src/extension-api.d.ts:2400"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"mode",children:"Mode?"}),"\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:"Mode"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-2",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2401",children:"packages/extension-api/src/extension-api.d.ts:2401"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"readonly",children:"ReadOnly?"}),"\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:"ReadOnly"}),": ",(0,s.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-3",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2399",children:"packages/extension-api/src/extension-api.d.ts:2399"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"source",children:"Source"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Source"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-4",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2397",children:"packages/extension-api/src/extension-api.d.ts:2397"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"target",children:"Target"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Target"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-5",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2396",children:"packages/extension-api/src/extension-api.d.ts:2396"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"tmpfsoptions",children:"TmpfsOptions?"}),"\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:"TmpfsOptions"}),": ",(0,s.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"mode-1",children:"Mode"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Mode"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"sizebytes",children:"SizeBytes"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"SizeBytes"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-6",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2413",children:"packages/extension-api/src/extension-api.d.ts:2413"})}),"\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.strong,{children:"Type"}),": ",(0,s.jsx)(n.a,{href:"/api/type-aliases/MountType",children:(0,s.jsx)(n.code,{children:"MountType"})})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-7",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2398",children:"packages/extension-api/src/extension-api.d.ts:2398"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"volumeoptions",children:"VolumeOptions?"}),"\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:"VolumeOptions"}),": ",(0,s.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"driverconfig",children:"DriverConfig"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"DriverConfig"}),": ",(0,s.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"driverconfigname",children:"DriverConfig.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:"driverconfigoptions",children:"DriverConfig.Options"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Options"}),": ",(0,s.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,s.jsx)(n.h5,{id:"index-signature",children:"Index Signature"}),"\n",(0,s.jsxs)(n.p,{children:["[",(0,s.jsx)(n.code,{children:"option"}),": ",(0,s.jsx)(n.code,{children:"string"}),"]: ",(0,s.jsx)(n.code,{children:"string"})]}),"\n",(0,s.jsx)(n.h4,{id:"labels",children:"Labels"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Labels"}),": ",(0,s.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,s.jsx)(n.h5,{id:"index-signature-1",children:"Index Signature"}),"\n",(0,s.jsxs)(n.p,{children:["[",(0,s.jsx)(n.code,{children:"label"}),": ",(0,s.jsx)(n.code,{children:"string"}),"]: ",(0,s.jsx)(n.code,{children:"string"})]}),"\n",(0,s.jsx)(n.h4,{id:"nocopy",children:"NoCopy"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"NoCopy"}),": ",(0,s.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-8",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2405",children:"packages/extension-api/src/extension-api.d.ts:2405"})})]})}function h(e={}){const{wrapper:n}={...(0,d.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(a,{...e})}):a(e)}},43023:(e,n,i)=>{i.d(n,{R:()=>t,x:()=>r});var s=i(63696);const d={},o=s.createContext(d);function t(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(d):e.components||d:t(e.components),s.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[13680],{657:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>c,contentTitle:()=>t,default:()=>h,frontMatter:()=>o,metadata:()=>r,toc:()=>l});var s=i(62540),d=i(43023);const o={},t="Interface: MountSettings",r={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"}},c={},l=[{value:"Properties",id:"properties",level:2},{value:"BindOptions?",id:"bindoptions",level:3},{value:"Propagation",id:"propagation",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"Consistency?",id:"consistency",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"Mode?",id:"mode",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"ReadOnly?",id:"readonly",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"Source",id:"source",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"Target",id:"target",level:3},{value:"Defined in",id:"defined-in-5",level:4},{value:"TmpfsOptions?",id:"tmpfsoptions",level:3},{value:"Mode",id:"mode-1",level:4},{value:"SizeBytes",id:"sizebytes",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"Type",id:"type",level:3},{value:"Defined in",id:"defined-in-7",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:"Defined in",id:"defined-in-8",level:4}];function a(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",h5:"h5",header:"header",hr:"hr",p:"p",strong:"strong",...(0,d.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.header,{children:(0,s.jsx)(n.h1,{id:"interface-mountsettings",children:"Interface: MountSettings"})}),"\n",(0,s.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,s.jsx)(n.h3,{id:"bindoptions",children:"BindOptions?"}),"\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:"BindOptions"}),": ",(0,s.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"propagation",children:"Propagation"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Propagation"}),": ",(0,s.jsx)(n.a,{href:"/api/type-aliases/MountPropagation",children:(0,s.jsx)(n.code,{children:"MountPropagation"})})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2402",children:"packages/extension-api/src/extension-api.d.ts:2402"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"consistency",children:"Consistency?"}),"\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:"Consistency"}),": ",(0,s.jsx)(n.a,{href:"/api/type-aliases/MountConsistency",children:(0,s.jsx)(n.code,{children:"MountConsistency"})})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2400",children:"packages/extension-api/src/extension-api.d.ts:2400"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"mode",children:"Mode?"}),"\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:"Mode"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-2",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2401",children:"packages/extension-api/src/extension-api.d.ts:2401"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"readonly",children:"ReadOnly?"}),"\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:"ReadOnly"}),": ",(0,s.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-3",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2399",children:"packages/extension-api/src/extension-api.d.ts:2399"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"source",children:"Source"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Source"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-4",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2397",children:"packages/extension-api/src/extension-api.d.ts:2397"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"target",children:"Target"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Target"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-5",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2396",children:"packages/extension-api/src/extension-api.d.ts:2396"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"tmpfsoptions",children:"TmpfsOptions?"}),"\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:"TmpfsOptions"}),": ",(0,s.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"mode-1",children:"Mode"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Mode"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"sizebytes",children:"SizeBytes"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"SizeBytes"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-6",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2413",children:"packages/extension-api/src/extension-api.d.ts:2413"})}),"\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.strong,{children:"Type"}),": ",(0,s.jsx)(n.a,{href:"/api/type-aliases/MountType",children:(0,s.jsx)(n.code,{children:"MountType"})})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-7",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2398",children:"packages/extension-api/src/extension-api.d.ts:2398"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"volumeoptions",children:"VolumeOptions?"}),"\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:"VolumeOptions"}),": ",(0,s.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"driverconfig",children:"DriverConfig"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"DriverConfig"}),": ",(0,s.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"driverconfigname",children:"DriverConfig.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:"driverconfigoptions",children:"DriverConfig.Options"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Options"}),": ",(0,s.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,s.jsx)(n.h5,{id:"index-signature",children:"Index Signature"}),"\n",(0,s.jsxs)(n.p,{children:["[",(0,s.jsx)(n.code,{children:"option"}),": ",(0,s.jsx)(n.code,{children:"string"}),"]: ",(0,s.jsx)(n.code,{children:"string"})]}),"\n",(0,s.jsx)(n.h4,{id:"labels",children:"Labels"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Labels"}),": ",(0,s.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,s.jsx)(n.h5,{id:"index-signature-1",children:"Index Signature"}),"\n",(0,s.jsxs)(n.p,{children:["[",(0,s.jsx)(n.code,{children:"label"}),": ",(0,s.jsx)(n.code,{children:"string"}),"]: ",(0,s.jsx)(n.code,{children:"string"})]}),"\n",(0,s.jsx)(n.h4,{id:"nocopy",children:"NoCopy"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"NoCopy"}),": ",(0,s.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-8",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2405",children:"packages/extension-api/src/extension-api.d.ts:2405"})})]})}function h(e={}){const{wrapper:n}={...(0,d.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(a,{...e})}):a(e)}},43023:(e,n,i)=>{i.d(n,{R:()=>t,x:()=>r});var s=i(63696);const d={},o=s.createContext(d);function t(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(d):e.components||d:t(e.components),s.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/9d2d4743.0d33466c.js b/assets/js/9d2d4743.9a3011dc.js similarity index 95% rename from assets/js/9d2d4743.0d33466c.js rename to assets/js/9d2d4743.9a3011dc.js index db036ee8396..111793011cd 100644 --- a/assets/js/9d2d4743.0d33466c.js +++ b/assets/js/9d2d4743.9a3011dc.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[64630],{79998:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>c,default:()=>l,frontMatter:()=>r,metadata:()=>s,toc:()=>d});var o=t(62540),i=t(43023);const r={},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:"Defined in",id:"defined-in",level:4}];function p(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",p:"p",strong:"strong",...(0,i.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(n.header,{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:"defined-in",children:"Defined in"}),"\n",(0,o.jsx)(n.p,{children:(0,o.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/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,i.R)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(p,{...e})}):p(e)}},43023:(e,n,t)=>{t.d(n,{R:()=>c,x:()=>s});var o=t(63696);const i={},r=o.createContext(i);function c(e){const n=o.useContext(r);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(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[64630],{79998:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>c,default:()=>l,frontMatter:()=>r,metadata:()=>s,toc:()=>d});var o=t(62540),i=t(43023);const r={},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:"Defined in",id:"defined-in",level:4}];function p(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",p:"p",strong:"strong",...(0,i.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(n.header,{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:"defined-in",children:"Defined in"}),"\n",(0,o.jsx)(n.p,{children:(0,o.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/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,i.R)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(p,{...e})}):p(e)}},43023:(e,n,t)=>{t.d(n,{R:()=>c,x:()=>s});var o=t(63696);const i={},r=o.createContext(i);function c(e){const n=o.useContext(r);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(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/9d887a11.13679168.js b/assets/js/9d887a11.ab5c69c6.js similarity index 98% rename from assets/js/9d887a11.13679168.js rename to assets/js/9d887a11.ab5c69c6.js index 859d107fd74..bae322bd9d0 100644 --- a/assets/js/9d887a11.13679168.js +++ b/assets/js/9d887a11.ab5c69c6.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[77350],{24445:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>o,contentTitle:()=>a,default:()=>p,frontMatter:()=>r,metadata:()=>c,toc:()=>d});var t=i(62540),s=i(43023);const r={},a="Function: createWebviewPanel()",c={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={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Defined in",id:"defined-in",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",strong:"strong",...(0,s.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.header,{children:(0,t.jsx)(n.h1,{id:"function-createwebviewpanel",children:"Function: createWebviewPanel()"})}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"createWebviewPanel"}),"(",(0,t.jsx)(n.code,{children:"viewType"}),", ",(0,t.jsx)(n.code,{children:"title"}),", ",(0,t.jsx)(n.code,{children:"options"}),"?): ",(0,t.jsx)(n.a,{href:"/api/interfaces/WebviewPanel",children:(0,t.jsx)(n.code,{children:"WebviewPanel"})})]}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"Create and show a new webview panel."}),"\n",(0,t.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"viewType"}),": ",(0,t.jsx)(n.code,{children:"string"})]}),"\n",(0,t.jsx)(n.p,{children:"Identifies the type of the webview panel."}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"title"}),": ",(0,t.jsx)(n.code,{children:"string"})]}),"\n",(0,t.jsx)(n.p,{children:"Title of the panel."}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"options?"}),": ",(0,t.jsx)(n.a,{href:"/api/interfaces/WebviewOptions",children:(0,t.jsx)(n.code,{children:"WebviewOptions"})})]}),"\n",(0,t.jsx)(n.p,{children:"Settings for the new panel."}),"\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/WebviewPanel",children:(0,t.jsx)(n.code,{children:"WebviewPanel"})})}),"\n",(0,t.jsx)(n.p,{children:"New webview panel."}),"\n",(0,t.jsx)(n.h2,{id:"defined-in",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2096",children:"packages/extension-api/src/extension-api.d.ts:2096"})})]})}function p(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},43023:(e,n,i)=>{i.d(n,{R:()=>a,x:()=>c});var t=i(63696);const s={},r=t.createContext(s);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(s):e.components||s:a(e.components),t.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[77350],{24445:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>o,contentTitle:()=>a,default:()=>p,frontMatter:()=>r,metadata:()=>c,toc:()=>d});var t=i(62540),s=i(43023);const r={},a="Function: createWebviewPanel()",c={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={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Defined in",id:"defined-in",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",strong:"strong",...(0,s.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.header,{children:(0,t.jsx)(n.h1,{id:"function-createwebviewpanel",children:"Function: createWebviewPanel()"})}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"createWebviewPanel"}),"(",(0,t.jsx)(n.code,{children:"viewType"}),", ",(0,t.jsx)(n.code,{children:"title"}),", ",(0,t.jsx)(n.code,{children:"options"}),"?): ",(0,t.jsx)(n.a,{href:"/api/interfaces/WebviewPanel",children:(0,t.jsx)(n.code,{children:"WebviewPanel"})})]}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"Create and show a new webview panel."}),"\n",(0,t.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"viewType"}),": ",(0,t.jsx)(n.code,{children:"string"})]}),"\n",(0,t.jsx)(n.p,{children:"Identifies the type of the webview panel."}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"title"}),": ",(0,t.jsx)(n.code,{children:"string"})]}),"\n",(0,t.jsx)(n.p,{children:"Title of the panel."}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"options?"}),": ",(0,t.jsx)(n.a,{href:"/api/interfaces/WebviewOptions",children:(0,t.jsx)(n.code,{children:"WebviewOptions"})})]}),"\n",(0,t.jsx)(n.p,{children:"Settings for the new panel."}),"\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/WebviewPanel",children:(0,t.jsx)(n.code,{children:"WebviewPanel"})})}),"\n",(0,t.jsx)(n.p,{children:"New webview panel."}),"\n",(0,t.jsx)(n.h2,{id:"defined-in",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2096",children:"packages/extension-api/src/extension-api.d.ts:2096"})})]})}function p(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},43023:(e,n,i)=>{i.d(n,{R:()=>a,x:()=>c});var t=i(63696);const s={},r=t.createContext(s);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(s):e.components||s:a(e.components),t.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/9db962b6.aff8fff5.js b/assets/js/9db962b6.508fe2ba.js similarity index 86% rename from assets/js/9db962b6.aff8fff5.js rename to assets/js/9db962b6.508fe2ba.js index d7976318710..d379a50c863 100644 --- a/assets/js/9db962b6.aff8fff5.js +++ b/assets/js/9db962b6.508fe2ba.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[21791],{91910:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>c,contentTitle:()=>o,default:()=>p,frontMatter:()=>r,metadata:()=>d,toc:()=>a});var i=s(62540),t=s(43023);const r={},o="Function: onDidUpdateKubernetesConnection()",d={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"}},c={},a=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Defined in",id:"defined-in",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",strong:"strong",...(0,t.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.header,{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:"defined-in",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L834",children:"packages/extension-api/src/extension-api.d.ts:834"})})]})}function p(e={}){const{wrapper:n}={...(0,t.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},43023:(e,n,s)=>{s.d(n,{R:()=>o,x:()=>d});var i=s(63696);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 d(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([[21791],{91910:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>d,contentTitle:()=>o,default:()=>p,frontMatter:()=>r,metadata:()=>c,toc:()=>a});var i=s(62540),t=s(43023);const r={},o="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"}},d={},a=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Defined in",id:"defined-in",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",strong:"strong",...(0,t.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.header,{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:"defined-in",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L834",children:"packages/extension-api/src/extension-api.d.ts:834"})})]})}function p(e={}){const{wrapper:n}={...(0,t.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},43023:(e,n,s)=>{s.d(n,{R:()=>o,x:()=>c});var i=s(63696);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/9dd60997.2a5fc285.js b/assets/js/9dd60997.f450c893.js similarity index 96% rename from assets/js/9dd60997.2a5fc285.js rename to assets/js/9dd60997.f450c893.js index bbae1a0073f..0b25a236b86 100644 --- a/assets/js/9dd60997.2a5fc285.js +++ b/assets/js/9dd60997.f450c893.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[15663],{22750:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>d,contentTitle:()=>r,default:()=>p,frontMatter:()=>o,metadata:()=>c,toc:()=>a});var i=s(62540),t=s(43023);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:"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:"Defined in",id:"defined-in",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:"Defined in",id:"defined-in-1",level:3}];function h(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",header:"header",p:"p",strong:"strong",...(0,t.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.header,{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:"defined-in",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L3915",children:"packages/extension-api/src/extension-api.d.ts:3915"})}),"\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:"defined-in-1",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L3934",children:"packages/extension-api/src/extension-api.d.ts:3934"})})]})}function p(e={}){const{wrapper:n}={...(0,t.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(h,{...e})}):h(e)}},43023:(e,n,s)=>{s.d(n,{R:()=>r,x:()=>c});var i=s(63696);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([[15663],{22750:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>d,contentTitle:()=>r,default:()=>p,frontMatter:()=>o,metadata:()=>c,toc:()=>a});var i=s(62540),t=s(43023);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:"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:"Defined in",id:"defined-in",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:"Defined in",id:"defined-in-1",level:3}];function h(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",header:"header",p:"p",strong:"strong",...(0,t.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.header,{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:"defined-in",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L3915",children:"packages/extension-api/src/extension-api.d.ts:3915"})}),"\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:"defined-in-1",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L3934",children:"packages/extension-api/src/extension-api.d.ts:3934"})})]})}function p(e={}){const{wrapper:n}={...(0,t.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(h,{...e})}):h(e)}},43023:(e,n,s)=>{s.d(n,{R:()=>r,x:()=>c});var i=s(63696);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.3e2dac4f.js b/assets/js/a08dfa31.9cd5025e.js similarity index 90% rename from assets/js/a08dfa31.3e2dac4f.js rename to assets/js/a08dfa31.9cd5025e.js index 1123030d5aa..8d1d152c049 100644 --- a/assets/js/a08dfa31.3e2dac4f.js +++ b/assets/js/a08dfa31.9cd5025e.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[9767],{68352:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>o,contentTitle:()=>t,default:()=>h,frontMatter:()=>r,metadata:()=>c,toc:()=>a});var s=i(62540),d=i(43023);const r={},t="Interface: ProviderOptions",c={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"}},o={},a=[{value:"Properties",id:"properties",level:2},{value:"detectionChecks?",id:"detectionchecks",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"emptyConnectionMarkdownDescription?",id:"emptyconnectionmarkdowndescription",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"id",id:"id",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"images?",id:"images",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"links?",id:"links",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"name",id:"name",level:3},{value:"Defined in",id:"defined-in-5",level:4},{value:"status",id:"status",level:3},{value:"Defined in",id:"defined-in-6",level:4},{value:"version?",id:"version",level:3},{value:"Defined in",id:"defined-in-7",level:4},{value:"warnings?",id:"warnings",level:3},{value:"Defined in",id:"defined-in-8",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",p:"p",strong:"strong",...(0,d.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.header,{children:(0,s.jsx)(n.h1,{id:"interface-provideroptions",children:"Interface: ProviderOptions"})}),"\n",(0,s.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,s.jsx)(n.h3,{id:"detectionchecks",children:"detectionChecks?"}),"\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:"detectionChecks"}),": ",(0,s.jsx)(n.a,{href:"/api/interfaces/ProviderDetectionCheck",children:(0,s.jsx)(n.code,{children:"ProviderDetectionCheck"})}),"[]"]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L318",children:"packages/extension-api/src/extension-api.d.ts:318"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"emptyconnectionmarkdowndescription",children:"emptyConnectionMarkdownDescription?"}),"\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:"emptyConnectionMarkdownDescription"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L324",children:"packages/extension-api/src/extension-api.d.ts:324"})}),"\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:"defined-in-2",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L312",children:"packages/extension-api/src/extension-api.d.ts:312"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"images",children:"images?"}),"\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:"images"}),": ",(0,s.jsx)(n.a,{href:"/api/interfaces/ProviderImages",children:(0,s.jsx)(n.code,{children:"ProviderImages"})})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-3",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L316",children:"packages/extension-api/src/extension-api.d.ts:316"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"links",children:"links?"}),"\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:"links"}),": ",(0,s.jsx)(n.a,{href:"/api/interfaces/Link",children:(0,s.jsx)(n.code,{children:"Link"})}),"[]"]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-4",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L317",children:"packages/extension-api/src/extension-api.d.ts:317"})}),"\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:"defined-in-5",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L313",children:"packages/extension-api/src/extension-api.d.ts:313"})}),"\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/ProviderStatus",children:(0,s.jsx)(n.code,{children:"ProviderStatus"})})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-6",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L314",children:"packages/extension-api/src/extension-api.d.ts:314"})}),"\n",(0,s.jsx)(n.hr,{}),"\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.code,{children:"optional"})," ",(0,s.jsx)(n.strong,{children:"version"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-7",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L315",children:"packages/extension-api/src/extension-api.d.ts:315"})}),"\n",(0,s.jsx)(n.hr,{}),"\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.code,{children:"optional"})," ",(0,s.jsx)(n.strong,{children:"warnings"}),": ",(0,s.jsx)(n.a,{href:"/api/interfaces/ProviderInformation",children:(0,s.jsx)(n.code,{children:"ProviderInformation"})}),"[]"]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-8",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/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,d.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},43023:(e,n,i)=>{i.d(n,{R:()=>t,x:()=>c});var s=i(63696);const d={},r=s.createContext(d);function t(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(d):e.components||d:t(e.components),s.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[9767],{68352:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>o,contentTitle:()=>t,default:()=>h,frontMatter:()=>r,metadata:()=>c,toc:()=>a});var s=i(62540),d=i(43023);const r={},t="Interface: ProviderOptions",c={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"}},o={},a=[{value:"Properties",id:"properties",level:2},{value:"detectionChecks?",id:"detectionchecks",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"emptyConnectionMarkdownDescription?",id:"emptyconnectionmarkdowndescription",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"id",id:"id",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"images?",id:"images",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"links?",id:"links",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"name",id:"name",level:3},{value:"Defined in",id:"defined-in-5",level:4},{value:"status",id:"status",level:3},{value:"Defined in",id:"defined-in-6",level:4},{value:"version?",id:"version",level:3},{value:"Defined in",id:"defined-in-7",level:4},{value:"warnings?",id:"warnings",level:3},{value:"Defined in",id:"defined-in-8",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",p:"p",strong:"strong",...(0,d.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.header,{children:(0,s.jsx)(n.h1,{id:"interface-provideroptions",children:"Interface: ProviderOptions"})}),"\n",(0,s.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,s.jsx)(n.h3,{id:"detectionchecks",children:"detectionChecks?"}),"\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:"detectionChecks"}),": ",(0,s.jsx)(n.a,{href:"/api/interfaces/ProviderDetectionCheck",children:(0,s.jsx)(n.code,{children:"ProviderDetectionCheck"})}),"[]"]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L318",children:"packages/extension-api/src/extension-api.d.ts:318"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"emptyconnectionmarkdowndescription",children:"emptyConnectionMarkdownDescription?"}),"\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:"emptyConnectionMarkdownDescription"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L324",children:"packages/extension-api/src/extension-api.d.ts:324"})}),"\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:"defined-in-2",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L312",children:"packages/extension-api/src/extension-api.d.ts:312"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"images",children:"images?"}),"\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:"images"}),": ",(0,s.jsx)(n.a,{href:"/api/interfaces/ProviderImages",children:(0,s.jsx)(n.code,{children:"ProviderImages"})})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-3",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L316",children:"packages/extension-api/src/extension-api.d.ts:316"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"links",children:"links?"}),"\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:"links"}),": ",(0,s.jsx)(n.a,{href:"/api/interfaces/Link",children:(0,s.jsx)(n.code,{children:"Link"})}),"[]"]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-4",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L317",children:"packages/extension-api/src/extension-api.d.ts:317"})}),"\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:"defined-in-5",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L313",children:"packages/extension-api/src/extension-api.d.ts:313"})}),"\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/ProviderStatus",children:(0,s.jsx)(n.code,{children:"ProviderStatus"})})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-6",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L314",children:"packages/extension-api/src/extension-api.d.ts:314"})}),"\n",(0,s.jsx)(n.hr,{}),"\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.code,{children:"optional"})," ",(0,s.jsx)(n.strong,{children:"version"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-7",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L315",children:"packages/extension-api/src/extension-api.d.ts:315"})}),"\n",(0,s.jsx)(n.hr,{}),"\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.code,{children:"optional"})," ",(0,s.jsx)(n.strong,{children:"warnings"}),": ",(0,s.jsx)(n.a,{href:"/api/interfaces/ProviderInformation",children:(0,s.jsx)(n.code,{children:"ProviderInformation"})}),"[]"]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-8",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/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,d.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},43023:(e,n,i)=>{i.d(n,{R:()=>t,x:()=>c});var s=i(63696);const d={},r=s.createContext(d);function t(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(d):e.components||d:t(e.components),s.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/a2c6f402.b2930b93.js b/assets/js/a2c6f402.e81a63b3.js similarity index 94% rename from assets/js/a2c6f402.b2930b93.js rename to assets/js/a2c6f402.e81a63b3.js index e463124fe10..8607f4ef934 100644 --- a/assets/js/a2c6f402.b2930b93.js +++ b/assets/js/a2c6f402.e81a63b3.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[33253],{86078:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>d,contentTitle:()=>o,default:()=>p,frontMatter:()=>r,metadata:()=>a,toc:()=>c});var t=i(62540),s=i(43023);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"}},d={},c=[{value:"Defined in",id:"defined-in",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",strong:"strong",...(0,s.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.header,{children:(0,t.jsx)(n.h1,{id:"type-alias-providerlinks",children:"Type Alias: ProviderLinks"})}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"ProviderLinks"}),": ",(0,t.jsx)(n.a,{href:"/api/interfaces/Link",children:(0,t.jsx)(n.code,{children:"Link"})})]}),"\n"]}),"\n",(0,t.jsx)(n.h2,{id:"defined-in",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L601",children:"packages/extension-api/src/extension-api.d.ts:601"})})]})}function p(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},43023:(e,n,i)=>{i.d(n,{R:()=>o,x:()=>a});var t=i(63696);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 a(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 +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[33253],{86078:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>d,contentTitle:()=>o,default:()=>p,frontMatter:()=>r,metadata:()=>a,toc:()=>c});var t=i(62540),s=i(43023);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"}},d={},c=[{value:"Defined in",id:"defined-in",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",strong:"strong",...(0,s.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.header,{children:(0,t.jsx)(n.h1,{id:"type-alias-providerlinks",children:"Type Alias: ProviderLinks"})}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"ProviderLinks"}),": ",(0,t.jsx)(n.a,{href:"/api/interfaces/Link",children:(0,t.jsx)(n.code,{children:"Link"})})]}),"\n"]}),"\n",(0,t.jsx)(n.h2,{id:"defined-in",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L601",children:"packages/extension-api/src/extension-api.d.ts:601"})})]})}function p(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},43023:(e,n,i)=>{i.d(n,{R:()=>o,x:()=>a});var t=i(63696);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 a(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/a2d1ff94.24f00837.js b/assets/js/a2d1ff94.db345a41.js similarity index 85% rename from assets/js/a2d1ff94.24f00837.js rename to assets/js/a2d1ff94.db345a41.js index 5e0e56204ee..134e63ccb78 100644 --- a/assets/js/a2d1ff94.24f00837.js +++ b/assets/js/a2d1ff94.db345a41.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[53588],{49567:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>c,contentTitle:()=>r,default:()=>p,frontMatter:()=>d,metadata:()=>o,toc:()=>a});var t=i(62540),s=i(43023);const d={},r="Interface: ContainerProviderConnection",o={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"}},c={},a=[{value:"Properties",id:"properties",level:2},{value:"endpoint",id:"endpoint",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"lifecycle?",id:"lifecycle",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"name",id:"name",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"type",id:"type",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"vmType?",id:"vmtype",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"Methods",id:"methods",level:2},{value:"status()",id:"status",level:3},{value:"Returns",id:"returns",level:4},{value:"Defined in",id:"defined-in-5",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",p:"p",strong:"strong",...(0,s.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.header,{children:(0,t.jsx)(n.h1,{id:"interface-containerproviderconnection",children:"Interface: ContainerProviderConnection"})}),"\n",(0,t.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,t.jsx)(n.h3,{id:"endpoint",children:"endpoint"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"endpoint"}),": ",(0,t.jsx)(n.a,{href:"/api/interfaces/ContainerProviderConnectionEndpoint",children:(0,t.jsx)(n.code,{children:"ContainerProviderConnectionEndpoint"})})]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L362",children:"packages/extension-api/src/extension-api.d.ts:362"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"lifecycle",children:"lifecycle?"}),"\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:"lifecycle"}),": ",(0,t.jsx)(n.a,{href:"/api/interfaces/ProviderConnectionLifecycle",children:(0,t.jsx)(n.code,{children:"ProviderConnectionLifecycle"})})]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L363",children:"packages/extension-api/src/extension-api.d.ts:363"})}),"\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:"defined-in-2",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L360",children:"packages/extension-api/src/extension-api.d.ts:360"})}),"\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:'"docker"'})," | ",(0,t.jsx)(n.code,{children:'"podman"'})]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"defined-in-3",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L361",children:"packages/extension-api/src/extension-api.d.ts:361"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"vmtype",children:"vmType?"}),"\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:"vmType"}),": ",(0,t.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"defined-in-4",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L365",children:"packages/extension-api/src/extension-api.d.ts:365"})}),"\n",(0,t.jsx)(n.h2,{id:"methods",children:"Methods"}),"\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/ProviderConnectionStatus",children:(0,t.jsx)(n.code,{children:"ProviderConnectionStatus"})})]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"returns",children:"Returns"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"/api/type-aliases/ProviderConnectionStatus",children:(0,t.jsx)(n.code,{children:"ProviderConnectionStatus"})})}),"\n",(0,t.jsx)(n.h4,{id:"defined-in-5",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/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,s.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},43023:(e,n,i)=>{i.d(n,{R:()=>r,x:()=>o});var t=i(63696);const s={},d=t.createContext(s);function r(e){const n=t.useContext(d);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(d.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[53588],{49567:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>c,contentTitle:()=>d,default:()=>p,frontMatter:()=>r,metadata:()=>o,toc:()=>a});var t=i(62540),s=i(43023);const r={},d="Interface: ContainerProviderConnection",o={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"}},c={},a=[{value:"Properties",id:"properties",level:2},{value:"endpoint",id:"endpoint",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"lifecycle?",id:"lifecycle",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"name",id:"name",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"type",id:"type",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"vmType?",id:"vmtype",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"Methods",id:"methods",level:2},{value:"status()",id:"status",level:3},{value:"Returns",id:"returns",level:4},{value:"Defined in",id:"defined-in-5",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",p:"p",strong:"strong",...(0,s.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.header,{children:(0,t.jsx)(n.h1,{id:"interface-containerproviderconnection",children:"Interface: ContainerProviderConnection"})}),"\n",(0,t.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,t.jsx)(n.h3,{id:"endpoint",children:"endpoint"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"endpoint"}),": ",(0,t.jsx)(n.a,{href:"/api/interfaces/ContainerProviderConnectionEndpoint",children:(0,t.jsx)(n.code,{children:"ContainerProviderConnectionEndpoint"})})]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L362",children:"packages/extension-api/src/extension-api.d.ts:362"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"lifecycle",children:"lifecycle?"}),"\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:"lifecycle"}),": ",(0,t.jsx)(n.a,{href:"/api/interfaces/ProviderConnectionLifecycle",children:(0,t.jsx)(n.code,{children:"ProviderConnectionLifecycle"})})]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L363",children:"packages/extension-api/src/extension-api.d.ts:363"})}),"\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:"defined-in-2",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L360",children:"packages/extension-api/src/extension-api.d.ts:360"})}),"\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:'"docker"'})," | ",(0,t.jsx)(n.code,{children:'"podman"'})]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"defined-in-3",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L361",children:"packages/extension-api/src/extension-api.d.ts:361"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"vmtype",children:"vmType?"}),"\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:"vmType"}),": ",(0,t.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"defined-in-4",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L365",children:"packages/extension-api/src/extension-api.d.ts:365"})}),"\n",(0,t.jsx)(n.h2,{id:"methods",children:"Methods"}),"\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/ProviderConnectionStatus",children:(0,t.jsx)(n.code,{children:"ProviderConnectionStatus"})})]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"returns",children:"Returns"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"/api/type-aliases/ProviderConnectionStatus",children:(0,t.jsx)(n.code,{children:"ProviderConnectionStatus"})})}),"\n",(0,t.jsx)(n.h4,{id:"defined-in-5",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/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,s.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},43023:(e,n,i)=>{i.d(n,{R:()=>d,x:()=>o});var t=i(63696);const s={},r=t.createContext(s);function d(e){const n=t.useContext(r);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:d(e.components),t.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/a2ffcc0f.e96db7f9.js b/assets/js/a2ffcc0f.2c4a92bc.js similarity index 98% rename from assets/js/a2ffcc0f.e96db7f9.js rename to assets/js/a2ffcc0f.2c4a92bc.js index e3e55697153..d334055a6ac 100644 --- a/assets/js/a2ffcc0f.e96db7f9.js +++ b/assets/js/a2ffcc0f.2c4a92bc.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[3962],{14962:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>c,contentTitle:()=>o,default:()=>p,frontMatter:()=>i,metadata:()=>a,toc:()=>d});var s=r(62540),t=r(43023);const i={},o="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={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Defined in",id:"defined-in",level:2}];function u(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",strong:"strong",...(0,t.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.header,{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:"defined-in",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2119",children:"packages/extension-api/src/extension-api.d.ts:2119"})})]})}function p(e={}){const{wrapper:n}={...(0,t.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(u,{...e})}):u(e)}},43023:(e,n,r)=>{r.d(n,{R:()=>o,x:()=>a});var s=r(63696);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 a(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:o(e.components),s.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[3962],{14962:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>c,contentTitle:()=>o,default:()=>p,frontMatter:()=>i,metadata:()=>a,toc:()=>d});var s=r(62540),t=r(43023);const i={},o="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={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Defined in",id:"defined-in",level:2}];function u(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",strong:"strong",...(0,t.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.header,{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:"defined-in",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2119",children:"packages/extension-api/src/extension-api.d.ts:2119"})})]})}function p(e={}){const{wrapper:n}={...(0,t.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(u,{...e})}):u(e)}},43023:(e,n,r)=>{r.d(n,{R:()=>o,x:()=>a});var s=r(63696);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 a(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/a3002291.12c231bf.js b/assets/js/a3002291.e3862cf4.js similarity index 96% rename from assets/js/a3002291.12c231bf.js rename to assets/js/a3002291.e3862cf4.js index 4e7c25907fe..8ec030a6d30 100644 --- a/assets/js/a3002291.12c231bf.js +++ b/assets/js/a3002291.e3862cf4.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[3085],{79779:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>s,default:()=>p,frontMatter:()=>o,metadata:()=>c,toc:()=>d});var r=t(62540),i=t(43023);const o={},s="Function: createNetwork()",c={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:"Defined in",id:"defined-in",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",strong:"strong",...(0,i.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.header,{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:"defined-in",children:"Defined in"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L3671",children:"packages/extension-api/src/extension-api.d.ts:3671"})})]})}function p(e={}){const{wrapper:n}={...(0,i.R)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(l,{...e})}):l(e)}},43023:(e,n,t)=>{t.d(n,{R:()=>s,x:()=>c});var r=t(63696);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([[3085],{79779:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>s,default:()=>p,frontMatter:()=>o,metadata:()=>c,toc:()=>d});var r=t(62540),i=t(43023);const o={},s="Function: createNetwork()",c={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:"Defined in",id:"defined-in",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",strong:"strong",...(0,i.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.header,{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:"defined-in",children:"Defined in"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L3671",children:"packages/extension-api/src/extension-api.d.ts:3671"})})]})}function p(e={}){const{wrapper:n}={...(0,i.R)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(l,{...e})}):l(e)}},43023:(e,n,t)=>{t.d(n,{R:()=>s,x:()=>c});var r=t(63696);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/a30c0d44.abda08c2.js b/assets/js/a30c0d44.973e23d1.js similarity index 90% rename from assets/js/a30c0d44.abda08c2.js rename to assets/js/a30c0d44.973e23d1.js index a0dc2895347..e51083a0766 100644 --- a/assets/js/a30c0d44.abda08c2.js +++ b/assets/js/a30c0d44.973e23d1.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[73800],{32464:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>a,contentTitle:()=>o,default:()=>h,frontMatter:()=>t,metadata:()=>r,toc:()=>l});var s=i(62540),d=i(43023);const t={},o="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"}},a={},l=[{value:"Properties",id:"properties",level:2},{value:"ignoreFocusOut?",id:"ignorefocusout",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"markdownDescription?",id:"markdowndescription",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"multiline?",id:"multiline",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"password?",id:"password",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"placeHolder?",id:"placeholder",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"prompt?",id:"prompt",level:3},{value:"Defined in",id:"defined-in-5",level:4},{value:"title?",id:"title",level:3},{value:"Defined in",id:"defined-in-6",level:4},{value:"value?",id:"value",level:3},{value:"Defined in",id:"defined-in-7",level:4},{value:"valueSelection?",id:"valueselection",level:3},{value:"Defined in",id:"defined-in-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:"Defined in",id:"defined-in-9",level:4}];function c(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",p:"p",strong:"strong",...(0,d.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.header,{children:(0,s.jsx)(n.h1,{id:"interface-inputboxoptions",children:"Interface: InputBoxOptions"})}),"\n",(0,s.jsx)(n.p,{children:"Options to configure the behavior of the input box UI."}),"\n",(0,s.jsx)(n.h2,{id:"properties",children:"Properties"}),"\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 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,s.jsx)(n.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L1181",children:"packages/extension-api/src/extension-api.d.ts:1181"})}),"\n",(0,s.jsx)(n.hr,{}),"\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:"A description of the field to be show (Markdown format)"}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L1165",children:"packages/extension-api/src/extension-api.d.ts:1165"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"multiline",children:"multiline?"}),"\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:"multiline"}),": ",(0,s.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:["Set to ",(0,s.jsx)(n.code,{children:"true"})," when value represents a multi line content."]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-2",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L1186",children:"packages/extension-api/src/extension-api.d.ts:1186"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"password",children:"password?"}),"\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:"password"}),": ",(0,s.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Controls if a password input is shown. Password input hides the typed text."}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-3",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L1175",children:"packages/extension-api/src/extension-api.d.ts:1175"})}),"\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 type."}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-4",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L1170",children:"packages/extension-api/src/extension-api.d.ts:1170"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"prompt",children:"prompt?"}),"\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:"prompt"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The text to display underneath the input box."}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-5",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L1160",children:"packages/extension-api/src/extension-api.d.ts:1160"})}),"\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 input box."}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-6",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L1142",children:"packages/extension-api/src/extension-api.d.ts:1142"})}),"\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.code,{children:"optional"})," ",(0,s.jsx)(n.strong,{children:"value"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The value to pre-fill in the input box."}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-7",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L1147",children:"packages/extension-api/src/extension-api.d.ts:1147"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"valueselection",children:"valueSelection?"}),"\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:"valueSelection"}),": [",(0,s.jsx)(n.code,{children:"number"}),", ",(0,s.jsx)(n.code,{children:"number"}),"]"]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:["Selection of the pre-filled ",(0,s.jsx)(n.a,{href:"/api/interfaces/InputBoxOptions#value",children:(0,s.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,s.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,s.jsx)(n.h4,{id:"defined-in-8",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L1155",children:"packages/extension-api/src/extension-api.d.ts:1155"})}),"\n",(0,s.jsx)(n.h2,{id:"methods",children:"Methods"}),"\n",(0,s.jsx)(n.h3,{id:"validateinput",children:"validateInput()?"}),"\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:"validateInput"}),"(",(0,s.jsx)(n.code,{children:"value"}),"): ",(0,s.jsx)(n.code,{children:"undefined"})," | ",(0,s.jsx)(n.code,{children:"null"})," | ",(0,s.jsx)(n.code,{children:"string"})," | ",(0,s.jsx)(n.a,{href:"/api/interfaces/InputBoxValidationMessage",children:(0,s.jsx)(n.code,{children:"InputBoxValidationMessage"})})," | ",(0,s.jsx)(n.code,{children:"Promise"}),"<",(0,s.jsx)(n.code,{children:"undefined"})," | ",(0,s.jsx)(n.code,{children:"null"})," | ",(0,s.jsx)(n.code,{children:"string"})," | ",(0,s.jsx)(n.a,{href:"/api/interfaces/InputBoxValidationMessage",children:(0,s.jsx)(n.code,{children:"InputBoxValidationMessage"})}),">"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"An optional function that will be called to validate input and to give a hint\nto the user."}),"\n",(0,s.jsx)(n.h4,{id:"parameters",children:"Parameters"}),"\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 current value of the input box."}),"\n",(0,s.jsx)(n.h4,{id:"returns",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"undefined"})," | ",(0,s.jsx)(n.code,{children:"null"})," | ",(0,s.jsx)(n.code,{children:"string"})," | ",(0,s.jsx)(n.a,{href:"/api/interfaces/InputBoxValidationMessage",children:(0,s.jsx)(n.code,{children:"InputBoxValidationMessage"})})," | ",(0,s.jsx)(n.code,{children:"Promise"}),"<",(0,s.jsx)(n.code,{children:"undefined"})," | ",(0,s.jsx)(n.code,{children:"null"})," | ",(0,s.jsx)(n.code,{children:"string"})," | ",(0,s.jsx)(n.a,{href:"/api/interfaces/InputBoxValidationMessage",children:(0,s.jsx)(n.code,{children:"InputBoxValidationMessage"})}),">"]}),"\n",(0,s.jsxs)(n.p,{children:["Either a human-readable string which is presented as an error message or an ",(0,s.jsx)(n.a,{href:"/api/interfaces/InputBoxValidationMessage",children:"InputBoxValidationMessage"}),"\nwhich can provide a specific message severity. Return ",(0,s.jsx)(n.code,{children:"undefined"}),", ",(0,s.jsx)(n.code,{children:"null"}),", or the empty string when 'value' is valid."]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-9",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L1196",children:"packages/extension-api/src/extension-api.d.ts:1196"})})]})}function h(e={}){const{wrapper:n}={...(0,d.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(c,{...e})}):c(e)}},43023:(e,n,i)=>{i.d(n,{R:()=>o,x:()=>r});var s=i(63696);const d={},t=s.createContext(d);function o(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(d):e.components||d:o(e.components),s.createElement(t.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[73800],{32464:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>a,contentTitle:()=>o,default:()=>h,frontMatter:()=>t,metadata:()=>r,toc:()=>l});var s=i(62540),d=i(43023);const t={},o="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"}},a={},l=[{value:"Properties",id:"properties",level:2},{value:"ignoreFocusOut?",id:"ignorefocusout",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"markdownDescription?",id:"markdowndescription",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"multiline?",id:"multiline",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"password?",id:"password",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"placeHolder?",id:"placeholder",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"prompt?",id:"prompt",level:3},{value:"Defined in",id:"defined-in-5",level:4},{value:"title?",id:"title",level:3},{value:"Defined in",id:"defined-in-6",level:4},{value:"value?",id:"value",level:3},{value:"Defined in",id:"defined-in-7",level:4},{value:"valueSelection?",id:"valueselection",level:3},{value:"Defined in",id:"defined-in-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:"Defined in",id:"defined-in-9",level:4}];function c(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",p:"p",strong:"strong",...(0,d.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.header,{children:(0,s.jsx)(n.h1,{id:"interface-inputboxoptions",children:"Interface: InputBoxOptions"})}),"\n",(0,s.jsx)(n.p,{children:"Options to configure the behavior of the input box UI."}),"\n",(0,s.jsx)(n.h2,{id:"properties",children:"Properties"}),"\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 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,s.jsx)(n.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L1181",children:"packages/extension-api/src/extension-api.d.ts:1181"})}),"\n",(0,s.jsx)(n.hr,{}),"\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:"A description of the field to be show (Markdown format)"}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L1165",children:"packages/extension-api/src/extension-api.d.ts:1165"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"multiline",children:"multiline?"}),"\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:"multiline"}),": ",(0,s.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:["Set to ",(0,s.jsx)(n.code,{children:"true"})," when value represents a multi line content."]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-2",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L1186",children:"packages/extension-api/src/extension-api.d.ts:1186"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"password",children:"password?"}),"\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:"password"}),": ",(0,s.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Controls if a password input is shown. Password input hides the typed text."}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-3",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L1175",children:"packages/extension-api/src/extension-api.d.ts:1175"})}),"\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 type."}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-4",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L1170",children:"packages/extension-api/src/extension-api.d.ts:1170"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"prompt",children:"prompt?"}),"\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:"prompt"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The text to display underneath the input box."}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-5",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L1160",children:"packages/extension-api/src/extension-api.d.ts:1160"})}),"\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 input box."}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-6",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L1142",children:"packages/extension-api/src/extension-api.d.ts:1142"})}),"\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.code,{children:"optional"})," ",(0,s.jsx)(n.strong,{children:"value"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The value to pre-fill in the input box."}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-7",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L1147",children:"packages/extension-api/src/extension-api.d.ts:1147"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"valueselection",children:"valueSelection?"}),"\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:"valueSelection"}),": [",(0,s.jsx)(n.code,{children:"number"}),", ",(0,s.jsx)(n.code,{children:"number"}),"]"]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:["Selection of the pre-filled ",(0,s.jsx)(n.a,{href:"/api/interfaces/InputBoxOptions#value",children:(0,s.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,s.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,s.jsx)(n.h4,{id:"defined-in-8",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L1155",children:"packages/extension-api/src/extension-api.d.ts:1155"})}),"\n",(0,s.jsx)(n.h2,{id:"methods",children:"Methods"}),"\n",(0,s.jsx)(n.h3,{id:"validateinput",children:"validateInput()?"}),"\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:"validateInput"}),"(",(0,s.jsx)(n.code,{children:"value"}),"): ",(0,s.jsx)(n.code,{children:"undefined"})," | ",(0,s.jsx)(n.code,{children:"null"})," | ",(0,s.jsx)(n.code,{children:"string"})," | ",(0,s.jsx)(n.a,{href:"/api/interfaces/InputBoxValidationMessage",children:(0,s.jsx)(n.code,{children:"InputBoxValidationMessage"})})," | ",(0,s.jsx)(n.code,{children:"Promise"}),"<",(0,s.jsx)(n.code,{children:"undefined"})," | ",(0,s.jsx)(n.code,{children:"null"})," | ",(0,s.jsx)(n.code,{children:"string"})," | ",(0,s.jsx)(n.a,{href:"/api/interfaces/InputBoxValidationMessage",children:(0,s.jsx)(n.code,{children:"InputBoxValidationMessage"})}),">"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"An optional function that will be called to validate input and to give a hint\nto the user."}),"\n",(0,s.jsx)(n.h4,{id:"parameters",children:"Parameters"}),"\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 current value of the input box."}),"\n",(0,s.jsx)(n.h4,{id:"returns",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"undefined"})," | ",(0,s.jsx)(n.code,{children:"null"})," | ",(0,s.jsx)(n.code,{children:"string"})," | ",(0,s.jsx)(n.a,{href:"/api/interfaces/InputBoxValidationMessage",children:(0,s.jsx)(n.code,{children:"InputBoxValidationMessage"})})," | ",(0,s.jsx)(n.code,{children:"Promise"}),"<",(0,s.jsx)(n.code,{children:"undefined"})," | ",(0,s.jsx)(n.code,{children:"null"})," | ",(0,s.jsx)(n.code,{children:"string"})," | ",(0,s.jsx)(n.a,{href:"/api/interfaces/InputBoxValidationMessage",children:(0,s.jsx)(n.code,{children:"InputBoxValidationMessage"})}),">"]}),"\n",(0,s.jsxs)(n.p,{children:["Either a human-readable string which is presented as an error message or an ",(0,s.jsx)(n.a,{href:"/api/interfaces/InputBoxValidationMessage",children:"InputBoxValidationMessage"}),"\nwhich can provide a specific message severity. Return ",(0,s.jsx)(n.code,{children:"undefined"}),", ",(0,s.jsx)(n.code,{children:"null"}),", or the empty string when 'value' is valid."]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-9",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L1196",children:"packages/extension-api/src/extension-api.d.ts:1196"})})]})}function h(e={}){const{wrapper:n}={...(0,d.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(c,{...e})}):c(e)}},43023:(e,n,i)=>{i.d(n,{R:()=>o,x:()=>r});var s=i(63696);const d={},t=s.createContext(d);function o(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(d):e.components||d:o(e.components),s.createElement(t.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/a334b453.326e36a5.js b/assets/js/a334b453.99a42045.js similarity index 90% rename from assets/js/a334b453.326e36a5.js rename to assets/js/a334b453.99a42045.js index fc1fe57b836..d61fcade083 100644 --- a/assets/js/a334b453.326e36a5.js +++ b/assets/js/a334b453.99a42045.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[13920],{44165:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>s,default:()=>l,frontMatter:()=>o,metadata:()=>c,toc:()=>d});var i=t(62540),r=t(43023);const o={},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:"Defined in",id:"defined-in",level:4},{value:"providerId",id:"providerid",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"status",id:"status",level:3},{value:"Defined in",id:"defined-in-2",level:4}];function p(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",p:"p",strong:"strong",...(0,r.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.header,{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:"defined-in",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L698",children:"packages/extension-api/src/extension-api.d.ts:698"})}),"\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:"defined-in-1",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L697",children:"packages/extension-api/src/extension-api.d.ts:697"})}),"\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:"defined-in-2",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L699",children:"packages/extension-api/src/extension-api.d.ts:699"})})]})}function l(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(p,{...e})}):p(e)}},43023:(e,n,t)=>{t.d(n,{R:()=>s,x:()=>c});var i=t(63696);const r={},o=i.createContext(r);function s(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:s(e.components),i.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[13920],{44165:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>s,default:()=>l,frontMatter:()=>o,metadata:()=>c,toc:()=>d});var i=t(62540),r=t(43023);const o={},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:"Defined in",id:"defined-in",level:4},{value:"providerId",id:"providerid",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"status",id:"status",level:3},{value:"Defined in",id:"defined-in-2",level:4}];function p(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",p:"p",strong:"strong",...(0,r.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.header,{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:"defined-in",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L698",children:"packages/extension-api/src/extension-api.d.ts:698"})}),"\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:"defined-in-1",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L697",children:"packages/extension-api/src/extension-api.d.ts:697"})}),"\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:"defined-in-2",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L699",children:"packages/extension-api/src/extension-api.d.ts:699"})})]})}function l(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(p,{...e})}):p(e)}},43023:(e,n,t)=>{t.d(n,{R:()=>s,x:()=>c});var i=t(63696);const r={},o=i.createContext(r);function s(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:s(e.components),i.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/a38d285e.5156b511.js b/assets/js/a38d285e.e7a5c865.js similarity index 96% rename from assets/js/a38d285e.5156b511.js rename to assets/js/a38d285e.e7a5c865.js index 743d5d5a4a4..23fd88be848 100644 --- a/assets/js/a38d285e.5156b511.js +++ b/assets/js/a38d285e.e7a5c865.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[55807],{10637:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>a,contentTitle:()=>s,default:()=>l,frontMatter:()=>o,metadata:()=>c,toc:()=>d});var t=i(62540),r=i(43023);const o={},s="Interface: RegisterContainerConnectionEvent",c={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:"Defined in",id:"defined-in",level:4},{value:"providerId",id:"providerid",level:3},{value:"Defined in",id:"defined-in-1",level:4}];function p(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",p:"p",strong:"strong",...(0,r.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.header,{children:(0,t.jsx)(n.h1,{id:"interface-registercontainerconnectionevent",children:"Interface: RegisterContainerConnectionEvent"})}),"\n",(0,t.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,t.jsx)(n.h3,{id:"connection",children:"connection"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"connection"}),": ",(0,t.jsx)(n.a,{href:"/api/interfaces/ContainerProviderConnection",children:(0,t.jsx)(n.code,{children:"ContainerProviderConnection"})})]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L719",children:"packages/extension-api/src/extension-api.d.ts:719"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"providerid",children:"providerId"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"providerId"}),": ",(0,t.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L718",children:"packages/extension-api/src/extension-api.d.ts:718"})})]})}function l(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(p,{...e})}):p(e)}},43023:(e,n,i)=>{i.d(n,{R:()=>s,x:()=>c});var t=i(63696);const r={},o=t.createContext(r);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(r):e.components||r:s(e.components),t.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[55807],{10637:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>a,contentTitle:()=>s,default:()=>l,frontMatter:()=>o,metadata:()=>c,toc:()=>d});var t=i(62540),r=i(43023);const o={},s="Interface: RegisterContainerConnectionEvent",c={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:"Defined in",id:"defined-in",level:4},{value:"providerId",id:"providerid",level:3},{value:"Defined in",id:"defined-in-1",level:4}];function p(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",p:"p",strong:"strong",...(0,r.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.header,{children:(0,t.jsx)(n.h1,{id:"interface-registercontainerconnectionevent",children:"Interface: RegisterContainerConnectionEvent"})}),"\n",(0,t.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,t.jsx)(n.h3,{id:"connection",children:"connection"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"connection"}),": ",(0,t.jsx)(n.a,{href:"/api/interfaces/ContainerProviderConnection",children:(0,t.jsx)(n.code,{children:"ContainerProviderConnection"})})]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L719",children:"packages/extension-api/src/extension-api.d.ts:719"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"providerid",children:"providerId"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"providerId"}),": ",(0,t.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L718",children:"packages/extension-api/src/extension-api.d.ts:718"})})]})}function l(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(p,{...e})}):p(e)}},43023:(e,n,i)=>{i.d(n,{R:()=>s,x:()=>c});var t=i(63696);const r={},o=t.createContext(r);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(r):e.components||r:s(e.components),t.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/a3f8794a.3b27b039.js b/assets/js/a3f8794a.0ec1d893.js similarity index 96% rename from assets/js/a3f8794a.3b27b039.js rename to assets/js/a3f8794a.0ec1d893.js index 0258cf98a92..3cdd6bbd9e2 100644 --- a/assets/js/a3f8794a.3b27b039.js +++ b/assets/js/a3f8794a.0ec1d893.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[36104],{9318:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>o,contentTitle:()=>s,default:()=>h,frontMatter:()=>a,metadata:()=>c,toc:()=>d});var i=t(62540),r=t(43023);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:"Defined in",id:"defined-in",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",strong:"strong",...(0,r.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.header,{children:(0,i.jsx)(n.h1,{id:"function-createcontainer",children:"Function: createContainer()"})}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"createContainer"}),"(",(0,i.jsx)(n.code,{children:"engineId"}),", ",(0,i.jsx)(n.code,{children:"containerCreateOptions"}),"): ",(0,i.jsx)(n.code,{children:"Promise"}),"<",(0,i.jsx)(n.a,{href:"/api/interfaces/ContainerCreateResult",children:(0,i.jsx)(n.code,{children:"ContainerCreateResult"})}),">"]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Create a new container on a specific container 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 on which to create 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:"containerCreateOptions"}),": ",(0,i.jsx)(n.a,{href:"/api/interfaces/ContainerCreateOptions",children:(0,i.jsx)(n.code,{children:"ContainerCreateOptions"})})]}),"\n",(0,i.jsx)(n.p,{children:"the details of the container to create"}),"\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/ContainerCreateResult",children:(0,i.jsx)(n.code,{children:"ContainerCreateResult"})}),">"]}),"\n",(0,i.jsx)(n.p,{children:"A promise resolving to the information on the created container"}),"\n",(0,i.jsx)(n.h2,{id:"defined-in",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L3481",children:"packages/extension-api/src/extension-api.d.ts:3481"})})]})}function h(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},43023:(e,n,t)=>{t.d(n,{R:()=>s,x:()=>c});var i=t(63696);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([[36104],{9318:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>o,contentTitle:()=>s,default:()=>h,frontMatter:()=>a,metadata:()=>c,toc:()=>d});var i=t(62540),r=t(43023);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:"Defined in",id:"defined-in",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",strong:"strong",...(0,r.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.header,{children:(0,i.jsx)(n.h1,{id:"function-createcontainer",children:"Function: createContainer()"})}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"createContainer"}),"(",(0,i.jsx)(n.code,{children:"engineId"}),", ",(0,i.jsx)(n.code,{children:"containerCreateOptions"}),"): ",(0,i.jsx)(n.code,{children:"Promise"}),"<",(0,i.jsx)(n.a,{href:"/api/interfaces/ContainerCreateResult",children:(0,i.jsx)(n.code,{children:"ContainerCreateResult"})}),">"]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Create a new container on a specific container 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 on which to create 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:"containerCreateOptions"}),": ",(0,i.jsx)(n.a,{href:"/api/interfaces/ContainerCreateOptions",children:(0,i.jsx)(n.code,{children:"ContainerCreateOptions"})})]}),"\n",(0,i.jsx)(n.p,{children:"the details of the container to create"}),"\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/ContainerCreateResult",children:(0,i.jsx)(n.code,{children:"ContainerCreateResult"})}),">"]}),"\n",(0,i.jsx)(n.p,{children:"A promise resolving to the information on the created container"}),"\n",(0,i.jsx)(n.h2,{id:"defined-in",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L3481",children:"packages/extension-api/src/extension-api.d.ts:3481"})})]})}function h(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},43023:(e,n,t)=>{t.d(n,{R:()=>s,x:()=>c});var i=t(63696);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 diff --git a/assets/js/a4794f2e.98169571.js b/assets/js/a4794f2e.155017b2.js similarity index 97% rename from assets/js/a4794f2e.98169571.js rename to assets/js/a4794f2e.155017b2.js index 8a78470995a..4eb552de211 100644 --- a/assets/js/a4794f2e.98169571.js +++ b/assets/js/a4794f2e.155017b2.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[28757],{73840:(e,r,s)=>{s.r(r),s.d(r,{assets:()=>a,contentTitle:()=>o,default:()=>p,frontMatter:()=>t,metadata:()=>c,toc:()=>d});var i=s(62540),n=s(43023);const t={},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:"Defined in",id:"defined-in",level:2}];function l(e){const r={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",strong:"strong",...(0,n.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(r.header,{children:(0,i.jsx)(r.h1,{id:"function-registerregistryprovider",children:"Function: registerRegistryProvider()"})}),"\n",(0,i.jsxs)(r.blockquote,{children:["\n",(0,i.jsxs)(r.p,{children:[(0,i.jsx)(r.strong,{children:"registerRegistryProvider"}),"(",(0,i.jsx)(r.code,{children:"registryProvider"}),"): ",(0,i.jsx)(r.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(r.code,{children:"Disposable"})})]}),"\n"]}),"\n",(0,i.jsx)(r.h2,{id:"parameters",children:"Parameters"}),"\n",(0,i.jsxs)(r.p,{children:["\u2022 ",(0,i.jsx)(r.strong,{children:"registryProvider"}),": ",(0,i.jsx)(r.a,{href:"/api/interfaces/RegistryProvider",children:(0,i.jsx)(r.code,{children:"RegistryProvider"})})]}),"\n",(0,i.jsx)(r.h2,{id:"returns",children:"Returns"}),"\n",(0,i.jsx)(r.p,{children:(0,i.jsx)(r.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(r.code,{children:"Disposable"})})}),"\n",(0,i.jsx)(r.h2,{id:"defined-in",children:"Defined in"}),"\n",(0,i.jsx)(r.p,{children:(0,i.jsx)(r.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L920",children:"packages/extension-api/src/extension-api.d.ts:920"})})]})}function p(e={}){const{wrapper:r}={...(0,n.R)(),...e.components};return r?(0,i.jsx)(r,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},43023:(e,r,s)=>{s.d(r,{R:()=>o,x:()=>c});var i=s(63696);const n={},t=i.createContext(n);function o(e){const r=i.useContext(t);return i.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(n):e.components||n:o(e.components),i.createElement(t.Provider,{value:r},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[28757],{73840:(e,r,s)=>{s.r(r),s.d(r,{assets:()=>a,contentTitle:()=>o,default:()=>p,frontMatter:()=>t,metadata:()=>c,toc:()=>d});var i=s(62540),n=s(43023);const t={},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:"Defined in",id:"defined-in",level:2}];function l(e){const r={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",strong:"strong",...(0,n.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(r.header,{children:(0,i.jsx)(r.h1,{id:"function-registerregistryprovider",children:"Function: registerRegistryProvider()"})}),"\n",(0,i.jsxs)(r.blockquote,{children:["\n",(0,i.jsxs)(r.p,{children:[(0,i.jsx)(r.strong,{children:"registerRegistryProvider"}),"(",(0,i.jsx)(r.code,{children:"registryProvider"}),"): ",(0,i.jsx)(r.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(r.code,{children:"Disposable"})})]}),"\n"]}),"\n",(0,i.jsx)(r.h2,{id:"parameters",children:"Parameters"}),"\n",(0,i.jsxs)(r.p,{children:["\u2022 ",(0,i.jsx)(r.strong,{children:"registryProvider"}),": ",(0,i.jsx)(r.a,{href:"/api/interfaces/RegistryProvider",children:(0,i.jsx)(r.code,{children:"RegistryProvider"})})]}),"\n",(0,i.jsx)(r.h2,{id:"returns",children:"Returns"}),"\n",(0,i.jsx)(r.p,{children:(0,i.jsx)(r.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(r.code,{children:"Disposable"})})}),"\n",(0,i.jsx)(r.h2,{id:"defined-in",children:"Defined in"}),"\n",(0,i.jsx)(r.p,{children:(0,i.jsx)(r.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L920",children:"packages/extension-api/src/extension-api.d.ts:920"})})]})}function p(e={}){const{wrapper:r}={...(0,n.R)(),...e.components};return r?(0,i.jsx)(r,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},43023:(e,r,s)=>{s.d(r,{R:()=>o,x:()=>c});var i=s(63696);const n={},t=i.createContext(n);function o(e){const r=i.useContext(t);return i.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(n):e.components||n:o(e.components),i.createElement(t.Provider,{value:r},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/a9fa5b1f.4f6009ae.js b/assets/js/a9fa5b1f.338403da.js similarity index 96% rename from assets/js/a9fa5b1f.4f6009ae.js rename to assets/js/a9fa5b1f.338403da.js index 3600d5c09d6..22ea9c75bc7 100644 --- a/assets/js/a9fa5b1f.4f6009ae.js +++ b/assets/js/a9fa5b1f.338403da.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[11022],{20740:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>d,contentTitle:()=>o,default:()=>p,frontMatter:()=>s,metadata:()=>c,toc:()=>a});var r=i(62540),t=i(43023);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"}},d={},a=[{value:"Properties",id:"properties",level:2},{value:"name",id:"name",level:3},{value:"Defined in",id:"defined-in",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:"Defined in",id:"defined-in-1",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",p:"p",strong:"strong",...(0,t.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.header,{children:(0,r.jsx)(n.h1,{id:"interface-providercleanupaction",children:"Interface: ProviderCleanupAction"})}),"\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:"defined-in",children:"Defined in"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L596",children:"packages/extension-api/src/extension-api.d.ts:596"})}),"\n",(0,r.jsx)(n.h2,{id:"methods",children:"Methods"}),"\n",(0,r.jsx)(n.h3,{id:"execute",children:"execute()"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"execute"}),"(",(0,r.jsx)(n.code,{children:"options"}),"): ",(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:"options"}),": ",(0,r.jsx)(n.a,{href:"/api/interfaces/ProviderCleanupExecuteOptions",children:(0,r.jsx)(n.code,{children:"ProviderCleanupExecuteOptions"})})]}),"\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:"defined-in-1",children:"Defined in"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L598",children:"packages/extension-api/src/extension-api.d.ts:598"})})]})}function p(e={}){const{wrapper:n}={...(0,t.R)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(l,{...e})}):l(e)}},43023:(e,n,i)=>{i.d(n,{R:()=>o,x:()=>c});var r=i(63696);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 c(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([[11022],{20740:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>d,contentTitle:()=>o,default:()=>p,frontMatter:()=>s,metadata:()=>c,toc:()=>a});var r=i(62540),t=i(43023);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"}},d={},a=[{value:"Properties",id:"properties",level:2},{value:"name",id:"name",level:3},{value:"Defined in",id:"defined-in",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:"Defined in",id:"defined-in-1",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",p:"p",strong:"strong",...(0,t.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.header,{children:(0,r.jsx)(n.h1,{id:"interface-providercleanupaction",children:"Interface: ProviderCleanupAction"})}),"\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:"defined-in",children:"Defined in"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L596",children:"packages/extension-api/src/extension-api.d.ts:596"})}),"\n",(0,r.jsx)(n.h2,{id:"methods",children:"Methods"}),"\n",(0,r.jsx)(n.h3,{id:"execute",children:"execute()"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"execute"}),"(",(0,r.jsx)(n.code,{children:"options"}),"): ",(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:"options"}),": ",(0,r.jsx)(n.a,{href:"/api/interfaces/ProviderCleanupExecuteOptions",children:(0,r.jsx)(n.code,{children:"ProviderCleanupExecuteOptions"})})]}),"\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:"defined-in-1",children:"Defined in"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L598",children:"packages/extension-api/src/extension-api.d.ts:598"})})]})}function p(e={}){const{wrapper:n}={...(0,t.R)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(l,{...e})}):l(e)}},43023:(e,n,i)=>{i.d(n,{R:()=>o,x:()=>c});var r=i(63696);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 c(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/ab69fe56.532d2c61.js b/assets/js/ab69fe56.9724cf3c.js similarity index 85% rename from assets/js/ab69fe56.532d2c61.js rename to assets/js/ab69fe56.9724cf3c.js index 5518272545f..8720fa85841 100644 --- a/assets/js/ab69fe56.532d2c61.js +++ b/assets/js/ab69fe56.9724cf3c.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[53499],{58739:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>c,contentTitle:()=>a,default:()=>u,frontMatter:()=>o,metadata:()=>r,toc:()=>d});var s=t(62540),i=t(43023);const o={},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={},d=[{value:"Defined in",id:"defined-in",level:2}];function p(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",strong:"strong",...(0,i.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.header,{children:(0,s.jsx)(n.h1,{id:"type-alias-mountconfig",children:"Type Alias: MountConfig"})}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"MountConfig"}),": ",(0,s.jsx)(n.a,{href:"/api/interfaces/MountSettings",children:(0,s.jsx)(n.code,{children:"MountSettings"})}),"[]"]}),"\n"]}),"\n",(0,s.jsx)(n.h2,{id:"defined-in",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2419",children:"packages/extension-api/src/extension-api.d.ts:2419"})})]})}function u(e={}){const{wrapper:n}={...(0,i.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(p,{...e})}):p(e)}},43023:(e,n,t)=>{t.d(n,{R:()=>a,x:()=>r});var s=t(63696);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([[53499],{58739:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>c,contentTitle:()=>a,default:()=>u,frontMatter:()=>o,metadata:()=>r,toc:()=>p});var s=t(62540),i=t(43023);const o={},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={},p=[{value:"Defined in",id:"defined-in",level:2}];function d(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",strong:"strong",...(0,i.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.header,{children:(0,s.jsx)(n.h1,{id:"type-alias-mountconfig",children:"Type Alias: MountConfig"})}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"MountConfig"}),": ",(0,s.jsx)(n.a,{href:"/api/interfaces/MountSettings",children:(0,s.jsx)(n.code,{children:"MountSettings"})}),"[]"]}),"\n"]}),"\n",(0,s.jsx)(n.h2,{id:"defined-in",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2419",children:"packages/extension-api/src/extension-api.d.ts:2419"})})]})}function u(e={}){const{wrapper:n}={...(0,i.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(d,{...e})}):d(e)}},43023:(e,n,t)=>{t.d(n,{R:()=>a,x:()=>r});var s=t(63696);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/adcef0a2.1a71dc72.js b/assets/js/adcef0a2.354e4a3c.js similarity index 85% rename from assets/js/adcef0a2.1a71dc72.js rename to assets/js/adcef0a2.354e4a3c.js index a09d2cdf14f..baea42e27bc 100644 --- a/assets/js/adcef0a2.1a71dc72.js +++ b/assets/js/adcef0a2.354e4a3c.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[5451],{79740:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>o,contentTitle:()=>a,default:()=>l,frontMatter:()=>c,metadata:()=>s,toc:()=>d});var t=r(62540),i=r(43023);const c={},a="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:"Defined in",id:"defined-in",level:4}];function h(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",p:"p",strong:"strong",...(0,i.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.header,{children:(0,t.jsx)(n.h1,{id:"interface-imagecheckerprovider",children:"Interface: ImageCheckerProvider"})}),"\n",(0,t.jsx)(n.p,{children:"Interface to be implemented by image checker providers"}),"\n",(0,t.jsx)(n.h2,{id:"methods",children:"Methods"}),"\n",(0,t.jsx)(n.h3,{id:"check",children:"check()"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"check"}),"(",(0,t.jsx)(n.code,{children:"image"}),", ",(0,t.jsx)(n.code,{children:"token"}),"?): ",(0,t.jsx)(n.a,{href:"/api/type-aliases/ProviderResult",children:(0,t.jsx)(n.code,{children:"ProviderResult"})}),"<",(0,t.jsx)(n.a,{href:"/api/interfaces/ImageChecks",children:(0,t.jsx)(n.code,{children:"ImageChecks"})}),">"]}),"\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:"image"}),": ",(0,t.jsx)(n.a,{href:"/api/interfaces/ImageInfo",children:(0,t.jsx)(n.code,{children:"ImageInfo"})})]}),"\n",(0,t.jsx)(n.p,{children:"Info about the image to analyze"}),"\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 cancellation token the function can use to be informed when the caller asks for the operation to be cancelled"}),"\n",(0,t.jsx)(n.h4,{id:"returns",children:"Returns"}),"\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.a,{href:"/api/type-aliases/ProviderResult",children:(0,t.jsx)(n.code,{children:"ProviderResult"})}),"<",(0,t.jsx)(n.a,{href:"/api/interfaces/ImageChecks",children:(0,t.jsx)(n.code,{children:"ImageChecks"})}),">"]}),"\n",(0,t.jsx)(n.p,{children:"the complete result of the analyze, either synchronously of through a Promise"}),"\n",(0,t.jsx)(n.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L4465",children:"packages/extension-api/src/extension-api.d.ts:4465"})})]})}function l(e={}){const{wrapper:n}={...(0,i.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(h,{...e})}):h(e)}},43023:(e,n,r)=>{r.d(n,{R:()=>a,x:()=>s});var t=r(63696);const i={},c=t.createContext(i);function a(e){const n=t.useContext(c);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function s(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:a(e.components),t.createElement(c.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[5451],{79740:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>o,contentTitle:()=>a,default:()=>l,frontMatter:()=>i,metadata:()=>s,toc:()=>d});var t=r(62540),c=r(43023);const i={},a="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:"Defined in",id:"defined-in",level:4}];function h(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",p:"p",strong:"strong",...(0,c.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.header,{children:(0,t.jsx)(n.h1,{id:"interface-imagecheckerprovider",children:"Interface: ImageCheckerProvider"})}),"\n",(0,t.jsx)(n.p,{children:"Interface to be implemented by image checker providers"}),"\n",(0,t.jsx)(n.h2,{id:"methods",children:"Methods"}),"\n",(0,t.jsx)(n.h3,{id:"check",children:"check()"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"check"}),"(",(0,t.jsx)(n.code,{children:"image"}),", ",(0,t.jsx)(n.code,{children:"token"}),"?): ",(0,t.jsx)(n.a,{href:"/api/type-aliases/ProviderResult",children:(0,t.jsx)(n.code,{children:"ProviderResult"})}),"<",(0,t.jsx)(n.a,{href:"/api/interfaces/ImageChecks",children:(0,t.jsx)(n.code,{children:"ImageChecks"})}),">"]}),"\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:"image"}),": ",(0,t.jsx)(n.a,{href:"/api/interfaces/ImageInfo",children:(0,t.jsx)(n.code,{children:"ImageInfo"})})]}),"\n",(0,t.jsx)(n.p,{children:"Info about the image to analyze"}),"\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 cancellation token the function can use to be informed when the caller asks for the operation to be cancelled"}),"\n",(0,t.jsx)(n.h4,{id:"returns",children:"Returns"}),"\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.a,{href:"/api/type-aliases/ProviderResult",children:(0,t.jsx)(n.code,{children:"ProviderResult"})}),"<",(0,t.jsx)(n.a,{href:"/api/interfaces/ImageChecks",children:(0,t.jsx)(n.code,{children:"ImageChecks"})}),">"]}),"\n",(0,t.jsx)(n.p,{children:"the complete result of the analyze, either synchronously of through a Promise"}),"\n",(0,t.jsx)(n.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L4465",children:"packages/extension-api/src/extension-api.d.ts:4465"})})]})}function l(e={}){const{wrapper:n}={...(0,c.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(h,{...e})}):h(e)}},43023:(e,n,r)=>{r.d(n,{R:()=>a,x:()=>s});var t=r(63696);const c={},i=t.createContext(c);function a(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(c):e.components||c:a(e.components),t.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/adfdec4a.33ca9ed3.js b/assets/js/adfdec4a.3650e688.js similarity index 90% rename from assets/js/adfdec4a.33ca9ed3.js rename to assets/js/adfdec4a.3650e688.js index 2f30d372176..e435dd543d8 100644 --- a/assets/js/adfdec4a.33ca9ed3.js +++ b/assets/js/adfdec4a.3650e688.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[22051],{63312:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>r,contentTitle:()=>c,default:()=>h,frontMatter:()=>t,metadata:()=>o,toc:()=>a});var s=i(62540),d=i(43023);const t={},c="Interface: CustomPick",o={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={},a=[{value:"Type Parameters",id:"type-parameters",level:2},{value:"Properties",id:"properties",level:2},{value:"canSelectMany",id:"canselectmany",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"description?",id:"description",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"hideItemSections",id:"hideitemsections",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"icon?",id:"icon",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"items",id:"items",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"minHeight?",id:"minheight",level:3},{value:"Defined in",id:"defined-in-5",level:4},{value:"onDidConfirmSelection",id:"ondidconfirmselection",level:3},{value:"Defined in",id:"defined-in-6",level:4},{value:"onDidHide",id:"ondidhide",level:3},{value:"Defined in",id:"defined-in-7",level:4},{value:"title?",id:"title",level:3},{value:"Defined in",id:"defined-in-8",level:4},{value:"Methods",id:"methods",level:2},{value:"dispose()",id:"dispose",level:3},{value:"Returns",id:"returns",level:4},{value:"Defined in",id:"defined-in-9",level:4},{value:"hide()",id:"hide",level:3},{value:"Returns",id:"returns-1",level:4},{value:"Defined in",id:"defined-in-10",level:4},{value:"show()",id:"show",level:3},{value:"Returns",id:"returns-2",level:4},{value:"Defined in",id:"defined-in-11",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",em:"em",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",p:"p",strong:"strong",...(0,d.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.header,{children:(0,s.jsx)(n.h1,{id:"interface-custompickt",children:"Interface: CustomPick"})}),"\n",(0,s.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,s.jsx)(n.h2,{id:"type-parameters",children:"Type Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"T"})," ",(0,s.jsx)(n.em,{children:"extends"})," ",(0,s.jsx)(n.a,{href:"/api/interfaces/CustomPickItem",children:(0,s.jsx)(n.code,{children:"CustomPickItem"})})]}),"\n",(0,s.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,s.jsx)(n.h3,{id:"canselectmany",children:"canSelectMany"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"canSelectMany"}),": ",(0,s.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"If multiple items can be selected at the same time. Defaults to false."}),"\n",(0,s.jsx)(n.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L1414",children:"packages/extension-api/src/extension-api.d.ts:1414"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"description",children:"description?"}),"\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:"description"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"An optional human-readable string which is rendered less prominent in a separate line."}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L1402",children:"packages/extension-api/src/extension-api.d.ts:1402"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"hideitemsections",children:"hideItemSections"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"hideItemSections"}),": ",(0,s.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,s.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,s.jsx)(n.h4,{id:"defined-in-2",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L1420",children:"packages/extension-api/src/extension-api.d.ts:1420"})}),"\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"})," | ",(0,s.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"An optional base64 PNG image"}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-3",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L1406",children:"packages/extension-api/src/extension-api.d.ts:1406"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"items",children:"items"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"items"}),": ",(0,s.jsx)(n.code,{children:"T"}),"[]"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Items to pick from. This can be read and updated by the extension."}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-4",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L1410",children:"packages/extension-api/src/extension-api.d.ts:1410"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"minheight",children:"minHeight?"}),"\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:"minHeight"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.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,s.jsx)(n.h4,{id:"defined-in-5",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L1426",children:"packages/extension-api/src/extension-api.d.ts:1426"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"ondidconfirmselection",children:"onDidConfirmSelection"}),"\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:"onDidConfirmSelection"}),": ",(0,s.jsx)(n.a,{href:"/api/interfaces/Event",children:(0,s.jsx)(n.code,{children:"Event"})}),"<",(0,s.jsx)(n.code,{children:"number"}),"[]>"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"An event signaling when the user indicated confirmation of the selected item(s) index(es)."}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-6",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L1430",children:"packages/extension-api/src/extension-api.d.ts:1430"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"ondidhide",children:"onDidHide"}),"\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:"onDidHide"}),": ",(0,s.jsx)(n.a,{href:"/api/interfaces/Event",children:(0,s.jsx)(n.code,{children:"Event"})}),"<",(0,s.jsx)(n.code,{children:"void"}),">"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"An event signaling when this input UI is hidden."}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-7",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L1434",children:"packages/extension-api/src/extension-api.d.ts:1434"})}),"\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 human-readable string which is rendered prominent."}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-8",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L1398",children:"packages/extension-api/src/extension-api.d.ts:1398"})}),"\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.jsxs)(n.p,{children:["Dispose and free associated resources. Call\n",(0,s.jsx)(n.a,{href:"/api/interfaces/CustomPick#hide",children:"CustomPick.hide"}),"."]}),"\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:"defined-in-9",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L1448",children:"packages/extension-api/src/extension-api.d.ts:1448"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"hide",children:"hide()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"hide"}),"(): ",(0,s.jsx)(n.code,{children:"void"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Hides the custom pick."}),"\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:"defined-in-10",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L1442",children:"packages/extension-api/src/extension-api.d.ts:1442"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"show",children:"show()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"show"}),"(): ",(0,s.jsx)(n.code,{children:"void"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Shows the custom pick."}),"\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:"defined-in-11",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L1438",children:"packages/extension-api/src/extension-api.d.ts:1438"})})]})}function h(e={}){const{wrapper:n}={...(0,d.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},43023:(e,n,i)=>{i.d(n,{R:()=>c,x:()=>o});var s=i(63696);const d={},t=s.createContext(d);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(d):e.components||d:c(e.components),s.createElement(t.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[22051],{63312:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>r,contentTitle:()=>c,default:()=>h,frontMatter:()=>t,metadata:()=>o,toc:()=>a});var s=i(62540),d=i(43023);const t={},c="Interface: CustomPick",o={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={},a=[{value:"Type Parameters",id:"type-parameters",level:2},{value:"Properties",id:"properties",level:2},{value:"canSelectMany",id:"canselectmany",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"description?",id:"description",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"hideItemSections",id:"hideitemsections",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"icon?",id:"icon",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"items",id:"items",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"minHeight?",id:"minheight",level:3},{value:"Defined in",id:"defined-in-5",level:4},{value:"onDidConfirmSelection",id:"ondidconfirmselection",level:3},{value:"Defined in",id:"defined-in-6",level:4},{value:"onDidHide",id:"ondidhide",level:3},{value:"Defined in",id:"defined-in-7",level:4},{value:"title?",id:"title",level:3},{value:"Defined in",id:"defined-in-8",level:4},{value:"Methods",id:"methods",level:2},{value:"dispose()",id:"dispose",level:3},{value:"Returns",id:"returns",level:4},{value:"Defined in",id:"defined-in-9",level:4},{value:"hide()",id:"hide",level:3},{value:"Returns",id:"returns-1",level:4},{value:"Defined in",id:"defined-in-10",level:4},{value:"show()",id:"show",level:3},{value:"Returns",id:"returns-2",level:4},{value:"Defined in",id:"defined-in-11",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",em:"em",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",p:"p",strong:"strong",...(0,d.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.header,{children:(0,s.jsx)(n.h1,{id:"interface-custompickt",children:"Interface: CustomPick"})}),"\n",(0,s.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,s.jsx)(n.h2,{id:"type-parameters",children:"Type Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"T"})," ",(0,s.jsx)(n.em,{children:"extends"})," ",(0,s.jsx)(n.a,{href:"/api/interfaces/CustomPickItem",children:(0,s.jsx)(n.code,{children:"CustomPickItem"})})]}),"\n",(0,s.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,s.jsx)(n.h3,{id:"canselectmany",children:"canSelectMany"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"canSelectMany"}),": ",(0,s.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"If multiple items can be selected at the same time. Defaults to false."}),"\n",(0,s.jsx)(n.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L1414",children:"packages/extension-api/src/extension-api.d.ts:1414"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"description",children:"description?"}),"\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:"description"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"An optional human-readable string which is rendered less prominent in a separate line."}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L1402",children:"packages/extension-api/src/extension-api.d.ts:1402"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"hideitemsections",children:"hideItemSections"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"hideItemSections"}),": ",(0,s.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,s.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,s.jsx)(n.h4,{id:"defined-in-2",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L1420",children:"packages/extension-api/src/extension-api.d.ts:1420"})}),"\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"})," | ",(0,s.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"An optional base64 PNG image"}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-3",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L1406",children:"packages/extension-api/src/extension-api.d.ts:1406"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"items",children:"items"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"items"}),": ",(0,s.jsx)(n.code,{children:"T"}),"[]"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Items to pick from. This can be read and updated by the extension."}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-4",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L1410",children:"packages/extension-api/src/extension-api.d.ts:1410"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"minheight",children:"minHeight?"}),"\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:"minHeight"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.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,s.jsx)(n.h4,{id:"defined-in-5",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L1426",children:"packages/extension-api/src/extension-api.d.ts:1426"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"ondidconfirmselection",children:"onDidConfirmSelection"}),"\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:"onDidConfirmSelection"}),": ",(0,s.jsx)(n.a,{href:"/api/interfaces/Event",children:(0,s.jsx)(n.code,{children:"Event"})}),"<",(0,s.jsx)(n.code,{children:"number"}),"[]>"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"An event signaling when the user indicated confirmation of the selected item(s) index(es)."}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-6",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L1430",children:"packages/extension-api/src/extension-api.d.ts:1430"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"ondidhide",children:"onDidHide"}),"\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:"onDidHide"}),": ",(0,s.jsx)(n.a,{href:"/api/interfaces/Event",children:(0,s.jsx)(n.code,{children:"Event"})}),"<",(0,s.jsx)(n.code,{children:"void"}),">"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"An event signaling when this input UI is hidden."}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-7",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L1434",children:"packages/extension-api/src/extension-api.d.ts:1434"})}),"\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 human-readable string which is rendered prominent."}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-8",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L1398",children:"packages/extension-api/src/extension-api.d.ts:1398"})}),"\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.jsxs)(n.p,{children:["Dispose and free associated resources. Call\n",(0,s.jsx)(n.a,{href:"/api/interfaces/CustomPick#hide",children:"CustomPick.hide"}),"."]}),"\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:"defined-in-9",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L1448",children:"packages/extension-api/src/extension-api.d.ts:1448"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"hide",children:"hide()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"hide"}),"(): ",(0,s.jsx)(n.code,{children:"void"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Hides the custom pick."}),"\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:"defined-in-10",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L1442",children:"packages/extension-api/src/extension-api.d.ts:1442"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"show",children:"show()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"show"}),"(): ",(0,s.jsx)(n.code,{children:"void"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Shows the custom pick."}),"\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:"defined-in-11",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L1438",children:"packages/extension-api/src/extension-api.d.ts:1438"})})]})}function h(e={}){const{wrapper:n}={...(0,d.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},43023:(e,n,i)=>{i.d(n,{R:()=>c,x:()=>o});var s=i(63696);const d={},t=s.createContext(d);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(d):e.components||d:c(e.components),s.createElement(t.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/ae4a775b.4426b7bc.js b/assets/js/ae4a775b.92d157cb.js similarity index 96% rename from assets/js/ae4a775b.4426b7bc.js rename to assets/js/ae4a775b.92d157cb.js index dcf33efb630..4a933d33438 100644 --- a/assets/js/ae4a775b.4426b7bc.js +++ b/assets/js/ae4a775b.92d157cb.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[72231],{67762:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>i,default:()=>u,frontMatter:()=>o,metadata:()=>r,toc:()=>d});var s=t(62540),c=t(43023);const o={},i="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:"context",permalink:"/api/namespaces/context/"},next:{title:"env",permalink:"/api/namespaces/env/"}},a={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Defined in",id:"defined-in",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",strong:"strong",...(0,c.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.header,{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:"defined-in",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L4300",children:"packages/extension-api/src/extension-api.d.ts:4300"})})]})}function u(e={}){const{wrapper:n}={...(0,c.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},43023:(e,n,t)=>{t.d(n,{R:()=>i,x:()=>r});var s=t(63696);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([[72231],{67762:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>i,default:()=>u,frontMatter:()=>o,metadata:()=>r,toc:()=>d});var s=t(62540),c=t(43023);const o={},i="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:"context",permalink:"/api/namespaces/context/"},next:{title:"env",permalink:"/api/namespaces/env/"}},a={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Defined in",id:"defined-in",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",strong:"strong",...(0,c.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.header,{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:"defined-in",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L4300",children:"packages/extension-api/src/extension-api.d.ts:4300"})})]})}function u(e={}){const{wrapper:n}={...(0,c.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},43023:(e,n,t)=>{t.d(n,{R:()=>i,x:()=>r});var s=t(63696);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/b15eeff9.dfb276e8.js b/assets/js/b15eeff9.cef075ec.js similarity index 94% rename from assets/js/b15eeff9.dfb276e8.js rename to assets/js/b15eeff9.cef075ec.js index 3660ee656ed..343a68d1936 100644 --- a/assets/js/b15eeff9.dfb276e8.js +++ b/assets/js/b15eeff9.cef075ec.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[46252],{77762:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>r,contentTitle:()=>c,default:()=>l,frontMatter:()=>s,metadata:()=>a,toc:()=>d});var t=i(62540),o=i(43023);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:"Defined in",id:"defined-in",level:4},{value:"label",id:"label",level:3},{value:"Defined in",id:"defined-in-1",level:4}];function h(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",p:"p",strong:"strong",...(0,o.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.header,{children:(0,t.jsx)(n.h1,{id:"interface-authenticationsessionaccountinformation",children:"Interface: AuthenticationSessionAccountInformation"})}),"\n",(0,t.jsxs)(n.p,{children:["The information of an account associated with an ",(0,t.jsx)(n.a,{href:"#AuthenticationSession",children:"AuthenticationSession"}),"."]}),"\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.code,{children:"readonly"})," ",(0,t.jsx)(n.strong,{children:"id"}),": ",(0,t.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"The unique identifier of the account."}),"\n",(0,t.jsx)(n.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L3731",children:"packages/extension-api/src/extension-api.d.ts:3731"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"label",children:"label"}),"\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:"label"}),": ",(0,t.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"The human-readable name of the account."}),"\n",(0,t.jsx)(n.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L3736",children:"packages/extension-api/src/extension-api.d.ts:3736"})})]})}function l(e={}){const{wrapper:n}={...(0,o.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(h,{...e})}):h(e)}},43023:(e,n,i)=>{i.d(n,{R:()=>c,x:()=>a});var t=i(63696);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 a(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([[46252],{77762:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>r,contentTitle:()=>c,default:()=>l,frontMatter:()=>s,metadata:()=>a,toc:()=>d});var t=i(62540),o=i(43023);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:"Defined in",id:"defined-in",level:4},{value:"label",id:"label",level:3},{value:"Defined in",id:"defined-in-1",level:4}];function h(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",p:"p",strong:"strong",...(0,o.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.header,{children:(0,t.jsx)(n.h1,{id:"interface-authenticationsessionaccountinformation",children:"Interface: AuthenticationSessionAccountInformation"})}),"\n",(0,t.jsxs)(n.p,{children:["The information of an account associated with an ",(0,t.jsx)(n.a,{href:"#AuthenticationSession",children:"AuthenticationSession"}),"."]}),"\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.code,{children:"readonly"})," ",(0,t.jsx)(n.strong,{children:"id"}),": ",(0,t.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"The unique identifier of the account."}),"\n",(0,t.jsx)(n.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L3731",children:"packages/extension-api/src/extension-api.d.ts:3731"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"label",children:"label"}),"\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:"label"}),": ",(0,t.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"The human-readable name of the account."}),"\n",(0,t.jsx)(n.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L3736",children:"packages/extension-api/src/extension-api.d.ts:3736"})})]})}function l(e={}){const{wrapper:n}={...(0,o.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(h,{...e})}):h(e)}},43023:(e,n,i)=>{i.d(n,{R:()=>c,x:()=>a});var t=i(63696);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 a(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/b3b7dd16.45a34afb.js b/assets/js/b3b7dd16.698d581a.js similarity index 96% rename from assets/js/b3b7dd16.45a34afb.js rename to assets/js/b3b7dd16.698d581a.js index d6ea6754258..772b9d35f10 100644 --- a/assets/js/b3b7dd16.45a34afb.js +++ b/assets/js/b3b7dd16.698d581a.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[45802],{29404:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>r,default:()=>l,frontMatter:()=>i,metadata:()=>o,toc:()=>d});var s=t(62540),c=t(43023);const i={},r="Function: createCustomPick()",o={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:"window",permalink:"/api/namespaces/window/"},next:{title:"createStatusBarItem",permalink:"/api/namespaces/window/functions/createStatusBarItem"}},a={},d=[{value:"Type Parameters",id:"type-parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Defined in",id:"defined-in",level:2}];function u(e){const n={a:"a",blockquote:"blockquote",code:"code",em:"em",h1:"h1",h2:"h2",header:"header",p:"p",strong:"strong",...(0,c.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.header,{children:(0,s.jsx)(n.h1,{id:"function-createcustompick",children:"Function: createCustomPick()"})}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"createCustomPick"}),"<",(0,s.jsx)(n.code,{children:"T"}),">(): ",(0,s.jsx)(n.a,{href:"/api/interfaces/CustomPick",children:(0,s.jsx)(n.code,{children:"CustomPick"})}),"<",(0,s.jsx)(n.code,{children:"T"}),">"]}),"\n"]}),"\n",(0,s.jsx)(n.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)(n.h2,{id:"type-parameters",children:"Type Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"T"})," ",(0,s.jsx)(n.em,{children:"extends"})," ",(0,s.jsx)(n.a,{href:"/api/interfaces/CustomPickItem",children:(0,s.jsx)(n.code,{children:"CustomPickItem"})})]}),"\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/CustomPick",children:(0,s.jsx)(n.code,{children:"CustomPick"})}),"<",(0,s.jsx)(n.code,{children:"T"}),">"]}),"\n",(0,s.jsx)(n.p,{children:"A new CustomPick"}),"\n",(0,s.jsx)(n.h2,{id:"defined-in",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2085",children:"packages/extension-api/src/extension-api.d.ts:2085"})})]})}function l(e={}){const{wrapper:n}={...(0,c.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(u,{...e})}):u(e)}},43023:(e,n,t)=>{t.d(n,{R:()=>r,x:()=>o});var s=t(63696);const c={},i=s.createContext(c);function r(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(c):e.components||c:r(e.components),s.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[45802],{29404:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>r,default:()=>l,frontMatter:()=>i,metadata:()=>o,toc:()=>d});var s=t(62540),c=t(43023);const i={},r="Function: createCustomPick()",o={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:"window",permalink:"/api/namespaces/window/"},next:{title:"createStatusBarItem",permalink:"/api/namespaces/window/functions/createStatusBarItem"}},a={},d=[{value:"Type Parameters",id:"type-parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Defined in",id:"defined-in",level:2}];function u(e){const n={a:"a",blockquote:"blockquote",code:"code",em:"em",h1:"h1",h2:"h2",header:"header",p:"p",strong:"strong",...(0,c.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.header,{children:(0,s.jsx)(n.h1,{id:"function-createcustompick",children:"Function: createCustomPick()"})}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"createCustomPick"}),"<",(0,s.jsx)(n.code,{children:"T"}),">(): ",(0,s.jsx)(n.a,{href:"/api/interfaces/CustomPick",children:(0,s.jsx)(n.code,{children:"CustomPick"})}),"<",(0,s.jsx)(n.code,{children:"T"}),">"]}),"\n"]}),"\n",(0,s.jsx)(n.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)(n.h2,{id:"type-parameters",children:"Type Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"T"})," ",(0,s.jsx)(n.em,{children:"extends"})," ",(0,s.jsx)(n.a,{href:"/api/interfaces/CustomPickItem",children:(0,s.jsx)(n.code,{children:"CustomPickItem"})})]}),"\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/CustomPick",children:(0,s.jsx)(n.code,{children:"CustomPick"})}),"<",(0,s.jsx)(n.code,{children:"T"}),">"]}),"\n",(0,s.jsx)(n.p,{children:"A new CustomPick"}),"\n",(0,s.jsx)(n.h2,{id:"defined-in",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2085",children:"packages/extension-api/src/extension-api.d.ts:2085"})})]})}function l(e={}){const{wrapper:n}={...(0,c.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(u,{...e})}):u(e)}},43023:(e,n,t)=>{t.d(n,{R:()=>r,x:()=>o});var s=t(63696);const c={},i=s.createContext(c);function r(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(c):e.components||c:r(e.components),s.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/b4df9b48.cc214a5f.js b/assets/js/b4df9b48.b2dea336.js similarity index 90% rename from assets/js/b4df9b48.cc214a5f.js rename to assets/js/b4df9b48.b2dea336.js index 474e8dd2e1b..3c3fe7411fb 100644 --- a/assets/js/b4df9b48.cc214a5f.js +++ b/assets/js/b4df9b48.b2dea336.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[87246],{6750:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>a,contentTitle:()=>t,default:()=>h,frontMatter:()=>d,metadata:()=>c,toc:()=>l});var s=i(62540),r=i(43023);const d={},t="Interface: Registry",c={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"}},a={},l=[{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:"Defined in",id:"defined-in",level:4},{value:"icon?",id:"icon",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"insecure?",id:"insecure",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"name?",id:"name",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"secret",id:"secret",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"serverUrl",id:"serverurl",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"source",id:"source",level:3},{value:"Defined in",id:"defined-in-6",level:4},{value:"username",id:"username",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-7",level:4}];function o(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",li:"li",p:"p",strong:"strong",ul:"ul",...(0,r.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.header,{children:(0,s.jsx)(n.h1,{id:"interface-registry",children:"Interface: Registry"})}),"\n",(0,s.jsx)(n.h2,{id:"extends",children:"Extends"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.a,{href:"/api/interfaces/RegistryCreateOptions",children:(0,s.jsx)(n.code,{children:"RegistryCreateOptions"})})}),"\n"]}),"\n",(0,s.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,s.jsx)(n.h3,{id:"alias",children:"alias?"}),"\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:"alias"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"inherited-from",children:"Inherited from"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.a,{href:"/api/interfaces/RegistryCreateOptions",children:(0,s.jsx)(n.code,{children:"RegistryCreateOptions"})}),".",(0,s.jsx)(n.a,{href:"/api/interfaces/RegistryCreateOptions#alias",children:(0,s.jsx)(n.code,{children:"alias"})})]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L908",children:"packages/extension-api/src/extension-api.d.ts:908"})}),"\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:"defined-in-1",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L900",children:"packages/extension-api/src/extension-api.d.ts:900"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"insecure",children:"insecure?"}),"\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:"insecure"}),": ",(0,s.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"inherited-from-1",children:"Inherited from"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.a,{href:"/api/interfaces/RegistryCreateOptions",children:(0,s.jsx)(n.code,{children:"RegistryCreateOptions"})}),".",(0,s.jsx)(n.a,{href:"/api/interfaces/RegistryCreateOptions#insecure",children:(0,s.jsx)(n.code,{children:"insecure"})})]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-2",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L907",children:"packages/extension-api/src/extension-api.d.ts:907"})}),"\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.code,{children:"optional"})," ",(0,s.jsx)(n.strong,{children:"name"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-3",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L899",children:"packages/extension-api/src/extension-api.d.ts:899"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"secret",children:"secret"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"secret"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"inherited-from-2",children:"Inherited from"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.a,{href:"/api/interfaces/RegistryCreateOptions",children:(0,s.jsx)(n.code,{children:"RegistryCreateOptions"})}),".",(0,s.jsx)(n.a,{href:"/api/interfaces/RegistryCreateOptions#secret",children:(0,s.jsx)(n.code,{children:"secret"})})]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-4",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L906",children:"packages/extension-api/src/extension-api.d.ts:906"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"serverurl",children:"serverUrl"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"serverUrl"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"inherited-from-3",children:"Inherited from"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.a,{href:"/api/interfaces/RegistryCreateOptions",children:(0,s.jsx)(n.code,{children:"RegistryCreateOptions"})}),".",(0,s.jsx)(n.a,{href:"/api/interfaces/RegistryCreateOptions#serverurl",children:(0,s.jsx)(n.code,{children:"serverUrl"})})]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-5",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L904",children:"packages/extension-api/src/extension-api.d.ts:904"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"source",children:"source"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"source"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-6",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/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:"username",children:"username"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"username"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"inherited-from-4",children:"Inherited from"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.a,{href:"/api/interfaces/RegistryCreateOptions",children:(0,s.jsx)(n.code,{children:"RegistryCreateOptions"})}),".",(0,s.jsx)(n.a,{href:"/api/interfaces/RegistryCreateOptions#username",children:(0,s.jsx)(n.code,{children:"username"})})]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-7",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L905",children:"packages/extension-api/src/extension-api.d.ts:905"})})]})}function h(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(o,{...e})}):o(e)}},43023:(e,n,i)=>{i.d(n,{R:()=>t,x:()=>c});var s=i(63696);const r={},d=s.createContext(r);function t(e){const n=s.useContext(d);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(d.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[87246],{6750:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>a,contentTitle:()=>t,default:()=>h,frontMatter:()=>d,metadata:()=>c,toc:()=>l});var s=i(62540),r=i(43023);const d={},t="Interface: Registry",c={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"}},a={},l=[{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:"Defined in",id:"defined-in",level:4},{value:"icon?",id:"icon",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"insecure?",id:"insecure",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"name?",id:"name",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"secret",id:"secret",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"serverUrl",id:"serverurl",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"source",id:"source",level:3},{value:"Defined in",id:"defined-in-6",level:4},{value:"username",id:"username",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-7",level:4}];function o(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",li:"li",p:"p",strong:"strong",ul:"ul",...(0,r.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.header,{children:(0,s.jsx)(n.h1,{id:"interface-registry",children:"Interface: Registry"})}),"\n",(0,s.jsx)(n.h2,{id:"extends",children:"Extends"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.a,{href:"/api/interfaces/RegistryCreateOptions",children:(0,s.jsx)(n.code,{children:"RegistryCreateOptions"})})}),"\n"]}),"\n",(0,s.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,s.jsx)(n.h3,{id:"alias",children:"alias?"}),"\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:"alias"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"inherited-from",children:"Inherited from"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.a,{href:"/api/interfaces/RegistryCreateOptions",children:(0,s.jsx)(n.code,{children:"RegistryCreateOptions"})}),".",(0,s.jsx)(n.a,{href:"/api/interfaces/RegistryCreateOptions#alias",children:(0,s.jsx)(n.code,{children:"alias"})})]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L908",children:"packages/extension-api/src/extension-api.d.ts:908"})}),"\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:"defined-in-1",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L900",children:"packages/extension-api/src/extension-api.d.ts:900"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"insecure",children:"insecure?"}),"\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:"insecure"}),": ",(0,s.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"inherited-from-1",children:"Inherited from"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.a,{href:"/api/interfaces/RegistryCreateOptions",children:(0,s.jsx)(n.code,{children:"RegistryCreateOptions"})}),".",(0,s.jsx)(n.a,{href:"/api/interfaces/RegistryCreateOptions#insecure",children:(0,s.jsx)(n.code,{children:"insecure"})})]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-2",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L907",children:"packages/extension-api/src/extension-api.d.ts:907"})}),"\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.code,{children:"optional"})," ",(0,s.jsx)(n.strong,{children:"name"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-3",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L899",children:"packages/extension-api/src/extension-api.d.ts:899"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"secret",children:"secret"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"secret"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"inherited-from-2",children:"Inherited from"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.a,{href:"/api/interfaces/RegistryCreateOptions",children:(0,s.jsx)(n.code,{children:"RegistryCreateOptions"})}),".",(0,s.jsx)(n.a,{href:"/api/interfaces/RegistryCreateOptions#secret",children:(0,s.jsx)(n.code,{children:"secret"})})]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-4",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L906",children:"packages/extension-api/src/extension-api.d.ts:906"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"serverurl",children:"serverUrl"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"serverUrl"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"inherited-from-3",children:"Inherited from"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.a,{href:"/api/interfaces/RegistryCreateOptions",children:(0,s.jsx)(n.code,{children:"RegistryCreateOptions"})}),".",(0,s.jsx)(n.a,{href:"/api/interfaces/RegistryCreateOptions#serverurl",children:(0,s.jsx)(n.code,{children:"serverUrl"})})]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-5",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L904",children:"packages/extension-api/src/extension-api.d.ts:904"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"source",children:"source"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"source"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-6",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/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:"username",children:"username"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"username"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"inherited-from-4",children:"Inherited from"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.a,{href:"/api/interfaces/RegistryCreateOptions",children:(0,s.jsx)(n.code,{children:"RegistryCreateOptions"})}),".",(0,s.jsx)(n.a,{href:"/api/interfaces/RegistryCreateOptions#username",children:(0,s.jsx)(n.code,{children:"username"})})]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-7",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L905",children:"packages/extension-api/src/extension-api.d.ts:905"})})]})}function h(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(o,{...e})}):o(e)}},43023:(e,n,i)=>{i.d(n,{R:()=>t,x:()=>c});var s=i(63696);const r={},d=s.createContext(r);function t(e){const n=s.useContext(d);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(d.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/b5114993.f7f3f334.js b/assets/js/b5114993.20a0afe3.js similarity index 88% rename from assets/js/b5114993.f7f3f334.js rename to assets/js/b5114993.20a0afe3.js index f5d6a44c47d..6c5e57ec12a 100644 --- a/assets/js/b5114993.f7f3f334.js +++ b/assets/js/b5114993.20a0afe3.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[34055],{43457:(e,s,n)=>{n.r(s),n.d(s,{assets:()=>c,contentTitle:()=>l,default:()=>h,frontMatter:()=>r,metadata:()=>a,toc:()=>t});var i=n(62540),d=n(43023);const r={},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"}},c={},t=[{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:"Defined in",id:"defined-in",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:"Defined in",id:"defined-in-1",level:4},{value:"Methods",id:"methods",level:2},{value:"dispose()",id:"dispose",level:3},{value:"Returns",id:"returns-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"create()",id:"create",level:3},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-3",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"from()",id:"from",level:3},{value:"Parameters",id:"parameters-3",level:4},{value:"Returns",id:"returns-4",level:4},{value:"Defined in",id:"defined-in-4",level:4}];function o(e){const s={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",li:"li",p:"p",strong:"strong",ul:"ul",...(0,d.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(s.header,{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/ImageFilesProvider",children:(0,i.jsx)(s.code,{children:"ImageFilesProvider"})})}),"\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:"defined-in",children:"Defined in"}),"\n",(0,i.jsx)(s.p,{children:(0,i.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/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:"defined-in-1",children:"Defined in"}),"\n",(0,i.jsx)(s.p,{children:(0,i.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/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:"defined-in-2",children:"Defined in"}),"\n",(0,i.jsx)(s.p,{children:(0,i.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/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:"defined-in-3",children:"Defined in"}),"\n",(0,i.jsx)(s.p,{children:(0,i.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/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:"defined-in-4",children:"Defined in"}),"\n",(0,i.jsx)(s.p,{children:(0,i.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/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,d.R)(),...e.components};return s?(0,i.jsx)(s,{...e,children:(0,i.jsx)(o,{...e})}):o(e)}},43023:(e,s,n)=>{n.d(s,{R:()=>l,x:()=>a});var i=n(63696);const d={},r=i.createContext(d);function l(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(d):e.components||d:l(e.components),i.createElement(r.Provider,{value:s},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[34055],{43457:(e,s,n)=>{n.r(s),n.d(s,{assets:()=>c,contentTitle:()=>l,default:()=>h,frontMatter:()=>d,metadata:()=>a,toc:()=>t});var i=n(62540),r=n(43023);const d={},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"}},c={},t=[{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:"Defined in",id:"defined-in",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:"Defined in",id:"defined-in-1",level:4},{value:"Methods",id:"methods",level:2},{value:"dispose()",id:"dispose",level:3},{value:"Returns",id:"returns-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"create()",id:"create",level:3},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-3",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"from()",id:"from",level:3},{value:"Parameters",id:"parameters-3",level:4},{value:"Returns",id:"returns-4",level:4},{value:"Defined in",id:"defined-in-4",level:4}];function o(e){const s={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",li:"li",p:"p",strong:"strong",ul:"ul",...(0,r.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(s.header,{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/ImageFilesProvider",children:(0,i.jsx)(s.code,{children:"ImageFilesProvider"})})}),"\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:"defined-in",children:"Defined in"}),"\n",(0,i.jsx)(s.p,{children:(0,i.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/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:"defined-in-1",children:"Defined in"}),"\n",(0,i.jsx)(s.p,{children:(0,i.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/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:"defined-in-2",children:"Defined in"}),"\n",(0,i.jsx)(s.p,{children:(0,i.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/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:"defined-in-3",children:"Defined in"}),"\n",(0,i.jsx)(s.p,{children:(0,i.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/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:"defined-in-4",children:"Defined in"}),"\n",(0,i.jsx)(s.p,{children:(0,i.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/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.R)(),...e.components};return s?(0,i.jsx)(s,{...e,children:(0,i.jsx)(o,{...e})}):o(e)}},43023:(e,s,n)=>{n.d(s,{R:()=>l,x:()=>a});var i=n(63696);const r={},d=i.createContext(r);function l(e){const s=i.useContext(d);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(d.Provider,{value:s},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/b51a9aee.c227835e.js b/assets/js/b51a9aee.34e8dea8.js similarity index 95% rename from assets/js/b51a9aee.c227835e.js rename to assets/js/b51a9aee.34e8dea8.js index 6d152112e94..39a8d561bfc 100644 --- a/assets/js/b51a9aee.c227835e.js +++ b/assets/js/b51a9aee.34e8dea8.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[39590],{57703:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>r,contentTitle:()=>a,default:()=>l,frontMatter:()=>s,metadata:()=>c,toc:()=>d});var i=t(62540),o=t(43023);const s={},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={},d=[{value:"Returns",id:"returns",level:2},{value:"Defined in",id:"defined-in",level:2}];function u(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",strong:"strong",...(0,o.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.header,{children:(0,i.jsx)(n.h1,{id:"function-navigatetovolumes",children:"Function: navigateToVolumes()"})}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"navigateToVolumes"}),"(): ",(0,i.jsx)(n.code,{children:"Promise"}),"<",(0,i.jsx)(n.code,{children:"void"}),">"]}),"\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.code,{children:"void"}),">"]}),"\n",(0,i.jsx)(n.h2,{id:"defined-in",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L4514",children:"packages/extension-api/src/extension-api.d.ts:4514"})})]})}function l(e={}){const{wrapper:n}={...(0,o.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(u,{...e})}):u(e)}},43023:(e,n,t)=>{t.d(n,{R:()=>a,x:()=>c});var i=t(63696);const o={},s=i.createContext(o);function a(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(o):e.components||o:a(e.components),i.createElement(s.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[39590],{57703:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>r,contentTitle:()=>a,default:()=>l,frontMatter:()=>s,metadata:()=>c,toc:()=>d});var i=t(62540),o=t(43023);const s={},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={},d=[{value:"Returns",id:"returns",level:2},{value:"Defined in",id:"defined-in",level:2}];function u(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",strong:"strong",...(0,o.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.header,{children:(0,i.jsx)(n.h1,{id:"function-navigatetovolumes",children:"Function: navigateToVolumes()"})}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"navigateToVolumes"}),"(): ",(0,i.jsx)(n.code,{children:"Promise"}),"<",(0,i.jsx)(n.code,{children:"void"}),">"]}),"\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.code,{children:"void"}),">"]}),"\n",(0,i.jsx)(n.h2,{id:"defined-in",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L4514",children:"packages/extension-api/src/extension-api.d.ts:4514"})})]})}function l(e={}){const{wrapper:n}={...(0,o.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(u,{...e})}):u(e)}},43023:(e,n,t)=>{t.d(n,{R:()=>a,x:()=>c});var i=t(63696);const o={},s=i.createContext(o);function a(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(o):e.components||o:a(e.components),i.createElement(s.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/b52d840d.66ee9ace.js b/assets/js/b52d840d.0f38102d.js similarity index 87% rename from assets/js/b52d840d.66ee9ace.js rename to assets/js/b52d840d.0f38102d.js index 1042d582661..af3cd9d3e9a 100644 --- a/assets/js/b52d840d.66ee9ace.js +++ b/assets/js/b52d840d.0f38102d.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[45226],{57223:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>r,contentTitle:()=>a,default:()=>h,frontMatter:()=>t,metadata:()=>c,toc:()=>o});var s=i(62540),d=i(43023);const t={},a="Interface: VolumeInfo",c={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"}},r={},o=[{value:"Properties",id:"properties",level:2},{value:"CreatedAt",id:"createdat",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"Driver",id:"driver",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"Labels",id:"labels",level:3},{value:"Index Signature",id:"index-signature",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"Mountpoint",id:"mountpoint",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"Name",id:"name",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"Options?",id:"options",level:3},{value:"Defined in",id:"defined-in-5",level:4},{value:"Scope",id:"scope",level:3},{value:"Defined in",id:"defined-in-6",level:4},{value:"Status?",id:"status",level:3},{value:"Index Signature",id:"index-signature-1",level:4},{value:"Defined in",id:"defined-in-7",level:4},{value:"UsageData?",id:"usagedata",level:3},{value:"Defined in",id:"defined-in-8",level:4},{value:"containersUsage",id:"containersusage",level:3},{value:"Defined in",id:"defined-in-9",level:4},{value:"engineId",id:"engineid",level:3},{value:"Defined in",id:"defined-in-10",level:4},{value:"engineName",id:"enginename",level:3},{value:"Defined in",id:"defined-in-11",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",p:"p",strong:"strong",...(0,d.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.header,{children:(0,s.jsx)(n.h1,{id:"interface-volumeinfo",children:"Interface: VolumeInfo"})}),"\n",(0,s.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,s.jsx)(n.h3,{id:"createdat",children:"CreatedAt"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"CreatedAt"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L3403",children:"packages/extension-api/src/extension-api.d.ts:3403"})}),"\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.strong,{children:"Driver"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L3406",children:"packages/extension-api/src/extension-api.d.ts:3406"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"labels",children:"Labels"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Labels"}),": ",(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:"defined-in-2",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L3409",children:"packages/extension-api/src/extension-api.d.ts:3409"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"mountpoint",children:"Mountpoint"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Mountpoint"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-3",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L3407",children:"packages/extension-api/src/extension-api.d.ts:3407"})}),"\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:"defined-in-4",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L3405",children:"packages/extension-api/src/extension-api.d.ts:3405"})}),"\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:"null"})," | ",(0,s.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-5",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L3411",children:"packages/extension-api/src/extension-api.d.ts:3411"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"scope",children:"Scope"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Scope"}),": ",(0,s.jsx)(n.code,{children:'"global"'})," | ",(0,s.jsx)(n.code,{children:'"local"'})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-6",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L3410",children:"packages/extension-api/src/extension-api.d.ts:3410"})}),"\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.code,{children:"optional"})," ",(0,s.jsx)(n.strong,{children:"Status"}),": ",(0,s.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"index-signature-1",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:"defined-in-7",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L3408",children:"packages/extension-api/src/extension-api.d.ts:3408"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"usagedata",children:"UsageData?"}),"\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:"UsageData"}),": ",(0,s.jsx)(n.code,{children:"null"})," | ",(0,s.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-8",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L3412",children:"packages/extension-api/src/extension-api.d.ts:3412"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"containersusage",children:"containersUsage"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"containersUsage"}),": ",(0,s.jsx)(n.code,{children:"object"}),"[]"]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-9",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L3404",children:"packages/extension-api/src/extension-api.d.ts:3404"})}),"\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.h4,{id:"defined-in-10",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L3401",children:"packages/extension-api/src/extension-api.d.ts:3401"})}),"\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.h4,{id:"defined-in-11",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L3402",children:"packages/extension-api/src/extension-api.d.ts:3402"})})]})}function h(e={}){const{wrapper:n}={...(0,d.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},43023:(e,n,i)=>{i.d(n,{R:()=>a,x:()=>c});var s=i(63696);const d={},t=s.createContext(d);function a(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(d):e.components||d:a(e.components),s.createElement(t.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[45226],{57223:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>r,contentTitle:()=>a,default:()=>h,frontMatter:()=>t,metadata:()=>c,toc:()=>o});var s=i(62540),d=i(43023);const t={},a="Interface: VolumeInfo",c={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"}},r={},o=[{value:"Properties",id:"properties",level:2},{value:"CreatedAt",id:"createdat",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"Driver",id:"driver",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"Labels",id:"labels",level:3},{value:"Index Signature",id:"index-signature",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"Mountpoint",id:"mountpoint",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"Name",id:"name",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"Options?",id:"options",level:3},{value:"Defined in",id:"defined-in-5",level:4},{value:"Scope",id:"scope",level:3},{value:"Defined in",id:"defined-in-6",level:4},{value:"Status?",id:"status",level:3},{value:"Index Signature",id:"index-signature-1",level:4},{value:"Defined in",id:"defined-in-7",level:4},{value:"UsageData?",id:"usagedata",level:3},{value:"Defined in",id:"defined-in-8",level:4},{value:"containersUsage",id:"containersusage",level:3},{value:"Defined in",id:"defined-in-9",level:4},{value:"engineId",id:"engineid",level:3},{value:"Defined in",id:"defined-in-10",level:4},{value:"engineName",id:"enginename",level:3},{value:"Defined in",id:"defined-in-11",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",p:"p",strong:"strong",...(0,d.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.header,{children:(0,s.jsx)(n.h1,{id:"interface-volumeinfo",children:"Interface: VolumeInfo"})}),"\n",(0,s.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,s.jsx)(n.h3,{id:"createdat",children:"CreatedAt"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"CreatedAt"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L3403",children:"packages/extension-api/src/extension-api.d.ts:3403"})}),"\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.strong,{children:"Driver"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L3406",children:"packages/extension-api/src/extension-api.d.ts:3406"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"labels",children:"Labels"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Labels"}),": ",(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:"defined-in-2",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L3409",children:"packages/extension-api/src/extension-api.d.ts:3409"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"mountpoint",children:"Mountpoint"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Mountpoint"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-3",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L3407",children:"packages/extension-api/src/extension-api.d.ts:3407"})}),"\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:"defined-in-4",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L3405",children:"packages/extension-api/src/extension-api.d.ts:3405"})}),"\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:"null"})," | ",(0,s.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-5",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L3411",children:"packages/extension-api/src/extension-api.d.ts:3411"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"scope",children:"Scope"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Scope"}),": ",(0,s.jsx)(n.code,{children:'"global"'})," | ",(0,s.jsx)(n.code,{children:'"local"'})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-6",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L3410",children:"packages/extension-api/src/extension-api.d.ts:3410"})}),"\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.code,{children:"optional"})," ",(0,s.jsx)(n.strong,{children:"Status"}),": ",(0,s.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"index-signature-1",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:"defined-in-7",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L3408",children:"packages/extension-api/src/extension-api.d.ts:3408"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"usagedata",children:"UsageData?"}),"\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:"UsageData"}),": ",(0,s.jsx)(n.code,{children:"null"})," | ",(0,s.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-8",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L3412",children:"packages/extension-api/src/extension-api.d.ts:3412"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"containersusage",children:"containersUsage"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"containersUsage"}),": ",(0,s.jsx)(n.code,{children:"object"}),"[]"]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-9",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L3404",children:"packages/extension-api/src/extension-api.d.ts:3404"})}),"\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.h4,{id:"defined-in-10",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L3401",children:"packages/extension-api/src/extension-api.d.ts:3401"})}),"\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.h4,{id:"defined-in-11",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L3402",children:"packages/extension-api/src/extension-api.d.ts:3402"})})]})}function h(e={}){const{wrapper:n}={...(0,d.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},43023:(e,n,i)=>{i.d(n,{R:()=>a,x:()=>c});var s=i(63696);const d={},t=s.createContext(d);function a(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(d):e.components||d:a(e.components),s.createElement(t.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/b5b19789.d7f853bb.js b/assets/js/b5b19789.c760b7d9.js similarity index 94% rename from assets/js/b5b19789.d7f853bb.js rename to assets/js/b5b19789.c760b7d9.js index ff3f2b3b63a..82c47c9577c 100644 --- a/assets/js/b5b19789.d7f853bb.js +++ b/assets/js/b5b19789.c760b7d9.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[61546],{1504:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>c,contentTitle:()=>s,default:()=>u,frontMatter:()=>r,metadata:()=>o,toc:()=>l});var i=n(62540),a=n(43023);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:"Defined in",id:"defined-in",level:2}];function d(e){const t={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",strong:"strong",...(0,a.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(t.header,{children:(0,i.jsx)(t.h1,{id:"variable-statusbaralignright",children:"Variable: StatusBarAlignRight"})}),"\n",(0,i.jsxs)(t.blockquote,{children:["\n",(0,i.jsxs)(t.p,{children:[(0,i.jsx)(t.code,{children:"const"})," ",(0,i.jsx)(t.strong,{children:"StatusBarAlignRight"}),": ",(0,i.jsx)(t.code,{children:'"RIGHT"'})," = ",(0,i.jsx)(t.code,{children:"'RIGHT'"})]}),"\n"]}),"\n",(0,i.jsx)(t.p,{children:"Aligned to the right side."}),"\n",(0,i.jsx)(t.h2,{id:"defined-in",children:"Defined in"}),"\n",(0,i.jsx)(t.p,{children:(0,i.jsx)(t.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L1487",children:"packages/extension-api/src/extension-api.d.ts:1487"})})]})}function u(e={}){const{wrapper:t}={...(0,a.R)(),...e.components};return t?(0,i.jsx)(t,{...e,children:(0,i.jsx)(d,{...e})}):d(e)}},43023:(e,t,n)=>{n.d(t,{R:()=>s,x:()=>o});var i=n(63696);const a={},r=i.createContext(a);function s(e){const t=i.useContext(r);return i.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),i.createElement(r.Provider,{value:t},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[61546],{1504:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>c,contentTitle:()=>s,default:()=>u,frontMatter:()=>r,metadata:()=>o,toc:()=>l});var i=n(62540),a=n(43023);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:"Defined in",id:"defined-in",level:2}];function d(e){const t={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",strong:"strong",...(0,a.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(t.header,{children:(0,i.jsx)(t.h1,{id:"variable-statusbaralignright",children:"Variable: StatusBarAlignRight"})}),"\n",(0,i.jsxs)(t.blockquote,{children:["\n",(0,i.jsxs)(t.p,{children:[(0,i.jsx)(t.code,{children:"const"})," ",(0,i.jsx)(t.strong,{children:"StatusBarAlignRight"}),": ",(0,i.jsx)(t.code,{children:'"RIGHT"'})," = ",(0,i.jsx)(t.code,{children:"'RIGHT'"})]}),"\n"]}),"\n",(0,i.jsx)(t.p,{children:"Aligned to the right side."}),"\n",(0,i.jsx)(t.h2,{id:"defined-in",children:"Defined in"}),"\n",(0,i.jsx)(t.p,{children:(0,i.jsx)(t.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L1487",children:"packages/extension-api/src/extension-api.d.ts:1487"})})]})}function u(e={}){const{wrapper:t}={...(0,a.R)(),...e.components};return t?(0,i.jsx)(t,{...e,children:(0,i.jsx)(d,{...e})}):d(e)}},43023:(e,t,n)=>{n.d(t,{R:()=>s,x:()=>o});var i=n(63696);const a={},r=i.createContext(a);function s(e){const t=i.useContext(r);return i.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),i.createElement(r.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/b5ec5208.490505ac.js b/assets/js/b5ec5208.95cb4890.js similarity index 98% rename from assets/js/b5ec5208.490505ac.js rename to assets/js/b5ec5208.95cb4890.js index 75b847ea974..a499e6a400a 100644 --- a/assets/js/b5ec5208.490505ac.js +++ b/assets/js/b5ec5208.95cb4890.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[57577],{66095:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>a,contentTitle:()=>d,default:()=>p,frontMatter:()=>t,metadata:()=>o,toc:()=>c});var i=s(62540),r=s(43023);const t={},d="Function: onDidUpdateProvider()",o={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:"proxy",permalink:"/api/namespaces/proxy/"}},a={},c=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Defined in",id:"defined-in",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",strong:"strong",...(0,r.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.header,{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:"defined-in",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L832",children:"packages/extension-api/src/extension-api.d.ts:832"})})]})}function p(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},43023:(e,n,s)=>{s.d(n,{R:()=>d,x:()=>o});var i=s(63696);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 o(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 +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[57577],{66095:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>a,contentTitle:()=>d,default:()=>p,frontMatter:()=>t,metadata:()=>o,toc:()=>c});var i=s(62540),r=s(43023);const t={},d="Function: onDidUpdateProvider()",o={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:"proxy",permalink:"/api/namespaces/proxy/"}},a={},c=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Defined in",id:"defined-in",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",strong:"strong",...(0,r.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.header,{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:"defined-in",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L832",children:"packages/extension-api/src/extension-api.d.ts:832"})})]})}function p(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},43023:(e,n,s)=>{s.d(n,{R:()=>d,x:()=>o});var i=s(63696);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 o(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/b66ca8cf.d727b1fa.js b/assets/js/b66ca8cf.8d6552ea.js similarity index 98% rename from assets/js/b66ca8cf.d727b1fa.js rename to assets/js/b66ca8cf.8d6552ea.js index b577e71fd06..a9b98117269 100644 --- a/assets/js/b66ca8cf.d727b1fa.js +++ b/assets/js/b66ca8cf.8d6552ea.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[20286],{92116:(e,s,n)=>{n.r(s),n.d(s,{assets:()=>a,contentTitle:()=>c,default:()=>h,frontMatter:()=>t,metadata:()=>o,toc:()=>d});var i=n(62540),r=n(43023);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:"Defined in",id:"defined-in",level:2}];function l(e){const s={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",strong:"strong",...(0,r.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(s.header,{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:"defined-in",children:"Defined in"}),"\n",(0,i.jsx)(s.p,{children:(0,i.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L933",children:"packages/extension-api/src/extension-api.d.ts:933"})})]})}function h(e={}){const{wrapper:s}={...(0,r.R)(),...e.components};return s?(0,i.jsx)(s,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},43023:(e,s,n)=>{n.d(s,{R:()=>c,x:()=>o});var i=n(63696);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([[20286],{92116:(e,s,n)=>{n.r(s),n.d(s,{assets:()=>a,contentTitle:()=>c,default:()=>h,frontMatter:()=>t,metadata:()=>o,toc:()=>d});var i=n(62540),r=n(43023);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:"Defined in",id:"defined-in",level:2}];function l(e){const s={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",strong:"strong",...(0,r.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(s.header,{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:"defined-in",children:"Defined in"}),"\n",(0,i.jsx)(s.p,{children:(0,i.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L933",children:"packages/extension-api/src/extension-api.d.ts:933"})})]})}function h(e={}){const{wrapper:s}={...(0,r.R)(),...e.components};return s?(0,i.jsx)(s,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},43023:(e,s,n)=>{n.d(s,{R:()=>c,x:()=>o});var i=n(63696);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.d3fffd51.js b/assets/js/b678a236.055e83f6.js similarity index 96% rename from assets/js/b678a236.d3fffd51.js rename to assets/js/b678a236.055e83f6.js index 4185847ea55..9e84789adb2 100644 --- a/assets/js/b678a236.d3fffd51.js +++ b/assets/js/b678a236.055e83f6.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[19060],{18730:(n,e,t)=>{t.r(e),t.d(e,{assets:()=>c,contentTitle:()=>r,default:()=>l,frontMatter:()=>o,metadata:()=>a,toc:()=>d});var i=t(62540),s=t(43023);const o={},r="Function: stopContainer()",a={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"}},c={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Defined in",id:"defined-in",level:2}];function p(n){const e={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",strong:"strong",...(0,s.R)(),...n.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(e.header,{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:"defined-in",children:"Defined in"}),"\n",(0,i.jsx)(e.p,{children:(0,i.jsx)(e.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L3539",children:"packages/extension-api/src/extension-api.d.ts:3539"})})]})}function l(n={}){const{wrapper:e}={...(0,s.R)(),...n.components};return e?(0,i.jsx)(e,{...n,children:(0,i.jsx)(p,{...n})}):p(n)}},43023:(n,e,t)=>{t.d(e,{R:()=>r,x:()=>a});var i=t(63696);const s={},o=i.createContext(s);function r(n){const e=i.useContext(o);return i.useMemo((function(){return"function"==typeof n?n(e):{...e,...n}}),[e,n])}function a(n){let e;return e=n.disableParentContext?"function"==typeof n.components?n.components(s):n.components||s:r(n.components),i.createElement(o.Provider,{value:e},n.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[19060],{18730:(n,e,t)=>{t.r(e),t.d(e,{assets:()=>c,contentTitle:()=>r,default:()=>l,frontMatter:()=>o,metadata:()=>a,toc:()=>d});var i=t(62540),s=t(43023);const o={},r="Function: stopContainer()",a={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"}},c={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Defined in",id:"defined-in",level:2}];function p(n){const e={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",strong:"strong",...(0,s.R)(),...n.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(e.header,{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:"defined-in",children:"Defined in"}),"\n",(0,i.jsx)(e.p,{children:(0,i.jsx)(e.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L3539",children:"packages/extension-api/src/extension-api.d.ts:3539"})})]})}function l(n={}){const{wrapper:e}={...(0,s.R)(),...n.components};return e?(0,i.jsx)(e,{...n,children:(0,i.jsx)(p,{...n})}):p(n)}},43023:(n,e,t)=>{t.d(e,{R:()=>r,x:()=>a});var i=t(63696);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/b6be2912.a0c05ecd.js b/assets/js/b6be2912.7fed9541.js similarity index 98% rename from assets/js/b6be2912.a0c05ecd.js rename to assets/js/b6be2912.7fed9541.js index edcc84dee1c..45e4f8b2349 100644 --- a/assets/js/b6be2912.a0c05ecd.js +++ b/assets/js/b6be2912.7fed9541.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[95322],{44660:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>c,contentTitle:()=>o,default:()=>l,frontMatter:()=>r,metadata:()=>a,toc:()=>d});var i=s(62540),t=s(43023);const r={},o="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:"Defined in",id:"defined-in",level:2}];function h(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",strong:"strong",...(0,t.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.header,{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:"defined-in",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L1903",children:"packages/extension-api/src/extension-api.d.ts:1903"})})]})}function l(e={}){const{wrapper:n}={...(0,t.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(h,{...e})}):h(e)}},43023:(e,n,s)=>{s.d(n,{R:()=>o,x:()=>a});var i=s(63696);const t={},r=i.createContext(t);function o(e){const n=i.useContext(r);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function a(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:o(e.components),i.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[95322],{44660:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>c,contentTitle:()=>o,default:()=>l,frontMatter:()=>r,metadata:()=>a,toc:()=>d});var i=s(62540),t=s(43023);const r={},o="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:"Defined in",id:"defined-in",level:2}];function h(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",strong:"strong",...(0,t.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.header,{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:"defined-in",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L1903",children:"packages/extension-api/src/extension-api.d.ts:1903"})})]})}function l(e={}){const{wrapper:n}={...(0,t.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(h,{...e})}):h(e)}},43023:(e,n,s)=>{s.d(n,{R:()=>o,x:()=>a});var i=s(63696);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/b6d76a6c.34b8fc90.js b/assets/js/b6d76a6c.7b897eb5.js similarity index 98% rename from assets/js/b6d76a6c.34b8fc90.js rename to assets/js/b6d76a6c.7b897eb5.js index c9178d18f3e..e2c36e6d82c 100644 --- a/assets/js/b6d76a6c.34b8fc90.js +++ b/assets/js/b6d76a6c.7b897eb5.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[36574],{92497:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>c,contentTitle:()=>r,default:()=>h,frontMatter:()=>a,metadata:()=>o,toc:()=>d});var i=s(62540),t=s(43023);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:"Defined in",id:"defined-in",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",strong:"strong",...(0,t.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.header,{children:(0,i.jsx)(n.h1,{id:"function-ondidstatechange",children:"Function: onDidStateChange()"})}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"onDidStateChange"}),"(",(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:"defined-in",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L881",children:"packages/extension-api/src/extension-api.d.ts:881"})})]})}function h(e={}){const{wrapper:n}={...(0,t.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},43023:(e,n,s)=>{s.d(n,{R:()=>r,x:()=>o});var i=s(63696);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 +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[36574],{92497:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>c,contentTitle:()=>r,default:()=>h,frontMatter:()=>a,metadata:()=>o,toc:()=>d});var i=s(62540),t=s(43023);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:"Defined in",id:"defined-in",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",strong:"strong",...(0,t.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.header,{children:(0,i.jsx)(n.h1,{id:"function-ondidstatechange",children:"Function: onDidStateChange()"})}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"onDidStateChange"}),"(",(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:"defined-in",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L881",children:"packages/extension-api/src/extension-api.d.ts:881"})})]})}function h(e={}){const{wrapper:n}={...(0,t.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},43023:(e,n,s)=>{s.d(n,{R:()=>r,x:()=>o});var i=s(63696);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/b7bb2d93.65b06945.js b/assets/js/b7bb2d93.6411161e.js similarity index 96% rename from assets/js/b7bb2d93.65b06945.js rename to assets/js/b7bb2d93.6411161e.js index 7592def71dd..bc1fe21023e 100644 --- a/assets/js/b7bb2d93.65b06945.js +++ b/assets/js/b7bb2d93.6411161e.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[84052],{46249:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>d,contentTitle:()=>r,default:()=>p,frontMatter:()=>o,metadata:()=>a,toc:()=>c});var t=i(62540),s=i(43023);const o={},r="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"}},d={},c=[{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:"Defined in",id:"defined-in",level:4},{value:"TASK_WIDGET",id:"task_widget",level:3},{value:"Defined in",id:"defined-in-1",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",del:"del",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",p:"p",strong:"strong",...(0,s.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.header,{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:"defined-in",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L1043",children:"packages/extension-api/src/extension-api.d.ts:1043"})}),"\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:"defined-in-1",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L1048",children:"packages/extension-api/src/extension-api.d.ts:1048"})})]})}function p(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},43023:(e,n,i)=>{i.d(n,{R:()=>r,x:()=>a});var t=i(63696);const s={},o=t.createContext(s);function r(e){const n=t.useContext(o);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function a(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:r(e.components),t.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[84052],{46249:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>d,contentTitle:()=>r,default:()=>p,frontMatter:()=>o,metadata:()=>a,toc:()=>c});var t=i(62540),s=i(43023);const o={},r="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"}},d={},c=[{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:"Defined in",id:"defined-in",level:4},{value:"TASK_WIDGET",id:"task_widget",level:3},{value:"Defined in",id:"defined-in-1",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",del:"del",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",p:"p",strong:"strong",...(0,s.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.header,{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:"defined-in",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L1043",children:"packages/extension-api/src/extension-api.d.ts:1043"})}),"\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:"defined-in-1",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L1048",children:"packages/extension-api/src/extension-api.d.ts:1048"})})]})}function p(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},43023:(e,n,i)=>{i.d(n,{R:()=>r,x:()=>a});var t=i(63696);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/b8eb0fce.364429a9.js b/assets/js/b8eb0fce.64c93e56.js similarity index 98% rename from assets/js/b8eb0fce.364429a9.js rename to assets/js/b8eb0fce.64c93e56.js index ba719cb6a56..e99b81d6ff1 100644 --- a/assets/js/b8eb0fce.364429a9.js +++ b/assets/js/b8eb0fce.64c93e56.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[80042],{9219:(e,s,n)=>{n.r(s),n.d(s,{assets:()=>a,contentTitle:()=>c,default:()=>h,frontMatter:()=>t,metadata:()=>o,toc:()=>d});var i=n(62540),r=n(43023);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:"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:"Defined in",id:"defined-in",level:2}];function l(e){const s={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",strong:"strong",...(0,r.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(s.header,{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:"defined-in",children:"Defined in"}),"\n",(0,i.jsx)(s.p,{children:(0,i.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L931",children:"packages/extension-api/src/extension-api.d.ts:931"})})]})}function h(e={}){const{wrapper:s}={...(0,r.R)(),...e.components};return s?(0,i.jsx)(s,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},43023:(e,s,n)=>{n.d(s,{R:()=>c,x:()=>o});var i=n(63696);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([[80042],{9219:(e,s,n)=>{n.r(s),n.d(s,{assets:()=>a,contentTitle:()=>c,default:()=>h,frontMatter:()=>t,metadata:()=>o,toc:()=>d});var i=n(62540),r=n(43023);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:"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:"Defined in",id:"defined-in",level:2}];function l(e){const s={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",strong:"strong",...(0,r.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(s.header,{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:"defined-in",children:"Defined in"}),"\n",(0,i.jsx)(s.p,{children:(0,i.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L931",children:"packages/extension-api/src/extension-api.d.ts:931"})})]})}function h(e={}){const{wrapper:s}={...(0,r.R)(),...e.components};return s?(0,i.jsx)(s,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},43023:(e,s,n)=>{n.d(s,{R:()=>c,x:()=>o});var i=n(63696);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.d63076a1.js b/assets/js/b8ec852b.b3f3d307.js similarity index 94% rename from assets/js/b8ec852b.d63076a1.js rename to assets/js/b8ec852b.b3f3d307.js index eaaf17c9943..f3136220261 100644 --- a/assets/js/b8ec852b.d63076a1.js +++ b/assets/js/b8ec852b.b3f3d307.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[14036],{13326:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>a,contentTitle:()=>r,default:()=>h,frontMatter:()=>t,metadata:()=>c,toc:()=>l});var s=i(62540),o=i(43023);const t={},r="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:"Defined in",id:"defined-in",level:4},{value:"location",id:"location",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"title?",id:"title",level:3},{value:"Defined in",id:"defined-in-2",level:4}];function d(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",p:"p",strong:"strong",...(0,o.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.header,{children:(0,s.jsx)(n.h1,{id:"interface-progressoptions",children:"Interface: ProgressOptions"})}),"\n",(0,s.jsx)(n.p,{children:"Value-object describing where and how progress should show."}),"\n",(0,s.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,s.jsx)(n.h3,{id:"cancellable",children:"cancellable?"}),"\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:"cancellable"}),": ",(0,s.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,s.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,s.jsx)(n.code,{children:"ProgressLocation.Notification"})," is supporting to show a cancel\nbutton."]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L1072",children:"packages/extension-api/src/extension-api.d.ts:1072"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"location",children:"location"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"location"}),": ",(0,s.jsx)(n.a,{href:"/api/enumerations/ProgressLocation",children:(0,s.jsx)(n.code,{children:"ProgressLocation"})})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The location at which progress should show."}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L1058",children:"packages/extension-api/src/extension-api.d.ts:1058"})}),"\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:"A human-readable string which will be used to describe the\noperation."}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-2",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L1064",children:"packages/extension-api/src/extension-api.d.ts:1064"})})]})}function h(e={}){const{wrapper:n}={...(0,o.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(d,{...e})}):d(e)}},43023:(e,n,i)=>{i.d(n,{R:()=>r,x:()=>c});var s=i(63696);const o={},t=s.createContext(o);function r(e){const n=s.useContext(t);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:r(e.components),s.createElement(t.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[14036],{13326:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>a,contentTitle:()=>r,default:()=>h,frontMatter:()=>t,metadata:()=>c,toc:()=>l});var s=i(62540),o=i(43023);const t={},r="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:"Defined in",id:"defined-in",level:4},{value:"location",id:"location",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"title?",id:"title",level:3},{value:"Defined in",id:"defined-in-2",level:4}];function d(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",p:"p",strong:"strong",...(0,o.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.header,{children:(0,s.jsx)(n.h1,{id:"interface-progressoptions",children:"Interface: ProgressOptions"})}),"\n",(0,s.jsx)(n.p,{children:"Value-object describing where and how progress should show."}),"\n",(0,s.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,s.jsx)(n.h3,{id:"cancellable",children:"cancellable?"}),"\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:"cancellable"}),": ",(0,s.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,s.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,s.jsx)(n.code,{children:"ProgressLocation.Notification"})," is supporting to show a cancel\nbutton."]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L1072",children:"packages/extension-api/src/extension-api.d.ts:1072"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"location",children:"location"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"location"}),": ",(0,s.jsx)(n.a,{href:"/api/enumerations/ProgressLocation",children:(0,s.jsx)(n.code,{children:"ProgressLocation"})})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The location at which progress should show."}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L1058",children:"packages/extension-api/src/extension-api.d.ts:1058"})}),"\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:"A human-readable string which will be used to describe the\noperation."}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-2",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L1064",children:"packages/extension-api/src/extension-api.d.ts:1064"})})]})}function h(e={}){const{wrapper:n}={...(0,o.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(d,{...e})}):d(e)}},43023:(e,n,i)=>{i.d(n,{R:()=>r,x:()=>c});var s=i(63696);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/b9287eb6.7b0189d4.js b/assets/js/b9287eb6.2a392b76.js similarity index 91% rename from assets/js/b9287eb6.7b0189d4.js rename to assets/js/b9287eb6.2a392b76.js index 54fa062faff..b250bec3158 100644 --- a/assets/js/b9287eb6.7b0189d4.js +++ b/assets/js/b9287eb6.2a392b76.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[25774],{86888:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>c,contentTitle:()=>r,default:()=>p,frontMatter:()=>a,metadata:()=>d,toc:()=>o});var i=s(62540),t=s(43023);const a={},r="Interface: CPUUsage",d={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"}},c={},o=[{value:"Properties",id:"properties",level:2},{value:"percpu_usage",id:"percpu_usage",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"total_usage",id:"total_usage",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"usage_in_kernelmode",id:"usage_in_kernelmode",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"usage_in_usermode",id:"usage_in_usermode",level:3},{value:"Defined in",id:"defined-in-3",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",p:"p",strong:"strong",...(0,t.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.header,{children:(0,i.jsx)(n.h1,{id:"interface-cpuusage",children:"Interface: CPUUsage"})}),"\n",(0,i.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(n.h3,{id:"percpu_usage",children:"percpu_usage"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"percpu_usage"}),": ",(0,i.jsx)(n.code,{children:"number"}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L3153",children:"packages/extension-api/src/extension-api.d.ts:3153"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"total_usage",children:"total_usage"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"total_usage"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L3155",children:"packages/extension-api/src/extension-api.d.ts:3155"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"usage_in_kernelmode",children:"usage_in_kernelmode"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"usage_in_kernelmode"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"defined-in-2",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L3156",children:"packages/extension-api/src/extension-api.d.ts:3156"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"usage_in_usermode",children:"usage_in_usermode"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"usage_in_usermode"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"defined-in-3",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L3154",children:"packages/extension-api/src/extension-api.d.ts:3154"})})]})}function p(e={}){const{wrapper:n}={...(0,t.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},43023:(e,n,s)=>{s.d(n,{R:()=>r,x:()=>d});var i=s(63696);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 d(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([[25774],{86888:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>c,contentTitle:()=>r,default:()=>p,frontMatter:()=>a,metadata:()=>d,toc:()=>o});var i=s(62540),t=s(43023);const a={},r="Interface: CPUUsage",d={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"}},c={},o=[{value:"Properties",id:"properties",level:2},{value:"percpu_usage",id:"percpu_usage",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"total_usage",id:"total_usage",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"usage_in_kernelmode",id:"usage_in_kernelmode",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"usage_in_usermode",id:"usage_in_usermode",level:3},{value:"Defined in",id:"defined-in-3",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",p:"p",strong:"strong",...(0,t.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.header,{children:(0,i.jsx)(n.h1,{id:"interface-cpuusage",children:"Interface: CPUUsage"})}),"\n",(0,i.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(n.h3,{id:"percpu_usage",children:"percpu_usage"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"percpu_usage"}),": ",(0,i.jsx)(n.code,{children:"number"}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L3153",children:"packages/extension-api/src/extension-api.d.ts:3153"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"total_usage",children:"total_usage"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"total_usage"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L3155",children:"packages/extension-api/src/extension-api.d.ts:3155"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"usage_in_kernelmode",children:"usage_in_kernelmode"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"usage_in_kernelmode"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"defined-in-2",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L3156",children:"packages/extension-api/src/extension-api.d.ts:3156"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"usage_in_usermode",children:"usage_in_usermode"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"usage_in_usermode"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"defined-in-3",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L3154",children:"packages/extension-api/src/extension-api.d.ts:3154"})})]})}function p(e={}){const{wrapper:n}={...(0,t.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},43023:(e,n,s)=>{s.d(n,{R:()=>r,x:()=>d});var i=s(63696);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 d(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/b9a87183.0daeccea.js b/assets/js/b9a87183.d355aa0e.js similarity index 93% rename from assets/js/b9a87183.0daeccea.js rename to assets/js/b9a87183.d355aa0e.js index d3dca16175f..43dbf50fc26 100644 --- a/assets/js/b9a87183.0daeccea.js +++ b/assets/js/b9a87183.d355aa0e.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[63156],{54060:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>c,contentTitle:()=>a,default:()=>l,frontMatter:()=>o,metadata:()=>s,toc:()=>d});var t=i(62540),r=i(43023);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:"Defined in",id:"defined-in",level:4},{value:"label",id:"label",level:3},{value:"Defined in",id:"defined-in-1",level:4}];function h(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",p:"p",strong:"strong",...(0,r.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.header,{children:(0,t.jsx)(n.h1,{id:"interface-authenticationproviderinformation",children:"Interface: AuthenticationProviderInformation"})}),"\n",(0,t.jsxs)(n.p,{children:["Basic information about 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:"id",children:"id"}),"\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:"id"}),": ",(0,t.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"The unique identifier of the authentication provider."}),"\n",(0,t.jsx)(n.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L3801",children:"packages/extension-api/src/extension-api.d.ts:3801"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"label",children:"label"}),"\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:"label"}),": ",(0,t.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"The human-readable name of the authentication provider."}),"\n",(0,t.jsx)(n.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L3806",children:"packages/extension-api/src/extension-api.d.ts:3806"})})]})}function l(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(h,{...e})}):h(e)}},43023:(e,n,i)=>{i.d(n,{R:()=>a,x:()=>s});var t=i(63696);const r={},o=t.createContext(r);function a(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:a(e.components),t.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[63156],{54060:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>c,contentTitle:()=>a,default:()=>l,frontMatter:()=>o,metadata:()=>s,toc:()=>d});var t=i(62540),r=i(43023);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:"Defined in",id:"defined-in",level:4},{value:"label",id:"label",level:3},{value:"Defined in",id:"defined-in-1",level:4}];function h(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",p:"p",strong:"strong",...(0,r.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.header,{children:(0,t.jsx)(n.h1,{id:"interface-authenticationproviderinformation",children:"Interface: AuthenticationProviderInformation"})}),"\n",(0,t.jsxs)(n.p,{children:["Basic information about 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:"id",children:"id"}),"\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:"id"}),": ",(0,t.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"The unique identifier of the authentication provider."}),"\n",(0,t.jsx)(n.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L3801",children:"packages/extension-api/src/extension-api.d.ts:3801"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"label",children:"label"}),"\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:"label"}),": ",(0,t.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"The human-readable name of the authentication provider."}),"\n",(0,t.jsx)(n.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L3806",children:"packages/extension-api/src/extension-api.d.ts:3806"})})]})}function l(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(h,{...e})}):h(e)}},43023:(e,n,i)=>{i.d(n,{R:()=>a,x:()=>s});var t=i(63696);const r={},o=t.createContext(r);function a(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:a(e.components),t.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/bab44fba.ef465356.js b/assets/js/bab44fba.82b72770.js similarity index 98% rename from assets/js/bab44fba.ef465356.js rename to assets/js/bab44fba.82b72770.js index a8a54249f80..bbab77ba28f 100644 --- a/assets/js/bab44fba.ef465356.js +++ b/assets/js/bab44fba.82b72770.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[34939],{59208:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>a,contentTitle:()=>c,default:()=>h,frontMatter:()=>t,metadata:()=>o,toc:()=>d});var i=r(62540),s=r(43023);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:"Defined in",id:"defined-in",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",header:"header",p:"p",strong:"strong",...(0,s.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.header,{children:(0,i.jsx)(n.h1,{id:"function-replicatepodmancontainer",children:"Function: replicatePodmanContainer()"})}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"replicatePodmanContainer"}),"(",(0,i.jsx)(n.code,{children:"source"}),", ",(0,i.jsx)(n.code,{children:"target"}),", ",(0,i.jsx)(n.code,{children:"overrideParameters"}),"): ",(0,i.jsx)(n.code,{children:"Promise"}),"<",(0,i.jsx)(n.code,{children:"object"}),">"]}),"\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:"source"})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"source.engineId"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"source.id"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"target"})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"target.engineId"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"overrideParameters"}),": ",(0,i.jsx)(n.a,{href:"/api/interfaces/PodmanContainerCreateOptions",children:(0,i.jsx)(n.code,{children:"PodmanContainerCreateOptions"})})]}),"\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:"object"}),">"]}),"\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.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.h2,{id:"defined-in",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L3681",children:"packages/extension-api/src/extension-api.d.ts:3681"})})]})}function h(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},43023:(e,n,r)=>{r.d(n,{R:()=>c,x:()=>o});var i=r(63696);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 o(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 +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[34939],{59208:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>a,contentTitle:()=>c,default:()=>h,frontMatter:()=>t,metadata:()=>o,toc:()=>d});var i=r(62540),s=r(43023);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:"Defined in",id:"defined-in",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",header:"header",p:"p",strong:"strong",...(0,s.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.header,{children:(0,i.jsx)(n.h1,{id:"function-replicatepodmancontainer",children:"Function: replicatePodmanContainer()"})}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"replicatePodmanContainer"}),"(",(0,i.jsx)(n.code,{children:"source"}),", ",(0,i.jsx)(n.code,{children:"target"}),", ",(0,i.jsx)(n.code,{children:"overrideParameters"}),"): ",(0,i.jsx)(n.code,{children:"Promise"}),"<",(0,i.jsx)(n.code,{children:"object"}),">"]}),"\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:"source"})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"source.engineId"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"source.id"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"target"})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"target.engineId"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"overrideParameters"}),": ",(0,i.jsx)(n.a,{href:"/api/interfaces/PodmanContainerCreateOptions",children:(0,i.jsx)(n.code,{children:"PodmanContainerCreateOptions"})})]}),"\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:"object"}),">"]}),"\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.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.h2,{id:"defined-in",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L3681",children:"packages/extension-api/src/extension-api.d.ts:3681"})})]})}function h(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},43023:(e,n,r)=>{r.d(n,{R:()=>c,x:()=>o});var i=r(63696);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 o(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/bb6a5560.a5e5c2c0.js b/assets/js/bb6a5560.8d259dee.js similarity index 95% rename from assets/js/bb6a5560.a5e5c2c0.js rename to assets/js/bb6a5560.8d259dee.js index 3cb15142d3e..5a1d25c3bf5 100644 --- a/assets/js/bb6a5560.a5e5c2c0.js +++ b/assets/js/bb6a5560.8d259dee.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[40304],{85343:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>o,default:()=>x,frontMatter:()=>r,metadata:()=>c,toc:()=>d});var s=t(62540),i=t(43023);const r={},o="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:"proxy",permalink:"/api/namespaces/proxy/"},next:{title:"isEnabled",permalink:"/api/namespaces/proxy/functions/isEnabled"}},a={},d=[{value:"Returns",id:"returns",level:2},{value:"Defined in",id:"defined-in",level:2}];function p(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",strong:"strong",...(0,i.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.header,{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:"defined-in",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L874",children:"packages/extension-api/src/extension-api.d.ts:874"})})]})}function x(e={}){const{wrapper:n}={...(0,i.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(p,{...e})}):p(e)}},43023:(e,n,t)=>{t.d(n,{R:()=>o,x:()=>c});var s=t(63696);const i={},r=s.createContext(i);function o(e){const n=s.useContext(r);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:o(e.components),s.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[40304],{85343:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>o,default:()=>x,frontMatter:()=>r,metadata:()=>c,toc:()=>d});var s=t(62540),i=t(43023);const r={},o="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:"proxy",permalink:"/api/namespaces/proxy/"},next:{title:"isEnabled",permalink:"/api/namespaces/proxy/functions/isEnabled"}},a={},d=[{value:"Returns",id:"returns",level:2},{value:"Defined in",id:"defined-in",level:2}];function p(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",strong:"strong",...(0,i.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.header,{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:"defined-in",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L874",children:"packages/extension-api/src/extension-api.d.ts:874"})})]})}function x(e={}){const{wrapper:n}={...(0,i.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(p,{...e})}):p(e)}},43023:(e,n,t)=>{t.d(n,{R:()=>o,x:()=>c});var s=t(63696);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/bd45720e.cf859d8c.js b/assets/js/bd45720e.afef7707.js similarity index 95% rename from assets/js/bd45720e.cf859d8c.js rename to assets/js/bd45720e.afef7707.js index 5f64762dcdc..a897dbcd13d 100644 --- a/assets/js/bd45720e.cf859d8c.js +++ b/assets/js/bd45720e.afef7707.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[14330],{98419:(n,e,t)=>{t.r(e),t.d(e,{assets:()=>c,contentTitle:()=>s,default:()=>u,frontMatter:()=>o,metadata:()=>r,toc:()=>d});var i=t(62540),a=t(43023);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:"Defined in",id:"defined-in",level:2}];function l(n){const e={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",strong:"strong",...(0,a.R)(),...n.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(e.header,{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:"defined-in",children:"Defined in"}),"\n",(0,i.jsx)(e.p,{children:(0,i.jsx)(e.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L4500",children:"packages/extension-api/src/extension-api.d.ts:4500"})})]})}function u(n={}){const{wrapper:e}={...(0,a.R)(),...n.components};return e?(0,i.jsx)(e,{...n,children:(0,i.jsx)(l,{...n})}):l(n)}},43023:(n,e,t)=>{t.d(e,{R:()=>s,x:()=>r});var i=t(63696);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([[14330],{98419:(n,e,t)=>{t.r(e),t.d(e,{assets:()=>c,contentTitle:()=>s,default:()=>u,frontMatter:()=>o,metadata:()=>r,toc:()=>d});var i=t(62540),a=t(43023);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:"Defined in",id:"defined-in",level:2}];function l(n){const e={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",strong:"strong",...(0,a.R)(),...n.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(e.header,{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:"defined-in",children:"Defined in"}),"\n",(0,i.jsx)(e.p,{children:(0,i.jsx)(e.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L4500",children:"packages/extension-api/src/extension-api.d.ts:4500"})})]})}function u(n={}){const{wrapper:e}={...(0,a.R)(),...n.components};return e?(0,i.jsx)(e,{...n,children:(0,i.jsx)(l,{...n})}):l(n)}},43023:(n,e,t)=>{t.d(e,{R:()=>s,x:()=>r});var i=t(63696);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.9cc2dee0.js b/assets/js/bd65ec7e.e77223c6.js similarity index 98% rename from assets/js/bd65ec7e.9cc2dee0.js rename to assets/js/bd65ec7e.e77223c6.js index 6bc0d5af30f..20f70ad36d7 100644 --- a/assets/js/bd65ec7e.9cc2dee0.js +++ b/assets/js/bd65ec7e.e77223c6.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[15910],{62101:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>a,contentTitle:()=>o,default:()=>l,frontMatter:()=>c,metadata:()=>i,toc:()=>d});var t=s(62540),r=s(43023);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:"kubernetes",permalink:"/api/namespaces/kubernetes/"},next:{title:"getKubeconfig",permalink:"/api/namespaces/kubernetes/functions/getKubeconfig"}},a={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Defined in",id:"defined-in",level:2}];function u(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",strong:"strong",...(0,r.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.header,{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:"defined-in",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2113",children:"packages/extension-api/src/extension-api.d.ts:2113"})})]})}function l(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(u,{...e})}):u(e)}},43023:(e,n,s)=>{s.d(n,{R:()=>o,x:()=>i});var t=s(63696);const r={},c=t.createContext(r);function o(e){const n=t.useContext(c);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function i(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:o(e.components),t.createElement(c.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[15910],{62101:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>a,contentTitle:()=>o,default:()=>l,frontMatter:()=>c,metadata:()=>i,toc:()=>d});var t=s(62540),r=s(43023);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:"kubernetes",permalink:"/api/namespaces/kubernetes/"},next:{title:"getKubeconfig",permalink:"/api/namespaces/kubernetes/functions/getKubeconfig"}},a={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Defined in",id:"defined-in",level:2}];function u(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",strong:"strong",...(0,r.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.header,{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:"defined-in",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2113",children:"packages/extension-api/src/extension-api.d.ts:2113"})})]})}function l(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(u,{...e})}):u(e)}},43023:(e,n,s)=>{s.d(n,{R:()=>o,x:()=>i});var t=s(63696);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.20bd8559.js b/assets/js/bdb8b81b.f58a86c3.js similarity index 89% rename from assets/js/bdb8b81b.20bd8559.js rename to assets/js/bdb8b81b.f58a86c3.js index 9f2e412b64d..a70e2df7dc0 100644 --- a/assets/js/bdb8b81b.20bd8559.js +++ b/assets/js/bdb8b81b.f58a86c3.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[52276],{6593:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>o,contentTitle:()=>a,default:()=>h,frontMatter:()=>r,metadata:()=>d,toc:()=>c});var t=i(62540),s=i(43023);const r={},a="Interface: StorageStats",d={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"}},o={},c=[{value:"Properties",id:"properties",level:2},{value:"read_count_normalized?",id:"read_count_normalized",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"read_size_bytes?",id:"read_size_bytes",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"write_count_normalized?",id:"write_count_normalized",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"write_size_bytes?",id:"write_size_bytes",level:3},{value:"Defined in",id:"defined-in-3",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",p:"p",strong:"strong",...(0,s.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.header,{children:(0,t.jsx)(n.h1,{id:"interface-storagestats",children:"Interface: StorageStats"})}),"\n",(0,t.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,t.jsx)(n.h3,{id:"read_count_normalized",children:"read_count_normalized?"}),"\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:"read_count_normalized"}),": ",(0,t.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L3087",children:"packages/extension-api/src/extension-api.d.ts:3087"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"read_size_bytes",children:"read_size_bytes?"}),"\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:"read_size_bytes"}),": ",(0,t.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L3088",children:"packages/extension-api/src/extension-api.d.ts:3088"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"write_count_normalized",children:"write_count_normalized?"}),"\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:"write_count_normalized"}),": ",(0,t.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"defined-in-2",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L3089",children:"packages/extension-api/src/extension-api.d.ts:3089"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"write_size_bytes",children:"write_size_bytes?"}),"\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:"write_size_bytes"}),": ",(0,t.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"defined-in-3",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L3090",children:"packages/extension-api/src/extension-api.d.ts:3090"})})]})}function h(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},43023:(e,n,i)=>{i.d(n,{R:()=>a,x:()=>d});var t=i(63696);const s={},r=t.createContext(s);function a(e){const n=t.useContext(r);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function d(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:a(e.components),t.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[52276],{6593:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>o,contentTitle:()=>a,default:()=>h,frontMatter:()=>r,metadata:()=>d,toc:()=>c});var t=i(62540),s=i(43023);const r={},a="Interface: StorageStats",d={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"}},o={},c=[{value:"Properties",id:"properties",level:2},{value:"read_count_normalized?",id:"read_count_normalized",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"read_size_bytes?",id:"read_size_bytes",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"write_count_normalized?",id:"write_count_normalized",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"write_size_bytes?",id:"write_size_bytes",level:3},{value:"Defined in",id:"defined-in-3",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",p:"p",strong:"strong",...(0,s.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.header,{children:(0,t.jsx)(n.h1,{id:"interface-storagestats",children:"Interface: StorageStats"})}),"\n",(0,t.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,t.jsx)(n.h3,{id:"read_count_normalized",children:"read_count_normalized?"}),"\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:"read_count_normalized"}),": ",(0,t.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L3087",children:"packages/extension-api/src/extension-api.d.ts:3087"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"read_size_bytes",children:"read_size_bytes?"}),"\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:"read_size_bytes"}),": ",(0,t.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L3088",children:"packages/extension-api/src/extension-api.d.ts:3088"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"write_count_normalized",children:"write_count_normalized?"}),"\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:"write_count_normalized"}),": ",(0,t.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"defined-in-2",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L3089",children:"packages/extension-api/src/extension-api.d.ts:3089"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"write_size_bytes",children:"write_size_bytes?"}),"\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:"write_size_bytes"}),": ",(0,t.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"defined-in-3",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L3090",children:"packages/extension-api/src/extension-api.d.ts:3090"})})]})}function h(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},43023:(e,n,i)=>{i.d(n,{R:()=>a,x:()=>d});var t=i(63696);const s={},r=t.createContext(s);function a(e){const n=t.useContext(r);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function d(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:a(e.components),t.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/be228752.52191fac.js b/assets/js/be228752.7eb623cd.js similarity index 83% rename from assets/js/be228752.52191fac.js rename to assets/js/be228752.7eb623cd.js index 6e4fe05aef0..3b480f6d411 100644 --- a/assets/js/be228752.52191fac.js +++ b/assets/js/be228752.7eb623cd.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[12286],{48671:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>c,contentTitle:()=>a,default:()=>p,frontMatter:()=>o,metadata:()=>r,toc:()=>d});var t=i(62540),s=i(43023);const o={},a="Function: navigateToPod()",r={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"}},c={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Defined in",id:"defined-in",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",strong:"strong",...(0,s.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.header,{children:(0,t.jsx)(n.h1,{id:"function-navigatetopod",children:"Function: navigateToPod()"})}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"navigateToPod"}),"(",(0,t.jsx)(n.code,{children:"kind"}),", ",(0,t.jsx)(n.code,{children:"name"}),", ",(0,t.jsx)(n.code,{children:"engineId"}),"): ",(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:"kind"}),": ",(0,t.jsx)(n.code,{children:"string"})]}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"name"}),": ",(0,t.jsx)(n.code,{children:"string"})]}),"\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.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:"defined-in",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L4521",children:"packages/extension-api/src/extension-api.d.ts:4521"})})]})}function p(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},43023:(e,n,i)=>{i.d(n,{R:()=>a,x:()=>r});var t=i(63696);const s={},o=t.createContext(s);function a(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:a(e.components),t.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[12286],{48671:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>r,contentTitle:()=>a,default:()=>p,frontMatter:()=>o,metadata:()=>c,toc:()=>d});var t=i(62540),s=i(43023);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:"Defined in",id:"defined-in",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",strong:"strong",...(0,s.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.header,{children:(0,t.jsx)(n.h1,{id:"function-navigatetopod",children:"Function: navigateToPod()"})}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"navigateToPod"}),"(",(0,t.jsx)(n.code,{children:"kind"}),", ",(0,t.jsx)(n.code,{children:"name"}),", ",(0,t.jsx)(n.code,{children:"engineId"}),"): ",(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:"kind"}),": ",(0,t.jsx)(n.code,{children:"string"})]}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"name"}),": ",(0,t.jsx)(n.code,{children:"string"})]}),"\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.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:"defined-in",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L4521",children:"packages/extension-api/src/extension-api.d.ts:4521"})})]})}function p(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},43023:(e,n,i)=>{i.d(n,{R:()=>a,x:()=>c});var t=i(63696);const s={},o=t.createContext(s);function a(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:a(e.components),t.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/bf11c6a2.50f0e98e.js b/assets/js/bf11c6a2.cb4a288d.js similarity index 82% rename from assets/js/bf11c6a2.50f0e98e.js rename to assets/js/bf11c6a2.cb4a288d.js index 6638edf61fa..74870ab63df 100644 --- a/assets/js/bf11c6a2.50f0e98e.js +++ b/assets/js/bf11c6a2.cb4a288d.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[43307],{70666:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>c,contentTitle:()=>d,default:()=>h,frontMatter:()=>t,metadata:()=>a,toc:()=>o});var s=i(62540),r=i(43023);const t={},d="Interface: RegistryCreateOptions",a={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"}},c={},o=[{value:"Extended by",id:"extended-by",level:2},{value:"Properties",id:"properties",level:2},{value:"alias?",id:"alias",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"insecure?",id:"insecure",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"secret",id:"secret",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"serverUrl",id:"serverurl",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"username",id:"username",level:3},{value:"Defined in",id:"defined-in-4",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",li:"li",p:"p",strong:"strong",ul:"ul",...(0,r.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.header,{children:(0,s.jsx)(n.h1,{id:"interface-registrycreateoptions",children:"Interface: RegistryCreateOptions"})}),"\n",(0,s.jsx)(n.h2,{id:"extended-by",children:"Extended by"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.a,{href:"/api/interfaces/Registry",children:(0,s.jsx)(n.code,{children:"Registry"})})}),"\n"]}),"\n",(0,s.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,s.jsx)(n.h3,{id:"alias",children:"alias?"}),"\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:"alias"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L908",children:"packages/extension-api/src/extension-api.d.ts:908"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"insecure",children:"insecure?"}),"\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:"insecure"}),": ",(0,s.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L907",children:"packages/extension-api/src/extension-api.d.ts:907"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"secret",children:"secret"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"secret"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-2",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L906",children:"packages/extension-api/src/extension-api.d.ts:906"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"serverurl",children:"serverUrl"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"serverUrl"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-3",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L904",children:"packages/extension-api/src/extension-api.d.ts:904"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"username",children:"username"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"username"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-4",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L905",children:"packages/extension-api/src/extension-api.d.ts:905"})})]})}function h(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},43023:(e,n,i)=>{i.d(n,{R:()=>d,x:()=>a});var s=i(63696);const r={},t=s.createContext(r);function d(e){const n=s.useContext(t);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(r):e.components||r:d(e.components),s.createElement(t.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[43307],{70666:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>a,contentTitle:()=>d,default:()=>h,frontMatter:()=>t,metadata:()=>c,toc:()=>o});var s=i(62540),r=i(43023);const t={},d="Interface: RegistryCreateOptions",c={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={},o=[{value:"Extended by",id:"extended-by",level:2},{value:"Properties",id:"properties",level:2},{value:"alias?",id:"alias",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"insecure?",id:"insecure",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"secret",id:"secret",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"serverUrl",id:"serverurl",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"username",id:"username",level:3},{value:"Defined in",id:"defined-in-4",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",li:"li",p:"p",strong:"strong",ul:"ul",...(0,r.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.header,{children:(0,s.jsx)(n.h1,{id:"interface-registrycreateoptions",children:"Interface: RegistryCreateOptions"})}),"\n",(0,s.jsx)(n.h2,{id:"extended-by",children:"Extended by"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.a,{href:"/api/interfaces/Registry",children:(0,s.jsx)(n.code,{children:"Registry"})})}),"\n"]}),"\n",(0,s.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,s.jsx)(n.h3,{id:"alias",children:"alias?"}),"\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:"alias"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L908",children:"packages/extension-api/src/extension-api.d.ts:908"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"insecure",children:"insecure?"}),"\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:"insecure"}),": ",(0,s.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L907",children:"packages/extension-api/src/extension-api.d.ts:907"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"secret",children:"secret"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"secret"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-2",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L906",children:"packages/extension-api/src/extension-api.d.ts:906"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"serverurl",children:"serverUrl"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"serverUrl"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-3",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L904",children:"packages/extension-api/src/extension-api.d.ts:904"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"username",children:"username"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"username"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-4",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L905",children:"packages/extension-api/src/extension-api.d.ts:905"})})]})}function h(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},43023:(e,n,i)=>{i.d(n,{R:()=>d,x:()=>c});var s=i(63696);const r={},t=s.createContext(r);function d(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:d(e.components),s.createElement(t.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/c09ab32f.1dce7f31.js b/assets/js/c09ab32f.7bbc413a.js similarity index 97% rename from assets/js/c09ab32f.1dce7f31.js rename to assets/js/c09ab32f.7bbc413a.js index 535201be405..fdaf723d2a7 100644 --- a/assets/js/c09ab32f.1dce7f31.js +++ b/assets/js/c09ab32f.7bbc413a.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[69325],{90217:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>l,contentTitle:()=>r,default:()=>u,frontMatter:()=>s,metadata:()=>o,toc:()=>c});var a=n(62540),i=n(43023);const s={},r="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"}},l={},c=[{value:"Defined in",id:"defined-in",level:2}];function d(e){const t={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",strong:"strong",...(0,i.R)(),...e.components};return(0,a.jsxs)(a.Fragment,{children:[(0,a.jsx)(t.header,{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:"defined-in",children:"Defined in"}),"\n",(0,a.jsx)(t.p,{children:(0,a.jsx)(t.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L1483",children:"packages/extension-api/src/extension-api.d.ts:1483"})})]})}function u(e={}){const{wrapper:t}={...(0,i.R)(),...e.components};return t?(0,a.jsx)(t,{...e,children:(0,a.jsx)(d,{...e})}):d(e)}},43023:(e,t,n)=>{n.d(t,{R:()=>r,x:()=>o});var a=n(63696);const i={},s=a.createContext(i);function r(e){const t=a.useContext(s);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:r(e.components),a.createElement(s.Provider,{value:t},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[69325],{90217:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>l,contentTitle:()=>r,default:()=>u,frontMatter:()=>s,metadata:()=>o,toc:()=>c});var a=n(62540),i=n(43023);const s={},r="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"}},l={},c=[{value:"Defined in",id:"defined-in",level:2}];function d(e){const t={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",strong:"strong",...(0,i.R)(),...e.components};return(0,a.jsxs)(a.Fragment,{children:[(0,a.jsx)(t.header,{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:"defined-in",children:"Defined in"}),"\n",(0,a.jsx)(t.p,{children:(0,a.jsx)(t.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L1483",children:"packages/extension-api/src/extension-api.d.ts:1483"})})]})}function u(e={}){const{wrapper:t}={...(0,i.R)(),...e.components};return t?(0,a.jsx)(t,{...e,children:(0,a.jsx)(d,{...e})}):d(e)}},43023:(e,t,n)=>{n.d(t,{R:()=>r,x:()=>o});var a=n(63696);const i={},s=a.createContext(i);function r(e){const t=a.useContext(s);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:r(e.components),a.createElement(s.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/c104141c.788d4889.js b/assets/js/c104141c.c267adb3.js similarity index 95% rename from assets/js/c104141c.788d4889.js rename to assets/js/c104141c.c267adb3.js index 3c1f1064de5..affb1defe91 100644 --- a/assets/js/c104141c.788d4889.js +++ b/assets/js/c104141c.c267adb3.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[7568],{30435:(e,t,r)=>{r.r(t),r.d(t,{assets:()=>d,contentTitle:()=>o,default:()=>h,frontMatter:()=>i,metadata:()=>a,toc:()=>c});var n=r(62540),s=r(43023);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"}},d={},c=[{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:"Defined in",id:"defined-in",level:4}];function l(e){const t={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",p:"p",strong:"strong",...(0,s.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(t.header,{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:"defined-in",children:"Defined in"}),"\n",(0,n.jsx)(t.p,{children:(0,n.jsx)(t.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L578",children:"packages/extension-api/src/extension-api.d.ts:578"})})]})}function h(e={}){const{wrapper:t}={...(0,s.R)(),...e.components};return t?(0,n.jsx)(t,{...e,children:(0,n.jsx)(l,{...e})}):l(e)}},43023:(e,t,r)=>{r.d(t,{R:()=>o,x:()=>a});var n=r(63696);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([[7568],{30435:(e,t,r)=>{r.r(t),r.d(t,{assets:()=>d,contentTitle:()=>o,default:()=>h,frontMatter:()=>i,metadata:()=>a,toc:()=>c});var n=r(62540),s=r(43023);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"}},d={},c=[{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:"Defined in",id:"defined-in",level:4}];function l(e){const t={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",p:"p",strong:"strong",...(0,s.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(t.header,{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:"defined-in",children:"Defined in"}),"\n",(0,n.jsx)(t.p,{children:(0,n.jsx)(t.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L578",children:"packages/extension-api/src/extension-api.d.ts:578"})})]})}function h(e={}){const{wrapper:t}={...(0,s.R)(),...e.components};return t?(0,n.jsx)(t,{...e,children:(0,n.jsx)(l,{...e})}):l(e)}},43023:(e,t,r)=>{r.d(t,{R:()=>o,x:()=>a});var n=r(63696);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.9a8d1e30.js b/assets/js/c1584a80.f1760e14.js similarity index 93% rename from assets/js/c1584a80.9a8d1e30.js rename to assets/js/c1584a80.f1760e14.js index ce17134da1a..bc3f441280d 100644 --- a/assets/js/c1584a80.9a8d1e30.js +++ b/assets/js/c1584a80.f1760e14.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[21817],{7261:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>c,contentTitle:()=>d,default:()=>h,frontMatter:()=>t,metadata:()=>a,toc:()=>o});var s=r(62540),i=r(43023);const t={},d="Interface: Logger",a={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"}},c={},o=[{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:"Defined in",id:"defined-in",level:4},{value:"log()",id:"log",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"warn()",id:"warn",level:3},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-2",level:4},{value:"Defined in",id:"defined-in-2",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",p:"p",strong:"strong",...(0,i.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.header,{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:"defined-in",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/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:"defined-in-1",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/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:"defined-in-2",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/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,i.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},43023:(e,n,r)=>{r.d(n,{R:()=>d,x:()=>a});var s=r(63696);const i={},t=s.createContext(i);function d(e){const n=s.useContext(t);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:d(e.components),s.createElement(t.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[21817],{7261:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>c,contentTitle:()=>d,default:()=>h,frontMatter:()=>t,metadata:()=>a,toc:()=>o});var s=r(62540),i=r(43023);const t={},d="Interface: Logger",a={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"}},c={},o=[{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:"Defined in",id:"defined-in",level:4},{value:"log()",id:"log",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"warn()",id:"warn",level:3},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-2",level:4},{value:"Defined in",id:"defined-in-2",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",p:"p",strong:"strong",...(0,i.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.header,{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:"defined-in",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/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:"defined-in-1",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/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:"defined-in-2",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/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,i.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},43023:(e,n,r)=>{r.d(n,{R:()=>d,x:()=>a});var s=r(63696);const i={},t=s.createContext(i);function d(e){const n=s.useContext(t);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:d(e.components),s.createElement(t.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/c1ca9e21.d8c7408e.js b/assets/js/c1ca9e21.4f8f8b1b.js similarity index 92% rename from assets/js/c1ca9e21.d8c7408e.js rename to assets/js/c1ca9e21.4f8f8b1b.js index ec757a45427..6973c8cd293 100644 --- a/assets/js/c1ca9e21.d8c7408e.js +++ b/assets/js/c1ca9e21.4f8f8b1b.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[53930],{87335:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>s,default:()=>p,frontMatter:()=>c,metadata:()=>o,toc:()=>d});var i=t(62540),r=t(43023);const c={},s="Interface: KubeconfigUpdateEvent",o={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:"Defined in",id:"defined-in",level:4},{value:"type",id:"type",level:3},{value:"Defined in",id:"defined-in-1",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",p:"p",strong:"strong",...(0,r.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.header,{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:"defined-in",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2126",children:"packages/extension-api/src/extension-api.d.ts:2126"})}),"\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:"defined-in-1",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2125",children:"packages/extension-api/src/extension-api.d.ts:2125"})})]})}function p(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},43023:(e,n,t)=>{t.d(n,{R:()=>s,x:()=>o});var i=t(63696);const r={},c=i.createContext(r);function s(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:s(e.components),i.createElement(c.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[53930],{87335:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>s,default:()=>p,frontMatter:()=>c,metadata:()=>o,toc:()=>d});var i=t(62540),r=t(43023);const c={},s="Interface: KubeconfigUpdateEvent",o={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:"Defined in",id:"defined-in",level:4},{value:"type",id:"type",level:3},{value:"Defined in",id:"defined-in-1",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",p:"p",strong:"strong",...(0,r.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.header,{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:"defined-in",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2126",children:"packages/extension-api/src/extension-api.d.ts:2126"})}),"\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:"defined-in-1",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2125",children:"packages/extension-api/src/extension-api.d.ts:2125"})})]})}function p(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},43023:(e,n,t)=>{t.d(n,{R:()=>s,x:()=>o});var i=t(63696);const r={},c=i.createContext(r);function s(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:s(e.components),i.createElement(c.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/c239db97.3de30ec5.js b/assets/js/c239db97.b3714bc3.js similarity index 98% rename from assets/js/c239db97.3de30ec5.js rename to assets/js/c239db97.b3714bc3.js index c3a6ef6eb9f..3a198a927f8 100644 --- a/assets/js/c239db97.3de30ec5.js +++ b/assets/js/c239db97.b3714bc3.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[66414],{45923:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>o,contentTitle:()=>c,default:()=>h,frontMatter:()=>a,metadata:()=>r,toc:()=>d});var s=i(62540),t=i(43023);const a={},c="Function: saveImage()",r={id:"namespaces/containerEngine/functions/saveImage",title:"Function: saveImage()",description:"saveImage(engineId, id, filename, token?): 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:"Defined in",id:"defined-in",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",strong:"strong",...(0,t.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.header,{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:"token"}),"?): ",(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.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.p,{children:"an optional cancellation token which will cancel saving the image on disk when the token is canceled"}),"\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:"defined-in",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L3570",children:"packages/extension-api/src/extension-api.d.ts:3570"})})]})}function h(e={}){const{wrapper:n}={...(0,t.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},43023:(e,n,i)=>{i.d(n,{R:()=>c,x:()=>r});var s=i(63696);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([[66414],{45923:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>o,contentTitle:()=>c,default:()=>h,frontMatter:()=>a,metadata:()=>r,toc:()=>d});var s=i(62540),t=i(43023);const a={},c="Function: saveImage()",r={id:"namespaces/containerEngine/functions/saveImage",title:"Function: saveImage()",description:"saveImage(engineId, id, filename, token?): 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:"Defined in",id:"defined-in",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",strong:"strong",...(0,t.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.header,{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:"token"}),"?): ",(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.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.p,{children:"an optional cancellation token which will cancel saving the image on disk when the token is canceled"}),"\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:"defined-in",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L3570",children:"packages/extension-api/src/extension-api.d.ts:3570"})})]})}function h(e={}){const{wrapper:n}={...(0,t.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},43023:(e,n,i)=>{i.d(n,{R:()=>c,x:()=>r});var s=i(63696);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 diff --git a/assets/js/c25913f3.a9961512.js b/assets/js/c25913f3.d478515f.js similarity index 88% rename from assets/js/c25913f3.a9961512.js rename to assets/js/c25913f3.d478515f.js index aeaad2c2c59..0ea7eb6204a 100644 --- a/assets/js/c25913f3.a9961512.js +++ b/assets/js/c25913f3.d478515f.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[32467],{63892:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>d,contentTitle:()=>o,default:()=>h,frontMatter:()=>a,metadata:()=>r,toc:()=>c});var t=i(62540),s=i(43023);const a={},o="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"}},d={},c=[{value:"Properties",id:"properties",level:2},{value:"message",id:"message",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"severity",id:"severity",level:3},{value:"Defined in",id:"defined-in-1",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",p:"p",strong:"strong",...(0,s.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.header,{children:(0,t.jsx)(n.h1,{id:"interface-inputboxvalidationmessage",children:"Interface: InputBoxValidationMessage"})}),"\n",(0,t.jsx)(n.p,{children:"Object to configure the behavior of the validation message."}),"\n",(0,t.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,t.jsx)(n.h3,{id:"message",children:"message"}),"\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:"message"}),": ",(0,t.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"The validation message to display."}),"\n",(0,t.jsx)(n.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L1125",children:"packages/extension-api/src/extension-api.d.ts:1125"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"severity",children:"severity"}),"\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:"severity"}),": ",(0,t.jsx)(n.a,{href:"/api/enumerations/InputBoxValidationSeverity",children:(0,t.jsx)(n.code,{children:"InputBoxValidationSeverity"})})]}),"\n"]}),"\n",(0,t.jsxs)(n.p,{children:["The severity of the validation message.\nNOTE: When using ",(0,t.jsx)(n.code,{children:"InputBoxValidationSeverity.Error"}),", the user will not be allowed to accept (hit ENTER) the input.\n",(0,t.jsx)(n.code,{children:"Info"})," and ",(0,t.jsx)(n.code,{children:"Warning"})," will still allow the InputBox to accept the input."]}),"\n",(0,t.jsx)(n.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L1132",children:"packages/extension-api/src/extension-api.d.ts:1132"})})]})}function h(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},43023:(e,n,i)=>{i.d(n,{R:()=>o,x:()=>r});var t=i(63696);const s={},a=t.createContext(s);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(s):e.components||s:o(e.components),t.createElement(a.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[32467],{63892:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>c,contentTitle:()=>o,default:()=>h,frontMatter:()=>a,metadata:()=>r,toc:()=>d});var t=i(62540),s=i(43023);const a={},o="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:"Defined in",id:"defined-in",level:4},{value:"severity",id:"severity",level:3},{value:"Defined in",id:"defined-in-1",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",p:"p",strong:"strong",...(0,s.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.header,{children:(0,t.jsx)(n.h1,{id:"interface-inputboxvalidationmessage",children:"Interface: InputBoxValidationMessage"})}),"\n",(0,t.jsx)(n.p,{children:"Object to configure the behavior of the validation message."}),"\n",(0,t.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,t.jsx)(n.h3,{id:"message",children:"message"}),"\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:"message"}),": ",(0,t.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"The validation message to display."}),"\n",(0,t.jsx)(n.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L1125",children:"packages/extension-api/src/extension-api.d.ts:1125"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"severity",children:"severity"}),"\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:"severity"}),": ",(0,t.jsx)(n.a,{href:"/api/enumerations/InputBoxValidationSeverity",children:(0,t.jsx)(n.code,{children:"InputBoxValidationSeverity"})})]}),"\n"]}),"\n",(0,t.jsxs)(n.p,{children:["The severity of the validation message.\nNOTE: When using ",(0,t.jsx)(n.code,{children:"InputBoxValidationSeverity.Error"}),", the user will not be allowed to accept (hit ENTER) the input.\n",(0,t.jsx)(n.code,{children:"Info"})," and ",(0,t.jsx)(n.code,{children:"Warning"})," will still allow the InputBox to accept the input."]}),"\n",(0,t.jsx)(n.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L1132",children:"packages/extension-api/src/extension-api.d.ts:1132"})})]})}function h(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},43023:(e,n,i)=>{i.d(n,{R:()=>o,x:()=>r});var t=i(63696);const s={},a=t.createContext(s);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(s):e.components||s:o(e.components),t.createElement(a.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/c2865a15.173826e0.js b/assets/js/c2865a15.11e9cbcd.js similarity index 97% rename from assets/js/c2865a15.173826e0.js rename to assets/js/c2865a15.11e9cbcd.js index f2770c00cd0..cf0570aa834 100644 --- a/assets/js/c2865a15.173826e0.js +++ b/assets/js/c2865a15.11e9cbcd.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[81898],{7001:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>c,contentTitle:()=>a,default:()=>l,frontMatter:()=>s,metadata:()=>r,toc:()=>p});var o=t(62540),i=t(43023);const s={},a="Type Alias: MountType",r={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"}},c={},p=[{value:"Defined in",id:"defined-in",level:2}];function d(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",strong:"strong",...(0,i.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(n.header,{children:(0,o.jsx)(n.h1,{id:"type-alias-mounttype",children:"Type Alias: MountType"})}),"\n",(0,o.jsxs)(n.blockquote,{children:["\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.strong,{children:"MountType"}),": ",(0,o.jsx)(n.code,{children:'"bind"'})," | ",(0,o.jsx)(n.code,{children:'"volume"'})," | ",(0,o.jsx)(n.code,{children:'"tmpfs"'})]}),"\n"]}),"\n",(0,o.jsx)(n.h2,{id:"defined-in",children:"Defined in"}),"\n",(0,o.jsx)(n.p,{children:(0,o.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2389",children:"packages/extension-api/src/extension-api.d.ts:2389"})})]})}function l(e={}){const{wrapper:n}={...(0,i.R)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(d,{...e})}):d(e)}},43023:(e,n,t)=>{t.d(n,{R:()=>a,x:()=>r});var o=t(63696);const i={},s=o.createContext(i);function a(e){const n=o.useContext(s);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(s.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[81898],{7001:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>c,contentTitle:()=>a,default:()=>l,frontMatter:()=>s,metadata:()=>r,toc:()=>p});var o=t(62540),i=t(43023);const s={},a="Type Alias: MountType",r={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"}},c={},p=[{value:"Defined in",id:"defined-in",level:2}];function d(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",strong:"strong",...(0,i.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(n.header,{children:(0,o.jsx)(n.h1,{id:"type-alias-mounttype",children:"Type Alias: MountType"})}),"\n",(0,o.jsxs)(n.blockquote,{children:["\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.strong,{children:"MountType"}),": ",(0,o.jsx)(n.code,{children:'"bind"'})," | ",(0,o.jsx)(n.code,{children:'"volume"'})," | ",(0,o.jsx)(n.code,{children:'"tmpfs"'})]}),"\n"]}),"\n",(0,o.jsx)(n.h2,{id:"defined-in",children:"Defined in"}),"\n",(0,o.jsx)(n.p,{children:(0,o.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2389",children:"packages/extension-api/src/extension-api.d.ts:2389"})})]})}function l(e={}){const{wrapper:n}={...(0,i.R)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(d,{...e})}):d(e)}},43023:(e,n,t)=>{t.d(n,{R:()=>a,x:()=>r});var o=t(63696);const i={},s=o.createContext(i);function a(e){const n=o.useContext(s);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(s.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/c358ebbc.219641a0.js b/assets/js/c358ebbc.3f6af45e.js similarity index 94% rename from assets/js/c358ebbc.219641a0.js rename to assets/js/c358ebbc.3f6af45e.js index 94ae1285001..7ea3396beea 100644 --- a/assets/js/c358ebbc.219641a0.js +++ b/assets/js/c358ebbc.3f6af45e.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[61634],{65548:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>c,contentTitle:()=>o,default:()=>l,frontMatter:()=>r,metadata:()=>d,toc:()=>a});var i=s(62540),t=s(43023);const r={},o="Interface: AuthenticationProvider",d={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"}},c={},a=[{value:"Properties",id:"properties",level:2},{value:"onDidChangeSessions",id:"ondidchangesessions",level:3},{value:"Defined in",id:"defined-in",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:"Defined in",id:"defined-in-1",level:4},{value:"getSessions()",id:"getsessions",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"removeSession()",id:"removesession",level:3},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-2",level:4},{value:"Defined in",id:"defined-in-3",level:4}];function h(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",p:"p",strong:"strong",...(0,t.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.header,{children:(0,i.jsx)(n.h1,{id:"interface-authenticationprovider",children:"Interface: AuthenticationProvider"})}),"\n",(0,i.jsx)(n.p,{children:"A provider for performing authentication to a service."}),"\n",(0,i.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(n.h3,{id:"ondidchangesessions",children:"onDidChangeSessions"}),"\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:"onDidChangeSessions"}),": ",(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/AuthenticationProviderAuthenticationSessionsChangeEvent",children:(0,i.jsx)(n.code,{children:"AuthenticationProviderAuthenticationSessionsChangeEvent"})}),">"]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["An ",(0,i.jsx)(n.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)(n.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L3862",children:"packages/extension-api/src/extension-api.d.ts:3862"})}),"\n",(0,i.jsx)(n.h2,{id:"methods",children:"Methods"}),"\n",(0,i.jsx)(n.h3,{id:"createsession",children:"createSession()"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"createSession"}),"(",(0,i.jsx)(n.code,{children:"scopes"}),"): ",(0,i.jsx)(n.code,{children:"Promise"}),"<",(0,i.jsx)(n.a,{href:"/api/interfaces/AuthenticationSession",children:(0,i.jsx)(n.code,{children:"AuthenticationSession"})}),">"]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Prompts a user to login."}),"\n",(0,i.jsx)(n.p,{children:"If login is successful, the onDidChangeSessions event should be fired."}),"\n",(0,i.jsx)(n.p,{children:"If login fails, a rejected promise should be returned."}),"\n",(0,i.jsx)(n.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)(n.h4,{id:"parameters",children:"Parameters"}),"\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, permissions, that the new session should be created with."}),"\n",(0,i.jsx)(n.h4,{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"})}),">"]}),"\n",(0,i.jsx)(n.p,{children:"A promise that resolves to an authentication session."}),"\n",(0,i.jsx)(n.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L3885",children:"packages/extension-api/src/extension-api.d.ts:3885"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"getsessions",children:"getSessions()"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"getSessions"}),"(",(0,i.jsx)(n.code,{children:"scopes"}),"?): ",(0,i.jsx)(n.code,{children:"Promise"}),""]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Get a list of sessions."}),"\n",(0,i.jsx)(n.h4,{id:"parameters-1",children:"Parameters"}),"\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:"An optional list of scopes. If provided, the sessions returned should match\nthese permissions, otherwise all sessions should be returned."}),"\n",(0,i.jsx)(n.h4,{id:"returns-1",children:"Returns"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"Promise"}),""]}),"\n",(0,i.jsx)(n.p,{children:"A promise that resolves to an array of authentication sessions."}),"\n",(0,i.jsx)(n.h4,{id:"defined-in-2",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L3870",children:"packages/extension-api/src/extension-api.d.ts:3870"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"removesession",children:"removeSession()"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"removeSession"}),"(",(0,i.jsx)(n.code,{children:"sessionId"}),"): ",(0,i.jsx)(n.code,{children:"Promise"}),"<",(0,i.jsx)(n.code,{children:"void"}),">"]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Removes the session corresponding to session id."}),"\n",(0,i.jsx)(n.p,{children:"If the removal is successful, the onDidChangeSessions event should be fired."}),"\n",(0,i.jsx)(n.p,{children:"If a session cannot be removed, the provider should reject with an error message."}),"\n",(0,i.jsx)(n.h4,{id:"parameters-2",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"sessionId"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n",(0,i.jsx)(n.p,{children:"The id of the session to remove."}),"\n",(0,i.jsx)(n.h4,{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:"void"}),">"]}),"\n",(0,i.jsx)(n.h4,{id:"defined-in-3",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L3895",children:"packages/extension-api/src/extension-api.d.ts:3895"})})]})}function l(e={}){const{wrapper:n}={...(0,t.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(h,{...e})}):h(e)}},43023:(e,n,s)=>{s.d(n,{R:()=>o,x:()=>d});var i=s(63696);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 d(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([[61634],{65548:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>c,contentTitle:()=>o,default:()=>l,frontMatter:()=>r,metadata:()=>d,toc:()=>a});var i=s(62540),t=s(43023);const r={},o="Interface: AuthenticationProvider",d={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"}},c={},a=[{value:"Properties",id:"properties",level:2},{value:"onDidChangeSessions",id:"ondidchangesessions",level:3},{value:"Defined in",id:"defined-in",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:"Defined in",id:"defined-in-1",level:4},{value:"getSessions()",id:"getsessions",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"removeSession()",id:"removesession",level:3},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-2",level:4},{value:"Defined in",id:"defined-in-3",level:4}];function h(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",p:"p",strong:"strong",...(0,t.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.header,{children:(0,i.jsx)(n.h1,{id:"interface-authenticationprovider",children:"Interface: AuthenticationProvider"})}),"\n",(0,i.jsx)(n.p,{children:"A provider for performing authentication to a service."}),"\n",(0,i.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(n.h3,{id:"ondidchangesessions",children:"onDidChangeSessions"}),"\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:"onDidChangeSessions"}),": ",(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/AuthenticationProviderAuthenticationSessionsChangeEvent",children:(0,i.jsx)(n.code,{children:"AuthenticationProviderAuthenticationSessionsChangeEvent"})}),">"]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["An ",(0,i.jsx)(n.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)(n.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L3862",children:"packages/extension-api/src/extension-api.d.ts:3862"})}),"\n",(0,i.jsx)(n.h2,{id:"methods",children:"Methods"}),"\n",(0,i.jsx)(n.h3,{id:"createsession",children:"createSession()"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"createSession"}),"(",(0,i.jsx)(n.code,{children:"scopes"}),"): ",(0,i.jsx)(n.code,{children:"Promise"}),"<",(0,i.jsx)(n.a,{href:"/api/interfaces/AuthenticationSession",children:(0,i.jsx)(n.code,{children:"AuthenticationSession"})}),">"]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Prompts a user to login."}),"\n",(0,i.jsx)(n.p,{children:"If login is successful, the onDidChangeSessions event should be fired."}),"\n",(0,i.jsx)(n.p,{children:"If login fails, a rejected promise should be returned."}),"\n",(0,i.jsx)(n.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)(n.h4,{id:"parameters",children:"Parameters"}),"\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, permissions, that the new session should be created with."}),"\n",(0,i.jsx)(n.h4,{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"})}),">"]}),"\n",(0,i.jsx)(n.p,{children:"A promise that resolves to an authentication session."}),"\n",(0,i.jsx)(n.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L3885",children:"packages/extension-api/src/extension-api.d.ts:3885"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"getsessions",children:"getSessions()"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"getSessions"}),"(",(0,i.jsx)(n.code,{children:"scopes"}),"?): ",(0,i.jsx)(n.code,{children:"Promise"}),""]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Get a list of sessions."}),"\n",(0,i.jsx)(n.h4,{id:"parameters-1",children:"Parameters"}),"\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:"An optional list of scopes. If provided, the sessions returned should match\nthese permissions, otherwise all sessions should be returned."}),"\n",(0,i.jsx)(n.h4,{id:"returns-1",children:"Returns"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"Promise"}),""]}),"\n",(0,i.jsx)(n.p,{children:"A promise that resolves to an array of authentication sessions."}),"\n",(0,i.jsx)(n.h4,{id:"defined-in-2",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L3870",children:"packages/extension-api/src/extension-api.d.ts:3870"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"removesession",children:"removeSession()"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"removeSession"}),"(",(0,i.jsx)(n.code,{children:"sessionId"}),"): ",(0,i.jsx)(n.code,{children:"Promise"}),"<",(0,i.jsx)(n.code,{children:"void"}),">"]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Removes the session corresponding to session id."}),"\n",(0,i.jsx)(n.p,{children:"If the removal is successful, the onDidChangeSessions event should be fired."}),"\n",(0,i.jsx)(n.p,{children:"If a session cannot be removed, the provider should reject with an error message."}),"\n",(0,i.jsx)(n.h4,{id:"parameters-2",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"sessionId"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n",(0,i.jsx)(n.p,{children:"The id of the session to remove."}),"\n",(0,i.jsx)(n.h4,{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:"void"}),">"]}),"\n",(0,i.jsx)(n.h4,{id:"defined-in-3",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L3895",children:"packages/extension-api/src/extension-api.d.ts:3895"})})]})}function l(e={}){const{wrapper:n}={...(0,t.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(h,{...e})}):h(e)}},43023:(e,n,s)=>{s.d(n,{R:()=>o,x:()=>d});var i=s(63696);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 d(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/c544b2d7.17a530f9.js b/assets/js/c544b2d7.743e021d.js similarity index 97% rename from assets/js/c544b2d7.17a530f9.js rename to assets/js/c544b2d7.743e021d.js index 547c488de01..1ed8488217a 100644 --- a/assets/js/c544b2d7.17a530f9.js +++ b/assets/js/c544b2d7.743e021d.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[68660],{74389:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>c,contentTitle:()=>o,default:()=>p,frontMatter:()=>r,metadata:()=>a,toc:()=>d});var i=t(62540),s=t(43023);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:"Defined in",id:"defined-in",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",p:"p",pre:"pre",strong:"strong",...(0,s.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.header,{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:"defined-in",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L3347",children:"packages/extension-api/src/extension-api.d.ts:3347"})})]})}function p(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},43023:(e,n,t)=>{t.d(n,{R:()=>o,x:()=>a});var i=t(63696);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([[68660],{74389:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>c,contentTitle:()=>o,default:()=>p,frontMatter:()=>r,metadata:()=>a,toc:()=>d});var i=t(62540),s=t(43023);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:"Defined in",id:"defined-in",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",p:"p",pre:"pre",strong:"strong",...(0,s.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.header,{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:"defined-in",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L3347",children:"packages/extension-api/src/extension-api.d.ts:3347"})})]})}function p(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},43023:(e,n,t)=>{t.d(n,{R:()=>o,x:()=>a});var i=t(63696);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.f42a6390.js b/assets/js/c7cac05f.6ec3b11f.js similarity index 90% rename from assets/js/c7cac05f.f42a6390.js rename to assets/js/c7cac05f.6ec3b11f.js index 5eaa0317d62..996262aaee4 100644 --- a/assets/js/c7cac05f.f42a6390.js +++ b/assets/js/c7cac05f.6ec3b11f.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[86693],{47595:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>l,contentTitle:()=>d,default:()=>p,frontMatter:()=>o,metadata:()=>r,toc:()=>a});var s=i(62540),t=i(43023);const o={},d="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:"Defined in",id:"defined-in",level:4},{value:"filters?",id:"filters",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"openLabel?",id:"openlabel",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"selectors?",id:"selectors",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"title?",id:"title",level:3},{value:"Defined in",id:"defined-in-4",level:4}];function c(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",p:"p",strong:"strong",...(0,t.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.header,{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:"defined-in",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L1819",children:"packages/extension-api/src/extension-api.d.ts:1819"})}),"\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:"defined-in-1",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L1835",children:"packages/extension-api/src/extension-api.d.ts:1835"})}),"\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:"defined-in-2",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L1824",children:"packages/extension-api/src/extension-api.d.ts:1824"})}),"\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:"defined-in-3",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L1830",children:"packages/extension-api/src/extension-api.d.ts:1830"})}),"\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:"defined-in-4",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L1843",children:"packages/extension-api/src/extension-api.d.ts:1843"})})]})}function p(e={}){const{wrapper:n}={...(0,t.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(c,{...e})}):c(e)}},43023:(e,n,i)=>{i.d(n,{R:()=>d,x:()=>r});var s=i(63696);const t={},o=s.createContext(t);function d(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(t):e.components||t:d(e.components),s.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[86693],{47595:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>l,contentTitle:()=>d,default:()=>p,frontMatter:()=>o,metadata:()=>r,toc:()=>a});var s=i(62540),t=i(43023);const o={},d="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:"Defined in",id:"defined-in",level:4},{value:"filters?",id:"filters",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"openLabel?",id:"openlabel",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"selectors?",id:"selectors",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"title?",id:"title",level:3},{value:"Defined in",id:"defined-in-4",level:4}];function c(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",p:"p",strong:"strong",...(0,t.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.header,{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:"defined-in",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L1819",children:"packages/extension-api/src/extension-api.d.ts:1819"})}),"\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:"defined-in-1",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L1835",children:"packages/extension-api/src/extension-api.d.ts:1835"})}),"\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:"defined-in-2",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L1824",children:"packages/extension-api/src/extension-api.d.ts:1824"})}),"\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:"defined-in-3",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L1830",children:"packages/extension-api/src/extension-api.d.ts:1830"})}),"\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:"defined-in-4",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L1843",children:"packages/extension-api/src/extension-api.d.ts:1843"})})]})}function p(e={}){const{wrapper:n}={...(0,t.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(c,{...e})}):c(e)}},43023:(e,n,i)=>{i.d(n,{R:()=>d,x:()=>r});var s=i(63696);const t={},o=s.createContext(t);function d(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(t):e.components||t:d(e.components),s.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/c813bd67.c32c3aee.js b/assets/js/c813bd67.68c9ce22.js similarity index 78% rename from assets/js/c813bd67.c32c3aee.js rename to assets/js/c813bd67.68c9ce22.js index 7f77aaf5348..6b0619b6842 100644 --- a/assets/js/c813bd67.c32c3aee.js +++ b/assets/js/c813bd67.68c9ce22.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[79849],{64686:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>o,contentTitle:()=>d,default:()=>h,frontMatter:()=>r,metadata:()=>c,toc:()=>a});var s=i(62540),t=i(43023);const r={},d="Interface: IPAM",c={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"}},o={},a=[{value:"Properties",id:"properties",level:2},{value:"Config?",id:"config",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"Driver",id:"driver",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"Options?",id:"options",level:3},{value:"Index Signature",id:"index-signature",level:4},{value:"Defined in",id:"defined-in-2",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",p:"p",strong:"strong",...(0,t.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.header,{children:(0,s.jsx)(n.h1,{id:"interface-ipam",children:"Interface: IPAM"})}),"\n",(0,s.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,s.jsx)(n.h3,{id:"config",children:"Config?"}),"\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:"Config"}),": ",(0,s.jsx)(n.code,{children:"object"}),"[]"]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2260",children:"packages/extension-api/src/extension-api.d.ts:2260"})}),"\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.strong,{children:"Driver"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2259",children:"packages/extension-api/src/extension-api.d.ts:2259"})}),"\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:"defined-in-2",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2261",children:"packages/extension-api/src/extension-api.d.ts:2261"})})]})}function h(e={}){const{wrapper:n}={...(0,t.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},43023:(e,n,i)=>{i.d(n,{R:()=>d,x:()=>c});var s=i(63696);const t={},r=s.createContext(t);function d(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(t):e.components||t:d(e.components),s.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[79849],{64686:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>o,contentTitle:()=>c,default:()=>h,frontMatter:()=>r,metadata:()=>d,toc:()=>a});var s=i(62540),t=i(43023);const r={},c="Interface: IPAM",d={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"}},o={},a=[{value:"Properties",id:"properties",level:2},{value:"Config?",id:"config",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"Driver",id:"driver",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"Options?",id:"options",level:3},{value:"Index Signature",id:"index-signature",level:4},{value:"Defined in",id:"defined-in-2",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",p:"p",strong:"strong",...(0,t.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.header,{children:(0,s.jsx)(n.h1,{id:"interface-ipam",children:"Interface: IPAM"})}),"\n",(0,s.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,s.jsx)(n.h3,{id:"config",children:"Config?"}),"\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:"Config"}),": ",(0,s.jsx)(n.code,{children:"object"}),"[]"]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2260",children:"packages/extension-api/src/extension-api.d.ts:2260"})}),"\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.strong,{children:"Driver"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2259",children:"packages/extension-api/src/extension-api.d.ts:2259"})}),"\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:"defined-in-2",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2261",children:"packages/extension-api/src/extension-api.d.ts:2261"})})]})}function h(e={}){const{wrapper:n}={...(0,t.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},43023:(e,n,i)=>{i.d(n,{R:()=>c,x:()=>d});var s=i(63696);const t={},r=s.createContext(t);function c(e){const n=s.useContext(r);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(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/ca1234c1.a83f4627.js b/assets/js/ca1234c1.75fefe75.js similarity index 92% rename from assets/js/ca1234c1.a83f4627.js rename to assets/js/ca1234c1.75fefe75.js index 47a927170ec..8deedf9bb29 100644 --- a/assets/js/ca1234c1.a83f4627.js +++ b/assets/js/ca1234c1.75fefe75.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[23767],{94394:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>c,contentTitle:()=>s,default:()=>h,frontMatter:()=>t,metadata:()=>d,toc:()=>a});var o=i(62540),r=i(43023);const t={},s="Interface: TelemetryLoggerOptions",d={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"}},c={},a=[{value:"Properties",id:"properties",level:2},{value:"additionalCommonProperties?",id:"additionalcommonproperties",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"ignoreBuiltInCommonProperties?",id:"ignorebuiltincommonproperties",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"ignoreUnhandledErrors?",id:"ignoreunhandlederrors",level:3},{value:"Defined in",id:"defined-in-2",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",p:"p",strong:"strong",...(0,r.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(n.header,{children:(0,o.jsx)(n.h1,{id:"interface-telemetryloggeroptions",children:"Interface: TelemetryLoggerOptions"})}),"\n",(0,o.jsxs)(n.p,{children:["Options for creating a ",(0,o.jsx)(n.a,{href:"/api/interfaces/TelemetryLogger",children:"TelemetryLogger"})]}),"\n",(0,o.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,o.jsx)(n.h3,{id:"additionalcommonproperties",children:"additionalCommonProperties?"}),"\n",(0,o.jsxs)(n.blockquote,{children:["\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.code,{children:"readonly"})," ",(0,o.jsx)(n.code,{children:"optional"})," ",(0,o.jsx)(n.strong,{children:"additionalCommonProperties"}),": ",(0,o.jsx)(n.code,{children:"Record"}),"<",(0,o.jsx)(n.code,{children:"string"}),", ",(0,o.jsx)(n.code,{children:"any"}),">"]}),"\n"]}),"\n",(0,o.jsx)(n.p,{children:"Any additional common properties which should be injected into the data object."}),"\n",(0,o.jsx)(n.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,o.jsx)(n.p,{children:(0,o.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L4266",children:"packages/extension-api/src/extension-api.d.ts:4266"})}),"\n",(0,o.jsx)(n.hr,{}),"\n",(0,o.jsx)(n.h3,{id:"ignorebuiltincommonproperties",children:"ignoreBuiltInCommonProperties?"}),"\n",(0,o.jsxs)(n.blockquote,{children:["\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.code,{children:"readonly"})," ",(0,o.jsx)(n.code,{children:"optional"})," ",(0,o.jsx)(n.strong,{children:"ignoreBuiltInCommonProperties"}),": ",(0,o.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,o.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,o.jsx)(n.code,{children:"false"})," if not defined."]}),"\n",(0,o.jsx)(n.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,o.jsx)(n.p,{children:(0,o.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L4254",children:"packages/extension-api/src/extension-api.d.ts:4254"})}),"\n",(0,o.jsx)(n.hr,{}),"\n",(0,o.jsx)(n.h3,{id:"ignoreunhandlederrors",children:"ignoreUnhandledErrors?"}),"\n",(0,o.jsxs)(n.blockquote,{children:["\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.code,{children:"readonly"})," ",(0,o.jsx)(n.code,{children:"optional"})," ",(0,o.jsx)(n.strong,{children:"ignoreUnhandledErrors"}),": ",(0,o.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,o.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,o.jsx)(n.code,{children:"false"})," if not defined."]}),"\n",(0,o.jsx)(n.h4,{id:"defined-in-2",children:"Defined in"}),"\n",(0,o.jsx)(n.p,{children:(0,o.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L4260",children:"packages/extension-api/src/extension-api.d.ts:4260"})})]})}function h(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(l,{...e})}):l(e)}},43023:(e,n,i)=>{i.d(n,{R:()=>s,x:()=>d});var o=i(63696);const r={},t=o.createContext(r);function s(e){const n=o.useContext(t);return o.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:s(e.components),o.createElement(t.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[23767],{94394:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>c,contentTitle:()=>s,default:()=>h,frontMatter:()=>t,metadata:()=>d,toc:()=>a});var o=i(62540),r=i(43023);const t={},s="Interface: TelemetryLoggerOptions",d={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"}},c={},a=[{value:"Properties",id:"properties",level:2},{value:"additionalCommonProperties?",id:"additionalcommonproperties",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"ignoreBuiltInCommonProperties?",id:"ignorebuiltincommonproperties",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"ignoreUnhandledErrors?",id:"ignoreunhandlederrors",level:3},{value:"Defined in",id:"defined-in-2",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",p:"p",strong:"strong",...(0,r.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(n.header,{children:(0,o.jsx)(n.h1,{id:"interface-telemetryloggeroptions",children:"Interface: TelemetryLoggerOptions"})}),"\n",(0,o.jsxs)(n.p,{children:["Options for creating a ",(0,o.jsx)(n.a,{href:"/api/interfaces/TelemetryLogger",children:"TelemetryLogger"})]}),"\n",(0,o.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,o.jsx)(n.h3,{id:"additionalcommonproperties",children:"additionalCommonProperties?"}),"\n",(0,o.jsxs)(n.blockquote,{children:["\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.code,{children:"readonly"})," ",(0,o.jsx)(n.code,{children:"optional"})," ",(0,o.jsx)(n.strong,{children:"additionalCommonProperties"}),": ",(0,o.jsx)(n.code,{children:"Record"}),"<",(0,o.jsx)(n.code,{children:"string"}),", ",(0,o.jsx)(n.code,{children:"any"}),">"]}),"\n"]}),"\n",(0,o.jsx)(n.p,{children:"Any additional common properties which should be injected into the data object."}),"\n",(0,o.jsx)(n.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,o.jsx)(n.p,{children:(0,o.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L4266",children:"packages/extension-api/src/extension-api.d.ts:4266"})}),"\n",(0,o.jsx)(n.hr,{}),"\n",(0,o.jsx)(n.h3,{id:"ignorebuiltincommonproperties",children:"ignoreBuiltInCommonProperties?"}),"\n",(0,o.jsxs)(n.blockquote,{children:["\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.code,{children:"readonly"})," ",(0,o.jsx)(n.code,{children:"optional"})," ",(0,o.jsx)(n.strong,{children:"ignoreBuiltInCommonProperties"}),": ",(0,o.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,o.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,o.jsx)(n.code,{children:"false"})," if not defined."]}),"\n",(0,o.jsx)(n.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,o.jsx)(n.p,{children:(0,o.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L4254",children:"packages/extension-api/src/extension-api.d.ts:4254"})}),"\n",(0,o.jsx)(n.hr,{}),"\n",(0,o.jsx)(n.h3,{id:"ignoreunhandlederrors",children:"ignoreUnhandledErrors?"}),"\n",(0,o.jsxs)(n.blockquote,{children:["\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.code,{children:"readonly"})," ",(0,o.jsx)(n.code,{children:"optional"})," ",(0,o.jsx)(n.strong,{children:"ignoreUnhandledErrors"}),": ",(0,o.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,o.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,o.jsx)(n.code,{children:"false"})," if not defined."]}),"\n",(0,o.jsx)(n.h4,{id:"defined-in-2",children:"Defined in"}),"\n",(0,o.jsx)(n.p,{children:(0,o.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L4260",children:"packages/extension-api/src/extension-api.d.ts:4260"})})]})}function h(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(l,{...e})}):l(e)}},43023:(e,n,i)=>{i.d(n,{R:()=>s,x:()=>d});var o=i(63696);const r={},t=o.createContext(r);function s(e){const n=o.useContext(t);return o.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:s(e.components),o.createElement(t.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/ca165b51.61b8ac0e.js b/assets/js/ca165b51.5963b7b1.js similarity index 93% rename from assets/js/ca165b51.61b8ac0e.js rename to assets/js/ca165b51.5963b7b1.js index d22c1867166..ce24de2855c 100644 --- a/assets/js/ca165b51.61b8ac0e.js +++ b/assets/js/ca165b51.5963b7b1.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[83313],{61056:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>c,contentTitle:()=>o,default:()=>l,frontMatter:()=>r,metadata:()=>d,toc:()=>a});var i=t(62540),s=t(43023);const r={},o="Interface: ProxySettings",d={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"}},c={},a=[{value:"Properties",id:"properties",level:2},{value:"httpProxy",id:"httpproxy",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"httpsProxy",id:"httpsproxy",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"noProxy",id:"noproxy",level:3},{value:"Defined in",id:"defined-in-2",level:4}];function p(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",p:"p",strong:"strong",...(0,s.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.header,{children:(0,i.jsx)(n.h1,{id:"interface-proxysettings",children:"Interface: ProxySettings"})}),"\n",(0,i.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(n.h3,{id:"httpproxy",children:"httpProxy"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"httpProxy"}),": ",(0,i.jsx)(n.code,{children:"undefined"})," | ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L868",children:"packages/extension-api/src/extension-api.d.ts:868"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"httpsproxy",children:"httpsProxy"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"httpsProxy"}),": ",(0,i.jsx)(n.code,{children:"undefined"})," | ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L869",children:"packages/extension-api/src/extension-api.d.ts:869"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"noproxy",children:"noProxy"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"noProxy"}),": ",(0,i.jsx)(n.code,{children:"undefined"})," | ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"defined-in-2",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L870",children:"packages/extension-api/src/extension-api.d.ts:870"})})]})}function l(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(p,{...e})}):p(e)}},43023:(e,n,t)=>{t.d(n,{R:()=>o,x:()=>d});var i=t(63696);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 d(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([[83313],{61056:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>c,contentTitle:()=>o,default:()=>l,frontMatter:()=>r,metadata:()=>d,toc:()=>a});var i=t(62540),s=t(43023);const r={},o="Interface: ProxySettings",d={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"}},c={},a=[{value:"Properties",id:"properties",level:2},{value:"httpProxy",id:"httpproxy",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"httpsProxy",id:"httpsproxy",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"noProxy",id:"noproxy",level:3},{value:"Defined in",id:"defined-in-2",level:4}];function p(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",p:"p",strong:"strong",...(0,s.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.header,{children:(0,i.jsx)(n.h1,{id:"interface-proxysettings",children:"Interface: ProxySettings"})}),"\n",(0,i.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(n.h3,{id:"httpproxy",children:"httpProxy"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"httpProxy"}),": ",(0,i.jsx)(n.code,{children:"undefined"})," | ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L868",children:"packages/extension-api/src/extension-api.d.ts:868"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"httpsproxy",children:"httpsProxy"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"httpsProxy"}),": ",(0,i.jsx)(n.code,{children:"undefined"})," | ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L869",children:"packages/extension-api/src/extension-api.d.ts:869"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"noproxy",children:"noProxy"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"noProxy"}),": ",(0,i.jsx)(n.code,{children:"undefined"})," | ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"defined-in-2",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L870",children:"packages/extension-api/src/extension-api.d.ts:870"})})]})}function l(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(p,{...e})}):p(e)}},43023:(e,n,t)=>{t.d(n,{R:()=>o,x:()=>d});var i=t(63696);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 d(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/caddb1c0.09e95918.js b/assets/js/caddb1c0.f7287333.js similarity index 96% rename from assets/js/caddb1c0.09e95918.js rename to assets/js/caddb1c0.f7287333.js index 50ae05b51ee..ba5e083c61c 100644 --- a/assets/js/caddb1c0.09e95918.js +++ b/assets/js/caddb1c0.f7287333.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[43169],{6170:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>o,contentTitle:()=>c,default:()=>h,frontMatter:()=>d,metadata:()=>t,toc:()=>l});var r=i(62540),s=i(43023);const d={},c="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"}},o={},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:"Defined in",id:"defined-in",level:4},{value:"edit()?",id:"edit",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"start()?",id:"start",level:3},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"stop()?",id:"stop",level:3},{value:"Parameters",id:"parameters-3",level:4},{value:"Returns",id:"returns-3",level:4},{value:"Defined in",id:"defined-in-3",level:4}];function a(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",p:"p",strong:"strong",...(0,s.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.header,{children:(0,r.jsx)(n.h1,{id:"interface-providerconnectionlifecycle",children:"Interface: ProviderConnectionLifecycle"})}),"\n",(0,r.jsx)(n.h2,{id:"methods",children:"Methods"}),"\n",(0,r.jsx)(n.h3,{id:"delete",children:"delete()?"}),"\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:"delete"}),"(",(0,r.jsx)(n.code,{children:"logger"}),"?): ",(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:"logger?"}),": ",(0,r.jsx)(n.a,{href:"/api/interfaces/Logger",children:(0,r.jsx)(n.code,{children:"Logger"})})]}),"\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:"defined-in",children:"Defined in"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L345",children:"packages/extension-api/src/extension-api.d.ts:345"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"edit",children:"edit()?"}),"\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:"edit"}),"(",(0,r.jsx)(n.code,{children:"editContext"}),", ",(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-1",children:"Parameters"}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"editContext"}),": ",(0,r.jsx)(n.a,{href:"/api/interfaces/LifecycleContext",children:(0,r.jsx)(n.code,{children:"LifecycleContext"})})]}),"\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-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:"defined-in-1",children:"Defined in"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L346",children:"packages/extension-api/src/extension-api.d.ts:346"})}),"\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.code,{children:"optional"})," ",(0,r.jsx)(n.strong,{children:"start"}),"(",(0,r.jsx)(n.code,{children:"startContext"}),", ",(0,r.jsx)(n.code,{children:"logger"}),"?): ",(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:"startContext"}),": ",(0,r.jsx)(n.a,{href:"/api/interfaces/LifecycleContext",children:(0,r.jsx)(n.code,{children:"LifecycleContext"})})]}),"\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.jsx)(n.h4,{id:"returns-2",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:"defined-in-2",children:"Defined in"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L343",children:"packages/extension-api/src/extension-api.d.ts:343"})}),"\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.code,{children:"optional"})," ",(0,r.jsx)(n.strong,{children:"stop"}),"(",(0,r.jsx)(n.code,{children:"stopContext"}),", ",(0,r.jsx)(n.code,{children:"logger"}),"?): ",(0,r.jsx)(n.code,{children:"Promise"}),"<",(0,r.jsx)(n.code,{children:"void"}),">"]}),"\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:"stopContext"}),": ",(0,r.jsx)(n.a,{href:"/api/interfaces/LifecycleContext",children:(0,r.jsx)(n.code,{children:"LifecycleContext"})})]}),"\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.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:"defined-in-3",children:"Defined in"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/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,s.R)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(a,{...e})}):a(e)}},43023:(e,n,i)=>{i.d(n,{R:()=>c,x:()=>t});var r=i(63696);const s={},d=r.createContext(s);function c(e){const n=r.useContext(d);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(s):e.components||s:c(e.components),r.createElement(d.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[43169],{6170:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>o,contentTitle:()=>c,default:()=>h,frontMatter:()=>d,metadata:()=>t,toc:()=>l});var r=i(62540),s=i(43023);const d={},c="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"}},o={},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:"Defined in",id:"defined-in",level:4},{value:"edit()?",id:"edit",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"start()?",id:"start",level:3},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"stop()?",id:"stop",level:3},{value:"Parameters",id:"parameters-3",level:4},{value:"Returns",id:"returns-3",level:4},{value:"Defined in",id:"defined-in-3",level:4}];function a(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",p:"p",strong:"strong",...(0,s.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.header,{children:(0,r.jsx)(n.h1,{id:"interface-providerconnectionlifecycle",children:"Interface: ProviderConnectionLifecycle"})}),"\n",(0,r.jsx)(n.h2,{id:"methods",children:"Methods"}),"\n",(0,r.jsx)(n.h3,{id:"delete",children:"delete()?"}),"\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:"delete"}),"(",(0,r.jsx)(n.code,{children:"logger"}),"?): ",(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:"logger?"}),": ",(0,r.jsx)(n.a,{href:"/api/interfaces/Logger",children:(0,r.jsx)(n.code,{children:"Logger"})})]}),"\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:"defined-in",children:"Defined in"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L345",children:"packages/extension-api/src/extension-api.d.ts:345"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"edit",children:"edit()?"}),"\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:"edit"}),"(",(0,r.jsx)(n.code,{children:"editContext"}),", ",(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-1",children:"Parameters"}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"editContext"}),": ",(0,r.jsx)(n.a,{href:"/api/interfaces/LifecycleContext",children:(0,r.jsx)(n.code,{children:"LifecycleContext"})})]}),"\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-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:"defined-in-1",children:"Defined in"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L346",children:"packages/extension-api/src/extension-api.d.ts:346"})}),"\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.code,{children:"optional"})," ",(0,r.jsx)(n.strong,{children:"start"}),"(",(0,r.jsx)(n.code,{children:"startContext"}),", ",(0,r.jsx)(n.code,{children:"logger"}),"?): ",(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:"startContext"}),": ",(0,r.jsx)(n.a,{href:"/api/interfaces/LifecycleContext",children:(0,r.jsx)(n.code,{children:"LifecycleContext"})})]}),"\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.jsx)(n.h4,{id:"returns-2",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:"defined-in-2",children:"Defined in"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L343",children:"packages/extension-api/src/extension-api.d.ts:343"})}),"\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.code,{children:"optional"})," ",(0,r.jsx)(n.strong,{children:"stop"}),"(",(0,r.jsx)(n.code,{children:"stopContext"}),", ",(0,r.jsx)(n.code,{children:"logger"}),"?): ",(0,r.jsx)(n.code,{children:"Promise"}),"<",(0,r.jsx)(n.code,{children:"void"}),">"]}),"\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:"stopContext"}),": ",(0,r.jsx)(n.a,{href:"/api/interfaces/LifecycleContext",children:(0,r.jsx)(n.code,{children:"LifecycleContext"})})]}),"\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.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:"defined-in-3",children:"Defined in"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/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,s.R)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(a,{...e})}):a(e)}},43023:(e,n,i)=>{i.d(n,{R:()=>c,x:()=>t});var r=i(63696);const s={},d=r.createContext(s);function c(e){const n=r.useContext(d);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(s):e.components||s:c(e.components),r.createElement(d.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/cb0f21df.0c11d352.js b/assets/js/cb0f21df.f5b4fbd4.js similarity index 93% rename from assets/js/cb0f21df.0c11d352.js rename to assets/js/cb0f21df.f5b4fbd4.js index 6a071fc3f71..20b86cc5018 100644 --- a/assets/js/cb0f21df.0c11d352.js +++ b/assets/js/cb0f21df.f5b4fbd4.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[37163],{68214:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>d,contentTitle:()=>o,default:()=>l,frontMatter:()=>r,metadata:()=>c,toc:()=>a});var i=t(62540),s=t(43023);const r={},o="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"}},d={},a=[{value:"Properties",id:"properties",level:2},{value:"connection",id:"connection",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"providerId",id:"providerid",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"status",id:"status",level:3},{value:"Defined in",id:"defined-in-2",level:4}];function p(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",p:"p",strong:"strong",...(0,s.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.header,{children:(0,i.jsx)(n.h1,{id:"interface-updatekubernetesconnectionevent",children:"Interface: UpdateKubernetesConnectionEvent"})}),"\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/KubernetesProviderConnection",children:(0,i.jsx)(n.code,{children:"KubernetesProviderConnection"})})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L704",children:"packages/extension-api/src/extension-api.d.ts:704"})}),"\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:"defined-in-1",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L703",children:"packages/extension-api/src/extension-api.d.ts:703"})}),"\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:"defined-in-2",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L705",children:"packages/extension-api/src/extension-api.d.ts:705"})})]})}function l(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(p,{...e})}):p(e)}},43023:(e,n,t)=>{t.d(n,{R:()=>o,x:()=>c});var i=t(63696);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([[37163],{68214:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>d,contentTitle:()=>o,default:()=>l,frontMatter:()=>r,metadata:()=>c,toc:()=>a});var i=t(62540),s=t(43023);const r={},o="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"}},d={},a=[{value:"Properties",id:"properties",level:2},{value:"connection",id:"connection",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"providerId",id:"providerid",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"status",id:"status",level:3},{value:"Defined in",id:"defined-in-2",level:4}];function p(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",p:"p",strong:"strong",...(0,s.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.header,{children:(0,i.jsx)(n.h1,{id:"interface-updatekubernetesconnectionevent",children:"Interface: UpdateKubernetesConnectionEvent"})}),"\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/KubernetesProviderConnection",children:(0,i.jsx)(n.code,{children:"KubernetesProviderConnection"})})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L704",children:"packages/extension-api/src/extension-api.d.ts:704"})}),"\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:"defined-in-1",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L703",children:"packages/extension-api/src/extension-api.d.ts:703"})}),"\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:"defined-in-2",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L705",children:"packages/extension-api/src/extension-api.d.ts:705"})})]})}function l(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(p,{...e})}):p(e)}},43023:(e,n,t)=>{t.d(n,{R:()=>o,x:()=>c});var i=t(63696);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/cc6d9416.f225b235.js b/assets/js/cc6d9416.af7a3a48.js similarity index 88% rename from assets/js/cc6d9416.f225b235.js rename to assets/js/cc6d9416.af7a3a48.js index 91ca165b6bb..bf0c30c474f 100644 --- a/assets/js/cc6d9416.f225b235.js +++ b/assets/js/cc6d9416.af7a3a48.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[73425],{8377:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>o,contentTitle:()=>d,default:()=>h,frontMatter:()=>r,metadata:()=>a,toc:()=>c});var s=i(62540),t=i(43023);const r={},d="Interface: AuthConfig",a={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"}},o={},c=[{value:"Properties",id:"properties",level:2},{value:"email?",id:"email",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"password",id:"password",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"serveraddress",id:"serveraddress",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"username",id:"username",level:3},{value:"Defined in",id:"defined-in-3",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",p:"p",strong:"strong",...(0,t.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.header,{children:(0,s.jsx)(n.h1,{id:"interface-authconfig",children:"Interface: AuthConfig"})}),"\n",(0,s.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,s.jsx)(n.h3,{id:"email",children:"email?"}),"\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:"email"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2365",children:"packages/extension-api/src/extension-api.d.ts:2365"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"password",children:"password"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"password"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2363",children:"packages/extension-api/src/extension-api.d.ts:2363"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"serveraddress",children:"serveraddress"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"serveraddress"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-2",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2364",children:"packages/extension-api/src/extension-api.d.ts:2364"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"username",children:"username"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"username"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-3",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2362",children:"packages/extension-api/src/extension-api.d.ts:2362"})})]})}function h(e={}){const{wrapper:n}={...(0,t.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},43023:(e,n,i)=>{i.d(n,{R:()=>d,x:()=>a});var s=i(63696);const t={},r=s.createContext(t);function d(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(t):e.components||t:d(e.components),s.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[73425],{8377:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>o,contentTitle:()=>d,default:()=>h,frontMatter:()=>r,metadata:()=>a,toc:()=>c});var s=i(62540),t=i(43023);const r={},d="Interface: AuthConfig",a={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"}},o={},c=[{value:"Properties",id:"properties",level:2},{value:"email?",id:"email",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"password",id:"password",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"serveraddress",id:"serveraddress",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"username",id:"username",level:3},{value:"Defined in",id:"defined-in-3",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",p:"p",strong:"strong",...(0,t.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.header,{children:(0,s.jsx)(n.h1,{id:"interface-authconfig",children:"Interface: AuthConfig"})}),"\n",(0,s.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,s.jsx)(n.h3,{id:"email",children:"email?"}),"\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:"email"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2365",children:"packages/extension-api/src/extension-api.d.ts:2365"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"password",children:"password"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"password"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2363",children:"packages/extension-api/src/extension-api.d.ts:2363"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"serveraddress",children:"serveraddress"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"serveraddress"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-2",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2364",children:"packages/extension-api/src/extension-api.d.ts:2364"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"username",children:"username"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"username"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-3",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2362",children:"packages/extension-api/src/extension-api.d.ts:2362"})})]})}function h(e={}){const{wrapper:n}={...(0,t.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},43023:(e,n,i)=>{i.d(n,{R:()=>d,x:()=>a});var s=i(63696);const t={},r=s.createContext(t);function d(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(t):e.components||t:d(e.components),s.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/cc922df3.4bced26e.js b/assets/js/cc922df3.d86c6415.js similarity index 95% rename from assets/js/cc922df3.4bced26e.js rename to assets/js/cc922df3.d86c6415.js index 13170b4a16c..6a48bfb66da 100644 --- a/assets/js/cc922df3.4bced26e.js +++ b/assets/js/cc922df3.d86c6415.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[9383],{14527:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>c,contentTitle:()=>r,default:()=>h,frontMatter:()=>o,metadata:()=>a,toc:()=>d});var t=i(62540),s=i(43023);const o={},r="Interface: AuthenticationGetSessionOptions",a={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"}},c={},d=[{value:"Properties",id:"properties",level:2},{value:"clearSessionPreference?",id:"clearsessionpreference",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"createIfNone?",id:"createifnone",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"forceNewSession?",id:"forcenewsession",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"silent?",id:"silent",level:3},{value:"Defined in",id:"defined-in-3",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",p:"p",strong:"strong",...(0,s.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.header,{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:"defined-in",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L3766",children:"packages/extension-api/src/extension-api.d.ts:3766"})}),"\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:"defined-in-1",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L3755",children:"packages/extension-api/src/extension-api.d.ts:3755"})}),"\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:"defined-in-2",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L3779",children:"packages/extension-api/src/extension-api.d.ts:3779"})}),"\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:"defined-in-3",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L3791",children:"packages/extension-api/src/extension-api.d.ts:3791"})})]})}function h(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},43023:(e,n,i)=>{i.d(n,{R:()=>r,x:()=>a});var t=i(63696);const s={},o=t.createContext(s);function r(e){const n=t.useContext(o);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function a(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:r(e.components),t.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[9383],{14527:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>c,contentTitle:()=>r,default:()=>h,frontMatter:()=>o,metadata:()=>a,toc:()=>d});var t=i(62540),s=i(43023);const o={},r="Interface: AuthenticationGetSessionOptions",a={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"}},c={},d=[{value:"Properties",id:"properties",level:2},{value:"clearSessionPreference?",id:"clearsessionpreference",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"createIfNone?",id:"createifnone",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"forceNewSession?",id:"forcenewsession",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"silent?",id:"silent",level:3},{value:"Defined in",id:"defined-in-3",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",p:"p",strong:"strong",...(0,s.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.header,{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:"defined-in",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L3766",children:"packages/extension-api/src/extension-api.d.ts:3766"})}),"\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:"defined-in-1",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L3755",children:"packages/extension-api/src/extension-api.d.ts:3755"})}),"\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:"defined-in-2",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L3779",children:"packages/extension-api/src/extension-api.d.ts:3779"})}),"\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:"defined-in-3",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L3791",children:"packages/extension-api/src/extension-api.d.ts:3791"})})]})}function h(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},43023:(e,n,i)=>{i.d(n,{R:()=>r,x:()=>a});var t=i(63696);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/cdf64ea9.cf0c74b2.js b/assets/js/cdf64ea9.fbb6071f.js similarity index 90% rename from assets/js/cdf64ea9.cf0c74b2.js rename to assets/js/cdf64ea9.fbb6071f.js index d4ed90ca6b1..ebd6d5e8520 100644 --- a/assets/js/cdf64ea9.cf0c74b2.js +++ b/assets/js/cdf64ea9.fbb6071f.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[52065],{3180:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>l,contentTitle:()=>c,default:()=>h,frontMatter:()=>r,metadata:()=>t,toc:()=>o});var d=i(62540),s=i(43023);const r={},c="Interface: RunError",t={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"}},l={},o=[{value:"Extends",id:"extends",level:2},{value:"Properties",id:"properties",level:2},{value:"cancelled",id:"cancelled",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"cause?",id:"cause",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"command",id:"command",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"exitCode",id:"exitcode",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"killed",id:"killed",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"message",id:"message",level:3},{value:"Overrides",id:"overrides",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"name",id:"name",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"stack?",id:"stack",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-7",level:4},{value:"stderr",id:"stderr",level:3},{value:"Defined in",id:"defined-in-8",level:4},{value:"stdout",id:"stdout",level:3},{value:"Defined in",id:"defined-in-9",level:4}];function a(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",li:"li",p:"p",strong:"strong",ul:"ul",...(0,s.R)(),...e.components};return(0,d.jsxs)(d.Fragment,{children:[(0,d.jsx)(n.header,{children:(0,d.jsx)(n.h1,{id:"interface-runerror",children:"Interface: RunError"})}),"\n",(0,d.jsx)(n.p,{children:"Represents an error that occurred during the execution of a command."}),"\n",(0,d.jsx)(n.h2,{id:"extends",children:"Extends"}),"\n",(0,d.jsxs)(n.ul,{children:["\n",(0,d.jsx)(n.li,{children:(0,d.jsx)(n.code,{children:"Error"})}),"\n"]}),"\n",(0,d.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,d.jsx)(n.h3,{id:"cancelled",children:"cancelled"}),"\n",(0,d.jsxs)(n.blockquote,{children:["\n",(0,d.jsxs)(n.p,{children:[(0,d.jsx)(n.strong,{children:"cancelled"}),": ",(0,d.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,d.jsx)(n.p,{children:"Indicates whether the execution was cancelled."}),"\n",(0,d.jsx)(n.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,d.jsx)(n.p,{children:(0,d.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L4116",children:"packages/extension-api/src/extension-api.d.ts:4116"})}),"\n",(0,d.jsx)(n.hr,{}),"\n",(0,d.jsx)(n.h3,{id:"cause",children:"cause?"}),"\n",(0,d.jsxs)(n.blockquote,{children:["\n",(0,d.jsxs)(n.p,{children:[(0,d.jsx)(n.code,{children:"optional"})," ",(0,d.jsx)(n.strong,{children:"cause"}),": ",(0,d.jsx)(n.code,{children:"unknown"})]}),"\n"]}),"\n",(0,d.jsx)(n.h4,{id:"inherited-from",children:"Inherited from"}),"\n",(0,d.jsx)(n.p,{children:(0,d.jsx)(n.code,{children:"Error.cause"})}),"\n",(0,d.jsx)(n.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,d.jsx)(n.p,{children:"node_modules/typescript/lib/lib.es2022.error.d.ts:24"}),"\n",(0,d.jsx)(n.hr,{}),"\n",(0,d.jsx)(n.h3,{id:"command",children:"command"}),"\n",(0,d.jsxs)(n.blockquote,{children:["\n",(0,d.jsxs)(n.p,{children:[(0,d.jsx)(n.strong,{children:"command"}),": ",(0,d.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,d.jsx)(n.p,{children:"The command that was executed."}),"\n",(0,d.jsx)(n.h4,{id:"defined-in-2",children:"Defined in"}),"\n",(0,d.jsx)(n.p,{children:(0,d.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L4101",children:"packages/extension-api/src/extension-api.d.ts:4101"})}),"\n",(0,d.jsx)(n.hr,{}),"\n",(0,d.jsx)(n.h3,{id:"exitcode",children:"exitCode"}),"\n",(0,d.jsxs)(n.blockquote,{children:["\n",(0,d.jsxs)(n.p,{children:[(0,d.jsx)(n.strong,{children:"exitCode"}),": ",(0,d.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,d.jsx)(n.p,{children:"The exit code of the command."}),"\n",(0,d.jsx)(n.h4,{id:"defined-in-3",children:"Defined in"}),"\n",(0,d.jsx)(n.p,{children:(0,d.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L4096",children:"packages/extension-api/src/extension-api.d.ts:4096"})}),"\n",(0,d.jsx)(n.hr,{}),"\n",(0,d.jsx)(n.h3,{id:"killed",children:"killed"}),"\n",(0,d.jsxs)(n.blockquote,{children:["\n",(0,d.jsxs)(n.p,{children:[(0,d.jsx)(n.strong,{children:"killed"}),": ",(0,d.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,d.jsx)(n.p,{children:"Indicates whether the process was forcefully killed."}),"\n",(0,d.jsx)(n.h4,{id:"defined-in-4",children:"Defined in"}),"\n",(0,d.jsx)(n.p,{children:(0,d.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L4121",children:"packages/extension-api/src/extension-api.d.ts:4121"})}),"\n",(0,d.jsx)(n.hr,{}),"\n",(0,d.jsx)(n.h3,{id:"message",children:"message"}),"\n",(0,d.jsxs)(n.blockquote,{children:["\n",(0,d.jsxs)(n.p,{children:[(0,d.jsx)(n.strong,{children:"message"}),": ",(0,d.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,d.jsx)(n.p,{children:"The error message."}),"\n",(0,d.jsx)(n.h4,{id:"overrides",children:"Overrides"}),"\n",(0,d.jsx)(n.p,{children:(0,d.jsx)(n.code,{children:"Error.message"})}),"\n",(0,d.jsx)(n.h4,{id:"defined-in-5",children:"Defined in"}),"\n",(0,d.jsx)(n.p,{children:(0,d.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L4091",children:"packages/extension-api/src/extension-api.d.ts:4091"})}),"\n",(0,d.jsx)(n.hr,{}),"\n",(0,d.jsx)(n.h3,{id:"name",children:"name"}),"\n",(0,d.jsxs)(n.blockquote,{children:["\n",(0,d.jsxs)(n.p,{children:[(0,d.jsx)(n.strong,{children:"name"}),": ",(0,d.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,d.jsx)(n.h4,{id:"inherited-from-1",children:"Inherited from"}),"\n",(0,d.jsx)(n.p,{children:(0,d.jsx)(n.code,{children:"Error.name"})}),"\n",(0,d.jsx)(n.h4,{id:"defined-in-6",children:"Defined in"}),"\n",(0,d.jsx)(n.p,{children:"node_modules/typescript/lib/lib.es5.d.ts:1076"}),"\n",(0,d.jsx)(n.hr,{}),"\n",(0,d.jsx)(n.h3,{id:"stack",children:"stack?"}),"\n",(0,d.jsxs)(n.blockquote,{children:["\n",(0,d.jsxs)(n.p,{children:[(0,d.jsx)(n.code,{children:"optional"})," ",(0,d.jsx)(n.strong,{children:"stack"}),": ",(0,d.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,d.jsx)(n.h4,{id:"inherited-from-2",children:"Inherited from"}),"\n",(0,d.jsx)(n.p,{children:(0,d.jsx)(n.code,{children:"Error.stack"})}),"\n",(0,d.jsx)(n.h4,{id:"defined-in-7",children:"Defined in"}),"\n",(0,d.jsx)(n.p,{children:"node_modules/typescript/lib/lib.es5.d.ts:1078"}),"\n",(0,d.jsx)(n.hr,{}),"\n",(0,d.jsx)(n.h3,{id:"stderr",children:"stderr"}),"\n",(0,d.jsxs)(n.blockquote,{children:["\n",(0,d.jsxs)(n.p,{children:[(0,d.jsx)(n.strong,{children:"stderr"}),": ",(0,d.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,d.jsx)(n.p,{children:"The standard error (stderr) content of the command."}),"\n",(0,d.jsx)(n.h4,{id:"defined-in-8",children:"Defined in"}),"\n",(0,d.jsx)(n.p,{children:(0,d.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L4111",children:"packages/extension-api/src/extension-api.d.ts:4111"})}),"\n",(0,d.jsx)(n.hr,{}),"\n",(0,d.jsx)(n.h3,{id:"stdout",children:"stdout"}),"\n",(0,d.jsxs)(n.blockquote,{children:["\n",(0,d.jsxs)(n.p,{children:[(0,d.jsx)(n.strong,{children:"stdout"}),": ",(0,d.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,d.jsx)(n.p,{children:"The standard output (stdout) content of the command."}),"\n",(0,d.jsx)(n.h4,{id:"defined-in-9",children:"Defined in"}),"\n",(0,d.jsx)(n.p,{children:(0,d.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L4106",children:"packages/extension-api/src/extension-api.d.ts:4106"})})]})}function h(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,d.jsx)(n,{...e,children:(0,d.jsx)(a,{...e})}):a(e)}},43023:(e,n,i)=>{i.d(n,{R:()=>c,x:()=>t});var d=i(63696);const s={},r=d.createContext(s);function c(e){const n=d.useContext(r);return d.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(s):e.components||s:c(e.components),d.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[52065],{3180:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>l,contentTitle:()=>c,default:()=>h,frontMatter:()=>r,metadata:()=>t,toc:()=>o});var d=i(62540),s=i(43023);const r={},c="Interface: RunError",t={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"}},l={},o=[{value:"Extends",id:"extends",level:2},{value:"Properties",id:"properties",level:2},{value:"cancelled",id:"cancelled",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"cause?",id:"cause",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"command",id:"command",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"exitCode",id:"exitcode",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"killed",id:"killed",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"message",id:"message",level:3},{value:"Overrides",id:"overrides",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"name",id:"name",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"stack?",id:"stack",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-7",level:4},{value:"stderr",id:"stderr",level:3},{value:"Defined in",id:"defined-in-8",level:4},{value:"stdout",id:"stdout",level:3},{value:"Defined in",id:"defined-in-9",level:4}];function a(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",li:"li",p:"p",strong:"strong",ul:"ul",...(0,s.R)(),...e.components};return(0,d.jsxs)(d.Fragment,{children:[(0,d.jsx)(n.header,{children:(0,d.jsx)(n.h1,{id:"interface-runerror",children:"Interface: RunError"})}),"\n",(0,d.jsx)(n.p,{children:"Represents an error that occurred during the execution of a command."}),"\n",(0,d.jsx)(n.h2,{id:"extends",children:"Extends"}),"\n",(0,d.jsxs)(n.ul,{children:["\n",(0,d.jsx)(n.li,{children:(0,d.jsx)(n.code,{children:"Error"})}),"\n"]}),"\n",(0,d.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,d.jsx)(n.h3,{id:"cancelled",children:"cancelled"}),"\n",(0,d.jsxs)(n.blockquote,{children:["\n",(0,d.jsxs)(n.p,{children:[(0,d.jsx)(n.strong,{children:"cancelled"}),": ",(0,d.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,d.jsx)(n.p,{children:"Indicates whether the execution was cancelled."}),"\n",(0,d.jsx)(n.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,d.jsx)(n.p,{children:(0,d.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L4116",children:"packages/extension-api/src/extension-api.d.ts:4116"})}),"\n",(0,d.jsx)(n.hr,{}),"\n",(0,d.jsx)(n.h3,{id:"cause",children:"cause?"}),"\n",(0,d.jsxs)(n.blockquote,{children:["\n",(0,d.jsxs)(n.p,{children:[(0,d.jsx)(n.code,{children:"optional"})," ",(0,d.jsx)(n.strong,{children:"cause"}),": ",(0,d.jsx)(n.code,{children:"unknown"})]}),"\n"]}),"\n",(0,d.jsx)(n.h4,{id:"inherited-from",children:"Inherited from"}),"\n",(0,d.jsx)(n.p,{children:(0,d.jsx)(n.code,{children:"Error.cause"})}),"\n",(0,d.jsx)(n.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,d.jsx)(n.p,{children:"node_modules/typescript/lib/lib.es2022.error.d.ts:24"}),"\n",(0,d.jsx)(n.hr,{}),"\n",(0,d.jsx)(n.h3,{id:"command",children:"command"}),"\n",(0,d.jsxs)(n.blockquote,{children:["\n",(0,d.jsxs)(n.p,{children:[(0,d.jsx)(n.strong,{children:"command"}),": ",(0,d.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,d.jsx)(n.p,{children:"The command that was executed."}),"\n",(0,d.jsx)(n.h4,{id:"defined-in-2",children:"Defined in"}),"\n",(0,d.jsx)(n.p,{children:(0,d.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L4101",children:"packages/extension-api/src/extension-api.d.ts:4101"})}),"\n",(0,d.jsx)(n.hr,{}),"\n",(0,d.jsx)(n.h3,{id:"exitcode",children:"exitCode"}),"\n",(0,d.jsxs)(n.blockquote,{children:["\n",(0,d.jsxs)(n.p,{children:[(0,d.jsx)(n.strong,{children:"exitCode"}),": ",(0,d.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,d.jsx)(n.p,{children:"The exit code of the command."}),"\n",(0,d.jsx)(n.h4,{id:"defined-in-3",children:"Defined in"}),"\n",(0,d.jsx)(n.p,{children:(0,d.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L4096",children:"packages/extension-api/src/extension-api.d.ts:4096"})}),"\n",(0,d.jsx)(n.hr,{}),"\n",(0,d.jsx)(n.h3,{id:"killed",children:"killed"}),"\n",(0,d.jsxs)(n.blockquote,{children:["\n",(0,d.jsxs)(n.p,{children:[(0,d.jsx)(n.strong,{children:"killed"}),": ",(0,d.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,d.jsx)(n.p,{children:"Indicates whether the process was forcefully killed."}),"\n",(0,d.jsx)(n.h4,{id:"defined-in-4",children:"Defined in"}),"\n",(0,d.jsx)(n.p,{children:(0,d.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L4121",children:"packages/extension-api/src/extension-api.d.ts:4121"})}),"\n",(0,d.jsx)(n.hr,{}),"\n",(0,d.jsx)(n.h3,{id:"message",children:"message"}),"\n",(0,d.jsxs)(n.blockquote,{children:["\n",(0,d.jsxs)(n.p,{children:[(0,d.jsx)(n.strong,{children:"message"}),": ",(0,d.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,d.jsx)(n.p,{children:"The error message."}),"\n",(0,d.jsx)(n.h4,{id:"overrides",children:"Overrides"}),"\n",(0,d.jsx)(n.p,{children:(0,d.jsx)(n.code,{children:"Error.message"})}),"\n",(0,d.jsx)(n.h4,{id:"defined-in-5",children:"Defined in"}),"\n",(0,d.jsx)(n.p,{children:(0,d.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L4091",children:"packages/extension-api/src/extension-api.d.ts:4091"})}),"\n",(0,d.jsx)(n.hr,{}),"\n",(0,d.jsx)(n.h3,{id:"name",children:"name"}),"\n",(0,d.jsxs)(n.blockquote,{children:["\n",(0,d.jsxs)(n.p,{children:[(0,d.jsx)(n.strong,{children:"name"}),": ",(0,d.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,d.jsx)(n.h4,{id:"inherited-from-1",children:"Inherited from"}),"\n",(0,d.jsx)(n.p,{children:(0,d.jsx)(n.code,{children:"Error.name"})}),"\n",(0,d.jsx)(n.h4,{id:"defined-in-6",children:"Defined in"}),"\n",(0,d.jsx)(n.p,{children:"node_modules/typescript/lib/lib.es5.d.ts:1076"}),"\n",(0,d.jsx)(n.hr,{}),"\n",(0,d.jsx)(n.h3,{id:"stack",children:"stack?"}),"\n",(0,d.jsxs)(n.blockquote,{children:["\n",(0,d.jsxs)(n.p,{children:[(0,d.jsx)(n.code,{children:"optional"})," ",(0,d.jsx)(n.strong,{children:"stack"}),": ",(0,d.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,d.jsx)(n.h4,{id:"inherited-from-2",children:"Inherited from"}),"\n",(0,d.jsx)(n.p,{children:(0,d.jsx)(n.code,{children:"Error.stack"})}),"\n",(0,d.jsx)(n.h4,{id:"defined-in-7",children:"Defined in"}),"\n",(0,d.jsx)(n.p,{children:"node_modules/typescript/lib/lib.es5.d.ts:1078"}),"\n",(0,d.jsx)(n.hr,{}),"\n",(0,d.jsx)(n.h3,{id:"stderr",children:"stderr"}),"\n",(0,d.jsxs)(n.blockquote,{children:["\n",(0,d.jsxs)(n.p,{children:[(0,d.jsx)(n.strong,{children:"stderr"}),": ",(0,d.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,d.jsx)(n.p,{children:"The standard error (stderr) content of the command."}),"\n",(0,d.jsx)(n.h4,{id:"defined-in-8",children:"Defined in"}),"\n",(0,d.jsx)(n.p,{children:(0,d.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L4111",children:"packages/extension-api/src/extension-api.d.ts:4111"})}),"\n",(0,d.jsx)(n.hr,{}),"\n",(0,d.jsx)(n.h3,{id:"stdout",children:"stdout"}),"\n",(0,d.jsxs)(n.blockquote,{children:["\n",(0,d.jsxs)(n.p,{children:[(0,d.jsx)(n.strong,{children:"stdout"}),": ",(0,d.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,d.jsx)(n.p,{children:"The standard output (stdout) content of the command."}),"\n",(0,d.jsx)(n.h4,{id:"defined-in-9",children:"Defined in"}),"\n",(0,d.jsx)(n.p,{children:(0,d.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L4106",children:"packages/extension-api/src/extension-api.d.ts:4106"})})]})}function h(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,d.jsx)(n,{...e,children:(0,d.jsx)(a,{...e})}):a(e)}},43023:(e,n,i)=>{i.d(n,{R:()=>c,x:()=>t});var d=i(63696);const s={},r=d.createContext(s);function c(e){const n=d.useContext(r);return d.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(s):e.components||s:c(e.components),d.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/cf6b503e.87db4208.js b/assets/js/cf6b503e.2ca7514f.js similarity index 95% rename from assets/js/cf6b503e.87db4208.js rename to assets/js/cf6b503e.2ca7514f.js index cb7a44b158e..1b66f80b16a 100644 --- a/assets/js/cf6b503e.87db4208.js +++ b/assets/js/cf6b503e.2ca7514f.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[55395],{75736:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>c,contentTitle:()=>o,default:()=>p,frontMatter:()=>r,metadata:()=>d,toc:()=>l});var t=i(62540),s=i(43023);const r={},o="Interface: CliToolSelectUpdate",d={id:"interfaces/CliToolSelectUpdate",title:"Interface: CliToolSelectUpdate",description:"Properties",source:"@site/api/interfaces/CliToolSelectUpdate.md",sourceDirName:"interfaces",slug:"/interfaces/CliToolSelectUpdate",permalink:"/api/interfaces/CliToolSelectUpdate",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"CliToolOptions",permalink:"/api/interfaces/CliToolOptions"},next:{title:"CliToolUpdate",permalink:"/api/interfaces/CliToolUpdate"}},c={},l=[{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:"Defined in",id:"defined-in",level:4},{value:"selectVersion()",id:"selectversion",level:3},{value:"Returns",id:"returns-1",level:4},{value:"Defined in",id:"defined-in-1",level:4}];function a(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",p:"p",strong:"strong",...(0,s.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.header,{children:(0,t.jsx)(n.h1,{id:"interface-clitoolselectupdate",children:"Interface: CliToolSelectUpdate"})}),"\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:"defined-in",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L4353",children:"packages/extension-api/src/extension-api.d.ts:4353"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"selectversion",children:"selectVersion()"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"selectVersion"}),": () => ",(0,t.jsx)(n.code,{children:"Promise"}),"<",(0,t.jsx)(n.code,{children:"string"}),">"]}),"\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:"string"}),">"]}),"\n",(0,t.jsx)(n.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L4352",children:"packages/extension-api/src/extension-api.d.ts:4352"})})]})}function p(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(a,{...e})}):a(e)}},43023:(e,n,i)=>{i.d(n,{R:()=>o,x:()=>d});var t=i(63696);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 d(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 +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[55395],{75736:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>c,contentTitle:()=>o,default:()=>p,frontMatter:()=>r,metadata:()=>d,toc:()=>l});var t=i(62540),s=i(43023);const r={},o="Interface: CliToolSelectUpdate",d={id:"interfaces/CliToolSelectUpdate",title:"Interface: CliToolSelectUpdate",description:"Properties",source:"@site/api/interfaces/CliToolSelectUpdate.md",sourceDirName:"interfaces",slug:"/interfaces/CliToolSelectUpdate",permalink:"/api/interfaces/CliToolSelectUpdate",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"CliToolOptions",permalink:"/api/interfaces/CliToolOptions"},next:{title:"CliToolUpdate",permalink:"/api/interfaces/CliToolUpdate"}},c={},l=[{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:"Defined in",id:"defined-in",level:4},{value:"selectVersion()",id:"selectversion",level:3},{value:"Returns",id:"returns-1",level:4},{value:"Defined in",id:"defined-in-1",level:4}];function a(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",p:"p",strong:"strong",...(0,s.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.header,{children:(0,t.jsx)(n.h1,{id:"interface-clitoolselectupdate",children:"Interface: CliToolSelectUpdate"})}),"\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:"defined-in",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L4353",children:"packages/extension-api/src/extension-api.d.ts:4353"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"selectversion",children:"selectVersion()"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"selectVersion"}),": () => ",(0,t.jsx)(n.code,{children:"Promise"}),"<",(0,t.jsx)(n.code,{children:"string"}),">"]}),"\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:"string"}),">"]}),"\n",(0,t.jsx)(n.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L4352",children:"packages/extension-api/src/extension-api.d.ts:4352"})})]})}function p(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(a,{...e})}):a(e)}},43023:(e,n,i)=>{i.d(n,{R:()=>o,x:()=>d});var t=i(63696);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 d(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/cfdfe126.c777edc3.js b/assets/js/cfdfe126.3791b9be.js similarity index 96% rename from assets/js/cfdfe126.c777edc3.js rename to assets/js/cfdfe126.3791b9be.js index 7de734e3a51..0646e316e3d 100644 --- a/assets/js/cfdfe126.c777edc3.js +++ b/assets/js/cfdfe126.3791b9be.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[75204],{99038:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>c,contentTitle:()=>r,default:()=>l,frontMatter:()=>t,metadata:()=>a,toc:()=>d});var o=s(62540),i=s(43023);const t={},r="Function: showInformationMessage()",a={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"}},c={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Defined in",id:"defined-in",level:2}];function h(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",strong:"strong",...(0,i.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(n.header,{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:"defined-in",children:"Defined in"}),"\n",(0,o.jsx)(n.p,{children:(0,o.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L1893",children:"packages/extension-api/src/extension-api.d.ts:1893"})})]})}function l(e={}){const{wrapper:n}={...(0,i.R)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(h,{...e})}):h(e)}},43023:(e,n,s)=>{s.d(n,{R:()=>r,x:()=>a});var o=s(63696);const i={},t=o.createContext(i);function r(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:r(e.components),o.createElement(t.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[75204],{99038:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>c,contentTitle:()=>r,default:()=>l,frontMatter:()=>t,metadata:()=>a,toc:()=>d});var o=s(62540),i=s(43023);const t={},r="Function: showInformationMessage()",a={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"}},c={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Defined in",id:"defined-in",level:2}];function h(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",strong:"strong",...(0,i.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(n.header,{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:"defined-in",children:"Defined in"}),"\n",(0,o.jsx)(n.p,{children:(0,o.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L1893",children:"packages/extension-api/src/extension-api.d.ts:1893"})})]})}function l(e={}){const{wrapper:n}={...(0,i.R)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(h,{...e})}):h(e)}},43023:(e,n,s)=>{s.d(n,{R:()=>r,x:()=>a});var o=s(63696);const i={},t=o.createContext(i);function r(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:r(e.components),o.createElement(t.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/d103759a.f338dc48.js b/assets/js/d103759a.ecc95e40.js similarity index 98% rename from assets/js/d103759a.f338dc48.js rename to assets/js/d103759a.ecc95e40.js index 9c41c13ac8a..e80c2f5627f 100644 --- a/assets/js/d103759a.f338dc48.js +++ b/assets/js/d103759a.ecc95e40.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[56095],{75220:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>o,contentTitle:()=>i,default:()=>l,frontMatter:()=>s,metadata:()=>c,toc:()=>d});var r=n(62540),a=n(43023);const s={},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={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Defined in",id:"defined-in",level:2}];function u(e){const t={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",strong:"strong",...(0,a.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(t.header,{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:"defined-in",children:"Defined in"}),"\n",(0,r.jsx)(t.p,{children:(0,r.jsx)(t.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L1992",children:"packages/extension-api/src/extension-api.d.ts:1992"})})]})}function l(e={}){const{wrapper:t}={...(0,a.R)(),...e.components};return t?(0,r.jsx)(t,{...e,children:(0,r.jsx)(u,{...e})}):u(e)}},43023:(e,t,n)=>{n.d(t,{R:()=>i,x:()=>c});var r=n(63696);const a={},s=r.createContext(a);function i(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(a):e.components||a:i(e.components),r.createElement(s.Provider,{value:t},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[56095],{75220:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>o,contentTitle:()=>i,default:()=>l,frontMatter:()=>s,metadata:()=>c,toc:()=>d});var r=n(62540),a=n(43023);const s={},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={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Defined in",id:"defined-in",level:2}];function u(e){const t={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",strong:"strong",...(0,a.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(t.header,{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:"defined-in",children:"Defined in"}),"\n",(0,r.jsx)(t.p,{children:(0,r.jsx)(t.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L1992",children:"packages/extension-api/src/extension-api.d.ts:1992"})})]})}function l(e={}){const{wrapper:t}={...(0,a.R)(),...e.components};return t?(0,r.jsx)(t,{...e,children:(0,r.jsx)(u,{...e})}):u(e)}},43023:(e,t,n)=>{n.d(t,{R:()=>i,x:()=>c});var r=n(63696);const a={},s=r.createContext(a);function i(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(a):e.components||a:i(e.components),r.createElement(s.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/d1163e47.67818520.js b/assets/js/d1163e47.f901747c.js similarity index 97% rename from assets/js/d1163e47.67818520.js rename to assets/js/d1163e47.f901747c.js index 21f76d709fb..359b5264951 100644 --- a/assets/js/d1163e47.67818520.js +++ b/assets/js/d1163e47.f901747c.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[37736],{1277:(e,r,t)=>{t.r(r),t.d(r,{assets:()=>o,contentTitle:()=>c,default:()=>h,frontMatter:()=>i,metadata:()=>s,toc:()=>d});var n=t(62540),a=t(43023);const i={},c="Interface: ImageCheckerProviderMetadata",s={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"}},o={},d=[{value:"Properties",id:"properties",level:2},{value:"label",id:"label",level:3},{value:"Defined in",id:"defined-in",level:4}];function l(e){const r={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",p:"p",strong:"strong",...(0,a.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(r.header,{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:"defined-in",children:"Defined in"}),"\n",(0,n.jsx)(r.p,{children:(0,n.jsx)(r.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L4469",children:"packages/extension-api/src/extension-api.d.ts:4469"})})]})}function h(e={}){const{wrapper:r}={...(0,a.R)(),...e.components};return r?(0,n.jsx)(r,{...e,children:(0,n.jsx)(l,{...e})}):l(e)}},43023:(e,r,t)=>{t.d(r,{R:()=>c,x:()=>s});var n=t(63696);const a={},i=n.createContext(a);function c(e){const r=n.useContext(i);return n.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(a):e.components||a:c(e.components),n.createElement(i.Provider,{value:r},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[37736],{1277:(e,r,t)=>{t.r(r),t.d(r,{assets:()=>o,contentTitle:()=>c,default:()=>h,frontMatter:()=>i,metadata:()=>s,toc:()=>d});var n=t(62540),a=t(43023);const i={},c="Interface: ImageCheckerProviderMetadata",s={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"}},o={},d=[{value:"Properties",id:"properties",level:2},{value:"label",id:"label",level:3},{value:"Defined in",id:"defined-in",level:4}];function l(e){const r={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",p:"p",strong:"strong",...(0,a.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(r.header,{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:"defined-in",children:"Defined in"}),"\n",(0,n.jsx)(r.p,{children:(0,n.jsx)(r.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L4469",children:"packages/extension-api/src/extension-api.d.ts:4469"})})]})}function h(e={}){const{wrapper:r}={...(0,a.R)(),...e.components};return r?(0,n.jsx)(r,{...e,children:(0,n.jsx)(l,{...e})}):l(e)}},43023:(e,r,t)=>{t.d(r,{R:()=>c,x:()=>s});var n=t(63696);const a={},i=n.createContext(a);function c(e){const r=n.useContext(i);return n.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(a):e.components||a:c(e.components),n.createElement(i.Provider,{value:r},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/d46ef83d.e7fdae18.js b/assets/js/d46ef83d.6f935815.js similarity index 94% rename from assets/js/d46ef83d.e7fdae18.js rename to assets/js/d46ef83d.6f935815.js index bdba3538379..3ebe16354e7 100644 --- a/assets/js/d46ef83d.e7fdae18.js +++ b/assets/js/d46ef83d.6f935815.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[60759],{68627:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>c,contentTitle:()=>i,default:()=>l,frontMatter:()=>s,metadata:()=>r,toc:()=>p});var o=t(62540),a=t(43023);const s={},i="Type Alias: MountPropagation",r={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:"Defined in",id:"defined-in",level:2}];function d(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",strong:"strong",...(0,a.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(n.header,{children:(0,o.jsx)(n.h1,{id:"type-alias-mountpropagation",children:"Type Alias: MountPropagation"})}),"\n",(0,o.jsxs)(n.blockquote,{children:["\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.strong,{children:"MountPropagation"}),": ",(0,o.jsx)(n.code,{children:'"private"'})," | ",(0,o.jsx)(n.code,{children:'"rprivate"'})," | ",(0,o.jsx)(n.code,{children:'"shared"'})," | ",(0,o.jsx)(n.code,{children:'"rshared"'})," | ",(0,o.jsx)(n.code,{children:'"slave"'})," | ",(0,o.jsx)(n.code,{children:'"rslave"'})]}),"\n"]}),"\n",(0,o.jsx)(n.h2,{id:"defined-in",children:"Defined in"}),"\n",(0,o.jsx)(n.p,{children:(0,o.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2393",children:"packages/extension-api/src/extension-api.d.ts:2393"})})]})}function l(e={}){const{wrapper:n}={...(0,a.R)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(d,{...e})}):d(e)}},43023:(e,n,t)=>{t.d(n,{R:()=>i,x:()=>r});var o=t(63696);const a={},s=o.createContext(a);function i(e){const n=o.useContext(s);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(a):e.components||a:i(e.components),o.createElement(s.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[60759],{68627:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>c,contentTitle:()=>i,default:()=>l,frontMatter:()=>s,metadata:()=>r,toc:()=>p});var o=t(62540),a=t(43023);const s={},i="Type Alias: MountPropagation",r={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:"Defined in",id:"defined-in",level:2}];function d(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",strong:"strong",...(0,a.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(n.header,{children:(0,o.jsx)(n.h1,{id:"type-alias-mountpropagation",children:"Type Alias: MountPropagation"})}),"\n",(0,o.jsxs)(n.blockquote,{children:["\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.strong,{children:"MountPropagation"}),": ",(0,o.jsx)(n.code,{children:'"private"'})," | ",(0,o.jsx)(n.code,{children:'"rprivate"'})," | ",(0,o.jsx)(n.code,{children:'"shared"'})," | ",(0,o.jsx)(n.code,{children:'"rshared"'})," | ",(0,o.jsx)(n.code,{children:'"slave"'})," | ",(0,o.jsx)(n.code,{children:'"rslave"'})]}),"\n"]}),"\n",(0,o.jsx)(n.h2,{id:"defined-in",children:"Defined in"}),"\n",(0,o.jsx)(n.p,{children:(0,o.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2393",children:"packages/extension-api/src/extension-api.d.ts:2393"})})]})}function l(e={}){const{wrapper:n}={...(0,a.R)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(d,{...e})}):d(e)}},43023:(e,n,t)=>{t.d(n,{R:()=>i,x:()=>r});var o=t(63696);const a={},s=o.createContext(a);function i(e){const n=o.useContext(s);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(a):e.components||a:i(e.components),o.createElement(s.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/d496897e.8bbbe56e.js b/assets/js/d496897e.70f1437f.js similarity index 96% rename from assets/js/d496897e.8bbbe56e.js rename to assets/js/d496897e.70f1437f.js index 8dd42e39ffe..27db5154cab 100644 --- a/assets/js/d496897e.8bbbe56e.js +++ b/assets/js/d496897e.70f1437f.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[27895],{8066:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>d,contentTitle:()=>c,default:()=>p,frontMatter:()=>r,metadata:()=>o,toc:()=>a});var i=t(62540),s=t(43023);const r={},c="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:"Defined in",id:"defined-in",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",header:"header",p:"p",strong:"strong",...(0,s.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.header,{children:(0,i.jsx)(n.h1,{id:"function-createpod",children:"Function: createPod()"})}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"createPod"}),"(",(0,i.jsx)(n.code,{children:"podOptions"}),"): ",(0,i.jsx)(n.code,{children:"Promise"}),"<",(0,i.jsx)(n.code,{children:"object"}),">"]}),"\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:"podOptions"}),": ",(0,i.jsx)(n.a,{href:"/api/interfaces/PodCreateOptions",children:(0,i.jsx)(n.code,{children:"PodCreateOptions"})})]}),"\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:"object"}),">"]}),"\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.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.h2,{id:"defined-in",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L3680",children:"packages/extension-api/src/extension-api.d.ts:3680"})})]})}function p(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},43023:(e,n,t)=>{t.d(n,{R:()=>c,x:()=>o});var i=t(63696);const s={},r=i.createContext(s);function c(e){const n=i.useContext(r);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:c(e.components),i.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[27895],{8066:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>d,contentTitle:()=>c,default:()=>p,frontMatter:()=>r,metadata:()=>o,toc:()=>a});var i=t(62540),s=t(43023);const r={},c="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:"Defined in",id:"defined-in",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",header:"header",p:"p",strong:"strong",...(0,s.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.header,{children:(0,i.jsx)(n.h1,{id:"function-createpod",children:"Function: createPod()"})}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"createPod"}),"(",(0,i.jsx)(n.code,{children:"podOptions"}),"): ",(0,i.jsx)(n.code,{children:"Promise"}),"<",(0,i.jsx)(n.code,{children:"object"}),">"]}),"\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:"podOptions"}),": ",(0,i.jsx)(n.a,{href:"/api/interfaces/PodCreateOptions",children:(0,i.jsx)(n.code,{children:"PodCreateOptions"})})]}),"\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:"object"}),">"]}),"\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.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.h2,{id:"defined-in",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L3680",children:"packages/extension-api/src/extension-api.d.ts:3680"})})]})}function p(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},43023:(e,n,t)=>{t.d(n,{R:()=>c,x:()=>o});var i=t(63696);const s={},r=i.createContext(s);function c(e){const n=i.useContext(r);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:c(e.components),i.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/d5f6644b.3798800d.js b/assets/js/d5f6644b.b5d0edc3.js similarity index 96% rename from assets/js/d5f6644b.3798800d.js rename to assets/js/d5f6644b.b5d0edc3.js index 25e17635ccc..1a668c1a3b3 100644 --- a/assets/js/d5f6644b.3798800d.js +++ b/assets/js/d5f6644b.b5d0edc3.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[87986],{82225:(e,s,n)=>{n.r(s),n.d(s,{assets:()=>c,contentTitle:()=>a,default:()=>h,frontMatter:()=>t,metadata:()=>l,toc:()=>o});var i=n(62540),r=n(43023);const t={},a="Interface: ImageFilesCallbacks",l={id:"interfaces/ImageFilesCallbacks",title:"Interface: ImageFilesCallbacks",description:"Interface to be implemented by image files providers",source:"@site/api/interfaces/ImageFilesCallbacks.md",sourceDirName:"interfaces",slug:"/interfaces/ImageFilesCallbacks",permalink:"/api/interfaces/ImageFilesCallbacks",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"ImageFileSymlink",permalink:"/api/interfaces/ImageFileSymlink"},next:{title:"ImageFilesProvider",permalink:"/api/interfaces/ImageFilesProvider"}},c={},o=[{value:"Methods",id:"methods",level:2},{value:"getFilesystemLayers()",id:"getfilesystemlayers",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Defined in",id:"defined-in",level:4}];function d(e){const s={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",p:"p",strong:"strong",...(0,r.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(s.header,{children:(0,i.jsx)(s.h1,{id:"interface-imagefilescallbacks",children:"Interface: ImageFilesCallbacks"})}),"\n",(0,i.jsx)(s.p,{children:"Interface to be implemented by image files providers"}),"\n",(0,i.jsx)(s.h2,{id:"methods",children:"Methods"}),"\n",(0,i.jsx)(s.h3,{id:"getfilesystemlayers",children:"getFilesystemLayers()"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"getFilesystemLayers"}),"(",(0,i.jsx)(s.code,{children:"image"}),", ",(0,i.jsx)(s.code,{children:"token"}),"?): ",(0,i.jsx)(s.a,{href:"/api/type-aliases/ProviderResult",children:(0,i.jsx)(s.code,{children:"ProviderResult"})}),"<",(0,i.jsx)(s.a,{href:"/api/interfaces/ImageFilesystemLayers",children:(0,i.jsx)(s.code,{children:"ImageFilesystemLayers"})}),">"]}),"\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:"image"}),": ",(0,i.jsx)(s.a,{href:"/api/interfaces/ImageInfo",children:(0,i.jsx)(s.code,{children:"ImageInfo"})})]}),"\n",(0,i.jsx)(s.p,{children:"Info about the image"}),"\n",(0,i.jsxs)(s.p,{children:["\u2022 ",(0,i.jsx)(s.strong,{children:"token?"}),": ",(0,i.jsx)(s.a,{href:"/api/interfaces/CancellationToken",children:(0,i.jsx)(s.code,{children:"CancellationToken"})})]}),"\n",(0,i.jsx)(s.p,{children:"a cancellation token the function can use to be informed when the caller asks for the operation to be cancelled"}),"\n",(0,i.jsx)(s.h4,{id:"returns",children:"Returns"}),"\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.a,{href:"/api/type-aliases/ProviderResult",children:(0,i.jsx)(s.code,{children:"ProviderResult"})}),"<",(0,i.jsx)(s.a,{href:"/api/interfaces/ImageFilesystemLayers",children:(0,i.jsx)(s.code,{children:"ImageFilesystemLayers"})}),">"]}),"\n",(0,i.jsx)(s.p,{children:"the complete result of the layers, either synchronously of through a Promise"}),"\n",(0,i.jsx)(s.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,i.jsx)(s.p,{children:(0,i.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L794",children:"packages/extension-api/src/extension-api.d.ts:794"})})]})}function h(e={}){const{wrapper:s}={...(0,r.R)(),...e.components};return s?(0,i.jsx)(s,{...e,children:(0,i.jsx)(d,{...e})}):d(e)}},43023:(e,s,n)=>{n.d(s,{R:()=>a,x:()=>l});var i=n(63696);const r={},t=i.createContext(r);function a(e){const s=i.useContext(t);return i.useMemo((function(){return"function"==typeof e?e(s):{...s,...e}}),[s,e])}function l(e){let s;return s=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:a(e.components),i.createElement(t.Provider,{value:s},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[87986],{82225:(e,s,n)=>{n.r(s),n.d(s,{assets:()=>c,contentTitle:()=>a,default:()=>h,frontMatter:()=>t,metadata:()=>l,toc:()=>o});var i=n(62540),r=n(43023);const t={},a="Interface: ImageFilesCallbacks",l={id:"interfaces/ImageFilesCallbacks",title:"Interface: ImageFilesCallbacks",description:"Interface to be implemented by image files providers",source:"@site/api/interfaces/ImageFilesCallbacks.md",sourceDirName:"interfaces",slug:"/interfaces/ImageFilesCallbacks",permalink:"/api/interfaces/ImageFilesCallbacks",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"ImageFileSymlink",permalink:"/api/interfaces/ImageFileSymlink"},next:{title:"ImageFilesProvider",permalink:"/api/interfaces/ImageFilesProvider"}},c={},o=[{value:"Methods",id:"methods",level:2},{value:"getFilesystemLayers()",id:"getfilesystemlayers",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Defined in",id:"defined-in",level:4}];function d(e){const s={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",p:"p",strong:"strong",...(0,r.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(s.header,{children:(0,i.jsx)(s.h1,{id:"interface-imagefilescallbacks",children:"Interface: ImageFilesCallbacks"})}),"\n",(0,i.jsx)(s.p,{children:"Interface to be implemented by image files providers"}),"\n",(0,i.jsx)(s.h2,{id:"methods",children:"Methods"}),"\n",(0,i.jsx)(s.h3,{id:"getfilesystemlayers",children:"getFilesystemLayers()"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"getFilesystemLayers"}),"(",(0,i.jsx)(s.code,{children:"image"}),", ",(0,i.jsx)(s.code,{children:"token"}),"?): ",(0,i.jsx)(s.a,{href:"/api/type-aliases/ProviderResult",children:(0,i.jsx)(s.code,{children:"ProviderResult"})}),"<",(0,i.jsx)(s.a,{href:"/api/interfaces/ImageFilesystemLayers",children:(0,i.jsx)(s.code,{children:"ImageFilesystemLayers"})}),">"]}),"\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:"image"}),": ",(0,i.jsx)(s.a,{href:"/api/interfaces/ImageInfo",children:(0,i.jsx)(s.code,{children:"ImageInfo"})})]}),"\n",(0,i.jsx)(s.p,{children:"Info about the image"}),"\n",(0,i.jsxs)(s.p,{children:["\u2022 ",(0,i.jsx)(s.strong,{children:"token?"}),": ",(0,i.jsx)(s.a,{href:"/api/interfaces/CancellationToken",children:(0,i.jsx)(s.code,{children:"CancellationToken"})})]}),"\n",(0,i.jsx)(s.p,{children:"a cancellation token the function can use to be informed when the caller asks for the operation to be cancelled"}),"\n",(0,i.jsx)(s.h4,{id:"returns",children:"Returns"}),"\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.a,{href:"/api/type-aliases/ProviderResult",children:(0,i.jsx)(s.code,{children:"ProviderResult"})}),"<",(0,i.jsx)(s.a,{href:"/api/interfaces/ImageFilesystemLayers",children:(0,i.jsx)(s.code,{children:"ImageFilesystemLayers"})}),">"]}),"\n",(0,i.jsx)(s.p,{children:"the complete result of the layers, either synchronously of through a Promise"}),"\n",(0,i.jsx)(s.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,i.jsx)(s.p,{children:(0,i.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L794",children:"packages/extension-api/src/extension-api.d.ts:794"})})]})}function h(e={}){const{wrapper:s}={...(0,r.R)(),...e.components};return s?(0,i.jsx)(s,{...e,children:(0,i.jsx)(d,{...e})}):d(e)}},43023:(e,s,n)=>{n.d(s,{R:()=>a,x:()=>l});var i=n(63696);const r={},t=i.createContext(r);function a(e){const s=i.useContext(t);return i.useMemo((function(){return"function"==typeof e?e(s):{...s,...e}}),[s,e])}function l(e){let s;return s=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:a(e.components),i.createElement(t.Provider,{value:s},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/d66cbd9e.a1c3f96e.js b/assets/js/d66cbd9e.043a29d6.js similarity index 74% rename from assets/js/d66cbd9e.a1c3f96e.js rename to assets/js/d66cbd9e.043a29d6.js index 93fbc1d6c90..f62a8c91f69 100644 --- a/assets/js/d66cbd9e.a1c3f96e.js +++ b/assets/js/d66cbd9e.043a29d6.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[73008],{91418:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>a,contentTitle:()=>d,default:()=>p,frontMatter:()=>s,metadata:()=>o,toc:()=>c});var t=i(62540),r=i(43023);const s={},d="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={},c=[{value:"Properties",id:"properties",level:2},{value:"IP",id:"ip",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"PrivatePort",id:"privateport",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"PublicPort",id:"publicport",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"Type",id:"type",level:3},{value:"Defined in",id:"defined-in-3",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",p:"p",strong:"strong",...(0,r.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.header,{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:"defined-in",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2318",children:"packages/extension-api/src/extension-api.d.ts:2318"})}),"\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:"defined-in-1",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2319",children:"packages/extension-api/src/extension-api.d.ts:2319"})}),"\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:"defined-in-2",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2320",children:"packages/extension-api/src/extension-api.d.ts:2320"})}),"\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:"defined-in-3",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2321",children:"packages/extension-api/src/extension-api.d.ts:2321"})})]})}function p(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},43023:(e,n,i)=>{i.d(n,{R:()=>d,x:()=>o});var t=i(63696);const r={},s=t.createContext(r);function d(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(r):e.components||r:d(e.components),t.createElement(s.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[73008],{91418:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>d,contentTitle:()=>o,default:()=>p,frontMatter:()=>s,metadata:()=>c,toc:()=>a});var t=i(62540),r=i(43023);const s={},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"}},d={},a=[{value:"Properties",id:"properties",level:2},{value:"IP",id:"ip",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"PrivatePort",id:"privateport",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"PublicPort",id:"publicport",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"Type",id:"type",level:3},{value:"Defined in",id:"defined-in-3",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",p:"p",strong:"strong",...(0,r.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.header,{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:"defined-in",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2318",children:"packages/extension-api/src/extension-api.d.ts:2318"})}),"\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:"defined-in-1",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2319",children:"packages/extension-api/src/extension-api.d.ts:2319"})}),"\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:"defined-in-2",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2320",children:"packages/extension-api/src/extension-api.d.ts:2320"})}),"\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:"defined-in-3",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2321",children:"packages/extension-api/src/extension-api.d.ts:2321"})})]})}function p(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},43023:(e,n,i)=>{i.d(n,{R:()=>o,x:()=>c});var t=i(63696);const r={},s=t.createContext(r);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(r):e.components||r:o(e.components),t.createElement(s.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/d739767a.5d9b422c.js b/assets/js/d739767a.4b20aeae.js similarity index 98% rename from assets/js/d739767a.5d9b422c.js rename to assets/js/d739767a.4b20aeae.js index 89e947a9005..07d60611c5d 100644 --- a/assets/js/d739767a.5d9b422c.js +++ b/assets/js/d739767a.4b20aeae.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[35327],{75345:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>c,contentTitle:()=>a,default:()=>h,frontMatter:()=>r,metadata:()=>l,toc:()=>d});var i=s(62540),t=s(43023);const r={},a="Function: onDidChangeTelemetryEnabled()",l={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"}},c={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Defined in",id:"defined-in",level:2}];function o(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",strong:"strong",...(0,t.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.header,{children:(0,i.jsx)(n.h1,{id:"function-ondidchangetelemetryenabled",children:"Function: onDidChangeTelemetryEnabled()"})}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"onDidChangeTelemetryEnabled"}),"(",(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:"/api/interfaces/Event",children:"Event"})," which fires when the user enabled or disables telemetry.\n",(0,i.jsx)(n.code,{children:"true"})," if the user has enabled telemetry or ",(0,i.jsx)(n.code,{children:"false"})," if the user has disabled telemetry."]}),"\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:"defined-in",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L4004",children:"packages/extension-api/src/extension-api.d.ts:4004"})})]})}function h(e={}){const{wrapper:n}={...(0,t.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(o,{...e})}):o(e)}},43023:(e,n,s)=>{s.d(n,{R:()=>a,x:()=>l});var i=s(63696);const t={},r=i.createContext(t);function a(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(t):e.components||t:a(e.components),i.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[35327],{75345:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>c,contentTitle:()=>a,default:()=>h,frontMatter:()=>r,metadata:()=>l,toc:()=>d});var i=s(62540),t=s(43023);const r={},a="Function: onDidChangeTelemetryEnabled()",l={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"}},c={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Defined in",id:"defined-in",level:2}];function o(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",strong:"strong",...(0,t.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.header,{children:(0,i.jsx)(n.h1,{id:"function-ondidchangetelemetryenabled",children:"Function: onDidChangeTelemetryEnabled()"})}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"onDidChangeTelemetryEnabled"}),"(",(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:"/api/interfaces/Event",children:"Event"})," which fires when the user enabled or disables telemetry.\n",(0,i.jsx)(n.code,{children:"true"})," if the user has enabled telemetry or ",(0,i.jsx)(n.code,{children:"false"})," if the user has disabled telemetry."]}),"\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:"defined-in",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L4004",children:"packages/extension-api/src/extension-api.d.ts:4004"})})]})}function h(e={}){const{wrapper:n}={...(0,t.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(o,{...e})}):o(e)}},43023:(e,n,s)=>{s.d(n,{R:()=>a,x:()=>l});var i=s(63696);const t={},r=i.createContext(t);function a(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(t):e.components||t:a(e.components),i.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/d83404a8.ca6f7b31.js b/assets/js/d83404a8.0fa4a979.js similarity index 88% rename from assets/js/d83404a8.ca6f7b31.js rename to assets/js/d83404a8.0fa4a979.js index 49218e20a25..8d7c8502834 100644 --- a/assets/js/d83404a8.ca6f7b31.js +++ b/assets/js/d83404a8.0fa4a979.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[6121],{45370:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>r,contentTitle:()=>a,default:()=>h,frontMatter:()=>t,metadata:()=>c,toc:()=>l});var s=i(62540),d=i(43023);const t={},a="Interface: ImageFile",c={id:"interfaces/ImageFile",title:"Interface: ImageFile",description:"the description of a file in an image filesystem layer",source:"@site/api/interfaces/ImageFile.md",sourceDirName:"interfaces",slug:"/interfaces/ImageFile",permalink:"/api/interfaces/ImageFile",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"ImageChecks",permalink:"/api/interfaces/ImageChecks"},next:{title:"ImageFileSymlink",permalink:"/api/interfaces/ImageFileSymlink"}},r={},l=[{value:"Extended by",id:"extended-by",level:2},{value:"Properties",id:"properties",level:2},{value:"atime",id:"atime",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"ctime",id:"ctime",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"gid",id:"gid",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"mode",id:"mode",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"mtime",id:"mtime",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"path",id:"path",level:3},{value:"Defined in",id:"defined-in-5",level:4},{value:"size",id:"size",level:3},{value:"Defined in",id:"defined-in-6",level:4},{value:"type",id:"type",level:3},{value:"Defined in",id:"defined-in-7",level:4},{value:"uid",id:"uid",level:3},{value:"Defined in",id:"defined-in-8",level:4}];function o(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",li:"li",p:"p",strong:"strong",ul:"ul",...(0,d.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.header,{children:(0,s.jsx)(n.h1,{id:"interface-imagefile",children:"Interface: ImageFile"})}),"\n",(0,s.jsx)(n.p,{children:"the description of a file in an image filesystem layer"}),"\n",(0,s.jsx)(n.h2,{id:"extended-by",children:"Extended by"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.a,{href:"/api/interfaces/ImageFileSymlink",children:(0,s.jsx)(n.code,{children:"ImageFileSymlink"})})}),"\n"]}),"\n",(0,s.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,s.jsx)(n.h3,{id:"atime",children:"atime"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"atime"}),": ",(0,s.jsx)(n.code,{children:"Date"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L738",children:"packages/extension-api/src/extension-api.d.ts:738"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"ctime",children:"ctime"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"ctime"}),": ",(0,s.jsx)(n.code,{children:"Date"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L737",children:"packages/extension-api/src/extension-api.d.ts:737"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"gid",children:"gid"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"gid"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-2",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L735",children:"packages/extension-api/src/extension-api.d.ts:735"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"mode",children:"mode"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"mode"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-3",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L733",children:"packages/extension-api/src/extension-api.d.ts:733"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"mtime",children:"mtime"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"mtime"}),": ",(0,s.jsx)(n.code,{children:"Date"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-4",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L739",children:"packages/extension-api/src/extension-api.d.ts:739"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"path",children:"path"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"path"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-5",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L730",children:"packages/extension-api/src/extension-api.d.ts:730"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"size",children:"size"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"size"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-6",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L736",children:"packages/extension-api/src/extension-api.d.ts:736"})}),"\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.strong,{children:"type"}),": ",(0,s.jsx)(n.code,{children:'"file"'})," | ",(0,s.jsx)(n.code,{children:'"directory"'})," | ",(0,s.jsx)(n.code,{children:'"symlink"'})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-7",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L731",children:"packages/extension-api/src/extension-api.d.ts:731"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"uid",children:"uid"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"uid"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-8",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L734",children:"packages/extension-api/src/extension-api.d.ts:734"})})]})}function h(e={}){const{wrapper:n}={...(0,d.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(o,{...e})}):o(e)}},43023:(e,n,i)=>{i.d(n,{R:()=>a,x:()=>c});var s=i(63696);const d={},t=s.createContext(d);function a(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(d):e.components||d:a(e.components),s.createElement(t.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[6121],{45370:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>r,contentTitle:()=>a,default:()=>h,frontMatter:()=>t,metadata:()=>c,toc:()=>l});var s=i(62540),d=i(43023);const t={},a="Interface: ImageFile",c={id:"interfaces/ImageFile",title:"Interface: ImageFile",description:"the description of a file in an image filesystem layer",source:"@site/api/interfaces/ImageFile.md",sourceDirName:"interfaces",slug:"/interfaces/ImageFile",permalink:"/api/interfaces/ImageFile",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"ImageChecks",permalink:"/api/interfaces/ImageChecks"},next:{title:"ImageFileSymlink",permalink:"/api/interfaces/ImageFileSymlink"}},r={},l=[{value:"Extended by",id:"extended-by",level:2},{value:"Properties",id:"properties",level:2},{value:"atime",id:"atime",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"ctime",id:"ctime",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"gid",id:"gid",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"mode",id:"mode",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"mtime",id:"mtime",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"path",id:"path",level:3},{value:"Defined in",id:"defined-in-5",level:4},{value:"size",id:"size",level:3},{value:"Defined in",id:"defined-in-6",level:4},{value:"type",id:"type",level:3},{value:"Defined in",id:"defined-in-7",level:4},{value:"uid",id:"uid",level:3},{value:"Defined in",id:"defined-in-8",level:4}];function o(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",li:"li",p:"p",strong:"strong",ul:"ul",...(0,d.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.header,{children:(0,s.jsx)(n.h1,{id:"interface-imagefile",children:"Interface: ImageFile"})}),"\n",(0,s.jsx)(n.p,{children:"the description of a file in an image filesystem layer"}),"\n",(0,s.jsx)(n.h2,{id:"extended-by",children:"Extended by"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.a,{href:"/api/interfaces/ImageFileSymlink",children:(0,s.jsx)(n.code,{children:"ImageFileSymlink"})})}),"\n"]}),"\n",(0,s.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,s.jsx)(n.h3,{id:"atime",children:"atime"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"atime"}),": ",(0,s.jsx)(n.code,{children:"Date"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L738",children:"packages/extension-api/src/extension-api.d.ts:738"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"ctime",children:"ctime"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"ctime"}),": ",(0,s.jsx)(n.code,{children:"Date"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L737",children:"packages/extension-api/src/extension-api.d.ts:737"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"gid",children:"gid"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"gid"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-2",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L735",children:"packages/extension-api/src/extension-api.d.ts:735"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"mode",children:"mode"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"mode"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-3",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L733",children:"packages/extension-api/src/extension-api.d.ts:733"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"mtime",children:"mtime"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"mtime"}),": ",(0,s.jsx)(n.code,{children:"Date"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-4",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L739",children:"packages/extension-api/src/extension-api.d.ts:739"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"path",children:"path"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"path"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-5",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L730",children:"packages/extension-api/src/extension-api.d.ts:730"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"size",children:"size"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"size"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-6",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L736",children:"packages/extension-api/src/extension-api.d.ts:736"})}),"\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.strong,{children:"type"}),": ",(0,s.jsx)(n.code,{children:'"file"'})," | ",(0,s.jsx)(n.code,{children:'"directory"'})," | ",(0,s.jsx)(n.code,{children:'"symlink"'})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-7",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L731",children:"packages/extension-api/src/extension-api.d.ts:731"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"uid",children:"uid"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"uid"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-8",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L734",children:"packages/extension-api/src/extension-api.d.ts:734"})})]})}function h(e={}){const{wrapper:n}={...(0,d.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(o,{...e})}):o(e)}},43023:(e,n,i)=>{i.d(n,{R:()=>a,x:()=>c});var s=i(63696);const d={},t=s.createContext(d);function a(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(d):e.components||d:a(e.components),s.createElement(t.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/d83f208d.5f4dafc2.js b/assets/js/d83f208d.e5a79ce0.js similarity index 84% rename from assets/js/d83f208d.5f4dafc2.js rename to assets/js/d83f208d.e5a79ce0.js index e1fa4335043..9ea6e2c649c 100644 --- a/assets/js/d83f208d.5f4dafc2.js +++ b/assets/js/d83f208d.e5a79ce0.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[35258],{13320:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>o,contentTitle:()=>r,default:()=>h,frontMatter:()=>t,metadata:()=>c,toc:()=>a});var s=i(62540),d=i(43023);const t={},r="Interface: RunOptions",c={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"}},o={},a=[{value:"Properties",id:"properties",level:2},{value:"cwd?",id:"cwd",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"encoding?",id:"encoding",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"env?",id:"env",level:3},{value:"Index Signature",id:"index-signature",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"isAdmin?",id:"isadmin",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"logger?",id:"logger",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"token?",id:"token",level:3},{value:"Defined in",id:"defined-in-5",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",p:"p",strong:"strong",...(0,d.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.header,{children:(0,s.jsx)(n.h1,{id:"interface-runoptions",children:"Interface: RunOptions"})}),"\n",(0,s.jsx)(n.p,{children:"Options for running a command."}),"\n",(0,s.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,s.jsx)(n.h3,{id:"cwd",children:"cwd?"}),"\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:"cwd"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"custom directory"}),"\n",(0,s.jsx)(n.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L4051",children:"packages/extension-api/src/extension-api.d.ts:4051"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"encoding",children:"encoding?"}),"\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:"encoding"}),": ",(0,s.jsx)(n.code,{children:"BufferEncoding"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The encoding to use. Default utf8"}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L4061",children:"packages/extension-api/src/extension-api.d.ts:4061"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"env",children:"env?"}),"\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:"env"}),": ",(0,s.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Environment variables to set for the command."}),"\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:"defined-in-2",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L4036",children:"packages/extension-api/src/extension-api.d.ts:4036"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"isadmin",children:"isAdmin?"}),"\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:"isAdmin"}),": ",(0,s.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"admin privileges required"}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-3",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L4056",children:"packages/extension-api/src/extension-api.d.ts:4056"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"logger",children:"logger?"}),"\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:"logger"}),": ",(0,s.jsx)(n.a,{href:"/api/interfaces/Logger",children:(0,s.jsx)(n.code,{children:"Logger"})})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"A logger used to track execution events."}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-4",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L4046",children:"packages/extension-api/src/extension-api.d.ts:4046"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"token",children:"token?"}),"\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:"token"}),": ",(0,s.jsx)(n.a,{href:"/api/interfaces/CancellationToken",children:(0,s.jsx)(n.code,{children:"CancellationToken"})})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"A cancellation token used to request cancellation."}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-5",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L4041",children:"packages/extension-api/src/extension-api.d.ts:4041"})})]})}function h(e={}){const{wrapper:n}={...(0,d.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},43023:(e,n,i)=>{i.d(n,{R:()=>r,x:()=>c});var s=i(63696);const d={},t=s.createContext(d);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(d):e.components||d:r(e.components),s.createElement(t.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[35258],{13320:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>o,contentTitle:()=>t,default:()=>h,frontMatter:()=>c,metadata:()=>r,toc:()=>a});var s=i(62540),d=i(43023);const c={},t="Interface: RunOptions",r={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"}},o={},a=[{value:"Properties",id:"properties",level:2},{value:"cwd?",id:"cwd",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"encoding?",id:"encoding",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"env?",id:"env",level:3},{value:"Index Signature",id:"index-signature",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"isAdmin?",id:"isadmin",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"logger?",id:"logger",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"token?",id:"token",level:3},{value:"Defined in",id:"defined-in-5",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",p:"p",strong:"strong",...(0,d.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.header,{children:(0,s.jsx)(n.h1,{id:"interface-runoptions",children:"Interface: RunOptions"})}),"\n",(0,s.jsx)(n.p,{children:"Options for running a command."}),"\n",(0,s.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,s.jsx)(n.h3,{id:"cwd",children:"cwd?"}),"\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:"cwd"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"custom directory"}),"\n",(0,s.jsx)(n.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L4051",children:"packages/extension-api/src/extension-api.d.ts:4051"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"encoding",children:"encoding?"}),"\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:"encoding"}),": ",(0,s.jsx)(n.code,{children:"BufferEncoding"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The encoding to use. Default utf8"}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L4061",children:"packages/extension-api/src/extension-api.d.ts:4061"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"env",children:"env?"}),"\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:"env"}),": ",(0,s.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Environment variables to set for the command."}),"\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:"defined-in-2",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L4036",children:"packages/extension-api/src/extension-api.d.ts:4036"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"isadmin",children:"isAdmin?"}),"\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:"isAdmin"}),": ",(0,s.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"admin privileges required"}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-3",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L4056",children:"packages/extension-api/src/extension-api.d.ts:4056"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"logger",children:"logger?"}),"\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:"logger"}),": ",(0,s.jsx)(n.a,{href:"/api/interfaces/Logger",children:(0,s.jsx)(n.code,{children:"Logger"})})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"A logger used to track execution events."}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-4",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L4046",children:"packages/extension-api/src/extension-api.d.ts:4046"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"token",children:"token?"}),"\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:"token"}),": ",(0,s.jsx)(n.a,{href:"/api/interfaces/CancellationToken",children:(0,s.jsx)(n.code,{children:"CancellationToken"})})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"A cancellation token used to request cancellation."}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-5",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L4041",children:"packages/extension-api/src/extension-api.d.ts:4041"})})]})}function h(e={}){const{wrapper:n}={...(0,d.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},43023:(e,n,i)=>{i.d(n,{R:()=>t,x:()=>r});var s=i(63696);const d={},c=s.createContext(d);function t(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(d):e.components||d:t(e.components),s.createElement(c.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/d9407a00.2e242177.js b/assets/js/d9407a00.2e242177.js new file mode 100644 index 00000000000..c0f78d85412 --- /dev/null +++ b/assets/js/d9407a00.2e242177.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[74358],{31096:(n,e,i)=>{i.r(e),i.d(e,{assets:()=>r,contentTitle:()=>a,default:()=>l,frontMatter:()=>t,metadata:()=>c,toc:()=>d});var o=i(62540),s=i(43023);const t={},a="Function: showNotification()",c={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:"Defined in",id:"defined-in",level:2}];function p(n){const e={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",strong:"strong",...(0,s.R)(),...n.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(e.header,{children:(0,o.jsx)(e.h1,{id:"function-shownotification",children:"Function: showNotification()"})}),"\n",(0,o.jsxs)(e.blockquote,{children:["\n",(0,o.jsxs)(e.p,{children:[(0,o.jsx)(e.strong,{children:"showNotification"}),"(",(0,o.jsx)(e.code,{children:"options"}),"): ",(0,o.jsx)(e.a,{href:"/api/classes/Disposable",children:(0,o.jsx)(e.code,{children:"Disposable"})})]}),"\n"]}),"\n",(0,o.jsx)(e.p,{children:"Show notification on different area of Podman Desktop based on its options (Dashboard, bell icon list, OS notification)"}),"\n",(0,o.jsx)(e.h2,{id:"parameters",children:"Parameters"}),"\n",(0,o.jsxs)(e.p,{children:["\u2022 ",(0,o.jsx)(e.strong,{children:"options"}),": ",(0,o.jsx)(e.a,{href:"/api/interfaces/NotificationOptions",children:(0,o.jsx)(e.code,{children:"NotificationOptions"})})]}),"\n",(0,o.jsx)(e.p,{children:"define how the notification must be created."}),"\n",(0,o.jsx)(e.h2,{id:"returns",children:"Returns"}),"\n",(0,o.jsx)(e.p,{children:(0,o.jsx)(e.a,{href:"/api/classes/Disposable",children:(0,o.jsx)(e.code,{children:"Disposable"})})}),"\n",(0,o.jsx)(e.h2,{id:"defined-in",children:"Defined in"}),"\n",(0,o.jsx)(e.p,{children:(0,o.jsx)(e.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L1983",children:"packages/extension-api/src/extension-api.d.ts:1983"})})]})}function l(n={}){const{wrapper:e}={...(0,s.R)(),...n.components};return e?(0,o.jsx)(e,{...n,children:(0,o.jsx)(p,{...n})}):p(n)}},43023:(n,e,i)=>{i.d(e,{R:()=>a,x:()=>c});var o=i(63696);const s={},t=o.createContext(s);function a(n){const e=o.useContext(t);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(s):n.components||s:a(n.components),o.createElement(t.Provider,{value:e},n.children)}}}]); \ No newline at end of file diff --git a/assets/js/d9407a00.355bc238.js b/assets/js/d9407a00.355bc238.js deleted file mode 100644 index 785391b742a..00000000000 --- a/assets/js/d9407a00.355bc238.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[74358],{31096:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>r,contentTitle:()=>a,default:()=>l,frontMatter:()=>t,metadata:()=>c,toc:()=>d});var o=i(62540),s=i(43023);const t={},a="Function: showNotification()",c={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:"Defined in",id:"defined-in",level:2}];function p(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",strong:"strong",...(0,s.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(n.header,{children:(0,o.jsx)(n.h1,{id:"function-shownotification",children:"Function: showNotification()"})}),"\n",(0,o.jsxs)(n.blockquote,{children:["\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.strong,{children:"showNotification"}),"(",(0,o.jsx)(n.code,{children:"options"}),"): ",(0,o.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,o.jsx)(n.code,{children:"Disposable"})})]}),"\n"]}),"\n",(0,o.jsx)(n.p,{children:"Show notification on different area of Podman Desktop based on its options (Dashboard, bell icon list, OS notification)"}),"\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/NotificationOptions",children:(0,o.jsx)(n.code,{children:"NotificationOptions"})})]}),"\n",(0,o.jsx)(n.p,{children:"define how the notification must be created."}),"\n",(0,o.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,o.jsx)(n.p,{children:(0,o.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,o.jsx)(n.code,{children:"Disposable"})})}),"\n",(0,o.jsx)(n.h2,{id:"defined-in",children:"Defined in"}),"\n",(0,o.jsx)(n.p,{children:(0,o.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L1983",children:"packages/extension-api/src/extension-api.d.ts:1983"})})]})}function l(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(p,{...e})}):p(e)}},43023:(e,n,i)=>{i.d(n,{R:()=>a,x:()=>c});var o=i(63696);const s={},t=o.createContext(s);function a(e){const n=o.useContext(t);return o.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:a(e.components),o.createElement(t.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/d9673b17.679e95e3.js b/assets/js/d9673b17.9b46a815.js similarity index 92% rename from assets/js/d9673b17.679e95e3.js rename to assets/js/d9673b17.9b46a815.js index 421b89236b2..7b04bc77cd0 100644 --- a/assets/js/d9673b17.679e95e3.js +++ b/assets/js/d9673b17.9b46a815.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[32428],{94218:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>a,contentTitle:()=>d,default:()=>h,frontMatter:()=>o,metadata:()=>c,toc:()=>r});var t=i(62540),s=i(43023);const o={},d="Interface: NotificationOptions",c={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={},r=[{value:"Properties",id:"properties",level:2},{value:"body?",id:"body",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"highlight?",id:"highlight",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"markdownActions?",id:"markdownactions",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"silent?",id:"silent",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"title?",id:"title",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"type?",id:"type",level:3},{value:"Defined in",id:"defined-in-5",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",p:"p",strong:"strong",...(0,s.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.header,{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:"defined-in",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L1461",children:"packages/extension-api/src/extension-api.d.ts:1461"})}),"\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:"defined-in-1",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L1477",children:"packages/extension-api/src/extension-api.d.ts:1477"})}),"\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:"defined-in-2",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L1473",children:"packages/extension-api/src/extension-api.d.ts:1473"})}),"\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:"defined-in-3",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L1465",children:"packages/extension-api/src/extension-api.d.ts:1465"})}),"\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:"defined-in-4",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L1457",children:"packages/extension-api/src/extension-api.d.ts:1457"})}),"\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:"defined-in-5",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L1469",children:"packages/extension-api/src/extension-api.d.ts:1469"})})]})}function h(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},43023:(e,n,i)=>{i.d(n,{R:()=>d,x:()=>c});var t=i(63696);const s={},o=t.createContext(s);function d(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:d(e.components),t.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[32428],{94218:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>a,contentTitle:()=>d,default:()=>h,frontMatter:()=>o,metadata:()=>c,toc:()=>r});var t=i(62540),s=i(43023);const o={},d="Interface: NotificationOptions",c={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={},r=[{value:"Properties",id:"properties",level:2},{value:"body?",id:"body",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"highlight?",id:"highlight",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"markdownActions?",id:"markdownactions",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"silent?",id:"silent",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"title?",id:"title",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"type?",id:"type",level:3},{value:"Defined in",id:"defined-in-5",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",p:"p",strong:"strong",...(0,s.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.header,{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:"defined-in",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L1461",children:"packages/extension-api/src/extension-api.d.ts:1461"})}),"\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:"defined-in-1",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L1477",children:"packages/extension-api/src/extension-api.d.ts:1477"})}),"\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:"defined-in-2",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L1473",children:"packages/extension-api/src/extension-api.d.ts:1473"})}),"\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:"defined-in-3",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L1465",children:"packages/extension-api/src/extension-api.d.ts:1465"})}),"\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:"defined-in-4",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L1457",children:"packages/extension-api/src/extension-api.d.ts:1457"})}),"\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:"defined-in-5",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L1469",children:"packages/extension-api/src/extension-api.d.ts:1469"})})]})}function h(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},43023:(e,n,i)=>{i.d(n,{R:()=>d,x:()=>c});var t=i(63696);const s={},o=t.createContext(s);function d(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:d(e.components),t.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/d9b4ee1e.0a9d66ae.js b/assets/js/d9b4ee1e.d3ccd4b4.js similarity index 95% rename from assets/js/d9b4ee1e.0a9d66ae.js rename to assets/js/d9b4ee1e.d3ccd4b4.js index 8d020dcb196..26b2ebedd4e 100644 --- a/assets/js/d9b4ee1e.0a9d66ae.js +++ b/assets/js/d9b4ee1e.d3ccd4b4.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[90488],{70456:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>c,contentTitle:()=>o,default:()=>d,frontMatter:()=>a,metadata:()=>i,toc:()=>l});var r=n(62540),s=n(43023);const a={},o="Type Alias: KubernetesGeneratorSelector",i={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"}},c={},l=[{value:"Defined in",id:"defined-in",level:2}];function p(e){const t={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",strong:"strong",...(0,s.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(t.header,{children:(0,r.jsx)(t.h1,{id:"type-alias-kubernetesgeneratorselector",children:"Type Alias: KubernetesGeneratorSelector"})}),"\n",(0,r.jsxs)(t.blockquote,{children:["\n",(0,r.jsxs)(t.p,{children:[(0,r.jsx)(t.strong,{children:"KubernetesGeneratorSelector"}),": ",(0,r.jsx)(t.a,{href:"/api/type-aliases/KubernetesGeneratorType",children:(0,r.jsx)(t.code,{children:"KubernetesGeneratorType"})})," | ",(0,r.jsx)(t.code,{children:"ReadonlyArray"}),"<",(0,r.jsx)(t.a,{href:"/api/type-aliases/KubernetesGeneratorType",children:(0,r.jsx)(t.code,{children:"KubernetesGeneratorType"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(t.h2,{id:"defined-in",children:"Defined in"}),"\n",(0,r.jsx)(t.p,{children:(0,r.jsx)(t.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2129",children:"packages/extension-api/src/extension-api.d.ts:2129"})})]})}function d(e={}){const{wrapper:t}={...(0,s.R)(),...e.components};return t?(0,r.jsx)(t,{...e,children:(0,r.jsx)(p,{...e})}):p(e)}},43023:(e,t,n)=>{n.d(t,{R:()=>o,x:()=>i});var r=n(63696);const s={},a=r.createContext(s);function o(e){const t=r.useContext(a);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:o(e.components),r.createElement(a.Provider,{value:t},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[90488],{70456:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>c,contentTitle:()=>o,default:()=>d,frontMatter:()=>a,metadata:()=>i,toc:()=>l});var r=n(62540),s=n(43023);const a={},o="Type Alias: KubernetesGeneratorSelector",i={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"}},c={},l=[{value:"Defined in",id:"defined-in",level:2}];function p(e){const t={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",strong:"strong",...(0,s.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(t.header,{children:(0,r.jsx)(t.h1,{id:"type-alias-kubernetesgeneratorselector",children:"Type Alias: KubernetesGeneratorSelector"})}),"\n",(0,r.jsxs)(t.blockquote,{children:["\n",(0,r.jsxs)(t.p,{children:[(0,r.jsx)(t.strong,{children:"KubernetesGeneratorSelector"}),": ",(0,r.jsx)(t.a,{href:"/api/type-aliases/KubernetesGeneratorType",children:(0,r.jsx)(t.code,{children:"KubernetesGeneratorType"})})," | ",(0,r.jsx)(t.code,{children:"ReadonlyArray"}),"<",(0,r.jsx)(t.a,{href:"/api/type-aliases/KubernetesGeneratorType",children:(0,r.jsx)(t.code,{children:"KubernetesGeneratorType"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(t.h2,{id:"defined-in",children:"Defined in"}),"\n",(0,r.jsx)(t.p,{children:(0,r.jsx)(t.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2129",children:"packages/extension-api/src/extension-api.d.ts:2129"})})]})}function d(e={}){const{wrapper:t}={...(0,s.R)(),...e.components};return t?(0,r.jsx)(t,{...e,children:(0,r.jsx)(p,{...e})}):p(e)}},43023:(e,t,n)=>{n.d(t,{R:()=>o,x:()=>i});var r=n(63696);const s={},a=r.createContext(s);function o(e){const t=r.useContext(a);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:o(e.components),r.createElement(a.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/db22fd17.a2fcddf3.js b/assets/js/db22fd17.bfcaee3d.js similarity index 97% rename from assets/js/db22fd17.a2fcddf3.js rename to assets/js/db22fd17.bfcaee3d.js index cc6460a62ff..81dd30a68b0 100644 --- a/assets/js/db22fd17.a2fcddf3.js +++ b/assets/js/db22fd17.bfcaee3d.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[88623],{12107:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>r,contentTitle:()=>a,default:()=>p,frontMatter:()=>s,metadata:()=>l,toc:()=>c});var o=n(62540),i=n(43023);const s={},a="Type Alias: CliToolState",l={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:"CliToolInstallationSource",permalink:"/api/type-aliases/CliToolInstallationSource"},next:{title:"ConfigurationScope",permalink:"/api/type-aliases/ConfigurationScope"}},r={},c=[{value:"Defined in",id:"defined-in",level:2}];function d(e){const t={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",strong:"strong",...(0,i.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(t.header,{children:(0,o.jsx)(t.h1,{id:"type-alias-clitoolstate",children:"Type Alias: CliToolState"})}),"\n",(0,o.jsxs)(t.blockquote,{children:["\n",(0,o.jsxs)(t.p,{children:[(0,o.jsx)(t.strong,{children:"CliToolState"}),": ",(0,o.jsx)(t.code,{children:'"registered"'})]}),"\n"]}),"\n",(0,o.jsx)(t.h2,{id:"defined-in",children:"Defined in"}),"\n",(0,o.jsx)(t.p,{children:(0,o.jsx)(t.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L4362",children:"packages/extension-api/src/extension-api.d.ts:4362"})})]})}function p(e={}){const{wrapper:t}={...(0,i.R)(),...e.components};return t?(0,o.jsx)(t,{...e,children:(0,o.jsx)(d,{...e})}):d(e)}},43023:(e,t,n)=>{n.d(t,{R:()=>a,x:()=>l});var o=n(63696);const i={},s=o.createContext(i);function a(e){const t=o.useContext(s);return o.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function l(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:a(e.components),o.createElement(s.Provider,{value:t},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[88623],{12107:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>r,contentTitle:()=>a,default:()=>p,frontMatter:()=>s,metadata:()=>l,toc:()=>c});var o=n(62540),i=n(43023);const s={},a="Type Alias: CliToolState",l={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:"CliToolInstallationSource",permalink:"/api/type-aliases/CliToolInstallationSource"},next:{title:"ConfigurationScope",permalink:"/api/type-aliases/ConfigurationScope"}},r={},c=[{value:"Defined in",id:"defined-in",level:2}];function d(e){const t={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",strong:"strong",...(0,i.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(t.header,{children:(0,o.jsx)(t.h1,{id:"type-alias-clitoolstate",children:"Type Alias: CliToolState"})}),"\n",(0,o.jsxs)(t.blockquote,{children:["\n",(0,o.jsxs)(t.p,{children:[(0,o.jsx)(t.strong,{children:"CliToolState"}),": ",(0,o.jsx)(t.code,{children:'"registered"'})]}),"\n"]}),"\n",(0,o.jsx)(t.h2,{id:"defined-in",children:"Defined in"}),"\n",(0,o.jsx)(t.p,{children:(0,o.jsx)(t.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L4362",children:"packages/extension-api/src/extension-api.d.ts:4362"})})]})}function p(e={}){const{wrapper:t}={...(0,i.R)(),...e.components};return t?(0,o.jsx)(t,{...e,children:(0,o.jsx)(d,{...e})}):d(e)}},43023:(e,t,n)=>{n.d(t,{R:()=>a,x:()=>l});var o=n(63696);const i={},s=o.createContext(i);function a(e){const t=o.useContext(s);return o.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function l(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:a(e.components),o.createElement(s.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/dc23cd40.5fc2622d.js b/assets/js/dc23cd40.5a4ed45e.js similarity index 92% rename from assets/js/dc23cd40.5fc2622d.js rename to assets/js/dc23cd40.5a4ed45e.js index c12c6081f88..628f1c56025 100644 --- a/assets/js/dc23cd40.5fc2622d.js +++ b/assets/js/dc23cd40.5a4ed45e.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[41052],{59494:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>o,contentTitle:()=>r,default:()=>p,frontMatter:()=>d,metadata:()=>a,toc:()=>c});var s=i(62540),t=i(43023);const d={},r="Interface: PodCreateOptions",a={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"}},o={},c=[{value:"Properties",id:"properties",level:2},{value:"Networks?",id:"networks",level:3},{value:"Index Signature",id:"index-signature",level:4},{value:"Remarks",id:"remarks",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"exit_policy?",id:"exit_policy",level:3},{value:"Examples",id:"examples",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"labels?",id:"labels",level:3},{value:"Index Signature",id:"index-signature-1",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"name?",id:"name",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"netns?",id:"netns",level:3},{value:"nsmode",id:"nsmode",level:4},{value:"Examples",id:"examples-1",level:5},{value:"Defined in",id:"defined-in-4",level:4},{value:"portmappings?",id:"portmappings",level:3},{value:"Defined in",id:"defined-in-5",level:4},{value:"provider?",id:"provider",level:3},{value:"Defined in",id:"defined-in-6",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",h5:"h5",header:"header",hr:"hr",p:"p",pre:"pre",strong:"strong",...(0,t.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.header,{children:(0,s.jsx)(n.h1,{id:"interface-podcreateoptions",children:"Interface: PodCreateOptions"})}),"\n",(0,s.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,s.jsx)(n.h3,{id:"networks",children:"Networks?"}),"\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:"Networks"}),": ",(0,s.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Map of networks names to ids the container should join to.\nYou can request additional settings for each network, you can set network aliases,"}),"\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:"object"})]}),"\n",(0,s.jsx)(n.h4,{id:"remarks",children:"Remarks"}),"\n",(0,s.jsxs)(n.p,{children:["PodCreateOptions.netns.nsmode need to be set to ",(0,s.jsx)(n.code,{children:"bridge"})," to join a network"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L400",children:"packages/extension-api/src/extension-api.d.ts:400"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"exit_policy",children:"exit_policy?"}),"\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:"exit_policy"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"ExitPolicy determines the pod's exit and stop behaviour."}),"\n",(0,s.jsx)(n.h4,{id:"examples",children:"Examples"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:'"continue": the pod continues running. This is the default policy\nwhen creating a pod.\n'})}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:'"stop": stop the pod when the last container exits. This is the\ndefault behaviour for play kube.\n'})}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L429",children:"packages/extension-api/src/extension-api.d.ts:429"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"labels",children:"labels?"}),"\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:"labels"}),": ",(0,s.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Labels are key-value pairs that are used to add metadata to pods. Optional."}),"\n",(0,s.jsx)(n.h4,{id:"index-signature-1",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:"defined-in-2",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L390",children:"packages/extension-api/src/extension-api.d.ts:390"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"name",children:"name?"}),"\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:"name"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Name is the name of the pod. If not provided, a name will be generated when the pod is created. Optional."}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-3",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L380",children:"packages/extension-api/src/extension-api.d.ts:380"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"netns",children:"netns?"}),"\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:"netns"}),": ",(0,s.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Network namespace"}),"\n",(0,s.jsx)(n.h4,{id:"nsmode",children:"nsmode"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"nsmode"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"NamespaceMode"}),"\n",(0,s.jsx)(n.h5,{id:"examples-1",children:"Examples"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"`bridge` indicates that the network backend (CNI/netavark) should be used.\n"})}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"`pasta` indicates that a pasta network stack should be used.\n"})}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-4",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L409",children:"packages/extension-api/src/extension-api.d.ts:409"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"portmappings",children:"portmappings?"}),"\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:"portmappings"}),": ",(0,s.jsx)(n.a,{href:"/api/interfaces/PodCreatePortOptions",children:(0,s.jsx)(n.code,{children:"PodCreatePortOptions"})}),"[]"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"PortMappings is a set of ports to map into the infra container.\nAs, by default, containers share their network with the infra container, this will forward the ports to the entire pod.\nOnly available if NetNS is set to Bridge, Slirp, or Pasta."}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-5",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L386",children:"packages/extension-api/src/extension-api.d.ts:386"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"provider",children:"provider?"}),"\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:"provider"}),": ",(0,s.jsx)(n.a,{href:"/api/interfaces/ContainerProviderConnection",children:(0,s.jsx)(n.code,{children:"ContainerProviderConnection"})})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-6",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L392",children:"packages/extension-api/src/extension-api.d.ts:392"})})]})}function p(e={}){const{wrapper:n}={...(0,t.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},43023:(e,n,i)=>{i.d(n,{R:()=>r,x:()=>a});var s=i(63696);const t={},d=s.createContext(t);function r(e){const n=s.useContext(d);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:r(e.components),s.createElement(d.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[41052],{59494:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>o,contentTitle:()=>r,default:()=>p,frontMatter:()=>d,metadata:()=>a,toc:()=>c});var s=i(62540),t=i(43023);const d={},r="Interface: PodCreateOptions",a={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"}},o={},c=[{value:"Properties",id:"properties",level:2},{value:"Networks?",id:"networks",level:3},{value:"Index Signature",id:"index-signature",level:4},{value:"Remarks",id:"remarks",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"exit_policy?",id:"exit_policy",level:3},{value:"Examples",id:"examples",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"labels?",id:"labels",level:3},{value:"Index Signature",id:"index-signature-1",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"name?",id:"name",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"netns?",id:"netns",level:3},{value:"nsmode",id:"nsmode",level:4},{value:"Examples",id:"examples-1",level:5},{value:"Defined in",id:"defined-in-4",level:4},{value:"portmappings?",id:"portmappings",level:3},{value:"Defined in",id:"defined-in-5",level:4},{value:"provider?",id:"provider",level:3},{value:"Defined in",id:"defined-in-6",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",h5:"h5",header:"header",hr:"hr",p:"p",pre:"pre",strong:"strong",...(0,t.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.header,{children:(0,s.jsx)(n.h1,{id:"interface-podcreateoptions",children:"Interface: PodCreateOptions"})}),"\n",(0,s.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,s.jsx)(n.h3,{id:"networks",children:"Networks?"}),"\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:"Networks"}),": ",(0,s.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Map of networks names to ids the container should join to.\nYou can request additional settings for each network, you can set network aliases,"}),"\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:"object"})]}),"\n",(0,s.jsx)(n.h4,{id:"remarks",children:"Remarks"}),"\n",(0,s.jsxs)(n.p,{children:["PodCreateOptions.netns.nsmode need to be set to ",(0,s.jsx)(n.code,{children:"bridge"})," to join a network"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L400",children:"packages/extension-api/src/extension-api.d.ts:400"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"exit_policy",children:"exit_policy?"}),"\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:"exit_policy"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"ExitPolicy determines the pod's exit and stop behaviour."}),"\n",(0,s.jsx)(n.h4,{id:"examples",children:"Examples"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:'"continue": the pod continues running. This is the default policy\nwhen creating a pod.\n'})}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:'"stop": stop the pod when the last container exits. This is the\ndefault behaviour for play kube.\n'})}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L429",children:"packages/extension-api/src/extension-api.d.ts:429"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"labels",children:"labels?"}),"\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:"labels"}),": ",(0,s.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Labels are key-value pairs that are used to add metadata to pods. Optional."}),"\n",(0,s.jsx)(n.h4,{id:"index-signature-1",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:"defined-in-2",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L390",children:"packages/extension-api/src/extension-api.d.ts:390"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"name",children:"name?"}),"\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:"name"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Name is the name of the pod. If not provided, a name will be generated when the pod is created. Optional."}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-3",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L380",children:"packages/extension-api/src/extension-api.d.ts:380"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"netns",children:"netns?"}),"\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:"netns"}),": ",(0,s.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Network namespace"}),"\n",(0,s.jsx)(n.h4,{id:"nsmode",children:"nsmode"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"nsmode"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"NamespaceMode"}),"\n",(0,s.jsx)(n.h5,{id:"examples-1",children:"Examples"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"`bridge` indicates that the network backend (CNI/netavark) should be used.\n"})}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"`pasta` indicates that a pasta network stack should be used.\n"})}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-4",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L409",children:"packages/extension-api/src/extension-api.d.ts:409"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"portmappings",children:"portmappings?"}),"\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:"portmappings"}),": ",(0,s.jsx)(n.a,{href:"/api/interfaces/PodCreatePortOptions",children:(0,s.jsx)(n.code,{children:"PodCreatePortOptions"})}),"[]"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"PortMappings is a set of ports to map into the infra container.\nAs, by default, containers share their network with the infra container, this will forward the ports to the entire pod.\nOnly available if NetNS is set to Bridge, Slirp, or Pasta."}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-5",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L386",children:"packages/extension-api/src/extension-api.d.ts:386"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"provider",children:"provider?"}),"\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:"provider"}),": ",(0,s.jsx)(n.a,{href:"/api/interfaces/ContainerProviderConnection",children:(0,s.jsx)(n.code,{children:"ContainerProviderConnection"})})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-6",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L392",children:"packages/extension-api/src/extension-api.d.ts:392"})})]})}function p(e={}){const{wrapper:n}={...(0,t.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},43023:(e,n,i)=>{i.d(n,{R:()=>r,x:()=>a});var s=i(63696);const t={},d=s.createContext(t);function r(e){const n=s.useContext(d);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:r(e.components),s.createElement(d.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/dec87402.05619531.js b/assets/js/dec87402.fcf70dc0.js similarity index 96% rename from assets/js/dec87402.05619531.js rename to assets/js/dec87402.fcf70dc0.js index eb71c2a03fa..8f3732284ab 100644 --- a/assets/js/dec87402.05619531.js +++ b/assets/js/dec87402.fcf70dc0.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[35716],{68972:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>c,contentTitle:()=>a,default:()=>h,frontMatter:()=>r,metadata:()=>o,toc:()=>d});var s=i(62540),t=i(43023);const r={},a="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:"context",permalink:"/api/namespaces/context/"}},c={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Defined in",id:"defined-in",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",strong:"strong",...(0,t.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.header,{children:(0,s.jsx)(n.h1,{id:"function-tagimage",children:"Function: tagImage()"})}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"tagImage"}),"(",(0,s.jsx)(n.code,{children:"engineId"}),", ",(0,s.jsx)(n.code,{children:"imageId"}),", ",(0,s.jsx)(n.code,{children:"repo"}),", ",(0,s.jsx)(n.code,{children:"tag"}),"?): ",(0,s.jsx)(n.code,{children:"Promise"}),"<",(0,s.jsx)(n.code,{children:"void"}),">"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Tag an image so that it becomes part of a repository"}),"\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:"imageId"}),": ",(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.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"repo"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n",(0,s.jsxs)(n.p,{children:["The repository to tag in. For example, ",(0,s.jsx)(n.code,{children:"someuser/someimage"})]}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"tag?"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n",(0,s.jsx)(n.p,{children:"The name of the new tag"}),"\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:"defined-in",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L3599",children:"packages/extension-api/src/extension-api.d.ts:3599"})})]})}function h(e={}){const{wrapper:n}={...(0,t.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},43023:(e,n,i)=>{i.d(n,{R:()=>a,x:()=>o});var s=i(63696);const t={},r=s.createContext(t);function a(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(t):e.components||t:a(e.components),s.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[35716],{68972:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>c,contentTitle:()=>a,default:()=>h,frontMatter:()=>r,metadata:()=>o,toc:()=>d});var s=i(62540),t=i(43023);const r={},a="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:"context",permalink:"/api/namespaces/context/"}},c={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Defined in",id:"defined-in",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",strong:"strong",...(0,t.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.header,{children:(0,s.jsx)(n.h1,{id:"function-tagimage",children:"Function: tagImage()"})}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"tagImage"}),"(",(0,s.jsx)(n.code,{children:"engineId"}),", ",(0,s.jsx)(n.code,{children:"imageId"}),", ",(0,s.jsx)(n.code,{children:"repo"}),", ",(0,s.jsx)(n.code,{children:"tag"}),"?): ",(0,s.jsx)(n.code,{children:"Promise"}),"<",(0,s.jsx)(n.code,{children:"void"}),">"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Tag an image so that it becomes part of a repository"}),"\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:"imageId"}),": ",(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.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"repo"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n",(0,s.jsxs)(n.p,{children:["The repository to tag in. For example, ",(0,s.jsx)(n.code,{children:"someuser/someimage"})]}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"tag?"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n",(0,s.jsx)(n.p,{children:"The name of the new tag"}),"\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:"defined-in",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L3599",children:"packages/extension-api/src/extension-api.d.ts:3599"})})]})}function h(e={}){const{wrapper:n}={...(0,t.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},43023:(e,n,i)=>{i.d(n,{R:()=>a,x:()=>o});var s=i(63696);const t={},r=s.createContext(t);function a(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(t):e.components||t:a(e.components),s.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/deccabf3.170ef08a.js b/assets/js/deccabf3.a30d945a.js similarity index 91% rename from assets/js/deccabf3.170ef08a.js rename to assets/js/deccabf3.a30d945a.js index ef06e61f290..40c4a8d18fa 100644 --- a/assets/js/deccabf3.170ef08a.js +++ b/assets/js/deccabf3.a30d945a.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[55756],{27164:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>d,contentTitle:()=>s,default:()=>h,frontMatter:()=>o,metadata:()=>a,toc:()=>c});var t=i(62540),r=i(43023);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"}},d={},c=[{value:"Enumeration Members",id:"enumeration-members",level:2},{value:"Error",id:"error",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"Info",id:"info",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"Warning",id:"warning",level:3},{value:"Defined in",id:"defined-in-2",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",p:"p",strong:"strong",...(0,r.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.header,{children:(0,t.jsx)(n.h1,{id:"enumeration-inputboxvalidationseverity",children:"Enumeration: InputBoxValidationSeverity"})}),"\n",(0,t.jsx)(n.p,{children:"Impacts the behavior and appearance of the validation message."}),"\n",(0,t.jsx)(n.h2,{id:"enumeration-members",children:"Enumeration Members"}),"\n",(0,t.jsx)(n.h3,{id:"error",children:"Error"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"Error"}),": ",(0,t.jsx)(n.code,{children:"3"})]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L1115",children:"packages/extension-api/src/extension-api.d.ts:1115"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"info",children:"Info"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"Info"}),": ",(0,t.jsx)(n.code,{children:"1"})]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L1113",children:"packages/extension-api/src/extension-api.d.ts:1113"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"warning",children:"Warning"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"Warning"}),": ",(0,t.jsx)(n.code,{children:"2"})]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"defined-in-2",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L1114",children:"packages/extension-api/src/extension-api.d.ts:1114"})})]})}function h(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},43023:(e,n,i)=>{i.d(n,{R:()=>s,x:()=>a});var t=i(63696);const r={},o=t.createContext(r);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(r):e.components||r:s(e.components),t.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[55756],{27164:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>d,contentTitle:()=>s,default:()=>h,frontMatter:()=>o,metadata:()=>a,toc:()=>c});var t=i(62540),r=i(43023);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"}},d={},c=[{value:"Enumeration Members",id:"enumeration-members",level:2},{value:"Error",id:"error",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"Info",id:"info",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"Warning",id:"warning",level:3},{value:"Defined in",id:"defined-in-2",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",p:"p",strong:"strong",...(0,r.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.header,{children:(0,t.jsx)(n.h1,{id:"enumeration-inputboxvalidationseverity",children:"Enumeration: InputBoxValidationSeverity"})}),"\n",(0,t.jsx)(n.p,{children:"Impacts the behavior and appearance of the validation message."}),"\n",(0,t.jsx)(n.h2,{id:"enumeration-members",children:"Enumeration Members"}),"\n",(0,t.jsx)(n.h3,{id:"error",children:"Error"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"Error"}),": ",(0,t.jsx)(n.code,{children:"3"})]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L1115",children:"packages/extension-api/src/extension-api.d.ts:1115"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"info",children:"Info"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"Info"}),": ",(0,t.jsx)(n.code,{children:"1"})]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L1113",children:"packages/extension-api/src/extension-api.d.ts:1113"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"warning",children:"Warning"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"Warning"}),": ",(0,t.jsx)(n.code,{children:"2"})]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"defined-in-2",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L1114",children:"packages/extension-api/src/extension-api.d.ts:1114"})})]})}function h(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},43023:(e,n,i)=>{i.d(n,{R:()=>s,x:()=>a});var t=i(63696);const r={},o=t.createContext(r);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(r):e.components||r:s(e.components),t.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/df2a6e58.d70df1a5.js b/assets/js/df2a6e58.678d5d36.js similarity index 98% rename from assets/js/df2a6e58.d70df1a5.js rename to assets/js/df2a6e58.678d5d36.js index a3b74e842e1..98daaadb685 100644 --- a/assets/js/df2a6e58.d70df1a5.js +++ b/assets/js/df2a6e58.678d5d36.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[72290],{29852:(n,e,i)=>{i.r(e),i.d(e,{assets:()=>a,contentTitle:()=>r,default:()=>p,frontMatter:()=>t,metadata:()=>c,toc:()=>l});var s=i(62540),o=i(43023);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:"Defined in",id:"defined-in",level:2}];function d(n){const e={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",pre:"pre",strong:"strong",...(0,o.R)(),...n.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(e.header,{children:(0,s.jsx)(e.h1,{id:"function-listinfos",children:"Function: listInfos()"})}),"\n",(0,s.jsxs)(e.blockquote,{children:["\n",(0,s.jsxs)(e.p,{children:[(0,s.jsx)(e.strong,{children:"listInfos"}),"(",(0,s.jsx)(e.code,{children:"options"}),"?): ",(0,s.jsx)(e.code,{children:"Promise"}),"<",(0,s.jsx)(e.a,{href:"/api/interfaces/ContainerEngineInfo",children:(0,s.jsx)(e.code,{children:"ContainerEngineInfo"})}),"[]>"]}),"\n"]}),"\n",(0,s.jsx)(e.p,{children:"List the engines information."}),"\n",(0,s.jsx)(e.h2,{id:"parameters",children:"Parameters"}),"\n",(0,s.jsxs)(e.p,{children:["\u2022 ",(0,s.jsx)(e.strong,{children:"options?"}),": ",(0,s.jsx)(e.a,{href:"/api/interfaces/ListInfosOptions",children:(0,s.jsx)(e.code,{children:"ListInfosOptions"})})]}),"\n",(0,s.jsx)(e.p,{children:"optional options for listing information"}),"\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.a,{href:"/api/interfaces/ContainerEngineInfo",children:(0,s.jsx)(e.code,{children:"ContainerEngineInfo"})}),"[]>"]}),"\n",(0,s.jsx)(e.p,{children:"A promise resolving to an array of engine information."}),"\n",(0,s.jsx)(e.h2,{id:"examples",children:"Examples"}),"\n",(0,s.jsx)(e.pre,{children:(0,s.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,s.jsx)(e.pre,{children:(0,s.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,s.jsx)(e.h2,{id:"defined-in",children:"Defined in"}),"\n",(0,s.jsx)(e.p,{children:(0,s.jsx)(e.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L3667",children:"packages/extension-api/src/extension-api.d.ts:3667"})})]})}function p(n={}){const{wrapper:e}={...(0,o.R)(),...n.components};return e?(0,s.jsx)(e,{...n,children:(0,s.jsx)(d,{...n})}):d(n)}},43023:(n,e,i)=>{i.d(e,{R:()=>r,x:()=>c});var s=i(63696);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 c(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 +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[72290],{29852:(n,e,i)=>{i.r(e),i.d(e,{assets:()=>a,contentTitle:()=>r,default:()=>p,frontMatter:()=>t,metadata:()=>c,toc:()=>l});var s=i(62540),o=i(43023);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:"Defined in",id:"defined-in",level:2}];function d(n){const e={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",pre:"pre",strong:"strong",...(0,o.R)(),...n.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(e.header,{children:(0,s.jsx)(e.h1,{id:"function-listinfos",children:"Function: listInfos()"})}),"\n",(0,s.jsxs)(e.blockquote,{children:["\n",(0,s.jsxs)(e.p,{children:[(0,s.jsx)(e.strong,{children:"listInfos"}),"(",(0,s.jsx)(e.code,{children:"options"}),"?): ",(0,s.jsx)(e.code,{children:"Promise"}),"<",(0,s.jsx)(e.a,{href:"/api/interfaces/ContainerEngineInfo",children:(0,s.jsx)(e.code,{children:"ContainerEngineInfo"})}),"[]>"]}),"\n"]}),"\n",(0,s.jsx)(e.p,{children:"List the engines information."}),"\n",(0,s.jsx)(e.h2,{id:"parameters",children:"Parameters"}),"\n",(0,s.jsxs)(e.p,{children:["\u2022 ",(0,s.jsx)(e.strong,{children:"options?"}),": ",(0,s.jsx)(e.a,{href:"/api/interfaces/ListInfosOptions",children:(0,s.jsx)(e.code,{children:"ListInfosOptions"})})]}),"\n",(0,s.jsx)(e.p,{children:"optional options for listing information"}),"\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.a,{href:"/api/interfaces/ContainerEngineInfo",children:(0,s.jsx)(e.code,{children:"ContainerEngineInfo"})}),"[]>"]}),"\n",(0,s.jsx)(e.p,{children:"A promise resolving to an array of engine information."}),"\n",(0,s.jsx)(e.h2,{id:"examples",children:"Examples"}),"\n",(0,s.jsx)(e.pre,{children:(0,s.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,s.jsx)(e.pre,{children:(0,s.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,s.jsx)(e.h2,{id:"defined-in",children:"Defined in"}),"\n",(0,s.jsx)(e.p,{children:(0,s.jsx)(e.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L3667",children:"packages/extension-api/src/extension-api.d.ts:3667"})})]})}function p(n={}){const{wrapper:e}={...(0,o.R)(),...n.components};return e?(0,s.jsx)(e,{...n,children:(0,s.jsx)(d,{...n})}):d(n)}},43023:(n,e,i)=>{i.d(e,{R:()=>r,x:()=>c});var s=i(63696);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 c(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/df4d464e.66fe4596.js b/assets/js/df4d464e.d61eddac.js similarity index 97% rename from assets/js/df4d464e.66fe4596.js rename to assets/js/df4d464e.d61eddac.js index bba45994679..aabca6174f6 100644 --- a/assets/js/df4d464e.66fe4596.js +++ b/assets/js/df4d464e.d61eddac.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[60102],{80775:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>a,contentTitle:()=>c,default:()=>l,frontMatter:()=>r,metadata:()=>o,toc:()=>d});var t=s(62540),i=s(43023);const r={},c="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:"navigation",permalink:"/api/namespaces/navigation/"}},a={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Defined in",id:"defined-in",level:2}];function u(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",strong:"strong",...(0,i.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.header,{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:"defined-in",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2105",children:"packages/extension-api/src/extension-api.d.ts:2105"})})]})}function l(e={}){const{wrapper:n}={...(0,i.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(u,{...e})}):u(e)}},43023:(e,n,s)=>{s.d(n,{R:()=>c,x:()=>o});var t=s(63696);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([[60102],{80775:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>a,contentTitle:()=>c,default:()=>l,frontMatter:()=>r,metadata:()=>o,toc:()=>d});var t=s(62540),i=s(43023);const r={},c="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:"navigation",permalink:"/api/namespaces/navigation/"}},a={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Defined in",id:"defined-in",level:2}];function u(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",strong:"strong",...(0,i.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.header,{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:"defined-in",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2105",children:"packages/extension-api/src/extension-api.d.ts:2105"})})]})}function l(e={}){const{wrapper:n}={...(0,i.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(u,{...e})}):u(e)}},43023:(e,n,s)=>{s.d(n,{R:()=>c,x:()=>o});var t=s(63696);const i={},r=t.createContext(i);function c(e){const n=t.useContext(r);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:c(e.components),t.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/e064f6d4.04de8f12.js b/assets/js/e064f6d4.8321315e.js similarity index 92% rename from assets/js/e064f6d4.04de8f12.js rename to assets/js/e064f6d4.8321315e.js index daf5e6d1f83..099eb89ce04 100644 --- a/assets/js/e064f6d4.04de8f12.js +++ b/assets/js/e064f6d4.8321315e.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[42586],{45668:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>o,contentTitle:()=>r,default:()=>h,frontMatter:()=>l,metadata:()=>c,toc:()=>t});var s=i(62540),d=i(43023);const l={},r="Interface: ContainerInspectInfo",c={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:"Defined in",id:"defined-in",level:4},{value:"Args",id:"args",level:3},{value:"Defined in",id:"defined-in-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:"Defined in",id:"defined-in-2",level:4},{value:"Created",id:"created",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"Driver",id:"driver",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"ExecIDs?",id:"execids",level:3},{value:"Defined in",id:"defined-in-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:"Defined in",id:"defined-in-6",level:4},{value:"HostConfig",id:"hostconfig",level:3},{value:"Defined in",id:"defined-in-7",level:4},{value:"HostnamePath",id:"hostnamepath",level:3},{value:"Defined in",id:"defined-in-8",level:4},{value:"HostsPath",id:"hostspath",level:3},{value:"Defined in",id:"defined-in-9",level:4},{value:"Id",id:"id",level:3},{value:"Defined in",id:"defined-in-10",level:4},{value:"Image",id:"image-1",level:3},{value:"Defined in",id:"defined-in-11",level:4},{value:"LogPath",id:"logpath",level:3},{value:"Defined in",id:"defined-in-12",level:4},{value:"MountLabel",id:"mountlabel",level:3},{value:"Defined in",id:"defined-in-13",level:4},{value:"Mounts",id:"mounts",level:3},{value:"Defined in",id:"defined-in-14",level:4},{value:"Name",id:"name-1",level:3},{value:"Defined in",id:"defined-in-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:"Defined in",id:"defined-in-16",level:4},{value:"Path",id:"path",level:3},{value:"Defined in",id:"defined-in-17",level:4},{value:"Platform",id:"platform",level:3},{value:"Defined in",id:"defined-in-18",level:4},{value:"ProcessLabel",id:"processlabel",level:3},{value:"Defined in",id:"defined-in-19",level:4},{value:"ResolvConfPath",id:"resolvconfpath",level:3},{value:"Defined in",id:"defined-in-20",level:4},{value:"RestartCount",id:"restartcount",level:3},{value:"Defined in",id:"defined-in-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:"Defined in",id:"defined-in-22",level:4},{value:"engineId",id:"engineid",level:3},{value:"Defined in",id:"defined-in-23",level:4},{value:"engineName",id:"enginename",level:3},{value:"Defined in",id:"defined-in-24",level:4}];function a(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",h5:"h5",header:"header",hr:"hr",p:"p",strong:"strong",...(0,d.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.header,{children:(0,s.jsx)(n.h1,{id:"interface-containerinspectinfo",children:"Interface: ContainerInspectInfo"})}),"\n",(0,s.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,s.jsx)(n.h3,{id:"apparmorprofile",children:"AppArmorProfile"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"AppArmorProfile"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2574",children:"packages/extension-api/src/extension-api.d.ts:2574"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"args",children:"Args"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Args"}),": ",(0,s.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2548",children:"packages/extension-api/src/extension-api.d.ts:2548"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"config",children:"Config"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Config"}),": ",(0,s.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"attachstderr",children:"AttachStderr"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"AttachStderr"}),": ",(0,s.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"attachstdin",children:"AttachStdin"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"AttachStdin"}),": ",(0,s.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"attachstdout",children:"AttachStdout"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"AttachStdout"}),": ",(0,s.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"cmd",children:"Cmd"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Cmd"}),": ",(0,s.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"domainname",children:"Domainname"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Domainname"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"entrypoint",children:"Entrypoint?"}),"\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:"Entrypoint"}),": ",(0,s.jsx)(n.code,{children:"string"})," | ",(0,s.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"env",children:"Env"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Env"}),": ",(0,s.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"exposedports",children:"ExposedPorts"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"ExposedPorts"}),": ",(0,s.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,s.jsx)(n.h5,{id:"index-signature",children:"Index Signature"}),"\n",(0,s.jsxs)(n.p,{children:["[",(0,s.jsx)(n.code,{children:"portAndProtocol"}),": ",(0,s.jsx)(n.code,{children:"string"}),"]: ",(0,s.jsx)(n.code,{children:"unknown"})]}),"\n",(0,s.jsx)(n.h4,{id:"hostname",children:"Hostname"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Hostname"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"image",children:"Image"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Image"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"labels",children:"Labels"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Labels"}),": ",(0,s.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,s.jsx)(n.h5,{id:"index-signature-1",children:"Index Signature"}),"\n",(0,s.jsxs)(n.p,{children:["[",(0,s.jsx)(n.code,{children:"label"}),": ",(0,s.jsx)(n.code,{children:"string"}),"]: ",(0,s.jsx)(n.code,{children:"string"})]}),"\n",(0,s.jsx)(n.h4,{id:"onbuild",children:"OnBuild?"}),"\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:"OnBuild"}),": ",(0,s.jsx)(n.code,{children:"unknown"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"openstdin",children:"OpenStdin"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"OpenStdin"}),": ",(0,s.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"stdinonce",children:"StdinOnce"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"StdinOnce"}),": ",(0,s.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"tty",children:"Tty"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Tty"}),": ",(0,s.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"user",children:"User"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"User"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"volumes",children:"Volumes"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Volumes"}),": ",(0,s.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,s.jsx)(n.h5,{id:"index-signature-2",children:"Index Signature"}),"\n",(0,s.jsxs)(n.p,{children:["[",(0,s.jsx)(n.code,{children:"volume"}),": ",(0,s.jsx)(n.code,{children:"string"}),"]: ",(0,s.jsx)(n.code,{children:"unknown"})]}),"\n",(0,s.jsx)(n.h4,{id:"workingdir",children:"WorkingDir"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"WorkingDir"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-2",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2593",children:"packages/extension-api/src/extension-api.d.ts:2593"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"created",children:"Created"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Created"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-3",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2546",children:"packages/extension-api/src/extension-api.d.ts:2546"})}),"\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.strong,{children:"Driver"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-4",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2570",children:"packages/extension-api/src/extension-api.d.ts:2570"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"execids",children:"ExecIDs?"}),"\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:"ExecIDs"}),": ",(0,s.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-5",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2575",children:"packages/extension-api/src/extension-api.d.ts:2575"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"graphdriver",children:"GraphDriver"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"GraphDriver"}),": ",(0,s.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"data",children:"Data"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Data"}),": ",(0,s.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"datadeviceid",children:"Data.DeviceId"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"DeviceId"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"datadevicename",children:"Data.DeviceName"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"DeviceName"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"datadevicesize",children:"Data.DeviceSize"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"DeviceSize"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{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:"defined-in-6",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2577",children:"packages/extension-api/src/extension-api.d.ts:2577"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"hostconfig",children:"HostConfig"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"HostConfig"}),": ",(0,s.jsx)(n.a,{href:"/api/interfaces/HostConfig",children:(0,s.jsx)(n.code,{children:"HostConfig"})})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-7",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2576",children:"packages/extension-api/src/extension-api.d.ts:2576"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"hostnamepath",children:"HostnamePath"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"HostnamePath"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-8",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2565",children:"packages/extension-api/src/extension-api.d.ts:2565"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"hostspath",children:"HostsPath"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"HostsPath"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-9",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2566",children:"packages/extension-api/src/extension-api.d.ts:2566"})}),"\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:"defined-in-10",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2545",children:"packages/extension-api/src/extension-api.d.ts:2545"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"image-1",children:"Image"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Image"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-11",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2563",children:"packages/extension-api/src/extension-api.d.ts:2563"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"logpath",children:"LogPath"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"LogPath"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-12",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2567",children:"packages/extension-api/src/extension-api.d.ts:2567"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"mountlabel",children:"MountLabel"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"MountLabel"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-13",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2572",children:"packages/extension-api/src/extension-api.d.ts:2572"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"mounts",children:"Mounts"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Mounts"}),": ",(0,s.jsx)(n.code,{children:"object"}),"[]"]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-14",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2585",children:"packages/extension-api/src/extension-api.d.ts:2585"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"name-1",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:"defined-in-15",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2568",children:"packages/extension-api/src/extension-api.d.ts:2568"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"networksettings",children:"NetworkSettings"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"NetworkSettings"}),": ",(0,s.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"bridge",children:"Bridge"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Bridge"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"endpointid",children:"EndpointID"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"EndpointID"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"gateway",children:"Gateway"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Gateway"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"globalipv6address",children:"GlobalIPv6Address"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"GlobalIPv6Address"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"globalipv6prefixlen",children:"GlobalIPv6PrefixLen"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"GlobalIPv6PrefixLen"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"hairpinmode",children:"HairpinMode"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"HairpinMode"}),": ",(0,s.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"ipaddress",children:"IPAddress"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"IPAddress"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"ipprefixlen",children:"IPPrefixLen"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"IPPrefixLen"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"ipv6gateway",children:"IPv6Gateway"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"IPv6Gateway"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"linklocalipv6address",children:"LinkLocalIPv6Address"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"LinkLocalIPv6Address"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"linklocalipv6prefixlen",children:"LinkLocalIPv6PrefixLen"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"LinkLocalIPv6PrefixLen"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"macaddress",children:"MacAddress"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"MacAddress"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"networks",children:"Networks"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Networks"}),": ",(0,s.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,s.jsx)(n.h5,{id:"index-signature-3",children:"Index Signature"}),"\n",(0,s.jsxs)(n.p,{children:["[",(0,s.jsx)(n.code,{children:"type"}),": ",(0,s.jsx)(n.code,{children:"string"}),"]: ",(0,s.jsx)(n.code,{children:"object"})]}),"\n",(0,s.jsx)(n.h4,{id:"node",children:"Node?"}),"\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:"Node"}),": ",(0,s.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"nodeaddr",children:"Node.Addr"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Addr"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"nodecpus",children:"Node.Cpus"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Cpus"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"nodeid",children:"Node.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:"nodeip",children:"Node.IP"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"IP"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"nodelabels",children:"Node.Labels"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Labels"}),": ",(0,s.jsx)(n.code,{children:"unknown"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"nodememory",children:"Node.Memory"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Memory"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"nodename",children:"Node.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:"ports",children:"Ports"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Ports"}),": ",(0,s.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,s.jsx)(n.h5,{id:"index-signature-4",children:"Index Signature"}),"\n",(0,s.jsxs)(n.p,{children:["[",(0,s.jsx)(n.code,{children:"portAndProtocol"}),": ",(0,s.jsx)(n.code,{children:"string"}),"]: ",(0,s.jsx)(n.code,{children:"object"}),"[]"]}),"\n",(0,s.jsx)(n.h4,{id:"sandboxid",children:"SandboxID"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"SandboxID"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"sandboxkey",children:"SandboxKey"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"SandboxKey"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"secondaryipaddresses",children:"SecondaryIPAddresses?"}),"\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:"SecondaryIPAddresses"}),": ",(0,s.jsx)(n.code,{children:"unknown"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"secondaryipv6addresses",children:"SecondaryIPv6Addresses?"}),"\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:"SecondaryIPv6Addresses"}),": ",(0,s.jsx)(n.code,{children:"unknown"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-16",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2613",children:"packages/extension-api/src/extension-api.d.ts:2613"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"path",children:"Path"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Path"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-17",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2547",children:"packages/extension-api/src/extension-api.d.ts:2547"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"platform",children:"Platform"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Platform"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-18",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2571",children:"packages/extension-api/src/extension-api.d.ts:2571"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"processlabel",children:"ProcessLabel"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"ProcessLabel"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-19",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2573",children:"packages/extension-api/src/extension-api.d.ts:2573"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"resolvconfpath",children:"ResolvConfPath"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"ResolvConfPath"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-20",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2564",children:"packages/extension-api/src/extension-api.d.ts:2564"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"restartcount",children:"RestartCount"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"RestartCount"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-21",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2569",children:"packages/extension-api/src/extension-api.d.ts:2569"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"state",children:"State"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"State"}),": ",(0,s.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"dead",children:"Dead"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Dead"}),": ",(0,s.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{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:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{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.h4,{id:"finishedat",children:"FinishedAt"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"FinishedAt"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"health",children:"Health?"}),"\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:"Health"}),": ",(0,s.jsx)(n.a,{href:"/api/interfaces/HealthCheckResults",children:(0,s.jsx)(n.code,{children:"HealthCheckResults"})})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"oomkilled",children:"OOMKilled"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"OOMKilled"}),": ",(0,s.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"paused",children:"Paused"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Paused"}),": ",(0,s.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"pid",children:"Pid"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Pid"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"restarting",children:"Restarting"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Restarting"}),": ",(0,s.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"running",children:"Running"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Running"}),": ",(0,s.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"startedat",children:"StartedAt"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"StartedAt"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{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:"defined-in-22",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2549",children:"packages/extension-api/src/extension-api.d.ts:2549"})}),"\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.h4,{id:"defined-in-23",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2543",children:"packages/extension-api/src/extension-api.d.ts:2543"})}),"\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.h4,{id:"defined-in-24",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2544",children:"packages/extension-api/src/extension-api.d.ts:2544"})})]})}function h(e={}){const{wrapper:n}={...(0,d.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(a,{...e})}):a(e)}},43023:(e,n,i)=>{i.d(n,{R:()=>r,x:()=>c});var s=i(63696);const d={},l=s.createContext(d);function r(e){const n=s.useContext(l);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(d):e.components||d:r(e.components),s.createElement(l.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[42586],{45668:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>o,contentTitle:()=>r,default:()=>h,frontMatter:()=>l,metadata:()=>c,toc:()=>t});var s=i(62540),d=i(43023);const l={},r="Interface: ContainerInspectInfo",c={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:"Defined in",id:"defined-in",level:4},{value:"Args",id:"args",level:3},{value:"Defined in",id:"defined-in-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:"Defined in",id:"defined-in-2",level:4},{value:"Created",id:"created",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"Driver",id:"driver",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"ExecIDs?",id:"execids",level:3},{value:"Defined in",id:"defined-in-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:"Defined in",id:"defined-in-6",level:4},{value:"HostConfig",id:"hostconfig",level:3},{value:"Defined in",id:"defined-in-7",level:4},{value:"HostnamePath",id:"hostnamepath",level:3},{value:"Defined in",id:"defined-in-8",level:4},{value:"HostsPath",id:"hostspath",level:3},{value:"Defined in",id:"defined-in-9",level:4},{value:"Id",id:"id",level:3},{value:"Defined in",id:"defined-in-10",level:4},{value:"Image",id:"image-1",level:3},{value:"Defined in",id:"defined-in-11",level:4},{value:"LogPath",id:"logpath",level:3},{value:"Defined in",id:"defined-in-12",level:4},{value:"MountLabel",id:"mountlabel",level:3},{value:"Defined in",id:"defined-in-13",level:4},{value:"Mounts",id:"mounts",level:3},{value:"Defined in",id:"defined-in-14",level:4},{value:"Name",id:"name-1",level:3},{value:"Defined in",id:"defined-in-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:"Defined in",id:"defined-in-16",level:4},{value:"Path",id:"path",level:3},{value:"Defined in",id:"defined-in-17",level:4},{value:"Platform",id:"platform",level:3},{value:"Defined in",id:"defined-in-18",level:4},{value:"ProcessLabel",id:"processlabel",level:3},{value:"Defined in",id:"defined-in-19",level:4},{value:"ResolvConfPath",id:"resolvconfpath",level:3},{value:"Defined in",id:"defined-in-20",level:4},{value:"RestartCount",id:"restartcount",level:3},{value:"Defined in",id:"defined-in-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:"Defined in",id:"defined-in-22",level:4},{value:"engineId",id:"engineid",level:3},{value:"Defined in",id:"defined-in-23",level:4},{value:"engineName",id:"enginename",level:3},{value:"Defined in",id:"defined-in-24",level:4}];function a(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",h5:"h5",header:"header",hr:"hr",p:"p",strong:"strong",...(0,d.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.header,{children:(0,s.jsx)(n.h1,{id:"interface-containerinspectinfo",children:"Interface: ContainerInspectInfo"})}),"\n",(0,s.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,s.jsx)(n.h3,{id:"apparmorprofile",children:"AppArmorProfile"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"AppArmorProfile"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2574",children:"packages/extension-api/src/extension-api.d.ts:2574"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"args",children:"Args"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Args"}),": ",(0,s.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2548",children:"packages/extension-api/src/extension-api.d.ts:2548"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"config",children:"Config"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Config"}),": ",(0,s.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"attachstderr",children:"AttachStderr"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"AttachStderr"}),": ",(0,s.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"attachstdin",children:"AttachStdin"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"AttachStdin"}),": ",(0,s.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"attachstdout",children:"AttachStdout"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"AttachStdout"}),": ",(0,s.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"cmd",children:"Cmd"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Cmd"}),": ",(0,s.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"domainname",children:"Domainname"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Domainname"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"entrypoint",children:"Entrypoint?"}),"\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:"Entrypoint"}),": ",(0,s.jsx)(n.code,{children:"string"})," | ",(0,s.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"env",children:"Env"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Env"}),": ",(0,s.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"exposedports",children:"ExposedPorts"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"ExposedPorts"}),": ",(0,s.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,s.jsx)(n.h5,{id:"index-signature",children:"Index Signature"}),"\n",(0,s.jsxs)(n.p,{children:["[",(0,s.jsx)(n.code,{children:"portAndProtocol"}),": ",(0,s.jsx)(n.code,{children:"string"}),"]: ",(0,s.jsx)(n.code,{children:"unknown"})]}),"\n",(0,s.jsx)(n.h4,{id:"hostname",children:"Hostname"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Hostname"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"image",children:"Image"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Image"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"labels",children:"Labels"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Labels"}),": ",(0,s.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,s.jsx)(n.h5,{id:"index-signature-1",children:"Index Signature"}),"\n",(0,s.jsxs)(n.p,{children:["[",(0,s.jsx)(n.code,{children:"label"}),": ",(0,s.jsx)(n.code,{children:"string"}),"]: ",(0,s.jsx)(n.code,{children:"string"})]}),"\n",(0,s.jsx)(n.h4,{id:"onbuild",children:"OnBuild?"}),"\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:"OnBuild"}),": ",(0,s.jsx)(n.code,{children:"unknown"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"openstdin",children:"OpenStdin"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"OpenStdin"}),": ",(0,s.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"stdinonce",children:"StdinOnce"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"StdinOnce"}),": ",(0,s.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"tty",children:"Tty"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Tty"}),": ",(0,s.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"user",children:"User"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"User"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"volumes",children:"Volumes"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Volumes"}),": ",(0,s.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,s.jsx)(n.h5,{id:"index-signature-2",children:"Index Signature"}),"\n",(0,s.jsxs)(n.p,{children:["[",(0,s.jsx)(n.code,{children:"volume"}),": ",(0,s.jsx)(n.code,{children:"string"}),"]: ",(0,s.jsx)(n.code,{children:"unknown"})]}),"\n",(0,s.jsx)(n.h4,{id:"workingdir",children:"WorkingDir"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"WorkingDir"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-2",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2593",children:"packages/extension-api/src/extension-api.d.ts:2593"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"created",children:"Created"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Created"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-3",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2546",children:"packages/extension-api/src/extension-api.d.ts:2546"})}),"\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.strong,{children:"Driver"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-4",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2570",children:"packages/extension-api/src/extension-api.d.ts:2570"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"execids",children:"ExecIDs?"}),"\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:"ExecIDs"}),": ",(0,s.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-5",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2575",children:"packages/extension-api/src/extension-api.d.ts:2575"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"graphdriver",children:"GraphDriver"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"GraphDriver"}),": ",(0,s.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"data",children:"Data"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Data"}),": ",(0,s.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"datadeviceid",children:"Data.DeviceId"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"DeviceId"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"datadevicename",children:"Data.DeviceName"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"DeviceName"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"datadevicesize",children:"Data.DeviceSize"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"DeviceSize"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{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:"defined-in-6",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2577",children:"packages/extension-api/src/extension-api.d.ts:2577"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"hostconfig",children:"HostConfig"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"HostConfig"}),": ",(0,s.jsx)(n.a,{href:"/api/interfaces/HostConfig",children:(0,s.jsx)(n.code,{children:"HostConfig"})})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-7",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2576",children:"packages/extension-api/src/extension-api.d.ts:2576"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"hostnamepath",children:"HostnamePath"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"HostnamePath"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-8",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2565",children:"packages/extension-api/src/extension-api.d.ts:2565"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"hostspath",children:"HostsPath"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"HostsPath"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-9",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2566",children:"packages/extension-api/src/extension-api.d.ts:2566"})}),"\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:"defined-in-10",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2545",children:"packages/extension-api/src/extension-api.d.ts:2545"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"image-1",children:"Image"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Image"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-11",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2563",children:"packages/extension-api/src/extension-api.d.ts:2563"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"logpath",children:"LogPath"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"LogPath"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-12",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2567",children:"packages/extension-api/src/extension-api.d.ts:2567"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"mountlabel",children:"MountLabel"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"MountLabel"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-13",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2572",children:"packages/extension-api/src/extension-api.d.ts:2572"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"mounts",children:"Mounts"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Mounts"}),": ",(0,s.jsx)(n.code,{children:"object"}),"[]"]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-14",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2585",children:"packages/extension-api/src/extension-api.d.ts:2585"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"name-1",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:"defined-in-15",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2568",children:"packages/extension-api/src/extension-api.d.ts:2568"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"networksettings",children:"NetworkSettings"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"NetworkSettings"}),": ",(0,s.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"bridge",children:"Bridge"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Bridge"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"endpointid",children:"EndpointID"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"EndpointID"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"gateway",children:"Gateway"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Gateway"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"globalipv6address",children:"GlobalIPv6Address"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"GlobalIPv6Address"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"globalipv6prefixlen",children:"GlobalIPv6PrefixLen"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"GlobalIPv6PrefixLen"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"hairpinmode",children:"HairpinMode"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"HairpinMode"}),": ",(0,s.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"ipaddress",children:"IPAddress"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"IPAddress"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"ipprefixlen",children:"IPPrefixLen"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"IPPrefixLen"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"ipv6gateway",children:"IPv6Gateway"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"IPv6Gateway"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"linklocalipv6address",children:"LinkLocalIPv6Address"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"LinkLocalIPv6Address"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"linklocalipv6prefixlen",children:"LinkLocalIPv6PrefixLen"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"LinkLocalIPv6PrefixLen"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"macaddress",children:"MacAddress"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"MacAddress"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"networks",children:"Networks"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Networks"}),": ",(0,s.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,s.jsx)(n.h5,{id:"index-signature-3",children:"Index Signature"}),"\n",(0,s.jsxs)(n.p,{children:["[",(0,s.jsx)(n.code,{children:"type"}),": ",(0,s.jsx)(n.code,{children:"string"}),"]: ",(0,s.jsx)(n.code,{children:"object"})]}),"\n",(0,s.jsx)(n.h4,{id:"node",children:"Node?"}),"\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:"Node"}),": ",(0,s.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"nodeaddr",children:"Node.Addr"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Addr"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"nodecpus",children:"Node.Cpus"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Cpus"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"nodeid",children:"Node.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:"nodeip",children:"Node.IP"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"IP"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"nodelabels",children:"Node.Labels"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Labels"}),": ",(0,s.jsx)(n.code,{children:"unknown"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"nodememory",children:"Node.Memory"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Memory"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"nodename",children:"Node.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:"ports",children:"Ports"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Ports"}),": ",(0,s.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,s.jsx)(n.h5,{id:"index-signature-4",children:"Index Signature"}),"\n",(0,s.jsxs)(n.p,{children:["[",(0,s.jsx)(n.code,{children:"portAndProtocol"}),": ",(0,s.jsx)(n.code,{children:"string"}),"]: ",(0,s.jsx)(n.code,{children:"object"}),"[]"]}),"\n",(0,s.jsx)(n.h4,{id:"sandboxid",children:"SandboxID"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"SandboxID"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"sandboxkey",children:"SandboxKey"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"SandboxKey"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"secondaryipaddresses",children:"SecondaryIPAddresses?"}),"\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:"SecondaryIPAddresses"}),": ",(0,s.jsx)(n.code,{children:"unknown"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"secondaryipv6addresses",children:"SecondaryIPv6Addresses?"}),"\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:"SecondaryIPv6Addresses"}),": ",(0,s.jsx)(n.code,{children:"unknown"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-16",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2613",children:"packages/extension-api/src/extension-api.d.ts:2613"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"path",children:"Path"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Path"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-17",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2547",children:"packages/extension-api/src/extension-api.d.ts:2547"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"platform",children:"Platform"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Platform"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-18",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2571",children:"packages/extension-api/src/extension-api.d.ts:2571"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"processlabel",children:"ProcessLabel"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"ProcessLabel"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-19",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2573",children:"packages/extension-api/src/extension-api.d.ts:2573"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"resolvconfpath",children:"ResolvConfPath"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"ResolvConfPath"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-20",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2564",children:"packages/extension-api/src/extension-api.d.ts:2564"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"restartcount",children:"RestartCount"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"RestartCount"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-21",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2569",children:"packages/extension-api/src/extension-api.d.ts:2569"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"state",children:"State"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"State"}),": ",(0,s.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"dead",children:"Dead"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Dead"}),": ",(0,s.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{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:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{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.h4,{id:"finishedat",children:"FinishedAt"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"FinishedAt"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"health",children:"Health?"}),"\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:"Health"}),": ",(0,s.jsx)(n.a,{href:"/api/interfaces/HealthCheckResults",children:(0,s.jsx)(n.code,{children:"HealthCheckResults"})})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"oomkilled",children:"OOMKilled"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"OOMKilled"}),": ",(0,s.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"paused",children:"Paused"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Paused"}),": ",(0,s.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"pid",children:"Pid"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Pid"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"restarting",children:"Restarting"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Restarting"}),": ",(0,s.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"running",children:"Running"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Running"}),": ",(0,s.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"startedat",children:"StartedAt"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"StartedAt"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{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:"defined-in-22",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2549",children:"packages/extension-api/src/extension-api.d.ts:2549"})}),"\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.h4,{id:"defined-in-23",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2543",children:"packages/extension-api/src/extension-api.d.ts:2543"})}),"\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.h4,{id:"defined-in-24",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2544",children:"packages/extension-api/src/extension-api.d.ts:2544"})})]})}function h(e={}){const{wrapper:n}={...(0,d.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(a,{...e})}):a(e)}},43023:(e,n,i)=>{i.d(n,{R:()=>r,x:()=>c});var s=i(63696);const d={},l=s.createContext(d);function r(e){const n=s.useContext(l);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(d):e.components||d:r(e.components),s.createElement(l.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/e1a2ab10.930df6c7.js b/assets/js/e1a2ab10.57eb07ce.js similarity index 81% rename from assets/js/e1a2ab10.930df6c7.js rename to assets/js/e1a2ab10.57eb07ce.js index 4cb44db54f3..16202c4d5ba 100644 --- a/assets/js/e1a2ab10.930df6c7.js +++ b/assets/js/e1a2ab10.57eb07ce.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[10906],{7368:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>d,contentTitle:()=>a,default:()=>h,frontMatter:()=>t,metadata:()=>c,toc:()=>l});var r=i(62540),s=i(43023);const t={},a="Interface: ProviderInstallation",c={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"}},d={},l=[{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:"Defined in",id:"defined-in",level:4},{value:"preflightChecks()?",id:"preflightchecks",level:3},{value:"Returns",id:"returns-1",level:4},{value:"Defined in",id:"defined-in-1",level:4}];function o(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",p:"p",strong:"strong",...(0,s.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.header,{children:(0,r.jsx)(n.h1,{id:"interface-providerinstallation",children:"Interface: ProviderInstallation"})}),"\n",(0,r.jsx)(n.h2,{id:"methods",children:"Methods"}),"\n",(0,r.jsx)(n.h3,{id:"install",children:"install()"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"install"}),"(",(0,r.jsx)(n.code,{children:"logger"}),"): ",(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:"logger"}),": ",(0,r.jsx)(n.a,{href:"/api/interfaces/Logger",children:(0,r.jsx)(n.code,{children:"Logger"})})]}),"\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:"defined-in",children:"Defined in"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L561",children:"packages/extension-api/src/extension-api.d.ts:561"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"preflightchecks",children:"preflightChecks()?"}),"\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:"preflightChecks"}),"(): ",(0,r.jsx)(n.a,{href:"/api/interfaces/InstallCheck",children:(0,r.jsx)(n.code,{children:"InstallCheck"})}),"[]"]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"returns-1",children:"Returns"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.a,{href:"/api/interfaces/InstallCheck",children:(0,r.jsx)(n.code,{children:"InstallCheck"})}),"[]"]}),"\n",(0,r.jsx)(n.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L559",children:"packages/extension-api/src/extension-api.d.ts:559"})})]})}function h(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(o,{...e})}):o(e)}},43023:(e,n,i)=>{i.d(n,{R:()=>a,x:()=>c});var r=i(63696);const s={},t=r.createContext(s);function a(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(s):e.components||s:a(e.components),r.createElement(t.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[10906],{7368:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>l,contentTitle:()=>c,default:()=>h,frontMatter:()=>t,metadata:()=>a,toc:()=>d});var r=i(62540),s=i(43023);const t={},c="Interface: ProviderInstallation",a={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={},d=[{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:"Defined in",id:"defined-in",level:4},{value:"preflightChecks()?",id:"preflightchecks",level:3},{value:"Returns",id:"returns-1",level:4},{value:"Defined in",id:"defined-in-1",level:4}];function o(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",p:"p",strong:"strong",...(0,s.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.header,{children:(0,r.jsx)(n.h1,{id:"interface-providerinstallation",children:"Interface: ProviderInstallation"})}),"\n",(0,r.jsx)(n.h2,{id:"methods",children:"Methods"}),"\n",(0,r.jsx)(n.h3,{id:"install",children:"install()"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"install"}),"(",(0,r.jsx)(n.code,{children:"logger"}),"): ",(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:"logger"}),": ",(0,r.jsx)(n.a,{href:"/api/interfaces/Logger",children:(0,r.jsx)(n.code,{children:"Logger"})})]}),"\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:"defined-in",children:"Defined in"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L561",children:"packages/extension-api/src/extension-api.d.ts:561"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"preflightchecks",children:"preflightChecks()?"}),"\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:"preflightChecks"}),"(): ",(0,r.jsx)(n.a,{href:"/api/interfaces/InstallCheck",children:(0,r.jsx)(n.code,{children:"InstallCheck"})}),"[]"]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"returns-1",children:"Returns"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.a,{href:"/api/interfaces/InstallCheck",children:(0,r.jsx)(n.code,{children:"InstallCheck"})}),"[]"]}),"\n",(0,r.jsx)(n.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L559",children:"packages/extension-api/src/extension-api.d.ts:559"})})]})}function h(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(o,{...e})}):o(e)}},43023:(e,n,i)=>{i.d(n,{R:()=>c,x:()=>a});var r=i(63696);const s={},t=r.createContext(s);function c(e){const n=r.useContext(t);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:c(e.components),r.createElement(t.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/e1c8d71f.e3b59ac4.js b/assets/js/e1c8d71f.4758f1b4.js similarity index 97% rename from assets/js/e1c8d71f.e3b59ac4.js rename to assets/js/e1c8d71f.4758f1b4.js index 7c79eb56d75..2ce47deed2f 100644 --- a/assets/js/e1c8d71f.e3b59ac4.js +++ b/assets/js/e1c8d71f.4758f1b4.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[59310],{89825:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>c,contentTitle:()=>a,default:()=>l,frontMatter:()=>s,metadata:()=>r,toc:()=>p});var i=n(62540),o=n(43023);const s={},a="Type Alias: NotificationType",r={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"}},c={},p=[{value:"Defined in",id:"defined-in",level:2}];function d(e){const t={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",strong:"strong",...(0,o.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(t.header,{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:"defined-in",children:"Defined in"}),"\n",(0,i.jsx)(t.p,{children:(0,i.jsx)(t.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L1451",children:"packages/extension-api/src/extension-api.d.ts:1451"})})]})}function l(e={}){const{wrapper:t}={...(0,o.R)(),...e.components};return t?(0,i.jsx)(t,{...e,children:(0,i.jsx)(d,{...e})}):d(e)}},43023:(e,t,n)=>{n.d(t,{R:()=>a,x:()=>r});var i=n(63696);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 r(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([[59310],{89825:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>c,contentTitle:()=>a,default:()=>l,frontMatter:()=>s,metadata:()=>r,toc:()=>p});var i=n(62540),o=n(43023);const s={},a="Type Alias: NotificationType",r={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"}},c={},p=[{value:"Defined in",id:"defined-in",level:2}];function d(e){const t={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",strong:"strong",...(0,o.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(t.header,{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:"defined-in",children:"Defined in"}),"\n",(0,i.jsx)(t.p,{children:(0,i.jsx)(t.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L1451",children:"packages/extension-api/src/extension-api.d.ts:1451"})})]})}function l(e={}){const{wrapper:t}={...(0,o.R)(),...e.components};return t?(0,i.jsx)(t,{...e,children:(0,i.jsx)(d,{...e})}):d(e)}},43023:(e,t,n)=>{n.d(t,{R:()=>a,x:()=>r});var i=n(63696);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 r(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.91eb9ec7.js b/assets/js/e35d7c3e.60c58fdd.js similarity index 97% rename from assets/js/e35d7c3e.91eb9ec7.js rename to assets/js/e35d7c3e.60c58fdd.js index 8a916b774a6..3c65443db30 100644 --- a/assets/js/e35d7c3e.91eb9ec7.js +++ b/assets/js/e35d7c3e.60c58fdd.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[54646],{88090:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>c,contentTitle:()=>o,default:()=>p,frontMatter:()=>i,metadata:()=>a,toc:()=>d});var r=n(62540),s=n(43023);const i={},o="Interface: NetworkCreateResult",a={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"}},c={},d=[{value:"Properties",id:"properties",level:2},{value:"Id",id:"id",level:3},{value:"Defined in",id:"defined-in",level:4}];function l(e){const t={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",p:"p",strong:"strong",...(0,s.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(t.header,{children:(0,r.jsx)(t.h1,{id:"interface-networkcreateresult",children:"Interface: NetworkCreateResult"})}),"\n",(0,r.jsx)(t.h2,{id:"properties",children:"Properties"}),"\n",(0,r.jsx)(t.h3,{id:"id",children:"Id"}),"\n",(0,r.jsxs)(t.blockquote,{children:["\n",(0,r.jsxs)(t.p,{children:[(0,r.jsx)(t.strong,{children:"Id"}),": ",(0,r.jsx)(t.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(t.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,r.jsx)(t.p,{children:(0,r.jsx)(t.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L3355",children:"packages/extension-api/src/extension-api.d.ts:3355"})})]})}function p(e={}){const{wrapper:t}={...(0,s.R)(),...e.components};return t?(0,r.jsx)(t,{...e,children:(0,r.jsx)(l,{...e})}):l(e)}},43023:(e,t,n)=>{n.d(t,{R:()=>o,x:()=>a});var r=n(63696);const s={},i=r.createContext(s);function o(e){const t=r.useContext(i);return r.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function a(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:o(e.components),r.createElement(i.Provider,{value:t},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[54646],{88090:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>c,contentTitle:()=>o,default:()=>p,frontMatter:()=>i,metadata:()=>a,toc:()=>d});var r=n(62540),s=n(43023);const i={},o="Interface: NetworkCreateResult",a={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"}},c={},d=[{value:"Properties",id:"properties",level:2},{value:"Id",id:"id",level:3},{value:"Defined in",id:"defined-in",level:4}];function l(e){const t={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",p:"p",strong:"strong",...(0,s.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(t.header,{children:(0,r.jsx)(t.h1,{id:"interface-networkcreateresult",children:"Interface: NetworkCreateResult"})}),"\n",(0,r.jsx)(t.h2,{id:"properties",children:"Properties"}),"\n",(0,r.jsx)(t.h3,{id:"id",children:"Id"}),"\n",(0,r.jsxs)(t.blockquote,{children:["\n",(0,r.jsxs)(t.p,{children:[(0,r.jsx)(t.strong,{children:"Id"}),": ",(0,r.jsx)(t.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(t.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,r.jsx)(t.p,{children:(0,r.jsx)(t.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L3355",children:"packages/extension-api/src/extension-api.d.ts:3355"})})]})}function p(e={}){const{wrapper:t}={...(0,s.R)(),...e.components};return t?(0,r.jsx)(t,{...e,children:(0,r.jsx)(l,{...e})}):l(e)}},43023:(e,t,n)=>{n.d(t,{R:()=>o,x:()=>a});var r=n(63696);const s={},i=r.createContext(s);function o(e){const t=r.useContext(i);return r.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function a(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:o(e.components),r.createElement(i.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/e38c422a.d0c94d36.js b/assets/js/e38c422a.7842f53e.js similarity index 97% rename from assets/js/e38c422a.d0c94d36.js rename to assets/js/e38c422a.7842f53e.js index 3beed44377b..17daa027b82 100644 --- a/assets/js/e38c422a.d0c94d36.js +++ b/assets/js/e38c422a.7842f53e.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[64577],{58446:(n,e,i)=>{i.r(e),i.d(e,{assets:()=>c,contentTitle:()=>s,default:()=>f,frontMatter:()=>r,metadata:()=>a,toc:()=>d});var t=i(62540),o=i(43023);const r={},s="Function: getConfiguration()",a={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:"configuration",permalink:"/api/namespaces/configuration/"},next:{title:"onDidChangeConfiguration",permalink:"/api/namespaces/configuration/functions/onDidChangeConfiguration"}},c={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Defined in",id:"defined-in",level:2}];function u(n){const e={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",strong:"strong",...(0,o.R)(),...n.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(e.header,{children:(0,t.jsx)(e.h1,{id:"function-getconfiguration",children:"Function: getConfiguration()"})}),"\n",(0,t.jsxs)(e.blockquote,{children:["\n",(0,t.jsxs)(e.p,{children:[(0,t.jsx)(e.strong,{children:"getConfiguration"}),"(",(0,t.jsx)(e.code,{children:"section"}),"?, ",(0,t.jsx)(e.code,{children:"scope"}),"?): ",(0,t.jsx)(e.a,{href:"/api/interfaces/Configuration",children:(0,t.jsx)(e.code,{children:"Configuration"})})]}),"\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:"section?"}),": ",(0,t.jsx)(e.code,{children:"string"})]}),"\n",(0,t.jsxs)(e.p,{children:["\u2022 ",(0,t.jsx)(e.strong,{children:"scope?"}),": ",(0,t.jsx)(e.a,{href:"/api/type-aliases/ConfigurationScope",children:(0,t.jsx)(e.code,{children:"ConfigurationScope"})})]}),"\n",(0,t.jsx)(e.h2,{id:"returns",children:"Returns"}),"\n",(0,t.jsx)(e.p,{children:(0,t.jsx)(e.a,{href:"/api/interfaces/Configuration",children:(0,t.jsx)(e.code,{children:"Configuration"})})}),"\n",(0,t.jsx)(e.h2,{id:"defined-in",children:"Defined in"}),"\n",(0,t.jsx)(e.p,{children:(0,t.jsx)(e.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L952",children:"packages/extension-api/src/extension-api.d.ts:952"})})]})}function f(n={}){const{wrapper:e}={...(0,o.R)(),...n.components};return e?(0,t.jsx)(e,{...n,children:(0,t.jsx)(u,{...n})}):u(n)}},43023:(n,e,i)=>{i.d(e,{R:()=>s,x:()=>a});var t=i(63696);const o={},r=t.createContext(o);function s(n){const e=t.useContext(r);return t.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:s(n.components),t.createElement(r.Provider,{value:e},n.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[64577],{58446:(n,e,i)=>{i.r(e),i.d(e,{assets:()=>c,contentTitle:()=>s,default:()=>f,frontMatter:()=>r,metadata:()=>a,toc:()=>d});var t=i(62540),o=i(43023);const r={},s="Function: getConfiguration()",a={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:"configuration",permalink:"/api/namespaces/configuration/"},next:{title:"onDidChangeConfiguration",permalink:"/api/namespaces/configuration/functions/onDidChangeConfiguration"}},c={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Defined in",id:"defined-in",level:2}];function u(n){const e={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",strong:"strong",...(0,o.R)(),...n.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(e.header,{children:(0,t.jsx)(e.h1,{id:"function-getconfiguration",children:"Function: getConfiguration()"})}),"\n",(0,t.jsxs)(e.blockquote,{children:["\n",(0,t.jsxs)(e.p,{children:[(0,t.jsx)(e.strong,{children:"getConfiguration"}),"(",(0,t.jsx)(e.code,{children:"section"}),"?, ",(0,t.jsx)(e.code,{children:"scope"}),"?): ",(0,t.jsx)(e.a,{href:"/api/interfaces/Configuration",children:(0,t.jsx)(e.code,{children:"Configuration"})})]}),"\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:"section?"}),": ",(0,t.jsx)(e.code,{children:"string"})]}),"\n",(0,t.jsxs)(e.p,{children:["\u2022 ",(0,t.jsx)(e.strong,{children:"scope?"}),": ",(0,t.jsx)(e.a,{href:"/api/type-aliases/ConfigurationScope",children:(0,t.jsx)(e.code,{children:"ConfigurationScope"})})]}),"\n",(0,t.jsx)(e.h2,{id:"returns",children:"Returns"}),"\n",(0,t.jsx)(e.p,{children:(0,t.jsx)(e.a,{href:"/api/interfaces/Configuration",children:(0,t.jsx)(e.code,{children:"Configuration"})})}),"\n",(0,t.jsx)(e.h2,{id:"defined-in",children:"Defined in"}),"\n",(0,t.jsx)(e.p,{children:(0,t.jsx)(e.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L952",children:"packages/extension-api/src/extension-api.d.ts:952"})})]})}function f(n={}){const{wrapper:e}={...(0,o.R)(),...n.components};return e?(0,t.jsx)(e,{...n,children:(0,t.jsx)(u,{...n})}):u(n)}},43023:(n,e,i)=>{i.d(e,{R:()=>s,x:()=>a});var t=i(63696);const o={},r=t.createContext(o);function s(n){const e=t.useContext(r);return t.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:s(n.components),t.createElement(r.Provider,{value:e},n.children)}}}]); \ No newline at end of file diff --git a/assets/js/e3f28bf9.3a0d14d4.js b/assets/js/e3f28bf9.b0a5a3ef.js similarity index 94% rename from assets/js/e3f28bf9.3a0d14d4.js rename to assets/js/e3f28bf9.b0a5a3ef.js index 3ec419fdfe2..e15b8160713 100644 --- a/assets/js/e3f28bf9.3a0d14d4.js +++ b/assets/js/e3f28bf9.b0a5a3ef.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[79594],{35694:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>o,default:()=>l,frontMatter:()=>s,metadata:()=>c,toc:()=>d});var r=t(62540),i=t(43023);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:"Defined in",id:"defined-in",level:4}];function p(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",p:"p",strong:"strong",...(0,i.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.header,{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:"defined-in",children:"Defined in"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L715",children:"packages/extension-api/src/extension-api.d.ts:715"})})]})}function l(e={}){const{wrapper:n}={...(0,i.R)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(p,{...e})}):p(e)}},43023:(e,n,t)=>{t.d(n,{R:()=>o,x:()=>c});var r=t(63696);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([[79594],{35694:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>o,default:()=>l,frontMatter:()=>s,metadata:()=>c,toc:()=>d});var r=t(62540),i=t(43023);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:"Defined in",id:"defined-in",level:4}];function p(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",p:"p",strong:"strong",...(0,i.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.header,{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:"defined-in",children:"Defined in"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L715",children:"packages/extension-api/src/extension-api.d.ts:715"})})]})}function l(e={}){const{wrapper:n}={...(0,i.R)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(p,{...e})}):p(e)}},43023:(e,n,t)=>{t.d(n,{R:()=>o,x:()=>c});var r=t(63696);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.9541bbcf.js b/assets/js/e546fc5a.f1feafa2.js similarity index 98% rename from assets/js/e546fc5a.9541bbcf.js rename to assets/js/e546fc5a.f1feafa2.js index 0f15a6906c7..8dd1dc62656 100644 --- a/assets/js/e546fc5a.9541bbcf.js +++ b/assets/js/e546fc5a.f1feafa2.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[25184],{83791:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>c,contentTitle:()=>o,default:()=>p,frontMatter:()=>r,metadata:()=>a,toc:()=>d});var i=s(62540),t=s(43023);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:"Defined in",id:"defined-in",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",strong:"strong",...(0,t.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.header,{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:"defined-in",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L877",children:"packages/extension-api/src/extension-api.d.ts:877"})})]})}function p(e={}){const{wrapper:n}={...(0,t.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},43023:(e,n,s)=>{s.d(n,{R:()=>o,x:()=>a});var i=s(63696);const t={},r=i.createContext(t);function o(e){const n=i.useContext(r);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function a(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:o(e.components),i.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[25184],{83791:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>c,contentTitle:()=>o,default:()=>p,frontMatter:()=>r,metadata:()=>a,toc:()=>d});var i=s(62540),t=s(43023);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:"Defined in",id:"defined-in",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",strong:"strong",...(0,t.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.header,{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:"defined-in",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L877",children:"packages/extension-api/src/extension-api.d.ts:877"})})]})}function p(e={}){const{wrapper:n}={...(0,t.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},43023:(e,n,s)=>{s.d(n,{R:()=>o,x:()=>a});var i=s(63696);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.4b5f561a.js b/assets/js/e6163b65.142b0a70.js similarity index 96% rename from assets/js/e6163b65.4b5f561a.js rename to assets/js/e6163b65.142b0a70.js index 2cbfc411f6c..7127ba1caa2 100644 --- a/assets/js/e6163b65.4b5f561a.js +++ b/assets/js/e6163b65.142b0a70.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[47479],{25068:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>o,contentTitle:()=>r,default:()=>h,frontMatter:()=>a,metadata:()=>c,toc:()=>d});var i=s(62540),t=s(43023);const a={},r="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:"fs",permalink:"/api/namespaces/fs/"}},o={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Defined in",id:"defined-in",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",strong:"strong",...(0,t.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.header,{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.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:"defined-in",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/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.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},43023:(e,n,s)=>{s.d(n,{R:()=>r,x:()=>c});var i=s(63696);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([[47479],{25068:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>o,contentTitle:()=>r,default:()=>h,frontMatter:()=>a,metadata:()=>c,toc:()=>d});var i=s(62540),t=s(43023);const a={},r="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:"fs",permalink:"/api/namespaces/fs/"}},o={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Defined in",id:"defined-in",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",strong:"strong",...(0,t.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.header,{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.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:"defined-in",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/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.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},43023:(e,n,s)=>{s.d(n,{R:()=>r,x:()=>c});var i=s(63696);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/e6412603.c2cf776d.js b/assets/js/e6412603.7e4063e7.js similarity index 96% rename from assets/js/e6412603.c2cf776d.js rename to assets/js/e6412603.7e4063e7.js index d1eb3d42cf4..27b50849c6d 100644 --- a/assets/js/e6412603.c2cf776d.js +++ b/assets/js/e6412603.7e4063e7.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[80348],{51579:(e,s,n)=>{n.r(s),n.d(s,{assets:()=>d,contentTitle:()=>a,default:()=>p,frontMatter:()=>r,metadata:()=>c,toc:()=>o});var i=n(62540),t=n(43023);const r={},a="Function: onDidUpdateRegistry()",c={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"}},d={},o=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Defined in",id:"defined-in",level:2}];function l(e){const s={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",strong:"strong",...(0,t.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(s.header,{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:"defined-in",children:"Defined in"}),"\n",(0,i.jsx)(s.p,{children:(0,i.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L932",children:"packages/extension-api/src/extension-api.d.ts:932"})})]})}function p(e={}){const{wrapper:s}={...(0,t.R)(),...e.components};return s?(0,i.jsx)(s,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},43023:(e,s,n)=>{n.d(s,{R:()=>a,x:()=>c});var i=n(63696);const t={},r=i.createContext(t);function a(e){const s=i.useContext(r);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(t):e.components||t:a(e.components),i.createElement(r.Provider,{value:s},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[80348],{51579:(e,s,n)=>{n.r(s),n.d(s,{assets:()=>d,contentTitle:()=>a,default:()=>p,frontMatter:()=>r,metadata:()=>c,toc:()=>o});var i=n(62540),t=n(43023);const r={},a="Function: onDidUpdateRegistry()",c={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"}},d={},o=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Defined in",id:"defined-in",level:2}];function l(e){const s={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",strong:"strong",...(0,t.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(s.header,{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:"defined-in",children:"Defined in"}),"\n",(0,i.jsx)(s.p,{children:(0,i.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L932",children:"packages/extension-api/src/extension-api.d.ts:932"})})]})}function p(e={}){const{wrapper:s}={...(0,t.R)(),...e.components};return s?(0,i.jsx)(s,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},43023:(e,s,n)=>{n.d(s,{R:()=>a,x:()=>c});var i=n(63696);const t={},r=i.createContext(t);function a(e){const s=i.useContext(r);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(t):e.components||t:a(e.components),i.createElement(r.Provider,{value:s},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/e69dadab.b68f4102.js b/assets/js/e69dadab.6cdcb78f.js similarity index 89% rename from assets/js/e69dadab.b68f4102.js rename to assets/js/e69dadab.6cdcb78f.js index d16bb651d85..0c10a49dcbf 100644 --- a/assets/js/e69dadab.b68f4102.js +++ b/assets/js/e69dadab.6cdcb78f.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[41067],{39183:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>r,contentTitle:()=>o,default:()=>h,frontMatter:()=>t,metadata:()=>a,toc:()=>c});var s=i(62540),d=i(43023);const t={},o="Interface: PodmanContainerCreateOptions",a={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"}},r={},c=[{value:"Properties",id:"properties",level:2},{value:"command?",id:"command",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"entrypoint?",id:"entrypoint",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"env?",id:"env",level:3},{value:"Index Signature",id:"index-signature",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"hostname?",id:"hostname",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"image?",id:"image",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"mounts?",id:"mounts",level:3},{value:"Defined in",id:"defined-in-5",level:4},{value:"name?",id:"name",level:3},{value:"Defined in",id:"defined-in-6",level:4},{value:"pod?",id:"pod",level:3},{value:"Defined in",id:"defined-in-7",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",p:"p",strong:"strong",...(0,d.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.header,{children:(0,s.jsx)(n.h1,{id:"interface-podmancontainercreateoptions",children:"Interface: PodmanContainerCreateOptions"})}),"\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.code,{children:"optional"})," ",(0,s.jsx)(n.strong,{children:"command"}),": ",(0,s.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2840",children:"packages/extension-api/src/extension-api.d.ts:2840"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"entrypoint",children:"entrypoint?"}),"\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:"entrypoint"}),": ",(0,s.jsx)(n.code,{children:"string"})," | ",(0,s.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2841",children:"packages/extension-api/src/extension-api.d.ts:2841"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"env",children:"env?"}),"\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:"env"}),": ",(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:"defined-in-2",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2842",children:"packages/extension-api/src/extension-api.d.ts:2842"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"hostname",children:"hostname?"}),"\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:"hostname"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-3",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2844",children:"packages/extension-api/src/extension-api.d.ts:2844"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"image",children:"image?"}),"\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:"image"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-4",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2845",children:"packages/extension-api/src/extension-api.d.ts:2845"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"mounts",children:"mounts?"}),"\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:"mounts"}),": ",(0,s.jsx)(n.code,{children:"object"}),"[]"]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-5",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2847",children:"packages/extension-api/src/extension-api.d.ts:2847"})}),"\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.code,{children:"optional"})," ",(0,s.jsx)(n.strong,{children:"name"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-6",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2846",children:"packages/extension-api/src/extension-api.d.ts:2846"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"pod",children:"pod?"}),"\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:"pod"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-7",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2843",children:"packages/extension-api/src/extension-api.d.ts:2843"})})]})}function h(e={}){const{wrapper:n}={...(0,d.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},43023:(e,n,i)=>{i.d(n,{R:()=>o,x:()=>a});var s=i(63696);const d={},t=s.createContext(d);function o(e){const n=s.useContext(t);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(d):e.components||d:o(e.components),s.createElement(t.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[41067],{39183:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>r,contentTitle:()=>o,default:()=>h,frontMatter:()=>t,metadata:()=>a,toc:()=>c});var s=i(62540),d=i(43023);const t={},o="Interface: PodmanContainerCreateOptions",a={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"}},r={},c=[{value:"Properties",id:"properties",level:2},{value:"command?",id:"command",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"entrypoint?",id:"entrypoint",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"env?",id:"env",level:3},{value:"Index Signature",id:"index-signature",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"hostname?",id:"hostname",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"image?",id:"image",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"mounts?",id:"mounts",level:3},{value:"Defined in",id:"defined-in-5",level:4},{value:"name?",id:"name",level:3},{value:"Defined in",id:"defined-in-6",level:4},{value:"pod?",id:"pod",level:3},{value:"Defined in",id:"defined-in-7",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",p:"p",strong:"strong",...(0,d.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.header,{children:(0,s.jsx)(n.h1,{id:"interface-podmancontainercreateoptions",children:"Interface: PodmanContainerCreateOptions"})}),"\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.code,{children:"optional"})," ",(0,s.jsx)(n.strong,{children:"command"}),": ",(0,s.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2840",children:"packages/extension-api/src/extension-api.d.ts:2840"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"entrypoint",children:"entrypoint?"}),"\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:"entrypoint"}),": ",(0,s.jsx)(n.code,{children:"string"})," | ",(0,s.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2841",children:"packages/extension-api/src/extension-api.d.ts:2841"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"env",children:"env?"}),"\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:"env"}),": ",(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:"defined-in-2",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2842",children:"packages/extension-api/src/extension-api.d.ts:2842"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"hostname",children:"hostname?"}),"\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:"hostname"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-3",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2844",children:"packages/extension-api/src/extension-api.d.ts:2844"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"image",children:"image?"}),"\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:"image"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-4",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2845",children:"packages/extension-api/src/extension-api.d.ts:2845"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"mounts",children:"mounts?"}),"\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:"mounts"}),": ",(0,s.jsx)(n.code,{children:"object"}),"[]"]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-5",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2847",children:"packages/extension-api/src/extension-api.d.ts:2847"})}),"\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.code,{children:"optional"})," ",(0,s.jsx)(n.strong,{children:"name"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-6",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2846",children:"packages/extension-api/src/extension-api.d.ts:2846"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"pod",children:"pod?"}),"\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:"pod"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-7",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2843",children:"packages/extension-api/src/extension-api.d.ts:2843"})})]})}function h(e={}){const{wrapper:n}={...(0,d.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},43023:(e,n,i)=>{i.d(n,{R:()=>o,x:()=>a});var s=i(63696);const d={},t=s.createContext(d);function o(e){const n=s.useContext(t);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(d):e.components||d:o(e.components),s.createElement(t.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/e6c31e60.943e3f46.js b/assets/js/e6c31e60.1c23a339.js similarity index 93% rename from assets/js/e6c31e60.943e3f46.js rename to assets/js/e6c31e60.1c23a339.js index 5ad0f943880..d67c117749d 100644 --- a/assets/js/e6c31e60.943e3f46.js +++ b/assets/js/e6c31e60.1c23a339.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[11084],{42773:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>a,contentTitle:()=>d,default:()=>h,frontMatter:()=>t,metadata:()=>c,toc:()=>o});var r=i(62540),s=i(43023);const t={},d="Interface: ProviderUpdate",c={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"}},a={},o=[{value:"Properties",id:"properties",level:2},{value:"version",id:"version",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"Methods",id:"methods",level:2},{value:"preflightChecks()?",id:"preflightchecks",level:3},{value:"Returns",id:"returns",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"update()",id:"update",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Defined in",id:"defined-in-2",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",p:"p",strong:"strong",...(0,s.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.header,{children:(0,r.jsx)(n.h1,{id:"interface-providerupdate",children:"Interface: ProviderUpdate"})}),"\n",(0,r.jsx)(n.h2,{id:"properties",children:"Properties"}),"\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.strong,{children:"version"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L565",children:"packages/extension-api/src/extension-api.d.ts:565"})}),"\n",(0,r.jsx)(n.h2,{id:"methods",children:"Methods"}),"\n",(0,r.jsx)(n.h3,{id:"preflightchecks",children:"preflightChecks()?"}),"\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:"preflightChecks"}),"(): ",(0,r.jsx)(n.a,{href:"/api/interfaces/InstallCheck",children:(0,r.jsx)(n.code,{children:"InstallCheck"})}),"[]"]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"returns",children:"Returns"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.a,{href:"/api/interfaces/InstallCheck",children:(0,r.jsx)(n.code,{children:"InstallCheck"})}),"[]"]}),"\n",(0,r.jsx)(n.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/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:"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:"logger"}),"): ",(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:"logger"}),": ",(0,r.jsx)(n.a,{href:"/api/interfaces/Logger",children:(0,r.jsx)(n.code,{children:"Logger"})})]}),"\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:"defined-in-2",children:"Defined in"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L567",children:"packages/extension-api/src/extension-api.d.ts:567"})})]})}function h(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(l,{...e})}):l(e)}},43023:(e,n,i)=>{i.d(n,{R:()=>d,x:()=>c});var r=i(63696);const s={},t=r.createContext(s);function d(e){const n=r.useContext(t);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:d(e.components),r.createElement(t.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[11084],{42773:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>a,contentTitle:()=>d,default:()=>h,frontMatter:()=>t,metadata:()=>c,toc:()=>o});var r=i(62540),s=i(43023);const t={},d="Interface: ProviderUpdate",c={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"}},a={},o=[{value:"Properties",id:"properties",level:2},{value:"version",id:"version",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"Methods",id:"methods",level:2},{value:"preflightChecks()?",id:"preflightchecks",level:3},{value:"Returns",id:"returns",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"update()",id:"update",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Defined in",id:"defined-in-2",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",p:"p",strong:"strong",...(0,s.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.header,{children:(0,r.jsx)(n.h1,{id:"interface-providerupdate",children:"Interface: ProviderUpdate"})}),"\n",(0,r.jsx)(n.h2,{id:"properties",children:"Properties"}),"\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.strong,{children:"version"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L565",children:"packages/extension-api/src/extension-api.d.ts:565"})}),"\n",(0,r.jsx)(n.h2,{id:"methods",children:"Methods"}),"\n",(0,r.jsx)(n.h3,{id:"preflightchecks",children:"preflightChecks()?"}),"\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:"preflightChecks"}),"(): ",(0,r.jsx)(n.a,{href:"/api/interfaces/InstallCheck",children:(0,r.jsx)(n.code,{children:"InstallCheck"})}),"[]"]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"returns",children:"Returns"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.a,{href:"/api/interfaces/InstallCheck",children:(0,r.jsx)(n.code,{children:"InstallCheck"})}),"[]"]}),"\n",(0,r.jsx)(n.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/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:"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:"logger"}),"): ",(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:"logger"}),": ",(0,r.jsx)(n.a,{href:"/api/interfaces/Logger",children:(0,r.jsx)(n.code,{children:"Logger"})})]}),"\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:"defined-in-2",children:"Defined in"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L567",children:"packages/extension-api/src/extension-api.d.ts:567"})})]})}function h(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(l,{...e})}):l(e)}},43023:(e,n,i)=>{i.d(n,{R:()=>d,x:()=>c});var r=i(63696);const s={},t=r.createContext(s);function d(e){const n=r.useContext(t);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:d(e.components),r.createElement(t.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/e7477a94.4cef4da0.js b/assets/js/e7477a94.8015f73e.js similarity index 84% rename from assets/js/e7477a94.4cef4da0.js rename to assets/js/e7477a94.8015f73e.js index 5087bbb08e5..d74a2591d99 100644 --- a/assets/js/e7477a94.4cef4da0.js +++ b/assets/js/e7477a94.8015f73e.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[55543],{18024:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>l,contentTitle:()=>c,default:()=>h,frontMatter:()=>r,metadata:()=>d,toc:()=>a});var t=i(62540),s=i(43023);const r={},c="Interface: InstallCheck",d={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:"Defined in",id:"defined-in",level:4},{value:"Methods",id:"methods",level:2},{value:"execute()",id:"execute",level:3},{value:"Returns",id:"returns",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"init()?",id:"init",level:3},{value:"Returns",id:"returns-1",level:4},{value:"Defined in",id:"defined-in-2",level:4}];function o(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",p:"p",strong:"strong",...(0,s.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.header,{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:"defined-in",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L553",children:"packages/extension-api/src/extension-api.d.ts:553"})}),"\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:"defined-in-1",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L554",children:"packages/extension-api/src/extension-api.d.ts:554"})}),"\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:"defined-in-2",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L555",children:"packages/extension-api/src/extension-api.d.ts:555"})})]})}function h(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(o,{...e})}):o(e)}},43023:(e,n,i)=>{i.d(n,{R:()=>c,x:()=>d});var t=i(63696);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 d(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([[55543],{18024:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>l,contentTitle:()=>r,default:()=>h,frontMatter:()=>c,metadata:()=>d,toc:()=>a});var t=i(62540),s=i(43023);const c={},r="Interface: InstallCheck",d={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:"Defined in",id:"defined-in",level:4},{value:"Methods",id:"methods",level:2},{value:"execute()",id:"execute",level:3},{value:"Returns",id:"returns",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"init()?",id:"init",level:3},{value:"Returns",id:"returns-1",level:4},{value:"Defined in",id:"defined-in-2",level:4}];function o(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",p:"p",strong:"strong",...(0,s.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.header,{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:"defined-in",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L553",children:"packages/extension-api/src/extension-api.d.ts:553"})}),"\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:"defined-in-1",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L554",children:"packages/extension-api/src/extension-api.d.ts:554"})}),"\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:"defined-in-2",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L555",children:"packages/extension-api/src/extension-api.d.ts:555"})})]})}function h(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(o,{...e})}):o(e)}},43023:(e,n,i)=>{i.d(n,{R:()=>r,x:()=>d});var t=i(63696);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 d(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 diff --git a/assets/js/e7923b27.afe0ba9f.js b/assets/js/e7923b27.d57db834.js similarity index 96% rename from assets/js/e7923b27.afe0ba9f.js rename to assets/js/e7923b27.d57db834.js index 731232ae69d..7d1b39d0110 100644 --- a/assets/js/e7923b27.afe0ba9f.js +++ b/assets/js/e7923b27.d57db834.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[37012],{87561:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>l,contentTitle:()=>c,default:()=>h,frontMatter:()=>r,metadata:()=>a,toc:()=>d});var t=s(62540),i=s(43023);const r={},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={},d=[{value:"Type Parameters",id:"type-parameters",level:2},{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Defined in",id:"defined-in",level:2}];function o(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",strong:"strong",...(0,i.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.header,{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.p,{children:"Event to subscribe"}),"\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:"defined-in",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/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,i.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(o,{...e})}):o(e)}},43023:(e,n,s)=>{s.d(n,{R:()=>c,x:()=>a});var t=s(63696);const i={},r=t.createContext(i);function c(e){const n=t.useContext(r);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function a(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:c(e.components),t.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[37012],{87561:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>l,contentTitle:()=>c,default:()=>h,frontMatter:()=>r,metadata:()=>a,toc:()=>d});var t=s(62540),i=s(43023);const r={},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={},d=[{value:"Type Parameters",id:"type-parameters",level:2},{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Defined in",id:"defined-in",level:2}];function o(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",strong:"strong",...(0,i.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.header,{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.p,{children:"Event to subscribe"}),"\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:"defined-in",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/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,i.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(o,{...e})}):o(e)}},43023:(e,n,s)=>{s.d(n,{R:()=>c,x:()=>a});var t=s(63696);const i={},r=t.createContext(i);function c(e){const n=t.useContext(r);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function a(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:c(e.components),t.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/e84cabb0.29116f1d.js b/assets/js/e84cabb0.2fb51f15.js similarity index 97% rename from assets/js/e84cabb0.29116f1d.js rename to assets/js/e84cabb0.2fb51f15.js index 1e13671f431..c4bee0113d4 100644 --- a/assets/js/e84cabb0.29116f1d.js +++ b/assets/js/e84cabb0.2fb51f15.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[53064],{45258:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>a,contentTitle:()=>i,default:()=>x,frontMatter:()=>o,metadata:()=>c,toc:()=>d});var t=s(62540),r=s(43023);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:"registry",permalink:"/api/namespaces/registry/"}},a={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Defined in",id:"defined-in",level:2}];function p(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",strong:"strong",...(0,r.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.header,{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:"defined-in",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L875",children:"packages/extension-api/src/extension-api.d.ts:875"})})]})}function x(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(p,{...e})}):p(e)}},43023:(e,n,s)=>{s.d(n,{R:()=>i,x:()=>c});var t=s(63696);const r={},o=t.createContext(r);function i(e){const n=t.useContext(o);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:i(e.components),t.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[53064],{45258:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>a,contentTitle:()=>i,default:()=>x,frontMatter:()=>o,metadata:()=>c,toc:()=>d});var t=s(62540),r=s(43023);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:"registry",permalink:"/api/namespaces/registry/"}},a={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Defined in",id:"defined-in",level:2}];function p(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",strong:"strong",...(0,r.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.header,{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:"defined-in",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L875",children:"packages/extension-api/src/extension-api.d.ts:875"})})]})}function x(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(p,{...e})}):p(e)}},43023:(e,n,s)=>{s.d(n,{R:()=>i,x:()=>c});var t=s(63696);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.0921fe3c.js b/assets/js/e88443f3.eb7e3acb.js similarity index 95% rename from assets/js/e88443f3.0921fe3c.js rename to assets/js/e88443f3.eb7e3acb.js index 65300ebdd7f..48dc14b352b 100644 --- a/assets/js/e88443f3.0921fe3c.js +++ b/assets/js/e88443f3.eb7e3acb.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[68598],{29262:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>d,contentTitle:()=>r,default:()=>l,frontMatter:()=>i,metadata:()=>c,toc:()=>a});var t=s(62540),o=s(43023);const i={},r="Function: stopPod()",c={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:"Defined in",id:"defined-in",level:2}];function p(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",strong:"strong",...(0,o.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.header,{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:"defined-in",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L3688",children:"packages/extension-api/src/extension-api.d.ts:3688"})})]})}function l(e={}){const{wrapper:n}={...(0,o.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(p,{...e})}):p(e)}},43023:(e,n,s)=>{s.d(n,{R:()=>r,x:()=>c});var t=s(63696);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([[68598],{29262:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>d,contentTitle:()=>r,default:()=>l,frontMatter:()=>i,metadata:()=>c,toc:()=>a});var t=s(62540),o=s(43023);const i={},r="Function: stopPod()",c={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:"Defined in",id:"defined-in",level:2}];function p(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",strong:"strong",...(0,o.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.header,{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:"defined-in",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L3688",children:"packages/extension-api/src/extension-api.d.ts:3688"})})]})}function l(e={}){const{wrapper:n}={...(0,o.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(p,{...e})}):p(e)}},43023:(e,n,s)=>{s.d(n,{R:()=>r,x:()=>c});var t=s(63696);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/e983a6d7.fe23cc41.js b/assets/js/e983a6d7.571e86ea.js similarity index 94% rename from assets/js/e983a6d7.fe23cc41.js rename to assets/js/e983a6d7.571e86ea.js index 1238aed40d3..e7267ec7fa5 100644 --- a/assets/js/e983a6d7.fe23cc41.js +++ b/assets/js/e983a6d7.571e86ea.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[26168],{66728:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>o,contentTitle:()=>c,default:()=>p,frontMatter:()=>t,metadata:()=>r,toc:()=>l});var a=s(62540),i=s(43023);const t={},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:"Defined in",id:"defined-in",level:2}];function d(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",strong:"strong",...(0,i.R)(),...e.components};return(0,a.jsxs)(a.Fragment,{children:[(0,a.jsx)(n.header,{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:"defined-in",children:"Defined in"}),"\n",(0,a.jsx)(n.p,{children:(0,a.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L3976",children:"packages/extension-api/src/extension-api.d.ts:3976"})})]})}function p(e={}){const{wrapper:n}={...(0,i.R)(),...e.components};return n?(0,a.jsx)(n,{...e,children:(0,a.jsx)(d,{...e})}):d(e)}},43023:(e,n,s)=>{s.d(n,{R:()=>c,x:()=>r});var a=s(63696);const i={},t=a.createContext(i);function c(e){const n=a.useContext(t);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(i):e.components||i:c(e.components),a.createElement(t.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[26168],{66728:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>o,contentTitle:()=>c,default:()=>p,frontMatter:()=>t,metadata:()=>r,toc:()=>l});var a=s(62540),i=s(43023);const t={},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:"Defined in",id:"defined-in",level:2}];function d(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",strong:"strong",...(0,i.R)(),...e.components};return(0,a.jsxs)(a.Fragment,{children:[(0,a.jsx)(n.header,{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:"defined-in",children:"Defined in"}),"\n",(0,a.jsx)(n.p,{children:(0,a.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L3976",children:"packages/extension-api/src/extension-api.d.ts:3976"})})]})}function p(e={}){const{wrapper:n}={...(0,i.R)(),...e.components};return n?(0,a.jsx)(n,{...e,children:(0,a.jsx)(d,{...e})}):d(e)}},43023:(e,n,s)=>{s.d(n,{R:()=>c,x:()=>r});var a=s(63696);const i={},t=a.createContext(i);function c(e){const n=a.useContext(t);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(i):e.components||i:c(e.components),a.createElement(t.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/ea3ffc82.bd0b27a7.js b/assets/js/ea3ffc82.fad7d657.js similarity index 88% rename from assets/js/ea3ffc82.bd0b27a7.js rename to assets/js/ea3ffc82.fad7d657.js index 92c13aa784f..716a98d04f0 100644 --- a/assets/js/ea3ffc82.bd0b27a7.js +++ b/assets/js/ea3ffc82.fad7d657.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[28917],{86477:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>d,contentTitle:()=>o,default:()=>h,frontMatter:()=>r,metadata:()=>c,toc:()=>a});var s=i(62540),t=i(43023);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"}},d={},a=[{value:"Properties",id:"properties",level:2},{value:"extensionUri",id:"extensionuri",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"secrets",id:"secrets",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"storagePath",id:"storagepath",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"subscriptions",id:"subscriptions",level:3},{value:"Defined in",id:"defined-in-3",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",p:"p",strong:"strong",...(0,t.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.header,{children:(0,s.jsx)(n.h1,{id:"interface-extensioncontext",children:"Interface: ExtensionContext"})}),"\n",(0,s.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,s.jsx)(n.h3,{id:"extensionuri",children:"extensionUri"}),"\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:"extensionUri"}),": ",(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 uri of the directory containing the extension."}),"\n",(0,s.jsx)(n.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L165",children:"packages/extension-api/src/extension-api.d.ts:165"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"secrets",children:"secrets"}),"\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:"secrets"}),": ",(0,s.jsx)(n.a,{href:"/api/interfaces/SecretStorage",children:(0,s.jsx)(n.code,{children:"SecretStorage"})})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"A storage utility for secrets. Secrets are persisted across reloads."}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L170",children:"packages/extension-api/src/extension-api.d.ts:170"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"storagepath",children:"storagePath"}),"\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:"storagePath"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.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,s.jsx)(n.h4,{id:"defined-in-2",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L160",children:"packages/extension-api/src/extension-api.d.ts:160"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"subscriptions",children:"subscriptions"}),"\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:"subscriptions"}),": ",(0,s.jsx)(n.code,{children:"object"}),"[]"]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-3",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/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,t.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},43023:(e,n,i)=>{i.d(n,{R:()=>o,x:()=>c});var s=i(63696);const t={},r=s.createContext(t);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(t):e.components||t:o(e.components),s.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[28917],{86477:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>a,contentTitle:()=>o,default:()=>h,frontMatter:()=>r,metadata:()=>c,toc:()=>d});var s=i(62540),t=i(43023);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:"Defined in",id:"defined-in",level:4},{value:"secrets",id:"secrets",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"storagePath",id:"storagepath",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"subscriptions",id:"subscriptions",level:3},{value:"Defined in",id:"defined-in-3",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",p:"p",strong:"strong",...(0,t.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.header,{children:(0,s.jsx)(n.h1,{id:"interface-extensioncontext",children:"Interface: ExtensionContext"})}),"\n",(0,s.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,s.jsx)(n.h3,{id:"extensionuri",children:"extensionUri"}),"\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:"extensionUri"}),": ",(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 uri of the directory containing the extension."}),"\n",(0,s.jsx)(n.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L165",children:"packages/extension-api/src/extension-api.d.ts:165"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"secrets",children:"secrets"}),"\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:"secrets"}),": ",(0,s.jsx)(n.a,{href:"/api/interfaces/SecretStorage",children:(0,s.jsx)(n.code,{children:"SecretStorage"})})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"A storage utility for secrets. Secrets are persisted across reloads."}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L170",children:"packages/extension-api/src/extension-api.d.ts:170"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"storagepath",children:"storagePath"}),"\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:"storagePath"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.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,s.jsx)(n.h4,{id:"defined-in-2",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L160",children:"packages/extension-api/src/extension-api.d.ts:160"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"subscriptions",children:"subscriptions"}),"\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:"subscriptions"}),": ",(0,s.jsx)(n.code,{children:"object"}),"[]"]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-3",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/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,t.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},43023:(e,n,i)=>{i.d(n,{R:()=>o,x:()=>c});var s=i(63696);const t={},r=s.createContext(t);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(t):e.components||t:o(e.components),s.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/ed2a4846.50d87ae3.js b/assets/js/ed2a4846.f97d69e6.js similarity index 94% rename from assets/js/ed2a4846.50d87ae3.js rename to assets/js/ed2a4846.f97d69e6.js index ebf560dfd56..682e7933b2d 100644 --- a/assets/js/ed2a4846.50d87ae3.js +++ b/assets/js/ed2a4846.f97d69e6.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[64605],{61810:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>o,contentTitle:()=>a,default:()=>u,frontMatter:()=>i,metadata:()=>c,toc:()=>l});var r=t(62540),s=t(43023);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:"Defined in",id:"defined-in",level:4}];function d(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",p:"p",strong:"strong",...(0,s.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.header,{children:(0,r.jsx)(n.h1,{id:"interface-generatekuberesult",children:"Interface: GenerateKubeResult"})}),"\n",(0,r.jsx)(n.p,{children:"The result containing a Kubernetes config files"}),"\n",(0,r.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,r.jsx)(n.h3,{id:"yaml",children:"yaml"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"yaml"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2137",children:"packages/extension-api/src/extension-api.d.ts:2137"})})]})}function u(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(d,{...e})}):d(e)}},43023:(e,n,t)=>{t.d(n,{R:()=>a,x:()=>c});var r=t(63696);const s={},i=r.createContext(s);function a(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:a(e.components),r.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[64605],{61810:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>o,contentTitle:()=>a,default:()=>u,frontMatter:()=>i,metadata:()=>c,toc:()=>l});var r=t(62540),s=t(43023);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:"Defined in",id:"defined-in",level:4}];function d(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",p:"p",strong:"strong",...(0,s.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.header,{children:(0,r.jsx)(n.h1,{id:"interface-generatekuberesult",children:"Interface: GenerateKubeResult"})}),"\n",(0,r.jsx)(n.p,{children:"The result containing a Kubernetes config files"}),"\n",(0,r.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,r.jsx)(n.h3,{id:"yaml",children:"yaml"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"yaml"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2137",children:"packages/extension-api/src/extension-api.d.ts:2137"})})]})}function u(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(d,{...e})}):d(e)}},43023:(e,n,t)=>{t.d(n,{R:()=>a,x:()=>c});var r=t(63696);const s={},i=r.createContext(s);function a(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:a(e.components),r.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/ed603d23.fc876545.js b/assets/js/ed603d23.5a161c69.js similarity index 93% rename from assets/js/ed603d23.fc876545.js rename to assets/js/ed603d23.5a161c69.js index c717d44253c..c0f357c0a4a 100644 --- a/assets/js/ed603d23.fc876545.js +++ b/assets/js/ed603d23.5a161c69.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[31502],{81265:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>d,contentTitle:()=>a,default:()=>h,frontMatter:()=>i,metadata:()=>o,toc:()=>c});var t=r(62540),s=r(43023);const i={},a="Interface: KubernetesGeneratorProvider",o={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"}},d={},c=[{value:"Properties",id:"properties",level:2},{value:"name",id:"name",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"types",id:"types",level:3},{value:"Defined in",id:"defined-in-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:"Defined in",id:"defined-in-2",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",p:"p",strong:"strong",...(0,s.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.header,{children:(0,t.jsx)(n.h1,{id:"interface-kubernetesgeneratorprovider",children:"Interface: KubernetesGeneratorProvider"})}),"\n",(0,t.jsx)(n.p,{children:"The KubernetesGeneratorProvider allows an extension to register a custom Kube Generator for a specific\nKubernetesGeneratorType."}),"\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:"defined-in",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2152",children:"packages/extension-api/src/extension-api.d.ts:2152"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"types",children:"types"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"types"}),": ",(0,t.jsx)(n.a,{href:"/api/type-aliases/KubernetesGeneratorSelector",children:(0,t.jsx)(n.code,{children:"KubernetesGeneratorSelector"})})]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2153",children:"packages/extension-api/src/extension-api.d.ts:2153"})}),"\n",(0,t.jsx)(n.h2,{id:"methods",children:"Methods"}),"\n",(0,t.jsx)(n.h3,{id:"generate",children:"generate()"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"generate"}),"(",(0,t.jsx)(n.code,{children:"kubernetesGeneratorArguments"}),"): ",(0,t.jsx)(n.code,{children:"Promise"}),"<",(0,t.jsx)(n.a,{href:"/api/interfaces/GenerateKubeResult",children:(0,t.jsx)(n.code,{children:"GenerateKubeResult"})}),">"]}),"\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:"kubernetesGeneratorArguments"}),": ",(0,t.jsx)(n.a,{href:"/api/type-aliases/KubernetesGeneratorArgument",children:(0,t.jsx)(n.code,{children:"KubernetesGeneratorArgument"})}),"[]"]}),"\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/GenerateKubeResult",children:(0,t.jsx)(n.code,{children:"GenerateKubeResult"})}),">"]}),"\n",(0,t.jsx)(n.h4,{id:"defined-in-2",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2154",children:"packages/extension-api/src/extension-api.d.ts:2154"})})]})}function h(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},43023:(e,n,r)=>{r.d(n,{R:()=>a,x:()=>o});var t=r(63696);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 o(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 +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[31502],{81265:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>d,contentTitle:()=>a,default:()=>h,frontMatter:()=>i,metadata:()=>o,toc:()=>c});var t=r(62540),s=r(43023);const i={},a="Interface: KubernetesGeneratorProvider",o={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"}},d={},c=[{value:"Properties",id:"properties",level:2},{value:"name",id:"name",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"types",id:"types",level:3},{value:"Defined in",id:"defined-in-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:"Defined in",id:"defined-in-2",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",p:"p",strong:"strong",...(0,s.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.header,{children:(0,t.jsx)(n.h1,{id:"interface-kubernetesgeneratorprovider",children:"Interface: KubernetesGeneratorProvider"})}),"\n",(0,t.jsx)(n.p,{children:"The KubernetesGeneratorProvider allows an extension to register a custom Kube Generator for a specific\nKubernetesGeneratorType."}),"\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:"defined-in",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2152",children:"packages/extension-api/src/extension-api.d.ts:2152"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"types",children:"types"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"types"}),": ",(0,t.jsx)(n.a,{href:"/api/type-aliases/KubernetesGeneratorSelector",children:(0,t.jsx)(n.code,{children:"KubernetesGeneratorSelector"})})]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2153",children:"packages/extension-api/src/extension-api.d.ts:2153"})}),"\n",(0,t.jsx)(n.h2,{id:"methods",children:"Methods"}),"\n",(0,t.jsx)(n.h3,{id:"generate",children:"generate()"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"generate"}),"(",(0,t.jsx)(n.code,{children:"kubernetesGeneratorArguments"}),"): ",(0,t.jsx)(n.code,{children:"Promise"}),"<",(0,t.jsx)(n.a,{href:"/api/interfaces/GenerateKubeResult",children:(0,t.jsx)(n.code,{children:"GenerateKubeResult"})}),">"]}),"\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:"kubernetesGeneratorArguments"}),": ",(0,t.jsx)(n.a,{href:"/api/type-aliases/KubernetesGeneratorArgument",children:(0,t.jsx)(n.code,{children:"KubernetesGeneratorArgument"})}),"[]"]}),"\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/GenerateKubeResult",children:(0,t.jsx)(n.code,{children:"GenerateKubeResult"})}),">"]}),"\n",(0,t.jsx)(n.h4,{id:"defined-in-2",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2154",children:"packages/extension-api/src/extension-api.d.ts:2154"})})]})}function h(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},43023:(e,n,r)=>{r.d(n,{R:()=>a,x:()=>o});var t=r(63696);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 o(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/edb40f78.4cfdcd59.js b/assets/js/edb40f78.830b0fed.js similarity index 96% rename from assets/js/edb40f78.4cfdcd59.js rename to assets/js/edb40f78.830b0fed.js index bea13c9964d..4276828708d 100644 --- a/assets/js/edb40f78.4cfdcd59.js +++ b/assets/js/edb40f78.830b0fed.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[19789],{32162:(e,r,n)=>{n.r(r),n.d(r,{assets:()=>d,contentTitle:()=>o,default:()=>p,frontMatter:()=>i,metadata:()=>a,toc:()=>c});var s=n(62540),t=n(43023);const i={},o="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"}},d={},c=[{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:"Defined in",id:"defined-in",level:4}];function l(e){const r={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",p:"p",strong:"strong",...(0,t.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(r.header,{children:(0,s.jsx)(r.h1,{id:"interface-progresst",children:"Interface: Progress"})}),"\n",(0,s.jsx)(r.p,{children:"Defines a generalized way of reporting progress updates."}),"\n",(0,s.jsx)(r.h2,{id:"type-parameters",children:"Type Parameters"}),"\n",(0,s.jsxs)(r.p,{children:["\u2022 ",(0,s.jsx)(r.strong,{children:"T"})]}),"\n",(0,s.jsx)(r.h2,{id:"methods",children:"Methods"}),"\n",(0,s.jsx)(r.h3,{id:"report",children:"report()"}),"\n",(0,s.jsxs)(r.blockquote,{children:["\n",(0,s.jsxs)(r.p,{children:[(0,s.jsx)(r.strong,{children:"report"}),"(",(0,s.jsx)(r.code,{children:"value"}),"): ",(0,s.jsx)(r.code,{children:"void"})]}),"\n"]}),"\n",(0,s.jsx)(r.p,{children:"Report a progress update."}),"\n",(0,s.jsx)(r.h4,{id:"parameters",children:"Parameters"}),"\n",(0,s.jsxs)(r.p,{children:["\u2022 ",(0,s.jsx)(r.strong,{children:"value"}),": ",(0,s.jsx)(r.code,{children:"T"})]}),"\n",(0,s.jsx)(r.p,{children:"A progress item, like a message and/or an\nreport on how much work finished"}),"\n",(0,s.jsx)(r.h4,{id:"returns",children:"Returns"}),"\n",(0,s.jsx)(r.p,{children:(0,s.jsx)(r.code,{children:"void"})}),"\n",(0,s.jsx)(r.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,s.jsx)(r.p,{children:(0,s.jsx)(r.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L1028",children:"packages/extension-api/src/extension-api.d.ts:1028"})})]})}function p(e={}){const{wrapper:r}={...(0,t.R)(),...e.components};return r?(0,s.jsx)(r,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},43023:(e,r,n)=>{n.d(r,{R:()=>o,x:()=>a});var s=n(63696);const t={},i=s.createContext(t);function o(e){const r=s.useContext(i);return s.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:o(e.components),s.createElement(i.Provider,{value:r},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[19789],{32162:(e,r,n)=>{n.r(r),n.d(r,{assets:()=>d,contentTitle:()=>o,default:()=>p,frontMatter:()=>i,metadata:()=>a,toc:()=>c});var s=n(62540),t=n(43023);const i={},o="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"}},d={},c=[{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:"Defined in",id:"defined-in",level:4}];function l(e){const r={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",p:"p",strong:"strong",...(0,t.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(r.header,{children:(0,s.jsx)(r.h1,{id:"interface-progresst",children:"Interface: Progress"})}),"\n",(0,s.jsx)(r.p,{children:"Defines a generalized way of reporting progress updates."}),"\n",(0,s.jsx)(r.h2,{id:"type-parameters",children:"Type Parameters"}),"\n",(0,s.jsxs)(r.p,{children:["\u2022 ",(0,s.jsx)(r.strong,{children:"T"})]}),"\n",(0,s.jsx)(r.h2,{id:"methods",children:"Methods"}),"\n",(0,s.jsx)(r.h3,{id:"report",children:"report()"}),"\n",(0,s.jsxs)(r.blockquote,{children:["\n",(0,s.jsxs)(r.p,{children:[(0,s.jsx)(r.strong,{children:"report"}),"(",(0,s.jsx)(r.code,{children:"value"}),"): ",(0,s.jsx)(r.code,{children:"void"})]}),"\n"]}),"\n",(0,s.jsx)(r.p,{children:"Report a progress update."}),"\n",(0,s.jsx)(r.h4,{id:"parameters",children:"Parameters"}),"\n",(0,s.jsxs)(r.p,{children:["\u2022 ",(0,s.jsx)(r.strong,{children:"value"}),": ",(0,s.jsx)(r.code,{children:"T"})]}),"\n",(0,s.jsx)(r.p,{children:"A progress item, like a message and/or an\nreport on how much work finished"}),"\n",(0,s.jsx)(r.h4,{id:"returns",children:"Returns"}),"\n",(0,s.jsx)(r.p,{children:(0,s.jsx)(r.code,{children:"void"})}),"\n",(0,s.jsx)(r.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,s.jsx)(r.p,{children:(0,s.jsx)(r.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L1028",children:"packages/extension-api/src/extension-api.d.ts:1028"})})]})}function p(e={}){const{wrapper:r}={...(0,t.R)(),...e.components};return r?(0,s.jsx)(r,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},43023:(e,r,n)=>{n.d(r,{R:()=>o,x:()=>a});var s=n(63696);const t={},i=s.createContext(t);function o(e){const r=s.useContext(i);return s.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:o(e.components),s.createElement(i.Provider,{value:r},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/edcfca88.3b3d1fbe.js b/assets/js/edcfca88.371325e7.js similarity index 79% rename from assets/js/edcfca88.3b3d1fbe.js rename to assets/js/edcfca88.371325e7.js index da4035a4199..a6503c7ea2d 100644 --- a/assets/js/edcfca88.3b3d1fbe.js +++ b/assets/js/edcfca88.371325e7.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[75687],{69074:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>c,contentTitle:()=>d,default:()=>p,frontMatter:()=>a,metadata:()=>r,toc:()=>o});var s=i(62540),t=i(43023);const a={},d="Interface: ManifestInspectInfo",r={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:"ManifestPushOptions",permalink:"/api/interfaces/ManifestPushOptions"}},c={},o=[{value:"Properties",id:"properties",level:2},{value:"engineId",id:"engineid",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"engineName",id:"enginename",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"manifests",id:"manifests",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"mediaType",id:"mediatype",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"schemaVersion",id:"schemaversion",level:3},{value:"Defined in",id:"defined-in-4",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",p:"p",strong:"strong",...(0,t.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.header,{children:(0,s.jsx)(n.h1,{id:"interface-manifestinspectinfo",children:"Interface: ManifestInspectInfo"})}),"\n",(0,s.jsx)(n.h2,{id:"properties",children:"Properties"}),"\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.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L462",children:"packages/extension-api/src/extension-api.d.ts:462"})}),"\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.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L463",children:"packages/extension-api/src/extension-api.d.ts:463"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"manifests",children:"manifests"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"manifests"}),": ",(0,s.jsx)(n.code,{children:"object"}),"[]"]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-2",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/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:"mediatype",children:"mediaType"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"mediaType"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-3",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L476",children:"packages/extension-api/src/extension-api.d.ts:476"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"schemaversion",children:"schemaVersion"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"schemaVersion"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-4",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L477",children:"packages/extension-api/src/extension-api.d.ts:477"})})]})}function p(e={}){const{wrapper:n}={...(0,t.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},43023:(e,n,i)=>{i.d(n,{R:()=>d,x:()=>r});var s=i(63696);const t={},a=s.createContext(t);function d(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:d(e.components),s.createElement(a.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[75687],{69074:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>r,contentTitle:()=>d,default:()=>p,frontMatter:()=>a,metadata:()=>c,toc:()=>o});var s=i(62540),t=i(43023);const a={},d="Interface: ManifestInspectInfo",c={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:"ManifestPushOptions",permalink:"/api/interfaces/ManifestPushOptions"}},r={},o=[{value:"Properties",id:"properties",level:2},{value:"engineId",id:"engineid",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"engineName",id:"enginename",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"manifests",id:"manifests",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"mediaType",id:"mediatype",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"schemaVersion",id:"schemaversion",level:3},{value:"Defined in",id:"defined-in-4",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",p:"p",strong:"strong",...(0,t.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.header,{children:(0,s.jsx)(n.h1,{id:"interface-manifestinspectinfo",children:"Interface: ManifestInspectInfo"})}),"\n",(0,s.jsx)(n.h2,{id:"properties",children:"Properties"}),"\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.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L462",children:"packages/extension-api/src/extension-api.d.ts:462"})}),"\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.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L463",children:"packages/extension-api/src/extension-api.d.ts:463"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"manifests",children:"manifests"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"manifests"}),": ",(0,s.jsx)(n.code,{children:"object"}),"[]"]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-2",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/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:"mediatype",children:"mediaType"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"mediaType"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-3",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L476",children:"packages/extension-api/src/extension-api.d.ts:476"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"schemaversion",children:"schemaVersion"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"schemaVersion"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-4",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L477",children:"packages/extension-api/src/extension-api.d.ts:477"})})]})}function p(e={}){const{wrapper:n}={...(0,t.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},43023:(e,n,i)=>{i.d(n,{R:()=>d,x:()=>c});var s=i(63696);const t={},a=s.createContext(t);function d(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:d(e.components),s.createElement(a.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/ef2e2003.64131ebf.js b/assets/js/ef2e2003.5578ce12.js similarity index 97% rename from assets/js/ef2e2003.64131ebf.js rename to assets/js/ef2e2003.5578ce12.js index 9ea731731e4..f494879019b 100644 --- a/assets/js/ef2e2003.64131ebf.js +++ b/assets/js/ef2e2003.5578ce12.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[59660],{53089:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>d,contentTitle:()=>s,default:()=>p,frontMatter:()=>i,metadata:()=>o,toc:()=>c});var r=n(62540),a=n(43023);const i={},s="Interface: ImageFilesProviderMetadata",o={id:"interfaces/ImageFilesProviderMetadata",title:"Interface: ImageFilesProviderMetadata",description:"Properties",source:"@site/api/interfaces/ImageFilesProviderMetadata.md",sourceDirName:"interfaces",slug:"/interfaces/ImageFilesProviderMetadata",permalink:"/api/interfaces/ImageFilesProviderMetadata",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"ImageFilesProvider",permalink:"/api/interfaces/ImageFilesProvider"},next:{title:"ImageFilesystemLayer",permalink:"/api/interfaces/ImageFilesystemLayer"}},d={},c=[{value:"Properties",id:"properties",level:2},{value:"label",id:"label",level:3},{value:"Defined in",id:"defined-in",level:4}];function l(e){const t={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",p:"p",strong:"strong",...(0,a.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(t.header,{children:(0,r.jsx)(t.h1,{id:"interface-imagefilesprovidermetadata",children:"Interface: ImageFilesProviderMetadata"})}),"\n",(0,r.jsx)(t.h2,{id:"properties",children:"Properties"}),"\n",(0,r.jsx)(t.h3,{id:"label",children:"label"}),"\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:"label"}),": ",(0,r.jsx)(t.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(t.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,r.jsx)(t.p,{children:(0,r.jsx)(t.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L827",children:"packages/extension-api/src/extension-api.d.ts:827"})})]})}function p(e={}){const{wrapper:t}={...(0,a.R)(),...e.components};return t?(0,r.jsx)(t,{...e,children:(0,r.jsx)(l,{...e})}):l(e)}},43023:(e,t,n)=>{n.d(t,{R:()=>s,x:()=>o});var r=n(63696);const a={},i=r.createContext(a);function s(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(a):e.components||a:s(e.components),r.createElement(i.Provider,{value:t},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[59660],{53089:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>d,contentTitle:()=>s,default:()=>p,frontMatter:()=>i,metadata:()=>o,toc:()=>c});var r=n(62540),a=n(43023);const i={},s="Interface: ImageFilesProviderMetadata",o={id:"interfaces/ImageFilesProviderMetadata",title:"Interface: ImageFilesProviderMetadata",description:"Properties",source:"@site/api/interfaces/ImageFilesProviderMetadata.md",sourceDirName:"interfaces",slug:"/interfaces/ImageFilesProviderMetadata",permalink:"/api/interfaces/ImageFilesProviderMetadata",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"ImageFilesProvider",permalink:"/api/interfaces/ImageFilesProvider"},next:{title:"ImageFilesystemLayer",permalink:"/api/interfaces/ImageFilesystemLayer"}},d={},c=[{value:"Properties",id:"properties",level:2},{value:"label",id:"label",level:3},{value:"Defined in",id:"defined-in",level:4}];function l(e){const t={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",p:"p",strong:"strong",...(0,a.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(t.header,{children:(0,r.jsx)(t.h1,{id:"interface-imagefilesprovidermetadata",children:"Interface: ImageFilesProviderMetadata"})}),"\n",(0,r.jsx)(t.h2,{id:"properties",children:"Properties"}),"\n",(0,r.jsx)(t.h3,{id:"label",children:"label"}),"\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:"label"}),": ",(0,r.jsx)(t.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(t.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,r.jsx)(t.p,{children:(0,r.jsx)(t.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L827",children:"packages/extension-api/src/extension-api.d.ts:827"})})]})}function p(e={}){const{wrapper:t}={...(0,a.R)(),...e.components};return t?(0,r.jsx)(t,{...e,children:(0,r.jsx)(l,{...e})}):l(e)}},43023:(e,t,n)=>{n.d(t,{R:()=>s,x:()=>o});var r=n(63696);const a={},i=r.createContext(a);function s(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(a):e.components||a:s(e.components),r.createElement(i.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/ef5945f7.1857533e.js b/assets/js/ef5945f7.93a780bf.js similarity index 85% rename from assets/js/ef5945f7.1857533e.js rename to assets/js/ef5945f7.93a780bf.js index 27ddf5c146e..ec2e3472d96 100644 --- a/assets/js/ef5945f7.1857533e.js +++ b/assets/js/ef5945f7.93a780bf.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[70540],{78064:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>a,contentTitle:()=>d,default:()=>l,frontMatter:()=>r,metadata:()=>o,toc:()=>c});var s=i(62540),t=i(43023);const r={},d="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={},c=[{value:"Type Parameters",id:"type-parameters",level:2},{value:"Properties",id:"properties",level:2},{value:"exports",id:"exports",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"extensionPath",id:"extensionpath",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"extensionUri",id:"extensionuri",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"id",id:"id",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"packageJSON",id:"packagejson",level:3},{value:"Defined in",id:"defined-in-4",level:4}];function h(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",p:"p",strong:"strong",...(0,t.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.header,{children:(0,s.jsx)(n.h1,{id:"interface-extensiont",children:"Interface: Extension"})}),"\n",(0,s.jsx)(n.p,{children:"Represents an extension."}),"\n",(0,s.jsxs)(n.p,{children:["To get an instance of an ",(0,s.jsx)(n.code,{children:"Extension"})," use ",(0,s.jsx)(n.a,{href:"/api/namespaces/extensions/functions/getExtension",children:"getExtension"}),"."]}),"\n",(0,s.jsx)(n.h2,{id:"type-parameters",children:"Type Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"T"})]}),"\n",(0,s.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,s.jsx)(n.h3,{id:"exports",children:"exports"}),"\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:"exports"}),": ",(0,s.jsx)(n.code,{children:"T"})]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:["The public API exported by this extension (return value of ",(0,s.jsx)(n.code,{children:"activate"}),").\nIt is an invalid action to access this field before this extension has been activated."]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L205",children:"packages/extension-api/src/extension-api.d.ts:205"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"extensionpath",children:"extensionPath"}),"\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:"extensionPath"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:["The absolute file path of the directory containing this extension. Shorthand\nnotation for ",(0,s.jsx)(n.a,{href:"/api/interfaces/Extension#extensionuri",children:"Extension.extensionUri.fsPath"})," (independent of the uri scheme)."]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L193",children:"packages/extension-api/src/extension-api.d.ts:193"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"extensionuri",children:"extensionUri"}),"\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:"extensionUri"}),": ",(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 uri of the directory containing the extension."}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-2",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L187",children:"packages/extension-api/src/extension-api.d.ts:187"})}),"\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.code,{children:"readonly"})," ",(0,s.jsx)(n.strong,{children:"id"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:["The canonical extension identifier in the form of: ",(0,s.jsx)(n.code,{children:"publisher.name"}),"."]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-3",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L182",children:"packages/extension-api/src/extension-api.d.ts:182"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"packagejson",children:"packageJSON"}),"\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:"packageJSON"}),": ",(0,s.jsx)(n.code,{children:"any"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The parsed contents of the extension's package.json."}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-4",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L199",children:"packages/extension-api/src/extension-api.d.ts:199"})})]})}function l(e={}){const{wrapper:n}={...(0,t.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(h,{...e})}):h(e)}},43023:(e,n,i)=>{i.d(n,{R:()=>d,x:()=>o});var s=i(63696);const t={},r=s.createContext(t);function d(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(t):e.components||t:d(e.components),s.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[70540],{78064:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>a,contentTitle:()=>o,default:()=>l,frontMatter:()=>r,metadata:()=>d,toc:()=>c});var s=i(62540),t=i(43023);const r={},o="Interface: Extension",d={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={},c=[{value:"Type Parameters",id:"type-parameters",level:2},{value:"Properties",id:"properties",level:2},{value:"exports",id:"exports",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"extensionPath",id:"extensionpath",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"extensionUri",id:"extensionuri",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"id",id:"id",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"packageJSON",id:"packagejson",level:3},{value:"Defined in",id:"defined-in-4",level:4}];function h(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",p:"p",strong:"strong",...(0,t.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.header,{children:(0,s.jsx)(n.h1,{id:"interface-extensiont",children:"Interface: Extension"})}),"\n",(0,s.jsx)(n.p,{children:"Represents an extension."}),"\n",(0,s.jsxs)(n.p,{children:["To get an instance of an ",(0,s.jsx)(n.code,{children:"Extension"})," use ",(0,s.jsx)(n.a,{href:"/api/namespaces/extensions/functions/getExtension",children:"getExtension"}),"."]}),"\n",(0,s.jsx)(n.h2,{id:"type-parameters",children:"Type Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"T"})]}),"\n",(0,s.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,s.jsx)(n.h3,{id:"exports",children:"exports"}),"\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:"exports"}),": ",(0,s.jsx)(n.code,{children:"T"})]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:["The public API exported by this extension (return value of ",(0,s.jsx)(n.code,{children:"activate"}),").\nIt is an invalid action to access this field before this extension has been activated."]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L205",children:"packages/extension-api/src/extension-api.d.ts:205"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"extensionpath",children:"extensionPath"}),"\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:"extensionPath"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:["The absolute file path of the directory containing this extension. Shorthand\nnotation for ",(0,s.jsx)(n.a,{href:"/api/interfaces/Extension#extensionuri",children:"Extension.extensionUri.fsPath"})," (independent of the uri scheme)."]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L193",children:"packages/extension-api/src/extension-api.d.ts:193"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"extensionuri",children:"extensionUri"}),"\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:"extensionUri"}),": ",(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 uri of the directory containing the extension."}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-2",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L187",children:"packages/extension-api/src/extension-api.d.ts:187"})}),"\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.code,{children:"readonly"})," ",(0,s.jsx)(n.strong,{children:"id"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:["The canonical extension identifier in the form of: ",(0,s.jsx)(n.code,{children:"publisher.name"}),"."]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-3",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L182",children:"packages/extension-api/src/extension-api.d.ts:182"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"packagejson",children:"packageJSON"}),"\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:"packageJSON"}),": ",(0,s.jsx)(n.code,{children:"any"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The parsed contents of the extension's package.json."}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-4",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L199",children:"packages/extension-api/src/extension-api.d.ts:199"})})]})}function l(e={}){const{wrapper:n}={...(0,t.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(h,{...e})}):h(e)}},43023:(e,n,i)=>{i.d(n,{R:()=>o,x:()=>d});var s=i(63696);const t={},r=s.createContext(t);function o(e){const n=s.useContext(r);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(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/f1ad83b2.9c79d00b.js b/assets/js/f1ad83b2.875d7308.js similarity index 91% rename from assets/js/f1ad83b2.9c79d00b.js rename to assets/js/f1ad83b2.875d7308.js index e825a442ea8..63e7bff12ee 100644 --- a/assets/js/f1ad83b2.9c79d00b.js +++ b/assets/js/f1ad83b2.875d7308.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[29824],{13536:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>c,contentTitle:()=>o,default:()=>h,frontMatter:()=>s,metadata:()=>d,toc:()=>a});var t=i(62540),r=i(43023);const s={},o="Interface: KubernetesProviderConnection",d={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"}},c={},a=[{value:"Properties",id:"properties",level:2},{value:"endpoint",id:"endpoint",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"lifecycle?",id:"lifecycle",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"name",id:"name",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"Methods",id:"methods",level:2},{value:"status()",id:"status",level:3},{value:"Returns",id:"returns",level:4},{value:"Defined in",id:"defined-in-3",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",p:"p",strong:"strong",...(0,r.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.header,{children:(0,t.jsx)(n.h1,{id:"interface-kubernetesproviderconnection",children:"Interface: KubernetesProviderConnection"})}),"\n",(0,t.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,t.jsx)(n.h3,{id:"endpoint",children:"endpoint"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"endpoint"}),": ",(0,t.jsx)(n.a,{href:"/api/interfaces/KubernetesProviderConnectionEndpoint",children:(0,t.jsx)(n.code,{children:"KubernetesProviderConnectionEndpoint"})})]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/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:"lifecycle",children:"lifecycle?"}),"\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:"lifecycle"}),": ",(0,t.jsx)(n.a,{href:"/api/interfaces/ProviderConnectionLifecycle",children:(0,t.jsx)(n.code,{children:"ProviderConnectionLifecycle"})})]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L486",children:"packages/extension-api/src/extension-api.d.ts:486"})}),"\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:"defined-in-2",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/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:"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/ProviderConnectionStatus",children:(0,t.jsx)(n.code,{children:"ProviderConnectionStatus"})})]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"returns",children:"Returns"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"/api/type-aliases/ProviderConnectionStatus",children:(0,t.jsx)(n.code,{children:"ProviderConnectionStatus"})})}),"\n",(0,t.jsx)(n.h4,{id:"defined-in-3",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L487",children:"packages/extension-api/src/extension-api.d.ts:487"})})]})}function h(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},43023:(e,n,i)=>{i.d(n,{R:()=>o,x:()=>d});var t=i(63696);const r={},s=t.createContext(r);function o(e){const n=t.useContext(s);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function d(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:o(e.components),t.createElement(s.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[29824],{13536:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>c,contentTitle:()=>o,default:()=>h,frontMatter:()=>s,metadata:()=>d,toc:()=>a});var t=i(62540),r=i(43023);const s={},o="Interface: KubernetesProviderConnection",d={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"}},c={},a=[{value:"Properties",id:"properties",level:2},{value:"endpoint",id:"endpoint",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"lifecycle?",id:"lifecycle",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"name",id:"name",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"Methods",id:"methods",level:2},{value:"status()",id:"status",level:3},{value:"Returns",id:"returns",level:4},{value:"Defined in",id:"defined-in-3",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",p:"p",strong:"strong",...(0,r.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.header,{children:(0,t.jsx)(n.h1,{id:"interface-kubernetesproviderconnection",children:"Interface: KubernetesProviderConnection"})}),"\n",(0,t.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,t.jsx)(n.h3,{id:"endpoint",children:"endpoint"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"endpoint"}),": ",(0,t.jsx)(n.a,{href:"/api/interfaces/KubernetesProviderConnectionEndpoint",children:(0,t.jsx)(n.code,{children:"KubernetesProviderConnectionEndpoint"})})]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/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:"lifecycle",children:"lifecycle?"}),"\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:"lifecycle"}),": ",(0,t.jsx)(n.a,{href:"/api/interfaces/ProviderConnectionLifecycle",children:(0,t.jsx)(n.code,{children:"ProviderConnectionLifecycle"})})]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L486",children:"packages/extension-api/src/extension-api.d.ts:486"})}),"\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:"defined-in-2",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/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:"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/ProviderConnectionStatus",children:(0,t.jsx)(n.code,{children:"ProviderConnectionStatus"})})]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"returns",children:"Returns"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"/api/type-aliases/ProviderConnectionStatus",children:(0,t.jsx)(n.code,{children:"ProviderConnectionStatus"})})}),"\n",(0,t.jsx)(n.h4,{id:"defined-in-3",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L487",children:"packages/extension-api/src/extension-api.d.ts:487"})})]})}function h(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},43023:(e,n,i)=>{i.d(n,{R:()=>o,x:()=>d});var t=i(63696);const r={},s=t.createContext(r);function o(e){const n=t.useContext(s);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function d(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:o(e.components),t.createElement(s.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/f20efc55.ae204a70.js b/assets/js/f20efc55.d6cbb94d.js similarity index 86% rename from assets/js/f20efc55.ae204a70.js rename to assets/js/f20efc55.d6cbb94d.js index 9a2e8e30ffb..2dbfffef3f6 100644 --- a/assets/js/f20efc55.ae204a70.js +++ b/assets/js/f20efc55.d6cbb94d.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[28645],{1569:(e,t,r)=>{r.r(t),r.d(t,{assets:()=>c,contentTitle:()=>s,default:()=>u,frontMatter:()=>n,metadata:()=>o,toc:()=>l});var a=r(62540),i=r(43023);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:"Defined in",id:"defined-in",level:2}];function d(e){const t={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",strong:"strong",...(0,i.R)(),...e.components};return(0,a.jsxs)(a.Fragment,{children:[(0,a.jsx)(t.header,{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:"defined-in",children:"Defined in"}),"\n",(0,a.jsx)(t.p,{children:(0,a.jsx)(t.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L1496",children:"packages/extension-api/src/extension-api.d.ts:1496"})})]})}function u(e={}){const{wrapper:t}={...(0,i.R)(),...e.components};return t?(0,a.jsx)(t,{...e,children:(0,a.jsx)(d,{...e})}):d(e)}},43023:(e,t,r)=>{r.d(t,{R:()=>s,x:()=>o});var a=r(63696);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 +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[28645],{1569:(e,t,r)=>{r.r(t),r.d(t,{assets:()=>c,contentTitle:()=>s,default:()=>d,frontMatter:()=>n,metadata:()=>o,toc:()=>l});var a=r(62540),i=r(43023);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:"Defined in",id:"defined-in",level:2}];function u(e){const t={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",strong:"strong",...(0,i.R)(),...e.components};return(0,a.jsxs)(a.Fragment,{children:[(0,a.jsx)(t.header,{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:"defined-in",children:"Defined in"}),"\n",(0,a.jsx)(t.p,{children:(0,a.jsx)(t.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L1496",children:"packages/extension-api/src/extension-api.d.ts:1496"})})]})}function d(e={}){const{wrapper:t}={...(0,i.R)(),...e.components};return t?(0,a.jsx)(t,{...e,children:(0,a.jsx)(u,{...e})}):u(e)}},43023:(e,t,r)=>{r.d(t,{R:()=>s,x:()=>o});var a=r(63696);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.77c25e4f.js b/assets/js/f27eaf88.edd88cd8.js similarity index 79% rename from assets/js/f27eaf88.77c25e4f.js rename to assets/js/f27eaf88.edd88cd8.js index 94ab3f74698..27940d3fc74 100644 --- a/assets/js/f27eaf88.77c25e4f.js +++ b/assets/js/f27eaf88.edd88cd8.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[98458],{52401:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>r,contentTitle:()=>o,default:()=>h,frontMatter:()=>a,metadata:()=>c,toc:()=>l});var i=t(62540),s=t(43023);const a={},o="Interface: CancellationToken",c={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:"Defined in",id:"defined-in",level:4},{value:"onCancellationRequested",id:"oncancellationrequested",level:3},{value:"Defined in",id:"defined-in-1",level:4}];function d(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",p:"p",strong:"strong",...(0,s.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.header,{children:(0,i.jsx)(n.h1,{id:"interface-cancellationtoken",children:"Interface: CancellationToken"})}),"\n",(0,i.jsx)(n.p,{children:"A cancellation token is passed to an asynchronous or long running\noperation to request cancellation."}),"\n",(0,i.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(n.h3,{id:"iscancellationrequested",children:"isCancellationRequested"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"isCancellationRequested"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Is ",(0,i.jsx)(n.code,{children:"true"})," when the token has been cancelled, ",(0,i.jsx)(n.code,{children:"false"})," otherwise."]}),"\n",(0,i.jsx)(n.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L1083",children:"packages/extension-api/src/extension-api.d.ts:1083"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"oncancellationrequested",children:"onCancellationRequested"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"onCancellationRequested"}),": ",(0,i.jsx)(n.a,{href:"/api/interfaces/Event",children:(0,i.jsx)(n.code,{children:"Event"})}),"<",(0,i.jsx)(n.code,{children:"any"}),">"]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["An ",(0,i.jsx)(n.a,{href:"/api/interfaces/Event",children:"Event"})," which fires upon cancellation."]}),"\n",(0,i.jsx)(n.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L1089",children:"packages/extension-api/src/extension-api.d.ts:1089"})})]})}function h(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(d,{...e})}):d(e)}},43023:(e,n,t)=>{t.d(n,{R:()=>o,x:()=>c});var i=t(63696);const s={},a=i.createContext(s);function o(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(s):e.components||s:o(e.components),i.createElement(a.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[98458],{52401:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>r,contentTitle:()=>c,default:()=>h,frontMatter:()=>a,metadata:()=>o,toc:()=>l});var i=t(62540),s=t(43023);const a={},c="Interface: CancellationToken",o={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:"Defined in",id:"defined-in",level:4},{value:"onCancellationRequested",id:"oncancellationrequested",level:3},{value:"Defined in",id:"defined-in-1",level:4}];function d(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",p:"p",strong:"strong",...(0,s.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.header,{children:(0,i.jsx)(n.h1,{id:"interface-cancellationtoken",children:"Interface: CancellationToken"})}),"\n",(0,i.jsx)(n.p,{children:"A cancellation token is passed to an asynchronous or long running\noperation to request cancellation."}),"\n",(0,i.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(n.h3,{id:"iscancellationrequested",children:"isCancellationRequested"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"isCancellationRequested"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Is ",(0,i.jsx)(n.code,{children:"true"})," when the token has been cancelled, ",(0,i.jsx)(n.code,{children:"false"})," otherwise."]}),"\n",(0,i.jsx)(n.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L1083",children:"packages/extension-api/src/extension-api.d.ts:1083"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"oncancellationrequested",children:"onCancellationRequested"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"onCancellationRequested"}),": ",(0,i.jsx)(n.a,{href:"/api/interfaces/Event",children:(0,i.jsx)(n.code,{children:"Event"})}),"<",(0,i.jsx)(n.code,{children:"any"}),">"]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["An ",(0,i.jsx)(n.a,{href:"/api/interfaces/Event",children:"Event"})," which fires upon cancellation."]}),"\n",(0,i.jsx)(n.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L1089",children:"packages/extension-api/src/extension-api.d.ts:1089"})})]})}function h(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(d,{...e})}):d(e)}},43023:(e,n,t)=>{t.d(n,{R:()=>c,x:()=>o});var i=t(63696);const s={},a=i.createContext(s);function c(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(s):e.components||s:c(e.components),i.createElement(a.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/f4271232.4e2b3ee6.js b/assets/js/f4271232.2de3f5cd.js similarity index 95% rename from assets/js/f4271232.4e2b3ee6.js rename to assets/js/f4271232.2de3f5cd.js index 7b1787b872b..43c2fe9afd5 100644 --- a/assets/js/f4271232.4e2b3ee6.js +++ b/assets/js/f4271232.2de3f5cd.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[18538],{25672:(n,e,t)=>{t.r(e),t.d(e,{assets:()=>c,contentTitle:()=>s,default:()=>p,frontMatter:()=>o,metadata:()=>r,toc:()=>d});var i=t(62540),a=t(43023);const o={},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:"Defined in",id:"defined-in",level:2}];function l(n){const e={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",strong:"strong",...(0,a.R)(),...n.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(e.header,{children:(0,i.jsx)(e.h1,{id:"function-navigatetocontainerlogs",children:"Function: navigateToContainerLogs()"})}),"\n",(0,i.jsxs)(e.blockquote,{children:["\n",(0,i.jsxs)(e.p,{children:[(0,i.jsx)(e.strong,{children:"navigateToContainerLogs"}),"(",(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:"defined-in",children:"Defined in"}),"\n",(0,i.jsx)(e.p,{children:(0,i.jsx)(e.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L4502",children:"packages/extension-api/src/extension-api.d.ts:4502"})})]})}function p(n={}){const{wrapper:e}={...(0,a.R)(),...n.components};return e?(0,i.jsx)(e,{...n,children:(0,i.jsx)(l,{...n})}):l(n)}},43023:(n,e,t)=>{t.d(e,{R:()=>s,x:()=>r});var i=t(63696);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([[18538],{25672:(n,e,t)=>{t.r(e),t.d(e,{assets:()=>c,contentTitle:()=>s,default:()=>p,frontMatter:()=>o,metadata:()=>r,toc:()=>d});var i=t(62540),a=t(43023);const o={},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:"Defined in",id:"defined-in",level:2}];function l(n){const e={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",strong:"strong",...(0,a.R)(),...n.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(e.header,{children:(0,i.jsx)(e.h1,{id:"function-navigatetocontainerlogs",children:"Function: navigateToContainerLogs()"})}),"\n",(0,i.jsxs)(e.blockquote,{children:["\n",(0,i.jsxs)(e.p,{children:[(0,i.jsx)(e.strong,{children:"navigateToContainerLogs"}),"(",(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:"defined-in",children:"Defined in"}),"\n",(0,i.jsx)(e.p,{children:(0,i.jsx)(e.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L4502",children:"packages/extension-api/src/extension-api.d.ts:4502"})})]})}function p(n={}){const{wrapper:e}={...(0,a.R)(),...n.components};return e?(0,i.jsx)(e,{...n,children:(0,i.jsx)(l,{...n})}):l(n)}},43023:(n,e,t)=>{t.d(e,{R:()=>s,x:()=>r});var i=t(63696);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/f6cd0d3d.48ecca81.js b/assets/js/f6cd0d3d.edededcb.js similarity index 83% rename from assets/js/f6cd0d3d.48ecca81.js rename to assets/js/f6cd0d3d.edededcb.js index ae71207aac1..7a6887a5e4a 100644 --- a/assets/js/f6cd0d3d.48ecca81.js +++ b/assets/js/f6cd0d3d.edededcb.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[40555],{50859:(e,r,n)=>{n.r(r),n.d(r,{assets:()=>c,contentTitle:()=>d,default:()=>h,frontMatter:()=>s,metadata:()=>a,toc:()=>o});var i=n(62540),t=n(43023);const s={},d="Interface: RegistryProvider",a={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"}},c={},o=[{value:"Properties",id:"properties",level:2},{value:"name",id:"name",level:3},{value:"Defined in",id:"defined-in",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:"Defined in",id:"defined-in-1",level:4}];function l(e){const r={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",p:"p",strong:"strong",...(0,t.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(r.header,{children:(0,i.jsx)(r.h1,{id:"interface-registryprovider",children:"Interface: RegistryProvider"})}),"\n",(0,i.jsx)(r.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(r.h3,{id:"name",children:"name"}),"\n",(0,i.jsxs)(r.blockquote,{children:["\n",(0,i.jsxs)(r.p,{children:[(0,i.jsx)(r.code,{children:"readonly"})," ",(0,i.jsx)(r.strong,{children:"name"}),": ",(0,i.jsx)(r.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(r.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,i.jsx)(r.p,{children:(0,i.jsx)(r.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L912",children:"packages/extension-api/src/extension-api.d.ts:912"})}),"\n",(0,i.jsx)(r.h2,{id:"methods",children:"Methods"}),"\n",(0,i.jsx)(r.h3,{id:"create",children:"create()"}),"\n",(0,i.jsxs)(r.blockquote,{children:["\n",(0,i.jsxs)(r.p,{children:[(0,i.jsx)(r.strong,{children:"create"}),"(",(0,i.jsx)(r.code,{children:"registryCreateOptions"}),"): ",(0,i.jsx)(r.a,{href:"/api/interfaces/Registry",children:(0,i.jsx)(r.code,{children:"Registry"})})]}),"\n"]}),"\n",(0,i.jsx)(r.h4,{id:"parameters",children:"Parameters"}),"\n",(0,i.jsxs)(r.p,{children:["\u2022 ",(0,i.jsx)(r.strong,{children:"registryCreateOptions"}),": ",(0,i.jsx)(r.a,{href:"/api/interfaces/RegistryCreateOptions",children:(0,i.jsx)(r.code,{children:"RegistryCreateOptions"})})]}),"\n",(0,i.jsx)(r.h4,{id:"returns",children:"Returns"}),"\n",(0,i.jsx)(r.p,{children:(0,i.jsx)(r.a,{href:"/api/interfaces/Registry",children:(0,i.jsx)(r.code,{children:"Registry"})})}),"\n",(0,i.jsx)(r.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,i.jsx)(r.p,{children:(0,i.jsx)(r.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L913",children:"packages/extension-api/src/extension-api.d.ts:913"})})]})}function h(e={}){const{wrapper:r}={...(0,t.R)(),...e.components};return r?(0,i.jsx)(r,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},43023:(e,r,n)=>{n.d(r,{R:()=>d,x:()=>a});var i=n(63696);const t={},s=i.createContext(t);function d(e){const r=i.useContext(s);return i.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:d(e.components),i.createElement(s.Provider,{value:r},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[40555],{50859:(e,r,n)=>{n.r(r),n.d(r,{assets:()=>c,contentTitle:()=>a,default:()=>h,frontMatter:()=>s,metadata:()=>d,toc:()=>o});var i=n(62540),t=n(43023);const s={},a="Interface: RegistryProvider",d={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"}},c={},o=[{value:"Properties",id:"properties",level:2},{value:"name",id:"name",level:3},{value:"Defined in",id:"defined-in",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:"Defined in",id:"defined-in-1",level:4}];function l(e){const r={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",p:"p",strong:"strong",...(0,t.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(r.header,{children:(0,i.jsx)(r.h1,{id:"interface-registryprovider",children:"Interface: RegistryProvider"})}),"\n",(0,i.jsx)(r.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(r.h3,{id:"name",children:"name"}),"\n",(0,i.jsxs)(r.blockquote,{children:["\n",(0,i.jsxs)(r.p,{children:[(0,i.jsx)(r.code,{children:"readonly"})," ",(0,i.jsx)(r.strong,{children:"name"}),": ",(0,i.jsx)(r.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(r.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,i.jsx)(r.p,{children:(0,i.jsx)(r.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L912",children:"packages/extension-api/src/extension-api.d.ts:912"})}),"\n",(0,i.jsx)(r.h2,{id:"methods",children:"Methods"}),"\n",(0,i.jsx)(r.h3,{id:"create",children:"create()"}),"\n",(0,i.jsxs)(r.blockquote,{children:["\n",(0,i.jsxs)(r.p,{children:[(0,i.jsx)(r.strong,{children:"create"}),"(",(0,i.jsx)(r.code,{children:"registryCreateOptions"}),"): ",(0,i.jsx)(r.a,{href:"/api/interfaces/Registry",children:(0,i.jsx)(r.code,{children:"Registry"})})]}),"\n"]}),"\n",(0,i.jsx)(r.h4,{id:"parameters",children:"Parameters"}),"\n",(0,i.jsxs)(r.p,{children:["\u2022 ",(0,i.jsx)(r.strong,{children:"registryCreateOptions"}),": ",(0,i.jsx)(r.a,{href:"/api/interfaces/RegistryCreateOptions",children:(0,i.jsx)(r.code,{children:"RegistryCreateOptions"})})]}),"\n",(0,i.jsx)(r.h4,{id:"returns",children:"Returns"}),"\n",(0,i.jsx)(r.p,{children:(0,i.jsx)(r.a,{href:"/api/interfaces/Registry",children:(0,i.jsx)(r.code,{children:"Registry"})})}),"\n",(0,i.jsx)(r.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,i.jsx)(r.p,{children:(0,i.jsx)(r.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L913",children:"packages/extension-api/src/extension-api.d.ts:913"})})]})}function h(e={}){const{wrapper:r}={...(0,t.R)(),...e.components};return r?(0,i.jsx)(r,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},43023:(e,r,n)=>{n.d(r,{R:()=>a,x:()=>d});var i=n(63696);const t={},s=i.createContext(t);function a(e){const r=i.useContext(s);return i.useMemo((function(){return"function"==typeof e?e(r):{...r,...e}}),[r,e])}function d(e){let r;return r=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:a(e.components),i.createElement(s.Provider,{value:r},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/f6cf66bc.f440376c.js b/assets/js/f6cf66bc.04576495.js similarity index 98% rename from assets/js/f6cf66bc.f440376c.js rename to assets/js/f6cf66bc.04576495.js index 70d09ca9480..f45116135a5 100644 --- a/assets/js/f6cf66bc.f440376c.js +++ b/assets/js/f6cf66bc.04576495.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[15405],{2640:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>a,contentTitle:()=>c,default:()=>p,frontMatter:()=>r,metadata:()=>o,toc:()=>d});var i=s(62540),t=s(43023);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:"Defined in",id:"defined-in",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",strong:"strong",...(0,t.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.header,{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:"defined-in",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2104",children:"packages/extension-api/src/extension-api.d.ts:2104"})})]})}function p(e={}){const{wrapper:n}={...(0,t.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},43023:(e,n,s)=>{s.d(n,{R:()=>c,x:()=>o});var i=s(63696);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([[15405],{2640:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>a,contentTitle:()=>c,default:()=>p,frontMatter:()=>r,metadata:()=>o,toc:()=>d});var i=s(62540),t=s(43023);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:"Defined in",id:"defined-in",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",strong:"strong",...(0,t.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.header,{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:"defined-in",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2104",children:"packages/extension-api/src/extension-api.d.ts:2104"})})]})}function p(e={}){const{wrapper:n}={...(0,t.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},43023:(e,n,s)=>{s.d(n,{R:()=>c,x:()=>o});var i=s(63696);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.966be44c.js b/assets/js/f7197f43.d3c794af.js similarity index 97% rename from assets/js/f7197f43.966be44c.js rename to assets/js/f7197f43.d3c794af.js index 5e0fbbda6c4..e1a16ba1b5d 100644 --- a/assets/js/f7197f43.966be44c.js +++ b/assets/js/f7197f43.d3c794af.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[96316],{71544:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>d,contentTitle:()=>i,default:()=>u,frontMatter:()=>a,metadata:()=>l,toc:()=>c});var t=s(62540),r=s(43023);const a={},i="Class: TelemetryTrustedValue",l={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"}},d={},c=[{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:"Defined in",id:"defined-in",level:4},{value:"Properties",id:"properties",level:2},{value:"value",id:"value",level:3},{value:"Defined in",id:"defined-in-1",level:4}];function o(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",p:"p",strong:"strong",...(0,r.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.header,{children:(0,t.jsx)(n.h1,{id:"class-telemetrytrustedvaluet",children:"Class: TelemetryTrustedValue"})}),"\n",(0,t.jsx)(n.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)(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:"constructors",children:"Constructors"}),"\n",(0,t.jsx)(n.h3,{id:"new-telemetrytrustedvalue",children:"new TelemetryTrustedValue()"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"new TelemetryTrustedValue"}),"<",(0,t.jsx)(n.code,{children:"T"}),">(",(0,t.jsx)(n.code,{children:"value"}),"): ",(0,t.jsx)(n.a,{href:"/api/classes/TelemetryTrustedValue",children:(0,t.jsx)(n.code,{children:"TelemetryTrustedValue"})}),"<",(0,t.jsx)(n.code,{children:"T"}),">"]}),"\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:"value"}),": ",(0,t.jsx)(n.code,{children:"T"})]}),"\n",(0,t.jsx)(n.h4,{id:"returns",children:"Returns"}),"\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.a,{href:"/api/classes/TelemetryTrustedValue",children:(0,t.jsx)(n.code,{children:"TelemetryTrustedValue"})}),"<",(0,t.jsx)(n.code,{children:"T"}),">"]}),"\n",(0,t.jsx)(n.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L4148",children:"packages/extension-api/src/extension-api.d.ts:4148"})}),"\n",(0,t.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,t.jsx)(n.h3,{id:"value",children:"value"}),"\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:"value"}),": ",(0,t.jsx)(n.code,{children:"T"})]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L4146",children:"packages/extension-api/src/extension-api.d.ts:4146"})})]})}function u(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(o,{...e})}):o(e)}},43023:(e,n,s)=>{s.d(n,{R:()=>i,x:()=>l});var t=s(63696);const r={},a=t.createContext(r);function i(e){const n=t.useContext(a);return t.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(r):e.components||r:i(e.components),t.createElement(a.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[96316],{71544:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>d,contentTitle:()=>i,default:()=>u,frontMatter:()=>a,metadata:()=>l,toc:()=>c});var t=s(62540),r=s(43023);const a={},i="Class: TelemetryTrustedValue",l={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"}},d={},c=[{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:"Defined in",id:"defined-in",level:4},{value:"Properties",id:"properties",level:2},{value:"value",id:"value",level:3},{value:"Defined in",id:"defined-in-1",level:4}];function o(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",p:"p",strong:"strong",...(0,r.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.header,{children:(0,t.jsx)(n.h1,{id:"class-telemetrytrustedvaluet",children:"Class: TelemetryTrustedValue"})}),"\n",(0,t.jsx)(n.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)(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:"constructors",children:"Constructors"}),"\n",(0,t.jsx)(n.h3,{id:"new-telemetrytrustedvalue",children:"new TelemetryTrustedValue()"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"new TelemetryTrustedValue"}),"<",(0,t.jsx)(n.code,{children:"T"}),">(",(0,t.jsx)(n.code,{children:"value"}),"): ",(0,t.jsx)(n.a,{href:"/api/classes/TelemetryTrustedValue",children:(0,t.jsx)(n.code,{children:"TelemetryTrustedValue"})}),"<",(0,t.jsx)(n.code,{children:"T"}),">"]}),"\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:"value"}),": ",(0,t.jsx)(n.code,{children:"T"})]}),"\n",(0,t.jsx)(n.h4,{id:"returns",children:"Returns"}),"\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.a,{href:"/api/classes/TelemetryTrustedValue",children:(0,t.jsx)(n.code,{children:"TelemetryTrustedValue"})}),"<",(0,t.jsx)(n.code,{children:"T"}),">"]}),"\n",(0,t.jsx)(n.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L4148",children:"packages/extension-api/src/extension-api.d.ts:4148"})}),"\n",(0,t.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,t.jsx)(n.h3,{id:"value",children:"value"}),"\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:"value"}),": ",(0,t.jsx)(n.code,{children:"T"})]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L4146",children:"packages/extension-api/src/extension-api.d.ts:4146"})})]})}function u(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(o,{...e})}):o(e)}},43023:(e,n,s)=>{s.d(n,{R:()=>i,x:()=>l});var t=s(63696);const r={},a=t.createContext(r);function i(e){const n=t.useContext(a);return t.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(r):e.components||r:i(e.components),t.createElement(a.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/f771dec1.afc0a87e.js b/assets/js/f771dec1.2b600265.js similarity index 95% rename from assets/js/f771dec1.afc0a87e.js rename to assets/js/f771dec1.2b600265.js index cf391be2cf6..10780c12b22 100644 --- a/assets/js/f771dec1.afc0a87e.js +++ b/assets/js/f771dec1.2b600265.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[35515],{89722:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>r,contentTitle:()=>c,default:()=>p,frontMatter:()=>s,metadata:()=>l,toc:()=>a});var o=i(62540),t=i(43023);const s={},c="Function: createCliTool()",l={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:"all",permalink:"/api/namespaces/cli/variables/all"},next:{title:"getCliTool",permalink:"/api/namespaces/cli/functions/getCliTool"}},r={},a=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Defined in",id:"defined-in",level:2}];function d(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",strong:"strong",...(0,t.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(n.header,{children:(0,o.jsx)(n.h1,{id:"function-createclitool",children:"Function: createCliTool()"})}),"\n",(0,o.jsxs)(n.blockquote,{children:["\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.strong,{children:"createCliTool"}),"(",(0,o.jsx)(n.code,{children:"options"}),"): ",(0,o.jsx)(n.a,{href:"/api/interfaces/CliTool",children:(0,o.jsx)(n.code,{children:"CliTool"})})]}),"\n"]}),"\n",(0,o.jsx)(n.p,{children:"Register new CLI Tool"}),"\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/CliToolOptions",children:(0,o.jsx)(n.code,{children:"CliToolOptions"})})]}),"\n",(0,o.jsx)(n.p,{children:"CliToolsOptions instance to configure new instance of CliTool"}),"\n",(0,o.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,o.jsx)(n.p,{children:(0,o.jsx)(n.a,{href:"/api/interfaces/CliTool",children:(0,o.jsx)(n.code,{children:"CliTool"})})}),"\n",(0,o.jsx)(n.p,{children:"CliTool instance"}),"\n",(0,o.jsx)(n.h2,{id:"defined-in",children:"Defined in"}),"\n",(0,o.jsx)(n.p,{children:(0,o.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L4403",children:"packages/extension-api/src/extension-api.d.ts:4403"})})]})}function p(e={}){const{wrapper:n}={...(0,t.R)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(d,{...e})}):d(e)}},43023:(e,n,i)=>{i.d(n,{R:()=>c,x:()=>l});var o=i(63696);const t={},s=o.createContext(t);function c(e){const n=o.useContext(s);return o.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(t):e.components||t:c(e.components),o.createElement(s.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[35515],{89722:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>r,contentTitle:()=>c,default:()=>p,frontMatter:()=>s,metadata:()=>l,toc:()=>a});var o=i(62540),t=i(43023);const s={},c="Function: createCliTool()",l={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:"all",permalink:"/api/namespaces/cli/variables/all"},next:{title:"getCliTool",permalink:"/api/namespaces/cli/functions/getCliTool"}},r={},a=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Defined in",id:"defined-in",level:2}];function d(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",strong:"strong",...(0,t.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(n.header,{children:(0,o.jsx)(n.h1,{id:"function-createclitool",children:"Function: createCliTool()"})}),"\n",(0,o.jsxs)(n.blockquote,{children:["\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.strong,{children:"createCliTool"}),"(",(0,o.jsx)(n.code,{children:"options"}),"): ",(0,o.jsx)(n.a,{href:"/api/interfaces/CliTool",children:(0,o.jsx)(n.code,{children:"CliTool"})})]}),"\n"]}),"\n",(0,o.jsx)(n.p,{children:"Register new CLI Tool"}),"\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/CliToolOptions",children:(0,o.jsx)(n.code,{children:"CliToolOptions"})})]}),"\n",(0,o.jsx)(n.p,{children:"CliToolsOptions instance to configure new instance of CliTool"}),"\n",(0,o.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,o.jsx)(n.p,{children:(0,o.jsx)(n.a,{href:"/api/interfaces/CliTool",children:(0,o.jsx)(n.code,{children:"CliTool"})})}),"\n",(0,o.jsx)(n.p,{children:"CliTool instance"}),"\n",(0,o.jsx)(n.h2,{id:"defined-in",children:"Defined in"}),"\n",(0,o.jsx)(n.p,{children:(0,o.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L4403",children:"packages/extension-api/src/extension-api.d.ts:4403"})})]})}function p(e={}){const{wrapper:n}={...(0,t.R)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(d,{...e})}):d(e)}},43023:(e,n,i)=>{i.d(n,{R:()=>c,x:()=>l});var o=i(63696);const t={},s=o.createContext(t);function c(e){const n=o.useContext(s);return o.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(t):e.components||t:c(e.components),o.createElement(s.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/f7c9e078.909f7f8c.js b/assets/js/f7c9e078.55a956e9.js similarity index 93% rename from assets/js/f7c9e078.909f7f8c.js rename to assets/js/f7c9e078.55a956e9.js index 4948957996e..321367d3db6 100644 --- a/assets/js/f7c9e078.909f7f8c.js +++ b/assets/js/f7c9e078.55a956e9.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[11532],{90054:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>o,default:()=>h,frontMatter:()=>s,metadata:()=>d,toc:()=>c});var i=t(62540),r=t(43023);const s={},o="Interface: ThrottlingData",d={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={},c=[{value:"Properties",id:"properties",level:2},{value:"periods",id:"periods",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"throttled_periods",id:"throttled_periods",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"throttled_time",id:"throttled_time",level:3},{value:"Defined in",id:"defined-in-2",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",p:"p",strong:"strong",...(0,r.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.header,{children:(0,i.jsx)(n.h1,{id:"interface-throttlingdata",children:"Interface: ThrottlingData"})}),"\n",(0,i.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(n.h3,{id:"periods",children:"periods"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"periods"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L3160",children:"packages/extension-api/src/extension-api.d.ts:3160"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"throttled_periods",children:"throttled_periods"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"throttled_periods"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L3161",children:"packages/extension-api/src/extension-api.d.ts:3161"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"throttled_time",children:"throttled_time"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"throttled_time"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"defined-in-2",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L3162",children:"packages/extension-api/src/extension-api.d.ts:3162"})})]})}function h(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},43023:(e,n,t)=>{t.d(n,{R:()=>o,x:()=>d});var i=t(63696);const r={},s=i.createContext(r);function o(e){const n=i.useContext(s);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(s.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[11532],{90054:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>o,default:()=>h,frontMatter:()=>s,metadata:()=>d,toc:()=>c});var i=t(62540),r=t(43023);const s={},o="Interface: ThrottlingData",d={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={},c=[{value:"Properties",id:"properties",level:2},{value:"periods",id:"periods",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"throttled_periods",id:"throttled_periods",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"throttled_time",id:"throttled_time",level:3},{value:"Defined in",id:"defined-in-2",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",p:"p",strong:"strong",...(0,r.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.header,{children:(0,i.jsx)(n.h1,{id:"interface-throttlingdata",children:"Interface: ThrottlingData"})}),"\n",(0,i.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(n.h3,{id:"periods",children:"periods"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"periods"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L3160",children:"packages/extension-api/src/extension-api.d.ts:3160"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"throttled_periods",children:"throttled_periods"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"throttled_periods"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L3161",children:"packages/extension-api/src/extension-api.d.ts:3161"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"throttled_time",children:"throttled_time"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"throttled_time"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"defined-in-2",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L3162",children:"packages/extension-api/src/extension-api.d.ts:3162"})})]})}function h(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},43023:(e,n,t)=>{t.d(n,{R:()=>o,x:()=>d});var i=t(63696);const r={},s=i.createContext(r);function o(e){const n=i.useContext(s);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(s.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/f86eb50f.82f67db1.js b/assets/js/f86eb50f.5ca03df7.js similarity index 87% rename from assets/js/f86eb50f.82f67db1.js rename to assets/js/f86eb50f.5ca03df7.js index f4ba260965b..03109877ffb 100644 --- a/assets/js/f86eb50f.82f67db1.js +++ b/assets/js/f86eb50f.5ca03df7.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[44183],{54061:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>s,contentTitle:()=>d,default:()=>h,frontMatter:()=>o,metadata:()=>c,toc:()=>a});var r=i(62540),t=i(43023);const o={},d="Interface: ContainerProviderConnectionFactory",c={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"}},s={},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:"Defined in",id:"defined-in",level:4},{value:"creationDisplayName?",id:"creationdisplayname",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-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:"Defined in",id:"defined-in-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:"Defined in",id:"defined-in-3",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",li:"li",p:"p",strong:"strong",ul:"ul",...(0,t.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.header,{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:"defined-in",children:"Defined in"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L499",children:"packages/extension-api/src/extension-api.d.ts:499"})}),"\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:"defined-in-1",children:"Defined in"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L496",children:"packages/extension-api/src/extension-api.d.ts:496"})}),"\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:"defined-in-2",children:"Defined in"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L505",children:"packages/extension-api/src/extension-api.d.ts:505"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"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:"defined-in-3",children:"Defined in"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L493",children:"packages/extension-api/src/extension-api.d.ts:493"})})]})}function h(e={}){const{wrapper:n}={...(0,t.R)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(l,{...e})}):l(e)}},43023:(e,n,i)=>{i.d(n,{R:()=>d,x:()=>c});var r=i(63696);const t={},o=r.createContext(t);function d(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:d(e.components),r.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[44183],{54061:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>s,contentTitle:()=>c,default:()=>h,frontMatter:()=>o,metadata:()=>d,toc:()=>a});var r=i(62540),t=i(43023);const o={},c="Interface: ContainerProviderConnectionFactory",d={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"}},s={},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:"Defined in",id:"defined-in",level:4},{value:"creationDisplayName?",id:"creationdisplayname",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-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:"Defined in",id:"defined-in-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:"Defined in",id:"defined-in-3",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",li:"li",p:"p",strong:"strong",ul:"ul",...(0,t.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.header,{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:"defined-in",children:"Defined in"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L499",children:"packages/extension-api/src/extension-api.d.ts:499"})}),"\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:"defined-in-1",children:"Defined in"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L496",children:"packages/extension-api/src/extension-api.d.ts:496"})}),"\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:"defined-in-2",children:"Defined in"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L505",children:"packages/extension-api/src/extension-api.d.ts:505"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"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:"defined-in-3",children:"Defined in"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L493",children:"packages/extension-api/src/extension-api.d.ts:493"})})]})}function h(e={}){const{wrapper:n}={...(0,t.R)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(l,{...e})}):l(e)}},43023:(e,n,i)=>{i.d(n,{R:()=>c,x:()=>d});var r=i(63696);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 d(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/f890fec4.d845d953.js b/assets/js/f890fec4.67856e0d.js similarity index 97% rename from assets/js/f890fec4.d845d953.js rename to assets/js/f890fec4.67856e0d.js index 71e94c37c9f..08a9116d420 100644 --- a/assets/js/f890fec4.d845d953.js +++ b/assets/js/f890fec4.67856e0d.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[9332],{37008:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>l,contentTitle:()=>c,default:()=>p,frontMatter:()=>s,metadata:()=>r,toc:()=>a});var o=i(62540),t=i(43023);const s={},c="Function: getCliTool()",r={id:"namespaces/cli/functions/getCliTool",title:"Function: getCliTool()",description:"getCliTool(id): CliToolInfo \\| undefined",source:"@site/api/namespaces/cli/functions/getCliTool.md",sourceDirName:"namespaces/cli/functions",slug:"/namespaces/cli/functions/getCliTool",permalink:"/api/namespaces/cli/functions/getCliTool",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"createCliTool",permalink:"/api/namespaces/cli/functions/createCliTool"},next:{title:"onDidChange",permalink:"/api/namespaces/cli/functions/onDidChange"}},l={},a=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Defined in",id:"defined-in",level:2}];function d(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",strong:"strong",...(0,t.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(n.header,{children:(0,o.jsx)(n.h1,{id:"function-getclitool",children:"Function: getCliTool()"})}),"\n",(0,o.jsxs)(n.blockquote,{children:["\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.strong,{children:"getCliTool"}),"(",(0,o.jsx)(n.code,{children:"id"}),"): ",(0,o.jsx)(n.a,{href:"/api/interfaces/CliToolInfo",children:(0,o.jsx)(n.code,{children:"CliToolInfo"})})," | ",(0,o.jsx)(n.code,{children:"undefined"})]}),"\n"]}),"\n",(0,o.jsx)(n.p,{children:"given an id, return the corresponding CLI Tool"}),"\n",(0,o.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,o.jsxs)(n.p,{children:["\u2022 ",(0,o.jsx)(n.strong,{children:"id"}),": ",(0,o.jsx)(n.code,{children:"string"})]}),"\n",(0,o.jsx)(n.p,{children:"cli tool"}),"\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/CliToolInfo",children:(0,o.jsx)(n.code,{children:"CliToolInfo"})})," | ",(0,o.jsx)(n.code,{children:"undefined"})]}),"\n",(0,o.jsx)(n.h2,{id:"defined-in",children:"Defined in"}),"\n",(0,o.jsx)(n.p,{children:(0,o.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L4409",children:"packages/extension-api/src/extension-api.d.ts:4409"})})]})}function p(e={}){const{wrapper:n}={...(0,t.R)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(d,{...e})}):d(e)}},43023:(e,n,i)=>{i.d(n,{R:()=>c,x:()=>r});var o=i(63696);const t={},s=o.createContext(t);function c(e){const n=o.useContext(s);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(t):e.components||t:c(e.components),o.createElement(s.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[9332],{37008:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>l,contentTitle:()=>c,default:()=>p,frontMatter:()=>s,metadata:()=>r,toc:()=>a});var o=i(62540),t=i(43023);const s={},c="Function: getCliTool()",r={id:"namespaces/cli/functions/getCliTool",title:"Function: getCliTool()",description:"getCliTool(id): CliToolInfo \\| undefined",source:"@site/api/namespaces/cli/functions/getCliTool.md",sourceDirName:"namespaces/cli/functions",slug:"/namespaces/cli/functions/getCliTool",permalink:"/api/namespaces/cli/functions/getCliTool",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"createCliTool",permalink:"/api/namespaces/cli/functions/createCliTool"},next:{title:"onDidChange",permalink:"/api/namespaces/cli/functions/onDidChange"}},l={},a=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Defined in",id:"defined-in",level:2}];function d(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",strong:"strong",...(0,t.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(n.header,{children:(0,o.jsx)(n.h1,{id:"function-getclitool",children:"Function: getCliTool()"})}),"\n",(0,o.jsxs)(n.blockquote,{children:["\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.strong,{children:"getCliTool"}),"(",(0,o.jsx)(n.code,{children:"id"}),"): ",(0,o.jsx)(n.a,{href:"/api/interfaces/CliToolInfo",children:(0,o.jsx)(n.code,{children:"CliToolInfo"})})," | ",(0,o.jsx)(n.code,{children:"undefined"})]}),"\n"]}),"\n",(0,o.jsx)(n.p,{children:"given an id, return the corresponding CLI Tool"}),"\n",(0,o.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,o.jsxs)(n.p,{children:["\u2022 ",(0,o.jsx)(n.strong,{children:"id"}),": ",(0,o.jsx)(n.code,{children:"string"})]}),"\n",(0,o.jsx)(n.p,{children:"cli tool"}),"\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/CliToolInfo",children:(0,o.jsx)(n.code,{children:"CliToolInfo"})})," | ",(0,o.jsx)(n.code,{children:"undefined"})]}),"\n",(0,o.jsx)(n.h2,{id:"defined-in",children:"Defined in"}),"\n",(0,o.jsx)(n.p,{children:(0,o.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L4409",children:"packages/extension-api/src/extension-api.d.ts:4409"})})]})}function p(e={}){const{wrapper:n}={...(0,t.R)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(d,{...e})}):d(e)}},43023:(e,n,i)=>{i.d(n,{R:()=>c,x:()=>r});var o=i(63696);const t={},s=o.createContext(t);function c(e){const n=o.useContext(s);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(t):e.components||t:c(e.components),o.createElement(s.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/fb8cd692.f93ea25f.js b/assets/js/fb8cd692.778d7423.js similarity index 85% rename from assets/js/fb8cd692.f93ea25f.js rename to assets/js/fb8cd692.778d7423.js index 0c7b878ad41..01a7892a64e 100644 --- a/assets/js/fb8cd692.f93ea25f.js +++ b/assets/js/fb8cd692.778d7423.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[48823],{98965:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>l,contentTitle:()=>c,default:()=>h,frontMatter:()=>o,metadata:()=>a,toc:()=>r});var s=i(62540),d=i(43023);const o={},c="Interface: HostConfig",a={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={},r=[{value:"Properties",id:"properties",level:2},{value:"AutoRemove?",id:"autoremove",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"Binds?",id:"binds",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"BlkioDeviceReadBps?",id:"blkiodevicereadbps",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"BlkioDeviceReadIOps?",id:"blkiodevicereadiops",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"BlkioDeviceWriteBps?",id:"blkiodevicewritebps",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"BlkioDeviceWriteIOps?",id:"blkiodevicewriteiops",level:3},{value:"Defined in",id:"defined-in-5",level:4},{value:"BlkioWeight?",id:"blkioweight",level:3},{value:"Defined in",id:"defined-in-6",level:4},{value:"BlkioWeightDevice?",id:"blkioweightdevice",level:3},{value:"Defined in",id:"defined-in-7",level:4},{value:"CapAdd?",id:"capadd",level:3},{value:"Defined in",id:"defined-in-8",level:4},{value:"CapDrop?",id:"capdrop",level:3},{value:"Defined in",id:"defined-in-9",level:4},{value:"Cgroup?",id:"cgroup",level:3},{value:"Defined in",id:"defined-in-10",level:4},{value:"CgroupParent?",id:"cgroupparent",level:3},{value:"Defined in",id:"defined-in-11",level:4},{value:"ConsoleSize?",id:"consolesize",level:3},{value:"Defined in",id:"defined-in-12",level:4},{value:"ContainerIDFile?",id:"containeridfile",level:3},{value:"Defined in",id:"defined-in-13",level:4},{value:"CpuCount?",id:"cpucount",level:3},{value:"Defined in",id:"defined-in-14",level:4},{value:"CpuPercent?",id:"cpupercent",level:3},{value:"Defined in",id:"defined-in-15",level:4},{value:"CpuPeriod?",id:"cpuperiod",level:3},{value:"Defined in",id:"defined-in-16",level:4},{value:"CpuQuota?",id:"cpuquota",level:3},{value:"Defined in",id:"defined-in-17",level:4},{value:"CpuRealtimePeriod?",id:"cpurealtimeperiod",level:3},{value:"Defined in",id:"defined-in-18",level:4},{value:"CpuRealtimeRuntime?",id:"cpurealtimeruntime",level:3},{value:"Defined in",id:"defined-in-19",level:4},{value:"CpuShares?",id:"cpushares",level:3},{value:"Defined in",id:"defined-in-20",level:4},{value:"CpusetCpus?",id:"cpusetcpus",level:3},{value:"Defined in",id:"defined-in-21",level:4},{value:"CpusetMems?",id:"cpusetmems",level:3},{value:"Defined in",id:"defined-in-22",level:4},{value:"DeviceCgroupRules?",id:"devicecgrouprules",level:3},{value:"Defined in",id:"defined-in-23",level:4},{value:"DeviceRequests?",id:"devicerequests",level:3},{value:"Defined in",id:"defined-in-24",level:4},{value:"Devices?",id:"devices",level:3},{value:"Defined in",id:"defined-in-25",level:4},{value:"DiskQuota?",id:"diskquota",level:3},{value:"Defined in",id:"defined-in-26",level:4},{value:"Dns?",id:"dns",level:3},{value:"Defined in",id:"defined-in-27",level:4},{value:"DnsOptions?",id:"dnsoptions",level:3},{value:"Defined in",id:"defined-in-28",level:4},{value:"DnsSearch?",id:"dnssearch",level:3},{value:"Defined in",id:"defined-in-29",level:4},{value:"ExtraHosts?",id:"extrahosts",level:3},{value:"Defined in",id:"defined-in-30",level:4},{value:"GroupAdd?",id:"groupadd",level:3},{value:"Defined in",id:"defined-in-31",level:4},{value:"Init?",id:"init",level:3},{value:"Defined in",id:"defined-in-32",level:4},{value:"IpcMode?",id:"ipcmode",level:3},{value:"Defined in",id:"defined-in-33",level:4},{value:"Isolation?",id:"isolation",level:3},{value:"Defined in",id:"defined-in-34",level:4},{value:"KernelMemory?",id:"kernelmemory",level:3},{value:"Defined in",id:"defined-in-35",level:4},{value:"Links?",id:"links",level:3},{value:"Defined in",id:"defined-in-36",level:4},{value:"LogConfig?",id:"logconfig",level:3},{value:"Config",id:"config",level:4},{value:"Type",id:"type",level:4},{value:"Defined in",id:"defined-in-37",level:4},{value:"MaskedPaths?",id:"maskedpaths",level:3},{value:"Defined in",id:"defined-in-38",level:4},{value:"Memory?",id:"memory",level:3},{value:"Defined in",id:"defined-in-39",level:4},{value:"MemoryReservation?",id:"memoryreservation",level:3},{value:"Defined in",id:"defined-in-40",level:4},{value:"MemorySwap?",id:"memoryswap",level:3},{value:"Defined in",id:"defined-in-41",level:4},{value:"MemorySwappiness?",id:"memoryswappiness",level:3},{value:"Defined in",id:"defined-in-42",level:4},{value:"Mounts?",id:"mounts",level:3},{value:"Defined in",id:"defined-in-43",level:4},{value:"NanoCpus?",id:"nanocpus",level:3},{value:"Defined in",id:"defined-in-44",level:4},{value:"NetworkMode?",id:"networkmode",level:3},{value:"Defined in",id:"defined-in-45",level:4},{value:"OomKillDisable?",id:"oomkilldisable",level:3},{value:"Defined in",id:"defined-in-46",level:4},{value:"OomScoreAdj?",id:"oomscoreadj",level:3},{value:"Defined in",id:"defined-in-47",level:4},{value:"PidMode?",id:"pidmode",level:3},{value:"Defined in",id:"defined-in-48",level:4},{value:"PidsLimit?",id:"pidslimit",level:3},{value:"Defined in",id:"defined-in-49",level:4},{value:"PortBindings?",id:"portbindings",level:3},{value:"Defined in",id:"defined-in-50",level:4},{value:"Privileged?",id:"privileged",level:3},{value:"Defined in",id:"defined-in-51",level:4},{value:"PublishAllPorts?",id:"publishallports",level:3},{value:"Defined in",id:"defined-in-52",level:4},{value:"ReadonlyPaths?",id:"readonlypaths",level:3},{value:"Defined in",id:"defined-in-53",level:4},{value:"ReadonlyRootfs?",id:"readonlyrootfs",level:3},{value:"Defined in",id:"defined-in-54",level:4},{value:"RestartPolicy?",id:"restartpolicy",level:3},{value:"Defined in",id:"defined-in-55",level:4},{value:"Runtime?",id:"runtime",level:3},{value:"Defined in",id:"defined-in-56",level:4},{value:"SecurityOpt?",id:"securityopt",level:3},{value:"Defined in",id:"defined-in-57",level:4},{value:"ShmSize?",id:"shmsize",level:3},{value:"Defined in",id:"defined-in-58",level:4},{value:"StorageOpt?",id:"storageopt",level:3},{value:"Index Signature",id:"index-signature",level:4},{value:"Defined in",id:"defined-in-59",level:4},{value:"Sysctls?",id:"sysctls",level:3},{value:"Index Signature",id:"index-signature-1",level:4},{value:"Defined in",id:"defined-in-60",level:4},{value:"Tmpfs?",id:"tmpfs",level:3},{value:"Index Signature",id:"index-signature-2",level:4},{value:"Defined in",id:"defined-in-61",level:4},{value:"UTSMode?",id:"utsmode",level:3},{value:"Defined in",id:"defined-in-62",level:4},{value:"Ulimits?",id:"ulimits",level:3},{value:"Defined in",id:"defined-in-63",level:4},{value:"UsernsMode?",id:"usernsmode",level:3},{value:"Defined in",id:"defined-in-64",level:4},{value:"VolumeDriver?",id:"volumedriver",level:3},{value:"Defined in",id:"defined-in-65",level:4},{value:"VolumesFrom?",id:"volumesfrom",level:3},{value:"Defined in",id:"defined-in-66",level:4}];function t(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",p:"p",strong:"strong",...(0,d.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.header,{children:(0,s.jsx)(n.h1,{id:"interface-hostconfig",children:"Interface: HostConfig"})}),"\n",(0,s.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,s.jsx)(n.h3,{id:"autoremove",children:"AutoRemove?"}),"\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:"AutoRemove"}),": ",(0,s.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2430",children:"packages/extension-api/src/extension-api.d.ts:2430"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"binds",children:"Binds?"}),"\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:"Binds"}),": ",(0,s.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2431",children:"packages/extension-api/src/extension-api.d.ts:2431"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"blkiodevicereadbps",children:"BlkioDeviceReadBps?"}),"\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:"BlkioDeviceReadBps"}),": ",(0,s.jsx)(n.code,{children:"unknown"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-2",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2474",children:"packages/extension-api/src/extension-api.d.ts:2474"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"blkiodevicereadiops",children:"BlkioDeviceReadIOps?"}),"\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:"BlkioDeviceReadIOps"}),": ",(0,s.jsx)(n.code,{children:"unknown"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-3",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2476",children:"packages/extension-api/src/extension-api.d.ts:2476"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"blkiodevicewritebps",children:"BlkioDeviceWriteBps?"}),"\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:"BlkioDeviceWriteBps"}),": ",(0,s.jsx)(n.code,{children:"unknown"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-4",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2475",children:"packages/extension-api/src/extension-api.d.ts:2475"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"blkiodevicewriteiops",children:"BlkioDeviceWriteIOps?"}),"\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:"BlkioDeviceWriteIOps"}),": ",(0,s.jsx)(n.code,{children:"unknown"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-5",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2477",children:"packages/extension-api/src/extension-api.d.ts:2477"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"blkioweight",children:"BlkioWeight?"}),"\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:"BlkioWeight"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-6",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2472",children:"packages/extension-api/src/extension-api.d.ts:2472"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"blkioweightdevice",children:"BlkioWeightDevice?"}),"\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:"BlkioWeightDevice"}),": ",(0,s.jsx)(n.code,{children:"unknown"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-7",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2473",children:"packages/extension-api/src/extension-api.d.ts:2473"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"capadd",children:"CapAdd?"}),"\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:"CapAdd"}),": ",(0,s.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-8",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2443",children:"packages/extension-api/src/extension-api.d.ts:2443"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"capdrop",children:"CapDrop?"}),"\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:"CapDrop"}),": ",(0,s.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-9",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2444",children:"packages/extension-api/src/extension-api.d.ts:2444"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"cgroup",children:"Cgroup?"}),"\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:"Cgroup"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-10",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2451",children:"packages/extension-api/src/extension-api.d.ts:2451"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"cgroupparent",children:"CgroupParent?"}),"\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:"CgroupParent"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-11",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2471",children:"packages/extension-api/src/extension-api.d.ts:2471"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"consolesize",children:"ConsoleSize?"}),"\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:"ConsoleSize"}),": ",(0,s.jsx)(n.code,{children:"number"}),"[]"]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-12",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2466",children:"packages/extension-api/src/extension-api.d.ts:2466"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"containeridfile",children:"ContainerIDFile?"}),"\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:"ContainerIDFile"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-13",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2432",children:"packages/extension-api/src/extension-api.d.ts:2432"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"cpucount",children:"CpuCount?"}),"\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:"CpuCount"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-14",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2496",children:"packages/extension-api/src/extension-api.d.ts:2496"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"cpupercent",children:"CpuPercent?"}),"\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:"CpuPercent"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-15",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2497",children:"packages/extension-api/src/extension-api.d.ts:2497"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"cpuperiod",children:"CpuPeriod?"}),"\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:"CpuPeriod"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-16",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2478",children:"packages/extension-api/src/extension-api.d.ts:2478"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"cpuquota",children:"CpuQuota?"}),"\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:"CpuQuota"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-17",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2479",children:"packages/extension-api/src/extension-api.d.ts:2479"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"cpurealtimeperiod",children:"CpuRealtimePeriod?"}),"\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:"CpuRealtimePeriod"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-18",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2498",children:"packages/extension-api/src/extension-api.d.ts:2498"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"cpurealtimeruntime",children:"CpuRealtimeRuntime?"}),"\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:"CpuRealtimeRuntime"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-19",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2499",children:"packages/extension-api/src/extension-api.d.ts:2499"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"cpushares",children:"CpuShares?"}),"\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:"CpuShares"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-20",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2470",children:"packages/extension-api/src/extension-api.d.ts:2470"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"cpusetcpus",children:"CpusetCpus?"}),"\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:"CpusetCpus"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-21",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/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:"cpusetmems",children:"CpusetMems?"}),"\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:"CpusetMems"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-22",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/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:"devicecgrouprules",children:"DeviceCgroupRules?"}),"\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:"DeviceCgroupRules"}),": ",(0,s.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-23",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2483",children:"packages/extension-api/src/extension-api.d.ts:2483"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"devicerequests",children:"DeviceRequests?"}),"\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:"DeviceRequests"}),": ",(0,s.jsx)(n.a,{href:"/api/interfaces/DeviceRequest",children:(0,s.jsx)(n.code,{children:"DeviceRequest"})}),"[]"]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-24",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2484",children:"packages/extension-api/src/extension-api.d.ts:2484"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"devices",children:"Devices?"}),"\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:"Devices"}),": ",(0,s.jsx)(n.code,{children:"unknown"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-25",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/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:"diskquota",children:"DiskQuota?"}),"\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:"DiskQuota"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-26",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2485",children:"packages/extension-api/src/extension-api.d.ts:2485"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"dns",children:"Dns?"}),"\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:"Dns"}),": ",(0,s.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-27",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2445",children:"packages/extension-api/src/extension-api.d.ts:2445"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"dnsoptions",children:"DnsOptions?"}),"\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:"DnsOptions"}),": ",(0,s.jsx)(n.code,{children:"unknown"}),"[]"]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-28",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2446",children:"packages/extension-api/src/extension-api.d.ts:2446"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"dnssearch",children:"DnsSearch?"}),"\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:"DnsSearch"}),": ",(0,s.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-29",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2447",children:"packages/extension-api/src/extension-api.d.ts:2447"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"extrahosts",children:"ExtraHosts?"}),"\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:"ExtraHosts"}),": ",(0,s.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-30",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2448",children:"packages/extension-api/src/extension-api.d.ts:2448"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"groupadd",children:"GroupAdd?"}),"\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:"GroupAdd"}),": ",(0,s.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-31",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2449",children:"packages/extension-api/src/extension-api.d.ts:2449"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"init",children:"Init?"}),"\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:"Init"}),": ",(0,s.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-32",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2493",children:"packages/extension-api/src/extension-api.d.ts:2493"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"ipcmode",children:"IpcMode?"}),"\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:"IpcMode"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-33",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2450",children:"packages/extension-api/src/extension-api.d.ts:2450"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"isolation",children:"Isolation?"}),"\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:"Isolation"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-34",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2467",children:"packages/extension-api/src/extension-api.d.ts:2467"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"kernelmemory",children:"KernelMemory?"}),"\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:"KernelMemory"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-35",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2486",children:"packages/extension-api/src/extension-api.d.ts:2486"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"links",children:"Links?"}),"\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:"Links"}),": ",(0,s.jsx)(n.code,{children:"unknown"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-36",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2452",children:"packages/extension-api/src/extension-api.d.ts:2452"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"logconfig",children:"LogConfig?"}),"\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:"LogConfig"}),": ",(0,s.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"config",children:"Config"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Config"}),": ",(0,s.jsx)(n.code,{children:"unknown"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"type",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:"defined-in-37",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2433",children:"packages/extension-api/src/extension-api.d.ts:2433"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"maskedpaths",children:"MaskedPaths?"}),"\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:"MaskedPaths"}),": ",(0,s.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-38",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2468",children:"packages/extension-api/src/extension-api.d.ts:2468"})}),"\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.h4,{id:"defined-in-39",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2487",children:"packages/extension-api/src/extension-api.d.ts:2487"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"memoryreservation",children:"MemoryReservation?"}),"\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:"MemoryReservation"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-40",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2488",children:"packages/extension-api/src/extension-api.d.ts:2488"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"memoryswap",children:"MemorySwap?"}),"\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:"MemorySwap"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-41",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2489",children:"packages/extension-api/src/extension-api.d.ts:2489"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"memoryswappiness",children:"MemorySwappiness?"}),"\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:"MemorySwappiness"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-42",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2490",children:"packages/extension-api/src/extension-api.d.ts:2490"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"mounts",children:"Mounts?"}),"\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:"Mounts"}),": ",(0,s.jsx)(n.a,{href:"/api/type-aliases/MountConfig",children:(0,s.jsx)(n.code,{children:"MountConfig"})})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-43",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2442",children:"packages/extension-api/src/extension-api.d.ts:2442"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"nanocpus",children:"NanoCpus?"}),"\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:"NanoCpus"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-44",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2491",children:"packages/extension-api/src/extension-api.d.ts:2491"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"networkmode",children:"NetworkMode?"}),"\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:"NetworkMode"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-45",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2437",children:"packages/extension-api/src/extension-api.d.ts:2437"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"oomkilldisable",children:"OomKillDisable?"}),"\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:"OomKillDisable"}),": ",(0,s.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-46",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2492",children:"packages/extension-api/src/extension-api.d.ts:2492"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"oomscoreadj",children:"OomScoreAdj?"}),"\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:"OomScoreAdj"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-47",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2453",children:"packages/extension-api/src/extension-api.d.ts:2453"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"pidmode",children:"PidMode?"}),"\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:"PidMode"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-48",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2454",children:"packages/extension-api/src/extension-api.d.ts:2454"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"pidslimit",children:"PidsLimit?"}),"\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:"PidsLimit"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-49",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2494",children:"packages/extension-api/src/extension-api.d.ts:2494"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"portbindings",children:"PortBindings?"}),"\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:"PortBindings"}),": ",(0,s.jsx)(n.code,{children:"unknown"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-50",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2438",children:"packages/extension-api/src/extension-api.d.ts:2438"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"privileged",children:"Privileged?"}),"\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:"Privileged"}),": ",(0,s.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-51",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2455",children:"packages/extension-api/src/extension-api.d.ts:2455"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"publishallports",children:"PublishAllPorts?"}),"\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:"PublishAllPorts"}),": ",(0,s.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-52",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2456",children:"packages/extension-api/src/extension-api.d.ts:2456"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"readonlypaths",children:"ReadonlyPaths?"}),"\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:"ReadonlyPaths"}),": ",(0,s.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-53",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2469",children:"packages/extension-api/src/extension-api.d.ts:2469"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"readonlyrootfs",children:"ReadonlyRootfs?"}),"\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:"ReadonlyRootfs"}),": ",(0,s.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-54",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2457",children:"packages/extension-api/src/extension-api.d.ts:2457"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"restartpolicy",children:"RestartPolicy?"}),"\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:"RestartPolicy"}),": ",(0,s.jsx)(n.a,{href:"/api/interfaces/HostRestartPolicy",children:(0,s.jsx)(n.code,{children:"HostRestartPolicy"})})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-55",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2439",children:"packages/extension-api/src/extension-api.d.ts:2439"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"runtime",children:"Runtime?"}),"\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:"Runtime"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-56",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2465",children:"packages/extension-api/src/extension-api.d.ts:2465"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"securityopt",children:"SecurityOpt?"}),"\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:"SecurityOpt"}),": ",(0,s.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-57",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2458",children:"packages/extension-api/src/extension-api.d.ts:2458"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"shmsize",children:"ShmSize?"}),"\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:"ShmSize"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-58",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2463",children:"packages/extension-api/src/extension-api.d.ts:2463"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"storageopt",children:"StorageOpt?"}),"\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:"StorageOpt"}),": ",(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:"option"}),": ",(0,s.jsx)(n.code,{children:"string"}),"]: ",(0,s.jsx)(n.code,{children:"string"})]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-59",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2459",children:"packages/extension-api/src/extension-api.d.ts:2459"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"sysctls",children:"Sysctls?"}),"\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:"Sysctls"}),": ",(0,s.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"index-signature-1",children:"Index Signature"}),"\n",(0,s.jsxs)(n.p,{children:["[",(0,s.jsx)(n.code,{children:"index"}),": ",(0,s.jsx)(n.code,{children:"string"}),"]: ",(0,s.jsx)(n.code,{children:"string"})]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-60",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2464",children:"packages/extension-api/src/extension-api.d.ts:2464"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"tmpfs",children:"Tmpfs?"}),"\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:"Tmpfs"}),": ",(0,s.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"index-signature-2",children:"Index Signature"}),"\n",(0,s.jsxs)(n.p,{children:["[",(0,s.jsx)(n.code,{children:"dir"}),": ",(0,s.jsx)(n.code,{children:"string"}),"]: ",(0,s.jsx)(n.code,{children:"string"})]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-61",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2460",children:"packages/extension-api/src/extension-api.d.ts:2460"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"utsmode",children:"UTSMode?"}),"\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:"UTSMode"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-62",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2461",children:"packages/extension-api/src/extension-api.d.ts:2461"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"ulimits",children:"Ulimits?"}),"\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:"Ulimits"}),": ",(0,s.jsx)(n.code,{children:"unknown"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-63",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2495",children:"packages/extension-api/src/extension-api.d.ts:2495"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"usernsmode",children:"UsernsMode?"}),"\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:"UsernsMode"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-64",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2462",children:"packages/extension-api/src/extension-api.d.ts:2462"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"volumedriver",children:"VolumeDriver?"}),"\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:"VolumeDriver"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-65",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2440",children:"packages/extension-api/src/extension-api.d.ts:2440"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"volumesfrom",children:"VolumesFrom?"}),"\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:"VolumesFrom"}),": ",(0,s.jsx)(n.code,{children:"unknown"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-66",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L2441",children:"packages/extension-api/src/extension-api.d.ts:2441"})})]})}function h(e={}){const{wrapper:n}={...(0,d.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(t,{...e})}):t(e)}},43023:(e,n,i)=>{i.d(n,{R:()=>c,x:()=>a});var s=i(63696);const d={},o=s.createContext(d);function c(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(d):e.components||d:c(e.components),s.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[48823],{98965:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>l,contentTitle:()=>o,default:()=>h,frontMatter:()=>c,metadata:()=>a,toc:()=>r});var s=i(62540),d=i(43023);const c={},o="Interface: HostConfig",a={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={},r=[{value:"Properties",id:"properties",level:2},{value:"AutoRemove?",id:"autoremove",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"Binds?",id:"binds",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"BlkioDeviceReadBps?",id:"blkiodevicereadbps",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"BlkioDeviceReadIOps?",id:"blkiodevicereadiops",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"BlkioDeviceWriteBps?",id:"blkiodevicewritebps",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"BlkioDeviceWriteIOps?",id:"blkiodevicewriteiops",level:3},{value:"Defined in",id:"defined-in-5",level:4},{value:"BlkioWeight?",id:"blkioweight",level:3},{value:"Defined in",id:"defined-in-6",level:4},{value:"BlkioWeightDevice?",id:"blkioweightdevice",level:3},{value:"Defined in",id:"defined-in-7",level:4},{value:"CapAdd?",id:"capadd",level:3},{value:"Defined in",id:"defined-in-8",level:4},{value:"CapDrop?",id:"capdrop",level:3},{value:"Defined in",id:"defined-in-9",level:4},{value:"Cgroup?",id:"cgroup",level:3},{value:"Defined in",id:"defined-in-10",level:4},{value:"CgroupParent?",id:"cgroupparent",level:3},{value:"Defined in",id:"defined-in-11",level:4},{value:"ConsoleSize?",id:"consolesize",level:3},{value:"Defined in",id:"defined-in-12",level:4},{value:"ContainerIDFile?",id:"containeridfile",level:3},{value:"Defined in",id:"defined-in-13",level:4},{value:"CpuCount?",id:"cpucount",level:3},{value:"Defined in",id:"defined-in-14",level:4},{value:"CpuPercent?",id:"cpupercent",level:3},{value:"Defined in",id:"defined-in-15",level:4},{value:"CpuPeriod?",id:"cpuperiod",level:3},{value:"Defined in",id:"defined-in-16",level:4},{value:"CpuQuota?",id:"cpuquota",level:3},{value:"Defined in",id:"defined-in-17",level:4},{value:"CpuRealtimePeriod?",id:"cpurealtimeperiod",level:3},{value:"Defined in",id:"defined-in-18",level:4},{value:"CpuRealtimeRuntime?",id:"cpurealtimeruntime",level:3},{value:"Defined in",id:"defined-in-19",level:4},{value:"CpuShares?",id:"cpushares",level:3},{value:"Defined in",id:"defined-in-20",level:4},{value:"CpusetCpus?",id:"cpusetcpus",level:3},{value:"Defined in",id:"defined-in-21",level:4},{value:"CpusetMems?",id:"cpusetmems",level:3},{value:"Defined in",id:"defined-in-22",level:4},{value:"DeviceCgroupRules?",id:"devicecgrouprules",level:3},{value:"Defined in",id:"defined-in-23",level:4},{value:"DeviceRequests?",id:"devicerequests",level:3},{value:"Defined in",id:"defined-in-24",level:4},{value:"Devices?",id:"devices",level:3},{value:"Defined in",id:"defined-in-25",level:4},{value:"DiskQuota?",id:"diskquota",level:3},{value:"Defined in",id:"defined-in-26",level:4},{value:"Dns?",id:"dns",level:3},{value:"Defined in",id:"defined-in-27",level:4},{value:"DnsOptions?",id:"dnsoptions",level:3},{value:"Defined in",id:"defined-in-28",level:4},{value:"DnsSearch?",id:"dnssearch",level:3},{value:"Defined in",id:"defined-in-29",level:4},{value:"ExtraHosts?",id:"extrahosts",level:3},{value:"Defined in",id:"defined-in-30",level:4},{value:"GroupAdd?",id:"groupadd",level:3},{value:"Defined in",id:"defined-in-31",level:4},{value:"Init?",id:"init",level:3},{value:"Defined in",id:"defined-in-32",level:4},{value:"IpcMode?",id:"ipcmode",level:3},{value:"Defined in",id:"defined-in-33",level:4},{value:"Isolation?",id:"isolation",level:3},{value:"Defined in",id:"defined-in-34",level:4},{value:"KernelMemory?",id:"kernelmemory",level:3},{value:"Defined in",id:"defined-in-35",level:4},{value:"Links?",id:"links",level:3},{value:"Defined in",id:"defined-in-36",level:4},{value:"LogConfig?",id:"logconfig",level:3},{value:"Config",id:"config",level:4},{value:"Type",id:"type",level:4},{value:"Defined in",id:"defined-in-37",level:4},{value:"MaskedPaths?",id:"maskedpaths",level:3},{value:"Defined in",id:"defined-in-38",level:4},{value:"Memory?",id:"memory",level:3},{value:"Defined in",id:"defined-in-39",level:4},{value:"MemoryReservation?",id:"memoryreservation",level:3},{value:"Defined in",id:"defined-in-40",level:4},{value:"MemorySwap?",id:"memoryswap",level:3},{value:"Defined in",id:"defined-in-41",level:4},{value:"MemorySwappiness?",id:"memoryswappiness",level:3},{value:"Defined in",id:"defined-in-42",level:4},{value:"Mounts?",id:"mounts",level:3},{value:"Defined in",id:"defined-in-43",level:4},{value:"NanoCpus?",id:"nanocpus",level:3},{value:"Defined in",id:"defined-in-44",level:4},{value:"NetworkMode?",id:"networkmode",level:3},{value:"Defined in",id:"defined-in-45",level:4},{value:"OomKillDisable?",id:"oomkilldisable",level:3},{value:"Defined in",id:"defined-in-46",level:4},{value:"OomScoreAdj?",id:"oomscoreadj",level:3},{value:"Defined in",id:"defined-in-47",level:4},{value:"PidMode?",id:"pidmode",level:3},{value:"Defined in",id:"defined-in-48",level:4},{value:"PidsLimit?",id:"pidslimit",level:3},{value:"Defined in",id:"defined-in-49",level:4},{value:"PortBindings?",id:"portbindings",level:3},{value:"Defined in",id:"defined-in-50",level:4},{value:"Privileged?",id:"privileged",level:3},{value:"Defined in",id:"defined-in-51",level:4},{value:"PublishAllPorts?",id:"publishallports",level:3},{value:"Defined in",id:"defined-in-52",level:4},{value:"ReadonlyPaths?",id:"readonlypaths",level:3},{value:"Defined in",id:"defined-in-53",level:4},{value:"ReadonlyRootfs?",id:"readonlyrootfs",level:3},{value:"Defined in",id:"defined-in-54",level:4},{value:"RestartPolicy?",id:"restartpolicy",level:3},{value:"Defined in",id:"defined-in-55",level:4},{value:"Runtime?",id:"runtime",level:3},{value:"Defined in",id:"defined-in-56",level:4},{value:"SecurityOpt?",id:"securityopt",level:3},{value:"Defined in",id:"defined-in-57",level:4},{value:"ShmSize?",id:"shmsize",level:3},{value:"Defined in",id:"defined-in-58",level:4},{value:"StorageOpt?",id:"storageopt",level:3},{value:"Index Signature",id:"index-signature",level:4},{value:"Defined in",id:"defined-in-59",level:4},{value:"Sysctls?",id:"sysctls",level:3},{value:"Index Signature",id:"index-signature-1",level:4},{value:"Defined in",id:"defined-in-60",level:4},{value:"Tmpfs?",id:"tmpfs",level:3},{value:"Index Signature",id:"index-signature-2",level:4},{value:"Defined in",id:"defined-in-61",level:4},{value:"UTSMode?",id:"utsmode",level:3},{value:"Defined in",id:"defined-in-62",level:4},{value:"Ulimits?",id:"ulimits",level:3},{value:"Defined in",id:"defined-in-63",level:4},{value:"UsernsMode?",id:"usernsmode",level:3},{value:"Defined in",id:"defined-in-64",level:4},{value:"VolumeDriver?",id:"volumedriver",level:3},{value:"Defined in",id:"defined-in-65",level:4},{value:"VolumesFrom?",id:"volumesfrom",level:3},{value:"Defined in",id:"defined-in-66",level:4}];function t(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",p:"p",strong:"strong",...(0,d.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.header,{children:(0,s.jsx)(n.h1,{id:"interface-hostconfig",children:"Interface: HostConfig"})}),"\n",(0,s.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,s.jsx)(n.h3,{id:"autoremove",children:"AutoRemove?"}),"\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:"AutoRemove"}),": ",(0,s.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2430",children:"packages/extension-api/src/extension-api.d.ts:2430"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"binds",children:"Binds?"}),"\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:"Binds"}),": ",(0,s.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2431",children:"packages/extension-api/src/extension-api.d.ts:2431"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"blkiodevicereadbps",children:"BlkioDeviceReadBps?"}),"\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:"BlkioDeviceReadBps"}),": ",(0,s.jsx)(n.code,{children:"unknown"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-2",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2474",children:"packages/extension-api/src/extension-api.d.ts:2474"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"blkiodevicereadiops",children:"BlkioDeviceReadIOps?"}),"\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:"BlkioDeviceReadIOps"}),": ",(0,s.jsx)(n.code,{children:"unknown"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-3",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2476",children:"packages/extension-api/src/extension-api.d.ts:2476"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"blkiodevicewritebps",children:"BlkioDeviceWriteBps?"}),"\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:"BlkioDeviceWriteBps"}),": ",(0,s.jsx)(n.code,{children:"unknown"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-4",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2475",children:"packages/extension-api/src/extension-api.d.ts:2475"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"blkiodevicewriteiops",children:"BlkioDeviceWriteIOps?"}),"\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:"BlkioDeviceWriteIOps"}),": ",(0,s.jsx)(n.code,{children:"unknown"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-5",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2477",children:"packages/extension-api/src/extension-api.d.ts:2477"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"blkioweight",children:"BlkioWeight?"}),"\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:"BlkioWeight"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-6",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2472",children:"packages/extension-api/src/extension-api.d.ts:2472"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"blkioweightdevice",children:"BlkioWeightDevice?"}),"\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:"BlkioWeightDevice"}),": ",(0,s.jsx)(n.code,{children:"unknown"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-7",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2473",children:"packages/extension-api/src/extension-api.d.ts:2473"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"capadd",children:"CapAdd?"}),"\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:"CapAdd"}),": ",(0,s.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-8",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2443",children:"packages/extension-api/src/extension-api.d.ts:2443"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"capdrop",children:"CapDrop?"}),"\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:"CapDrop"}),": ",(0,s.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-9",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2444",children:"packages/extension-api/src/extension-api.d.ts:2444"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"cgroup",children:"Cgroup?"}),"\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:"Cgroup"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-10",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2451",children:"packages/extension-api/src/extension-api.d.ts:2451"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"cgroupparent",children:"CgroupParent?"}),"\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:"CgroupParent"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-11",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2471",children:"packages/extension-api/src/extension-api.d.ts:2471"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"consolesize",children:"ConsoleSize?"}),"\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:"ConsoleSize"}),": ",(0,s.jsx)(n.code,{children:"number"}),"[]"]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-12",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2466",children:"packages/extension-api/src/extension-api.d.ts:2466"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"containeridfile",children:"ContainerIDFile?"}),"\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:"ContainerIDFile"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-13",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2432",children:"packages/extension-api/src/extension-api.d.ts:2432"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"cpucount",children:"CpuCount?"}),"\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:"CpuCount"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-14",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2496",children:"packages/extension-api/src/extension-api.d.ts:2496"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"cpupercent",children:"CpuPercent?"}),"\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:"CpuPercent"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-15",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2497",children:"packages/extension-api/src/extension-api.d.ts:2497"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"cpuperiod",children:"CpuPeriod?"}),"\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:"CpuPeriod"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-16",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2478",children:"packages/extension-api/src/extension-api.d.ts:2478"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"cpuquota",children:"CpuQuota?"}),"\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:"CpuQuota"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-17",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2479",children:"packages/extension-api/src/extension-api.d.ts:2479"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"cpurealtimeperiod",children:"CpuRealtimePeriod?"}),"\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:"CpuRealtimePeriod"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-18",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2498",children:"packages/extension-api/src/extension-api.d.ts:2498"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"cpurealtimeruntime",children:"CpuRealtimeRuntime?"}),"\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:"CpuRealtimeRuntime"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-19",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2499",children:"packages/extension-api/src/extension-api.d.ts:2499"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"cpushares",children:"CpuShares?"}),"\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:"CpuShares"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-20",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2470",children:"packages/extension-api/src/extension-api.d.ts:2470"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"cpusetcpus",children:"CpusetCpus?"}),"\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:"CpusetCpus"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-21",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/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:"cpusetmems",children:"CpusetMems?"}),"\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:"CpusetMems"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-22",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/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:"devicecgrouprules",children:"DeviceCgroupRules?"}),"\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:"DeviceCgroupRules"}),": ",(0,s.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-23",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2483",children:"packages/extension-api/src/extension-api.d.ts:2483"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"devicerequests",children:"DeviceRequests?"}),"\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:"DeviceRequests"}),": ",(0,s.jsx)(n.a,{href:"/api/interfaces/DeviceRequest",children:(0,s.jsx)(n.code,{children:"DeviceRequest"})}),"[]"]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-24",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2484",children:"packages/extension-api/src/extension-api.d.ts:2484"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"devices",children:"Devices?"}),"\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:"Devices"}),": ",(0,s.jsx)(n.code,{children:"unknown"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-25",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/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:"diskquota",children:"DiskQuota?"}),"\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:"DiskQuota"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-26",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2485",children:"packages/extension-api/src/extension-api.d.ts:2485"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"dns",children:"Dns?"}),"\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:"Dns"}),": ",(0,s.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-27",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2445",children:"packages/extension-api/src/extension-api.d.ts:2445"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"dnsoptions",children:"DnsOptions?"}),"\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:"DnsOptions"}),": ",(0,s.jsx)(n.code,{children:"unknown"}),"[]"]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-28",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2446",children:"packages/extension-api/src/extension-api.d.ts:2446"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"dnssearch",children:"DnsSearch?"}),"\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:"DnsSearch"}),": ",(0,s.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-29",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2447",children:"packages/extension-api/src/extension-api.d.ts:2447"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"extrahosts",children:"ExtraHosts?"}),"\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:"ExtraHosts"}),": ",(0,s.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-30",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2448",children:"packages/extension-api/src/extension-api.d.ts:2448"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"groupadd",children:"GroupAdd?"}),"\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:"GroupAdd"}),": ",(0,s.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-31",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2449",children:"packages/extension-api/src/extension-api.d.ts:2449"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"init",children:"Init?"}),"\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:"Init"}),": ",(0,s.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-32",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2493",children:"packages/extension-api/src/extension-api.d.ts:2493"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"ipcmode",children:"IpcMode?"}),"\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:"IpcMode"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-33",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2450",children:"packages/extension-api/src/extension-api.d.ts:2450"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"isolation",children:"Isolation?"}),"\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:"Isolation"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-34",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2467",children:"packages/extension-api/src/extension-api.d.ts:2467"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"kernelmemory",children:"KernelMemory?"}),"\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:"KernelMemory"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-35",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2486",children:"packages/extension-api/src/extension-api.d.ts:2486"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"links",children:"Links?"}),"\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:"Links"}),": ",(0,s.jsx)(n.code,{children:"unknown"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-36",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2452",children:"packages/extension-api/src/extension-api.d.ts:2452"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"logconfig",children:"LogConfig?"}),"\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:"LogConfig"}),": ",(0,s.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"config",children:"Config"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Config"}),": ",(0,s.jsx)(n.code,{children:"unknown"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"type",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:"defined-in-37",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2433",children:"packages/extension-api/src/extension-api.d.ts:2433"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"maskedpaths",children:"MaskedPaths?"}),"\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:"MaskedPaths"}),": ",(0,s.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-38",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2468",children:"packages/extension-api/src/extension-api.d.ts:2468"})}),"\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.h4,{id:"defined-in-39",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2487",children:"packages/extension-api/src/extension-api.d.ts:2487"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"memoryreservation",children:"MemoryReservation?"}),"\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:"MemoryReservation"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-40",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2488",children:"packages/extension-api/src/extension-api.d.ts:2488"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"memoryswap",children:"MemorySwap?"}),"\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:"MemorySwap"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-41",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2489",children:"packages/extension-api/src/extension-api.d.ts:2489"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"memoryswappiness",children:"MemorySwappiness?"}),"\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:"MemorySwappiness"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-42",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2490",children:"packages/extension-api/src/extension-api.d.ts:2490"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"mounts",children:"Mounts?"}),"\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:"Mounts"}),": ",(0,s.jsx)(n.a,{href:"/api/type-aliases/MountConfig",children:(0,s.jsx)(n.code,{children:"MountConfig"})})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-43",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2442",children:"packages/extension-api/src/extension-api.d.ts:2442"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"nanocpus",children:"NanoCpus?"}),"\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:"NanoCpus"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-44",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2491",children:"packages/extension-api/src/extension-api.d.ts:2491"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"networkmode",children:"NetworkMode?"}),"\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:"NetworkMode"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-45",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2437",children:"packages/extension-api/src/extension-api.d.ts:2437"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"oomkilldisable",children:"OomKillDisable?"}),"\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:"OomKillDisable"}),": ",(0,s.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-46",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2492",children:"packages/extension-api/src/extension-api.d.ts:2492"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"oomscoreadj",children:"OomScoreAdj?"}),"\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:"OomScoreAdj"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-47",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2453",children:"packages/extension-api/src/extension-api.d.ts:2453"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"pidmode",children:"PidMode?"}),"\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:"PidMode"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-48",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2454",children:"packages/extension-api/src/extension-api.d.ts:2454"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"pidslimit",children:"PidsLimit?"}),"\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:"PidsLimit"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-49",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2494",children:"packages/extension-api/src/extension-api.d.ts:2494"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"portbindings",children:"PortBindings?"}),"\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:"PortBindings"}),": ",(0,s.jsx)(n.code,{children:"unknown"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-50",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2438",children:"packages/extension-api/src/extension-api.d.ts:2438"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"privileged",children:"Privileged?"}),"\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:"Privileged"}),": ",(0,s.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-51",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2455",children:"packages/extension-api/src/extension-api.d.ts:2455"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"publishallports",children:"PublishAllPorts?"}),"\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:"PublishAllPorts"}),": ",(0,s.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-52",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2456",children:"packages/extension-api/src/extension-api.d.ts:2456"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"readonlypaths",children:"ReadonlyPaths?"}),"\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:"ReadonlyPaths"}),": ",(0,s.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-53",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2469",children:"packages/extension-api/src/extension-api.d.ts:2469"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"readonlyrootfs",children:"ReadonlyRootfs?"}),"\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:"ReadonlyRootfs"}),": ",(0,s.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-54",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2457",children:"packages/extension-api/src/extension-api.d.ts:2457"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"restartpolicy",children:"RestartPolicy?"}),"\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:"RestartPolicy"}),": ",(0,s.jsx)(n.a,{href:"/api/interfaces/HostRestartPolicy",children:(0,s.jsx)(n.code,{children:"HostRestartPolicy"})})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-55",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2439",children:"packages/extension-api/src/extension-api.d.ts:2439"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"runtime",children:"Runtime?"}),"\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:"Runtime"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-56",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2465",children:"packages/extension-api/src/extension-api.d.ts:2465"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"securityopt",children:"SecurityOpt?"}),"\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:"SecurityOpt"}),": ",(0,s.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-57",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2458",children:"packages/extension-api/src/extension-api.d.ts:2458"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"shmsize",children:"ShmSize?"}),"\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:"ShmSize"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-58",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2463",children:"packages/extension-api/src/extension-api.d.ts:2463"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"storageopt",children:"StorageOpt?"}),"\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:"StorageOpt"}),": ",(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:"option"}),": ",(0,s.jsx)(n.code,{children:"string"}),"]: ",(0,s.jsx)(n.code,{children:"string"})]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-59",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2459",children:"packages/extension-api/src/extension-api.d.ts:2459"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"sysctls",children:"Sysctls?"}),"\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:"Sysctls"}),": ",(0,s.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"index-signature-1",children:"Index Signature"}),"\n",(0,s.jsxs)(n.p,{children:["[",(0,s.jsx)(n.code,{children:"index"}),": ",(0,s.jsx)(n.code,{children:"string"}),"]: ",(0,s.jsx)(n.code,{children:"string"})]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-60",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2464",children:"packages/extension-api/src/extension-api.d.ts:2464"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"tmpfs",children:"Tmpfs?"}),"\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:"Tmpfs"}),": ",(0,s.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"index-signature-2",children:"Index Signature"}),"\n",(0,s.jsxs)(n.p,{children:["[",(0,s.jsx)(n.code,{children:"dir"}),": ",(0,s.jsx)(n.code,{children:"string"}),"]: ",(0,s.jsx)(n.code,{children:"string"})]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-61",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2460",children:"packages/extension-api/src/extension-api.d.ts:2460"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"utsmode",children:"UTSMode?"}),"\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:"UTSMode"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-62",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2461",children:"packages/extension-api/src/extension-api.d.ts:2461"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"ulimits",children:"Ulimits?"}),"\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:"Ulimits"}),": ",(0,s.jsx)(n.code,{children:"unknown"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-63",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2495",children:"packages/extension-api/src/extension-api.d.ts:2495"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"usernsmode",children:"UsernsMode?"}),"\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:"UsernsMode"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-64",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2462",children:"packages/extension-api/src/extension-api.d.ts:2462"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"volumedriver",children:"VolumeDriver?"}),"\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:"VolumeDriver"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-65",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2440",children:"packages/extension-api/src/extension-api.d.ts:2440"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"volumesfrom",children:"VolumesFrom?"}),"\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:"VolumesFrom"}),": ",(0,s.jsx)(n.code,{children:"unknown"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-66",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L2441",children:"packages/extension-api/src/extension-api.d.ts:2441"})})]})}function h(e={}){const{wrapper:n}={...(0,d.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(t,{...e})}):t(e)}},43023:(e,n,i)=>{i.d(n,{R:()=>o,x:()=>a});var s=i(63696);const d={},c=s.createContext(d);function o(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(d):e.components||d:o(e.components),s.createElement(c.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/fbfd390f.805c7d7c.js b/assets/js/fbfd390f.3527d541.js similarity index 94% rename from assets/js/fbfd390f.805c7d7c.js rename to assets/js/fbfd390f.3527d541.js index b472b838a4c..dd9ba5a6e56 100644 --- a/assets/js/fbfd390f.805c7d7c.js +++ b/assets/js/fbfd390f.3527d541.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[69215],{98219:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>d,contentTitle:()=>c,default:()=>l,frontMatter:()=>s,metadata:()=>o,toc:()=>a});var r=n(62540),i=n(43023);const s={},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:"Defined in",id:"defined-in",level:4}];function u(e){const t={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",p:"p",strong:"strong",...(0,i.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(t.header,{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:"defined-in",children:"Defined in"}),"\n",(0,r.jsx)(t.p,{children:(0,r.jsx)(t.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L520",children:"packages/extension-api/src/extension-api.d.ts:520"})})]})}function l(e={}){const{wrapper:t}={...(0,i.R)(),...e.components};return t?(0,r.jsx)(t,{...e,children:(0,r.jsx)(u,{...e})}):u(e)}},43023:(e,t,n)=>{n.d(t,{R:()=>c,x:()=>o});var r=n(63696);const i={},s=r.createContext(i);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(i):e.components||i:c(e.components),r.createElement(s.Provider,{value:t},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[69215],{98219:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>d,contentTitle:()=>c,default:()=>l,frontMatter:()=>s,metadata:()=>o,toc:()=>a});var r=n(62540),i=n(43023);const s={},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:"Defined in",id:"defined-in",level:4}];function u(e){const t={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",p:"p",strong:"strong",...(0,i.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(t.header,{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:"defined-in",children:"Defined in"}),"\n",(0,r.jsx)(t.p,{children:(0,r.jsx)(t.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L520",children:"packages/extension-api/src/extension-api.d.ts:520"})})]})}function l(e={}){const{wrapper:t}={...(0,i.R)(),...e.components};return t?(0,r.jsx)(t,{...e,children:(0,r.jsx)(u,{...e})}):u(e)}},43023:(e,t,n)=>{n.d(t,{R:()=>c,x:()=>o});var r=n(63696);const i={},s=r.createContext(i);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(i):e.components||i:c(e.components),r.createElement(s.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/fc923f19.5fe4d7e6.js b/assets/js/fc923f19.9012a3fc.js similarity index 93% rename from assets/js/fc923f19.5fe4d7e6.js rename to assets/js/fc923f19.9012a3fc.js index a72ccc555df..aff772c86d0 100644 --- a/assets/js/fc923f19.5fe4d7e6.js +++ b/assets/js/fc923f19.9012a3fc.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[24478],{44710:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>a,contentTitle:()=>c,default:()=>l,frontMatter:()=>t,metadata:()=>d,toc:()=>o});var s=i(62540),r=i(43023);const t={},c="Interface: ImageCheck",d={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={},o=[{value:"Properties",id:"properties",level:2},{value:"markdownDescription?",id:"markdowndescription",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"name",id:"name",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"severity?",id:"severity",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"status",id:"status",level:3},{value:"Defined in",id:"defined-in-3",level:4}];function h(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",p:"p",strong:"strong",...(0,r.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.header,{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:"defined-in",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L4442",children:"packages/extension-api/src/extension-api.d.ts:4442"})}),"\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:"defined-in-1",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L4430",children:"packages/extension-api/src/extension-api.d.ts:4430"})}),"\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:"defined-in-2",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L4438",children:"packages/extension-api/src/extension-api.d.ts:4438"})}),"\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:"defined-in-3",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L4434",children:"packages/extension-api/src/extension-api.d.ts:4434"})})]})}function l(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(h,{...e})}):h(e)}},43023:(e,n,i)=>{i.d(n,{R:()=>c,x:()=>d});var s=i(63696);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 d(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([[24478],{44710:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>a,contentTitle:()=>c,default:()=>l,frontMatter:()=>t,metadata:()=>d,toc:()=>o});var s=i(62540),r=i(43023);const t={},c="Interface: ImageCheck",d={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={},o=[{value:"Properties",id:"properties",level:2},{value:"markdownDescription?",id:"markdowndescription",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"name",id:"name",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"severity?",id:"severity",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"status",id:"status",level:3},{value:"Defined in",id:"defined-in-3",level:4}];function h(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",p:"p",strong:"strong",...(0,r.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.header,{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:"defined-in",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L4442",children:"packages/extension-api/src/extension-api.d.ts:4442"})}),"\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:"defined-in-1",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L4430",children:"packages/extension-api/src/extension-api.d.ts:4430"})}),"\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:"defined-in-2",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L4438",children:"packages/extension-api/src/extension-api.d.ts:4438"})}),"\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:"defined-in-3",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L4434",children:"packages/extension-api/src/extension-api.d.ts:4434"})})]})}function l(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(h,{...e})}):h(e)}},43023:(e,n,i)=>{i.d(n,{R:()=>c,x:()=>d});var s=i(63696);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 d(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 diff --git a/assets/js/fd702dc7.4376bde7.js b/assets/js/fd702dc7.64b826e1.js similarity index 97% rename from assets/js/fd702dc7.4376bde7.js rename to assets/js/fd702dc7.64b826e1.js index 0c4337ffa29..cc54db20d77 100644 --- a/assets/js/fd702dc7.4376bde7.js +++ b/assets/js/fd702dc7.64b826e1.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[50024],{92466:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>r,default:()=>p,frontMatter:()=>o,metadata:()=>c,toc:()=>l});var s=t(62540),i=t(43023);const o={},r="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:"Defined in",id:"defined-in",level:4}];function d(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",p:"p",strong:"strong",...(0,i.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.header,{children:(0,s.jsx)(n.h1,{id:"interface-webviewoptions",children:"Interface: WebviewOptions"})}),"\n",(0,s.jsx)(n.p,{children:"Content settings for a webview."}),"\n",(0,s.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,s.jsx)(n.h3,{id:"localresourceroots",children:"localResourceRoots?"}),"\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.code,{children:"optional"})," ",(0,s.jsx)(n.strong,{children:"localResourceRoots"}),": readonly ",(0,s.jsx)(n.a,{href:"/api/classes/Uri",children:(0,s.jsx)(n.code,{children:"Uri"})}),"[]"]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:["Root paths from which the webview can load local (filesystem) resources using uris from ",(0,s.jsx)(n.code,{children:"asWebviewUri"})]}),"\n",(0,s.jsx)(n.p,{children:"Default to the root folders of the current workspace plus the extension's install directory."}),"\n",(0,s.jsx)(n.p,{children:"Pass in an empty array to disallow access to any local resources."}),"\n",(0,s.jsx)(n.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L1692",children:"packages/extension-api/src/extension-api.d.ts:1692"})})]})}function p(e={}){const{wrapper:n}={...(0,i.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(d,{...e})}):d(e)}},43023:(e,n,t)=>{t.d(n,{R:()=>r,x:()=>c});var s=t(63696);const i={},o=s.createContext(i);function r(e){const n=s.useContext(o);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:r(e.components),s.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[50024],{92466:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>r,default:()=>p,frontMatter:()=>o,metadata:()=>c,toc:()=>l});var s=t(62540),i=t(43023);const o={},r="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:"Defined in",id:"defined-in",level:4}];function d(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",p:"p",strong:"strong",...(0,i.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.header,{children:(0,s.jsx)(n.h1,{id:"interface-webviewoptions",children:"Interface: WebviewOptions"})}),"\n",(0,s.jsx)(n.p,{children:"Content settings for a webview."}),"\n",(0,s.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,s.jsx)(n.h3,{id:"localresourceroots",children:"localResourceRoots?"}),"\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.code,{children:"optional"})," ",(0,s.jsx)(n.strong,{children:"localResourceRoots"}),": readonly ",(0,s.jsx)(n.a,{href:"/api/classes/Uri",children:(0,s.jsx)(n.code,{children:"Uri"})}),"[]"]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:["Root paths from which the webview can load local (filesystem) resources using uris from ",(0,s.jsx)(n.code,{children:"asWebviewUri"})]}),"\n",(0,s.jsx)(n.p,{children:"Default to the root folders of the current workspace plus the extension's install directory."}),"\n",(0,s.jsx)(n.p,{children:"Pass in an empty array to disallow access to any local resources."}),"\n",(0,s.jsx)(n.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L1692",children:"packages/extension-api/src/extension-api.d.ts:1692"})})]})}function p(e={}){const{wrapper:n}={...(0,i.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(d,{...e})}):d(e)}},43023:(e,n,t)=>{t.d(n,{R:()=>r,x:()=>c});var s=t(63696);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/fe1a05e2.fe6dd7d0.js b/assets/js/fe1a05e2.b71397d4.js similarity index 96% rename from assets/js/fe1a05e2.fe6dd7d0.js rename to assets/js/fe1a05e2.b71397d4.js index c3d992abb31..5856bf2258f 100644 --- a/assets/js/fe1a05e2.fe6dd7d0.js +++ b/assets/js/fe1a05e2.b71397d4.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[31438],{96422:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>c,contentTitle:()=>o,default:()=>p,frontMatter:()=>i,metadata:()=>a,toc:()=>d});var t=r(62540),s=r(43023);const i={},o="Function: registerProviderMenuItem()",a={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:"window",permalink:"/api/namespaces/window/"}},c={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Defined in",id:"defined-in",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",strong:"strong",...(0,s.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.header,{children:(0,t.jsx)(n.h1,{id:"function-registerprovidermenuitem",children:"Function: registerProviderMenuItem()"})}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"registerProviderMenuItem"}),"(",(0,t.jsx)(n.code,{children:"providerId"}),", ",(0,t.jsx)(n.code,{children:"item"}),"): ",(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:"Creates a menu in the tray for a given Provider"}),"\n",(0,t.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"providerId"}),": ",(0,t.jsx)(n.code,{children:"string"})]}),"\n",(0,t.jsx)(n.p,{children:"the same as the id on Provider provided by createProvider() method, need to place menu item properly"}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"item"}),": ",(0,t.jsx)(n.a,{href:"/api/interfaces/MenuItem",children:(0,t.jsx)(n.code,{children:"MenuItem"})})]}),"\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:"defined-in",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L948",children:"packages/extension-api/src/extension-api.d.ts:948"})})]})}function p(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},43023:(e,n,r)=>{r.d(n,{R:()=>o,x:()=>a});var t=r(63696);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 a(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:o(e.components),t.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[31438],{96422:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>c,contentTitle:()=>o,default:()=>p,frontMatter:()=>i,metadata:()=>a,toc:()=>d});var t=r(62540),s=r(43023);const i={},o="Function: registerProviderMenuItem()",a={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:"window",permalink:"/api/namespaces/window/"}},c={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Defined in",id:"defined-in",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",strong:"strong",...(0,s.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.header,{children:(0,t.jsx)(n.h1,{id:"function-registerprovidermenuitem",children:"Function: registerProviderMenuItem()"})}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"registerProviderMenuItem"}),"(",(0,t.jsx)(n.code,{children:"providerId"}),", ",(0,t.jsx)(n.code,{children:"item"}),"): ",(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:"Creates a menu in the tray for a given Provider"}),"\n",(0,t.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"providerId"}),": ",(0,t.jsx)(n.code,{children:"string"})]}),"\n",(0,t.jsx)(n.p,{children:"the same as the id on Provider provided by createProvider() method, need to place menu item properly"}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"item"}),": ",(0,t.jsx)(n.a,{href:"/api/interfaces/MenuItem",children:(0,t.jsx)(n.code,{children:"MenuItem"})})]}),"\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:"defined-in",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L948",children:"packages/extension-api/src/extension-api.d.ts:948"})})]})}function p(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},43023:(e,n,r)=>{r.d(n,{R:()=>o,x:()=>a});var t=r(63696);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 a(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/fe716911.70078c31.js b/assets/js/fe716911.5b4c2bdb.js similarity index 89% rename from assets/js/fe716911.70078c31.js rename to assets/js/fe716911.5b4c2bdb.js index fb7f1a32abb..2fcb5e90e90 100644 --- a/assets/js/fe716911.70078c31.js +++ b/assets/js/fe716911.5b4c2bdb.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[36273],{19276:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>r,contentTitle:()=>t,default:()=>h,frontMatter:()=>d,metadata:()=>o,toc:()=>a});var s=i(62540),c=i(43023);const d={},t="Interface: CheckResult",o={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"}},r={},a=[{value:"Properties",id:"properties",level:2},{value:"description?",id:"description",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"docLinks?",id:"doclinks",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"docLinksDescription?",id:"doclinksdescription",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"fixCommand?",id:"fixcommand",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"successful",id:"successful",level:3},{value:"Defined in",id:"defined-in-4",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",p:"p",strong:"strong",...(0,c.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.header,{children:(0,s.jsx)(n.h1,{id:"interface-checkresult",children:"Interface: CheckResult"})}),"\n",(0,s.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,s.jsx)(n.h3,{id:"description",children:"description?"}),"\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:"description"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L546",children:"packages/extension-api/src/extension-api.d.ts:546"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"doclinks",children:"docLinks?"}),"\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:"docLinks"}),": ",(0,s.jsx)(n.a,{href:"/api/interfaces/Link",children:(0,s.jsx)(n.code,{children:"Link"})}),"[]"]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L548",children:"packages/extension-api/src/extension-api.d.ts:548"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"doclinksdescription",children:"docLinksDescription?"}),"\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:"docLinksDescription"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-2",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L547",children:"packages/extension-api/src/extension-api.d.ts:547"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"fixcommand",children:"fixCommand?"}),"\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:"fixCommand"}),": ",(0,s.jsx)(n.a,{href:"/api/interfaces/CheckResultFixCommand",children:(0,s.jsx)(n.code,{children:"CheckResultFixCommand"})})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-3",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L549",children:"packages/extension-api/src/extension-api.d.ts:549"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"successful",children:"successful"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"successful"}),": ",(0,s.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-4",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L545",children:"packages/extension-api/src/extension-api.d.ts:545"})})]})}function h(e={}){const{wrapper:n}={...(0,c.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},43023:(e,n,i)=>{i.d(n,{R:()=>t,x:()=>o});var s=i(63696);const c={},d=s.createContext(c);function t(e){const n=s.useContext(d);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:t(e.components),s.createElement(d.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[36273],{19276:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>r,contentTitle:()=>t,default:()=>h,frontMatter:()=>d,metadata:()=>o,toc:()=>a});var s=i(62540),c=i(43023);const d={},t="Interface: CheckResult",o={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"}},r={},a=[{value:"Properties",id:"properties",level:2},{value:"description?",id:"description",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"docLinks?",id:"doclinks",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"docLinksDescription?",id:"doclinksdescription",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"fixCommand?",id:"fixcommand",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"successful",id:"successful",level:3},{value:"Defined in",id:"defined-in-4",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",p:"p",strong:"strong",...(0,c.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.header,{children:(0,s.jsx)(n.h1,{id:"interface-checkresult",children:"Interface: CheckResult"})}),"\n",(0,s.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,s.jsx)(n.h3,{id:"description",children:"description?"}),"\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:"description"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L546",children:"packages/extension-api/src/extension-api.d.ts:546"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"doclinks",children:"docLinks?"}),"\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:"docLinks"}),": ",(0,s.jsx)(n.a,{href:"/api/interfaces/Link",children:(0,s.jsx)(n.code,{children:"Link"})}),"[]"]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L548",children:"packages/extension-api/src/extension-api.d.ts:548"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"doclinksdescription",children:"docLinksDescription?"}),"\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:"docLinksDescription"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-2",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L547",children:"packages/extension-api/src/extension-api.d.ts:547"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"fixcommand",children:"fixCommand?"}),"\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:"fixCommand"}),": ",(0,s.jsx)(n.a,{href:"/api/interfaces/CheckResultFixCommand",children:(0,s.jsx)(n.code,{children:"CheckResultFixCommand"})})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-3",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L549",children:"packages/extension-api/src/extension-api.d.ts:549"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"successful",children:"successful"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"successful"}),": ",(0,s.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-4",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L545",children:"packages/extension-api/src/extension-api.d.ts:545"})})]})}function h(e={}){const{wrapper:n}={...(0,c.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},43023:(e,n,i)=>{i.d(n,{R:()=>t,x:()=>o});var s=i(63696);const c={},d=s.createContext(c);function t(e){const n=s.useContext(d);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:t(e.components),s.createElement(d.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/fee0a0be.4b7cc891.js b/assets/js/fee0a0be.5f886d61.js similarity index 85% rename from assets/js/fee0a0be.4b7cc891.js rename to assets/js/fee0a0be.5f886d61.js index 5fbcb989ac4..a365e3f593b 100644 --- a/assets/js/fee0a0be.4b7cc891.js +++ b/assets/js/fee0a0be.5f886d61.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[75315],{44124:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>t,contentTitle:()=>o,default:()=>h,frontMatter:()=>r,metadata:()=>a,toc:()=>c});var s=i(62540),d=i(43023);const r={},o="Interface: ContainerEngineInfo",a={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={},c=[{value:"Properties",id:"properties",level:2},{value:"cpuIdle?",id:"cpuidle",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"cpus?",id:"cpus",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"diskSize?",id:"disksize",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"diskUsed?",id:"diskused",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"engineId",id:"engineid",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"engineName",id:"enginename",level:3},{value:"Defined in",id:"defined-in-5",level:4},{value:"engineType",id:"enginetype",level:3},{value:"Defined in",id:"defined-in-6",level:4},{value:"memory?",id:"memory",level:3},{value:"Defined in",id:"defined-in-7",level:4},{value:"memoryUsed?",id:"memoryused",level:3},{value:"Defined in",id:"defined-in-8",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",p:"p",strong:"strong",...(0,d.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.header,{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:"defined-in",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L3381",children:"packages/extension-api/src/extension-api.d.ts:3381"})}),"\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:"defined-in-1",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L3377",children:"packages/extension-api/src/extension-api.d.ts:3377"})}),"\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:"defined-in-2",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L3393",children:"packages/extension-api/src/extension-api.d.ts:3393"})}),"\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:"defined-in-3",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L3397",children:"packages/extension-api/src/extension-api.d.ts:3397"})}),"\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:"defined-in-4",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L3365",children:"packages/extension-api/src/extension-api.d.ts:3365"})}),"\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:"defined-in-5",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L3369",children:"packages/extension-api/src/extension-api.d.ts:3369"})}),"\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:"defined-in-6",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L3373",children:"packages/extension-api/src/extension-api.d.ts:3373"})}),"\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:"defined-in-7",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L3385",children:"packages/extension-api/src/extension-api.d.ts:3385"})}),"\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:"defined-in-8",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L3389",children:"packages/extension-api/src/extension-api.d.ts:3389"})})]})}function h(e={}){const{wrapper:n}={...(0,d.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},43023:(e,n,i)=>{i.d(n,{R:()=>o,x:()=>a});var s=i(63696);const d={},r=s.createContext(d);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(d):e.components||d:o(e.components),s.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[75315],{44124:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>a,contentTitle:()=>o,default:()=>h,frontMatter:()=>r,metadata:()=>c,toc:()=>t});var s=i(62540),d=i(43023);const r={},o="Interface: ContainerEngineInfo",c={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"}},a={},t=[{value:"Properties",id:"properties",level:2},{value:"cpuIdle?",id:"cpuidle",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"cpus?",id:"cpus",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"diskSize?",id:"disksize",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"diskUsed?",id:"diskused",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"engineId",id:"engineid",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"engineName",id:"enginename",level:3},{value:"Defined in",id:"defined-in-5",level:4},{value:"engineType",id:"enginetype",level:3},{value:"Defined in",id:"defined-in-6",level:4},{value:"memory?",id:"memory",level:3},{value:"Defined in",id:"defined-in-7",level:4},{value:"memoryUsed?",id:"memoryused",level:3},{value:"Defined in",id:"defined-in-8",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",p:"p",strong:"strong",...(0,d.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.header,{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:"defined-in",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L3381",children:"packages/extension-api/src/extension-api.d.ts:3381"})}),"\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:"defined-in-1",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L3377",children:"packages/extension-api/src/extension-api.d.ts:3377"})}),"\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:"defined-in-2",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L3393",children:"packages/extension-api/src/extension-api.d.ts:3393"})}),"\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:"defined-in-3",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L3397",children:"packages/extension-api/src/extension-api.d.ts:3397"})}),"\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:"defined-in-4",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L3365",children:"packages/extension-api/src/extension-api.d.ts:3365"})}),"\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:"defined-in-5",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L3369",children:"packages/extension-api/src/extension-api.d.ts:3369"})}),"\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:"defined-in-6",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L3373",children:"packages/extension-api/src/extension-api.d.ts:3373"})}),"\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:"defined-in-7",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L3385",children:"packages/extension-api/src/extension-api.d.ts:3385"})}),"\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:"defined-in-8",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L3389",children:"packages/extension-api/src/extension-api.d.ts:3389"})})]})}function h(e={}){const{wrapper:n}={...(0,d.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},43023:(e,n,i)=>{i.d(n,{R:()=>o,x:()=>c});var s=i(63696);const d={},r=s.createContext(d);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(d):e.components||d:o(e.components),s.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/fefd9738.a8978888.js b/assets/js/fefd9738.3351c54e.js similarity index 96% rename from assets/js/fefd9738.a8978888.js rename to assets/js/fefd9738.3351c54e.js index 141b18f6c5a..51a4b194b1b 100644 --- a/assets/js/fefd9738.a8978888.js +++ b/assets/js/fefd9738.3351c54e.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[88375],{33652:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>l,contentTitle:()=>t,default:()=>h,frontMatter:()=>a,metadata:()=>r,toc:()=>o});var i=s(62540),c=s(43023);const a={},t="Function: onDidChange()",r={id:"namespaces/cli/functions/onDidChange",title:"Function: onDidChange()",description:"onDidChange(listener, thisArgs?, disposables?): Disposable",source:"@site/api/namespaces/cli/functions/onDidChange.md",sourceDirName:"namespaces/cli/functions",slug:"/namespaces/cli/functions/onDidChange",permalink:"/api/namespaces/cli/functions/onDidChange",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"getCliTool",permalink:"/api/namespaces/cli/functions/getCliTool"},next:{title:"commands",permalink:"/api/namespaces/commands/"}},l={},o=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Defined in",id:"defined-in",level:2}];function d(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",strong:"strong",...(0,c.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.header,{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:"cli.all"})," changes. This can happen when cli 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.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:"defined-in",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L4420",children:"packages/extension-api/src/extension-api.d.ts:4420"})})]})}function h(e={}){const{wrapper:n}={...(0,c.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(d,{...e})}):d(e)}},43023:(e,n,s)=>{s.d(n,{R:()=>t,x:()=>r});var i=s(63696);const c={},a=i.createContext(c);function t(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(c):e.components||c:t(e.components),i.createElement(a.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[88375],{33652:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>l,contentTitle:()=>t,default:()=>h,frontMatter:()=>a,metadata:()=>r,toc:()=>o});var i=s(62540),c=s(43023);const a={},t="Function: onDidChange()",r={id:"namespaces/cli/functions/onDidChange",title:"Function: onDidChange()",description:"onDidChange(listener, thisArgs?, disposables?): Disposable",source:"@site/api/namespaces/cli/functions/onDidChange.md",sourceDirName:"namespaces/cli/functions",slug:"/namespaces/cli/functions/onDidChange",permalink:"/api/namespaces/cli/functions/onDidChange",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"getCliTool",permalink:"/api/namespaces/cli/functions/getCliTool"},next:{title:"commands",permalink:"/api/namespaces/commands/"}},l={},o=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Defined in",id:"defined-in",level:2}];function d(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",strong:"strong",...(0,c.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.header,{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:"cli.all"})," changes. This can happen when cli 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.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:"defined-in",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L4420",children:"packages/extension-api/src/extension-api.d.ts:4420"})})]})}function h(e={}){const{wrapper:n}={...(0,c.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(d,{...e})}):d(e)}},43023:(e,n,s)=>{s.d(n,{R:()=>t,x:()=>r});var i=s(63696);const c={},a=i.createContext(c);function t(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(c):e.components||c:t(e.components),i.createElement(a.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/ff2f63f6.1ab5df77.js b/assets/js/ff2f63f6.9005ac65.js similarity index 95% rename from assets/js/ff2f63f6.1ab5df77.js rename to assets/js/ff2f63f6.9005ac65.js index ffb6c59ae2c..1e9bf90bb98 100644 --- a/assets/js/ff2f63f6.1ab5df77.js +++ b/assets/js/ff2f63f6.9005ac65.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[28154],{80360:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>o,contentTitle:()=>i,default:()=>l,frontMatter:()=>s,metadata:()=>c,toc:()=>d});var r=n(62540),a=n(43023);const s={},i="Interface: SecretStorageChangeEvent",c={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"}},o={},d=[{value:"Properties",id:"properties",level:2},{value:"key",id:"key",level:3},{value:"Defined in",id:"defined-in",level:4}];function h(e){const t={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",p:"p",strong:"strong",...(0,a.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(t.header,{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:"defined-in",children:"Defined in"}),"\n",(0,r.jsx)(t.p,{children:(0,r.jsx)(t.a,{href:"https://github.com/containers/podman-desktop/blob/13577e14ec4ae24a352df23ae096812d4eeaf026/packages/extension-api/src/extension-api.d.ts#L4556",children:"packages/extension-api/src/extension-api.d.ts:4556"})})]})}function l(e={}){const{wrapper:t}={...(0,a.R)(),...e.components};return t?(0,r.jsx)(t,{...e,children:(0,r.jsx)(h,{...e})}):h(e)}},43023:(e,t,n)=>{n.d(t,{R:()=>i,x:()=>c});var r=n(63696);const a={},s=r.createContext(a);function i(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(a):e.components||a:i(e.components),r.createElement(s.Provider,{value:t},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[28154],{80360:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>o,contentTitle:()=>i,default:()=>l,frontMatter:()=>s,metadata:()=>c,toc:()=>d});var r=n(62540),a=n(43023);const s={},i="Interface: SecretStorageChangeEvent",c={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"}},o={},d=[{value:"Properties",id:"properties",level:2},{value:"key",id:"key",level:3},{value:"Defined in",id:"defined-in",level:4}];function h(e){const t={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",p:"p",strong:"strong",...(0,a.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(t.header,{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:"defined-in",children:"Defined in"}),"\n",(0,r.jsx)(t.p,{children:(0,r.jsx)(t.a,{href:"https://github.com/containers/podman-desktop/blob/8754805bf092ada9b82519ba7f46e0af0cc5e003/packages/extension-api/src/extension-api.d.ts#L4556",children:"packages/extension-api/src/extension-api.d.ts:4556"})})]})}function l(e={}){const{wrapper:t}={...(0,a.R)(),...e.components};return t?(0,r.jsx)(t,{...e,children:(0,r.jsx)(h,{...e})}):h(e)}},43023:(e,t,n)=>{n.d(t,{R:()=>i,x:()=>c});var r=n(63696);const a={},s=r.createContext(a);function i(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(a):e.components||a:i(e.components),r.createElement(s.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/runtime~main.3ac797b7.js b/assets/js/runtime~main.1a6d56cb.js similarity index 64% rename from assets/js/runtime~main.3ac797b7.js rename to assets/js/runtime~main.1a6d56cb.js index 6d1a9a05cb9..ddfa4c658f4 100644 --- a/assets/js/runtime~main.3ac797b7.js +++ b/assets/js/runtime~main.1a6d56cb.js @@ -1 +1 @@ -(()=>{"use strict";var e,a,c,f,d,b={},r={};function t(e){var a=r[e];if(void 0!==a)return a.exports;var c=r[e]={exports:{}};return b[e].call(c.exports,c,c.exports,t),c.exports}t.m=b,e=[],t.O=(a,c,f,d)=>{if(!c){var b=1/0;for(n=0;n=d)&&Object.keys(t.O).every((e=>t.O[e](c[o])))?c.splice(o--,1):(r=!1,d0&&e[n-1][2]>d;n--)e[n]=e[n-1];e[n]=[c,f,d]},t.n=e=>{var a=e&&e.__esModule?()=>e.default:()=>e;return t.d(a,{a:a}),a},c=Object.getPrototypeOf?e=>Object.getPrototypeOf(e):e=>e.__proto__,t.t=function(e,f){if(1&f&&(e=this(e)),8&f)return e;if("object"==typeof e&&e){if(4&f&&e.__esModule)return e;if(16&f&&"function"==typeof e.then)return e}var d=Object.create(null);t.r(d);var b={};a=a||[null,c({}),c([]),c(c)];for(var r=2&f&&e;"object"==typeof r&&!~a.indexOf(r);r=c(r))Object.getOwnPropertyNames(r).forEach((a=>b[a]=()=>e[a]));return b.default=()=>e,t.d(d,b),d},t.d=(e,a)=>{for(var c in a)t.o(a,c)&&!t.o(e,c)&&Object.defineProperty(e,c,{enumerable:!0,get:a[c]})},t.f={},t.e=e=>Promise.all(Object.keys(t.f).reduce(((a,c)=>(t.f[c](e,a),a)),[])),t.u=e=>"assets/js/"+({473:"9dce5486",772:"5c0f0993",812:"c6aad055",836:"14ae68e7",1171:"0029a336",1603:"7258860f",1647:"9af13eab",2026:"35300761",2134:"10ce918d",2139:"3c39daba",2172:"3e2b82eb",2334:"87a5fc8a",2449:"00e9d6a1",2571:"164937d2",3e3:"ada86621",3085:"a3002291",3392:"reactPlayerVidyard",3724:"35dda5a2",3962:"a2ffcc0f",4024:"d1462701",4406:"3f29ba7c",4769:"86f2a982",5004:"8abd0ba5",5187:"fe0d4a0f",5276:"4b39f818",5451:"adcef0a2",5556:"46b3c144",5569:"10091836",5646:"473de3ed",5787:"708d858d",6121:"d83404a8",6463:"reactPlayerKaltura",6704:"1ee92283",7327:"4b8121dd",7406:"6aa0b043",7446:"48b6ff5f",7568:"c104141c",7766:"3ba80b69",7832:"fc8a94e3",8078:"5046ea8f",8209:"01a85c17",8402:"6269f1c0",8826:"640277b9",8848:"d178b2c6",8870:"7e2ae3df",8936:"67fccd64",9072:"94324b0e",9332:"f890fec4",9383:"cc922df3",9426:"2d629ea6",9527:"f16d562f",9647:"5e95c892",9767:"a08dfa31",9962:"014457dd",10010:"878aa0e7",10107:"23b35f70",10673:"e44de27e",10906:"e1a2ab10",11022:"a9fa5b1f",11084:"e6c31e60",11173:"28d80fa9",11532:"f7c9e078",11568:"6d8c157a",12036:"d651e2ee",12042:"reactPlayerTwitch",12065:"f9fb4395",12248:"9a22c80d",12286:"be228752",12401:"6bf124c2",12618:"23a8e291",12978:"871ce139",13037:"591f7a5f",13365:"da802cf4",13579:"70e3b13c",13589:"6c80b6fe",13680:"9c540f0b",13920:"a334b453",14036:"b8ec852b",14061:"5087625a",14330:"bd45720e",15405:"f6cf66bc",15607:"5a7aef43",15663:"9dd60997",15746:"5a3b561f",15910:"bd65ec7e",15974:"7be672a3",15985:"e6fb1369",16100:"4f9d299b",16115:"22e2140b",16256:"6eafe0c7",16328:"reactPlayerDailyMotion",16344:"610f2c47",16425:"30a9912a",16583:"0c14b239",16709:"7afa6340",17043:"8b4dd820",17148:"34767260",17159:"308aae28",17242:"4974f5d2",17349:"0cab2b3a",17387:"7144043e",17397:"db320b4a",17652:"07305c4a",17656:"56a9df4f",17796:"62e21724",17853:"5db8318c",18038:"9f2f2cb3",18121:"3a2db09e",18146:"c15d9823",18401:"17896441",18445:"5a9a7a02",18446:"reactPlayerYouTube",18538:"f4271232",18557:"4780c642",18609:"6101b3fc",18687:"17c68348",19060:"b678a236",19150:"1a906644",19763:"65a10ffa",19789:"edb40f78",19810:"75281220",20044:"524ce9a0",20153:"fff8aeb8",20228:"6494b798",20286:"b66ca8cf",21076:"8ae04122",21126:"107d77e6",21381:"0f54081d",21407:"724f3974",21791:"9db962b6",21817:"c1584a80",22051:"adfdec4a",22319:"09788c0c",22405:"0547cb65",22496:"44287967",22778:"f523fb3f",23512:"006e489c",23767:"ca1234c1",23960:"74b658de",24279:"df203c0f",24478:"fc923f19",24593:"4ec76dfa",24639:"97a89ac0",24915:"82170cf7",25184:"e546fc5a",25320:"91392348",25492:"3a38a610",25670:"280646e4",25774:"b9287eb6",26168:"e983a6d7",26173:"reactPlayerVimeo",26600:"360dc931",26693:"368cce37",26716:"1515c895",26929:"311d0508",27262:"fb50ea3a",27895:"d496897e",27902:"2f8f53cb",28154:"ff2f63f6",28341:"60c82955",28645:"f20efc55",28728:"a00af9f0",28757:"a4794f2e",28903:"5df556a2",28917:"ea3ffc82",29099:"7e93d479",29634:"b39cdcf9",29744:"9f90a44b",29824:"f1ad83b2",30487:"814402d7",30784:"cd343213",30862:"4d71dffe",30962:"ba5b9f11",31438:"fe1a05e2",31502:"ed603d23",31652:"30997935",31672:"04a546a4",31681:"cabda5f8",31718:"4b66c45e",31774:"d1c21237",32428:"d9673b17",32467:"c25913f3",32500:"901c37e5",32689:"cd7fa15a",32923:"12f1535e",32993:"185c52e7",33167:"ca6c9efa",33195:"b799648a",33253:"a2c6f402",33294:"71748509",33331:"09b168a7",33582:"81b69ac7",34055:"b5114993",34293:"2340b3ee",34318:"8eeedb31",34415:"a0323d9f",34428:"07f59c2a",34583:"1df93b7f",34918:"c9cac9d9",34939:"bab44fba",35111:"7547d3bb",35129:"e665718d",35258:"d83f208d",35272:"883e2c3c",35327:"d739767a",35515:"f771dec1",35634:"4bdb36b8",35644:"64bd32f2",35716:"dec87402",35742:"aba21aa0",36049:"3109d9d2",36104:"a3f8794a",36273:"fe716911",36353:"reactPlayerPreview",36574:"b6d76a6c",36901:"8dbb6800",37012:"e7923b27",37163:"cb0f21df",37561:"6477cdc2",37643:"a6aa9e1f",37709:"562ca3e9",37736:"d1163e47",38311:"c71cae97",38341:"512fbd77",38752:"d7fbbe43",38788:"7c7a772e",38802:"3b68f98c",38843:"3462068c",38947:"ef8b811a",39004:"01821883",39164:"46669adc",39498:"97eb992d",39590:"b51a9aee",40098:"7fa133e1",40117:"9c65fea5",40228:"815c93fd",40296:"16914cba",40304:"bb6a5560",40532:"0e3a398f",40555:"f6cd0d3d",40611:"148448cb",40793:"0433ef30",41052:"dc23cd40",41067:"e69dadab",41266:"64abd3af",41340:"bd80aa65",41382:"10210328",41697:"4ec4c6cd",41789:"64134c03",41949:"6b1fbd0a",42586:"e064f6d4",42607:"3866940b",42950:"8a864d1e",43079:"8fe4c488",43140:"786fee93",43164:"43f3fe28",43169:"caddb1c0",43307:"bf11c6a2",43320:"46cf64bb",43425:"5b10a003",43665:"3f797343",44183:"f86eb50f",44261:"2bbe04e6",44362:"f431c910",44413:"70bd0abb",44462:"7d3ae564",44693:"5b7d9ef2",45226:"b52d840d",45759:"160cb329",45802:"b3b7dd16",46252:"b15eeff9",46398:"33a21d7d",46666:"c2911623",46741:"d1b15a6d",46850:"8b4ba22f",47008:"22de4147",47422:"1949cc8d",47479:"e6163b65",47627:"reactPlayerStreamable",47798:"2f195bb0",48130:"f81c1134",48279:"981d19db",48374:"56c3a9b2",48507:"33f367df",48823:"fb8cd692",48909:"71c7597c",49244:"41b2e801",49606:"29931f43",49808:"06a27da2",49819:"7cde3c49",50024:"fd702dc7",50038:"330b5684",50740:"456c0e28",51023:"080a9824",51047:"0e72c11a",51162:"059d1c6a",51181:"e73930cf",51594:"59a6f192",51814:"91a39dd0",52065:"cdf64ea9",52276:"bdb8b81b",52492:"d4bf7e47",52547:"5ebdf64d",52711:"9e4087bc",52723:"reactPlayerMux",52853:"a943bcee",53064:"e84cabb0",53113:"0c4fad6b",53125:"416d4fcf",53203:"17612ae7",53225:"7500e360",53410:"5e30269e",53499:"ab69fe56",53588:"a2d1ff94",53629:"125d93c1",53930:"c1ca9e21",54134:"2f7d01f7",54329:"4816649b",54333:"40d377be",54427:"b2973dc4",54628:"a7777682",54642:"9e8f4e9c",54646:"e35d7c3e",54691:"873d332f",54727:"7aa856d6",54797:"9684f8b7",55251:"8ccdb99f",55259:"aaabcfd8",55395:"cf6b503e",55543:"e7477a94",55756:"deccabf3",55780:"4f425ff4",55807:"a38d285e",55979:"d4840880",56095:"d103759a",56500:"382e0557",56576:"8785b74d",56898:"5e486140",57577:"b5ec5208",57689:"a826efc5",57720:"4213e5b1",57778:"4c217c25",57915:"49bee2be",57947:"93e05602",58699:"ed1f6062",58775:"24dadce3",58796:"8c8ef21f",59310:"e1c8d71f",59660:"ef2e2003",59818:"1c93995d",59911:"065365b3",60102:"df4d464e",60261:"3a4a1d3a",60404:"1369aff7",60441:"1fc83a28",60759:"d46ef83d",61036:"42b67a8e",61216:"2ab17a83",61235:"a7456010",61546:"b5b19789",61634:"c358ebbc",62138:"1a4e3797",62662:"5660752d",62824:"de311ed4",63090:"01a1d0f4",63156:"b9a87183",63805:"17d2ebc8",64147:"ae79aff5",64169:"3d8d8999",64179:"92d7df62",64212:"621db11d",64374:"3132913e",64558:"95646edb",64577:"e38c422a",64605:"ed2a4846",64630:"9d2d4743",64679:"86e64757",65331:"97615df2",65608:"271ff0d1",66045:"3f66023b",66054:"c6346fcf",66414:"c239db97",66622:"814d49b7",67098:"a7bd4aaa",67402:"2bb2c1cd",67472:"814f3328",67570:"reactPlayerMixcloud",67635:"4f35c7a7",67962:"67386898",68026:"3819c331",68170:"7a957b04",68171:"79f18c88",68598:"e88443f3",68660:"c544b2d7",68833:"4c5becac",68860:"c0c3bda5",69183:"38f19abb",69215:"fbfd390f",69325:"c09ab32f",69345:"030ccfd9",69389:"0dd9aaeb",69416:"19eded63",69586:"4f9e8711",69597:"5bc09a53",69656:"38a042e4",69725:"423842d7",69838:"a35cf155",69935:"a847366a",69937:"cecc75bb",69979:"reactPlayerSoundCloud",70062:"91fe1403",70073:"8873cf50",70142:"a7fe0e50",70414:"330dfcdb",70423:"8cb0269b",70540:"ef5945f7",70542:"7bef3f04",70876:"6864e844",70986:"8ca0e442",71728:"688ee267",72231:"ae4a775b",72290:"df2a6e58",72456:"f26f8f05",72526:"8e49e0b0",72972:"97c7db18",73008:"d66cbd9e",73267:"73f18a6f",73318:"97d49594",73425:"cc6d9416",73553:"e0277333",73588:"016e89ec",73607:"450c2e30",73800:"a30c0d44",73946:"54d805e4",74013:"91008145",74190:"2658ced2",74202:"9542c76a",74210:"4cb6c19a",74238:"c5b2f0f9",74260:"81e486a8",74358:"d9407a00",74361:"920c2ac2",74457:"49d9416a",74501:"a9bc0f5d",74785:"a0c37fdd",74937:"39ae3791",75046:"0341d436",75056:"6763d4e0",75204:"cfdfe126",75315:"fee0a0be",75687:"edcfca88",76151:"bc873533",76228:"43be69c9",76430:"0fa6e9bf",76775:"fd684bd6",77350:"9d887a11",77353:"254d0ff5",77546:"1dfee34e",78007:"bc816bf2",78048:"52ea62e7",78110:"b104dd1e",78170:"2cb13d6d",78258:"69c5f318",78349:"5393540e",78434:"7b477840",78465:"021eaa84",78664:"905702d2",78707:"d7ed6ffb",78848:"74c26f41",78989:"12eb386e",79048:"a94703ab",79067:"898514b1",79405:"927c84a6",79594:"e3f28bf9",79683:"aba485c2",79849:"c813bd67",79981:"83245ae6",80042:"b8eb0fce",80348:"e6412603",80353:"ff38b1ce",80714:"714e70d1",80957:"c141421f",81497:"9286a297",81634:"67eba1be",81898:"c2865a15",81903:"acecf23e",81961:"1e582a71",82060:"94f3d131",82219:"b985118d",82244:"8677f412",82479:"1a16e8bf",83249:"ccc49370",83313:"ca165b51",83405:"612345e6",83509:"19e69ccd",83729:"8be8ac58",83976:"0e384e19",83993:"1cfced13",84e3:"bb0cb288",84052:"b7bb2d93",84539:"16ce7fd2",84787:"3720c009",84813:"6875c492",84874:"54590fd2",85193:"7d88b63f",85462:"98ced590",85784:"af231220",86040:"7a21ccb0",86219:"b757e1e0",86244:"9f97f9d1",86693:"c7cac05f",86887:"reactPlayerFacebook",87246:"b4df9b48",87438:"fe9a92c0",87577:"7f0476bd",87986:"d5f6644b",88041:"874690d0",88375:"fefd9738",88499:"57dba496",88576:"78b70dba",88614:"bbf561d5",88623:"db22fd17",88801:"95366386",88930:"5c25e6fa",89507:"6774f806",89634:"180d0c5f",89858:"36994c47",89885:"0877aebd",89904:"73f9658e",90305:"8c6c72f9",90418:"604e05e4",90488:"d9b4ee1e",90619:"49a2e93c",90735:"6e92edd9",90843:"24bda87b",90849:"0058b4c6",90989:"0102eb3e",91638:"232c546d",91643:"7e5a2776",91746:"732d4d9b",92388:"ed75cfcb",92449:"25d1f3de",92456:"c8eb055e",92553:"a33d13d7",92749:"8519c2b0",92834:"c44aa824",93031:"894e67a6",93520:"c361d244",93655:"3d6cee82",93744:"3289a752",93891:"931e3b0a",93897:"6603ef13",94054:"6e30ac7b",94209:"57e01cd5",94365:"cd23aec9",94468:"adb00d9a",94692:"7d9edfb8",94892:"1d31e443",94964:"6eb49eac",95044:"92b08985",95275:"f644aac7",95314:"494e8e75",95322:"b6be2912",95505:"86f8c256",95576:"aca8b082",95645:"abc85917",95696:"825ec378",95904:"b7746a44",96170:"57a8015d",96220:"6a1fe514",96316:"f7197f43",96357:"c2e1e282",96420:"51e516cc",96549:"583db3ef",96831:"25622900",96906:"f0e3a130",97120:"a8ce95ee",97161:"c11c87f7",97331:"1fbe0675",97458:"reactPlayerFilePlayer",97550:"123a454a",97623:"ffbee6a9",98458:"f27eaf88",98537:"fa5f999e",98910:"86063cd3",99340:"reactPlayerWistia",99795:"5fb93fc0",99872:"5e8fbcdf"}[e]||e)+"."+{473:"280d8724",772:"9aac335c",812:"b3d90c80",836:"19a19f4d",1171:"2c40c19a",1333:"1af56771",1603:"8f8035ab",1647:"074366e1",2026:"bb5d790d",2134:"92af30fe",2139:"330cecf3",2172:"d76138d6",2334:"06ded9a9",2449:"99537d09",2571:"480240d3",3e3:"6586846c",3085:"12c231bf",3303:"502d9be6",3392:"26549ee8",3524:"d3b4341b",3686:"c8627c03",3724:"ec5e4f72",3962:"e96db7f9",4024:"6719586b",4406:"46e51d42",4769:"a1df941e",5004:"881101de",5187:"1cc77d8f",5276:"405c3f77",5451:"1a71dc72",5556:"d5d085e3",5569:"73e80872",5618:"d8f19d30",5646:"21f1d33d",5787:"2e4f2a3b",6121:"ca6f7b31",6463:"864fe255",6704:"d90fc574",7327:"4ddc044d",7406:"5c9ed67a",7446:"d360337d",7568:"788d4889",7766:"ba92eb3d",7832:"189ed50f",8078:"7917b32c",8209:"dc80aa6d",8402:"aca3985d",8826:"d947ca26",8848:"9ed0bf55",8870:"2ed3b61d",8936:"b7405619",9072:"e545997a",9332:"d845d953",9383:"4bced26e",9426:"e9795135",9527:"cd0e39f5",9603:"feeda7ba",9647:"136a2d64",9767:"3e2dac4f",9962:"88a57510",10010:"9b8dbe13",10107:"ceb741dc",10673:"8141eebb",10906:"930df6c7",11022:"4f6009ae",11084:"943e3f46",11173:"5850a775",11532:"909f7f8c",11568:"c22677a5",12036:"f14baeca",12042:"ebcda0df",12065:"c6df11b1",12176:"71adad58",12248:"b5e3e719",12286:"52191fac",12401:"f3bc4993",12618:"4d3eb74e",12978:"ac4518c5",13037:"3c101040",13365:"73fb951e",13579:"a0c340fa",13589:"175b6832",13680:"a6ad9d29",13920:"326e36a5",14036:"d63076a1",14061:"5b09bcdf",14330:"cf859d8c",15405:"f440376c",15607:"8acec8ac",15663:"2a5fc285",15746:"7bebb0b2",15910:"9cc2dee0",15974:"ff5ae384",15985:"e6194203",16100:"6510348c",16115:"40a20efd",16256:"ff9c875c",16328:"1cee6458",16344:"a88297e7",16425:"d22aca15",16583:"c3d5ca0d",16709:"4f55effc",17043:"846bca0e",17148:"b97336ef",17159:"a645c04c",17242:"61264935",17349:"f1dc9fb4",17387:"340846c3",17397:"ec53cb3e",17652:"0ebdfb04",17656:"bc21343a",17796:"2950f7b3",17853:"ab24268d",18038:"b14c97b4",18121:"edfc6de2",18146:"36cc4219",18401:"402ade53",18445:"f95f5405",18446:"2f393a2d",18538:"4e2b3ee6",18557:"6e1e1550",18609:"cca17bd5",18687:"5936e890",18973:"dcbaa706",19060:"d3fffd51",19150:"fff6b18b",19763:"2ddc7e94",19789:"4cfdcd59",19810:"72c3f3a2",20044:"ad4045cf",20153:"566289dc",20228:"934c1752",20286:"d727b1fa",21076:"56a6200e",21126:"b9344263",21381:"1f1a3a49",21407:"78647697",21791:"aff8fff5",21817:"9a8d1e30",22051:"33ca9ed3",22319:"93434adb",22405:"79fd4546",22496:"dbe4df9e",22778:"12be248c",23512:"c5577bd1",23767:"a83f4627",23934:"f3126557",23960:"9add0cab",24189:"c249b745",24279:"0a26846f",24478:"5fe4d7e6",24593:"c138b7c5",24639:"edd2c0ad",24915:"6aa47739",25184:"9541bbcf",25320:"0d52704b",25492:"87fddd26",25670:"537d51d8",25681:"261a04cf",25774:"7b0189d4",26026:"f9a02576",26168:"fe23cc41",26173:"231c5de7",26600:"62a5b638",26693:"fee75f49",26716:"29a309e1",26929:"bd8fe717",27262:"574647d3",27717:"d7b090db",27895:"8bbbe56e",27902:"b1bd9c34",28154:"1ab5df77",28341:"8e488dc8",28435:"672816c4",28645:"ae204a70",28697:"6c8e6caa",28728:"263cd739",28757:"98169571",28903:"bb0842cd",28917:"bd0b27a7",29099:"259c9643",29308:"845f2564",29634:"254dc925",29744:"b938caf7",29824:"9c79d00b",30487:"0375673c",30784:"2e0a23c1",30862:"15cd821e",30962:"710a67d9",31438:"fe6dd7d0",31502:"fc876545",31652:"90d4abbf",31672:"8f9617e9",31681:"4073656a",31718:"b7ae637e",31774:"5a0c1d46",32428:"679e95e3",32467:"a9961512",32500:"82061bcf",32588:"a5c46adf",32689:"2e9559c6",32923:"8815e5f8",32993:"42df6b29",33076:"1715d03b",33167:"6f4066fc",33195:"de0fd6b5",33253:"b2930b93",33294:"3c5b06f4",33331:"c884a1fb",33582:"ab480ad4",34055:"f7f3f334",34293:"1bcefee7",34318:"d7c36038",34415:"d9e8cddd",34428:"35f8051c",34583:"01a92f00",34656:"1f20c9c8",34918:"90899ea0",34939:"ef465356",35111:"e2429649",35129:"0110b356",35258:"5f4dafc2",35272:"70088570",35327:"5d9b422c",35515:"afc0a87e",35634:"57a6fb3e",35644:"4098990e",35716:"05619531",35742:"5d49a645",36049:"44f2bcef",36104:"3b27b039",36273:"70078c31",36353:"397a99ee",36574:"34b8fc90",36901:"ca60cfe7",37012:"afe0ba9f",37163:"0c11d352",37561:"e9b7f0a4",37643:"9cc53623",37709:"c3ea0043",37736:"67818520",37955:"d11c416b",38311:"48144dc2",38341:"43198afa",38752:"0930e74a",38788:"8b9f5fad",38802:"babbe266",38843:"c6109b90",38947:"134f3be3",39004:"300660dc",39164:"5034f00d",39498:"a2dd54be",39590:"c227835e",39714:"e3ccdf73",40098:"2e8e6003",40117:"7c6571f5",40228:"a40740f2",40296:"be0d01e2",40304:"a5e5c2c0",40340:"dc84fa42",40504:"7af7708e",40532:"ad06bcb7",40555:"48ecca81",40611:"7b3edab0",40793:"99d64827",41052:"5fc2622d",41067:"b68f4102",41266:"3588bdc7",41340:"42e08eff",41382:"254d3d2f",41697:"fc1a1633",41789:"190148e6",41949:"f04d8334",42586:"04de8f12",42607:"09e20270",42950:"25c36262",43079:"e2ed9058",43140:"29544406",43164:"60e01bd6",43169:"09e95918",43307:"50f0e98e",43320:"e486804e",43425:"df6ca68a",43431:"9871975d",43665:"b9f35c84",44183:"82f67db1",44261:"20fa645f",44362:"faab84a4",44413:"e42ad9ff",44462:"0296631e",44693:"160cb4ae",45226:"66ee9ace",45759:"688bd9c3",45802:"45a34afb",46252:"dfb276e8",46398:"5dd62d1c",46666:"b171cea9",46741:"52477a26",46850:"1b31d04b",47008:"eadf04b4",47422:"3075578f",47479:"4b5f561a",47623:"62f69c95",47627:"5f135999",47798:"3745a376",48130:"d3f8db81",48279:"139797b9",48374:"3233545f",48507:"94acfbde",48823:"f93ea25f",48909:"64b2bda1",49073:"0c3427a9",49244:"aad08605",49606:"f6ea22fa",49808:"4118e3b3",49819:"936a1144",50024:"4376bde7",50038:"86373ac9",50740:"7a2fcb35",51023:"8fd13ebb",51047:"87a4deef",51162:"60870e0c",51181:"27c74c38",51594:"a0d84c5f",51814:"7f215ed1",51822:"7aa2a359",52065:"cf0c74b2",52276:"20bd8559",52492:"9fd9898d",52547:"85d09cf5",52711:"96d2373f",52723:"c5989c0b",52853:"f693a67c",53064:"29116f1d",53113:"39bf846a",53125:"d6be3ff6",53203:"c5143c47",53225:"8a2b8f41",53410:"d6a8fa39",53499:"532d2c61",53588:"24f00837",53629:"bef6c0c3",53930:"d8c7408e",54134:"03a0d248",54329:"88dd8763",54333:"43a445e1",54427:"c281113e",54628:"f2d4a307",54642:"4bfa5536",54646:"91eb9ec7",54691:"de5513fd",54727:"48ac0baa",54797:"0d604612",55251:"e7c57212",55259:"c9fde7e9",55395:"87db4208",55543:"4cef4da0",55756:"170ef08a",55780:"7966511a",55807:"5156b511",55979:"895e383c",56095:"f338dc48",56500:"e71f029d",56576:"538df7a9",56898:"07245d3f",57415:"382226be",57577:"490505ac",57689:"bcbc1181",57720:"ec6fd34f",57778:"f70c8a52",57915:"c99d8a90",57947:"a61eea31",58625:"3cce9597",58699:"7ae7e5da",58775:"17c3ec6c",58796:"cef627e9",59310:"e3b59ac4",59660:"64131ebf",59818:"c92b42b9",59911:"042b108e",60102:"66fe4596",60261:"5b43d10a",60404:"caf568ca",60441:"f01e0cf7",60759:"e7fdae18",61036:"00c64008",61216:"d4e70c76",61235:"d921c339",61473:"d8e284b1",61546:"d7f853bb",61634:"219641a0",62138:"3450920a",62662:"9cd9ee52",62824:"65ff65d3",63090:"c06ba542",63156:"0daeccea",63805:"b1416d2b",64147:"bd657679",64169:"c166c22b",64179:"f4dfb03c",64212:"b552bb9b",64374:"153d7036",64558:"3ebe70b6",64577:"d0c94d36",64605:"50d87ae3",64630:"0d33466c",64679:"7ee90816",65331:"384df7f8",65566:"0b511c9c",65608:"10913cdc",66045:"0b191cd9",66054:"46d68e9a",66414:"3de30ec5",66622:"ce39587b",67098:"4ef1b139",67402:"0270841e",67472:"1f64d18d",67570:"10e3911a",67635:"daae111d",67962:"0446f9f3",68026:"6cee73bc",68170:"b2fa346f",68171:"9d03dc1c",68598:"0921fe3c",68660:"17a530f9",68833:"b0f466a3",68860:"ebedbdf6",69183:"99d69017",69215:"805c7d7c",69325:"1dce7f31",69345:"47c63788",69389:"d358c548",69416:"b86f2ac7",69586:"f09ade23",69597:"a616dee9",69656:"985f0208",69725:"13faa63f",69838:"fac977bb",69935:"7b463c3a",69937:"c2f949a4",69979:"55a971e2",70062:"682c8736",70073:"6b72e911",70142:"c3430b99",70414:"e004bf7b",70423:"15542aa7",70540:"1857533e",70542:"3cac711d",70876:"ecda918a",70986:"c26d2865",71261:"e2407cd4",71728:"2e419df6",72231:"4426b7bc",72290:"d70df1a5",72456:"8722cf96",72526:"a75ed61c",72972:"df480da6",73008:"a1c3f96e",73267:"61b096b7",73318:"b3f60952",73425:"f225b235",73553:"ceccdc76",73588:"ca66c4a3",73607:"977a291b",73800:"abda08c2",73946:"743494aa",74013:"f60afe76",74190:"6f23a9ce",74202:"669940a1",74210:"1d36c93d",74238:"609e970c",74260:"8971d423",74358:"355bc238",74361:"6c4f181c",74457:"4b57632d",74501:"f2654fc0",74785:"46c49879",74937:"05d4fffb",75046:"20142eed",75056:"4ee6f5f4",75204:"c777edc3",75315:"4b7cc891",75687:"3b3d1fbe",76010:"967e9e91",76151:"8a457ede",76228:"24a8a188",76430:"ed7a37dd",76752:"b2b30d75",76775:"88e2f79f",77350:"13679168",77353:"b2f79b13",77546:"a26a51b0",78007:"a6e29a63",78048:"b96a3e8c",78110:"a962e98b",78170:"f3414af3",78258:"9ac358c2",78349:"c83954a1",78434:"5147dd4d",78465:"73b73cec",78664:"3b2e9222",78707:"bfcf089b",78848:"44c19e4b",78989:"3bff7be2",79048:"88610977",79067:"d1ba078c",79405:"5b57bafc",79594:"3a0d14d4",79683:"13db7663",79849:"c32c3aee",79981:"f836251d",80042:"364429a9",80348:"c2cf776d",80353:"72e6ab5e",80714:"6b94b4bf",80957:"2b45b766",81497:"3c016d49",81634:"715f2571",81898:"173826e0",81903:"67a62659",81961:"e1db2648",82060:"d8ff953d",82219:"2c224c0d",82244:"d0a4fa9f",82479:"438ec5af",83249:"47e2e9ba",83313:"61b8ac0e",83405:"1ee3f276",83509:"44b229e2",83729:"de2ed4f5",83976:"700385f9",83993:"b064f926",84e3:"8b8de19a",84052:"65b06945",84539:"1aea1097",84671:"8a77350b",84787:"6030d90f",84813:"d336ff0f",84874:"90be7d30",85145:"fa76a070",85193:"dab23735",85462:"5593af1c",85520:"db1227a4",85784:"10ff5b00",86040:"f118a861",86219:"0bb7f995",86244:"72f267fc",86693:"f42a6390",86887:"7639f87f",87246:"cc214a5f",87438:"3dff9fbc",87577:"c676d743",87986:"3798800d",88041:"31a5cfd3",88375:"a8978888",88499:"dc7274a2",88576:"772bb7c2",88614:"39f175fe",88623:"a2fcddf3",88801:"7aa67542",88930:"17433ee3",89074:"df84199a",89093:"6a7aeebc",89507:"16f35e3b",89634:"731ec28d",89858:"63c2e6ec",89885:"5fc4b403",89904:"ab7eb03f",90305:"49c42fe7",90418:"a47dbf58",90488:"0a9d66ae",90619:"e3f958c4",90735:"200d5588",90843:"7f66d647",90849:"c933951e",90989:"3a21f55e",91638:"e1f5c9e9",91643:"be224f18",91746:"e86b7fa4",92388:"30ab91dc",92449:"b551feb2",92456:"370ed0fe",92553:"c26cc4c8",92749:"810d7e0f",92834:"c1a1c195",93031:"e76b4787",93520:"d6dbf71a",93655:"e091d01b",93744:"73302fec",93891:"2ba77572",93897:"c2303fb9",94054:"5a27fc2c",94209:"dc3646b8",94365:"511e6008",94468:"158b5fb4",94692:"7a273432",94892:"4c9df7d9",94964:"470e417b",95044:"d6d70d3b",95275:"0c9b627d",95314:"1d1085a7",95322:"a0c05ecd",95505:"a2b971b1",95576:"d022ca6a",95601:"84970094",95645:"53c2d97b",95696:"4a5937d3",95904:"792a052a",96170:"ac62bb11",96220:"e5365227",96316:"966be44c",96357:"b5e08f84",96420:"24dbee7c",96549:"e3fad985",96831:"c97d2000",96906:"35285308",97120:"3f3056d3",97161:"c6631228",97331:"5c6c0dcb",97458:"a8e74fc1",97550:"f7e4c3ba",97623:"d7cfc852",98458:"77c25e4f",98537:"c2d51678",98910:"6898e210",99340:"9e33dbe5",99795:"2fe9d526",99872:"e3183753"}[e]+".js",t.miniCssF=e=>{},t.g=function(){if("object"==typeof globalThis)return globalThis;try{return this||new Function("return this")()}catch(e){if("object"==typeof window)return window}}(),t.o=(e,a)=>Object.prototype.hasOwnProperty.call(e,a),f={},d="docs:",t.l=(e,a,c,b)=>{if(f[e])f[e].push(a);else{var r,o;if(void 0!==c)for(var l=document.getElementsByTagName("script"),n=0;n{r.onerror=r.onload=null,clearTimeout(s);var d=f[e];if(delete f[e],r.parentNode&&r.parentNode.removeChild(r),d&&d.forEach((e=>e(c))),a)return a(c)},s=setTimeout(u.bind(null,void 0,{type:"timeout",target:r}),12e4);r.onerror=u.bind(null,r.onerror),r.onload=u.bind(null,r.onload),o&&document.head.appendChild(r)}},t.r=e=>{"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(e,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(e,"__esModule",{value:!0})},t.p="/",t.gca=function(e){return e={10091836:"5569",10210328:"41382",17896441:"18401",25622900:"96831",30997935:"31652",34767260:"17148",35300761:"2026",44287967:"22496",67386898:"67962",71748509:"33294",75281220:"19810",91008145:"74013",91392348:"25320",95366386:"88801","9dce5486":"473","5c0f0993":"772",c6aad055:"812","14ae68e7":"836","0029a336":"1171","7258860f":"1603","9af13eab":"1647","10ce918d":"2134","3c39daba":"2139","3e2b82eb":"2172","87a5fc8a":"2334","00e9d6a1":"2449","164937d2":"2571",ada86621:"3000",a3002291:"3085",reactPlayerVidyard:"3392","35dda5a2":"3724",a2ffcc0f:"3962",d1462701:"4024","3f29ba7c":"4406","86f2a982":"4769","8abd0ba5":"5004",fe0d4a0f:"5187","4b39f818":"5276",adcef0a2:"5451","46b3c144":"5556","473de3ed":"5646","708d858d":"5787",d83404a8:"6121",reactPlayerKaltura:"6463","1ee92283":"6704","4b8121dd":"7327","6aa0b043":"7406","48b6ff5f":"7446",c104141c:"7568","3ba80b69":"7766",fc8a94e3:"7832","5046ea8f":"8078","01a85c17":"8209","6269f1c0":"8402","640277b9":"8826",d178b2c6:"8848","7e2ae3df":"8870","67fccd64":"8936","94324b0e":"9072",f890fec4:"9332",cc922df3:"9383","2d629ea6":"9426",f16d562f:"9527","5e95c892":"9647",a08dfa31:"9767","014457dd":"9962","878aa0e7":"10010","23b35f70":"10107",e44de27e:"10673",e1a2ab10:"10906",a9fa5b1f:"11022",e6c31e60:"11084","28d80fa9":"11173",f7c9e078:"11532","6d8c157a":"11568",d651e2ee:"12036",reactPlayerTwitch:"12042",f9fb4395:"12065","9a22c80d":"12248",be228752:"12286","6bf124c2":"12401","23a8e291":"12618","871ce139":"12978","591f7a5f":"13037",da802cf4:"13365","70e3b13c":"13579","6c80b6fe":"13589","9c540f0b":"13680",a334b453:"13920",b8ec852b:"14036","5087625a":"14061",bd45720e:"14330",f6cf66bc:"15405","5a7aef43":"15607","9dd60997":"15663","5a3b561f":"15746",bd65ec7e:"15910","7be672a3":"15974",e6fb1369:"15985","4f9d299b":"16100","22e2140b":"16115","6eafe0c7":"16256",reactPlayerDailyMotion:"16328","610f2c47":"16344","30a9912a":"16425","0c14b239":"16583","7afa6340":"16709","8b4dd820":"17043","308aae28":"17159","4974f5d2":"17242","0cab2b3a":"17349","7144043e":"17387",db320b4a:"17397","07305c4a":"17652","56a9df4f":"17656","62e21724":"17796","5db8318c":"17853","9f2f2cb3":"18038","3a2db09e":"18121",c15d9823:"18146","5a9a7a02":"18445",reactPlayerYouTube:"18446",f4271232:"18538","4780c642":"18557","6101b3fc":"18609","17c68348":"18687",b678a236:"19060","1a906644":"19150","65a10ffa":"19763",edb40f78:"19789","524ce9a0":"20044",fff8aeb8:"20153","6494b798":"20228",b66ca8cf:"20286","8ae04122":"21076","107d77e6":"21126","0f54081d":"21381","724f3974":"21407","9db962b6":"21791",c1584a80:"21817",adfdec4a:"22051","09788c0c":"22319","0547cb65":"22405",f523fb3f:"22778","006e489c":"23512",ca1234c1:"23767","74b658de":"23960",df203c0f:"24279",fc923f19:"24478","4ec76dfa":"24593","97a89ac0":"24639","82170cf7":"24915",e546fc5a:"25184","3a38a610":"25492","280646e4":"25670",b9287eb6:"25774",e983a6d7:"26168",reactPlayerVimeo:"26173","360dc931":"26600","368cce37":"26693","1515c895":"26716","311d0508":"26929",fb50ea3a:"27262",d496897e:"27895","2f8f53cb":"27902",ff2f63f6:"28154","60c82955":"28341",f20efc55:"28645",a00af9f0:"28728",a4794f2e:"28757","5df556a2":"28903",ea3ffc82:"28917","7e93d479":"29099",b39cdcf9:"29634","9f90a44b":"29744",f1ad83b2:"29824","814402d7":"30487",cd343213:"30784","4d71dffe":"30862",ba5b9f11:"30962",fe1a05e2:"31438",ed603d23:"31502","04a546a4":"31672",cabda5f8:"31681","4b66c45e":"31718",d1c21237:"31774",d9673b17:"32428",c25913f3:"32467","901c37e5":"32500",cd7fa15a:"32689","12f1535e":"32923","185c52e7":"32993",ca6c9efa:"33167",b799648a:"33195",a2c6f402:"33253","09b168a7":"33331","81b69ac7":"33582",b5114993:"34055","2340b3ee":"34293","8eeedb31":"34318",a0323d9f:"34415","07f59c2a":"34428","1df93b7f":"34583",c9cac9d9:"34918",bab44fba:"34939","7547d3bb":"35111",e665718d:"35129",d83f208d:"35258","883e2c3c":"35272",d739767a:"35327",f771dec1:"35515","4bdb36b8":"35634","64bd32f2":"35644",dec87402:"35716",aba21aa0:"35742","3109d9d2":"36049",a3f8794a:"36104",fe716911:"36273",reactPlayerPreview:"36353",b6d76a6c:"36574","8dbb6800":"36901",e7923b27:"37012",cb0f21df:"37163","6477cdc2":"37561",a6aa9e1f:"37643","562ca3e9":"37709",d1163e47:"37736",c71cae97:"38311","512fbd77":"38341",d7fbbe43:"38752","7c7a772e":"38788","3b68f98c":"38802","3462068c":"38843",ef8b811a:"38947","01821883":"39004","46669adc":"39164","97eb992d":"39498",b51a9aee:"39590","7fa133e1":"40098","9c65fea5":"40117","815c93fd":"40228","16914cba":"40296",bb6a5560:"40304","0e3a398f":"40532",f6cd0d3d:"40555","148448cb":"40611","0433ef30":"40793",dc23cd40:"41052",e69dadab:"41067","64abd3af":"41266",bd80aa65:"41340","4ec4c6cd":"41697","64134c03":"41789","6b1fbd0a":"41949",e064f6d4:"42586","3866940b":"42607","8a864d1e":"42950","8fe4c488":"43079","786fee93":"43140","43f3fe28":"43164",caddb1c0:"43169",bf11c6a2:"43307","46cf64bb":"43320","5b10a003":"43425","3f797343":"43665",f86eb50f:"44183","2bbe04e6":"44261",f431c910:"44362","70bd0abb":"44413","7d3ae564":"44462","5b7d9ef2":"44693",b52d840d:"45226","160cb329":"45759",b3b7dd16:"45802",b15eeff9:"46252","33a21d7d":"46398",c2911623:"46666",d1b15a6d:"46741","8b4ba22f":"46850","22de4147":"47008","1949cc8d":"47422",e6163b65:"47479",reactPlayerStreamable:"47627","2f195bb0":"47798",f81c1134:"48130","981d19db":"48279","56c3a9b2":"48374","33f367df":"48507",fb8cd692:"48823","71c7597c":"48909","41b2e801":"49244","29931f43":"49606","06a27da2":"49808","7cde3c49":"49819",fd702dc7:"50024","330b5684":"50038","456c0e28":"50740","080a9824":"51023","0e72c11a":"51047","059d1c6a":"51162",e73930cf:"51181","59a6f192":"51594","91a39dd0":"51814",cdf64ea9:"52065",bdb8b81b:"52276",d4bf7e47:"52492","5ebdf64d":"52547","9e4087bc":"52711",reactPlayerMux:"52723",a943bcee:"52853",e84cabb0:"53064","0c4fad6b":"53113","416d4fcf":"53125","17612ae7":"53203","7500e360":"53225","5e30269e":"53410",ab69fe56:"53499",a2d1ff94:"53588","125d93c1":"53629",c1ca9e21:"53930","2f7d01f7":"54134","4816649b":"54329","40d377be":"54333",b2973dc4:"54427",a7777682:"54628","9e8f4e9c":"54642",e35d7c3e:"54646","873d332f":"54691","7aa856d6":"54727","9684f8b7":"54797","8ccdb99f":"55251",aaabcfd8:"55259",cf6b503e:"55395",e7477a94:"55543",deccabf3:"55756","4f425ff4":"55780",a38d285e:"55807",d4840880:"55979",d103759a:"56095","382e0557":"56500","8785b74d":"56576","5e486140":"56898",b5ec5208:"57577",a826efc5:"57689","4213e5b1":"57720","4c217c25":"57778","49bee2be":"57915","93e05602":"57947",ed1f6062:"58699","24dadce3":"58775","8c8ef21f":"58796",e1c8d71f:"59310",ef2e2003:"59660","1c93995d":"59818","065365b3":"59911",df4d464e:"60102","3a4a1d3a":"60261","1369aff7":"60404","1fc83a28":"60441",d46ef83d:"60759","42b67a8e":"61036","2ab17a83":"61216",a7456010:"61235",b5b19789:"61546",c358ebbc:"61634","1a4e3797":"62138","5660752d":"62662",de311ed4:"62824","01a1d0f4":"63090",b9a87183:"63156","17d2ebc8":"63805",ae79aff5:"64147","3d8d8999":"64169","92d7df62":"64179","621db11d":"64212","3132913e":"64374","95646edb":"64558",e38c422a:"64577",ed2a4846:"64605","9d2d4743":"64630","86e64757":"64679","97615df2":"65331","271ff0d1":"65608","3f66023b":"66045",c6346fcf:"66054",c239db97:"66414","814d49b7":"66622",a7bd4aaa:"67098","2bb2c1cd":"67402","814f3328":"67472",reactPlayerMixcloud:"67570","4f35c7a7":"67635","3819c331":"68026","7a957b04":"68170","79f18c88":"68171",e88443f3:"68598",c544b2d7:"68660","4c5becac":"68833",c0c3bda5:"68860","38f19abb":"69183",fbfd390f:"69215",c09ab32f:"69325","030ccfd9":"69345","0dd9aaeb":"69389","19eded63":"69416","4f9e8711":"69586","5bc09a53":"69597","38a042e4":"69656","423842d7":"69725",a35cf155:"69838",a847366a:"69935",cecc75bb:"69937",reactPlayerSoundCloud:"69979","91fe1403":"70062","8873cf50":"70073",a7fe0e50:"70142","330dfcdb":"70414","8cb0269b":"70423",ef5945f7:"70540","7bef3f04":"70542","6864e844":"70876","8ca0e442":"70986","688ee267":"71728",ae4a775b:"72231",df2a6e58:"72290",f26f8f05:"72456","8e49e0b0":"72526","97c7db18":"72972",d66cbd9e:"73008","73f18a6f":"73267","97d49594":"73318",cc6d9416:"73425",e0277333:"73553","016e89ec":"73588","450c2e30":"73607",a30c0d44:"73800","54d805e4":"73946","2658ced2":"74190","9542c76a":"74202","4cb6c19a":"74210",c5b2f0f9:"74238","81e486a8":"74260",d9407a00:"74358","920c2ac2":"74361","49d9416a":"74457",a9bc0f5d:"74501",a0c37fdd:"74785","39ae3791":"74937","0341d436":"75046","6763d4e0":"75056",cfdfe126:"75204",fee0a0be:"75315",edcfca88:"75687",bc873533:"76151","43be69c9":"76228","0fa6e9bf":"76430",fd684bd6:"76775","9d887a11":"77350","254d0ff5":"77353","1dfee34e":"77546",bc816bf2:"78007","52ea62e7":"78048",b104dd1e:"78110","2cb13d6d":"78170","69c5f318":"78258","5393540e":"78349","7b477840":"78434","021eaa84":"78465","905702d2":"78664",d7ed6ffb:"78707","74c26f41":"78848","12eb386e":"78989",a94703ab:"79048","898514b1":"79067","927c84a6":"79405",e3f28bf9:"79594",aba485c2:"79683",c813bd67:"79849","83245ae6":"79981",b8eb0fce:"80042",e6412603:"80348",ff38b1ce:"80353","714e70d1":"80714",c141421f:"80957","9286a297":"81497","67eba1be":"81634",c2865a15:"81898",acecf23e:"81903","1e582a71":"81961","94f3d131":"82060",b985118d:"82219","8677f412":"82244","1a16e8bf":"82479",ccc49370:"83249",ca165b51:"83313","612345e6":"83405","19e69ccd":"83509","8be8ac58":"83729","0e384e19":"83976","1cfced13":"83993",bb0cb288:"84000",b7bb2d93:"84052","16ce7fd2":"84539","3720c009":"84787","6875c492":"84813","54590fd2":"84874","7d88b63f":"85193","98ced590":"85462",af231220:"85784","7a21ccb0":"86040",b757e1e0:"86219","9f97f9d1":"86244",c7cac05f:"86693",reactPlayerFacebook:"86887",b4df9b48:"87246",fe9a92c0:"87438","7f0476bd":"87577",d5f6644b:"87986","874690d0":"88041",fefd9738:"88375","57dba496":"88499","78b70dba":"88576",bbf561d5:"88614",db22fd17:"88623","5c25e6fa":"88930","6774f806":"89507","180d0c5f":"89634","36994c47":"89858","0877aebd":"89885","73f9658e":"89904","8c6c72f9":"90305","604e05e4":"90418",d9b4ee1e:"90488","49a2e93c":"90619","6e92edd9":"90735","24bda87b":"90843","0058b4c6":"90849","0102eb3e":"90989","232c546d":"91638","7e5a2776":"91643","732d4d9b":"91746",ed75cfcb:"92388","25d1f3de":"92449",c8eb055e:"92456",a33d13d7:"92553","8519c2b0":"92749",c44aa824:"92834","894e67a6":"93031",c361d244:"93520","3d6cee82":"93655","3289a752":"93744","931e3b0a":"93891","6603ef13":"93897","6e30ac7b":"94054","57e01cd5":"94209",cd23aec9:"94365",adb00d9a:"94468","7d9edfb8":"94692","1d31e443":"94892","6eb49eac":"94964","92b08985":"95044",f644aac7:"95275","494e8e75":"95314",b6be2912:"95322","86f8c256":"95505",aca8b082:"95576",abc85917:"95645","825ec378":"95696",b7746a44:"95904","57a8015d":"96170","6a1fe514":"96220",f7197f43:"96316",c2e1e282:"96357","51e516cc":"96420","583db3ef":"96549",f0e3a130:"96906",a8ce95ee:"97120",c11c87f7:"97161","1fbe0675":"97331",reactPlayerFilePlayer:"97458","123a454a":"97550",ffbee6a9:"97623",f27eaf88:"98458",fa5f999e:"98537","86063cd3":"98910",reactPlayerWistia:"99340","5fb93fc0":"99795","5e8fbcdf":"99872"}[e]||e,t.p+t.u(e)},(()=>{var e={45354:0,71869:0};t.f.j=(a,c)=>{var f=t.o(e,a)?e[a]:void 0;if(0!==f)if(f)c.push(f[2]);else if(/^(45354|71869)$/.test(a))e[a]=0;else{var d=new Promise(((c,d)=>f=e[a]=[c,d]));c.push(f[2]=d);var b=t.p+t.u(a),r=new Error;t.l(b,(c=>{if(t.o(e,a)&&(0!==(f=e[a])&&(e[a]=void 0),f)){var d=c&&("load"===c.type?"missing":c.type),b=c&&c.target&&c.target.src;r.message="Loading chunk "+a+" failed.\n("+d+": "+b+")",r.name="ChunkLoadError",r.type=d,r.request=b,f[1](r)}}),"chunk-"+a,a)}},t.O.j=a=>0===e[a];var a=(a,c)=>{var f,d,b=c[0],r=c[1],o=c[2],l=0;if(b.some((a=>0!==e[a]))){for(f in r)t.o(r,f)&&(t.m[f]=r[f]);if(o)var n=o(t)}for(a&&a(c);l{"use strict";var e,a,f,c,d,b={},r={};function t(e){var a=r[e];if(void 0!==a)return a.exports;var f=r[e]={exports:{}};return b[e].call(f.exports,f,f.exports,t),f.exports}t.m=b,e=[],t.O=(a,f,c,d)=>{if(!f){var b=1/0;for(n=0;n=d)&&Object.keys(t.O).every((e=>t.O[e](f[o])))?f.splice(o--,1):(r=!1,d0&&e[n-1][2]>d;n--)e[n]=e[n-1];e[n]=[f,c,d]},t.n=e=>{var a=e&&e.__esModule?()=>e.default:()=>e;return t.d(a,{a:a}),a},f=Object.getPrototypeOf?e=>Object.getPrototypeOf(e):e=>e.__proto__,t.t=function(e,c){if(1&c&&(e=this(e)),8&c)return e;if("object"==typeof e&&e){if(4&c&&e.__esModule)return e;if(16&c&&"function"==typeof e.then)return e}var d=Object.create(null);t.r(d);var b={};a=a||[null,f({}),f([]),f(f)];for(var r=2&c&&e;"object"==typeof r&&!~a.indexOf(r);r=f(r))Object.getOwnPropertyNames(r).forEach((a=>b[a]=()=>e[a]));return b.default=()=>e,t.d(d,b),d},t.d=(e,a)=>{for(var f in a)t.o(a,f)&&!t.o(e,f)&&Object.defineProperty(e,f,{enumerable:!0,get:a[f]})},t.f={},t.e=e=>Promise.all(Object.keys(t.f).reduce(((a,f)=>(t.f[f](e,a),a)),[])),t.u=e=>"assets/js/"+({473:"9dce5486",772:"5c0f0993",812:"c6aad055",836:"14ae68e7",1171:"0029a336",1603:"7258860f",1647:"9af13eab",2026:"35300761",2134:"10ce918d",2139:"3c39daba",2172:"3e2b82eb",2334:"87a5fc8a",2449:"00e9d6a1",2571:"164937d2",3e3:"ada86621",3085:"a3002291",3392:"reactPlayerVidyard",3724:"35dda5a2",3962:"a2ffcc0f",4024:"d1462701",4406:"3f29ba7c",4769:"86f2a982",5004:"8abd0ba5",5187:"fe0d4a0f",5276:"4b39f818",5451:"adcef0a2",5556:"46b3c144",5569:"10091836",5646:"473de3ed",5787:"708d858d",6121:"d83404a8",6463:"reactPlayerKaltura",6704:"1ee92283",7327:"4b8121dd",7406:"6aa0b043",7446:"48b6ff5f",7568:"c104141c",7766:"3ba80b69",7832:"fc8a94e3",8078:"5046ea8f",8209:"01a85c17",8402:"6269f1c0",8826:"640277b9",8848:"d178b2c6",8870:"7e2ae3df",8936:"67fccd64",9072:"94324b0e",9332:"f890fec4",9383:"cc922df3",9426:"2d629ea6",9527:"f16d562f",9647:"5e95c892",9767:"a08dfa31",9962:"014457dd",10010:"878aa0e7",10107:"23b35f70",10673:"e44de27e",10906:"e1a2ab10",11022:"a9fa5b1f",11084:"e6c31e60",11173:"28d80fa9",11532:"f7c9e078",11568:"6d8c157a",12036:"d651e2ee",12042:"reactPlayerTwitch",12065:"f9fb4395",12248:"9a22c80d",12286:"be228752",12401:"6bf124c2",12618:"23a8e291",12978:"871ce139",13037:"591f7a5f",13365:"da802cf4",13579:"70e3b13c",13589:"6c80b6fe",13680:"9c540f0b",13920:"a334b453",14036:"b8ec852b",14061:"5087625a",14330:"bd45720e",15405:"f6cf66bc",15607:"5a7aef43",15663:"9dd60997",15746:"5a3b561f",15910:"bd65ec7e",15974:"7be672a3",15985:"e6fb1369",16100:"4f9d299b",16115:"22e2140b",16256:"6eafe0c7",16328:"reactPlayerDailyMotion",16344:"610f2c47",16425:"30a9912a",16583:"0c14b239",16709:"7afa6340",17043:"8b4dd820",17148:"34767260",17159:"308aae28",17242:"4974f5d2",17349:"0cab2b3a",17387:"7144043e",17397:"db320b4a",17652:"07305c4a",17656:"56a9df4f",17796:"62e21724",17853:"5db8318c",18038:"9f2f2cb3",18121:"3a2db09e",18146:"c15d9823",18401:"17896441",18445:"5a9a7a02",18446:"reactPlayerYouTube",18538:"f4271232",18557:"4780c642",18609:"6101b3fc",18687:"17c68348",19060:"b678a236",19150:"1a906644",19763:"65a10ffa",19789:"edb40f78",19810:"75281220",20044:"524ce9a0",20153:"fff8aeb8",20228:"6494b798",20286:"b66ca8cf",21076:"8ae04122",21126:"107d77e6",21381:"0f54081d",21407:"724f3974",21791:"9db962b6",21817:"c1584a80",22051:"adfdec4a",22319:"09788c0c",22405:"0547cb65",22496:"44287967",22778:"f523fb3f",23512:"006e489c",23767:"ca1234c1",23960:"74b658de",24279:"df203c0f",24478:"fc923f19",24593:"4ec76dfa",24639:"97a89ac0",24915:"82170cf7",25184:"e546fc5a",25320:"91392348",25492:"3a38a610",25670:"280646e4",25774:"b9287eb6",26168:"e983a6d7",26173:"reactPlayerVimeo",26600:"360dc931",26693:"368cce37",26716:"1515c895",26929:"311d0508",27262:"fb50ea3a",27895:"d496897e",27902:"2f8f53cb",28154:"ff2f63f6",28341:"60c82955",28645:"f20efc55",28728:"a00af9f0",28757:"a4794f2e",28903:"5df556a2",28917:"ea3ffc82",29099:"7e93d479",29634:"b39cdcf9",29744:"9f90a44b",29824:"f1ad83b2",30487:"814402d7",30784:"cd343213",30862:"4d71dffe",30962:"ba5b9f11",31438:"fe1a05e2",31502:"ed603d23",31652:"30997935",31672:"04a546a4",31681:"cabda5f8",31718:"4b66c45e",31774:"d1c21237",32428:"d9673b17",32467:"c25913f3",32500:"901c37e5",32689:"cd7fa15a",32923:"12f1535e",32993:"185c52e7",33167:"ca6c9efa",33195:"b799648a",33253:"a2c6f402",33294:"71748509",33331:"09b168a7",33582:"81b69ac7",34055:"b5114993",34293:"2340b3ee",34318:"8eeedb31",34415:"a0323d9f",34428:"07f59c2a",34583:"1df93b7f",34918:"c9cac9d9",34939:"bab44fba",35111:"7547d3bb",35129:"e665718d",35258:"d83f208d",35272:"883e2c3c",35327:"d739767a",35515:"f771dec1",35634:"4bdb36b8",35644:"64bd32f2",35716:"dec87402",35742:"aba21aa0",36049:"3109d9d2",36104:"a3f8794a",36273:"fe716911",36353:"reactPlayerPreview",36574:"b6d76a6c",36901:"8dbb6800",37012:"e7923b27",37163:"cb0f21df",37561:"6477cdc2",37643:"a6aa9e1f",37709:"562ca3e9",37736:"d1163e47",38311:"c71cae97",38341:"512fbd77",38752:"d7fbbe43",38788:"7c7a772e",38802:"3b68f98c",38843:"3462068c",38947:"ef8b811a",39004:"01821883",39164:"46669adc",39498:"97eb992d",39590:"b51a9aee",40098:"7fa133e1",40117:"9c65fea5",40228:"815c93fd",40296:"16914cba",40304:"bb6a5560",40532:"0e3a398f",40555:"f6cd0d3d",40611:"148448cb",40793:"0433ef30",41052:"dc23cd40",41067:"e69dadab",41266:"64abd3af",41340:"bd80aa65",41382:"10210328",41697:"4ec4c6cd",41789:"64134c03",41949:"6b1fbd0a",42586:"e064f6d4",42607:"3866940b",42950:"8a864d1e",43079:"8fe4c488",43140:"786fee93",43164:"43f3fe28",43169:"caddb1c0",43307:"bf11c6a2",43320:"46cf64bb",43425:"5b10a003",43665:"3f797343",44183:"f86eb50f",44261:"2bbe04e6",44362:"f431c910",44413:"70bd0abb",44462:"7d3ae564",44693:"5b7d9ef2",45226:"b52d840d",45759:"160cb329",45802:"b3b7dd16",46252:"b15eeff9",46398:"33a21d7d",46666:"c2911623",46741:"d1b15a6d",46850:"8b4ba22f",47008:"22de4147",47422:"1949cc8d",47479:"e6163b65",47627:"reactPlayerStreamable",47798:"2f195bb0",48130:"f81c1134",48279:"981d19db",48374:"56c3a9b2",48507:"33f367df",48823:"fb8cd692",48909:"71c7597c",49244:"41b2e801",49606:"29931f43",49808:"06a27da2",49819:"7cde3c49",50024:"fd702dc7",50038:"330b5684",50740:"456c0e28",51023:"080a9824",51047:"0e72c11a",51162:"059d1c6a",51181:"e73930cf",51594:"59a6f192",51814:"91a39dd0",52065:"cdf64ea9",52276:"bdb8b81b",52492:"d4bf7e47",52547:"5ebdf64d",52711:"9e4087bc",52723:"reactPlayerMux",52853:"a943bcee",53064:"e84cabb0",53113:"0c4fad6b",53125:"416d4fcf",53203:"17612ae7",53225:"7500e360",53410:"5e30269e",53499:"ab69fe56",53588:"a2d1ff94",53629:"125d93c1",53930:"c1ca9e21",54134:"2f7d01f7",54329:"4816649b",54333:"40d377be",54427:"b2973dc4",54628:"a7777682",54642:"9e8f4e9c",54646:"e35d7c3e",54691:"873d332f",54727:"7aa856d6",54797:"9684f8b7",55251:"8ccdb99f",55259:"aaabcfd8",55395:"cf6b503e",55543:"e7477a94",55756:"deccabf3",55780:"4f425ff4",55807:"a38d285e",55979:"d4840880",56095:"d103759a",56500:"382e0557",56576:"8785b74d",56898:"5e486140",57577:"b5ec5208",57689:"a826efc5",57720:"4213e5b1",57778:"4c217c25",57915:"49bee2be",57947:"93e05602",58699:"ed1f6062",58775:"24dadce3",58796:"8c8ef21f",59310:"e1c8d71f",59660:"ef2e2003",59818:"1c93995d",59911:"065365b3",60102:"df4d464e",60261:"3a4a1d3a",60404:"1369aff7",60441:"1fc83a28",60759:"d46ef83d",61036:"42b67a8e",61216:"2ab17a83",61235:"a7456010",61546:"b5b19789",61634:"c358ebbc",62138:"1a4e3797",62662:"5660752d",62824:"de311ed4",63090:"01a1d0f4",63156:"b9a87183",63805:"17d2ebc8",64147:"ae79aff5",64169:"3d8d8999",64179:"92d7df62",64212:"621db11d",64374:"3132913e",64558:"95646edb",64577:"e38c422a",64605:"ed2a4846",64630:"9d2d4743",64679:"86e64757",65331:"97615df2",65608:"271ff0d1",66045:"3f66023b",66054:"c6346fcf",66414:"c239db97",66622:"814d49b7",67098:"a7bd4aaa",67402:"2bb2c1cd",67472:"814f3328",67570:"reactPlayerMixcloud",67635:"4f35c7a7",67962:"67386898",68026:"3819c331",68170:"7a957b04",68171:"79f18c88",68598:"e88443f3",68660:"c544b2d7",68833:"4c5becac",68860:"c0c3bda5",69183:"38f19abb",69215:"fbfd390f",69325:"c09ab32f",69345:"030ccfd9",69389:"0dd9aaeb",69416:"19eded63",69586:"4f9e8711",69597:"5bc09a53",69656:"38a042e4",69725:"423842d7",69838:"a35cf155",69935:"a847366a",69937:"cecc75bb",69979:"reactPlayerSoundCloud",70062:"91fe1403",70073:"8873cf50",70142:"a7fe0e50",70414:"330dfcdb",70423:"8cb0269b",70540:"ef5945f7",70542:"7bef3f04",70876:"6864e844",70986:"8ca0e442",71728:"688ee267",72231:"ae4a775b",72290:"df2a6e58",72456:"f26f8f05",72526:"8e49e0b0",72972:"97c7db18",73008:"d66cbd9e",73267:"73f18a6f",73318:"97d49594",73425:"cc6d9416",73553:"e0277333",73588:"016e89ec",73607:"450c2e30",73800:"a30c0d44",73946:"54d805e4",74013:"91008145",74190:"2658ced2",74202:"9542c76a",74210:"4cb6c19a",74238:"c5b2f0f9",74260:"81e486a8",74358:"d9407a00",74361:"920c2ac2",74457:"49d9416a",74501:"a9bc0f5d",74785:"a0c37fdd",74937:"39ae3791",75046:"0341d436",75056:"6763d4e0",75204:"cfdfe126",75315:"fee0a0be",75687:"edcfca88",76151:"bc873533",76228:"43be69c9",76430:"0fa6e9bf",76775:"fd684bd6",77350:"9d887a11",77353:"254d0ff5",77546:"1dfee34e",78007:"bc816bf2",78048:"52ea62e7",78110:"b104dd1e",78170:"2cb13d6d",78258:"69c5f318",78349:"5393540e",78434:"7b477840",78465:"021eaa84",78664:"905702d2",78707:"d7ed6ffb",78848:"74c26f41",78989:"12eb386e",79048:"a94703ab",79067:"898514b1",79405:"927c84a6",79594:"e3f28bf9",79683:"aba485c2",79849:"c813bd67",79981:"83245ae6",80042:"b8eb0fce",80348:"e6412603",80353:"ff38b1ce",80714:"714e70d1",80957:"c141421f",81497:"9286a297",81634:"67eba1be",81898:"c2865a15",81903:"acecf23e",81961:"1e582a71",82060:"94f3d131",82219:"b985118d",82244:"8677f412",82479:"1a16e8bf",83249:"ccc49370",83313:"ca165b51",83405:"612345e6",83509:"19e69ccd",83729:"8be8ac58",83976:"0e384e19",83993:"1cfced13",84e3:"bb0cb288",84052:"b7bb2d93",84539:"16ce7fd2",84787:"3720c009",84813:"6875c492",84874:"54590fd2",85193:"7d88b63f",85462:"98ced590",85784:"af231220",86040:"7a21ccb0",86219:"b757e1e0",86244:"9f97f9d1",86693:"c7cac05f",86887:"reactPlayerFacebook",87246:"b4df9b48",87438:"fe9a92c0",87577:"7f0476bd",87986:"d5f6644b",88041:"874690d0",88375:"fefd9738",88499:"57dba496",88576:"78b70dba",88614:"bbf561d5",88623:"db22fd17",88801:"95366386",88930:"5c25e6fa",89507:"6774f806",89634:"180d0c5f",89858:"36994c47",89885:"0877aebd",89904:"73f9658e",90305:"8c6c72f9",90418:"604e05e4",90488:"d9b4ee1e",90619:"49a2e93c",90735:"6e92edd9",90843:"24bda87b",90849:"0058b4c6",90989:"0102eb3e",91638:"232c546d",91643:"7e5a2776",91746:"732d4d9b",92388:"ed75cfcb",92449:"25d1f3de",92456:"c8eb055e",92553:"a33d13d7",92749:"8519c2b0",92834:"c44aa824",93031:"894e67a6",93520:"c361d244",93655:"3d6cee82",93744:"3289a752",93891:"931e3b0a",93897:"6603ef13",94054:"6e30ac7b",94209:"57e01cd5",94365:"cd23aec9",94468:"adb00d9a",94692:"7d9edfb8",94892:"1d31e443",94964:"6eb49eac",95044:"92b08985",95275:"f644aac7",95314:"494e8e75",95322:"b6be2912",95505:"86f8c256",95576:"aca8b082",95645:"abc85917",95696:"825ec378",95904:"b7746a44",96170:"57a8015d",96220:"6a1fe514",96316:"f7197f43",96357:"c2e1e282",96420:"51e516cc",96549:"583db3ef",96831:"25622900",96906:"f0e3a130",97120:"a8ce95ee",97161:"c11c87f7",97331:"1fbe0675",97458:"reactPlayerFilePlayer",97550:"123a454a",97623:"ffbee6a9",98458:"f27eaf88",98537:"fa5f999e",98910:"86063cd3",99340:"reactPlayerWistia",99795:"5fb93fc0",99872:"5e8fbcdf"}[e]||e)+"."+{473:"280d8724",772:"27698a25",812:"b3d90c80",836:"4af9c8c3",1171:"a827462c",1333:"1af56771",1603:"30af2c7f",1647:"694eae48",2026:"c85306b1",2134:"92af30fe",2139:"330cecf3",2172:"fd107078",2334:"6f2bfba9",2449:"99537d09",2571:"ebc7a947",3e3:"6586846c",3085:"e3862cf4",3303:"502d9be6",3392:"26549ee8",3524:"d3b4341b",3686:"c8627c03",3724:"ec5e4f72",3962:"2c4a92bc",4024:"6719586b",4406:"46e51d42",4769:"a1df941e",5004:"32852fb1",5187:"1cc77d8f",5276:"6259f6ef",5451:"354e4a3c",5556:"b8af3d43",5569:"73e80872",5618:"d8f19d30",5646:"21f1d33d",5787:"2e4f2a3b",6121:"0fa4a979",6463:"864fe255",6704:"26bd4b22",7327:"4ddc044d",7406:"f7d1efa5",7446:"d360337d",7568:"c267adb3",7766:"e8e68567",7832:"189ed50f",8078:"81d7b184",8209:"dc80aa6d",8402:"aca3985d",8826:"1b32454b",8848:"9ed0bf55",8870:"da94dc06",8936:"9c63e23b",9072:"8e17c1ee",9332:"67856e0d",9383:"d86c6415",9426:"e9795135",9527:"cd0e39f5",9603:"feeda7ba",9647:"136a2d64",9767:"9cd5025e",9962:"88a57510",10010:"17e767a5",10107:"ceb741dc",10673:"8141eebb",10906:"57eb07ce",11022:"338403da",11084:"1c23a339",11173:"5850a775",11532:"55a956e9",11568:"c22677a5",12036:"f14baeca",12042:"ebcda0df",12065:"c6df11b1",12176:"71adad58",12248:"89dbfcb3",12286:"7eb623cd",12401:"f3bc4993",12618:"71c7a2e8",12978:"3c20e387",13037:"3c101040",13365:"73fb951e",13579:"528cbd7c",13589:"175b6832",13680:"2174f7e5",13920:"99a42045",14036:"b3f3d307",14061:"5b09bcdf",14330:"afef7707",15405:"04576495",15607:"413eeb80",15663:"f450c893",15746:"7bebb0b2",15910:"e77223c6",15974:"ff5ae384",15985:"e6194203",16100:"6510348c",16115:"f759648f",16256:"809fe20f",16328:"1cee6458",16344:"2b0d1574",16425:"e215b8fb",16583:"6be7511e",16709:"4f55effc",17043:"846bca0e",17148:"b97336ef",17159:"a645c04c",17242:"61264935",17349:"0587a16f",17387:"340846c3",17397:"ec53cb3e",17652:"0ebdfb04",17656:"b40c8018",17796:"2c863a20",17853:"e5aacc51",18038:"b14c97b4",18121:"edfc6de2",18146:"36cc4219",18401:"402ade53",18445:"fef2f70c",18446:"2f393a2d",18538:"2de3f5cd",18557:"6e1e1550",18609:"cca17bd5",18687:"75fd8c6b",18973:"dcbaa706",19060:"055e83f6",19150:"b171c747",19763:"2ddc7e94",19789:"830b0fed",19810:"72c3f3a2",20044:"ad4045cf",20153:"566289dc",20228:"d69822eb",20286:"8d6552ea",21076:"56a6200e",21126:"8eaa5676",21381:"0a8fa52a",21407:"78647697",21791:"508fe2ba",21817:"f1760e14",22051:"3650e688",22319:"93434adb",22405:"9ed8cdaf",22496:"a26b0af7",22778:"12be248c",23512:"c5577bd1",23767:"75fefe75",23934:"f3126557",23960:"a150bc7e",24189:"c249b745",24279:"0a26846f",24478:"9012a3fc",24593:"c138b7c5",24639:"edd2c0ad",24915:"8fc6886c",25184:"f1feafa2",25320:"5ce3e01f",25492:"4ff9d5c2",25670:"bf91385b",25681:"261a04cf",25774:"2a392b76",26026:"f9a02576",26168:"571e86ea",26173:"231c5de7",26600:"62a5b638",26693:"fee75f49",26716:"88b21388",26929:"bd8fe717",27262:"574647d3",27717:"d7b090db",27895:"70f1437f",27902:"b1bd9c34",28154:"9005ac65",28341:"79d076a7",28435:"672816c4",28645:"d6cbb94d",28697:"6c8e6caa",28728:"263cd739",28757:"155017b2",28903:"bb0842cd",28917:"fad7d657",29099:"259c9643",29308:"845f2564",29634:"254dc925",29744:"b938caf7",29824:"875d7308",30487:"7a700f4a",30784:"2e0a23c1",30862:"15cd821e",30962:"710a67d9",31438:"b71397d4",31502:"5a161c69",31652:"90d4abbf",31672:"a76ae295",31681:"4073656a",31718:"b7ae637e",31774:"5a0c1d46",32428:"9b46a815",32467:"d478515f",32500:"82061bcf",32588:"a5c46adf",32689:"2e9559c6",32923:"8815e5f8",32993:"63c685d2",33076:"1715d03b",33167:"6f4066fc",33195:"de0fd6b5",33253:"e81a63b3",33294:"0501485a",33331:"c884a1fb",33582:"71480871",34055:"20a0afe3",34293:"ed116807",34318:"3c86e0eb",34415:"d9e8cddd",34428:"35f8051c",34583:"01a92f00",34656:"1f20c9c8",34918:"90899ea0",34939:"82b72770",35111:"bc3984f2",35129:"0110b356",35258:"e5a79ce0",35272:"a3408c5e",35327:"4b20aeae",35515:"2b600265",35634:"57a6fb3e",35644:"c6c97e18",35716:"fcf70dc0",35742:"5d49a645",36049:"fbcf90c1",36104:"0ec1d893",36273:"5b4c2bdb",36353:"397a99ee",36574:"7b897eb5",36901:"b3e80772",37012:"d57db834",37163:"f5b4fbd4",37561:"7ffaa466",37643:"9cc53623",37709:"c3ea0043",37736:"f901747c",37955:"d11c416b",38311:"48144dc2",38341:"43198afa",38752:"0930e74a",38788:"62b54e2d",38802:"babbe266",38843:"c6109b90",38947:"134f3be3",39004:"8da815af",39164:"21f58b85",39498:"d695cef5",39590:"34e8dea8",39714:"e3ccdf73",40098:"3faef52f",40117:"7c6571f5",40228:"a40740f2",40296:"6fded6fc",40304:"8d259dee",40340:"dc84fa42",40504:"7af7708e",40532:"f5b42f08",40555:"edededcb",40611:"cae7c405",40793:"99d64827",41052:"5a4ed45e",41067:"6cdcb78f",41266:"3588bdc7",41340:"42e08eff",41382:"be0cabc7",41697:"fc1a1633",41789:"67794c44",41949:"f04d8334",42586:"8321315e",42607:"7e34ec18",42950:"5d0c1ef6",43079:"e2ed9058",43140:"5c81ae7e",43164:"0f7ab352",43169:"f7287333",43307:"cb4a288d",43320:"e486804e",43425:"06726e81",43431:"9871975d",43665:"1c8c5232",44183:"5ca03df7",44261:"20fa645f",44362:"faab84a4",44413:"7d0969f3",44462:"0296631e",44693:"5d5a57ca",45226:"0f38102d",45759:"e38489c1",45802:"698d581a",46252:"cef075ec",46398:"5dd62d1c",46666:"b171cea9",46741:"52477a26",46850:"9a7b01f0",47008:"eadf04b4",47422:"3075578f",47479:"142b0a70",47623:"62f69c95",47627:"5f135999",47798:"3745a376",48130:"d3f8db81",48279:"d1785594",48374:"3233545f",48507:"94acfbde",48823:"778d7423",48909:"5057d28e",49073:"0c3427a9",49244:"95839f24",49606:"f6ea22fa",49808:"3a1a0752",49819:"483b5683",50024:"64b826e1",50038:"86373ac9",50740:"a122a075",51023:"d3723757",51047:"760caae1",51162:"60870e0c",51181:"27c74c38",51594:"a0d84c5f",51814:"7f215ed1",51822:"7aa2a359",52065:"fbb6071f",52276:"f58a86c3",52492:"9fd9898d",52547:"85d09cf5",52711:"96d2373f",52723:"c5989c0b",52853:"f693a67c",53064:"2fb51f15",53113:"0c8cef87",53125:"92783c64",53203:"9b161957",53225:"288552aa",53410:"c6ca280a",53499:"9724cf3c",53588:"db345a41",53629:"57a18275",53930:"4f8f8b1b",54134:"03a0d248",54329:"88dd8763",54333:"f890c78e",54427:"c281113e",54628:"f2d4a307",54642:"4bfa5536",54646:"60c58fdd",54691:"8e6a6347",54727:"f065ff33",54797:"0d604612",55251:"bf60ff99",55259:"c9fde7e9",55395:"2ca7514f",55543:"8015f73e",55756:"a30d945a",55780:"64bffbbe",55807:"e7a5c865",55979:"895e383c",56095:"ecc95e40",56500:"22fe314c",56576:"1cd69543",56898:"bb4473e0",57415:"382226be",57577:"95cb4890",57689:"bcbc1181",57720:"ec6fd34f",57778:"6a00e784",57915:"76fc0204",57947:"a61eea31",58625:"3cce9597",58699:"7ae7e5da",58775:"a381bd21",58796:"df0876ec",59310:"4758f1b4",59660:"5578ce12",59818:"c92b42b9",59911:"24742235",60102:"d61eddac",60261:"5b43d10a",60404:"caf568ca",60441:"db7344d0",60759:"6f935815",61036:"e043536a",61216:"d4e70c76",61235:"d921c339",61473:"d8e284b1",61546:"c760b7d9",61634:"3f6af45e",62138:"3450920a",62662:"9cd9ee52",62824:"65ff65d3",63090:"bc23bcbe",63156:"d355aa0e",63805:"4e26a60c",64147:"bd657679",64169:"c166c22b",64179:"566158e9",64212:"b552bb9b",64374:"962ac72e",64558:"a1f5bd24",64577:"7842f53e",64605:"f97d69e6",64630:"9a3011dc",64679:"59408388",65331:"384df7f8",65566:"0b511c9c",65608:"2e9275a0",66045:"eb031895",66054:"46d68e9a",66414:"b3714bc3",66622:"6d76dd65",67098:"4ef1b139",67402:"4fab1170",67472:"1f64d18d",67570:"10e3911a",67635:"daae111d",67962:"12c542c6",68026:"6cee73bc",68170:"b2fa346f",68171:"8893bdd6",68598:"eb7e3acb",68660:"743e021d",68833:"2a43877b",68860:"ebedbdf6",69183:"99d69017",69215:"3527d541",69325:"7bbc413a",69345:"62027475",69389:"d358c548",69416:"b86f2ac7",69586:"b1f62579",69597:"727e6ee1",69656:"985f0208",69725:"c7ef4c84",69838:"fac977bb",69935:"7b463c3a",69937:"c2f949a4",69979:"55a971e2",70062:"8932e8d2",70073:"6b72e911",70142:"c3430b99",70414:"e004bf7b",70423:"256bca2e",70540:"93a780bf",70542:"1dd7488d",70876:"ecda918a",70986:"c26d2865",71261:"e2407cd4",71728:"ace7ce81",72231:"92d157cb",72290:"678d5d36",72456:"8722cf96",72526:"a75ed61c",72972:"dac6b774",73008:"043a29d6",73267:"105a4bda",73318:"cae37401",73425:"af7a3a48",73553:"ceccdc76",73588:"ca66c4a3",73607:"977a291b",73800:"973e23d1",73946:"42b1404a",74013:"04970eef",74190:"6f23a9ce",74202:"669940a1",74210:"1d36c93d",74238:"609e970c",74260:"8971d423",74358:"2e242177",74361:"73e679c9",74457:"2d59657e",74501:"f2654fc0",74785:"46c49879",74937:"33385c54",75046:"20142eed",75056:"fac34dd7",75204:"3791b9be",75315:"5f886d61",75687:"371325e7",76010:"967e9e91",76151:"8a457ede",76228:"c1514293",76430:"dfa96e60",76752:"b2b30d75",76775:"88e2f79f",77350:"ab5c69c6",77353:"97188e18",77546:"23dcc2ee",78007:"a6e29a63",78048:"b96a3e8c",78110:"a962e98b",78170:"0fc12f7e",78258:"9ac358c2",78349:"c83954a1",78434:"5147dd4d",78465:"73b73cec",78664:"8f59f3fa",78707:"bfcf089b",78848:"44c19e4b",78989:"f732d0f4",79048:"88610977",79067:"d1ba078c",79405:"b6fb981e",79594:"b0a5a3ef",79683:"13db7663",79849:"68c9ce22",79981:"f836251d",80042:"64c93e56",80348:"7e4063e7",80353:"72e6ab5e",80714:"487b1c99",80957:"2b45b766",81497:"f610180a",81634:"39c7e55f",81898:"11e9cbcd",81903:"67a62659",81961:"e1db2648",82060:"d8ff953d",82219:"2c224c0d",82244:"d0a4fa9f",82479:"438ec5af",83249:"47e2e9ba",83313:"5963b7b1",83405:"91f73475",83509:"9b091196",83729:"de2ed4f5",83976:"700385f9",83993:"b064f926",84e3:"8b8de19a",84052:"6411161e",84539:"1aea1097",84671:"8a77350b",84787:"6030d90f",84813:"d336ff0f",84874:"90be7d30",85145:"fa76a070",85193:"dab23735",85462:"d54e161f",85520:"db1227a4",85784:"10ff5b00",86040:"f118a861",86219:"0bb7f995",86244:"72f267fc",86693:"6ec3b11f",86887:"7639f87f",87246:"b2dea336",87438:"3dff9fbc",87577:"52d2b245",87986:"b5d0edc3",88041:"ae978a69",88375:"3351c54e",88499:"0f1160d7",88576:"772bb7c2",88614:"39f175fe",88623:"bfcaee3d",88801:"7aa67542",88930:"17433ee3",89074:"df84199a",89093:"6a7aeebc",89507:"e6aa73be",89634:"17181c3f",89858:"63c2e6ec",89885:"04f19fc0",89904:"5ae8f46f",90305:"7edff533",90418:"8b003852",90488:"d3ccd4b4",90619:"e3f958c4",90735:"5f371511",90843:"7f66d647",90849:"c933951e",90989:"65e07fbe",91638:"e1f5c9e9",91643:"51f4171d",91746:"e86b7fa4",92388:"30ab91dc",92449:"b551feb2",92456:"370ed0fe",92553:"c26cc4c8",92749:"9dcb01f6",92834:"c1a1c195",93031:"e76b4787",93520:"d6dbf71a",93655:"bfb1eaf6",93744:"73302fec",93891:"f3bb935b",93897:"c2303fb9",94054:"9a42ea49",94209:"b6ea49b4",94365:"511e6008",94468:"158b5fb4",94692:"b92e6925",94892:"4c9df7d9",94964:"470e417b",95044:"6da183a6",95275:"0c9b627d",95314:"360f7b21",95322:"7fed9541",95505:"ccac3db3",95576:"d022ca6a",95601:"84970094",95645:"53c2d97b",95696:"0fcfad82",95904:"792a052a",96170:"ae7e76ac",96220:"c01159fa",96316:"d3c794af",96357:"b5e08f84",96420:"24dbee7c",96549:"e3fad985",96831:"c97d2000",96906:"35285308",97120:"3f3056d3",97161:"c6631228",97331:"9cf6a829",97458:"a8e74fc1",97550:"aa629d67",97623:"d7cfc852",98458:"edd88cd8",98537:"c2d51678",98910:"6898e210",99340:"9e33dbe5",99795:"2fe9d526",99872:"4645a505"}[e]+".js",t.miniCssF=e=>{},t.g=function(){if("object"==typeof globalThis)return globalThis;try{return this||new Function("return this")()}catch(e){if("object"==typeof window)return window}}(),t.o=(e,a)=>Object.prototype.hasOwnProperty.call(e,a),c={},d="docs:",t.l=(e,a,f,b)=>{if(c[e])c[e].push(a);else{var r,o;if(void 0!==f)for(var l=document.getElementsByTagName("script"),n=0;n{r.onerror=r.onload=null,clearTimeout(s);var d=c[e];if(delete c[e],r.parentNode&&r.parentNode.removeChild(r),d&&d.forEach((e=>e(f))),a)return a(f)},s=setTimeout(u.bind(null,void 0,{type:"timeout",target:r}),12e4);r.onerror=u.bind(null,r.onerror),r.onload=u.bind(null,r.onload),o&&document.head.appendChild(r)}},t.r=e=>{"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(e,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(e,"__esModule",{value:!0})},t.p="/",t.gca=function(e){return e={10091836:"5569",10210328:"41382",17896441:"18401",25622900:"96831",30997935:"31652",34767260:"17148",35300761:"2026",44287967:"22496",67386898:"67962",71748509:"33294",75281220:"19810",91008145:"74013",91392348:"25320",95366386:"88801","9dce5486":"473","5c0f0993":"772",c6aad055:"812","14ae68e7":"836","0029a336":"1171","7258860f":"1603","9af13eab":"1647","10ce918d":"2134","3c39daba":"2139","3e2b82eb":"2172","87a5fc8a":"2334","00e9d6a1":"2449","164937d2":"2571",ada86621:"3000",a3002291:"3085",reactPlayerVidyard:"3392","35dda5a2":"3724",a2ffcc0f:"3962",d1462701:"4024","3f29ba7c":"4406","86f2a982":"4769","8abd0ba5":"5004",fe0d4a0f:"5187","4b39f818":"5276",adcef0a2:"5451","46b3c144":"5556","473de3ed":"5646","708d858d":"5787",d83404a8:"6121",reactPlayerKaltura:"6463","1ee92283":"6704","4b8121dd":"7327","6aa0b043":"7406","48b6ff5f":"7446",c104141c:"7568","3ba80b69":"7766",fc8a94e3:"7832","5046ea8f":"8078","01a85c17":"8209","6269f1c0":"8402","640277b9":"8826",d178b2c6:"8848","7e2ae3df":"8870","67fccd64":"8936","94324b0e":"9072",f890fec4:"9332",cc922df3:"9383","2d629ea6":"9426",f16d562f:"9527","5e95c892":"9647",a08dfa31:"9767","014457dd":"9962","878aa0e7":"10010","23b35f70":"10107",e44de27e:"10673",e1a2ab10:"10906",a9fa5b1f:"11022",e6c31e60:"11084","28d80fa9":"11173",f7c9e078:"11532","6d8c157a":"11568",d651e2ee:"12036",reactPlayerTwitch:"12042",f9fb4395:"12065","9a22c80d":"12248",be228752:"12286","6bf124c2":"12401","23a8e291":"12618","871ce139":"12978","591f7a5f":"13037",da802cf4:"13365","70e3b13c":"13579","6c80b6fe":"13589","9c540f0b":"13680",a334b453:"13920",b8ec852b:"14036","5087625a":"14061",bd45720e:"14330",f6cf66bc:"15405","5a7aef43":"15607","9dd60997":"15663","5a3b561f":"15746",bd65ec7e:"15910","7be672a3":"15974",e6fb1369:"15985","4f9d299b":"16100","22e2140b":"16115","6eafe0c7":"16256",reactPlayerDailyMotion:"16328","610f2c47":"16344","30a9912a":"16425","0c14b239":"16583","7afa6340":"16709","8b4dd820":"17043","308aae28":"17159","4974f5d2":"17242","0cab2b3a":"17349","7144043e":"17387",db320b4a:"17397","07305c4a":"17652","56a9df4f":"17656","62e21724":"17796","5db8318c":"17853","9f2f2cb3":"18038","3a2db09e":"18121",c15d9823:"18146","5a9a7a02":"18445",reactPlayerYouTube:"18446",f4271232:"18538","4780c642":"18557","6101b3fc":"18609","17c68348":"18687",b678a236:"19060","1a906644":"19150","65a10ffa":"19763",edb40f78:"19789","524ce9a0":"20044",fff8aeb8:"20153","6494b798":"20228",b66ca8cf:"20286","8ae04122":"21076","107d77e6":"21126","0f54081d":"21381","724f3974":"21407","9db962b6":"21791",c1584a80:"21817",adfdec4a:"22051","09788c0c":"22319","0547cb65":"22405",f523fb3f:"22778","006e489c":"23512",ca1234c1:"23767","74b658de":"23960",df203c0f:"24279",fc923f19:"24478","4ec76dfa":"24593","97a89ac0":"24639","82170cf7":"24915",e546fc5a:"25184","3a38a610":"25492","280646e4":"25670",b9287eb6:"25774",e983a6d7:"26168",reactPlayerVimeo:"26173","360dc931":"26600","368cce37":"26693","1515c895":"26716","311d0508":"26929",fb50ea3a:"27262",d496897e:"27895","2f8f53cb":"27902",ff2f63f6:"28154","60c82955":"28341",f20efc55:"28645",a00af9f0:"28728",a4794f2e:"28757","5df556a2":"28903",ea3ffc82:"28917","7e93d479":"29099",b39cdcf9:"29634","9f90a44b":"29744",f1ad83b2:"29824","814402d7":"30487",cd343213:"30784","4d71dffe":"30862",ba5b9f11:"30962",fe1a05e2:"31438",ed603d23:"31502","04a546a4":"31672",cabda5f8:"31681","4b66c45e":"31718",d1c21237:"31774",d9673b17:"32428",c25913f3:"32467","901c37e5":"32500",cd7fa15a:"32689","12f1535e":"32923","185c52e7":"32993",ca6c9efa:"33167",b799648a:"33195",a2c6f402:"33253","09b168a7":"33331","81b69ac7":"33582",b5114993:"34055","2340b3ee":"34293","8eeedb31":"34318",a0323d9f:"34415","07f59c2a":"34428","1df93b7f":"34583",c9cac9d9:"34918",bab44fba:"34939","7547d3bb":"35111",e665718d:"35129",d83f208d:"35258","883e2c3c":"35272",d739767a:"35327",f771dec1:"35515","4bdb36b8":"35634","64bd32f2":"35644",dec87402:"35716",aba21aa0:"35742","3109d9d2":"36049",a3f8794a:"36104",fe716911:"36273",reactPlayerPreview:"36353",b6d76a6c:"36574","8dbb6800":"36901",e7923b27:"37012",cb0f21df:"37163","6477cdc2":"37561",a6aa9e1f:"37643","562ca3e9":"37709",d1163e47:"37736",c71cae97:"38311","512fbd77":"38341",d7fbbe43:"38752","7c7a772e":"38788","3b68f98c":"38802","3462068c":"38843",ef8b811a:"38947","01821883":"39004","46669adc":"39164","97eb992d":"39498",b51a9aee:"39590","7fa133e1":"40098","9c65fea5":"40117","815c93fd":"40228","16914cba":"40296",bb6a5560:"40304","0e3a398f":"40532",f6cd0d3d:"40555","148448cb":"40611","0433ef30":"40793",dc23cd40:"41052",e69dadab:"41067","64abd3af":"41266",bd80aa65:"41340","4ec4c6cd":"41697","64134c03":"41789","6b1fbd0a":"41949",e064f6d4:"42586","3866940b":"42607","8a864d1e":"42950","8fe4c488":"43079","786fee93":"43140","43f3fe28":"43164",caddb1c0:"43169",bf11c6a2:"43307","46cf64bb":"43320","5b10a003":"43425","3f797343":"43665",f86eb50f:"44183","2bbe04e6":"44261",f431c910:"44362","70bd0abb":"44413","7d3ae564":"44462","5b7d9ef2":"44693",b52d840d:"45226","160cb329":"45759",b3b7dd16:"45802",b15eeff9:"46252","33a21d7d":"46398",c2911623:"46666",d1b15a6d:"46741","8b4ba22f":"46850","22de4147":"47008","1949cc8d":"47422",e6163b65:"47479",reactPlayerStreamable:"47627","2f195bb0":"47798",f81c1134:"48130","981d19db":"48279","56c3a9b2":"48374","33f367df":"48507",fb8cd692:"48823","71c7597c":"48909","41b2e801":"49244","29931f43":"49606","06a27da2":"49808","7cde3c49":"49819",fd702dc7:"50024","330b5684":"50038","456c0e28":"50740","080a9824":"51023","0e72c11a":"51047","059d1c6a":"51162",e73930cf:"51181","59a6f192":"51594","91a39dd0":"51814",cdf64ea9:"52065",bdb8b81b:"52276",d4bf7e47:"52492","5ebdf64d":"52547","9e4087bc":"52711",reactPlayerMux:"52723",a943bcee:"52853",e84cabb0:"53064","0c4fad6b":"53113","416d4fcf":"53125","17612ae7":"53203","7500e360":"53225","5e30269e":"53410",ab69fe56:"53499",a2d1ff94:"53588","125d93c1":"53629",c1ca9e21:"53930","2f7d01f7":"54134","4816649b":"54329","40d377be":"54333",b2973dc4:"54427",a7777682:"54628","9e8f4e9c":"54642",e35d7c3e:"54646","873d332f":"54691","7aa856d6":"54727","9684f8b7":"54797","8ccdb99f":"55251",aaabcfd8:"55259",cf6b503e:"55395",e7477a94:"55543",deccabf3:"55756","4f425ff4":"55780",a38d285e:"55807",d4840880:"55979",d103759a:"56095","382e0557":"56500","8785b74d":"56576","5e486140":"56898",b5ec5208:"57577",a826efc5:"57689","4213e5b1":"57720","4c217c25":"57778","49bee2be":"57915","93e05602":"57947",ed1f6062:"58699","24dadce3":"58775","8c8ef21f":"58796",e1c8d71f:"59310",ef2e2003:"59660","1c93995d":"59818","065365b3":"59911",df4d464e:"60102","3a4a1d3a":"60261","1369aff7":"60404","1fc83a28":"60441",d46ef83d:"60759","42b67a8e":"61036","2ab17a83":"61216",a7456010:"61235",b5b19789:"61546",c358ebbc:"61634","1a4e3797":"62138","5660752d":"62662",de311ed4:"62824","01a1d0f4":"63090",b9a87183:"63156","17d2ebc8":"63805",ae79aff5:"64147","3d8d8999":"64169","92d7df62":"64179","621db11d":"64212","3132913e":"64374","95646edb":"64558",e38c422a:"64577",ed2a4846:"64605","9d2d4743":"64630","86e64757":"64679","97615df2":"65331","271ff0d1":"65608","3f66023b":"66045",c6346fcf:"66054",c239db97:"66414","814d49b7":"66622",a7bd4aaa:"67098","2bb2c1cd":"67402","814f3328":"67472",reactPlayerMixcloud:"67570","4f35c7a7":"67635","3819c331":"68026","7a957b04":"68170","79f18c88":"68171",e88443f3:"68598",c544b2d7:"68660","4c5becac":"68833",c0c3bda5:"68860","38f19abb":"69183",fbfd390f:"69215",c09ab32f:"69325","030ccfd9":"69345","0dd9aaeb":"69389","19eded63":"69416","4f9e8711":"69586","5bc09a53":"69597","38a042e4":"69656","423842d7":"69725",a35cf155:"69838",a847366a:"69935",cecc75bb:"69937",reactPlayerSoundCloud:"69979","91fe1403":"70062","8873cf50":"70073",a7fe0e50:"70142","330dfcdb":"70414","8cb0269b":"70423",ef5945f7:"70540","7bef3f04":"70542","6864e844":"70876","8ca0e442":"70986","688ee267":"71728",ae4a775b:"72231",df2a6e58:"72290",f26f8f05:"72456","8e49e0b0":"72526","97c7db18":"72972",d66cbd9e:"73008","73f18a6f":"73267","97d49594":"73318",cc6d9416:"73425",e0277333:"73553","016e89ec":"73588","450c2e30":"73607",a30c0d44:"73800","54d805e4":"73946","2658ced2":"74190","9542c76a":"74202","4cb6c19a":"74210",c5b2f0f9:"74238","81e486a8":"74260",d9407a00:"74358","920c2ac2":"74361","49d9416a":"74457",a9bc0f5d:"74501",a0c37fdd:"74785","39ae3791":"74937","0341d436":"75046","6763d4e0":"75056",cfdfe126:"75204",fee0a0be:"75315",edcfca88:"75687",bc873533:"76151","43be69c9":"76228","0fa6e9bf":"76430",fd684bd6:"76775","9d887a11":"77350","254d0ff5":"77353","1dfee34e":"77546",bc816bf2:"78007","52ea62e7":"78048",b104dd1e:"78110","2cb13d6d":"78170","69c5f318":"78258","5393540e":"78349","7b477840":"78434","021eaa84":"78465","905702d2":"78664",d7ed6ffb:"78707","74c26f41":"78848","12eb386e":"78989",a94703ab:"79048","898514b1":"79067","927c84a6":"79405",e3f28bf9:"79594",aba485c2:"79683",c813bd67:"79849","83245ae6":"79981",b8eb0fce:"80042",e6412603:"80348",ff38b1ce:"80353","714e70d1":"80714",c141421f:"80957","9286a297":"81497","67eba1be":"81634",c2865a15:"81898",acecf23e:"81903","1e582a71":"81961","94f3d131":"82060",b985118d:"82219","8677f412":"82244","1a16e8bf":"82479",ccc49370:"83249",ca165b51:"83313","612345e6":"83405","19e69ccd":"83509","8be8ac58":"83729","0e384e19":"83976","1cfced13":"83993",bb0cb288:"84000",b7bb2d93:"84052","16ce7fd2":"84539","3720c009":"84787","6875c492":"84813","54590fd2":"84874","7d88b63f":"85193","98ced590":"85462",af231220:"85784","7a21ccb0":"86040",b757e1e0:"86219","9f97f9d1":"86244",c7cac05f:"86693",reactPlayerFacebook:"86887",b4df9b48:"87246",fe9a92c0:"87438","7f0476bd":"87577",d5f6644b:"87986","874690d0":"88041",fefd9738:"88375","57dba496":"88499","78b70dba":"88576",bbf561d5:"88614",db22fd17:"88623","5c25e6fa":"88930","6774f806":"89507","180d0c5f":"89634","36994c47":"89858","0877aebd":"89885","73f9658e":"89904","8c6c72f9":"90305","604e05e4":"90418",d9b4ee1e:"90488","49a2e93c":"90619","6e92edd9":"90735","24bda87b":"90843","0058b4c6":"90849","0102eb3e":"90989","232c546d":"91638","7e5a2776":"91643","732d4d9b":"91746",ed75cfcb:"92388","25d1f3de":"92449",c8eb055e:"92456",a33d13d7:"92553","8519c2b0":"92749",c44aa824:"92834","894e67a6":"93031",c361d244:"93520","3d6cee82":"93655","3289a752":"93744","931e3b0a":"93891","6603ef13":"93897","6e30ac7b":"94054","57e01cd5":"94209",cd23aec9:"94365",adb00d9a:"94468","7d9edfb8":"94692","1d31e443":"94892","6eb49eac":"94964","92b08985":"95044",f644aac7:"95275","494e8e75":"95314",b6be2912:"95322","86f8c256":"95505",aca8b082:"95576",abc85917:"95645","825ec378":"95696",b7746a44:"95904","57a8015d":"96170","6a1fe514":"96220",f7197f43:"96316",c2e1e282:"96357","51e516cc":"96420","583db3ef":"96549",f0e3a130:"96906",a8ce95ee:"97120",c11c87f7:"97161","1fbe0675":"97331",reactPlayerFilePlayer:"97458","123a454a":"97550",ffbee6a9:"97623",f27eaf88:"98458",fa5f999e:"98537","86063cd3":"98910",reactPlayerWistia:"99340","5fb93fc0":"99795","5e8fbcdf":"99872"}[e]||e,t.p+t.u(e)},(()=>{var e={45354:0,71869:0};t.f.j=(a,f)=>{var c=t.o(e,a)?e[a]:void 0;if(0!==c)if(c)f.push(c[2]);else if(/^(45354|71869)$/.test(a))e[a]=0;else{var d=new Promise(((f,d)=>c=e[a]=[f,d]));f.push(c[2]=d);var b=t.p+t.u(a),r=new Error;t.l(b,(f=>{if(t.o(e,a)&&(0!==(c=e[a])&&(e[a]=void 0),c)){var d=f&&("load"===f.type?"missing":f.type),b=f&&f.target&&f.target.src;r.message="Loading chunk "+a+" failed.\n("+d+": "+b+")",r.name="ChunkLoadError",r.type=d,r.request=b,c[1](r)}}),"chunk-"+a,a)}},t.O.j=a=>0===e[a];var a=(a,f)=>{var c,d,b=f[0],r=f[1],o=f[2],l=0;if(b.some((a=>0!==e[a]))){for(c in r)t.o(r,c)&&(t.m[c]=r[c]);if(o)var n=o(t)}for(a&&a(f);l - + diff --git a/blog/2024/08/01/using-rhel-wsl-podman-machine.html b/blog/2024/08/01/using-rhel-wsl-podman-machine.html index 9e780bf0e8a..6a42f19e288 100644 --- a/blog/2024/08/01/using-rhel-wsl-podman-machine.html +++ b/blog/2024/08/01/using-rhel-wsl-podman-machine.html @@ -13,7 +13,7 @@ - + diff --git a/blog/5-things-to-know-for-a-docker-user.html b/blog/5-things-to-know-for-a-docker-user.html index 72ed1d36a10..1444704a42f 100644 --- a/blog/5-things-to-know-for-a-docker-user.html +++ b/blog/5-things-to-know-for-a-docker-user.html @@ -13,7 +13,7 @@ - + diff --git a/blog/archive.html b/blog/archive.html index e70f6ec09fe..81780c2f322 100644 --- a/blog/archive.html +++ b/blog/archive.html @@ -13,7 +13,7 @@ - + diff --git a/blog/authors.html b/blog/authors.html index 1303814553a..457ed067a11 100644 --- a/blog/authors.html +++ b/blog/authors.html @@ -13,7 +13,7 @@ - + diff --git a/blog/develop-using-devcontainer.html b/blog/develop-using-devcontainer.html index e103f6549bb..9c8c9e9ef9d 100644 --- a/blog/develop-using-devcontainer.html +++ b/blog/develop-using-devcontainer.html @@ -13,7 +13,7 @@ - + diff --git a/blog/getting-started-with-compose.html b/blog/getting-started-with-compose.html index 6c30773d97d..87126714146 100644 --- a/blog/getting-started-with-compose.html +++ b/blog/getting-started-with-compose.html @@ -13,7 +13,7 @@ - + diff --git a/blog/podman-desktop-release-0.10.html b/blog/podman-desktop-release-0.10.html index 15cc8b03e17..68413967151 100644 --- a/blog/podman-desktop-release-0.10.html +++ b/blog/podman-desktop-release-0.10.html @@ -13,7 +13,7 @@ - + diff --git a/blog/podman-desktop-release-0.11.html b/blog/podman-desktop-release-0.11.html index 13189d03ebc..a4bfe6aa3d7 100644 --- a/blog/podman-desktop-release-0.11.html +++ b/blog/podman-desktop-release-0.11.html @@ -13,7 +13,7 @@ - + diff --git a/blog/podman-desktop-release-0.12.html b/blog/podman-desktop-release-0.12.html index 2cf04227e0b..e649faea4e9 100644 --- a/blog/podman-desktop-release-0.12.html +++ b/blog/podman-desktop-release-0.12.html @@ -13,7 +13,7 @@ - + diff --git a/blog/podman-desktop-release-0.13.html b/blog/podman-desktop-release-0.13.html index 9148b08514c..b393054627a 100644 --- a/blog/podman-desktop-release-0.13.html +++ b/blog/podman-desktop-release-0.13.html @@ -13,7 +13,7 @@ - + diff --git a/blog/podman-desktop-release-0.14.html b/blog/podman-desktop-release-0.14.html index 88661cf1ec0..ab383e76306 100644 --- a/blog/podman-desktop-release-0.14.html +++ b/blog/podman-desktop-release-0.14.html @@ -13,7 +13,7 @@ - + diff --git a/blog/podman-desktop-release-0.15.html b/blog/podman-desktop-release-0.15.html index 7c75191e964..1eb6c56a8a0 100644 --- a/blog/podman-desktop-release-0.15.html +++ b/blog/podman-desktop-release-0.15.html @@ -13,7 +13,7 @@ - + diff --git a/blog/podman-desktop-release-1.0.html b/blog/podman-desktop-release-1.0.html index 53599274bca..68a81efe3cb 100644 --- a/blog/podman-desktop-release-1.0.html +++ b/blog/podman-desktop-release-1.0.html @@ -13,7 +13,7 @@ - + diff --git a/blog/podman-desktop-release-1.1.html b/blog/podman-desktop-release-1.1.html index 29fa32a7064..20d388b2bd7 100644 --- a/blog/podman-desktop-release-1.1.html +++ b/blog/podman-desktop-release-1.1.html @@ -13,7 +13,7 @@ - + diff --git a/blog/podman-desktop-release-1.10.html b/blog/podman-desktop-release-1.10.html index b9297c5fae5..9f6fa82b860 100644 --- a/blog/podman-desktop-release-1.10.html +++ b/blog/podman-desktop-release-1.10.html @@ -13,7 +13,7 @@ - + diff --git a/blog/podman-desktop-release-1.11.html b/blog/podman-desktop-release-1.11.html index 54c35e431c3..f57330b9dd3 100644 --- a/blog/podman-desktop-release-1.11.html +++ b/blog/podman-desktop-release-1.11.html @@ -13,7 +13,7 @@ - + diff --git a/blog/podman-desktop-release-1.12.html b/blog/podman-desktop-release-1.12.html index 52c057f904b..bef4913ff7a 100644 --- a/blog/podman-desktop-release-1.12.html +++ b/blog/podman-desktop-release-1.12.html @@ -13,7 +13,7 @@ - + diff --git a/blog/podman-desktop-release-1.2.html b/blog/podman-desktop-release-1.2.html index 210393bf2dc..db3f0ac6a4a 100644 --- a/blog/podman-desktop-release-1.2.html +++ b/blog/podman-desktop-release-1.2.html @@ -13,7 +13,7 @@ - + diff --git a/blog/podman-desktop-release-1.3.html b/blog/podman-desktop-release-1.3.html index 98f428f687c..e49699aefe7 100644 --- a/blog/podman-desktop-release-1.3.html +++ b/blog/podman-desktop-release-1.3.html @@ -13,7 +13,7 @@ - + diff --git a/blog/podman-desktop-release-1.4.html b/blog/podman-desktop-release-1.4.html index 553e320bb03..b92ea2375ea 100644 --- a/blog/podman-desktop-release-1.4.html +++ b/blog/podman-desktop-release-1.4.html @@ -13,7 +13,7 @@ - + diff --git a/blog/podman-desktop-release-1.5.html b/blog/podman-desktop-release-1.5.html index 90ae1fa6413..ae0dbdffea3 100644 --- a/blog/podman-desktop-release-1.5.html +++ b/blog/podman-desktop-release-1.5.html @@ -13,7 +13,7 @@ - + diff --git a/blog/podman-desktop-release-1.6.html b/blog/podman-desktop-release-1.6.html index 9a2ce739cef..0d2d67551e0 100644 --- a/blog/podman-desktop-release-1.6.html +++ b/blog/podman-desktop-release-1.6.html @@ -13,7 +13,7 @@ - + diff --git a/blog/podman-desktop-release-1.7.html b/blog/podman-desktop-release-1.7.html index 400c4a652c0..ac6c752c0dc 100644 --- a/blog/podman-desktop-release-1.7.html +++ b/blog/podman-desktop-release-1.7.html @@ -13,7 +13,7 @@ - + diff --git a/blog/podman-desktop-release-1.8.html b/blog/podman-desktop-release-1.8.html index 045e7e54eac..a7f009674d1 100644 --- a/blog/podman-desktop-release-1.8.html +++ b/blog/podman-desktop-release-1.8.html @@ -13,7 +13,7 @@ - + diff --git a/blog/podman-desktop-release-1.9.html b/blog/podman-desktop-release-1.9.html index 9b423e5daa4..f5bac2f845b 100644 --- a/blog/podman-desktop-release-1.9.html +++ b/blog/podman-desktop-release-1.9.html @@ -13,7 +13,7 @@ - + diff --git a/blog/podman-desktop-wins-devies-award.html b/blog/podman-desktop-wins-devies-award.html index 6a3cc104ebb..f65f0c6562c 100644 --- a/blog/podman-desktop-wins-devies-award.html +++ b/blog/podman-desktop-wins-devies-award.html @@ -13,7 +13,7 @@ - + diff --git a/blog/running-a-local-kubernetes-cluster-with-podman-desktop.html b/blog/running-a-local-kubernetes-cluster-with-podman-desktop.html index e5b13eb259e..a93d2dcb91a 100644 --- a/blog/running-a-local-kubernetes-cluster-with-podman-desktop.html +++ b/blog/running-a-local-kubernetes-cluster-with-podman-desktop.html @@ -13,7 +13,7 @@ - + diff --git a/blog/sharing-podman-images-with-kubernetes-cluster.html b/blog/sharing-podman-images-with-kubernetes-cluster.html index d928824f792..3ebd28224dc 100644 --- a/blog/sharing-podman-images-with-kubernetes-cluster.html +++ b/blog/sharing-podman-images-with-kubernetes-cluster.html @@ -13,7 +13,7 @@ - + diff --git a/blog/tags.html b/blog/tags.html index 3c987403b91..974f3f196a3 100644 --- a/blog/tags.html +++ b/blog/tags.html @@ -13,7 +13,7 @@ - + diff --git a/blog/tags/award.html b/blog/tags/award.html index 21f3d55647c..9cf0bad2cbd 100644 --- a/blog/tags/award.html +++ b/blog/tags/award.html @@ -13,7 +13,7 @@ - + diff --git a/blog/tags/codespaces.html b/blog/tags/codespaces.html index 57e94cc9879..2997316e5c3 100644 --- a/blog/tags/codespaces.html +++ b/blog/tags/codespaces.html @@ -13,7 +13,7 @@ - + diff --git a/blog/tags/compose.html b/blog/tags/compose.html index d79fc24032b..3385510061f 100644 --- a/blog/tags/compose.html +++ b/blog/tags/compose.html @@ -13,7 +13,7 @@ - + diff --git a/blog/tags/containerfile.html b/blog/tags/containerfile.html index 89aec4aacc7..fd5b524ad94 100644 --- a/blog/tags/containerfile.html +++ b/blog/tags/containerfile.html @@ -13,7 +13,7 @@ - + diff --git a/blog/tags/containers.html b/blog/tags/containers.html index bb541ba496c..36469057395 100644 --- a/blog/tags/containers.html +++ b/blog/tags/containers.html @@ -13,7 +13,7 @@ - + diff --git a/blog/tags/devcontainer.html b/blog/tags/devcontainer.html index c6007c2d04f..0315976b201 100644 --- a/blog/tags/devcontainer.html +++ b/blog/tags/devcontainer.html @@ -13,7 +13,7 @@ - + diff --git a/blog/tags/docker-compose.html b/blog/tags/docker-compose.html index 9f84adbd3d7..179e4ed363f 100644 --- a/blog/tags/docker-compose.html +++ b/blog/tags/docker-compose.html @@ -13,7 +13,7 @@ - + diff --git a/blog/tags/docker.html b/blog/tags/docker.html index 9b2ea8d6a57..a719364c0ca 100644 --- a/blog/tags/docker.html +++ b/blog/tags/docker.html @@ -13,7 +13,7 @@ - + diff --git a/blog/tags/dockerfile.html b/blog/tags/dockerfile.html index 71975365ee7..b243c801cc6 100644 --- a/blog/tags/dockerfile.html +++ b/blog/tags/dockerfile.html @@ -13,7 +13,7 @@ - + diff --git a/blog/tags/extensions.html b/blog/tags/extensions.html index f4288fb5d94..a9d20d6076e 100644 --- a/blog/tags/extensions.html +++ b/blog/tags/extensions.html @@ -13,7 +13,7 @@ - + diff --git a/blog/tags/images.html b/blog/tags/images.html index ee82cc93cfb..8cf6f08ad90 100644 --- a/blog/tags/images.html +++ b/blog/tags/images.html @@ -13,7 +13,7 @@ - + diff --git a/blog/tags/kind.html b/blog/tags/kind.html index 6f0e984d4cc..919aa0988ef 100644 --- a/blog/tags/kind.html +++ b/blog/tags/kind.html @@ -13,7 +13,7 @@ - + diff --git a/blog/tags/kubernetes.html b/blog/tags/kubernetes.html index f3682e3a113..8b6b5ef699b 100644 --- a/blog/tags/kubernetes.html +++ b/blog/tags/kubernetes.html @@ -13,7 +13,7 @@ - + diff --git a/blog/tags/machine.html b/blog/tags/machine.html index f54166ecf4b..c9570ed8c26 100644 --- a/blog/tags/machine.html +++ b/blog/tags/machine.html @@ -13,7 +13,7 @@ - + diff --git a/blog/tags/migrating.html b/blog/tags/migrating.html index c4d2732413a..4a5618eae2e 100644 --- a/blog/tags/migrating.html +++ b/blog/tags/migrating.html @@ -13,7 +13,7 @@ - + diff --git a/blog/tags/multi-container.html b/blog/tags/multi-container.html index 55e2dfcadd1..e2c28141ee7 100644 --- a/blog/tags/multi-container.html +++ b/blog/tags/multi-container.html @@ -13,7 +13,7 @@ - + diff --git a/blog/tags/onboarding.html b/blog/tags/onboarding.html index e9cb82dcf49..54ee1e696de 100644 --- a/blog/tags/onboarding.html +++ b/blog/tags/onboarding.html @@ -13,7 +13,7 @@ - + diff --git a/blog/tags/openshift.html b/blog/tags/openshift.html index 81fbd0182bc..2f0c44f79c4 100644 --- a/blog/tags/openshift.html +++ b/blog/tags/openshift.html @@ -13,7 +13,7 @@ - + diff --git a/blog/tags/podman-desktop.html b/blog/tags/podman-desktop.html index 0c6c1827090..3ff62327e11 100644 --- a/blog/tags/podman-desktop.html +++ b/blog/tags/podman-desktop.html @@ -13,7 +13,7 @@ - + diff --git a/blog/tags/podman.html b/blog/tags/podman.html index a91f24ad301..e87fac97c5f 100644 --- a/blog/tags/podman.html +++ b/blog/tags/podman.html @@ -13,7 +13,7 @@ - + diff --git a/blog/tags/release.html b/blog/tags/release.html index 9543299f5b7..9775053e783 100644 --- a/blog/tags/release.html +++ b/blog/tags/release.html @@ -13,7 +13,7 @@ - + diff --git a/blog/tags/rhel.html b/blog/tags/rhel.html index 89a41452e7a..093f5cc4ebe 100644 --- a/blog/tags/rhel.html +++ b/blog/tags/rhel.html @@ -13,7 +13,7 @@ - + diff --git a/blog/tags/settings.html b/blog/tags/settings.html index 4c41e500abc..71bd72bb75f 100644 --- a/blog/tags/settings.html +++ b/blog/tags/settings.html @@ -13,7 +13,7 @@ - + diff --git a/blog/tags/story.html b/blog/tags/story.html index c9641bd0a80..ba0311215df 100644 --- a/blog/tags/story.html +++ b/blog/tags/story.html @@ -13,7 +13,7 @@ - + diff --git a/blog/tags/wasi.html b/blog/tags/wasi.html index 65634eb400a..e90efdeddf9 100644 --- a/blog/tags/wasi.html +++ b/blog/tags/wasi.html @@ -13,7 +13,7 @@ - + diff --git a/blog/tags/wasm.html b/blog/tags/wasm.html index 8858b6e9962..60779a4ed20 100644 --- a/blog/tags/wasm.html +++ b/blog/tags/wasm.html @@ -13,7 +13,7 @@ - + diff --git a/blog/tags/web-assembly.html b/blog/tags/web-assembly.html index abbb904a394..ac77f48e56a 100644 --- a/blog/tags/web-assembly.html +++ b/blog/tags/web-assembly.html @@ -13,7 +13,7 @@ - + diff --git a/blog/tags/wsl.html b/blog/tags/wsl.html index bdddb8a4f9e..1fce296d631 100644 --- a/blog/tags/wsl.html +++ b/blog/tags/wsl.html @@ -13,7 +13,7 @@ - + diff --git a/blog/wasm-workloads-on-macos-and-windows-with-podman.html b/blog/wasm-workloads-on-macos-and-windows-with-podman.html index fb925e7c16a..7f76c3700cc 100644 --- a/blog/wasm-workloads-on-macos-and-windows-with-podman.html +++ b/blog/wasm-workloads-on-macos-and-windows-with-podman.html @@ -13,7 +13,7 @@ - + diff --git a/core-values.html b/core-values.html index 533f252273c..2a8d5380d6d 100644 --- a/core-values.html +++ b/core-values.html @@ -13,7 +13,7 @@ - + diff --git a/docs/ai-lab.html b/docs/ai-lab.html index 8d45fa0fa87..ee45b6d1c68 100644 --- a/docs/ai-lab.html +++ b/docs/ai-lab.html @@ -13,7 +13,7 @@ - + diff --git a/docs/ai-lab/create-playground.html b/docs/ai-lab/create-playground.html index c4c4d778e6b..17d458b8ea2 100644 --- a/docs/ai-lab/create-playground.html +++ b/docs/ai-lab/create-playground.html @@ -13,7 +13,7 @@ - + diff --git a/docs/ai-lab/download-model.html b/docs/ai-lab/download-model.html index 360087160a9..b549585986b 100644 --- a/docs/ai-lab/download-model.html +++ b/docs/ai-lab/download-model.html @@ -13,7 +13,7 @@ - + diff --git a/docs/ai-lab/installing.html b/docs/ai-lab/installing.html index 148acf1d30c..9adfe9970c1 100644 --- a/docs/ai-lab/installing.html +++ b/docs/ai-lab/installing.html @@ -13,7 +13,7 @@ - + diff --git a/docs/ai-lab/start-inference-server.html b/docs/ai-lab/start-inference-server.html index c779d73eb38..a28434583dd 100644 --- a/docs/ai-lab/start-inference-server.html +++ b/docs/ai-lab/start-inference-server.html @@ -13,7 +13,7 @@ - + diff --git a/docs/ai-lab/start-recipe.html b/docs/ai-lab/start-recipe.html index 79e9a90e38e..bde4e42b7ae 100644 --- a/docs/ai-lab/start-recipe.html +++ b/docs/ai-lab/start-recipe.html @@ -13,7 +13,7 @@ - + diff --git a/docs/compose.html b/docs/compose.html index 7e1754831b8..3f9713da149 100644 --- a/docs/compose.html +++ b/docs/compose.html @@ -13,7 +13,7 @@ - + diff --git a/docs/compose/running-compose.html b/docs/compose/running-compose.html index 0ecfd533a43..63534cf2405 100644 --- a/docs/compose/running-compose.html +++ b/docs/compose/running-compose.html @@ -13,7 +13,7 @@ - + diff --git a/docs/compose/setting-up-compose.html b/docs/compose/setting-up-compose.html index 5a8c915a63d..009acdea408 100644 --- a/docs/compose/setting-up-compose.html +++ b/docs/compose/setting-up-compose.html @@ -13,7 +13,7 @@ - + diff --git a/docs/compose/troubleshooting.html b/docs/compose/troubleshooting.html index 7f52cf26827..01d00215991 100644 --- a/docs/compose/troubleshooting.html +++ b/docs/compose/troubleshooting.html @@ -13,7 +13,7 @@ - + diff --git a/docs/containers.html b/docs/containers.html index 75ccf3f2bf0..cb2678ebc52 100644 --- a/docs/containers.html +++ b/docs/containers.html @@ -13,7 +13,7 @@ - + diff --git a/docs/containers/creating-a-pod.html b/docs/containers/creating-a-pod.html index acf88be2c5c..b13a1355966 100644 --- a/docs/containers/creating-a-pod.html +++ b/docs/containers/creating-a-pod.html @@ -13,7 +13,7 @@ - + diff --git a/docs/containers/images.html b/docs/containers/images.html index e3556773225..bf561f0e266 100644 --- a/docs/containers/images.html +++ b/docs/containers/images.html @@ -13,7 +13,7 @@ - + diff --git a/docs/containers/images/building-an-image.html b/docs/containers/images/building-an-image.html index 7b72933b765..45373304816 100644 --- a/docs/containers/images/building-an-image.html +++ b/docs/containers/images/building-an-image.html @@ -13,7 +13,7 @@ - + diff --git a/docs/containers/images/pulling-an-image.html b/docs/containers/images/pulling-an-image.html index 5aa2a05d020..85caba6be31 100644 --- a/docs/containers/images/pulling-an-image.html +++ b/docs/containers/images/pulling-an-image.html @@ -13,7 +13,7 @@ - + diff --git a/docs/containers/images/pushing-an-image-to-a-registry.html b/docs/containers/images/pushing-an-image-to-a-registry.html index f7b7974936f..a69d01b6ad3 100644 --- a/docs/containers/images/pushing-an-image-to-a-registry.html +++ b/docs/containers/images/pushing-an-image-to-a-registry.html @@ -13,7 +13,7 @@ - + diff --git a/docs/containers/onboarding.html b/docs/containers/onboarding.html index f19dae752dd..13d860a7e3d 100644 --- a/docs/containers/onboarding.html +++ b/docs/containers/onboarding.html @@ -13,7 +13,7 @@ - + diff --git a/docs/containers/registries.html b/docs/containers/registries.html index 9fa0c7056e3..2b975ec1b61 100644 --- a/docs/containers/registries.html +++ b/docs/containers/registries.html @@ -13,7 +13,7 @@ - + diff --git a/docs/containers/starting-a-container.html b/docs/containers/starting-a-container.html index f155f56aae9..7a01c9d16ac 100644 --- a/docs/containers/starting-a-container.html +++ b/docs/containers/starting-a-container.html @@ -13,7 +13,7 @@ - + diff --git a/docs/extensions.html b/docs/extensions.html index 9bbcc990f52..ab33c4216e2 100644 --- a/docs/extensions.html +++ b/docs/extensions.html @@ -13,7 +13,7 @@ - + diff --git a/docs/extensions/api.html b/docs/extensions/api.html index f85806d340e..c3a8734a921 100644 --- a/docs/extensions/api.html +++ b/docs/extensions/api.html @@ -13,7 +13,7 @@ - + diff --git a/docs/extensions/developing.html b/docs/extensions/developing.html index ce92734f361..b40d9b3d96c 100644 --- a/docs/extensions/developing.html +++ b/docs/extensions/developing.html @@ -13,7 +13,7 @@ - + diff --git a/docs/extensions/developing/adding-icons.html b/docs/extensions/developing/adding-icons.html index 45b608c653c..2412267e772 100644 --- a/docs/extensions/developing/adding-icons.html +++ b/docs/extensions/developing/adding-icons.html @@ -13,7 +13,7 @@ - + diff --git a/docs/extensions/developing/command-palette.html b/docs/extensions/developing/command-palette.html index 69957d76b4f..e9a166c584b 100644 --- a/docs/extensions/developing/command-palette.html +++ b/docs/extensions/developing/command-palette.html @@ -13,7 +13,7 @@ - + diff --git a/docs/extensions/developing/commands.html b/docs/extensions/developing/commands.html index 171d8246532..1be3e34192b 100644 --- a/docs/extensions/developing/commands.html +++ b/docs/extensions/developing/commands.html @@ -13,7 +13,7 @@ - + diff --git a/docs/extensions/developing/config.html b/docs/extensions/developing/config.html index 1b532a305d5..330333e2809 100644 --- a/docs/extensions/developing/config.html +++ b/docs/extensions/developing/config.html @@ -13,7 +13,7 @@ - + diff --git a/docs/extensions/developing/menu.html b/docs/extensions/developing/menu.html index 83e95a3fe63..10a2d0922b5 100644 --- a/docs/extensions/developing/menu.html +++ b/docs/extensions/developing/menu.html @@ -13,7 +13,7 @@ - + diff --git a/docs/extensions/developing/onboarding-workflow.html b/docs/extensions/developing/onboarding-workflow.html index 3756440a16e..ecdcce6d4bd 100644 --- a/docs/extensions/developing/onboarding-workflow.html +++ b/docs/extensions/developing/onboarding-workflow.html @@ -13,7 +13,7 @@ - + diff --git a/docs/extensions/developing/when-clause-context.html b/docs/extensions/developing/when-clause-context.html index 660717e5c71..5ac0e0c2887 100644 --- a/docs/extensions/developing/when-clause-context.html +++ b/docs/extensions/developing/when-clause-context.html @@ -13,7 +13,7 @@ - + diff --git a/docs/extensions/install.html b/docs/extensions/install.html index baf87d036ee..d86263e9bc5 100644 --- a/docs/extensions/install.html +++ b/docs/extensions/install.html @@ -13,7 +13,7 @@ - + diff --git a/docs/extensions/publish.html b/docs/extensions/publish.html index fd5ad7bfe2f..a97bd8440e9 100644 --- a/docs/extensions/publish.html +++ b/docs/extensions/publish.html @@ -13,7 +13,7 @@ - + diff --git a/docs/extensions/templates.html b/docs/extensions/templates.html index 3b67f868b96..b341148d751 100644 --- a/docs/extensions/templates.html +++ b/docs/extensions/templates.html @@ -13,7 +13,7 @@ - + diff --git a/docs/installation.html b/docs/installation.html index cc04d856079..20f43927893 100644 --- a/docs/installation.html +++ b/docs/installation.html @@ -13,7 +13,7 @@ - + diff --git a/docs/installation/linux-install.html b/docs/installation/linux-install.html index b591e9119f7..0c76c267fe2 100644 --- a/docs/installation/linux-install.html +++ b/docs/installation/linux-install.html @@ -13,7 +13,7 @@ - + diff --git a/docs/installation/linux-install/installing-podman-desktop-from-a-flatpak-bundle.html b/docs/installation/linux-install/installing-podman-desktop-from-a-flatpak-bundle.html index 6774e9a3a47..45308ae57af 100644 --- a/docs/installation/linux-install/installing-podman-desktop-from-a-flatpak-bundle.html +++ b/docs/installation/linux-install/installing-podman-desktop-from-a-flatpak-bundle.html @@ -13,7 +13,7 @@ - + diff --git a/docs/installation/macos-install.html b/docs/installation/macos-install.html index 13c8411ca87..9b26b769cf5 100644 --- a/docs/installation/macos-install.html +++ b/docs/installation/macos-install.html @@ -13,7 +13,7 @@ - + diff --git a/docs/installation/windows-install.html b/docs/installation/windows-install.html index fe9c694ca85..bb169e729f8 100644 --- a/docs/installation/windows-install.html +++ b/docs/installation/windows-install.html @@ -13,7 +13,7 @@ - + diff --git a/docs/intro.html b/docs/intro.html index 6324535b190..49d0b06864e 100644 --- a/docs/intro.html +++ b/docs/intro.html @@ -13,7 +13,7 @@ - + diff --git a/docs/kind.html b/docs/kind.html index bce0fc6b05a..966171ae5ec 100644 --- a/docs/kind.html +++ b/docs/kind.html @@ -13,7 +13,7 @@ - + diff --git a/docs/kind/building-an-image-and-testing-it-in-kind.html b/docs/kind/building-an-image-and-testing-it-in-kind.html index fed91204003..0c6044d3138 100644 --- a/docs/kind/building-an-image-and-testing-it-in-kind.html +++ b/docs/kind/building-an-image-and-testing-it-in-kind.html @@ -13,7 +13,7 @@ - + diff --git a/docs/kind/configuring-podman-for-kind-on-windows.html b/docs/kind/configuring-podman-for-kind-on-windows.html index fc35ee4d587..aff7efbcc50 100644 --- a/docs/kind/configuring-podman-for-kind-on-windows.html +++ b/docs/kind/configuring-podman-for-kind-on-windows.html @@ -13,7 +13,7 @@ - + diff --git a/docs/kind/creating-a-kind-cluster.html b/docs/kind/creating-a-kind-cluster.html index 33939ff5454..9fdb39e513f 100644 --- a/docs/kind/creating-a-kind-cluster.html +++ b/docs/kind/creating-a-kind-cluster.html @@ -13,7 +13,7 @@ - + diff --git a/docs/kind/deleting-your-kind-cluster.html b/docs/kind/deleting-your-kind-cluster.html index a9cc661ea90..3663042d44a 100644 --- a/docs/kind/deleting-your-kind-cluster.html +++ b/docs/kind/deleting-your-kind-cluster.html @@ -13,7 +13,7 @@ - + diff --git a/docs/kind/installing.html b/docs/kind/installing.html index 23cb2aae6c8..698eb4d717e 100644 --- a/docs/kind/installing.html +++ b/docs/kind/installing.html @@ -13,7 +13,7 @@ - + diff --git a/docs/kind/pushing-an-image-to-kind.html b/docs/kind/pushing-an-image-to-kind.html index b7d673b41b5..488731df4c2 100644 --- a/docs/kind/pushing-an-image-to-kind.html +++ b/docs/kind/pushing-an-image-to-kind.html @@ -13,7 +13,7 @@ - + diff --git a/docs/kind/restarting-your-kind-cluster.html b/docs/kind/restarting-your-kind-cluster.html index 0a93839a957..c08bec7ffc9 100644 --- a/docs/kind/restarting-your-kind-cluster.html +++ b/docs/kind/restarting-your-kind-cluster.html @@ -13,7 +13,7 @@ - + diff --git a/docs/kind/working-with-your-local-kind-cluster.html b/docs/kind/working-with-your-local-kind-cluster.html index c9b0f736eb6..b7711545111 100644 --- a/docs/kind/working-with-your-local-kind-cluster.html +++ b/docs/kind/working-with-your-local-kind-cluster.html @@ -13,7 +13,7 @@ - + diff --git a/docs/kubernetes.html b/docs/kubernetes.html index 4fbeaaa13c5..5ce97327662 100644 --- a/docs/kubernetes.html +++ b/docs/kubernetes.html @@ -13,7 +13,7 @@ - + diff --git a/docs/kubernetes/deploying-a-container-to-kubernetes.html b/docs/kubernetes/deploying-a-container-to-kubernetes.html index f96e256abce..b869f677529 100644 --- a/docs/kubernetes/deploying-a-container-to-kubernetes.html +++ b/docs/kubernetes/deploying-a-container-to-kubernetes.html @@ -13,7 +13,7 @@ - + diff --git a/docs/kubernetes/deploying-a-pod-to-kubernetes.html b/docs/kubernetes/deploying-a-pod-to-kubernetes.html index a86e1d8635b..94d357c1751 100644 --- a/docs/kubernetes/deploying-a-pod-to-kubernetes.html +++ b/docs/kubernetes/deploying-a-pod-to-kubernetes.html @@ -13,7 +13,7 @@ - + diff --git a/docs/kubernetes/existing-kubernetes.html b/docs/kubernetes/existing-kubernetes.html index e8571a61c27..eef0bd966c2 100644 --- a/docs/kubernetes/existing-kubernetes.html +++ b/docs/kubernetes/existing-kubernetes.html @@ -13,7 +13,7 @@ - + diff --git a/docs/kubernetes/kind/pushing-an-image-to-kind.html b/docs/kubernetes/kind/pushing-an-image-to-kind.html index acc4a76af5f..88976ee8caf 100644 --- a/docs/kubernetes/kind/pushing-an-image-to-kind.html +++ b/docs/kubernetes/kind/pushing-an-image-to-kind.html @@ -13,7 +13,7 @@ - + diff --git a/docs/kubernetes/lima/pushing-an-image-to-lima.html b/docs/kubernetes/lima/pushing-an-image-to-lima.html index 09ee64c7fd0..942da20814c 100644 --- a/docs/kubernetes/lima/pushing-an-image-to-lima.html +++ b/docs/kubernetes/lima/pushing-an-image-to-lima.html @@ -13,7 +13,7 @@ - + diff --git a/docs/kubernetes/minikube/pushing-an-image-to-minikube.html b/docs/kubernetes/minikube/pushing-an-image-to-minikube.html index b2a8bf649a1..7c699cf5fff 100644 --- a/docs/kubernetes/minikube/pushing-an-image-to-minikube.html +++ b/docs/kubernetes/minikube/pushing-an-image-to-minikube.html @@ -13,7 +13,7 @@ - + diff --git a/docs/kubernetes/viewing-and-selecting-current-kubernetes-context.html b/docs/kubernetes/viewing-and-selecting-current-kubernetes-context.html index a86e1f4c28f..4f310cec3f3 100644 --- a/docs/kubernetes/viewing-and-selecting-current-kubernetes-context.html +++ b/docs/kubernetes/viewing-and-selecting-current-kubernetes-context.html @@ -13,7 +13,7 @@ - + diff --git a/docs/lima.html b/docs/lima.html index 9ccb596ddea..727a593e84e 100644 --- a/docs/lima.html +++ b/docs/lima.html @@ -13,7 +13,7 @@ - + diff --git a/docs/lima/creating-a-kubernetes-instance.html b/docs/lima/creating-a-kubernetes-instance.html index 5ef78ab9a4c..fb9b14a31b2 100644 --- a/docs/lima/creating-a-kubernetes-instance.html +++ b/docs/lima/creating-a-kubernetes-instance.html @@ -13,7 +13,7 @@ - + diff --git a/docs/lima/creating-a-lima-instance.html b/docs/lima/creating-a-lima-instance.html index 195b2d90707..75d5c784732 100644 --- a/docs/lima/creating-a-lima-instance.html +++ b/docs/lima/creating-a-lima-instance.html @@ -13,7 +13,7 @@ - + diff --git a/docs/lima/customizing.html b/docs/lima/customizing.html index 106e8e47b94..5e6713fa7ad 100644 --- a/docs/lima/customizing.html +++ b/docs/lima/customizing.html @@ -13,7 +13,7 @@ - + diff --git a/docs/lima/installing.html b/docs/lima/installing.html index d8636d1562d..5d696955a3e 100644 --- a/docs/lima/installing.html +++ b/docs/lima/installing.html @@ -13,7 +13,7 @@ - + diff --git a/docs/migrating-from-docker.html b/docs/migrating-from-docker.html index 2096e1a92b3..a240cb949b9 100644 --- a/docs/migrating-from-docker.html +++ b/docs/migrating-from-docker.html @@ -13,7 +13,7 @@ - + diff --git a/docs/migrating-from-docker/emulating-docker-cli-with-podman.html b/docs/migrating-from-docker/emulating-docker-cli-with-podman.html index 7e9ca4cac3f..260951fba47 100644 --- a/docs/migrating-from-docker/emulating-docker-cli-with-podman.html +++ b/docs/migrating-from-docker/emulating-docker-cli-with-podman.html @@ -13,7 +13,7 @@ - + diff --git a/docs/migrating-from-docker/importing-saved-containers.html b/docs/migrating-from-docker/importing-saved-containers.html index 9e5a1d3a6cd..a431bc5e8ed 100644 --- a/docs/migrating-from-docker/importing-saved-containers.html +++ b/docs/migrating-from-docker/importing-saved-containers.html @@ -13,7 +13,7 @@ - + diff --git a/docs/migrating-from-docker/using-podman-mac-helper.html b/docs/migrating-from-docker/using-podman-mac-helper.html index 9efca045f95..5152e31327f 100644 --- a/docs/migrating-from-docker/using-podman-mac-helper.html +++ b/docs/migrating-from-docker/using-podman-mac-helper.html @@ -13,7 +13,7 @@ - + diff --git a/docs/migrating-from-docker/using-the-docker_host-environment-variable.html b/docs/migrating-from-docker/using-the-docker_host-environment-variable.html index 2cc54091648..eeaf3396d88 100644 --- a/docs/migrating-from-docker/using-the-docker_host-environment-variable.html +++ b/docs/migrating-from-docker/using-the-docker_host-environment-variable.html @@ -13,7 +13,7 @@ - + diff --git a/docs/migrating-from-docker/verifying-your-tools-are-using-podman.html b/docs/migrating-from-docker/verifying-your-tools-are-using-podman.html index b35784e6ee3..c3af0ffe50f 100644 --- a/docs/migrating-from-docker/verifying-your-tools-are-using-podman.html +++ b/docs/migrating-from-docker/verifying-your-tools-are-using-podman.html @@ -13,7 +13,7 @@ - + diff --git a/docs/minikube.html b/docs/minikube.html index 6590b7483b5..0c8a281a454 100644 --- a/docs/minikube.html +++ b/docs/minikube.html @@ -13,7 +13,7 @@ - + diff --git a/docs/minikube/building-an-image-and-testing-it-in-minikube.html b/docs/minikube/building-an-image-and-testing-it-in-minikube.html index 9fc90698cc3..c7685a8c70a 100644 --- a/docs/minikube/building-an-image-and-testing-it-in-minikube.html +++ b/docs/minikube/building-an-image-and-testing-it-in-minikube.html @@ -13,7 +13,7 @@ - + diff --git a/docs/minikube/configuring-podman-for-minikube-on-windows.html b/docs/minikube/configuring-podman-for-minikube-on-windows.html index 90e6214ab34..de17fa9d622 100644 --- a/docs/minikube/configuring-podman-for-minikube-on-windows.html +++ b/docs/minikube/configuring-podman-for-minikube-on-windows.html @@ -13,7 +13,7 @@ - + diff --git a/docs/minikube/creating-a-minikube-cluster.html b/docs/minikube/creating-a-minikube-cluster.html index 2fdf0c90f26..599cd189a2f 100644 --- a/docs/minikube/creating-a-minikube-cluster.html +++ b/docs/minikube/creating-a-minikube-cluster.html @@ -13,7 +13,7 @@ - + diff --git a/docs/minikube/deleting-your-minikube-cluster.html b/docs/minikube/deleting-your-minikube-cluster.html index 7bf6792c038..b6f499121e0 100644 --- a/docs/minikube/deleting-your-minikube-cluster.html +++ b/docs/minikube/deleting-your-minikube-cluster.html @@ -13,7 +13,7 @@ - + diff --git a/docs/minikube/installing.html b/docs/minikube/installing.html index 417e779e2b2..b987f24f212 100644 --- a/docs/minikube/installing.html +++ b/docs/minikube/installing.html @@ -13,7 +13,7 @@ - + diff --git a/docs/minikube/pushing-an-image-to-minikube.html b/docs/minikube/pushing-an-image-to-minikube.html index 91db1e69f0f..bf19eede768 100644 --- a/docs/minikube/pushing-an-image-to-minikube.html +++ b/docs/minikube/pushing-an-image-to-minikube.html @@ -13,7 +13,7 @@ - + diff --git a/docs/minikube/restarting-your-minikube-cluster.html b/docs/minikube/restarting-your-minikube-cluster.html index ee9d3436879..4a026aa71d0 100644 --- a/docs/minikube/restarting-your-minikube-cluster.html +++ b/docs/minikube/restarting-your-minikube-cluster.html @@ -13,7 +13,7 @@ - + diff --git a/docs/minikube/working-with-your-local-minikube-cluster.html b/docs/minikube/working-with-your-local-minikube-cluster.html index e2b83646759..af9f6e7ea5c 100644 --- a/docs/minikube/working-with-your-local-minikube-cluster.html +++ b/docs/minikube/working-with-your-local-minikube-cluster.html @@ -13,7 +13,7 @@ - + diff --git a/docs/openshift.html b/docs/openshift.html index ec5daeb032c..49fa7c42ed8 100644 --- a/docs/openshift.html +++ b/docs/openshift.html @@ -13,7 +13,7 @@ - + diff --git a/docs/openshift/developer-sandbox.html b/docs/openshift/developer-sandbox.html index fb12ff40db5..c091536342e 100644 --- a/docs/openshift/developer-sandbox.html +++ b/docs/openshift/developer-sandbox.html @@ -13,7 +13,7 @@ - + diff --git a/docs/openshift/openshift-local.html b/docs/openshift/openshift-local.html index acdb8001441..a82ecdc1b22 100644 --- a/docs/openshift/openshift-local.html +++ b/docs/openshift/openshift-local.html @@ -13,7 +13,7 @@ - + diff --git a/docs/podman.html b/docs/podman.html index 3842d638c1a..38315038484 100644 --- a/docs/podman.html +++ b/docs/podman.html @@ -13,7 +13,7 @@ - + diff --git a/docs/podman/accessing-podman-from-another-wsl-instance.html b/docs/podman/accessing-podman-from-another-wsl-instance.html index 02407b7c22a..17c5d2717ae 100644 --- a/docs/podman/accessing-podman-from-another-wsl-instance.html +++ b/docs/podman/accessing-podman-from-another-wsl-instance.html @@ -13,7 +13,7 @@ - + diff --git a/docs/podman/creating-a-podman-machine.html b/docs/podman/creating-a-podman-machine.html index 13b1a9c6cd5..ebaf066673d 100644 --- a/docs/podman/creating-a-podman-machine.html +++ b/docs/podman/creating-a-podman-machine.html @@ -13,7 +13,7 @@ - + diff --git a/docs/podman/gpu.html b/docs/podman/gpu.html index 2cc7f2b48df..177925825e9 100644 --- a/docs/podman/gpu.html +++ b/docs/podman/gpu.html @@ -13,7 +13,7 @@ - + diff --git a/docs/podman/podman-remote.html b/docs/podman/podman-remote.html index e9a4b392523..00f28510ef4 100644 --- a/docs/podman/podman-remote.html +++ b/docs/podman/podman-remote.html @@ -13,7 +13,7 @@ - + diff --git a/docs/podman/setting-podman-machine-default-connection.html b/docs/podman/setting-podman-machine-default-connection.html index e028ecd39a5..7dfaf8e40b4 100644 --- a/docs/podman/setting-podman-machine-default-connection.html +++ b/docs/podman/setting-podman-machine-default-connection.html @@ -13,7 +13,7 @@ - + diff --git a/docs/proxy.html b/docs/proxy.html index 08b439be633..6a064bb0729 100644 --- a/docs/proxy.html +++ b/docs/proxy.html @@ -13,7 +13,7 @@ - + diff --git a/docs/tags.html b/docs/tags.html index 5272038cd82..78a8216f782 100644 --- a/docs/tags.html +++ b/docs/tags.html @@ -13,7 +13,7 @@ - + diff --git a/docs/tags/ai.html b/docs/tags/ai.html index 912103f68e1..f942f99105b 100644 --- a/docs/tags/ai.html +++ b/docs/tags/ai.html @@ -13,7 +13,7 @@ - + diff --git a/docs/tags/api.html b/docs/tags/api.html index 450097e9ff1..97174f8a7fd 100644 --- a/docs/tags/api.html +++ b/docs/tags/api.html @@ -13,7 +13,7 @@ - + diff --git a/docs/tags/compose.html b/docs/tags/compose.html index ba9f1e021f7..fbde3ffa4d6 100644 --- a/docs/tags/compose.html +++ b/docs/tags/compose.html @@ -13,7 +13,7 @@ - + diff --git a/docs/tags/containers.html b/docs/tags/containers.html index 07fb540f19d..6c8eb264288 100644 --- a/docs/tags/containers.html +++ b/docs/tags/containers.html @@ -13,7 +13,7 @@ - + diff --git a/docs/tags/docker.html b/docs/tags/docker.html index 8736c8b7b93..23d404b3914 100644 --- a/docs/tags/docker.html +++ b/docs/tags/docker.html @@ -13,7 +13,7 @@ - + diff --git a/docs/tags/extension.html b/docs/tags/extension.html index 601c07f4808..0aff1f96b69 100644 --- a/docs/tags/extension.html +++ b/docs/tags/extension.html @@ -13,7 +13,7 @@ - + diff --git a/docs/tags/flathub.html b/docs/tags/flathub.html index a3e7b54fb65..6ee3ba2af93 100644 --- a/docs/tags/flathub.html +++ b/docs/tags/flathub.html @@ -13,7 +13,7 @@ - + diff --git a/docs/tags/flatpak.html b/docs/tags/flatpak.html index e937bfb3eea..df6bbb0f47e 100644 --- a/docs/tags/flatpak.html +++ b/docs/tags/flatpak.html @@ -13,7 +13,7 @@ - + diff --git a/docs/tags/generative-ai.html b/docs/tags/generative-ai.html index 81f9ff7ee82..4b3329b65cd 100644 --- a/docs/tags/generative-ai.html +++ b/docs/tags/generative-ai.html @@ -13,7 +13,7 @@ - + diff --git a/docs/tags/icons.html b/docs/tags/icons.html index 196326d28b3..e7e0fd5f9b1 100644 --- a/docs/tags/icons.html +++ b/docs/tags/icons.html @@ -13,7 +13,7 @@ - + diff --git a/docs/tags/images.html b/docs/tags/images.html index 26e9a97f23d..c0ce8861d94 100644 --- a/docs/tags/images.html +++ b/docs/tags/images.html @@ -13,7 +13,7 @@ - + diff --git a/docs/tags/installing.html b/docs/tags/installing.html index fa78b7f4b36..69376da09af 100644 --- a/docs/tags/installing.html +++ b/docs/tags/installing.html @@ -13,7 +13,7 @@ - + diff --git a/docs/tags/kind.html b/docs/tags/kind.html index 85b86351a30..74431f4991d 100644 --- a/docs/tags/kind.html +++ b/docs/tags/kind.html @@ -13,7 +13,7 @@ - + diff --git a/docs/tags/kubernetes.html b/docs/tags/kubernetes.html index d67bba182e2..eee993215e9 100644 --- a/docs/tags/kubernetes.html +++ b/docs/tags/kubernetes.html @@ -13,7 +13,7 @@ - + diff --git a/docs/tags/lima.html b/docs/tags/lima.html index 571903bf91e..a8feee96d32 100644 --- a/docs/tags/lima.html +++ b/docs/tags/lima.html @@ -13,7 +13,7 @@ - + diff --git a/docs/tags/linux.html b/docs/tags/linux.html index 07c3574e409..7efbb949dc3 100644 --- a/docs/tags/linux.html +++ b/docs/tags/linux.html @@ -13,7 +13,7 @@ - + diff --git a/docs/tags/llm.html b/docs/tags/llm.html index 7c014abfe12..cd2196de67c 100644 --- a/docs/tags/llm.html +++ b/docs/tags/llm.html @@ -13,7 +13,7 @@ - + diff --git a/docs/tags/mac-0-s.html b/docs/tags/mac-0-s.html index c83d670b440..5b223490dd6 100644 --- a/docs/tags/mac-0-s.html +++ b/docs/tags/mac-0-s.html @@ -13,7 +13,7 @@ - + diff --git a/docs/tags/mac-os.html b/docs/tags/mac-os.html index fd084049c6f..a8550e1963b 100644 --- a/docs/tags/mac-os.html +++ b/docs/tags/mac-os.html @@ -13,7 +13,7 @@ - + diff --git a/docs/tags/macos.html b/docs/tags/macos.html index 744f7b22a7a..488ede1aa78 100644 --- a/docs/tags/macos.html +++ b/docs/tags/macos.html @@ -13,7 +13,7 @@ - + diff --git a/docs/tags/migrating-from-docker.html b/docs/tags/migrating-from-docker.html index cc5ba1c79e3..9f67d07c586 100644 --- a/docs/tags/migrating-from-docker.html +++ b/docs/tags/migrating-from-docker.html @@ -13,7 +13,7 @@ - + diff --git a/docs/tags/migrating-to-kubernetes.html b/docs/tags/migrating-to-kubernetes.html index 77452228fc8..c2285d1cfd5 100644 --- a/docs/tags/migrating-to-kubernetes.html +++ b/docs/tags/migrating-to-kubernetes.html @@ -13,7 +13,7 @@ - + diff --git a/docs/tags/minikube.html b/docs/tags/minikube.html index 233731ea4d1..2a13128fff5 100644 --- a/docs/tags/minikube.html +++ b/docs/tags/minikube.html @@ -13,7 +13,7 @@ - + diff --git a/docs/tags/onboarding.html b/docs/tags/onboarding.html index bbe32edd6db..1d41502bcea 100644 --- a/docs/tags/onboarding.html +++ b/docs/tags/onboarding.html @@ -13,7 +13,7 @@ - + diff --git a/docs/tags/openshift.html b/docs/tags/openshift.html index 4da488bb564..a1a7222552a 100644 --- a/docs/tags/openshift.html +++ b/docs/tags/openshift.html @@ -13,7 +13,7 @@ - + diff --git a/docs/tags/podman-desktop.html b/docs/tags/podman-desktop.html index e9cddbd700f..ea4cfc79a1a 100644 --- a/docs/tags/podman-desktop.html +++ b/docs/tags/podman-desktop.html @@ -13,7 +13,7 @@ - + diff --git a/docs/tags/podman.html b/docs/tags/podman.html index 405e3548247..4b9d60b0072 100644 --- a/docs/tags/podman.html +++ b/docs/tags/podman.html @@ -13,7 +13,7 @@ - + diff --git a/docs/tags/pods.html b/docs/tags/pods.html index 700c5b06a8e..9aab1e71ffd 100644 --- a/docs/tags/pods.html +++ b/docs/tags/pods.html @@ -13,7 +13,7 @@ - + diff --git a/docs/tags/publishing.html b/docs/tags/publishing.html index 9de5240f047..d1fa38d37bc 100644 --- a/docs/tags/publishing.html +++ b/docs/tags/publishing.html @@ -13,7 +13,7 @@ - + diff --git a/docs/tags/selecting-context.html b/docs/tags/selecting-context.html index f2b468e45d1..ef4d1d59a5d 100644 --- a/docs/tags/selecting-context.html +++ b/docs/tags/selecting-context.html @@ -13,7 +13,7 @@ - + diff --git a/docs/tags/when-clause.html b/docs/tags/when-clause.html index a75595ed015..b8b8b9e6a52 100644 --- a/docs/tags/when-clause.html +++ b/docs/tags/when-clause.html @@ -13,7 +13,7 @@ - + diff --git a/docs/tags/windows.html b/docs/tags/windows.html index 1e40db9ab9d..14833e509c1 100644 --- a/docs/tags/windows.html +++ b/docs/tags/windows.html @@ -13,7 +13,7 @@ - + diff --git a/docs/tags/writing.html b/docs/tags/writing.html index 3281896c752..b3eaf62f93d 100644 --- a/docs/tags/writing.html +++ b/docs/tags/writing.html @@ -13,7 +13,7 @@ - + diff --git a/docs/troubleshooting.html b/docs/troubleshooting.html index f7708cc0181..6649bed0aa2 100644 --- a/docs/troubleshooting.html +++ b/docs/troubleshooting.html @@ -13,7 +13,7 @@ - + diff --git a/docs/troubleshooting/troubleshooting-openshift-local.html b/docs/troubleshooting/troubleshooting-openshift-local.html index 12e58d650fc..bef5b0013f6 100644 --- a/docs/troubleshooting/troubleshooting-openshift-local.html +++ b/docs/troubleshooting/troubleshooting-openshift-local.html @@ -13,7 +13,7 @@ - + diff --git a/docs/troubleshooting/troubleshooting-podman-on-linux.html b/docs/troubleshooting/troubleshooting-podman-on-linux.html index f16d366d740..260054173d1 100644 --- a/docs/troubleshooting/troubleshooting-podman-on-linux.html +++ b/docs/troubleshooting/troubleshooting-podman-on-linux.html @@ -13,7 +13,7 @@ - + diff --git a/docs/troubleshooting/troubleshooting-podman-on-macos.html b/docs/troubleshooting/troubleshooting-podman-on-macos.html index 6fbb3f43136..084cf18bf80 100644 --- a/docs/troubleshooting/troubleshooting-podman-on-macos.html +++ b/docs/troubleshooting/troubleshooting-podman-on-macos.html @@ -13,7 +13,7 @@ - + diff --git a/docs/troubleshooting/troubleshooting-podman-on-windows.html b/docs/troubleshooting/troubleshooting-podman-on-windows.html index 49dccdbda4c..c2ac4b9b838 100644 --- a/docs/troubleshooting/troubleshooting-podman-on-windows.html +++ b/docs/troubleshooting/troubleshooting-podman-on-windows.html @@ -13,7 +13,7 @@ - + diff --git a/docs/troubleshooting/troubleshooting-podman.html b/docs/troubleshooting/troubleshooting-podman.html index 173d24940a1..4cd936207f9 100644 --- a/docs/troubleshooting/troubleshooting-podman.html +++ b/docs/troubleshooting/troubleshooting-podman.html @@ -13,7 +13,7 @@ - + diff --git a/downloads.html b/downloads.html index 4ad4493b737..5ca625ed9da 100644 --- a/downloads.html +++ b/downloads.html @@ -13,7 +13,7 @@ - + diff --git a/downloads/linux.html b/downloads/linux.html index e7b44eace1e..42e77d8885d 100644 --- a/downloads/linux.html +++ b/downloads/linux.html @@ -13,7 +13,7 @@ - + diff --git a/downloads/macos.html b/downloads/macos.html index 0f0da5938cc..88522b128ef 100644 --- a/downloads/macos.html +++ b/downloads/macos.html @@ -13,7 +13,7 @@ - + diff --git a/downloads/windows.html b/downloads/windows.html index ab532ce0a9d..bedf6878ea0 100644 --- a/downloads/windows.html +++ b/downloads/windows.html @@ -13,7 +13,7 @@ - + diff --git a/extend.html b/extend.html index 272d6444293..ebba12d9ca6 100644 --- a/extend.html +++ b/extend.html @@ -13,7 +13,7 @@ - + diff --git a/extensions/ai-lab.html b/extensions/ai-lab.html index 4cf1cb2dd6b..29f2fda8575 100644 --- a/extensions/ai-lab.html +++ b/extensions/ai-lab.html @@ -13,7 +13,7 @@ - + diff --git a/features.html b/features.html index b20070ecd43..1c49af339f1 100644 --- a/features.html +++ b/features.html @@ -13,7 +13,7 @@ - + diff --git a/index.html b/index.html index 1b2132bb865..551419a5030 100644 --- a/index.html +++ b/index.html @@ -13,7 +13,7 @@ - + diff --git a/search.html b/search.html index 1b4c70d5f6a..52e9d5071d1 100644 --- a/search.html +++ b/search.html @@ -13,7 +13,7 @@ - + diff --git a/storybook.html b/storybook.html index 733802da759..30cb356daab 100644 --- a/storybook.html +++ b/storybook.html @@ -13,7 +13,7 @@ - +