diff --git a/404.html b/404.html index 545d74eb8e6..8147e13cceb 100644 --- a/404.html +++ b/404.html @@ -13,7 +13,7 @@ - + diff --git a/api.html b/api.html index 0b5c2395545..1d75931108a 100644 --- a/api.html +++ b/api.html @@ -13,7 +13,7 @@ - + diff --git a/api/classes/CancellationTokenSource.html b/api/classes/CancellationTokenSource.html index 82e0bffd343..f223e91a934 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:1075

+

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

Methods​

cancel()​

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

Returns​

void

Defined in​

-

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

+

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

dispose()​

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

Returns​

void

Defined in​

-

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

+

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

\ No newline at end of file diff --git a/api/classes/Disposable.html b/api/classes/Disposable.html index 40373586f38..609055d49dc 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 96462743459..f8ded968de4 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()​

@@ -60,6 +60,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 9add30ab99d..857e70d26b9 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:4125

+

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

Properties​

value​

readonly value: T

Defined in​

-

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

+

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

\ No newline at end of file diff --git a/api/classes/Uri.html b/api/classes/Uri.html index 585d276b769..9e86a60814e 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:1585

+

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

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

+

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

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

+

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

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

+

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

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

+

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

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

+

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

Methods​

toString()​

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

Returns​

string

Defined in​

-

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

+

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

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

+

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

file()​

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

Returns​

Uri

Defined in​

-

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

+

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

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

+

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

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

+

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

\ No newline at end of file diff --git a/api/enumerations/InputBoxValidationSeverity.html b/api/enumerations/InputBoxValidationSeverity.html index b573d968180..f65126c3461 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:1094

+

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

Info​

Info: 1

Defined in​

-

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

+

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

Warning​

Warning: 2

Defined in​

-

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

+

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

\ No newline at end of file diff --git a/api/enumerations/ProgressLocation.html b/api/enumerations/ProgressLocation.html index 7d4bebf7683..e7689014097 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:1022

+

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

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

+

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

\ No newline at end of file diff --git a/api/enumerations/QuickPickItemKind.html b/api/enumerations/QuickPickItemKind.html index 562c43739da..188ddc82641 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:1197

+

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

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

+

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

\ No newline at end of file diff --git a/api/interfaces/AuditRecord.html b/api/interfaces/AuditRecord.html index 03ca61976c1..4620bb7de8d 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:495

+

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

type​

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

Defined in​

-

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

+

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

\ No newline at end of file diff --git a/api/interfaces/AuditRequestItems.html b/api/interfaces/AuditRequestItems.html index c1ac864d562..aa72580eb44 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 991a8834c90..a0ab898c4ec 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:499

+

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

\ No newline at end of file diff --git a/api/interfaces/Auditor.html b/api/interfaces/Auditor.html index 4d7154c5725..3e0e8bd9337 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:508

+

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

\ No newline at end of file diff --git a/api/interfaces/AuthConfig.html b/api/interfaces/AuthConfig.html index ca429c52624..f0845fb7496 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:2345

+

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

password​

password: string

Defined in​

-

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

+

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

serveraddress​

serveraddress: string

Defined in​

-

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

+

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

username​

username: 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/AuthenticationGetSessionOptions.html b/api/interfaces/AuthenticationGetSessionOptions.html index dd85d8c51ec..6860df388c5 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 getSession is called with this flag.

Defaults to false.

Defined in​

-

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

+

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

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

+

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

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

+

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

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

+

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

\ No newline at end of file diff --git a/api/interfaces/AuthenticationProvider.html b/api/interfaces/AuthenticationProvider.html index 04c3bf2a506..f2b4872970e 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:3839

+

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

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

+

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

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

+

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

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

+

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

\ No newline at end of file diff --git a/api/interfaces/AuthenticationProviderAuthenticationSessionsChangeEvent.html b/api/interfaces/AuthenticationProviderAuthenticationSessionsChangeEvent.html index f82b0629602..8fae050a662 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:3816

+

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

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

+

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

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

+

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

\ No newline at end of file diff --git a/api/interfaces/AuthenticationProviderInformation.html b/api/interfaces/AuthenticationProviderInformation.html index 35970b09199..83d2c7bf538 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:3778

+

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

label​

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

The human-readable name of the authentication provider.

Defined in​

-

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

+

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

\ No newline at end of file diff --git a/api/interfaces/AuthenticationProviderOptions.html b/api/interfaces/AuthenticationProviderOptions.html index 886ab5661f3..aec7d1a4e50 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:3806

+

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

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

+

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

\ No newline at end of file diff --git a/api/interfaces/AuthenticationSession.html b/api/interfaces/AuthenticationSession.html index ecd3a0a28ad..e9f30f44c17 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:3687

+

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

account​

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

The account associated with the session.

Defined in​

-

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

+

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

id​

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

The identifier of the authentication session.

Defined in​

-

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

+

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

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

+

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

\ No newline at end of file diff --git a/api/interfaces/AuthenticationSessionAccountInformation.html b/api/interfaces/AuthenticationSessionAccountInformation.html index 3d249c9b692..1ba6f9bb154 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:3708

+

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

label​

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

The human-readable name of the account.

Defined in​

-

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

+

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

\ No newline at end of file diff --git a/api/interfaces/AuthenticationSessionsChangeEvent.html b/api/interfaces/AuthenticationSessionsChangeEvent.html index e16d050c901..f0af7752ebe 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:3793

+

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

\ No newline at end of file diff --git a/api/interfaces/BlkioStatEntry.html b/api/interfaces/BlkioStatEntry.html index a0e7b7cdf53..bf01df209b5 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:3049

+

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

minor​

minor: number

Defined in​

-

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

+

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

op​

op: string

Defined in​

-

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

+

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

value​

value: number

Defined in​

-

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

+

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

\ No newline at end of file diff --git a/api/interfaces/BlkioStats.html b/api/interfaces/BlkioStats.html index beb06bbffa4..0f3bbc08f18 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:3061

+

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

io_queue_recursive​

io_queue_recursive: BlkioStatEntry[]

Defined in​

-

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

+

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

io_service_bytes_recursive​

io_service_bytes_recursive: BlkioStatEntry[]

Defined in​

-

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

+

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

io_service_time_recursive​

io_service_time_recursive: BlkioStatEntry[]

Defined in​

-

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

+

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

io_serviced_recursive​

io_serviced_recursive: BlkioStatEntry[]

Defined in​

-

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

+

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

io_time_recursive​

io_time_recursive: BlkioStatEntry[]

Defined in​

-

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

+

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

io_wait_time_recursive​

io_wait_time_recursive: BlkioStatEntry[]

Defined in​

-

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

+

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

sectors_recursive​

sectors_recursive: BlkioStatEntry[]

Defined in​

-

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

+

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

\ No newline at end of file diff --git a/api/interfaces/BuildImageOptions.html b/api/interfaces/BuildImageOptions.html index 3d3858e3aa0..261b44070e9 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:3191

+

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

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

+

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

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

+

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

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

+

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

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

+

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

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

+

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

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

+

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

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

+

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

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

+

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

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

+

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

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

+

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

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

+

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

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

+

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

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

+

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

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

+

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

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

+

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

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

+

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

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

+

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

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

+

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

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

+

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

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

+

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

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

+

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

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

+

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

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

+

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

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

+

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

target?​

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

Default: ""

Target build stage

Defined in​

-

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

+

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

\ No newline at end of file diff --git a/api/interfaces/CPUStats.html b/api/interfaces/CPUStats.html index 7356e67e8cb..95dd751ce5f 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:3146

+

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

online_cpus​

online_cpus: number

Defined in​

-

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

+

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

system_cpu_usage​

system_cpu_usage: number

Defined in​

-

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

+

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

throttling_data​

throttling_data: ThrottlingData

Defined in​

-

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

+

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

\ No newline at end of file diff --git a/api/interfaces/CPUUsage.html b/api/interfaces/CPUUsage.html index f3659e2ebfc..7e70720bf4f 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:3133

+

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

total_usage​

total_usage: number

Defined in​

-

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

+

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

usage_in_kernelmode​

usage_in_kernelmode: number

Defined in​

-

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

+

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

usage_in_usermode​

usage_in_usermode: number

Defined in​

-

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

+

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

\ No newline at end of file diff --git a/api/interfaces/CancellationToken.html b/api/interfaces/CancellationToken.html index dfefbb4aad2..61a5610065e 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:1062

+

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

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

+

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

\ No newline at end of file diff --git a/api/interfaces/CheckResult.html b/api/interfaces/CheckResult.html index 038d5828a89..7d001c5f1c6 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:525

+

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

optional docLinks: Link[]

Defined in​

-

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

+

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

docLinksDescription?​

optional docLinksDescription: string

Defined in​

-

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

+

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

fixCommand?​

optional fixCommand: CheckResultFixCommand

Defined in​

-

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

+

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

successful​

successful: boolean

Defined in​

-

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

+

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

\ No newline at end of file diff --git a/api/interfaces/CheckResultFixCommand.html b/api/interfaces/CheckResultFixCommand.html index c580db5376f..fc185ae80c1 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:519

+

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

title​

title: string

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/CliTool.html b/api/interfaces/CliTool.html index 81105138652..ba7061bed2b 100644 --- a/api/interfaces/CliTool.html +++ b/api/interfaces/CliTool.html @@ -13,7 +13,7 @@ - + @@ -28,7 +28,7 @@

displayName: string

Defined in​

-

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

+

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

extensionInfo​

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

label: string

Defined in​

-

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

+

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

id​

id: string

Defined in​

-

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

+

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

images​

images: ProviderImages

Defined in​

-

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

+

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

markdownDescription​

markdownDescription: string

Defined in​

-

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

+

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

name​

name: string

Defined in​

-

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

+

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

onDidUpdateVersion​

onDidUpdateVersion: Event<string>

Defined in​

-

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

+

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

state​

state: "registered"

Defined in​

-

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

+

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

Methods​

dispose()​

@@ -97,7 +97,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

registerUpdate()​

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

Returns​

Disposable

Defined in​

-

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

+

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

updateVersion()​

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

Returns​

void

Defined in​

-

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

+

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

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

displayName: string

Defined in​

-

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

+

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

images​

images: ProviderImages

Defined in​

-

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

+

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

markdownDescription​

markdownDescription: string

Defined in​

-

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

+

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

name​

name: string

Defined in​

-

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

+

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

path​

path: string

Defined in​

-

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

+

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

version​

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

Defined in​

-

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

+

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

\ No newline at end of file diff --git a/api/interfaces/CliToolUpdate.html b/api/interfaces/CliToolUpdate.html index 7d8015f7096..7a9cf118ecd 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:4314

+

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

version​

version: string

Defined in​

-

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

+

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

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

optional displayName: string

Defined in​

-

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

+

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

images?​

optional images: ProviderImages

Defined in​

-

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

+

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

markdownDescription?​

optional markdownDescription: string

Defined in​

-

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

+

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

path?​

optional path: string

Defined in​

-

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

+

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

version​

version: string

Defined in​

-

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

+

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

\ No newline at end of file diff --git a/api/interfaces/Clipboard.html b/api/interfaces/Clipboard.html index 172df5244d7..3363867e9bb 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:4254

+

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

writeText()​

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

Promise<void>

A Promise that resolves when writing happened.

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/Command.html b/api/interfaces/Command.html index 06851ecf73f..9758e2d7666 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 df2de15e888..f3456c88a34 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:951

+

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

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

+

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

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

+

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

update()​

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

Returns​

Promise<void>

Defined in​

-

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

+

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

\ No newline at end of file diff --git a/api/interfaces/ConfigurationChangeEvent.html b/api/interfaces/ConfigurationChangeEvent.html index 8e6df4e6b81..4e4fa11e0ba 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:995

+

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

\ No newline at end of file diff --git a/api/interfaces/ContainerAuthInfo.html b/api/interfaces/ContainerAuthInfo.html index 8dfe553a6a8..253d3a3d947 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:2658

+

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

password​

password: string

Defined in​

-

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

+

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

serveraddress​

serveraddress: string

Defined in​

-

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

+

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

username​

username: string

Defined in​

-

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

+

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

\ No newline at end of file diff --git a/api/interfaces/ContainerCreateOptions.html b/api/interfaces/ContainerCreateOptions.html index 2d16a5f0e19..c71c57fa7cb 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:2971

+

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

AttachStderr?​

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

Whether to attach to stderr (default false)

Defined in​

-

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

+

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

AttachStdin?​

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

Whether to attach to stdin (default false)

Defined in​

-

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

+

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

AttachStdout?​

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

Whether to attach to stdout(default false)

Defined in​

-

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

+

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

Cmd?​

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

Command to run specified as an array of strings

Defined in​

-

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

+

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

Detach?​

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

Run the container in the background

Defined in​

-

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

+

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

Domainname?​

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

The domain name to use for the container.

Defined in​

-

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

+

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

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

+

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

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

+

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

EnvFiles?​

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

Environment files to use

Defined in​

-

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

+

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

ExposedPorts?​

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

Index Signature​

[port: string]: object

Defined in​

-

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

+

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

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

+

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

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

+

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

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

+

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

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

+

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

Labels?​

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

Index Signature​

[label: string]: string

Defined in​

-

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

+

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

MacAddress?​

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

MAC address of the container.

Defined in​

-

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

+

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

NetworkConfig?​

optional NetworkConfig: NetworkingConfig

Defined in​

-

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

+

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

NetworkDisabled?​

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

Disable networking for the container.

Defined in​

-

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

+

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

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

+

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

OpenStdin?​

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

Whether to open stdin (default false)

Defined in​

-

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

+

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

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

+

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

StdinOnce?​

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

Close stdin after one attached client disconnects (deafult false)

Defined in​

-

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

+

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

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

+

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

StopTimeout?​

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

Default: 10

Timeout to stop a container in seconds.

Defined in​

-

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

+

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

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

+

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

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

+

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

Volumes?​

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

Index Signature​

[volume: string]: object

Defined in​

-

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

+

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

WorkingDir?​

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

The working directory for commands to run in.

Defined in​

-

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

+

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

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

+

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

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

+

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

pod?​

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

Pod where to create the container in

Defined in​

-

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

+

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

start?​

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

Start the container immediately (default true)

Defined in​

-

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

+

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

\ No newline at end of file diff --git a/api/interfaces/ContainerCreateResult.html b/api/interfaces/ContainerCreateResult.html index ed7d662fb17..5d63a6dd15b 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:3034

+

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

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

+

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

\ No newline at end of file diff --git a/api/interfaces/ContainerEngineInfo.html b/api/interfaces/ContainerEngineInfo.html index 3c0cc470e72..ec0efa2a053 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:3361

+

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

cpus?​

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

number of CPUs available for the container engine

Defined in​

-

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

+

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

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

+

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

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

+

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

engineId​

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

unique id identifying the container engine

Defined in​

-

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

+

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

engineName​

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

name of the container engine

Defined in​

-

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

+

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

engineType​

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

engine type, either 'podman' or 'docker'

Defined in​

-

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

+

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

memory?​

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

Quantity of memory available for the container engine

Defined in​

-

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

+

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

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

+

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

\ No newline at end of file diff --git a/api/interfaces/ContainerInfo.html b/api/interfaces/ContainerInfo.html index 29dae75aa75..b67012de7ed 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:2273

+

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

Created​

Created: number

Defined in​

-

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

+

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

HostConfig​

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

NetworkMode: string

Defined in​

-

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

+

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

Id​

Id: string

Defined in​

-

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

+

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

Image​

Image: string

Defined in​

-

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

+

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

ImageID​

ImageID: string

Defined in​

-

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

+

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

Labels​

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

Index Signature​

[label: string]: string

Defined in​

-

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

+

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

Mounts​

Mounts: object[]

Defined in​

-

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

+

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

Names​

Names: string[]

Defined in​

-

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

+

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

NetworkSettings​

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

[networkType: string]: NetworkInfo

Defined in​

-

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

+

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

Ports​

Ports: Port[]

Defined in​

-

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

+

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

State​

State: string

Defined in​

-

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

+

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

Status​

Status: string

Defined in​

-

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

+

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

engineId​

engineId: string

Defined in​

-

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

+

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

engineName​

engineName: string

Defined in​

-

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

+

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

engineType​

engineType: "docker" | "podman"

Defined in​

-

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

+

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

\ No newline at end of file diff --git a/api/interfaces/ContainerInspectInfo.html b/api/interfaces/ContainerInspectInfo.html index 746cec8d972..057e7348a10 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:2554

+

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

Args​

Args: string[]

Defined in​

-

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

+

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

Config​

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

WorkingDir: string

Defined in​

-

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

+

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

Created​

Created: string

Defined in​

-

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

+

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

Driver​

Driver: string

Defined in​

-

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

+

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

ExecIDs?​

optional ExecIDs: string[]

Defined in​

-

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

+

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

GraphDriver​

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

Name: string

Defined in​

-

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

+

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

HostConfig​

HostConfig: HostConfig

Defined in​

-

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

+

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

HostnamePath​

HostnamePath: string

Defined in​

-

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

+

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

HostsPath​

HostsPath: string

Defined in​

-

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

+

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

Id​

Id: string

Defined in​

-

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

+

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

Image​

Image: string

Defined in​

-

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

+

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

LogPath​

LogPath: string

Defined in​

-

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

+

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

MountLabel​

MountLabel: string

Defined in​

-

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

+

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

Mounts​

Mounts: object[]

Defined in​

-

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

+

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

Name​

Name: string

Defined in​

-

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

+

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

NetworkSettings​

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

optional SecondaryIPv6Addresses: unknown

Defined in​

-

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

+

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

Path​

Path: string

Defined in​

-

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

+

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

Platform​

Platform: string

Defined in​

-

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

+

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

ProcessLabel​

ProcessLabel: string

Defined in​

-

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

+

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

ResolvConfPath​

ResolvConfPath: string

Defined in​

-

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

+

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

RestartCount​

RestartCount: number

Defined in​

-

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

+

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

State​

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

Status: string

Defined in​

-

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

+

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

engineId​

engineId: string

Defined in​

-

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

+

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

engineName​

engineName: string

Defined in​

-

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

+

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

\ No newline at end of file diff --git a/api/interfaces/ContainerJSONEvent.html b/api/interfaces/ContainerJSONEvent.html index 76434092d53..1d534dc31b5 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:2648

+

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

id​

id: string

Defined in​

-

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

+

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

status​

status: string

Defined in​

-

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

+

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

type​

type: string

Defined in​

-

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

+

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

\ No newline at end of file diff --git a/api/interfaces/ContainerProviderConnection.html b/api/interfaces/ContainerProviderConnection.html index 29f54c8dadb..270aaea933f 100644 --- a/api/interfaces/ContainerProviderConnection.html +++ b/api/interfaces/ContainerProviderConnection.html @@ -13,7 +13,7 @@ - + @@ -24,28 +24,28 @@

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

Methods​

status()​

@@ -54,6 +54,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 c55614a4106..4952dcd0801 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 ee012c48b19..245fe97f5e0 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:478

+

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

creationDisplayName?​

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

Inherited from​

ProviderConnectionFactory.creationDisplayName

Defined in​

-

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

+

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

Methods​

create()​

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

Returns​

Promise<void>

Defined in​

-

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

+

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

initialize()?​

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

Inherited from​

ProviderConnectionFactory.initialize

Defined in​

-

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

+

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

\ No newline at end of file diff --git a/api/interfaces/ContainerStatsInfo.html b/api/interfaces/ContainerStatsInfo.html index 9410ec4898d..3dd39ed3c27 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:3158

+

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

cpu_stats​

cpu_stats: CPUStats

Defined in​

-

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

+

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

engineId​

engineId: string

Defined in​

-

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

+

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

engineName​

engineName: string

Defined in​

-

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

+

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

memory_stats​

memory_stats: MemoryStats

Defined in​

-

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

+

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

networks​

networks: NetworkStats

Defined in​

-

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

+

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

num_procs​

num_procs: number

Defined in​

-

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

+

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

pids_stats?​

optional pids_stats: PidsStats

Defined in​

-

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

+

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

precpu_stats​

precpu_stats: CPUStats

Defined in​

-

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

+

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

preread​

preread: string

Defined in​

-

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

+

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

read​

read: string

Defined in​

-

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

+

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

storage_stats?​

optional storage_stats: StorageStats

Defined in​

-

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

+

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

\ No newline at end of file diff --git a/api/interfaces/CustomPick.html b/api/interfaces/CustomPick.html index d273674430c..5596c138a44 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:1393

+

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

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

+

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

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

+

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

icon?​

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

An optional base64 PNG image

Defined in​

-

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

+

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

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

+

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

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

+

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

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

+

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

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

+

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

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

+

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

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

+

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

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

+

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

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

+

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

\ No newline at end of file diff --git a/api/interfaces/CustomPickItem.html b/api/interfaces/CustomPickItem.html index bc9539532d2..de9e4764881 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:1354

+

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

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

+

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

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

+

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

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

+

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

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

+

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

\ No newline at end of file diff --git a/api/interfaces/CustomPickSectionItem.html b/api/interfaces/CustomPickSectionItem.html index cf2973d5453..7a6f79e2ecf 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:1334

+

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

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

+

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

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

+

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

\ No newline at end of file diff --git a/api/interfaces/DeviceRequest.html b/api/interfaces/DeviceRequest.html index e007739b4b6..de3a0ee2d73 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:2405

+

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

Count?​

optional Count: number

Defined in​

-

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

+

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

DeviceIDs?​

optional DeviceIDs: string[]

Defined in​

-

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

+

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

Driver?​

optional Driver: string

Defined in​

-

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

+

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

Options?​

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

Index Signature​

[key: string]: string

Defined in​

-

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

+

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

\ No newline at end of file diff --git a/api/interfaces/EndpointIPAMConfig.html b/api/interfaces/EndpointIPAMConfig.html index c210a38c3cc..f7633ade2d6 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:2739

+

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

IPv6Address?​

optional IPv6Address: string

Defined in​

-

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

+

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

LinkLocalIPs?​

optional LinkLocalIPs: string[]

Defined in​

-

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

+

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

\ No newline at end of file diff --git a/api/interfaces/EndpointSettings.html b/api/interfaces/EndpointSettings.html index 6f93051e6c1..1bae5e6784f 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:2757

+

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

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

+

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

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

+

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

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

+

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

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

+

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

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

+

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

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

+

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

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

+

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

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

+

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

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

+

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

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

+

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

optional Links: string[]

Defined in​

-

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

+

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

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

+

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

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

+

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

\ No newline at end of file diff --git a/api/interfaces/Event.html b/api/interfaces/Event.html index 4b7c3184cd2..f263d8d831d 100644 --- a/api/interfaces/Event.html +++ b/api/interfaces/Event.html @@ -13,7 +13,7 @@ - + @@ -35,6 +35,6 @@

Disposable

A disposable which unsubscribes the event listener.

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 efcd240fe64..75cc5665478 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 86cd0326fa8..0107411864d 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 582164f0971..cf4929f8ce6 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:1652

+

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

onDidCreate​

readonly onDidCreate: Event<Uri>

Defined in​

-

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

+

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

onDidDelete​

readonly onDidDelete: Event<Uri>

Defined in​

-

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

+

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

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 f2962c6f5b6..4e3c1a09faa 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:2117

+

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

\ No newline at end of file diff --git a/api/interfaces/HealthCheckLog.html b/api/interfaces/HealthCheckLog.html index b9257ac3623..019dc5eb61b 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:2511

+

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

ExitCode​

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

Exitcode is 0 or 1

Defined in​

-

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

+

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

Output​

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

Output is the stdout/stderr from the healthcheck command

Defined in​

-

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

+

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

Start​

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

Start time as string

Defined in​

-

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

+

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

\ No newline at end of file diff --git a/api/interfaces/HealthCheckResults.html b/api/interfaces/HealthCheckResults.html index 9332afc6b6b..3d511f0ff5d 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:2493

+

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

Log​

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

Log describes healthcheck attempts and results

Defined in​

-

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

+

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

Status​

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

Status is starting, healthy or unhealthy

Defined in​

-

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

+

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

\ No newline at end of file diff --git a/api/interfaces/HealthConfig.html b/api/interfaces/HealthConfig.html index 90fde958850..cc3fa55627b 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:2707

+

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

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

+

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

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

+

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

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

+

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

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

+

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

\ No newline at end of file diff --git a/api/interfaces/HostConfig.html b/api/interfaces/HostConfig.html index ce6e6389433..832f8510a04 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:2410

+

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

Binds?​

optional Binds: string[]

Defined in​

-

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

+

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

BlkioDeviceReadBps?​

optional BlkioDeviceReadBps: unknown

Defined in​

-

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

+

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

BlkioDeviceReadIOps?​

optional BlkioDeviceReadIOps: unknown

Defined in​

-

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

+

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

BlkioDeviceWriteBps?​

optional BlkioDeviceWriteBps: unknown

Defined in​

-

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

+

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

BlkioDeviceWriteIOps?​

optional BlkioDeviceWriteIOps: unknown

Defined in​

-

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

+

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

BlkioWeight?​

optional BlkioWeight: number

Defined in​

-

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

+

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

BlkioWeightDevice?​

optional BlkioWeightDevice: unknown

Defined in​

-

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

+

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

CapAdd?​

optional CapAdd: string[]

Defined in​

-

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

+

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

CapDrop?​

optional CapDrop: string[]

Defined in​

-

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

+

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

Cgroup?​

optional Cgroup: string

Defined in​

-

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

+

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

CgroupParent?​

optional CgroupParent: string

Defined in​

-

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

+

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

ConsoleSize?​

optional ConsoleSize: number[]

Defined in​

-

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

+

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

ContainerIDFile?​

optional ContainerIDFile: string

Defined in​

-

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

+

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

CpuCount?​

optional CpuCount: number

Defined in​

-

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

+

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

CpuPercent?​

optional CpuPercent: number

Defined in​

-

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

+

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

CpuPeriod?​

optional CpuPeriod: number

Defined in​

-

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

+

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

CpuQuota?​

optional CpuQuota: number

Defined in​

-

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

+

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

CpuRealtimePeriod?​

optional CpuRealtimePeriod: number

Defined in​

-

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

+

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

CpuRealtimeRuntime?​

optional CpuRealtimeRuntime: number

Defined in​

-

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

+

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

CpuShares?​

optional CpuShares: number

Defined in​

-

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

+

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

CpusetCpus?​

optional CpusetCpus: string

Defined in​

-

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

+

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

CpusetMems?​

optional CpusetMems: string

Defined in​

-

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

+

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

DeviceCgroupRules?​

optional DeviceCgroupRules: string[]

Defined in​

-

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

+

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

DeviceRequests?​

optional DeviceRequests: DeviceRequest[]

Defined in​

-

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

+

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

Devices?​

optional Devices: unknown

Defined in​

-

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

+

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

DiskQuota?​

optional DiskQuota: number

Defined in​

-

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

+

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

Dns?​

optional Dns: string[]

Defined in​

-

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

+

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

DnsOptions?​

optional DnsOptions: unknown[]

Defined in​

-

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

+

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

DnsSearch?​

optional DnsSearch: string[]

Defined in​

-

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

+

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

ExtraHosts?​

optional ExtraHosts: string[]

Defined in​

-

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

+

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

GroupAdd?​

optional GroupAdd: string[]

Defined in​

-

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

+

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

Init?​

optional Init: boolean

Defined in​

-

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

+

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

IpcMode?​

optional IpcMode: string

Defined in​

-

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

+

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

Isolation?​

optional Isolation: string

Defined in​

-

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

+

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

KernelMemory?​

optional KernelMemory: number

Defined in​

-

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

+

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

optional Links: unknown

Defined in​

-

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

+

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

LogConfig?​

@@ -291,154 +291,154 @@

Type: string

Defined in​

-

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

+

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

MaskedPaths?​

optional MaskedPaths: string[]

Defined in​

-

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

+

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

Memory?​

optional Memory: number

Defined in​

-

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

+

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

MemoryReservation?​

optional MemoryReservation: number

Defined in​

-

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

+

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

MemorySwap?​

optional MemorySwap: number

Defined in​

-

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

+

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

MemorySwappiness?​

optional MemorySwappiness: number

Defined in​

-

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

+

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

Mounts?​

optional Mounts: MountConfig

Defined in​

-

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

+

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

NanoCpus?​

optional NanoCpus: number

Defined in​

-

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

+

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

NetworkMode?​

optional NetworkMode: string

Defined in​

-

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

+

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

OomKillDisable?​

optional OomKillDisable: boolean

Defined in​

-

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

+

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

OomScoreAdj?​

optional OomScoreAdj: number

Defined in​

-

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

+

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

PidMode?​

optional PidMode: string

Defined in​

-

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

+

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

PidsLimit?​

optional PidsLimit: number

Defined in​

-

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

+

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

PortBindings?​

optional PortBindings: unknown

Defined in​

-

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

+

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

Privileged?​

optional Privileged: boolean

Defined in​

-

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

+

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

PublishAllPorts?​

optional PublishAllPorts: boolean

Defined in​

-

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

+

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

ReadonlyPaths?​

optional ReadonlyPaths: string[]

Defined in​

-

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

+

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

ReadonlyRootfs?​

optional ReadonlyRootfs: boolean

Defined in​

-

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

+

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

RestartPolicy?​

optional RestartPolicy: HostRestartPolicy

Defined in​

-

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

+

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

Runtime?​

optional Runtime: string

Defined in​

-

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

+

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

SecurityOpt?​

optional SecurityOpt: string[]

Defined in​

-

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

+

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

ShmSize?​

optional ShmSize: number

Defined in​

-

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

+

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

StorageOpt?​

@@ -447,7 +447,7 @@

Index Signature​

[option: string]: string

Defined in​

-

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

+

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

Sysctls?​

@@ -456,7 +456,7 @@

Index Signature​

[index: string]: string

Defined in​

-

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

+

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

Tmpfs?​

@@ -465,41 +465,41 @@

Index Signature​

[dir: string]: string

Defined in​

-

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

+

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

UTSMode?​

optional UTSMode: string

Defined in​

-

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

+

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

Ulimits?​

optional Ulimits: unknown

Defined in​

-

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

+

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

UsernsMode?​

optional UsernsMode: string

Defined in​

-

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

+

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

VolumeDriver?​

optional VolumeDriver: string

Defined in​

-

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

+

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

VolumesFrom?​

optional VolumesFrom: unknown

Defined in​

-

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

+

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

\ No newline at end of file diff --git a/api/interfaces/HostRestartPolicy.html b/api/interfaces/HostRestartPolicy.html index 24e5a23a64c..b71a0b224b3 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:2366

+

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

Name​

Name: string

Defined in​

-

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

+

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

\ No newline at end of file diff --git a/api/interfaces/IPAM.html b/api/interfaces/IPAM.html index 533f2b9b84a..f714d027adb 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:2240

+

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

Driver​

Driver: string

Defined in​

-

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

+

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

Options?​

@@ -40,6 +40,6 @@

Index Signature​

[key: string]: string

Defined in​

-

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

+

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

\ No newline at end of file diff --git a/api/interfaces/ImageCheck.html b/api/interfaces/ImageCheck.html index ac48310ecdf..446b4963a5d 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:4372

+

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

name​

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

a short and descriptive name for the error/recommendation

Defined in​

-

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

+

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

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

+

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

status​

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

either the feedback is positive or negative

Defined in​

-

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

+

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

\ No newline at end of file diff --git a/api/interfaces/ImageCheckerProvider.html b/api/interfaces/ImageCheckerProvider.html index 614b0a76837..79afa28297f 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:4395

+

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

\ No newline at end of file diff --git a/api/interfaces/ImageCheckerProviderMetadata.html b/api/interfaces/ImageCheckerProviderMetadata.html index 2e1347a6291..15a68ee1844 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:4399

+

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

\ No newline at end of file diff --git a/api/interfaces/ImageChecks.html b/api/interfaces/ImageChecks.html index d12d55d3b19..7fc0c48cb70 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:4382

+

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

\ No newline at end of file diff --git a/api/interfaces/ImageFile.html b/api/interfaces/ImageFile.html index a999f2809aa..bfcb25051db 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:717

+

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

ctime​

ctime: Date

Defined in​

-

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

+

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

gid​

gid: number

Defined in​

-

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

+

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

mode​

mode: number

Defined in​

-

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

+

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

mtime​

mtime: Date

Defined in​

-

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

+

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

path​

path: string

Defined in​

-

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

+

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

size​

size: number

Defined in​

-

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

+

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

type​

type: "file" | "directory" | "symlink"

Defined in​

-

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

+

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

uid​

uid: number

Defined in​

-

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

+

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

\ No newline at end of file diff --git a/api/interfaces/ImageFileSymlink.html b/api/interfaces/ImageFileSymlink.html index e0783f9caa4..b8136321333 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:717

+

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

ctime​

@@ -40,7 +40,7 @@

Inherited from​

ImageFile.ctime

Defined in​

-

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

+

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

gid​

@@ -49,14 +49,14 @@

Inherited from​

ImageFile.gid

Defined in​

-

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

+

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

linkPath​

linkPath: string

Defined in​

-

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

+

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

mode​

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

Inherited from​

ImageFile.mode

Defined in​

-

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

+

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

mtime​

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

Inherited from​

ImageFile.mtime

Defined in​

-

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

+

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

path​

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

Inherited from​

ImageFile.path

Defined in​

-

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

+

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

size​

@@ -92,7 +92,7 @@

Inherited from​

ImageFile.size

Defined in​

-

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

+

packages/extension-api/src/extension-api.d.ts:715

type​

@@ -101,7 +101,7 @@

Overrides​

ImageFile.type

Defined in​

-

packages/extension-api/src/extension-api.d.ts:725

+

packages/extension-api/src/extension-api.d.ts:725

uid​

@@ -110,6 +110,6 @@

Inherited from​

ImageFile.uid

Defined in​

-

packages/extension-api/src/extension-api.d.ts:713

+

packages/extension-api/src/extension-api.d.ts:713

\ No newline at end of file diff --git a/api/interfaces/ImageFilesCallbacks.html b/api/interfaces/ImageFilesCallbacks.html index 5d9f36887b8..39588f4b8cd 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:773

+

packages/extension-api/src/extension-api.d.ts:773

\ No newline at end of file diff --git a/api/interfaces/ImageFilesProvider.html b/api/interfaces/ImageFilesProvider.html index 3f0efcfd894..d86eae0f6b8 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:788

+

packages/extension-api/src/extension-api.d.ts:788

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:784

+

packages/extension-api/src/extension-api.d.ts:784

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:802

+

packages/extension-api/src/extension-api.d.ts:802

@@ -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:792

+

packages/extension-api/src/extension-api.d.ts:792

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:797

+

packages/extension-api/src/extension-api.d.ts:797

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 15c0c7e16f8..a0c93ff720b 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:806

+

packages/extension-api/src/extension-api.d.ts:806

\ No newline at end of file diff --git a/api/interfaces/ImageFilesystemLayer.html b/api/interfaces/ImageFilesystemLayer.html index 62f311be7b1..bf90f6b7c2f 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:741

+

packages/extension-api/src/extension-api.d.ts:741

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:745

+

packages/extension-api/src/extension-api.d.ts:745

id​

@@ -42,7 +42,7 @@

unique id of the layer

Defined in​

-

packages/extension-api/src/extension-api.d.ts:737

+

packages/extension-api/src/extension-api.d.ts:737

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:753

+

packages/extension-api/src/extension-api.d.ts:753

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:749

+

packages/extension-api/src/extension-api.d.ts:749

\ No newline at end of file diff --git a/api/interfaces/ImageFilesystemLayers.html b/api/interfaces/ImageFilesystemLayers.html index 97ce3a0fa4b..c40cc15610c 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:760

+

packages/extension-api/src/extension-api.d.ts:760

\ No newline at end of file diff --git a/api/interfaces/ImageInfo.html b/api/interfaces/ImageInfo.html index 78b2d0f5d41..dbe9523056f 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:2149

+

packages/extension-api/src/extension-api.d.ts:2149

Created​

Created: number

Defined in​

-

packages/extension-api/src/extension-api.d.ts:2144

+

packages/extension-api/src/extension-api.d.ts:2144

Digest​

Digest: string

Defined in​

-

packages/extension-api/src/extension-api.d.ts:2151

+

packages/extension-api/src/extension-api.d.ts:2151

History?​

optional History: string[]

Defined in​

-

packages/extension-api/src/extension-api.d.ts:2150

+

packages/extension-api/src/extension-api.d.ts:2150

Id​

Id: string

Defined in​

-

packages/extension-api/src/extension-api.d.ts:2140

+

packages/extension-api/src/extension-api.d.ts:2140

Labels​

@@ -61,69 +61,69 @@

Index Signature​

[label: string]: string

Defined in​

-

packages/extension-api/src/extension-api.d.ts:2148

+

packages/extension-api/src/extension-api.d.ts:2148

ParentId​

ParentId: string

Defined in​

-

packages/extension-api/src/extension-api.d.ts:2141

+

packages/extension-api/src/extension-api.d.ts:2141

RepoDigests?​

optional RepoDigests: string[]

Defined in​

-

packages/extension-api/src/extension-api.d.ts:2143

+

packages/extension-api/src/extension-api.d.ts:2143

RepoTags​

RepoTags: undefined | string[]

Defined in​

-

packages/extension-api/src/extension-api.d.ts:2142

+

packages/extension-api/src/extension-api.d.ts:2142

SharedSize​

SharedSize: number

Defined in​

-

packages/extension-api/src/extension-api.d.ts:2147

+

packages/extension-api/src/extension-api.d.ts:2147

Size​

Size: number

Defined in​

-

packages/extension-api/src/extension-api.d.ts:2145

+

packages/extension-api/src/extension-api.d.ts:2145

VirtualSize​

VirtualSize: number

Defined in​

-

packages/extension-api/src/extension-api.d.ts:2146

+

packages/extension-api/src/extension-api.d.ts:2146

engineId​

engineId: string

Defined in​

-

packages/extension-api/src/extension-api.d.ts:2138

+

packages/extension-api/src/extension-api.d.ts:2138

engineName​

engineName: string

Defined in​

-

packages/extension-api/src/extension-api.d.ts:2139

+

packages/extension-api/src/extension-api.d.ts:2139

isManifest?​

optional isManifest: boolean

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/ImageInspectInfo.html b/api/interfaces/ImageInspectInfo.html index 5a9afe23e40..ddc4507e621 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:2211

+

packages/extension-api/src/extension-api.d.ts:2211

Author​

Author: string

Defined in​

-

packages/extension-api/src/extension-api.d.ts:2189

+

packages/extension-api/src/extension-api.d.ts:2189

Comment​

Comment: string

Defined in​

-

packages/extension-api/src/extension-api.d.ts:2164

+

packages/extension-api/src/extension-api.d.ts:2164

Config​

@@ -127,14 +127,14 @@

WorkingDir: string

Defined in​

-

packages/extension-api/src/extension-api.d.ts:2190

+

packages/extension-api/src/extension-api.d.ts:2190

Container​

Container: string

Defined in​

-

packages/extension-api/src/extension-api.d.ts:2166

+

packages/extension-api/src/extension-api.d.ts:2166

ContainerConfig​

@@ -223,21 +223,21 @@

WorkingDir: string

Defined in​

-

packages/extension-api/src/extension-api.d.ts:2167

+

packages/extension-api/src/extension-api.d.ts:2167

Created​

Created: string

Defined in​

-

packages/extension-api/src/extension-api.d.ts:2165

+

packages/extension-api/src/extension-api.d.ts:2165

DockerVersion​

DockerVersion: string

Defined in​

-

packages/extension-api/src/extension-api.d.ts:2188

+

packages/extension-api/src/extension-api.d.ts:2188

GraphDriver​

@@ -264,42 +264,42 @@

Name: string

Defined in​

-

packages/extension-api/src/extension-api.d.ts:2215

+

packages/extension-api/src/extension-api.d.ts:2215

Id​

Id: string

Defined in​

-

packages/extension-api/src/extension-api.d.ts:2160

+

packages/extension-api/src/extension-api.d.ts:2160

Os​

Os: string

Defined in​

-

packages/extension-api/src/extension-api.d.ts:2212

+

packages/extension-api/src/extension-api.d.ts:2212

Parent​

Parent: string

Defined in​

-

packages/extension-api/src/extension-api.d.ts:2163

+

packages/extension-api/src/extension-api.d.ts:2163

RepoDigests​

RepoDigests: string[]

Defined in​

-

packages/extension-api/src/extension-api.d.ts:2162

+

packages/extension-api/src/extension-api.d.ts:2162

RepoTags​

RepoTags: string[]

Defined in​

-

packages/extension-api/src/extension-api.d.ts:2161

+

packages/extension-api/src/extension-api.d.ts:2161

RootFS​

@@ -318,34 +318,34 @@

Type: string

Defined in​

-

packages/extension-api/src/extension-api.d.ts:2223

+

packages/extension-api/src/extension-api.d.ts:2223

Size​

Size: number

Defined in​

-

packages/extension-api/src/extension-api.d.ts:2213

+

packages/extension-api/src/extension-api.d.ts:2213

VirtualSize​

VirtualSize: number

Defined in​

-

packages/extension-api/src/extension-api.d.ts:2214

+

packages/extension-api/src/extension-api.d.ts:2214

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

\ No newline at end of file diff --git a/api/interfaces/InputBoxOptions.html b/api/interfaces/InputBoxOptions.html index 989a334295d..773a220920d 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:1160

+

packages/extension-api/src/extension-api.d.ts:1160

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:1144

+

packages/extension-api/src/extension-api.d.ts:1144

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:1165

+

packages/extension-api/src/extension-api.d.ts:1165

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:1154

+

packages/extension-api/src/extension-api.d.ts:1154

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:1149

+

packages/extension-api/src/extension-api.d.ts:1149

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:1139

+

packages/extension-api/src/extension-api.d.ts:1139

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:1121

+

packages/extension-api/src/extension-api.d.ts:1121

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:1126

+

packages/extension-api/src/extension-api.d.ts:1126

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:1134

+

packages/extension-api/src/extension-api.d.ts:1134

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:1175

+

packages/extension-api/src/extension-api.d.ts:1175

\ No newline at end of file diff --git a/api/interfaces/InputBoxValidationMessage.html b/api/interfaces/InputBoxValidationMessage.html index 0f166526125..fb46aee900f 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:1104

+

packages/extension-api/src/extension-api.d.ts:1104

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:1111

+

packages/extension-api/src/extension-api.d.ts:1111

\ No newline at end of file diff --git a/api/interfaces/InstallCheck.html b/api/interfaces/InstallCheck.html index 0e40397e036..602ce873720 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:532

+

packages/extension-api/src/extension-api.d.ts:532

Methods​

execute()​

@@ -33,7 +33,7 @@

Returns​

Promise<CheckResult>

Defined in​

-

packages/extension-api/src/extension-api.d.ts:533

+

packages/extension-api/src/extension-api.d.ts:533

init()?​

@@ -42,6 +42,6 @@

Returns​

Promise<void>

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/KubeconfigUpdateEvent.html b/api/interfaces/KubeconfigUpdateEvent.html index a108442214e..bea3f484d47 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:2106

+

packages/extension-api/src/extension-api.d.ts:2106

type​

readonly type: "CREATE" | "UPDATE" | "DELETE"

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/interfaces/KubernetesGeneratorProvider.html b/api/interfaces/KubernetesGeneratorProvider.html index 9c543e06f97..6fc58f974e0 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:2132

+

packages/extension-api/src/extension-api.d.ts:2132

types​

types: KubernetesGeneratorSelector

Defined in​

-

packages/extension-api/src/extension-api.d.ts:2133

+

packages/extension-api/src/extension-api.d.ts:2133

Methods​

generate()​

@@ -44,6 +44,6 @@ KubernetesGeneratorType.

Returns​

Promise<GenerateKubeResult>

Defined in​

-

packages/extension-api/src/extension-api.d.ts:2134

+

packages/extension-api/src/extension-api.d.ts:2134

\ No newline at end of file diff --git a/api/interfaces/KubernetesProviderConnection.html b/api/interfaces/KubernetesProviderConnection.html index d4027aff1b9..381db4ca027 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:464

+

packages/extension-api/src/extension-api.d.ts:464

lifecycle?​

optional lifecycle: ProviderConnectionLifecycle

Defined in​

-

packages/extension-api/src/extension-api.d.ts:465

+

packages/extension-api/src/extension-api.d.ts:465

name​

name: string

Defined in​

-

packages/extension-api/src/extension-api.d.ts:463

+

packages/extension-api/src/extension-api.d.ts:463

Methods​

status()​

@@ -47,6 +47,6 @@

Returns​

ProviderConnectionStatus

Defined in​

-

packages/extension-api/src/extension-api.d.ts:466

+

packages/extension-api/src/extension-api.d.ts:466

\ No newline at end of file diff --git a/api/interfaces/KubernetesProviderConnectionEndpoint.html b/api/interfaces/KubernetesProviderConnectionEndpoint.html index cab1ec6b156..cdb7376905a 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:460

+

packages/extension-api/src/extension-api.d.ts:460

\ No newline at end of file diff --git a/api/interfaces/KubernetesProviderConnectionFactory.html b/api/interfaces/KubernetesProviderConnectionFactory.html index 862756d83f3..509cc1d0415 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:478

+

packages/extension-api/src/extension-api.d.ts:478

creationDisplayName?​

@@ -39,7 +39,7 @@

Inherited from​

ProviderConnectionFactory.creationDisplayName

Defined in​

-

packages/extension-api/src/extension-api.d.ts:475

+

packages/extension-api/src/extension-api.d.ts:475

Methods​

create()?​

@@ -52,7 +52,7 @@

Returns​

Promise<void>

Defined in​

-

packages/extension-api/src/extension-api.d.ts:490

+

packages/extension-api/src/extension-api.d.ts:490

initialize()?​

@@ -63,6 +63,6 @@

Inherited from​

ProviderConnectionFactory.initialize

Defined in​

-

packages/extension-api/src/extension-api.d.ts:472

+

packages/extension-api/src/extension-api.d.ts:472

\ No newline at end of file diff --git a/api/interfaces/LifecycleContext.html b/api/interfaces/LifecycleContext.html index c41f8279d98..5fb700cb9c3 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 6bc5ea89d3b..143f6ab911a 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:514

+

packages/extension-api/src/extension-api.d.ts:514

title​

title: string

Defined in​

-

packages/extension-api/src/extension-api.d.ts:512

+

packages/extension-api/src/extension-api.d.ts:512

url​

url: string

Defined in​

-

packages/extension-api/src/extension-api.d.ts:513

+

packages/extension-api/src/extension-api.d.ts:513

\ No newline at end of file diff --git a/api/interfaces/ListImagesOptions.html b/api/interfaces/ListImagesOptions.html index 7cfa6189167..e01fd64e10e 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:3327

+

packages/extension-api/src/extension-api.d.ts:3327

\ No newline at end of file diff --git a/api/interfaces/ListInfosOptions.html b/api/interfaces/ListInfosOptions.html index 6ac27760f6e..9f775cbf349 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:3431

+

packages/extension-api/src/extension-api.d.ts:3431

\ No newline at end of file diff --git a/api/interfaces/Logger.html b/api/interfaces/Logger.html index 25aed986bb1..16c8288d067 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 9951cff3454..6509839548b 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:435

+

packages/extension-api/src/extension-api.d.ts:435

amend?​

optional amend: boolean

Defined in​

-

packages/extension-api/src/extension-api.d.ts:434

+

packages/extension-api/src/extension-api.d.ts:434

images​

images: string[]

Defined in​

-

packages/extension-api/src/extension-api.d.ts:432

+

packages/extension-api/src/extension-api.d.ts:432

name​

name: string

Defined in​

-

packages/extension-api/src/extension-api.d.ts:433

+

packages/extension-api/src/extension-api.d.ts:433

provider?​

optional provider: ContainerProviderConnection

Defined in​

-

packages/extension-api/src/extension-api.d.ts:438

+

packages/extension-api/src/extension-api.d.ts:438

\ No newline at end of file diff --git a/api/interfaces/ManifestInspectInfo.html b/api/interfaces/ManifestInspectInfo.html index 28b9942b40d..e6e19eec308 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:441

+

packages/extension-api/src/extension-api.d.ts:441

engineName​

engineName: string

Defined in​

-

packages/extension-api/src/extension-api.d.ts:442

+

packages/extension-api/src/extension-api.d.ts:442

manifests​

manifests: object[]

Defined in​

-

packages/extension-api/src/extension-api.d.ts:443

+

packages/extension-api/src/extension-api.d.ts:443

mediaType​

mediaType: string

Defined in​

-

packages/extension-api/src/extension-api.d.ts:455

+

packages/extension-api/src/extension-api.d.ts:455

schemaVersion​

schemaVersion: number

Defined in​

-

packages/extension-api/src/extension-api.d.ts:456

+

packages/extension-api/src/extension-api.d.ts:456

\ No newline at end of file diff --git a/api/interfaces/MemoryStats.html b/api/interfaces/MemoryStats.html index d43c596a48e..b1c2d84016b 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:3127

+

packages/extension-api/src/extension-api.d.ts:3127

commitpeakbytes?​

optional commitpeakbytes: number

Defined in​

-

packages/extension-api/src/extension-api.d.ts:3128

+

packages/extension-api/src/extension-api.d.ts:3128

failcnt​

failcnt: number

Defined in​

-

packages/extension-api/src/extension-api.d.ts:3123

+

packages/extension-api/src/extension-api.d.ts:3123

limit​

limit: number

Defined in​

-

packages/extension-api/src/extension-api.d.ts:3124

+

packages/extension-api/src/extension-api.d.ts:3124

max_usage​

max_usage: number

Defined in​

-

packages/extension-api/src/extension-api.d.ts:3121

+

packages/extension-api/src/extension-api.d.ts:3121

privateworkingset?​

optional privateworkingset: number

Defined in​

-

packages/extension-api/src/extension-api.d.ts:3129

+

packages/extension-api/src/extension-api.d.ts:3129

stats​

@@ -182,13 +182,13 @@

writeback: number

Defined in​

-

packages/extension-api/src/extension-api.d.ts:3090

+

packages/extension-api/src/extension-api.d.ts:3090

usage​

usage: number

Defined in​

-

packages/extension-api/src/extension-api.d.ts:3122

+

packages/extension-api/src/extension-api.d.ts:3122

\ No newline at end of file diff --git a/api/interfaces/MenuItem.html b/api/interfaces/MenuItem.html index 51a23cc0a65..56c846d3b2d 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 383128ba7d3..71f5bfd9359 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:2382

+

packages/extension-api/src/extension-api.d.ts:2382

Consistency?​

optional Consistency: MountConsistency

Defined in​

-

packages/extension-api/src/extension-api.d.ts:2380

+

packages/extension-api/src/extension-api.d.ts:2380

Mode?​

optional Mode: string

Defined in​

-

packages/extension-api/src/extension-api.d.ts:2381

+

packages/extension-api/src/extension-api.d.ts:2381

ReadOnly?​

optional ReadOnly: boolean

Defined in​

-

packages/extension-api/src/extension-api.d.ts:2379

+

packages/extension-api/src/extension-api.d.ts:2379

Source​

Source: string

Defined in​

-

packages/extension-api/src/extension-api.d.ts:2377

+

packages/extension-api/src/extension-api.d.ts:2377

Target​

Target: string

Defined in​

-

packages/extension-api/src/extension-api.d.ts:2376

+

packages/extension-api/src/extension-api.d.ts:2376

TmpfsOptions?​

@@ -78,14 +78,14 @@

SizeBytes: number

Defined in​

-

packages/extension-api/src/extension-api.d.ts:2393

+

packages/extension-api/src/extension-api.d.ts:2393

Type​

Type: MountType

Defined in​

-

packages/extension-api/src/extension-api.d.ts:2378

+

packages/extension-api/src/extension-api.d.ts:2378

VolumeOptions?​

@@ -116,6 +116,6 @@

NoCopy: boolean

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/NetworkContainer.html b/api/interfaces/NetworkContainer.html index 1fc055deffb..93b121fc17e 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:2232

+

packages/extension-api/src/extension-api.d.ts:2232

IPv4Address​

IPv4Address: string

Defined in​

-

packages/extension-api/src/extension-api.d.ts:2234

+

packages/extension-api/src/extension-api.d.ts:2234

IPv6Address​

IPv6Address: string

Defined in​

-

packages/extension-api/src/extension-api.d.ts:2235

+

packages/extension-api/src/extension-api.d.ts:2235

MacAddress​

MacAddress: string

Defined in​

-

packages/extension-api/src/extension-api.d.ts:2233

+

packages/extension-api/src/extension-api.d.ts:2233

Name​

Name: string

Defined in​

-

packages/extension-api/src/extension-api.d.ts:2231

+

packages/extension-api/src/extension-api.d.ts:2231

\ No newline at end of file diff --git a/api/interfaces/NetworkCreateOptions.html b/api/interfaces/NetworkCreateOptions.html index 6aa1b04e49a..e9a89b3d1a1 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:3331

+

packages/extension-api/src/extension-api.d.ts:3331

\ No newline at end of file diff --git a/api/interfaces/NetworkCreateResult.html b/api/interfaces/NetworkCreateResult.html index b6578c4e047..6cd3d5bc641 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:3335

+

packages/extension-api/src/extension-api.d.ts:3335

\ No newline at end of file diff --git a/api/interfaces/NetworkInfo.html b/api/interfaces/NetworkInfo.html index ec05ea86289..8e1971b1563 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:2307

+

packages/extension-api/src/extension-api.d.ts:2307

EndpointID​

EndpointID: string

Defined in​

-

packages/extension-api/src/extension-api.d.ts:2309

+

packages/extension-api/src/extension-api.d.ts:2309

Gateway​

Gateway: string

Defined in​

-

packages/extension-api/src/extension-api.d.ts:2310

+

packages/extension-api/src/extension-api.d.ts:2310

GlobalIPv6Address​

GlobalIPv6Address: string

Defined in​

-

packages/extension-api/src/extension-api.d.ts:2314

+

packages/extension-api/src/extension-api.d.ts:2314

GlobalIPv6PrefixLen​

GlobalIPv6PrefixLen: number

Defined in​

-

packages/extension-api/src/extension-api.d.ts:2315

+

packages/extension-api/src/extension-api.d.ts:2315

IPAMConfig?​

optional IPAMConfig: unknown

Defined in​

-

packages/extension-api/src/extension-api.d.ts:2305

+

packages/extension-api/src/extension-api.d.ts:2305

IPAddress​

IPAddress: string

Defined in​

-

packages/extension-api/src/extension-api.d.ts:2311

+

packages/extension-api/src/extension-api.d.ts:2311

IPPrefixLen​

IPPrefixLen: number

Defined in​

-

packages/extension-api/src/extension-api.d.ts:2312

+

packages/extension-api/src/extension-api.d.ts:2312

IPv6Gateway​

IPv6Gateway: string

Defined in​

-

packages/extension-api/src/extension-api.d.ts:2313

+

packages/extension-api/src/extension-api.d.ts:2313

optional Links: unknown

Defined in​

-

packages/extension-api/src/extension-api.d.ts:2306

+

packages/extension-api/src/extension-api.d.ts:2306

MacAddress​

MacAddress: string

Defined in​

-

packages/extension-api/src/extension-api.d.ts:2316

+

packages/extension-api/src/extension-api.d.ts:2316

NetworkID​

NetworkID: string

Defined in​

-

packages/extension-api/src/extension-api.d.ts:2308

+

packages/extension-api/src/extension-api.d.ts:2308

\ No newline at end of file diff --git a/api/interfaces/NetworkInspectInfo.html b/api/interfaces/NetworkInspectInfo.html index bbddb484300..8359db735fa 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:2256

+

packages/extension-api/src/extension-api.d.ts:2256

ConfigFrom?​

@@ -35,14 +35,14 @@

Network: string

Defined in​

-

packages/extension-api/src/extension-api.d.ts:2258

+

packages/extension-api/src/extension-api.d.ts:2258

ConfigOnly​

ConfigOnly: boolean

Defined in​

-

packages/extension-api/src/extension-api.d.ts:2259

+

packages/extension-api/src/extension-api.d.ts:2259

Containers?​

@@ -51,56 +51,56 @@

Index Signature​

[id: string]: NetworkContainer

Defined in​

-

packages/extension-api/src/extension-api.d.ts:2260

+

packages/extension-api/src/extension-api.d.ts:2260

Created​

Created: string

Defined in​

-

packages/extension-api/src/extension-api.d.ts:2250

+

packages/extension-api/src/extension-api.d.ts:2250

Driver​

Driver: string

Defined in​

-

packages/extension-api/src/extension-api.d.ts:2252

+

packages/extension-api/src/extension-api.d.ts:2252

EnableIPv6​

EnableIPv6: boolean

Defined in​

-

packages/extension-api/src/extension-api.d.ts:2253

+

packages/extension-api/src/extension-api.d.ts:2253

IPAM?​

optional IPAM: IPAM

Defined in​

-

packages/extension-api/src/extension-api.d.ts:2254

+

packages/extension-api/src/extension-api.d.ts:2254

Id​

Id: string

Defined in​

-

packages/extension-api/src/extension-api.d.ts:2249

+

packages/extension-api/src/extension-api.d.ts:2249

Ingress​

Ingress: boolean

Defined in​

-

packages/extension-api/src/extension-api.d.ts:2257

+

packages/extension-api/src/extension-api.d.ts:2257

Internal​

Internal: boolean

Defined in​

-

packages/extension-api/src/extension-api.d.ts:2255

+

packages/extension-api/src/extension-api.d.ts:2255

Labels?​

@@ -109,14 +109,14 @@

Index Signature​

[key: string]: string

Defined in​

-

packages/extension-api/src/extension-api.d.ts:2262

+

packages/extension-api/src/extension-api.d.ts:2262

Name​

Name: string

Defined in​

-

packages/extension-api/src/extension-api.d.ts:2248

+

packages/extension-api/src/extension-api.d.ts:2248

Options?​

@@ -125,34 +125,34 @@

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

Scope​

Scope: string

Defined in​

-

packages/extension-api/src/extension-api.d.ts:2251

+

packages/extension-api/src/extension-api.d.ts:2251

engineId​

engineId: string

Defined in​

-

packages/extension-api/src/extension-api.d.ts:2245

+

packages/extension-api/src/extension-api.d.ts:2245

engineName​

engineName: string

Defined in​

-

packages/extension-api/src/extension-api.d.ts:2246

+

packages/extension-api/src/extension-api.d.ts:2246

engineType​

engineType: "docker" | "podman"

Defined in​

-

packages/extension-api/src/extension-api.d.ts:2247

+

packages/extension-api/src/extension-api.d.ts:2247

\ No newline at end of file diff --git a/api/interfaces/NetworkStats.html b/api/interfaces/NetworkStats.html index 76282837dfb..6d1f6a4b21e 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 95c3decad4c..3357d4c8693 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:2816

+

packages/extension-api/src/extension-api.d.ts:2816

\ No newline at end of file diff --git a/api/interfaces/NotificationOptions.html b/api/interfaces/NotificationOptions.html index 734fea233b3..1c9b54a74ef 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:1440

+

packages/extension-api/src/extension-api.d.ts:1440

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:1456

+

packages/extension-api/src/extension-api.d.ts:1456

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:1452

+

packages/extension-api/src/extension-api.d.ts:1452

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:1444

+

packages/extension-api/src/extension-api.d.ts:1444

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:1436

+

packages/extension-api/src/extension-api.d.ts:1436

type?​

@@ -65,6 +65,6 @@

The type of the notification. Default value: info

Defined in​

-

packages/extension-api/src/extension-api.d.ts:1448

+

packages/extension-api/src/extension-api.d.ts:1448

\ No newline at end of file diff --git a/api/interfaces/OpenDialogOptions.html b/api/interfaces/OpenDialogOptions.html index 06927c14b45..655f935bd9c 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:1798

+

packages/extension-api/src/extension-api.d.ts:1798

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:1814

+

packages/extension-api/src/extension-api.d.ts:1814

openLabel?​

@@ -42,7 +42,7 @@

A human-readable string for the open button.

Defined in​

-

packages/extension-api/src/extension-api.d.ts:1803

+

packages/extension-api/src/extension-api.d.ts:1803

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:1809

+

packages/extension-api/src/extension-api.d.ts:1809

title?​

@@ -59,6 +59,6 @@ supported:

Dialog title.

Defined in​

-

packages/extension-api/src/extension-api.d.ts:1822

+

packages/extension-api/src/extension-api.d.ts:1822

\ No newline at end of file diff --git a/api/interfaces/PidsStats.html b/api/interfaces/PidsStats.html index 2530028aecd..93b1a5de88e 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:3044

+

packages/extension-api/src/extension-api.d.ts:3044

limit?​

optional limit: number

Defined in​

-

packages/extension-api/src/extension-api.d.ts:3045

+

packages/extension-api/src/extension-api.d.ts:3045

\ No newline at end of file diff --git a/api/interfaces/PodContainerInfo.html b/api/interfaces/PodContainerInfo.html index 297d9435152..efd8a1bb4e6 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:2320

+

packages/extension-api/src/extension-api.d.ts:2320

Names​

Names: string

Defined in​

-

packages/extension-api/src/extension-api.d.ts:2321

+

packages/extension-api/src/extension-api.d.ts:2321

Status​

Status: string

Defined in​

-

packages/extension-api/src/extension-api.d.ts:2322

+

packages/extension-api/src/extension-api.d.ts:2322

\ No newline at end of file diff --git a/api/interfaces/PodCreateOptions.html b/api/interfaces/PodCreateOptions.html index cbe5f5e693b..c3f925d365e 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:399

+

packages/extension-api/src/extension-api.d.ts:399

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:428

+

packages/extension-api/src/extension-api.d.ts:428

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:389

+

packages/extension-api/src/extension-api.d.ts:389

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:379

+

packages/extension-api/src/extension-api.d.ts:379

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:408

+

packages/extension-api/src/extension-api.d.ts:408

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:385

+

packages/extension-api/src/extension-api.d.ts:385

provider?​

optional provider: ContainerProviderConnection

Defined in​

-

packages/extension-api/src/extension-api.d.ts:391

+

packages/extension-api/src/extension-api.d.ts:391

\ No newline at end of file diff --git a/api/interfaces/PodCreatePortOptions.html b/api/interfaces/PodCreatePortOptions.html index b6c6d8fa4ff..277170f2e0a 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:369

+

packages/extension-api/src/extension-api.d.ts:369

host_ip​

host_ip: string

Defined in​

-

packages/extension-api/src/extension-api.d.ts:368

+

packages/extension-api/src/extension-api.d.ts:368

host_port​

host_port: number

Defined in​

-

packages/extension-api/src/extension-api.d.ts:370

+

packages/extension-api/src/extension-api.d.ts:370

protocol​

protocol: string

Defined in​

-

packages/extension-api/src/extension-api.d.ts:371

+

packages/extension-api/src/extension-api.d.ts:371

range​

range: number

Defined in​

-

packages/extension-api/src/extension-api.d.ts:372

+

packages/extension-api/src/extension-api.d.ts:372

\ No newline at end of file diff --git a/api/interfaces/PodInfo.html b/api/interfaces/PodInfo.html index 0d9b5bf60b2..b6868001e9e 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:2329

+

packages/extension-api/src/extension-api.d.ts:2329

Containers​

Containers: PodContainerInfo[]

Defined in​

-

packages/extension-api/src/extension-api.d.ts:2330

+

packages/extension-api/src/extension-api.d.ts:2330

Created​

Created: string

Defined in​

-

packages/extension-api/src/extension-api.d.ts:2331

+

packages/extension-api/src/extension-api.d.ts:2331

Id​

Id: string

Defined in​

-

packages/extension-api/src/extension-api.d.ts:2332

+

packages/extension-api/src/extension-api.d.ts:2332

InfraId​

InfraId: string

Defined in​

-

packages/extension-api/src/extension-api.d.ts:2333

+

packages/extension-api/src/extension-api.d.ts:2333

Labels​

@@ -61,55 +61,55 @@

Index Signature​

[key: string]: string

Defined in​

-

packages/extension-api/src/extension-api.d.ts:2334

+

packages/extension-api/src/extension-api.d.ts:2334

Name​

Name: string

Defined in​

-

packages/extension-api/src/extension-api.d.ts:2335

+

packages/extension-api/src/extension-api.d.ts:2335

Namespace​

Namespace: string

Defined in​

-

packages/extension-api/src/extension-api.d.ts:2336

+

packages/extension-api/src/extension-api.d.ts:2336

Networks​

Networks: string[]

Defined in​

-

packages/extension-api/src/extension-api.d.ts:2337

+

packages/extension-api/src/extension-api.d.ts:2337

Status​

Status: string

Defined in​

-

packages/extension-api/src/extension-api.d.ts:2338

+

packages/extension-api/src/extension-api.d.ts:2338

engineId​

engineId: string

Defined in​

-

packages/extension-api/src/extension-api.d.ts:2326

+

packages/extension-api/src/extension-api.d.ts:2326

engineName​

engineName: string

Defined in​

-

packages/extension-api/src/extension-api.d.ts:2327

+

packages/extension-api/src/extension-api.d.ts:2327

kind​

kind: "podman" | "kubernetes"

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/PodmanContainerCreateOptions.html b/api/interfaces/PodmanContainerCreateOptions.html index 33d269e4a6d..4a7ac69468e 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:2820

+

packages/extension-api/src/extension-api.d.ts:2820

entrypoint?​

optional entrypoint: string | string[]

Defined in​

-

packages/extension-api/src/extension-api.d.ts:2821

+

packages/extension-api/src/extension-api.d.ts:2821

env?​

@@ -40,41 +40,41 @@

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

hostname?​

optional hostname: string

Defined in​

-

packages/extension-api/src/extension-api.d.ts:2824

+

packages/extension-api/src/extension-api.d.ts:2824

image?​

optional image: string

Defined in​

-

packages/extension-api/src/extension-api.d.ts:2825

+

packages/extension-api/src/extension-api.d.ts:2825

mounts?​

optional mounts: object[]

Defined in​

-

packages/extension-api/src/extension-api.d.ts:2827

+

packages/extension-api/src/extension-api.d.ts:2827

name?​

optional name: string

Defined in​

-

packages/extension-api/src/extension-api.d.ts:2826

+

packages/extension-api/src/extension-api.d.ts:2826

pod?​

optional pod: string

Defined in​

-

packages/extension-api/src/extension-api.d.ts:2823

+

packages/extension-api/src/extension-api.d.ts:2823

\ No newline at end of file diff --git a/api/interfaces/Port.html b/api/interfaces/Port.html index 2721ed1499d..b88941199c6 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:2298

+

packages/extension-api/src/extension-api.d.ts:2298

PrivatePort​

PrivatePort: number

Defined in​

-

packages/extension-api/src/extension-api.d.ts:2299

+

packages/extension-api/src/extension-api.d.ts:2299

PublicPort​

PublicPort: number

Defined in​

-

packages/extension-api/src/extension-api.d.ts:2300

+

packages/extension-api/src/extension-api.d.ts:2300

Type​

Type: string

Defined in​

-

packages/extension-api/src/extension-api.d.ts:2301

+

packages/extension-api/src/extension-api.d.ts:2301

\ No newline at end of file diff --git a/api/interfaces/PortBinding.html b/api/interfaces/PortBinding.html index 8a4dddece65..2ccdd067f9c 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:2356

+

packages/extension-api/src/extension-api.d.ts:2356

HostPort?​

optional HostPort: string

Defined in​

-

packages/extension-api/src/extension-api.d.ts:2357

+

packages/extension-api/src/extension-api.d.ts:2357

\ No newline at end of file diff --git a/api/interfaces/PortMap.html b/api/interfaces/PortMap.html index a1829430971..e9d2fd875ee 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 8c857ab1afa..813013e30ea 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:1007

+

packages/extension-api/src/extension-api.d.ts:1007

\ No newline at end of file diff --git a/api/interfaces/ProgressOptions.html b/api/interfaces/ProgressOptions.html index 76818f6eb8b..ed13bc707fb 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:1051

+

packages/extension-api/src/extension-api.d.ts:1051

location​

@@ -37,7 +37,7 @@ button.

The location at which progress should show.

Defined in​

-

packages/extension-api/src/extension-api.d.ts:1037

+

packages/extension-api/src/extension-api.d.ts:1037

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:1043

+

packages/extension-api/src/extension-api.d.ts:1043

\ No newline at end of file diff --git a/api/interfaces/Provider.html b/api/interfaces/Provider.html index dd4e9a92763..c8a0f377522 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:629

+

packages/extension-api/src/extension-api.d.ts:629

id​

readonly id: string

Defined in​

-

packages/extension-api/src/extension-api.d.ts:614

+

packages/extension-api/src/extension-api.d.ts:614

images​

readonly images: ProviderImages

Defined in​

-

packages/extension-api/src/extension-api.d.ts:624

+

packages/extension-api/src/extension-api.d.ts:624

readonly links: Link[]

Defined in​

-

packages/extension-api/src/extension-api.d.ts:626

+

packages/extension-api/src/extension-api.d.ts:626

name​

readonly name: string

Defined in​

-

packages/extension-api/src/extension-api.d.ts:613

+

packages/extension-api/src/extension-api.d.ts:613

onDidUpdateDetectionChecks​

onDidUpdateDetectionChecks: Event<ProviderDetectionCheck[]>

Defined in​

-

packages/extension-api/src/extension-api.d.ts:640

+

packages/extension-api/src/extension-api.d.ts:640

onDidUpdateStatus​

onDidUpdateStatus: Event<ProviderStatus>

Defined in​

-

packages/extension-api/src/extension-api.d.ts:617

+

packages/extension-api/src/extension-api.d.ts:617

onDidUpdateVersion​

onDidUpdateVersion: Event<string>

Defined in​

-

packages/extension-api/src/extension-api.d.ts:622

+

packages/extension-api/src/extension-api.d.ts:622

status​

readonly status: ProviderStatus

Defined in​

-

packages/extension-api/src/extension-api.d.ts:615

+

packages/extension-api/src/extension-api.d.ts:615

version​

readonly version: undefined | string

Defined in​

-

packages/extension-api/src/extension-api.d.ts:620

+

packages/extension-api/src/extension-api.d.ts:620

warnings​

readonly warnings: ProviderInformation[]

Defined in​

-

packages/extension-api/src/extension-api.d.ts:636

+

packages/extension-api/src/extension-api.d.ts:636

Methods​

dispose()​

@@ -103,7 +103,7 @@

Returns​

void

Defined in​

-

packages/extension-api/src/extension-api.d.ts:612

+

packages/extension-api/src/extension-api.d.ts:612

registerAutostart()​

@@ -114,7 +114,7 @@

Returns​

Disposable

Defined in​

-

packages/extension-api/src/extension-api.d.ts:608

+

packages/extension-api/src/extension-api.d.ts:608

registerCleanup()​

@@ -125,7 +125,7 @@

Returns​

Disposable

Defined in​

-

packages/extension-api/src/extension-api.d.ts:610

+

packages/extension-api/src/extension-api.d.ts:610

registerContainerProviderConnection()​

@@ -136,7 +136,7 @@

Returns​

Disposable

Defined in​

-

packages/extension-api/src/extension-api.d.ts:597

+

packages/extension-api/src/extension-api.d.ts:597

registerInstallation()​

@@ -147,7 +147,7 @@

Returns​

Disposable

Defined in​

-

packages/extension-api/src/extension-api.d.ts:602

+

packages/extension-api/src/extension-api.d.ts:602

registerKubernetesProviderConnection()​

@@ -158,7 +158,7 @@

Returns​

Disposable

Defined in​

-

packages/extension-api/src/extension-api.d.ts:598

+

packages/extension-api/src/extension-api.d.ts:598

registerLifecycle()​

@@ -169,7 +169,7 @@

Returns​

Disposable

Defined in​

-

packages/extension-api/src/extension-api.d.ts:599

+

packages/extension-api/src/extension-api.d.ts:599

registerUpdate()​

@@ -180,7 +180,7 @@

Returns​

Disposable

Defined in​

-

packages/extension-api/src/extension-api.d.ts:605

+

packages/extension-api/src/extension-api.d.ts:605

setContainerProviderConnectionFactory()​

@@ -192,7 +192,7 @@

Returns​

Disposable

Defined in​

-

packages/extension-api/src/extension-api.d.ts:588

+

packages/extension-api/src/extension-api.d.ts:588

setKubernetesProviderConnectionFactory()​

@@ -204,7 +204,7 @@

Returns​

Disposable

Defined in​

-

packages/extension-api/src/extension-api.d.ts:592

+

packages/extension-api/src/extension-api.d.ts:592

updateDetectionChecks()​

@@ -215,7 +215,7 @@

Returns​

void

Defined in​

-

packages/extension-api/src/extension-api.d.ts:633

+

packages/extension-api/src/extension-api.d.ts:633

updateStatus()​

@@ -226,7 +226,7 @@

Returns​

void

Defined in​

-

packages/extension-api/src/extension-api.d.ts:616

+

packages/extension-api/src/extension-api.d.ts:616

updateVersion()​

@@ -237,7 +237,7 @@

Returns​

void

Defined in​

-

packages/extension-api/src/extension-api.d.ts:621

+

packages/extension-api/src/extension-api.d.ts:621

updateWarnings()​

@@ -248,6 +248,6 @@

Returns​

void

Defined in​

-

packages/extension-api/src/extension-api.d.ts:637

+

packages/extension-api/src/extension-api.d.ts:637

\ No newline at end of file diff --git a/api/interfaces/ProviderAutostart.html b/api/interfaces/ProviderAutostart.html index 2fa21e7aca8..bc5e316de96 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:557

+

packages/extension-api/src/extension-api.d.ts:557

\ No newline at end of file diff --git a/api/interfaces/ProviderCleanup.html b/api/interfaces/ProviderCleanup.html index c806c5c3e1b..3e2b15ab956 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:564

+

packages/extension-api/src/extension-api.d.ts:564

\ No newline at end of file diff --git a/api/interfaces/ProviderCleanupAction.html b/api/interfaces/ProviderCleanupAction.html index 7a0f2412c07..ec22c7bbdab 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:575

+

packages/extension-api/src/extension-api.d.ts:575

Methods​

execute()​

@@ -35,6 +35,6 @@

Returns​

Promise<void>

Defined in​

-

packages/extension-api/src/extension-api.d.ts:577

+

packages/extension-api/src/extension-api.d.ts:577

\ No newline at end of file diff --git a/api/interfaces/ProviderCleanupExecuteOptions.html b/api/interfaces/ProviderCleanupExecuteOptions.html index 14ce5387392..340a3efe5d5 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:568

+

packages/extension-api/src/extension-api.d.ts:568

token?​

optional token: CancellationToken

Defined in​

-

packages/extension-api/src/extension-api.d.ts:569

+

packages/extension-api/src/extension-api.d.ts:569

\ No newline at end of file diff --git a/api/interfaces/ProviderConnectionFactory.html b/api/interfaces/ProviderConnectionFactory.html index 2bf7a05979f..dcdc059a5be 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:478

+

packages/extension-api/src/extension-api.d.ts:478

creationDisplayName?​

optional creationDisplayName: string

Defined in​

-

packages/extension-api/src/extension-api.d.ts:475

+

packages/extension-api/src/extension-api.d.ts:475

Methods​

initialize()?​

@@ -45,6 +45,6 @@

Returns​

Promise<void>

Defined in​

-

packages/extension-api/src/extension-api.d.ts:472

+

packages/extension-api/src/extension-api.d.ts:472

\ No newline at end of file diff --git a/api/interfaces/ProviderConnectionLifecycle.html b/api/interfaces/ProviderConnectionLifecycle.html index af0dd1a8f6d..e91ba15e975 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 1423e34f31b..02b82e8632f 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:702

+

packages/extension-api/src/extension-api.d.ts:702

providerId​

providerId: string

Defined in​

-

packages/extension-api/src/extension-api.d.ts:701

+

packages/extension-api/src/extension-api.d.ts:701

\ No newline at end of file diff --git a/api/interfaces/ProviderDetectionCheck.html b/api/interfaces/ProviderDetectionCheck.html index bf7e4e5cdea..ad12a9db55c 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 f3740823c97..5d0d61facd4 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:670

+

packages/extension-api/src/extension-api.d.ts:670

name​

name: string

Defined in​

-

packages/extension-api/src/extension-api.d.ts:671

+

packages/extension-api/src/extension-api.d.ts:671

status​

status: ProviderStatus

Defined in​

-

packages/extension-api/src/extension-api.d.ts:672

+

packages/extension-api/src/extension-api.d.ts:672

\ No newline at end of file diff --git a/api/interfaces/ProviderImages.html b/api/interfaces/ProviderImages.html index baf731a8467..fae36387f2f 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:583

+

packages/extension-api/src/extension-api.d.ts:583

optional logo: string | object

Defined in​

-

packages/extension-api/src/extension-api.d.ts:584

+

packages/extension-api/src/extension-api.d.ts:584

\ No newline at end of file diff --git a/api/interfaces/ProviderInformation.html b/api/interfaces/ProviderInformation.html index 5fe2a9e822d..4d28d546626 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 5b4233b1a58..d3293708ec2 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:540

+

packages/extension-api/src/extension-api.d.ts:540

preflightChecks()?​

@@ -37,6 +37,6 @@

Returns​

InstallCheck[]

Defined in​

-

packages/extension-api/src/extension-api.d.ts:538

+

packages/extension-api/src/extension-api.d.ts:538

\ No newline at end of file diff --git a/api/interfaces/ProviderLifecycle.html b/api/interfaces/ProviderLifecycle.html index 0b0e58fa449..561799b979b 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 9246e7eede5..b83b6b0f4c7 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 806ee11e0d4..f8a52d8da66 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:544

+

packages/extension-api/src/extension-api.d.ts:544

Methods​

preflightChecks()?​

@@ -33,7 +33,7 @@

Returns​

InstallCheck[]

Defined in​

-

packages/extension-api/src/extension-api.d.ts:548

+

packages/extension-api/src/extension-api.d.ts:548

update()​

@@ -44,6 +44,6 @@

Returns​

Promise<void>

Defined in​

-

packages/extension-api/src/extension-api.d.ts:546

+

packages/extension-api/src/extension-api.d.ts:546

\ No newline at end of file diff --git a/api/interfaces/ProxySettings.html b/api/interfaces/ProxySettings.html index 82e0c7ad61e..ec7bc07bb64 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:847

+

packages/extension-api/src/extension-api.d.ts:847

httpsProxy​

httpsProxy: undefined | string

Defined in​

-

packages/extension-api/src/extension-api.d.ts:848

+

packages/extension-api/src/extension-api.d.ts:848

noProxy​

noProxy: undefined | string

Defined in​

-

packages/extension-api/src/extension-api.d.ts:849

+

packages/extension-api/src/extension-api.d.ts:849

\ No newline at end of file diff --git a/api/interfaces/PullEvent.html b/api/interfaces/PullEvent.html index 6c75d5082d0..13943023e19 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:2670

+

packages/extension-api/src/extension-api.d.ts:2670

errorDetails?​

@@ -35,21 +35,21 @@

optional message: string

Defined in​

-

packages/extension-api/src/extension-api.d.ts:2671

+

packages/extension-api/src/extension-api.d.ts:2671

id?​

optional id: string

Defined in​

-

packages/extension-api/src/extension-api.d.ts:2663

+

packages/extension-api/src/extension-api.d.ts:2663

progress?​

optional progress: string

Defined in​

-

packages/extension-api/src/extension-api.d.ts:2665

+

packages/extension-api/src/extension-api.d.ts:2665

progressDetail?​

@@ -64,20 +64,20 @@

optional total: number

Defined in​

-

packages/extension-api/src/extension-api.d.ts:2666

+

packages/extension-api/src/extension-api.d.ts:2666

status?​

optional status: string

Defined in​

-

packages/extension-api/src/extension-api.d.ts:2664

+

packages/extension-api/src/extension-api.d.ts:2664

stream?​

optional stream: string

Defined in​

-

packages/extension-api/src/extension-api.d.ts:2662

+

packages/extension-api/src/extension-api.d.ts:2662

\ No newline at end of file diff --git a/api/interfaces/QuickInputButton.html b/api/interfaces/QuickInputButton.html index 6c272de47aa..acec17d516d 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:1207

+

packages/extension-api/src/extension-api.d.ts:1207

tooltip?​

@@ -34,6 +34,6 @@

An optional tooltip.

Defined in​

-

packages/extension-api/src/extension-api.d.ts:1212

+

packages/extension-api/src/extension-api.d.ts:1212

\ No newline at end of file diff --git a/api/interfaces/QuickPickItem.html b/api/interfaces/QuickPickItem.html index a27e109cbfe..a51e2d58048 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:1308

+

packages/extension-api/src/extension-api.d.ts:1308

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:1318

+

packages/extension-api/src/extension-api.d.ts:1318

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:1280

+

packages/extension-api/src/extension-api.d.ts:1280

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:1288

+

packages/extension-api/src/extension-api.d.ts:1288

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:1272

+

packages/extension-api/src/extension-api.d.ts:1272

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:1266

+

packages/extension-api/src/extension-api.d.ts:1266

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:1301

+

packages/extension-api/src/extension-api.d.ts:1301

\ No newline at end of file diff --git a/api/interfaces/QuickPickOptions.html b/api/interfaces/QuickPickOptions.html index f84cb8faded..1080bcdfe45 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:1248

+

packages/extension-api/src/extension-api.d.ts:1248

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:1243

+

packages/extension-api/src/extension-api.d.ts:1243

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:1227

+

packages/extension-api/src/extension-api.d.ts:1227

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:1232

+

packages/extension-api/src/extension-api.d.ts:1232

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:1237

+

packages/extension-api/src/extension-api.d.ts:1237

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:1222

+

packages/extension-api/src/extension-api.d.ts:1222

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:1254

+

packages/extension-api/src/extension-api.d.ts:1254

\ No newline at end of file diff --git a/api/interfaces/RegisterContainerConnectionEvent.html b/api/interfaces/RegisterContainerConnectionEvent.html index 6d93170bea4..ef1735b1408 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: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

\ No newline at end of file diff --git a/api/interfaces/RegisterKubernetesConnectionEvent.html b/api/interfaces/RegisterKubernetesConnectionEvent.html index 574b5b122f8..86899266680 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:694

+

packages/extension-api/src/extension-api.d.ts:694

\ No newline at end of file diff --git a/api/interfaces/Registry.html b/api/interfaces/Registry.html index 235398ee81b..6478f4b54e5 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:887

+

packages/extension-api/src/extension-api.d.ts:887

icon?​

optional icon: string

Defined in​

-

packages/extension-api/src/extension-api.d.ts:879

+

packages/extension-api/src/extension-api.d.ts:879

insecure?​

@@ -46,14 +46,14 @@

Inherited from​

RegistryCreateOptions.insecure

Defined in​

-

packages/extension-api/src/extension-api.d.ts:886

+

packages/extension-api/src/extension-api.d.ts:886

name?​

optional name: string

Defined in​

-

packages/extension-api/src/extension-api.d.ts:878

+

packages/extension-api/src/extension-api.d.ts:878

secret​

@@ -62,7 +62,7 @@

Inherited from​

RegistryCreateOptions.secret

Defined in​

-

packages/extension-api/src/extension-api.d.ts:885

+

packages/extension-api/src/extension-api.d.ts:885

serverUrl​

@@ -71,14 +71,14 @@

Inherited from​

RegistryCreateOptions.serverUrl

Defined in​

-

packages/extension-api/src/extension-api.d.ts:883

+

packages/extension-api/src/extension-api.d.ts:883

source​

source: string

Defined in​

-

packages/extension-api/src/extension-api.d.ts:875

+

packages/extension-api/src/extension-api.d.ts:875

username​

@@ -87,6 +87,6 @@

Inherited from​

RegistryCreateOptions.username

Defined in​

-

packages/extension-api/src/extension-api.d.ts:884

+

packages/extension-api/src/extension-api.d.ts:884

\ No newline at end of file diff --git a/api/interfaces/RegistryConfig.html b/api/interfaces/RegistryConfig.html index dc60286aa48..9a499acc513 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 36f451910e0..a8412b99f2c 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:887

+

packages/extension-api/src/extension-api.d.ts:887

insecure?​

optional insecure: boolean

Defined in​

-

packages/extension-api/src/extension-api.d.ts:886

+

packages/extension-api/src/extension-api.d.ts:886

secret​

secret: string

Defined in​

-

packages/extension-api/src/extension-api.d.ts:885

+

packages/extension-api/src/extension-api.d.ts:885

serverUrl​

serverUrl: string

Defined in​

-

packages/extension-api/src/extension-api.d.ts:883

+

packages/extension-api/src/extension-api.d.ts:883

username​

username: string

Defined in​

-

packages/extension-api/src/extension-api.d.ts:884

+

packages/extension-api/src/extension-api.d.ts:884

\ No newline at end of file diff --git a/api/interfaces/RegistryProvider.html b/api/interfaces/RegistryProvider.html index 8d6526ec775..416f5f1710f 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:891

+

packages/extension-api/src/extension-api.d.ts:891

Methods​

create()​

@@ -35,6 +35,6 @@

Returns​

Registry

Defined in​

-

packages/extension-api/src/extension-api.d.ts:892

+

packages/extension-api/src/extension-api.d.ts:892

\ No newline at end of file diff --git a/api/interfaces/RegistrySuggestedProvider.html b/api/interfaces/RegistrySuggestedProvider.html index 13d5993a93e..ec316e6e77a 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:871

+

packages/extension-api/src/extension-api.d.ts:871

name​

name: string

Defined in​

-

packages/extension-api/src/extension-api.d.ts:867

+

packages/extension-api/src/extension-api.d.ts:867

url​

url: string

Defined in​

-

packages/extension-api/src/extension-api.d.ts:868

+

packages/extension-api/src/extension-api.d.ts:868

\ No newline at end of file diff --git a/api/interfaces/RunError.html b/api/interfaces/RunError.html index 477c62974c0..4ad41576220 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:4093

+

packages/extension-api/src/extension-api.d.ts:4093

cause?​

@@ -47,7 +47,7 @@

The command that was executed.

Defined in​

-

packages/extension-api/src/extension-api.d.ts:4078

+

packages/extension-api/src/extension-api.d.ts:4078

exitCode​

@@ -55,7 +55,7 @@

The exit code of the command.

Defined in​

-

packages/extension-api/src/extension-api.d.ts:4073

+

packages/extension-api/src/extension-api.d.ts:4073

killed​

@@ -63,7 +63,7 @@

Indicates whether the process was forcefully killed.

Defined in​

-

packages/extension-api/src/extension-api.d.ts:4098

+

packages/extension-api/src/extension-api.d.ts:4098

message​

@@ -73,7 +73,7 @@

Overrides​

Error.message

Defined in​

-

packages/extension-api/src/extension-api.d.ts:4068

+

packages/extension-api/src/extension-api.d.ts:4068

name​

@@ -99,7 +99,7 @@

The standard error (stderr) content of the command.

Defined in​

-

packages/extension-api/src/extension-api.d.ts:4088

+

packages/extension-api/src/extension-api.d.ts:4088

stdout​

@@ -107,6 +107,6 @@

The standard output (stdout) content of the command.

Defined in​

-

packages/extension-api/src/extension-api.d.ts:4083

+

packages/extension-api/src/extension-api.d.ts:4083

\ No newline at end of file diff --git a/api/interfaces/RunOptions.html b/api/interfaces/RunOptions.html index 188c5a5da86..6228de6a35c 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:4028

+

packages/extension-api/src/extension-api.d.ts:4028

encoding?​

@@ -34,7 +34,7 @@

The encoding to use. Default utf8

Defined in​

-

packages/extension-api/src/extension-api.d.ts:4038

+

packages/extension-api/src/extension-api.d.ts:4038

env?​

@@ -44,7 +44,7 @@

Index Signature​

[key: string]: string

Defined in​

-

packages/extension-api/src/extension-api.d.ts:4013

+

packages/extension-api/src/extension-api.d.ts:4013

isAdmin?​

@@ -52,7 +52,7 @@

admin privileges required

Defined in​

-

packages/extension-api/src/extension-api.d.ts:4033

+

packages/extension-api/src/extension-api.d.ts:4033

logger?​

@@ -60,7 +60,7 @@

A logger used to track execution events.

Defined in​

-

packages/extension-api/src/extension-api.d.ts:4023

+

packages/extension-api/src/extension-api.d.ts:4023

token?​

@@ -68,6 +68,6 @@

A cancellation token used to request cancellation.

Defined in​

-

packages/extension-api/src/extension-api.d.ts:4018

+

packages/extension-api/src/extension-api.d.ts:4018

\ No newline at end of file diff --git a/api/interfaces/RunResult.html b/api/interfaces/RunResult.html index b18a28b23e7..41fdb2f80a8 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:4048

+

packages/extension-api/src/extension-api.d.ts:4048

stderr​

@@ -34,7 +34,7 @@

The standard error (stderr) content of the command.

Defined in​

-

packages/extension-api/src/extension-api.d.ts:4058

+

packages/extension-api/src/extension-api.d.ts:4058

stdout​

@@ -42,6 +42,6 @@

The standard output (stdout) content of the command.

Defined in​

-

packages/extension-api/src/extension-api.d.ts:4053

+

packages/extension-api/src/extension-api.d.ts:4053

\ No newline at end of file diff --git a/api/interfaces/SaveDialogOptions.html b/api/interfaces/SaveDialogOptions.html index e6fef24fab2..0b8e0115d75 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:1832

+

packages/extension-api/src/extension-api.d.ts:1832

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:1842

+

packages/extension-api/src/extension-api.d.ts:1842

saveLabel?​

@@ -42,7 +42,7 @@

A human-readable string for the save button.

Defined in​

-

packages/extension-api/src/extension-api.d.ts:1837

+

packages/extension-api/src/extension-api.d.ts:1837

title?​

@@ -50,6 +50,6 @@

Dialog title.

Defined in​

-

packages/extension-api/src/extension-api.d.ts:1850

+

packages/extension-api/src/extension-api.d.ts:1850

\ No newline at end of file diff --git a/api/interfaces/SecretStorage.html b/api/interfaces/SecretStorage.html index 00addc3e0eb..fc57b54f760 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:4518

+

packages/extension-api/src/extension-api.d.ts:4518

Methods​

delete()​

@@ -40,7 +40,7 @@ sensitive.

Returns​

Promise<void>

Defined in​

-

packages/extension-api/src/extension-api.d.ts:4513

+

packages/extension-api/src/extension-api.d.ts:4513

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:4500

+

packages/extension-api/src/extension-api.d.ts:4500

store()​

@@ -70,6 +70,6 @@ is no secret matching that key.

Returns​

Promise<void>

Defined in​

-

packages/extension-api/src/extension-api.d.ts:4507

+

packages/extension-api/src/extension-api.d.ts:4507

\ No newline at end of file diff --git a/api/interfaces/SecretStorageChangeEvent.html b/api/interfaces/SecretStorageChangeEvent.html index 173c1fb7537..7212f61ef3a 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:4486

+

packages/extension-api/src/extension-api.d.ts:4486

\ No newline at end of file diff --git a/api/interfaces/StatusBarItem.html b/api/interfaces/StatusBarItem.html index 4d8354290ba..db09318e024 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:1485

+

packages/extension-api/src/extension-api.d.ts:1485

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:1513

+

packages/extension-api/src/extension-api.d.ts:1513

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:1518

+

packages/extension-api/src/extension-api.d.ts:1518

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:1509

+

packages/extension-api/src/extension-api.d.ts:1509

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:1504

+

packages/extension-api/src/extension-api.d.ts:1504

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:1490

+

packages/extension-api/src/extension-api.d.ts:1490

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:1494

+

packages/extension-api/src/extension-api.d.ts:1494

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:1498

+

packages/extension-api/src/extension-api.d.ts:1498

Methods​

dispose()​

@@ -98,7 +98,7 @@ or more to the right.

Returns​

void

Defined in​

-

packages/extension-api/src/extension-api.d.ts:1532

+

packages/extension-api/src/extension-api.d.ts:1532

hide()​

@@ -108,7 +108,7 @@ or more to the right.

Returns​

void

Defined in​

-

packages/extension-api/src/extension-api.d.ts:1526

+

packages/extension-api/src/extension-api.d.ts:1526

show()​

@@ -118,6 +118,6 @@ or more to the right.

Returns​

void

Defined in​

-

packages/extension-api/src/extension-api.d.ts:1522

+

packages/extension-api/src/extension-api.d.ts:1522

\ No newline at end of file diff --git a/api/interfaces/StorageStats.html b/api/interfaces/StorageStats.html index 241dae2ce76..a25053fa871 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:3067

+

packages/extension-api/src/extension-api.d.ts:3067

read_size_bytes?​

optional read_size_bytes: number

Defined in​

-

packages/extension-api/src/extension-api.d.ts:3068

+

packages/extension-api/src/extension-api.d.ts:3068

write_count_normalized?​

optional write_count_normalized: number

Defined in​

-

packages/extension-api/src/extension-api.d.ts:3069

+

packages/extension-api/src/extension-api.d.ts:3069

write_size_bytes?​

optional write_size_bytes: number

Defined in​

-

packages/extension-api/src/extension-api.d.ts:3070

+

packages/extension-api/src/extension-api.d.ts:3070

\ No newline at end of file diff --git a/api/interfaces/TelemetryLogger.html b/api/interfaces/TelemetryLogger.html index 387b21e9a23..3575ccab8ea 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:4155

+

packages/extension-api/src/extension-api.d.ts:4155

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:4150

+

packages/extension-api/src/extension-api.d.ts:4150

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:4145

+

packages/extension-api/src/extension-api.d.ts:4145

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:4190

+

packages/extension-api/src/extension-api.d.ts:4190

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:4177

+

packages/extension-api/src/extension-api.d.ts:4177

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:4185

+

packages/extension-api/src/extension-api.d.ts:4185

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:4166

+

packages/extension-api/src/extension-api.d.ts:4166

\ No newline at end of file diff --git a/api/interfaces/TelemetryLoggerOptions.html b/api/interfaces/TelemetryLoggerOptions.html index 48947a9d0a1..cdc1a9e315f 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:4243

+

packages/extension-api/src/extension-api.d.ts:4243

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:4231

+

packages/extension-api/src/extension-api.d.ts:4231

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:4237

+

packages/extension-api/src/extension-api.d.ts:4237

\ No newline at end of file diff --git a/api/interfaces/TelemetrySender.html b/api/interfaces/TelemetrySender.html index d4ad273dc7c..39388a9620f 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:4220

+

packages/extension-api/src/extension-api.d.ts:4220

sendErrorData()​

@@ -45,7 +45,7 @@ as its TelemetryLogger is being di

Returns​

void

Defined in​

-

packages/extension-api/src/extension-api.d.ts:4214

+

packages/extension-api/src/extension-api.d.ts:4214

sendEventData()​

@@ -60,6 +60,6 @@ as its TelemetryLogger is being di

Returns​

void

Defined in​

-

packages/extension-api/src/extension-api.d.ts:4205

+

packages/extension-api/src/extension-api.d.ts:4205

\ No newline at end of file diff --git a/api/interfaces/ThrottlingData.html b/api/interfaces/ThrottlingData.html index 001747ba326..5a3fb7c91b1 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:3140

+

packages/extension-api/src/extension-api.d.ts:3140

throttled_periods​

throttled_periods: number

Defined in​

-

packages/extension-api/src/extension-api.d.ts:3141

+

packages/extension-api/src/extension-api.d.ts:3141

throttled_time​

throttled_time: 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/UnregisterContainerConnectionEvent.html b/api/interfaces/UnregisterContainerConnectionEvent.html index fafef0835bf..4c02f6c9040 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:688

+

packages/extension-api/src/extension-api.d.ts:688

\ No newline at end of file diff --git a/api/interfaces/UnregisterKubernetesConnectionEvent.html b/api/interfaces/UnregisterKubernetesConnectionEvent.html index e71369332fe..3f423c425a3 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:691

+

packages/extension-api/src/extension-api.d.ts:691

\ No newline at end of file diff --git a/api/interfaces/UpdateContainerConnectionEvent.html b/api/interfaces/UpdateContainerConnectionEvent.html index 59921faa868..78bb1f3cd46 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:677

+

packages/extension-api/src/extension-api.d.ts:677

providerId​

providerId: string

Defined in​

-

packages/extension-api/src/extension-api.d.ts:676

+

packages/extension-api/src/extension-api.d.ts:676

status​

status: ProviderConnectionStatus

Defined in​

-

packages/extension-api/src/extension-api.d.ts:678

+

packages/extension-api/src/extension-api.d.ts:678

\ No newline at end of file diff --git a/api/interfaces/UpdateKubernetesConnectionEvent.html b/api/interfaces/UpdateKubernetesConnectionEvent.html index d788c83bde6..d5e45008d35 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:683

+

packages/extension-api/src/extension-api.d.ts:683

providerId​

providerId: string

Defined in​

-

packages/extension-api/src/extension-api.d.ts:682

+

packages/extension-api/src/extension-api.d.ts:682

status​

status: ProviderConnectionStatus

Defined in​

-

packages/extension-api/src/extension-api.d.ts:684

+

packages/extension-api/src/extension-api.d.ts:684

\ No newline at end of file diff --git a/api/interfaces/VolumeCreateOptions.html b/api/interfaces/VolumeCreateOptions.html index f8dddb09786..cf73cd7f82e 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:3405

+

packages/extension-api/src/extension-api.d.ts:3405

provider?​

optional provider: ContainerProviderConnection

Defined in​

-

packages/extension-api/src/extension-api.d.ts:3407

+

packages/extension-api/src/extension-api.d.ts:3407

\ No newline at end of file diff --git a/api/interfaces/VolumeCreateResponseInfo.html b/api/interfaces/VolumeCreateResponseInfo.html index 5150fa8c3d4..870603d1651 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:3419

+

packages/extension-api/src/extension-api.d.ts:3419

Driver​

Driver: string

Defined in​

-

packages/extension-api/src/extension-api.d.ts:3417

+

packages/extension-api/src/extension-api.d.ts:3417

Labels​

@@ -40,28 +40,28 @@

Index Signature​

[label: string]: string

Defined in​

-

packages/extension-api/src/extension-api.d.ts:3421

+

packages/extension-api/src/extension-api.d.ts:3421

Mountpoint​

Mountpoint: string

Defined in​

-

packages/extension-api/src/extension-api.d.ts:3418

+

packages/extension-api/src/extension-api.d.ts:3418

Name​

Name: string

Defined in​

-

packages/extension-api/src/extension-api.d.ts:3416

+

packages/extension-api/src/extension-api.d.ts:3416

Scope​

Scope: string

Defined in​

-

packages/extension-api/src/extension-api.d.ts:3422

+

packages/extension-api/src/extension-api.d.ts:3422

Status?​

@@ -70,6 +70,6 @@

Index Signature​

[key: string]: string

Defined in​

-

packages/extension-api/src/extension-api.d.ts:3420

+

packages/extension-api/src/extension-api.d.ts:3420

\ No newline at end of file diff --git a/api/interfaces/VolumeDeleteOptions.html b/api/interfaces/VolumeDeleteOptions.html index 3c916ac1b77..a847a82d40b 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:3412

+

packages/extension-api/src/extension-api.d.ts:3412

\ No newline at end of file diff --git a/api/interfaces/VolumeInfo.html b/api/interfaces/VolumeInfo.html index ae3c9cb05bc..7badc2d184f 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:3383

+

packages/extension-api/src/extension-api.d.ts:3383

Driver​

Driver: string

Defined in​

-

packages/extension-api/src/extension-api.d.ts:3386

+

packages/extension-api/src/extension-api.d.ts:3386

Labels​

@@ -40,35 +40,35 @@

Index Signature​

[key: string]: string

Defined in​

-

packages/extension-api/src/extension-api.d.ts:3389

+

packages/extension-api/src/extension-api.d.ts:3389

Mountpoint​

Mountpoint: string

Defined in​

-

packages/extension-api/src/extension-api.d.ts:3387

+

packages/extension-api/src/extension-api.d.ts:3387

Name​

Name: string

Defined in​

-

packages/extension-api/src/extension-api.d.ts:3385

+

packages/extension-api/src/extension-api.d.ts:3385

Options?​

optional Options: null | object

Defined in​

-

packages/extension-api/src/extension-api.d.ts:3391

+

packages/extension-api/src/extension-api.d.ts:3391

Scope​

Scope: "global" | "local"

Defined in​

-

packages/extension-api/src/extension-api.d.ts:3390

+

packages/extension-api/src/extension-api.d.ts:3390

Status?​

@@ -77,34 +77,34 @@

Index Signature​

[key: string]: string

Defined in​

-

packages/extension-api/src/extension-api.d.ts:3388

+

packages/extension-api/src/extension-api.d.ts:3388

UsageData?​

optional UsageData: null | object

Defined in​

-

packages/extension-api/src/extension-api.d.ts:3392

+

packages/extension-api/src/extension-api.d.ts:3392

containersUsage​

containersUsage: object[]

Defined in​

-

packages/extension-api/src/extension-api.d.ts:3384

+

packages/extension-api/src/extension-api.d.ts:3384

engineId​

engineId: string

Defined in​

-

packages/extension-api/src/extension-api.d.ts:3381

+

packages/extension-api/src/extension-api.d.ts:3381

engineName​

engineName: string

Defined in​

-

packages/extension-api/src/extension-api.d.ts:3382

+

packages/extension-api/src/extension-api.d.ts:3382

\ No newline at end of file diff --git a/api/interfaces/VolumeListInfo.html b/api/interfaces/VolumeListInfo.html index 874eac1f93b..4337ff0bf4c 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:3398

+

packages/extension-api/src/extension-api.d.ts:3398

Warnings​

Warnings: string[]

Defined in​

-

packages/extension-api/src/extension-api.d.ts:3399

+

packages/extension-api/src/extension-api.d.ts:3399

engineId​

engineId: string

Defined in​

-

packages/extension-api/src/extension-api.d.ts:3400

+

packages/extension-api/src/extension-api.d.ts:3400

engineName​

engineName: string

Defined in​

-

packages/extension-api/src/extension-api.d.ts:3401

+

packages/extension-api/src/extension-api.d.ts:3401

\ No newline at end of file diff --git a/api/interfaces/Webview.html b/api/interfaces/Webview.html index 5c4c7c8e7b1..b5bcc962f29 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:1712

+

packages/extension-api/src/extension-api.d.ts:1712

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:1689

+

packages/extension-api/src/extension-api.d.ts:1689

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:1696

+

packages/extension-api/src/extension-api.d.ts:1696

options​

@@ -52,7 +52,7 @@

Content settings for the webview.

Defined in​

-

packages/extension-api/src/extension-api.d.ts:1681

+

packages/extension-api/src/extension-api.d.ts:1681

Methods​

asWebviewUri()​

@@ -64,7 +64,7 @@

Returns​

Uri

Defined in​

-

packages/extension-api/src/extension-api.d.ts:1706

+

packages/extension-api/src/extension-api.d.ts:1706

postMessage()​

@@ -76,6 +76,6 @@

Returns​

Promise<boolean>

Defined in​

-

packages/extension-api/src/extension-api.d.ts:1701

+

packages/extension-api/src/extension-api.d.ts:1701

\ No newline at end of file diff --git a/api/interfaces/WebviewInfo.html b/api/interfaces/WebviewInfo.html index 2f2773d1205..c88350ab941 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:3038

+

packages/extension-api/src/extension-api.d.ts:3038

title​

title: string

Defined in​

-

packages/extension-api/src/extension-api.d.ts:3040

+

packages/extension-api/src/extension-api.d.ts:3040

viewType​

viewType: string

Defined in​

-

packages/extension-api/src/extension-api.d.ts:3039

+

packages/extension-api/src/extension-api.d.ts:3039

\ No newline at end of file diff --git a/api/interfaces/WebviewOptions.html b/api/interfaces/WebviewOptions.html index bbb4b88e86e..948aeb1adfc 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:1671

+

packages/extension-api/src/extension-api.d.ts:1671

\ No newline at end of file diff --git a/api/interfaces/WebviewPanel.html b/api/interfaces/WebviewPanel.html index a5c2d6f547b..81cdc8e885e 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:1753

+

packages/extension-api/src/extension-api.d.ts:1753

iconPath?​

@@ -34,7 +34,7 @@

Icon for the panel shown in UI.

Defined in​

-

packages/extension-api/src/extension-api.d.ts:1732

+

packages/extension-api/src/extension-api.d.ts:1732

onDidChangeViewState​

@@ -42,7 +42,7 @@

Fired when the panel's view state changes.

Defined in​

-

packages/extension-api/src/extension-api.d.ts:1763

+

packages/extension-api/src/extension-api.d.ts:1763

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:1773

+

packages/extension-api/src/extension-api.d.ts:1773

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:1727

+

packages/extension-api/src/extension-api.d.ts:1727

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:1722

+

packages/extension-api/src/extension-api.d.ts:1722

visible​

@@ -77,7 +77,7 @@ called on it.

Whether the panel is visible.

Defined in​

-

packages/extension-api/src/extension-api.d.ts:1758

+

packages/extension-api/src/extension-api.d.ts:1758

webview​

@@ -85,7 +85,7 @@ called on it.

Webview belonging to the panel.

Defined in​

-

packages/extension-api/src/extension-api.d.ts:1748

+

packages/extension-api/src/extension-api.d.ts:1748

Methods​

dispose()​

@@ -98,7 +98,7 @@ fire the onDispose event.

Returns​

void

Defined in​

-

packages/extension-api/src/extension-api.d.ts:1788

+

packages/extension-api/src/extension-api.d.ts:1788

reveal()​

@@ -111,6 +111,6 @@ fire the onDispose event.

Returns​

void

Defined in​

-

packages/extension-api/src/extension-api.d.ts:1779

+

packages/extension-api/src/extension-api.d.ts:1779

\ No newline at end of file diff --git a/api/interfaces/WebviewPanelOnDidChangeViewStateEvent.html b/api/interfaces/WebviewPanelOnDidChangeViewStateEvent.html index 445157b589c..dec095f0da1 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:1860

+

packages/extension-api/src/extension-api.d.ts:1860

\ No newline at end of file diff --git a/api/namespaces/authentication.html b/api/namespaces/authentication.html index bf6c1626af2..48a7633b401 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 a0db5c7ea70..cf2bc12aef2 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:3892

+

packages/extension-api/src/extension-api.d.ts:3892

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:3911

+

packages/extension-api/src/extension-api.d.ts:3911

\ No newline at end of file diff --git a/api/namespaces/authentication/functions/onDidChangeSessions.html b/api/namespaces/authentication/functions/onDidChangeSessions.html index 1a9b9432952..eacc5d875f9 100644 --- a/api/namespaces/authentication/functions/onDidChangeSessions.html +++ b/api/namespaces/authentication/functions/onDidChangeSessions.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:3921

+

packages/extension-api/src/extension-api.d.ts:3921

\ No newline at end of file diff --git a/api/namespaces/authentication/functions/registerAuthenticationProvider.html b/api/namespaces/authentication/functions/registerAuthenticationProvider.html index afd9ed4321b..858f45adbbf 100644 --- a/api/namespaces/authentication/functions/registerAuthenticationProvider.html +++ b/api/namespaces/authentication/functions/registerAuthenticationProvider.html @@ -13,7 +13,7 @@ - + @@ -38,6 +38,6 @@ has already been used by another provider. Ids are case-sensitive.

Params​

options Additional options for the provider.

Defined in​

-

packages/extension-api/src/extension-api.d.ts:3935

+

packages/extension-api/src/extension-api.d.ts:3935

\ No newline at end of file diff --git a/api/namespaces/cli.html b/api/namespaces/cli.html index 34420509fac..6971e503519 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 0e14b72b4e5..24377b7f22a 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:4350

+

packages/extension-api/src/extension-api.d.ts:4350

\ No newline at end of file diff --git a/api/namespaces/commands.html b/api/namespaces/commands.html index 6b120b6d832..8490f7baa40 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 884dbc534b6..1637bcc7f6c 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:666

+

packages/extension-api/src/extension-api.d.ts:666

\ No newline at end of file diff --git a/api/namespaces/commands/functions/registerCommand.html b/api/namespaces/commands/functions/registerCommand.html index d48974923e6..5aadd3dd660 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:654

+

packages/extension-api/src/extension-api.d.ts:654

\ No newline at end of file diff --git a/api/namespaces/configuration.html b/api/namespaces/configuration.html index 005f21b27a4..100ef4f680a 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 9131fe0c8a5..ea53e06a7a1 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:931

+

packages/extension-api/src/extension-api.d.ts:931

\ No newline at end of file diff --git a/api/namespaces/configuration/functions/onDidChangeConfiguration.html b/api/namespaces/configuration/functions/onDidChangeConfiguration.html index b7f3592f96f..1fac4f06e09 100644 --- a/api/namespaces/configuration/functions/onDidChangeConfiguration.html +++ b/api/namespaces/configuration/functions/onDidChangeConfiguration.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:936

+

packages/extension-api/src/extension-api.d.ts:936

\ No newline at end of file diff --git a/api/namespaces/containerEngine.html b/api/namespaces/containerEngine.html index 4a82beef04e..cb39f4c996c 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 4f3a1236747..a979a63ee22 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:3536

+

packages/extension-api/src/extension-api.d.ts:3536

\ No newline at end of file diff --git a/api/namespaces/containerEngine/functions/createContainer.html b/api/namespaces/containerEngine/functions/createContainer.html index de11ce2acb4..e52ab8a6e3a 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:3461

+

packages/extension-api/src/extension-api.d.ts:3461

\ No newline at end of file diff --git a/api/namespaces/containerEngine/functions/createManifest.html b/api/namespaces/containerEngine/functions/createManifest.html index da006b701c6..76ec9c50615 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:3671

+

packages/extension-api/src/extension-api.d.ts:3671

\ No newline at end of file diff --git a/api/namespaces/containerEngine/functions/createNetwork.html b/api/namespaces/containerEngine/functions/createNetwork.html index 572e17526d0..b5c6e7672c8 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:3650

+

packages/extension-api/src/extension-api.d.ts:3650

\ No newline at end of file diff --git a/api/namespaces/containerEngine/functions/createPod.html b/api/namespaces/containerEngine/functions/createPod.html index 30c1c20835b..b9b467c044e 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:3659

+

packages/extension-api/src/extension-api.d.ts:3659

\ No newline at end of file diff --git a/api/namespaces/containerEngine/functions/createVolume.html b/api/namespaces/containerEngine/functions/createVolume.html index fa3e76c723f..1e11b37b0e0 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:3656

+

packages/extension-api/src/extension-api.d.ts:3656

\ No newline at end of file diff --git a/api/namespaces/containerEngine/functions/deleteContainer.html b/api/namespaces/containerEngine/functions/deleteContainer.html index 81706fde431..355496dfd3e 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:3528

+

packages/extension-api/src/extension-api.d.ts:3528

\ No newline at end of file diff --git a/api/namespaces/containerEngine/functions/deleteImage.html b/api/namespaces/containerEngine/functions/deleteImage.html index 53058611530..73f43aa847e 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:3616

+

packages/extension-api/src/extension-api.d.ts:3616

\ No newline at end of file diff --git a/api/namespaces/containerEngine/functions/deleteVolume.html b/api/namespaces/containerEngine/functions/deleteVolume.html index ec793154c06..c3fd5980431 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:3657

+

packages/extension-api/src/extension-api.d.ts:3657

\ No newline at end of file diff --git a/api/namespaces/containerEngine/functions/getImageInspect.html b/api/namespaces/containerEngine/functions/getImageInspect.html index d70e14dbf46..22bfe657990 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:3625

+

packages/extension-api/src/extension-api.d.ts:3625

\ No newline at end of file diff --git a/api/namespaces/containerEngine/functions/info.html b/api/namespaces/containerEngine/functions/info.html index 3e2d365b9b9..6df4b9b4b89 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:3627

+

packages/extension-api/src/extension-api.d.ts:3627

\ No newline at end of file diff --git a/api/namespaces/containerEngine/functions/inspectContainer.html b/api/namespaces/containerEngine/functions/inspectContainer.html index 59efb886ab7..3150476062d 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:3452

+

packages/extension-api/src/extension-api.d.ts:3452

\ No newline at end of file diff --git a/api/namespaces/containerEngine/functions/inspectManifest.html b/api/namespaces/containerEngine/functions/inspectManifest.html index c1b3c948c1a..a85fdbd4e17 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:3672

+

packages/extension-api/src/extension-api.d.ts:3672

\ No newline at end of file diff --git a/api/namespaces/containerEngine/functions/listContainers.html b/api/namespaces/containerEngine/functions/listContainers.html index c538cd2b19d..603c5b2ac7c 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:3443

+

packages/extension-api/src/extension-api.d.ts:3443

\ No newline at end of file diff --git a/api/namespaces/containerEngine/functions/listImages.html b/api/namespaces/containerEngine/functions/listImages.html index 9c9fda8fd0f..5f48c2736be 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:3568

+

packages/extension-api/src/extension-api.d.ts:3568

\ No newline at end of file diff --git a/api/namespaces/containerEngine/functions/listInfos.html b/api/namespaces/containerEngine/functions/listInfos.html index 6444027b611..65fe967e695 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:3646

+

packages/extension-api/src/extension-api.d.ts:3646

\ No newline at end of file diff --git a/api/namespaces/containerEngine/functions/listNetworks.html b/api/namespaces/containerEngine/functions/listNetworks.html index a1b8de42c24..50daa58019d 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:3649

+

packages/extension-api/src/extension-api.d.ts:3649

\ No newline at end of file diff --git a/api/namespaces/containerEngine/functions/listPods.html b/api/namespaces/containerEngine/functions/listPods.html index 8cc21980c1c..49417aa63ba 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:3666

+

packages/extension-api/src/extension-api.d.ts:3666

\ No newline at end of file diff --git a/api/namespaces/containerEngine/functions/listVolumes.html b/api/namespaces/containerEngine/functions/listVolumes.html index 0c44fc3fd78..2bf765fd19b 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:3655

+

packages/extension-api/src/extension-api.d.ts:3655

\ No newline at end of file diff --git a/api/namespaces/containerEngine/functions/logsContainer.html b/api/namespaces/containerEngine/functions/logsContainer.html index e0b01538785..8a050e4ebe3 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:3481

+

packages/extension-api/src/extension-api.d.ts:3481

\ No newline at end of file diff --git a/api/namespaces/containerEngine/functions/onEvent.html b/api/namespaces/containerEngine/functions/onEvent.html index 7cdac1fd0bf..b16a355cafb 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:3647

+

packages/extension-api/src/extension-api.d.ts:3647

\ No newline at end of file diff --git a/api/namespaces/containerEngine/functions/pullImage.html b/api/namespaces/containerEngine/functions/pullImage.html index 7ab00136c0a..1b5a1af4622 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:3604

+

packages/extension-api/src/extension-api.d.ts:3604

\ No newline at end of file diff --git a/api/namespaces/containerEngine/functions/pushImage.html b/api/namespaces/containerEngine/functions/pushImage.html index 73061340967..6ba8aaf6257 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:3590

+

packages/extension-api/src/extension-api.d.ts:3590

\ No newline at end of file diff --git a/api/namespaces/containerEngine/functions/removePod.html b/api/namespaces/containerEngine/functions/removePod.html index 90012d5b4c5..dd6ce46da03 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:3668

+

packages/extension-api/src/extension-api.d.ts:3668

\ No newline at end of file diff --git a/api/namespaces/containerEngine/functions/replicatePodmanContainer.html b/api/namespaces/containerEngine/functions/replicatePodmanContainer.html index 2562df6d129..472bb13be7c 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:3660

+

packages/extension-api/src/extension-api.d.ts:3660

\ No newline at end of file diff --git a/api/namespaces/containerEngine/functions/saveImage.html b/api/namespaces/containerEngine/functions/saveImage.html index 5c72abef16b..3f3e807c105 100644 --- a/api/namespaces/containerEngine/functions/saveImage.html +++ b/api/namespaces/containerEngine/functions/saveImage.html @@ -13,7 +13,7 @@ - + @@ -32,6 +32,6 @@

Returns​

Promise<void>

Defined in​

-

packages/extension-api/src/extension-api.d.ts:3549

+

packages/extension-api/src/extension-api.d.ts:3549

\ No newline at end of file diff --git a/api/namespaces/containerEngine/functions/startContainer.html b/api/namespaces/containerEngine/functions/startContainer.html index cdb69581f40..d2c7ecacc45 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:3472

+

packages/extension-api/src/extension-api.d.ts:3472

\ No newline at end of file diff --git a/api/namespaces/containerEngine/functions/startPod.html b/api/namespaces/containerEngine/functions/startPod.html index 81270a3bea6..f23d437faaf 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:3665

+

packages/extension-api/src/extension-api.d.ts:3665

\ No newline at end of file diff --git a/api/namespaces/containerEngine/functions/statsContainer.html b/api/namespaces/containerEngine/functions/statsContainer.html index 320cd94d0f5..0f858e3791c 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:3507

+

packages/extension-api/src/extension-api.d.ts:3507

\ No newline at end of file diff --git a/api/namespaces/containerEngine/functions/stopContainer.html b/api/namespaces/containerEngine/functions/stopContainer.html index 0f5903ab9ae..314d80ae43d 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:3519

+

packages/extension-api/src/extension-api.d.ts:3519

\ No newline at end of file diff --git a/api/namespaces/containerEngine/functions/stopPod.html b/api/namespaces/containerEngine/functions/stopPod.html index 446826d6fed..8397109f63a 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:3667

+

packages/extension-api/src/extension-api.d.ts:3667

\ No newline at end of file diff --git a/api/namespaces/containerEngine/functions/tagImage.html b/api/namespaces/containerEngine/functions/tagImage.html index 5393f3f4f6e..387090a14d2 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:3578

+

packages/extension-api/src/extension-api.d.ts:3578

\ No newline at end of file diff --git a/api/namespaces/context.html b/api/namespaces/context.html index 64235984c2f..c697039194a 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 179bd78f60f..4cad02ad04f 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:4277

+

packages/extension-api/src/extension-api.d.ts:4277

\ No newline at end of file diff --git a/api/namespaces/env.html b/api/namespaces/env.html index 6e7d40c93ca..32092a1d9d2 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 93e784a4b89..bb450fc1480 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:3998

+

packages/extension-api/src/extension-api.d.ts:3998

\ No newline at end of file diff --git a/api/namespaces/env/functions/onDidChangeTelemetryEnabled.html b/api/namespaces/env/functions/onDidChangeTelemetryEnabled.html index fc029c3ba1f..9f9989c945f 100644 --- a/api/namespaces/env/functions/onDidChangeTelemetryEnabled.html +++ b/api/namespaces/env/functions/onDidChangeTelemetryEnabled.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:3981

+

packages/extension-api/src/extension-api.d.ts:3981

\ No newline at end of file diff --git a/api/namespaces/env/functions/openExternal.html b/api/namespaces/env/functions/openExternal.html index 6aead1ed549..b9b1c57fd78 100644 --- a/api/namespaces/env/functions/openExternal.html +++ b/api/namespaces/env/functions/openExternal.html @@ -13,7 +13,7 @@ - + @@ -28,6 +28,6 @@

Promise<boolean>

A promise indicating if open was successful.

Defined in​

-

packages/extension-api/src/extension-api.d.ts:3989

+

packages/extension-api/src/extension-api.d.ts:3989

\ No newline at end of file diff --git a/api/namespaces/env/variables/clipboard.html b/api/namespaces/env/variables/clipboard.html index 25de4966aa2..c167fdf8bf9 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:4003

+

packages/extension-api/src/extension-api.d.ts:4003

\ No newline at end of file diff --git a/api/namespaces/env/variables/isLinux.html b/api/namespaces/env/variables/isLinux.html index c2e553ae993..9b137799594 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:3969

+

packages/extension-api/src/extension-api.d.ts:3969

\ No newline at end of file diff --git a/api/namespaces/env/variables/isMac.html b/api/namespaces/env/variables/isMac.html index 311e955f3b3..a5d6c4fbe45 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:3953

+

packages/extension-api/src/extension-api.d.ts:3953

\ No newline at end of file diff --git a/api/namespaces/env/variables/isTelemetryEnabled.html b/api/namespaces/env/variables/isTelemetryEnabled.html index c2fc441f0fc..61b220b1832 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:3975

+

packages/extension-api/src/extension-api.d.ts:3975

\ No newline at end of file diff --git a/api/namespaces/env/variables/isWindows.html b/api/namespaces/env/variables/isWindows.html index 27680dfdc8b..f68f1d6e862 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:3961

+

packages/extension-api/src/extension-api.d.ts:3961

\ No newline at end of file diff --git a/api/namespaces/extensions.html b/api/namespaces/extensions.html index f8b3a798784..e97e60dc935 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 991d1bb7f03..b56adf3b1c9 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 f6e622c2258..56097c090d9 100644 --- a/api/namespaces/extensions/functions/onDidChange.html +++ b/api/namespaces/extensions/functions/onDidChange.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: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 ee9e933cdb8..499635e0b3f 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 241e1e248d4..39b4bdb51b5 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 50f90bcda19..eee54336578 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:1657

+

packages/extension-api/src/extension-api.d.ts:1657

\ No newline at end of file diff --git a/api/namespaces/imageChecker.html b/api/namespaces/imageChecker.html index 9131ca87dee..018d828f3d1 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 df9bc768dfb..1cd7b402a98 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:4420

+

packages/extension-api/src/extension-api.d.ts:4420

\ No newline at end of file diff --git a/api/namespaces/kubernetes.html b/api/namespaces/kubernetes.html index da853ead2ce..69d362a27f4 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 dadb2c51c71..305e7c6c74a 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:2092

+

packages/extension-api/src/extension-api.d.ts:2092

\ No newline at end of file diff --git a/api/namespaces/kubernetes/functions/getKubeconfig.html b/api/namespaces/kubernetes/functions/getKubeconfig.html index a23f6999fa3..46a39c58231 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:2082

+

packages/extension-api/src/extension-api.d.ts:2082

\ No newline at end of file diff --git a/api/namespaces/kubernetes/functions/onDidUpdateKubeconfig.html b/api/namespaces/kubernetes/functions/onDidUpdateKubeconfig.html index 0975267a6c8..fbc2d9cf6cf 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:2083

+

packages/extension-api/src/extension-api.d.ts:2083

\ No newline at end of file diff --git a/api/namespaces/kubernetes/functions/registerKubernetesGenerator.html b/api/namespaces/kubernetes/functions/registerKubernetesGenerator.html index 99d4fc61a73..48b2769536e 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:2099

+

packages/extension-api/src/extension-api.d.ts:2099

\ No newline at end of file diff --git a/api/namespaces/kubernetes/functions/setKubeconfig.html b/api/namespaces/kubernetes/functions/setKubeconfig.html index a0dbd8564cc..f472a08e122 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:2084

+

packages/extension-api/src/extension-api.d.ts:2084

\ No newline at end of file diff --git a/api/namespaces/navigation.html b/api/namespaces/navigation.html index f602096d14b..a838e80e22b 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 13a73f2a478..e105ab3adb1 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:4467

+

packages/extension-api/src/extension-api.d.ts:4467

\ No newline at end of file diff --git a/api/namespaces/navigation/functions/navigateToContainer.html b/api/namespaces/navigation/functions/navigateToContainer.html index e4d121bacdc..31f47ffe6a6 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:4430

+

packages/extension-api/src/extension-api.d.ts:4430

\ No newline at end of file diff --git a/api/namespaces/navigation/functions/navigateToContainerInspect.html b/api/namespaces/navigation/functions/navigateToContainerInspect.html index 3734dff7ef4..24883caa7fb 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:4434

+

packages/extension-api/src/extension-api.d.ts:4434

\ No newline at end of file diff --git a/api/namespaces/navigation/functions/navigateToContainerLogs.html b/api/namespaces/navigation/functions/navigateToContainerLogs.html index 5bb00159cf9..c3d94d46bf2 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:4432

+

packages/extension-api/src/extension-api.d.ts:4432

\ No newline at end of file diff --git a/api/namespaces/navigation/functions/navigateToContainerTerminal.html b/api/namespaces/navigation/functions/navigateToContainerTerminal.html index e06b11b9990..7a6f1302ac7 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:4436

+

packages/extension-api/src/extension-api.d.ts:4436

\ No newline at end of file diff --git a/api/namespaces/navigation/functions/navigateToContainers.html b/api/namespaces/navigation/functions/navigateToContainers.html index a38a0199e02..cfce54a0b24 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:4428

+

packages/extension-api/src/extension-api.d.ts:4428

\ No newline at end of file diff --git a/api/namespaces/navigation/functions/navigateToContribution.html b/api/namespaces/navigation/functions/navigateToContribution.html index d2230017a76..b29e49e8393 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:4454

+

packages/extension-api/src/extension-api.d.ts:4454

\ No newline at end of file diff --git a/api/namespaces/navigation/functions/navigateToEditProviderContainerConnection.html b/api/namespaces/navigation/functions/navigateToEditProviderContainerConnection.html index 779c61405c5..cd69759c1fa 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:4476

+

packages/extension-api/src/extension-api.d.ts:4476

\ No newline at end of file diff --git a/api/namespaces/navigation/functions/navigateToImage.html b/api/namespaces/navigation/functions/navigateToImage.html index 2ba79551cc1..ca7d3c9652a 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:4441

+

packages/extension-api/src/extension-api.d.ts:4441

\ No newline at end of file diff --git a/api/namespaces/navigation/functions/navigateToImages.html b/api/namespaces/navigation/functions/navigateToImages.html index 6a40d55f08d..cceaba3fdb4 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:4439

+

packages/extension-api/src/extension-api.d.ts:4439

\ No newline at end of file diff --git a/api/namespaces/navigation/functions/navigateToPod.html b/api/namespaces/navigation/functions/navigateToPod.html index a89435871b7..1ffe807c5f1 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:4451

+

packages/extension-api/src/extension-api.d.ts:4451

\ No newline at end of file diff --git a/api/namespaces/navigation/functions/navigateToPods.html b/api/namespaces/navigation/functions/navigateToPods.html index f2bad47437b..b8da2b8f671 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:4449

+

packages/extension-api/src/extension-api.d.ts:4449

\ No newline at end of file diff --git a/api/namespaces/navigation/functions/navigateToResources.html b/api/namespaces/navigation/functions/navigateToResources.html index 96e36684761..963429428ec 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:4472

+

packages/extension-api/src/extension-api.d.ts:4472

\ No newline at end of file diff --git a/api/namespaces/navigation/functions/navigateToVolume.html b/api/namespaces/navigation/functions/navigateToVolume.html index 0084ea18f24..c56f4069f6b 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:4446

+

packages/extension-api/src/extension-api.d.ts:4446

\ No newline at end of file diff --git a/api/namespaces/navigation/functions/navigateToVolumes.html b/api/namespaces/navigation/functions/navigateToVolumes.html index f01378297e7..b6c7998e826 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:4444

+

packages/extension-api/src/extension-api.d.ts:4444

\ No newline at end of file diff --git a/api/namespaces/navigation/functions/navigateToWebview.html b/api/namespaces/navigation/functions/navigateToWebview.html index 47234b0e0b0..c69fa9439fb 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:4462

    +

    packages/extension-api/src/extension-api.d.ts:4462

    \ No newline at end of file diff --git a/api/namespaces/process.html b/api/namespaces/process.html index 10f4156f13d..22f90a304d0 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 1cfd4180154..8966f89127f 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:4114

    +

    packages/extension-api/src/extension-api.d.ts:4114

    \ No newline at end of file diff --git a/api/namespaces/provider.html b/api/namespaces/provider.html index a043e7d1485..4bd4ad60d4f 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 61cfa6070a4..d56a9d2be05 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:840

    +

    packages/extension-api/src/extension-api.d.ts:840

    \ No newline at end of file diff --git a/api/namespaces/provider/functions/createProvider.html b/api/namespaces/provider/functions/createProvider.html index 771b6d670a5..8285e9c1906 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:810

    +

    packages/extension-api/src/extension-api.d.ts:810

    \ No newline at end of file diff --git a/api/namespaces/provider/functions/getContainerConnections.html b/api/namespaces/provider/functions/getContainerConnections.html index 8e915dec74b..a7a9d6f0bea 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:816

    +

    packages/extension-api/src/extension-api.d.ts:816

    \ No newline at end of file diff --git a/api/namespaces/provider/functions/getProviderLifecycleContext.html b/api/namespaces/provider/functions/getProviderLifecycleContext.html index b33ddb30c18..bcbe3c346fd 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:826

    +

    packages/extension-api/src/extension-api.d.ts:826

    \ No newline at end of file diff --git a/api/namespaces/provider/functions/onDidRegisterContainerConnection.html b/api/namespaces/provider/functions/onDidRegisterContainerConnection.html index 3b780457464..9742e7f26d4 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:815

    +

    packages/extension-api/src/extension-api.d.ts:815

    \ No newline at end of file diff --git a/api/namespaces/provider/functions/onDidUnregisterContainerConnection.html b/api/namespaces/provider/functions/onDidUnregisterContainerConnection.html index a211a1d927b..d2c4e69707b 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:814

    +

    packages/extension-api/src/extension-api.d.ts:814

    \ No newline at end of file diff --git a/api/namespaces/provider/functions/onDidUpdateContainerConnection.html b/api/namespaces/provider/functions/onDidUpdateContainerConnection.html index b0ae89f5a9f..7e0a77776e7 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:812

    +

    packages/extension-api/src/extension-api.d.ts:812

    \ No newline at end of file diff --git a/api/namespaces/provider/functions/onDidUpdateKubernetesConnection.html b/api/namespaces/provider/functions/onDidUpdateKubernetesConnection.html index 926d8836a8f..d175f5e791e 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:813

    +

    packages/extension-api/src/extension-api.d.ts:813

    \ No newline at end of file diff --git a/api/namespaces/provider/functions/onDidUpdateProvider.html b/api/namespaces/provider/functions/onDidUpdateProvider.html index db77d3d06e3..6a34071b922 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:811

    +

    packages/extension-api/src/extension-api.d.ts:811

    \ No newline at end of file diff --git a/api/namespaces/proxy.html b/api/namespaces/proxy.html index 5a150e478fc..c7a69f66447 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 8e2db3c6106..0566dcede76 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:853

    +

    packages/extension-api/src/extension-api.d.ts:853

    \ No newline at end of file diff --git a/api/namespaces/proxy/functions/isEnabled.html b/api/namespaces/proxy/functions/isEnabled.html index ac0fccd4e8f..587b1052de7 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:859

    +

    packages/extension-api/src/extension-api.d.ts:859

    \ No newline at end of file diff --git a/api/namespaces/proxy/functions/onDidStateChange.html b/api/namespaces/proxy/functions/onDidStateChange.html index 585364dc7ff..447cdff2591 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:860

    +

    packages/extension-api/src/extension-api.d.ts:860

    \ No newline at end of file diff --git a/api/namespaces/proxy/functions/onDidUpdateProxy.html b/api/namespaces/proxy/functions/onDidUpdateProxy.html index 59f1879f627..012df9717d0 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:856

    +

    packages/extension-api/src/extension-api.d.ts:856

    \ No newline at end of file diff --git a/api/namespaces/proxy/functions/setProxy.html b/api/namespaces/proxy/functions/setProxy.html index a5bc71662ee..4a2e489b100 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:854

    +

    packages/extension-api/src/extension-api.d.ts:854

    \ No newline at end of file diff --git a/api/namespaces/registry.html b/api/namespaces/registry.html index 44953e481c1..20a7744d1db 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 6195a25b0c5..af11ca2e038 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:910

    +

    packages/extension-api/src/extension-api.d.ts:910

    \ No newline at end of file diff --git a/api/namespaces/registry/functions/onDidUnregisterRegistry.html b/api/namespaces/registry/functions/onDidUnregisterRegistry.html index 0eabaa4ca9b..a8639004240 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:912

    +

    packages/extension-api/src/extension-api.d.ts:912

    \ No newline at end of file diff --git a/api/namespaces/registry/functions/onDidUpdateRegistry.html b/api/namespaces/registry/functions/onDidUpdateRegistry.html index 7134703371a..f9db863b03d 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:911

    +

    packages/extension-api/src/extension-api.d.ts:911

    \ No newline at end of file diff --git a/api/namespaces/registry/functions/registerRegistry.html b/api/namespaces/registry/functions/registerRegistry.html index 8eed2f77f4a..17b90dea9fc 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:902

    +

    packages/extension-api/src/extension-api.d.ts:902

    \ No newline at end of file diff --git a/api/namespaces/registry/functions/registerRegistryProvider.html b/api/namespaces/registry/functions/registerRegistryProvider.html index 47080fafdb1..a537ae3b800 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:899

    +

    packages/extension-api/src/extension-api.d.ts:899

    \ No newline at end of file diff --git a/api/namespaces/registry/functions/suggestRegistry.html b/api/namespaces/registry/functions/suggestRegistry.html index 6eb825312d9..a2d6cf2880c 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:908

    +

    packages/extension-api/src/extension-api.d.ts:908

    \ No newline at end of file diff --git a/api/namespaces/registry/functions/unregisterRegistry.html b/api/namespaces/registry/functions/unregisterRegistry.html index 68140b90018..a9709426e75 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:905

    +

    packages/extension-api/src/extension-api.d.ts:905

    \ No newline at end of file diff --git a/api/namespaces/tray.html b/api/namespaces/tray.html index 2cc06cbd9de..d57d7710606 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 7a72852448b..ad8f5d8b4e2 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:920

    +

    packages/extension-api/src/extension-api.d.ts:920

    \ No newline at end of file diff --git a/api/namespaces/tray/functions/registerProviderMenuItem.html b/api/namespaces/tray/functions/registerProviderMenuItem.html index dcbfe66e4b1..13f7451b713 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:927

    +

    packages/extension-api/src/extension-api.d.ts:927

    \ No newline at end of file diff --git a/api/namespaces/window.html b/api/namespaces/window.html index 5ea5fd54e8c..886cedb9a88 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 a503b33bb38..e7df6217878 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:2064

    +

    packages/extension-api/src/extension-api.d.ts:2064

    \ No newline at end of file diff --git a/api/namespaces/window/functions/createStatusBarItem.html b/api/namespaces/window/functions/createStatusBarItem.html index 35954de8f48..a07b951f236 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:1971

    +

    packages/extension-api/src/extension-api.d.ts:1971

    \ No newline at end of file diff --git a/api/namespaces/window/functions/createWebviewPanel.html b/api/namespaces/window/functions/createWebviewPanel.html index 2b786394dac..d56b60290dc 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:2075

    +

    packages/extension-api/src/extension-api.d.ts:2075

    \ No newline at end of file diff --git a/api/namespaces/window/functions/listWebviews.html b/api/namespaces/window/functions/listWebviews.html index 08d7b5e3a1b..3fb76015437 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:2077

    +

    packages/extension-api/src/extension-api.d.ts:2077

    \ No newline at end of file diff --git a/api/namespaces/window/functions/showErrorMessage.html b/api/namespaces/window/functions/showErrorMessage.html index 54588d37f96..8e4a8353771 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:1892

    +

    packages/extension-api/src/extension-api.d.ts:1892

    \ No newline at end of file diff --git a/api/namespaces/window/functions/showInformationMessage.html b/api/namespaces/window/functions/showInformationMessage.html index 0099d46ba8d..215fc2664ae 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:1872

    +

    packages/extension-api/src/extension-api.d.ts:1872

    \ No newline at end of file diff --git a/api/namespaces/window/functions/showInputBox.html b/api/namespaces/window/functions/showInputBox.html index 63cf475e85e..22d8e498850 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:1984

    +

    packages/extension-api/src/extension-api.d.ts:1984

    \ No newline at end of file diff --git a/api/namespaces/window/functions/showNotification.html b/api/namespaces/window/functions/showNotification.html index 47ff98d5059..f1cf04b639d 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:1962

    +

    packages/extension-api/src/extension-api.d.ts:1962

    \ No newline at end of file diff --git a/api/namespaces/window/functions/showOpenDialog.html b/api/namespaces/window/functions/showOpenDialog.html index cdb11c85d87..619b0792d42 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:1993

    +

    packages/extension-api/src/extension-api.d.ts:1993

    \ No newline at end of file diff --git a/api/namespaces/window/functions/showQuickPick.html b/api/namespaces/window/functions/showQuickPick.html index 16d4c98d31f..a4c7a5a1896 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:2012

    +

    packages/extension-api/src/extension-api.d.ts:2012

    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:2026

    +

    packages/extension-api/src/extension-api.d.ts:2026

    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:2040

    +

    packages/extension-api/src/extension-api.d.ts:2040

    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:2054

    +

    packages/extension-api/src/extension-api.d.ts:2054

    \ No newline at end of file diff --git a/api/namespaces/window/functions/showSaveDialog.html b/api/namespaces/window/functions/showSaveDialog.html index c5f9a3a2517..f4a36b42dea 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:2002

    +

    packages/extension-api/src/extension-api.d.ts:2002

    \ No newline at end of file diff --git a/api/namespaces/window/functions/showWarningMessage.html b/api/namespaces/window/functions/showWarningMessage.html index cfd0e74eda3..ad096e86e4f 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:1882

    +

    packages/extension-api/src/extension-api.d.ts:1882

    \ No newline at end of file diff --git a/api/namespaces/window/functions/withProgress.html b/api/namespaces/window/functions/withProgress.html index d496ffc92de..b642df01254 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:1953

    +

    packages/extension-api/src/extension-api.d.ts:1953

    \ No newline at end of file diff --git a/api/type-aliases/CheckResultLink.html b/api/type-aliases/CheckResultLink.html index 12ea2428ec4..0996dfad7ba 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:516

    +

    packages/extension-api/src/extension-api.d.ts:516

    \ No newline at end of file diff --git a/api/type-aliases/CliToolState.html b/api/type-aliases/CliToolState.html index bf592c66b23..90345e351cc 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:4317

    +

    packages/extension-api/src/extension-api.d.ts:4317

    \ No newline at end of file diff --git a/api/type-aliases/ConfigurationScope.html b/api/type-aliases/ConfigurationScope.html index 410bfdb2386..f993c4e5df4 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:942

    +

    packages/extension-api/src/extension-api.d.ts:942

    \ No newline at end of file diff --git a/api/type-aliases/KubernetesGeneratorArgument.html b/api/type-aliases/KubernetesGeneratorArgument.html index 6ee6ce61e70..29f962f3f16 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:2120

    +

    packages/extension-api/src/extension-api.d.ts:2120

    \ No newline at end of file diff --git a/api/type-aliases/KubernetesGeneratorSelector.html b/api/type-aliases/KubernetesGeneratorSelector.html index 7aa42106ed7..c0912adb450 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:2109

    +

    packages/extension-api/src/extension-api.d.ts:2109

    \ No newline at end of file diff --git a/api/type-aliases/KubernetesGeneratorType.html b/api/type-aliases/KubernetesGeneratorType.html index 6f36e672ecb..eb155f3cd57 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:2111

    +

    packages/extension-api/src/extension-api.d.ts:2111

    \ No newline at end of file diff --git a/api/type-aliases/MountConfig.html b/api/type-aliases/MountConfig.html index 1f94032ef3b..da9147925f7 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:2399

    +

    packages/extension-api/src/extension-api.d.ts:2399

    \ No newline at end of file diff --git a/api/type-aliases/MountConsistency.html b/api/type-aliases/MountConsistency.html index fc4866cff46..e2591fa7eb9 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:2371

    +

    packages/extension-api/src/extension-api.d.ts:2371

    \ No newline at end of file diff --git a/api/type-aliases/MountPropagation.html b/api/type-aliases/MountPropagation.html index 23c7b3a7b97..6a59b665736 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:2373

    +

    packages/extension-api/src/extension-api.d.ts:2373

    \ No newline at end of file diff --git a/api/type-aliases/MountType.html b/api/type-aliases/MountType.html index 98eaa8a4661..20f53d175f3 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:2369

    +

    packages/extension-api/src/extension-api.d.ts:2369

    \ No newline at end of file diff --git a/api/type-aliases/NotificationType.html b/api/type-aliases/NotificationType.html index c416a1666a0..c4d370af92d 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:1430

    +

    packages/extension-api/src/extension-api.d.ts:1430

    \ No newline at end of file diff --git a/api/type-aliases/ProviderConnectionStatus.html b/api/type-aliases/ProviderConnectionStatus.html index 917ddfd80bc..e3a6ab9acac 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 1aff98fc4ca..fc25355390d 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:580

    +

    packages/extension-api/src/extension-api.d.ts:580

    \ No newline at end of file diff --git a/api/type-aliases/ProviderResult.html b/api/type-aliases/ProviderResult.html index 175c5e29177..25adec2b556 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 833951d2ce1..f97959801a2 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 e5fe2217e66..5fa9cff1acf 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:1470

    +

    packages/extension-api/src/extension-api.d.ts:1470

    \ No newline at end of file diff --git a/api/variables/StatusBarAlignLeft.html b/api/variables/StatusBarAlignLeft.html index 0b3e004bd4a..9e7e7397722 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:1462

    +

    packages/extension-api/src/extension-api.d.ts:1462

    \ No newline at end of file diff --git a/api/variables/StatusBarAlignRight.html b/api/variables/StatusBarAlignRight.html index 21d6e65025d..ddacc0b12b2 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:1466

    +

    packages/extension-api/src/extension-api.d.ts:1466

    \ No newline at end of file diff --git a/api/variables/StatusBarItemDefaultPriority.html b/api/variables/StatusBarItemDefaultPriority.html index f07b4cbdc16..8b2de274a01 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:1475

    +

    packages/extension-api/src/extension-api.d.ts:1475

    \ No newline at end of file diff --git a/api/variables/version.html b/api/variables/version.html index f3343cbfc7c..de64b169470 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.96c77ad9.js b/assets/js/0029a336.37319785.js similarity index 97% rename from assets/js/0029a336.96c77ad9.js rename to assets/js/0029a336.37319785.js index 2a476a36f29..8df4db87b4e 100644 --- a/assets/js/0029a336.96c77ad9.js +++ b/assets/js/0029a336.37319785.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[19093],{14583:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>c,contentTitle:()=>o,default:()=>h,frontMatter:()=>i,metadata:()=>a,toc:()=>d});var r=s(24246),t=s(71670);const i={},o="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",p:"p",pre:"pre",strong:"strong",...(0,t.a)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.h1,{id:"function-withprogress",children:"Function: withProgress()"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"withProgress"}),"<",(0,r.jsx)(n.code,{children:"R"}),">(",(0,r.jsx)(n.code,{children:"options"}),", ",(0,r.jsx)(n.code,{children:"task"}),"): ",(0,r.jsx)(n.code,{children:"Promise"}),"<",(0,r.jsx)(n.code,{children:"R"}),">"]}),"\n"]}),"\n",(0,r.jsxs)(n.p,{children:["Show progress in Podman Desktop. Progress is shown while running the given callback\nand while the promise it returned isn't resolved nor rejected. The location at which\nprogress should show (and other details) is defined via the passed ",(0,r.jsx)(n.a,{href:"/api/interfaces/ProgressOptions",children:(0,r.jsx)(n.code,{children:"ProgressOptions"})}),"."]}),"\n",(0,r.jsx)(n.h2,{id:"type-parameters",children:"Type Parameters"}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"R"})]}),"\n",(0,r.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"options"}),": ",(0,r.jsx)(n.a,{href:"/api/interfaces/ProgressOptions",children:(0,r.jsx)(n.code,{children:"ProgressOptions"})})]}),"\n",(0,r.jsx)(n.p,{children:"the options for the task's details"}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"task"})]}),"\n",(0,r.jsxs)(n.p,{children:["A callback returning a promise. Progress state can be reported with\nthe provided ",(0,r.jsx)(n.a,{href:"/api/interfaces/Progress",children:"Progress"}),"-object."]}),"\n",(0,r.jsxs)(n.p,{children:["To report discrete progress, use ",(0,r.jsx)(n.code,{children:"increment"})," to indicate how much work has been completed. Each call with\na ",(0,r.jsx)(n.code,{children:"increment"})," value will be summed up and reflected as overall progress until 100% is reached (a value of\ne.g. ",(0,r.jsx)(n.code,{children:"10"})," accounts for ",(0,r.jsx)(n.code,{children:"10%"})," of work done).\nNote that currently only ",(0,r.jsx)(n.code,{children:"ProgressLocation.Notification"})," is capable of showing discrete progress."]}),"\n",(0,r.jsxs)(n.p,{children:["To monitor if the operation has been cancelled by the user, use the provided ",(0,r.jsx)(n.a,{href:"/api/interfaces/CancellationToken",children:(0,r.jsx)(n.code,{children:"CancellationToken"})}),".\nNote that currently only ",(0,r.jsx)(n.code,{children:"ProgressLocation.Notification"})," is supporting to show a cancel button to cancel the\nlong-running operation."]}),"\n",(0,r.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"Promise"}),"<",(0,r.jsx)(n.code,{children:"R"}),">"]}),"\n",(0,r.jsx)(n.p,{children:"The promise the task-callback returned."}),"\n",(0,r.jsx)(n.h2,{id:"examples",children:"Examples"}),"\n",(0,r.jsx)(n.p,{children:"Here is a simple example"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:"await window.withProgress({ location: ProgressLocation.TASK_WIDGET, title: `Running task` },\n async progress => {\n progress.report({message: 'task1' });\n await task1();\n progress.report({increment: 50, message: 'task2' });\n await task2();\n },\n);\n"})}),"\n",(0,r.jsx)(n.p,{children:"The error is propagated if thrown inside the task callback."}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:"try {\n await window.withProgress(\n { location: ProgressLocation.TASK_WIDGET, title: `Running task` },\n async progress => {\n throw new Error('error when running a task');\n },\n );\n } catch (error) {\n // do something with the error\n }\n"})}),"\n",(0,r.jsx)(n.p,{children:"You can return a value from the task callback"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:"const result: number = await window.withProgress(\n { location: ProgressLocation.TASK_WIDGET, title: `Running task` },\n async progress => {\n // compute something\n return 55;\n },\n);\n"})}),"\n",(0,r.jsx)(n.h2,{id:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L1953",children:"packages/extension-api/src/extension-api.d.ts:1953"})})]})}function h(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(l,{...e})}):l(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>a,a:()=>o});var r=s(27378);const t={},i=r.createContext(t);function o(e){const n=r.useContext(i);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function a(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:o(e.components),r.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[19093],{14583:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>c,contentTitle:()=>o,default:()=>h,frontMatter:()=>i,metadata:()=>a,toc:()=>d});var r=s(24246),t=s(71670);const i={},o="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",p:"p",pre:"pre",strong:"strong",...(0,t.a)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.h1,{id:"function-withprogress",children:"Function: withProgress()"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"withProgress"}),"<",(0,r.jsx)(n.code,{children:"R"}),">(",(0,r.jsx)(n.code,{children:"options"}),", ",(0,r.jsx)(n.code,{children:"task"}),"): ",(0,r.jsx)(n.code,{children:"Promise"}),"<",(0,r.jsx)(n.code,{children:"R"}),">"]}),"\n"]}),"\n",(0,r.jsxs)(n.p,{children:["Show progress in Podman Desktop. Progress is shown while running the given callback\nand while the promise it returned isn't resolved nor rejected. The location at which\nprogress should show (and other details) is defined via the passed ",(0,r.jsx)(n.a,{href:"/api/interfaces/ProgressOptions",children:(0,r.jsx)(n.code,{children:"ProgressOptions"})}),"."]}),"\n",(0,r.jsx)(n.h2,{id:"type-parameters",children:"Type Parameters"}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"R"})]}),"\n",(0,r.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"options"}),": ",(0,r.jsx)(n.a,{href:"/api/interfaces/ProgressOptions",children:(0,r.jsx)(n.code,{children:"ProgressOptions"})})]}),"\n",(0,r.jsx)(n.p,{children:"the options for the task's details"}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"task"})]}),"\n",(0,r.jsxs)(n.p,{children:["A callback returning a promise. Progress state can be reported with\nthe provided ",(0,r.jsx)(n.a,{href:"/api/interfaces/Progress",children:"Progress"}),"-object."]}),"\n",(0,r.jsxs)(n.p,{children:["To report discrete progress, use ",(0,r.jsx)(n.code,{children:"increment"})," to indicate how much work has been completed. Each call with\na ",(0,r.jsx)(n.code,{children:"increment"})," value will be summed up and reflected as overall progress until 100% is reached (a value of\ne.g. ",(0,r.jsx)(n.code,{children:"10"})," accounts for ",(0,r.jsx)(n.code,{children:"10%"})," of work done).\nNote that currently only ",(0,r.jsx)(n.code,{children:"ProgressLocation.Notification"})," is capable of showing discrete progress."]}),"\n",(0,r.jsxs)(n.p,{children:["To monitor if the operation has been cancelled by the user, use the provided ",(0,r.jsx)(n.a,{href:"/api/interfaces/CancellationToken",children:(0,r.jsx)(n.code,{children:"CancellationToken"})}),".\nNote that currently only ",(0,r.jsx)(n.code,{children:"ProgressLocation.Notification"})," is supporting to show a cancel button to cancel the\nlong-running operation."]}),"\n",(0,r.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"Promise"}),"<",(0,r.jsx)(n.code,{children:"R"}),">"]}),"\n",(0,r.jsx)(n.p,{children:"The promise the task-callback returned."}),"\n",(0,r.jsx)(n.h2,{id:"examples",children:"Examples"}),"\n",(0,r.jsx)(n.p,{children:"Here is a simple example"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:"await window.withProgress({ location: ProgressLocation.TASK_WIDGET, title: `Running task` },\n async progress => {\n progress.report({message: 'task1' });\n await task1();\n progress.report({increment: 50, message: 'task2' });\n await task2();\n },\n);\n"})}),"\n",(0,r.jsx)(n.p,{children:"The error is propagated if thrown inside the task callback."}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:"try {\n await window.withProgress(\n { location: ProgressLocation.TASK_WIDGET, title: `Running task` },\n async progress => {\n throw new Error('error when running a task');\n },\n );\n } catch (error) {\n // do something with the error\n }\n"})}),"\n",(0,r.jsx)(n.p,{children:"You can return a value from the task callback"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:"const result: number = await window.withProgress(\n { location: ProgressLocation.TASK_WIDGET, title: `Running task` },\n async progress => {\n // compute something\n return 55;\n },\n);\n"})}),"\n",(0,r.jsx)(n.h2,{id:"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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L1953",children:"packages/extension-api/src/extension-api.d.ts:1953"})})]})}function h(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(l,{...e})}):l(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>a,a:()=>o});var r=s(27378);const t={},i=r.createContext(t);function o(e){const n=r.useContext(i);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function a(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:o(e.components),r.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/0102eb3e.b5af5f79.js b/assets/js/0102eb3e.0bf3b48b.js similarity index 76% rename from assets/js/0102eb3e.b5af5f79.js rename to assets/js/0102eb3e.0bf3b48b.js index 2d601a8a721..3e6d87ae008 100644 --- a/assets/js/0102eb3e.b5af5f79.js +++ b/assets/js/0102eb3e.0bf3b48b.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[75542],{66777:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>d,contentTitle:()=>o,default:()=>p,frontMatter:()=>r,metadata:()=>c,toc:()=>a});var t=i(24246),s=i(71670);const r={},o="Interface: WebviewInfo",c={id:"interfaces/WebviewInfo",title:"Interface: WebviewInfo",description:"Properties",source:"@site/api/interfaces/WebviewInfo.md",sourceDirName:"interfaces",slug:"/interfaces/WebviewInfo",permalink:"/api/interfaces/WebviewInfo",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Webview",permalink:"/api/interfaces/Webview"},next:{title:"WebviewOptions",permalink:"/api/interfaces/WebviewOptions"}},d={},a=[{value:"Properties",id:"properties",level:2},{value:"id",id:"id",level:3},{value:"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",hr:"hr",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"interface-webviewinfo",children:"Interface: WebviewInfo"}),"\n",(0,t.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,t.jsx)(n.h3,{id:"id",children:"id"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"id"}),": ",(0,t.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L3038",children:"packages/extension-api/src/extension-api.d.ts:3038"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L3040",children:"packages/extension-api/src/extension-api.d.ts:3040"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L3039",children:"packages/extension-api/src/extension-api.d.ts:3039"})})]})}function p(e={}){const{wrapper:n}={...(0,s.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>c,a:()=>o});var t=i(27378);const s={},r=t.createContext(s);function o(e){const n=t.useContext(r);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:o(e.components),t.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[75542],{66777:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>o,contentTitle:()=>d,default:()=>p,frontMatter:()=>r,metadata:()=>c,toc:()=>a});var t=i(24246),s=i(71670);const r={},d="Interface: WebviewInfo",c={id:"interfaces/WebviewInfo",title:"Interface: WebviewInfo",description:"Properties",source:"@site/api/interfaces/WebviewInfo.md",sourceDirName:"interfaces",slug:"/interfaces/WebviewInfo",permalink:"/api/interfaces/WebviewInfo",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Webview",permalink:"/api/interfaces/Webview"},next:{title:"WebviewOptions",permalink:"/api/interfaces/WebviewOptions"}},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",hr:"hr",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"interface-webviewinfo",children:"Interface: WebviewInfo"}),"\n",(0,t.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,t.jsx)(n.h3,{id:"id",children:"id"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"id"}),": ",(0,t.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L3038",children:"packages/extension-api/src/extension-api.d.ts:3038"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L3040",children:"packages/extension-api/src/extension-api.d.ts:3040"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L3039",children:"packages/extension-api/src/extension-api.d.ts:3039"})})]})}function p(e={}){const{wrapper:n}={...(0,s.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>c,a:()=>d});var t=i(27378);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 c(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/01821883.0210e27f.js b/assets/js/01821883.76008ed5.js similarity index 90% rename from assets/js/01821883.0210e27f.js rename to assets/js/01821883.76008ed5.js index a13524437ff..befbedb2c9d 100644 --- a/assets/js/01821883.0210e27f.js +++ b/assets/js/01821883.76008ed5.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[77683],{95061:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>o,contentTitle:()=>c,default:()=>p,frontMatter:()=>d,metadata:()=>r,toc:()=>a});var s=i(24246),t=i(71670);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",hr:"hr",p:"p",strong:"strong",...(0,t.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"interface-devicerequest",children:"Interface: DeviceRequest"}),"\n",(0,s.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,s.jsx)(n.h3,{id:"capabilities",children:"Capabilities?"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"optional"})," ",(0,s.jsx)(n.strong,{children:"Capabilities"}),": ",(0,s.jsx)(n.code,{children:"string"}),"[][]"]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L2405",children:"packages/extension-api/src/extension-api.d.ts:2405"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L2403",children:"packages/extension-api/src/extension-api.d.ts:2403"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L2404",children:"packages/extension-api/src/extension-api.d.ts:2404"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/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:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L2406",children:"packages/extension-api/src/extension-api.d.ts:2406"})})]})}function p(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>r,a:()=>c});var s=i(27378);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([[77683],{95061:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>o,contentTitle:()=>c,default:()=>p,frontMatter:()=>d,metadata:()=>r,toc:()=>a});var s=i(24246),t=i(71670);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",hr:"hr",p:"p",strong:"strong",...(0,t.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"interface-devicerequest",children:"Interface: DeviceRequest"}),"\n",(0,s.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,s.jsx)(n.h3,{id:"capabilities",children:"Capabilities?"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"optional"})," ",(0,s.jsx)(n.strong,{children:"Capabilities"}),": ",(0,s.jsx)(n.code,{children:"string"}),"[][]"]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2405",children:"packages/extension-api/src/extension-api.d.ts:2405"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2403",children:"packages/extension-api/src/extension-api.d.ts:2403"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2404",children:"packages/extension-api/src/extension-api.d.ts:2404"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"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/bd83a8b2bb8ab886dc757381b589638cbda150d0/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:"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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2406",children:"packages/extension-api/src/extension-api.d.ts:2406"})})]})}function p(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>r,a:()=>c});var s=i(27378);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 diff --git a/assets/js/01a1d0f4.a26fe0ce.js b/assets/js/01a1d0f4.60628720.js similarity index 96% rename from assets/js/01a1d0f4.a26fe0ce.js rename to assets/js/01a1d0f4.60628720.js index 2bcf45c2069..2c83a943f20 100644 --- a/assets/js/01a1d0f4.a26fe0ce.js +++ b/assets/js/01a1d0f4.60628720.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[13826],{96261:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>a,contentTitle:()=>o,default:()=>p,frontMatter:()=>r,metadata:()=>c,toc:()=>d});var s=i(24246),t=i(71670);const r={},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",p:"p",strong:"strong",...(0,t.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L814",children:"packages/extension-api/src/extension-api.d.ts:814"})})]})}function p(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>c,a:()=>o});var s=i(27378);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([[13826],{96261:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>a,contentTitle:()=>o,default:()=>p,frontMatter:()=>r,metadata:()=>c,toc:()=>d});var s=i(24246),t=i(71670);const r={},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",p:"p",strong:"strong",...(0,t.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L814",children:"packages/extension-api/src/extension-api.d.ts:814"})})]})}function p(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>c,a:()=>o});var s=i(27378);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/030ccfd9.c1cc37b5.js b/assets/js/030ccfd9.c3ffcb97.js similarity index 94% rename from assets/js/030ccfd9.c1cc37b5.js rename to assets/js/030ccfd9.c3ffcb97.js index 515a2e21f3b..bca0b8b33ac 100644 --- a/assets/js/030ccfd9.c1cc37b5.js +++ b/assets/js/030ccfd9.c3ffcb97.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[67690],{38650:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>o,default:()=>p,frontMatter:()=>c,metadata:()=>r,toc:()=>u});var s=t(24246),i=t(71670);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",p:"p",strong:"strong",...(0,i.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"function-getkubeconfig",children:"Function: getKubeconfig()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"getKubeconfig"}),"(): ",(0,s.jsx)(n.a,{href:"/api/classes/Uri",children:(0,s.jsx)(n.code,{children:"Uri"})})]}),"\n"]}),"\n",(0,s.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"/api/classes/Uri",children:(0,s.jsx)(n.code,{children:"Uri"})})}),"\n",(0,s.jsx)(n.h2,{id:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L2082",children:"packages/extension-api/src/extension-api.d.ts:2082"})})]})}function p(e={}){const{wrapper:n}={...(0,i.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(d,{...e})}):d(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>r,a:()=>o});var s=t(27378);const i={},c=s.createContext(i);function o(e){const n=s.useContext(c);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function 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([[67690],{38650:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>o,default:()=>p,frontMatter:()=>c,metadata:()=>r,toc:()=>u});var s=t(24246),i=t(71670);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",p:"p",strong:"strong",...(0,i.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"function-getkubeconfig",children:"Function: getKubeconfig()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"getKubeconfig"}),"(): ",(0,s.jsx)(n.a,{href:"/api/classes/Uri",children:(0,s.jsx)(n.code,{children:"Uri"})})]}),"\n"]}),"\n",(0,s.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"/api/classes/Uri",children:(0,s.jsx)(n.code,{children:"Uri"})})}),"\n",(0,s.jsx)(n.h2,{id:"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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2082",children:"packages/extension-api/src/extension-api.d.ts:2082"})})]})}function p(e={}){const{wrapper:n}={...(0,i.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(d,{...e})}):d(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>r,a:()=>o});var s=t(27378);const i={},c=s.createContext(i);function o(e){const n=s.useContext(c);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function 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.2ce4b473.js b/assets/js/04a546a4.987ca97b.js similarity index 86% rename from assets/js/04a546a4.2ce4b473.js rename to assets/js/04a546a4.987ca97b.js index d9019abe4f3..4ff1551e823 100644 --- a/assets/js/04a546a4.2ce4b473.js +++ b/assets/js/04a546a4.987ca97b.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[17329],{44419:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>c,contentTitle:()=>d,default:()=>h,frontMatter:()=>s,metadata:()=>o,toc:()=>a});var i=t(24246),r=t(71670);const s={},d="Interface: Clipboard",o={id:"interfaces/Clipboard",title:"Interface: Clipboard",description:"The clipboard provides read and write access to the system's clipboard.",source:"@site/api/interfaces/Clipboard.md",sourceDirName:"interfaces",slug:"/interfaces/Clipboard",permalink:"/api/interfaces/Clipboard",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"CliToolUpdateOptions",permalink:"/api/interfaces/CliToolUpdateOptions"},next:{title:"Command",permalink:"/api/interfaces/Command"}},c={},a=[{value:"Methods",id:"methods",level:2},{value:"readText()",id:"readtext",level:3},{value:"Returns",id:"returns",level:4},{value:"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",hr:"hr",p:"p",strong:"strong",...(0,r.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"interface-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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L4254",children:"packages/extension-api/src/extension-api.d.ts:4254"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/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.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>o,a:()=>d});var i=t(27378);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 o(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([[17329],{44419:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>o,contentTitle:()=>d,default:()=>h,frontMatter:()=>s,metadata:()=>c,toc:()=>a});var i=t(24246),r=t(71670);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"}},o={},a=[{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",hr:"hr",p:"p",strong:"strong",...(0,r.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"interface-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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L4254",children:"packages/extension-api/src/extension-api.d.ts:4254"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/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.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>c,a:()=>d});var i=t(27378);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 diff --git a/assets/js/0547cb65.6c434be8.js b/assets/js/0547cb65.9e9cb6f5.js similarity index 79% rename from assets/js/0547cb65.6c434be8.js rename to assets/js/0547cb65.9e9cb6f5.js index 573e7916df6..4bed9fce2d3 100644 --- a/assets/js/0547cb65.6c434be8.js +++ b/assets/js/0547cb65.9e9cb6f5.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[30060],{6204:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>o,contentTitle:()=>s,default:()=>u,frontMatter:()=>a,metadata:()=>c,toc:()=>d});var t=i(24246),r=i(71670);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",hr:"hr",p:"p",strong:"strong",...(0,r.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"enumeration-quickpickitemkind",children:"Enumeration: QuickPickItemKind"}),"\n",(0,t.jsxs)(n.p,{children:["The kind of ",(0,t.jsx)(n.a,{href:"/api/interfaces/QuickPickItem",children:"quick pick item"}),"."]}),"\n",(0,t.jsx)(n.h2,{id:"enumeration-members",children:"Enumeration Members"}),"\n",(0,t.jsx)(n.h3,{id:"default",children:"Default"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"Default"}),": ",(0,t.jsx)(n.code,{children:"0"})]}),"\n"]}),"\n",(0,t.jsxs)(n.p,{children:["The default ",(0,t.jsx)(n.a,{href:"/api/interfaces/QuickPickItem#kind",children:"QuickPickItem.kind"})," is an item that can be selected in the quick pick."]}),"\n",(0,t.jsx)(n.h4,{id:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L1197",children:"packages/extension-api/src/extension-api.d.ts:1197"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L1193",children:"packages/extension-api/src/extension-api.d.ts:1193"})})]})}function u(e={}){const{wrapper:n}={...(0,r.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>c,a:()=>s});var t=i(27378);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([[30060],{6204:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>o,contentTitle:()=>c,default:()=>u,frontMatter:()=>r,metadata:()=>s,toc:()=>d});var t=i(24246),a=i(71670);const r={},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",hr:"hr",p:"p",strong:"strong",...(0,a.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"enumeration-quickpickitemkind",children:"Enumeration: QuickPickItemKind"}),"\n",(0,t.jsxs)(n.p,{children:["The kind of ",(0,t.jsx)(n.a,{href:"/api/interfaces/QuickPickItem",children:"quick pick item"}),"."]}),"\n",(0,t.jsx)(n.h2,{id:"enumeration-members",children:"Enumeration Members"}),"\n",(0,t.jsx)(n.h3,{id:"default",children:"Default"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"Default"}),": ",(0,t.jsx)(n.code,{children:"0"})]}),"\n"]}),"\n",(0,t.jsxs)(n.p,{children:["The default ",(0,t.jsx)(n.a,{href:"/api/interfaces/QuickPickItem#kind",children:"QuickPickItem.kind"})," is an item that can be selected in the quick pick."]}),"\n",(0,t.jsx)(n.h4,{id:"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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L1197",children:"packages/extension-api/src/extension-api.d.ts:1197"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L1193",children:"packages/extension-api/src/extension-api.d.ts:1193"})})]})}function u(e={}){const{wrapper:n}={...(0,a.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>s,a:()=>c});var t=i(27378);const a={},r=t.createContext(a);function c(e){const n=t.useContext(r);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function s(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(a):e.components||a:c(e.components),t.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/065365b3.c07f48b2.js b/assets/js/065365b3.3b2b3c69.js similarity index 97% rename from assets/js/065365b3.c07f48b2.js rename to assets/js/065365b3.3b2b3c69.js index e9c0a4aadfb..2ac0b697146 100644 --- a/assets/js/065365b3.c07f48b2.js +++ b/assets/js/065365b3.3b2b3c69.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[43871],{90952:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>o,contentTitle:()=>r,default:()=>l,frontMatter:()=>i,metadata:()=>a,toc:()=>d});var c=t(24246),s=t(71670);const i={},r="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",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,c.jsxs)(c.Fragment,{children:[(0,c.jsx)(n.h1,{id:"interface-imagechecks",children:"Interface: ImageChecks"}),"\n",(0,c.jsx)(n.p,{children:"the complete result of an image check"}),"\n",(0,c.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,c.jsx)(n.h3,{id:"checks",children:"checks"}),"\n",(0,c.jsxs)(n.blockquote,{children:["\n",(0,c.jsxs)(n.p,{children:[(0,c.jsx)(n.strong,{children:"checks"}),": ",(0,c.jsx)(n.a,{href:"/api/interfaces/ImageCheck",children:(0,c.jsx)(n.code,{children:"ImageCheck"})}),"[]"]}),"\n"]}),"\n",(0,c.jsx)(n.p,{children:"the list of errors/recommendations found during the image check"}),"\n",(0,c.jsx)(n.h4,{id:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L4382",children:"packages/extension-api/src/extension-api.d.ts:4382"})})]})}function l(e={}){const{wrapper:n}={...(0,s.a)(),...e.components};return n?(0,c.jsx)(n,{...e,children:(0,c.jsx)(h,{...e})}):h(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>a,a:()=>r});var c=t(27378);const s={},i=c.createContext(s);function r(e){const n=c.useContext(i);return c.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function a(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:r(e.components),c.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[43871],{90952:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>o,contentTitle:()=>r,default:()=>l,frontMatter:()=>i,metadata:()=>a,toc:()=>d});var c=t(24246),s=t(71670);const i={},r="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",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,c.jsxs)(c.Fragment,{children:[(0,c.jsx)(n.h1,{id:"interface-imagechecks",children:"Interface: ImageChecks"}),"\n",(0,c.jsx)(n.p,{children:"the complete result of an image check"}),"\n",(0,c.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,c.jsx)(n.h3,{id:"checks",children:"checks"}),"\n",(0,c.jsxs)(n.blockquote,{children:["\n",(0,c.jsxs)(n.p,{children:[(0,c.jsx)(n.strong,{children:"checks"}),": ",(0,c.jsx)(n.a,{href:"/api/interfaces/ImageCheck",children:(0,c.jsx)(n.code,{children:"ImageCheck"})}),"[]"]}),"\n"]}),"\n",(0,c.jsx)(n.p,{children:"the list of errors/recommendations found during the image check"}),"\n",(0,c.jsx)(n.h4,{id:"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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L4382",children:"packages/extension-api/src/extension-api.d.ts:4382"})})]})}function l(e={}){const{wrapper:n}={...(0,s.a)(),...e.components};return n?(0,c.jsx)(n,{...e,children:(0,c.jsx)(h,{...e})}):h(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>a,a:()=>r});var c=t(27378);const s={},i=c.createContext(s);function r(e){const n=c.useContext(i);return c.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function a(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:r(e.components),c.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/06a27da2.b794f176.js b/assets/js/06a27da2.b794f176.js new file mode 100644 index 00000000000..8f1bd9f0c36 --- /dev/null +++ b/assets/js/06a27da2.b794f176.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[14824],{1590:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>c,contentTitle:()=>t,default:()=>h,frontMatter:()=>a,metadata:()=>r,toc:()=>o});var d=i(24246),s=i(71670);const a={},t="Interface: PodInfo",r={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",hr:"hr",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,d.jsxs)(d.Fragment,{children:[(0,d.jsx)(n.h1,{id:"interface-podinfo",children:"Interface: PodInfo"}),"\n",(0,d.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,d.jsx)(n.h3,{id:"cgroup",children:"Cgroup"}),"\n",(0,d.jsxs)(n.blockquote,{children:["\n",(0,d.jsxs)(n.p,{children:[(0,d.jsx)(n.strong,{children:"Cgroup"}),": ",(0,d.jsx)(n.code,{children:"string"})]}),"\n"]}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2329",children:"packages/extension-api/src/extension-api.d.ts:2329"})}),"\n",(0,d.jsx)(n.hr,{}),"\n",(0,d.jsx)(n.h3,{id:"containers",children:"Containers"}),"\n",(0,d.jsxs)(n.blockquote,{children:["\n",(0,d.jsxs)(n.p,{children:[(0,d.jsx)(n.strong,{children:"Containers"}),": ",(0,d.jsx)(n.a,{href:"/api/interfaces/PodContainerInfo",children:(0,d.jsx)(n.code,{children:"PodContainerInfo"})}),"[]"]}),"\n"]}),"\n",(0,d.jsx)(n.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,d.jsx)(n.p,{children:(0,d.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2330",children:"packages/extension-api/src/extension-api.d.ts:2330"})}),"\n",(0,d.jsx)(n.hr,{}),"\n",(0,d.jsx)(n.h3,{id:"created",children:"Created"}),"\n",(0,d.jsxs)(n.blockquote,{children:["\n",(0,d.jsxs)(n.p,{children:[(0,d.jsx)(n.strong,{children:"Created"}),": ",(0,d.jsx)(n.code,{children:"string"})]}),"\n"]}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2331",children:"packages/extension-api/src/extension-api.d.ts:2331"})}),"\n",(0,d.jsx)(n.hr,{}),"\n",(0,d.jsx)(n.h3,{id:"id",children:"Id"}),"\n",(0,d.jsxs)(n.blockquote,{children:["\n",(0,d.jsxs)(n.p,{children:[(0,d.jsx)(n.strong,{children:"Id"}),": ",(0,d.jsx)(n.code,{children:"string"})]}),"\n"]}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2332",children:"packages/extension-api/src/extension-api.d.ts:2332"})}),"\n",(0,d.jsx)(n.hr,{}),"\n",(0,d.jsx)(n.h3,{id:"infraid",children:"InfraId"}),"\n",(0,d.jsxs)(n.blockquote,{children:["\n",(0,d.jsxs)(n.p,{children:[(0,d.jsx)(n.strong,{children:"InfraId"}),": ",(0,d.jsx)(n.code,{children:"string"})]}),"\n"]}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2333",children:"packages/extension-api/src/extension-api.d.ts:2333"})}),"\n",(0,d.jsx)(n.hr,{}),"\n",(0,d.jsx)(n.h3,{id:"labels",children:"Labels"}),"\n",(0,d.jsxs)(n.blockquote,{children:["\n",(0,d.jsxs)(n.p,{children:[(0,d.jsx)(n.strong,{children:"Labels"}),": ",(0,d.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,d.jsx)(n.h4,{id:"index-signature",children:"Index Signature"}),"\n",(0,d.jsxs)(n.p,{children:["[",(0,d.jsx)(n.code,{children:"key"}),": ",(0,d.jsx)(n.code,{children:"string"}),"]: ",(0,d.jsx)(n.code,{children:"string"})]}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2334",children:"packages/extension-api/src/extension-api.d.ts:2334"})}),"\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:"defined-in-6",children:"Defined in"}),"\n",(0,d.jsx)(n.p,{children:(0,d.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2335",children:"packages/extension-api/src/extension-api.d.ts:2335"})}),"\n",(0,d.jsx)(n.hr,{}),"\n",(0,d.jsx)(n.h3,{id:"namespace",children:"Namespace"}),"\n",(0,d.jsxs)(n.blockquote,{children:["\n",(0,d.jsxs)(n.p,{children:[(0,d.jsx)(n.strong,{children:"Namespace"}),": ",(0,d.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,d.jsx)(n.h4,{id:"defined-in-7",children:"Defined in"}),"\n",(0,d.jsx)(n.p,{children:(0,d.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2336",children:"packages/extension-api/src/extension-api.d.ts:2336"})}),"\n",(0,d.jsx)(n.hr,{}),"\n",(0,d.jsx)(n.h3,{id:"networks",children:"Networks"}),"\n",(0,d.jsxs)(n.blockquote,{children:["\n",(0,d.jsxs)(n.p,{children:[(0,d.jsx)(n.strong,{children:"Networks"}),": ",(0,d.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2337",children:"packages/extension-api/src/extension-api.d.ts:2337"})}),"\n",(0,d.jsx)(n.hr,{}),"\n",(0,d.jsx)(n.h3,{id:"status",children:"Status"}),"\n",(0,d.jsxs)(n.blockquote,{children:["\n",(0,d.jsxs)(n.p,{children:[(0,d.jsx)(n.strong,{children:"Status"}),": ",(0,d.jsx)(n.code,{children:"string"})]}),"\n"]}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2338",children:"packages/extension-api/src/extension-api.d.ts:2338"})}),"\n",(0,d.jsx)(n.hr,{}),"\n",(0,d.jsx)(n.h3,{id:"engineid",children:"engineId"}),"\n",(0,d.jsxs)(n.blockquote,{children:["\n",(0,d.jsxs)(n.p,{children:[(0,d.jsx)(n.strong,{children:"engineId"}),": ",(0,d.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,d.jsx)(n.h4,{id:"defined-in-10",children:"Defined in"}),"\n",(0,d.jsx)(n.p,{children:(0,d.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2326",children:"packages/extension-api/src/extension-api.d.ts:2326"})}),"\n",(0,d.jsx)(n.hr,{}),"\n",(0,d.jsx)(n.h3,{id:"enginename",children:"engineName"}),"\n",(0,d.jsxs)(n.blockquote,{children:["\n",(0,d.jsxs)(n.p,{children:[(0,d.jsx)(n.strong,{children:"engineName"}),": ",(0,d.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,d.jsx)(n.h4,{id:"defined-in-11",children:"Defined in"}),"\n",(0,d.jsx)(n.p,{children:(0,d.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2327",children:"packages/extension-api/src/extension-api.d.ts:2327"})}),"\n",(0,d.jsx)(n.hr,{}),"\n",(0,d.jsx)(n.h3,{id:"kind",children:"kind"}),"\n",(0,d.jsxs)(n.blockquote,{children:["\n",(0,d.jsxs)(n.p,{children:[(0,d.jsx)(n.strong,{children:"kind"}),": ",(0,d.jsx)(n.code,{children:'"podman"'})," | ",(0,d.jsx)(n.code,{children:'"kubernetes"'})]}),"\n"]}),"\n",(0,d.jsx)(n.h4,{id:"defined-in-12",children:"Defined in"}),"\n",(0,d.jsx)(n.p,{children:(0,d.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/bd83a8b2bb8ab886dc757381b589638cbda150d0/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,s.a)(),...e.components};return n?(0,d.jsx)(n,{...e,children:(0,d.jsx)(l,{...e})}):l(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>r,a:()=>t});var d=i(27378);const s={},a=d.createContext(s);function t(e){const n=d.useContext(a);return d.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:t(e.components),d.createElement(a.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/06a27da2.c261393e.js b/assets/js/06a27da2.c261393e.js deleted file mode 100644 index 8528d2a9dd1..00000000000 --- a/assets/js/06a27da2.c261393e.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[14824],{1590:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>c,contentTitle:()=>r,default:()=>h,frontMatter:()=>t,metadata:()=>a,toc:()=>o});var s=i(24246),d=i(71670);const t={},r="Interface: PodInfo",a={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",hr:"hr",p:"p",strong:"strong",...(0,d.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{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/804b2198fda0957e1ecfb87539f019eb9b79a66f/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:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/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:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/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:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/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:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/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:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/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:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/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:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/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:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L2337",children:"packages/extension-api/src/extension-api.d.ts:2337"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L2338",children:"packages/extension-api/src/extension-api.d.ts:2338"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/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:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/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:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/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.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>a,a:()=>r});var s=i(27378);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 diff --git a/assets/js/080a9824.c8940fb9.js b/assets/js/080a9824.e99fc1a7.js similarity index 86% rename from assets/js/080a9824.c8940fb9.js rename to assets/js/080a9824.e99fc1a7.js index 50a34a5d526..d399420ea33 100644 --- a/assets/js/080a9824.c8940fb9.js +++ b/assets/js/080a9824.e99fc1a7.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[44958],{76055:(e,i,n)=>{n.r(i),n.d(i,{assets:()=>c,contentTitle:()=>d,default:()=>h,frontMatter:()=>a,metadata:()=>r,toc:()=>o});var s=n(24246),t=n(71670);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",hr:"hr",p:"p",strong:"strong",...(0,t.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(i.h1,{id:"interface-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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L741",children:"packages/extension-api/src/extension-api.d.ts:741"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L745",children:"packages/extension-api/src/extension-api.d.ts:745"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L737",children:"packages/extension-api/src/extension-api.d.ts:737"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L753",children:"packages/extension-api/src/extension-api.d.ts:753"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L749",children:"packages/extension-api/src/extension-api.d.ts:749"})})]})}function h(e={}){const{wrapper:i}={...(0,t.a)(),...e.components};return i?(0,s.jsx)(i,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},71670:(e,i,n)=>{n.d(i,{Z:()=>r,a:()=>d});var s=n(27378);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([[44958],{76055:(e,i,n)=>{n.r(i),n.d(i,{assets:()=>c,contentTitle:()=>a,default:()=>h,frontMatter:()=>d,metadata:()=>r,toc:()=>o});var s=n(24246),t=n(71670);const d={},a="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",hr:"hr",p:"p",strong:"strong",...(0,t.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(i.h1,{id:"interface-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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L741",children:"packages/extension-api/src/extension-api.d.ts:741"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L745",children:"packages/extension-api/src/extension-api.d.ts:745"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L737",children:"packages/extension-api/src/extension-api.d.ts:737"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L753",children:"packages/extension-api/src/extension-api.d.ts:753"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L749",children:"packages/extension-api/src/extension-api.d.ts:749"})})]})}function h(e={}){const{wrapper:i}={...(0,t.a)(),...e.components};return i?(0,s.jsx)(i,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},71670:(e,i,n)=>{n.d(i,{Z:()=>r,a:()=>a});var s=n(27378);const t={},d=s.createContext(t);function a(e){const i=s.useContext(d);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:a(e.components),s.createElement(d.Provider,{value:i},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/0877aebd.52d3e01b.js b/assets/js/0877aebd.82b4b323.js similarity index 94% rename from assets/js/0877aebd.52d3e01b.js rename to assets/js/0877aebd.82b4b323.js index 8fcdb122f6f..74c9270e88d 100644 --- a/assets/js/0877aebd.52d3e01b.js +++ b/assets/js/0877aebd.82b4b323.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[87213],{27062:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>a,contentTitle:()=>r,default:()=>p,frontMatter:()=>s,metadata:()=>c,toc:()=>d});var t=i(24246),o=i(71670);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",hr:"hr",p:"p",strong:"strong",...(0,o.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"interface-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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L3806",children:"packages/extension-api/src/extension-api.d.ts:3806"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L3804",children:"packages/extension-api/src/extension-api.d.ts:3804"})})]})}function p(e={}){const{wrapper:n}={...(0,o.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>c,a:()=>r});var t=i(27378);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([[87213],{27062:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>a,contentTitle:()=>r,default:()=>p,frontMatter:()=>s,metadata:()=>c,toc:()=>d});var t=i(24246),o=i(71670);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",hr:"hr",p:"p",strong:"strong",...(0,o.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"interface-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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L3806",children:"packages/extension-api/src/extension-api.d.ts:3806"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L3804",children:"packages/extension-api/src/extension-api.d.ts:3804"})})]})}function p(e={}){const{wrapper:n}={...(0,o.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>c,a:()=>r});var t=i(27378);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.70cb17e9.js b/assets/js/0c14b239.eacdab45.js similarity index 96% rename from assets/js/0c14b239.70cb17e9.js rename to assets/js/0c14b239.eacdab45.js index 566ea31452f..41d7b171e59 100644 --- a/assets/js/0c14b239.70cb17e9.js +++ b/assets/js/0c14b239.eacdab45.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[34479],{55264:(n,e,i)=>{i.r(e),i.d(e,{assets:()=>c,contentTitle:()=>a,default:()=>h,frontMatter:()=>t,metadata:()=>r,toc:()=>d});var s=i(24246),o=i(71670);const t={},a="Function: onDidChangeConfiguration()",r={id:"namespaces/configuration/functions/onDidChangeConfiguration",title:"Function: onDidChangeConfiguration()",description:"onDidChangeConfiguration(listener, thisArgs?, disposables?): Disposable",source:"@site/api/namespaces/configuration/functions/onDidChangeConfiguration.md",sourceDirName:"namespaces/configuration/functions",slug:"/namespaces/configuration/functions/onDidChangeConfiguration",permalink:"/api/namespaces/configuration/functions/onDidChangeConfiguration",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"getConfiguration",permalink:"/api/namespaces/configuration/functions/getConfiguration"},next:{title:"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(n){const e={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,o.a)(),...n.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(e.h1,{id:"function-ondidchangeconfiguration",children:"Function: onDidChangeConfiguration()"}),"\n",(0,s.jsxs)(e.blockquote,{children:["\n",(0,s.jsxs)(e.p,{children:[(0,s.jsx)(e.strong,{children:"onDidChangeConfiguration"}),"(",(0,s.jsx)(e.code,{children:"listener"}),", ",(0,s.jsx)(e.code,{children:"thisArgs"}),"?, ",(0,s.jsx)(e.code,{children:"disposables"}),"?): ",(0,s.jsx)(e.a,{href:"/api/classes/Disposable",children:(0,s.jsx)(e.code,{children:"Disposable"})})]}),"\n"]}),"\n",(0,s.jsx)(e.h2,{id:"parameters",children:"Parameters"}),"\n",(0,s.jsxs)(e.p,{children:["\u2022 ",(0,s.jsx)(e.strong,{children:"listener"})]}),"\n",(0,s.jsx)(e.p,{children:"The listener function will be called when the event happens."}),"\n",(0,s.jsxs)(e.p,{children:["\u2022 ",(0,s.jsx)(e.strong,{children:"thisArgs?"}),": ",(0,s.jsx)(e.code,{children:"any"})]}),"\n",(0,s.jsxs)(e.p,{children:["The ",(0,s.jsx)(e.code,{children:"this"}),"-argument which will be used when calling the event listener."]}),"\n",(0,s.jsxs)(e.p,{children:["\u2022 ",(0,s.jsx)(e.strong,{children:"disposables?"}),": ",(0,s.jsx)(e.a,{href:"/api/classes/Disposable",children:(0,s.jsx)(e.code,{children:"Disposable"})}),"[]"]}),"\n",(0,s.jsxs)(e.p,{children:["An array to which a ",(0,s.jsx)(e.a,{href:"/api/classes/Disposable",children:"Disposable"})," will be added."]}),"\n",(0,s.jsx)(e.h2,{id:"returns",children:"Returns"}),"\n",(0,s.jsx)(e.p,{children:(0,s.jsx)(e.a,{href:"/api/classes/Disposable",children:(0,s.jsx)(e.code,{children:"Disposable"})})}),"\n",(0,s.jsx)(e.p,{children:"A disposable which unsubscribes the event listener."}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L936",children:"packages/extension-api/src/extension-api.d.ts:936"})})]})}function h(n={}){const{wrapper:e}={...(0,o.a)(),...n.components};return e?(0,s.jsx)(e,{...n,children:(0,s.jsx)(l,{...n})}):l(n)}},71670:(n,e,i)=>{i.d(e,{Z:()=>r,a:()=>a});var s=i(27378);const o={},t=s.createContext(o);function a(n){const e=s.useContext(t);return s.useMemo((function(){return"function"==typeof n?n(e):{...e,...n}}),[e,n])}function r(n){let e;return e=n.disableParentContext?"function"==typeof n.components?n.components(o):n.components||o:a(n.components),s.createElement(t.Provider,{value:e},n.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[34479],{55264:(n,e,i)=>{i.r(e),i.d(e,{assets:()=>c,contentTitle:()=>a,default:()=>h,frontMatter:()=>t,metadata:()=>r,toc:()=>d});var s=i(24246),o=i(71670);const t={},a="Function: onDidChangeConfiguration()",r={id:"namespaces/configuration/functions/onDidChangeConfiguration",title:"Function: onDidChangeConfiguration()",description:"onDidChangeConfiguration(listener, thisArgs?, disposables?): Disposable",source:"@site/api/namespaces/configuration/functions/onDidChangeConfiguration.md",sourceDirName:"namespaces/configuration/functions",slug:"/namespaces/configuration/functions/onDidChangeConfiguration",permalink:"/api/namespaces/configuration/functions/onDidChangeConfiguration",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"getConfiguration",permalink:"/api/namespaces/configuration/functions/getConfiguration"},next:{title:"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(n){const e={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,o.a)(),...n.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(e.h1,{id:"function-ondidchangeconfiguration",children:"Function: onDidChangeConfiguration()"}),"\n",(0,s.jsxs)(e.blockquote,{children:["\n",(0,s.jsxs)(e.p,{children:[(0,s.jsx)(e.strong,{children:"onDidChangeConfiguration"}),"(",(0,s.jsx)(e.code,{children:"listener"}),", ",(0,s.jsx)(e.code,{children:"thisArgs"}),"?, ",(0,s.jsx)(e.code,{children:"disposables"}),"?): ",(0,s.jsx)(e.a,{href:"/api/classes/Disposable",children:(0,s.jsx)(e.code,{children:"Disposable"})})]}),"\n"]}),"\n",(0,s.jsx)(e.h2,{id:"parameters",children:"Parameters"}),"\n",(0,s.jsxs)(e.p,{children:["\u2022 ",(0,s.jsx)(e.strong,{children:"listener"})]}),"\n",(0,s.jsx)(e.p,{children:"The listener function will be called when the event happens."}),"\n",(0,s.jsxs)(e.p,{children:["\u2022 ",(0,s.jsx)(e.strong,{children:"thisArgs?"}),": ",(0,s.jsx)(e.code,{children:"any"})]}),"\n",(0,s.jsxs)(e.p,{children:["The ",(0,s.jsx)(e.code,{children:"this"}),"-argument which will be used when calling the event listener."]}),"\n",(0,s.jsxs)(e.p,{children:["\u2022 ",(0,s.jsx)(e.strong,{children:"disposables?"}),": ",(0,s.jsx)(e.a,{href:"/api/classes/Disposable",children:(0,s.jsx)(e.code,{children:"Disposable"})}),"[]"]}),"\n",(0,s.jsxs)(e.p,{children:["An array to which a ",(0,s.jsx)(e.a,{href:"/api/classes/Disposable",children:"Disposable"})," will be added."]}),"\n",(0,s.jsx)(e.h2,{id:"returns",children:"Returns"}),"\n",(0,s.jsx)(e.p,{children:(0,s.jsx)(e.a,{href:"/api/classes/Disposable",children:(0,s.jsx)(e.code,{children:"Disposable"})})}),"\n",(0,s.jsx)(e.p,{children:"A disposable which unsubscribes the event listener."}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L936",children:"packages/extension-api/src/extension-api.d.ts:936"})})]})}function h(n={}){const{wrapper:e}={...(0,o.a)(),...n.components};return e?(0,s.jsx)(e,{...n,children:(0,s.jsx)(l,{...n})}):l(n)}},71670:(n,e,i)=>{i.d(e,{Z:()=>r,a:()=>a});var s=i(27378);const o={},t=s.createContext(o);function a(n){const e=s.useContext(t);return s.useMemo((function(){return"function"==typeof n?n(e):{...e,...n}}),[e,n])}function r(n){let e;return e=n.disableParentContext?"function"==typeof n.components?n.components(o):n.components||o:a(n.components),s.createElement(t.Provider,{value:e},n.children)}}}]); \ No newline at end of file diff --git a/assets/js/0c4fad6b.5ac2b7c1.js b/assets/js/0c4fad6b.ac419fba.js similarity index 95% rename from assets/js/0c4fad6b.5ac2b7c1.js rename to assets/js/0c4fad6b.ac419fba.js index bd54afb94f2..f8e3607b096 100644 --- a/assets/js/0c4fad6b.5ac2b7c1.js +++ b/assets/js/0c4fad6b.ac419fba.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[41976],{5862:(n,e,t)=>{t.r(e),t.d(e,{assets:()=>r,contentTitle:()=>s,default:()=>p,frontMatter:()=>o,metadata:()=>c,toc:()=>d});var i=t(24246),a=t(71670);const o={},s="Function: navigateToAuthentication()",c={id:"namespaces/navigation/functions/navigateToAuthentication",title:"Function: navigateToAuthentication()",description:"navigateToAuthentication(): Promise\\",source:"@site/api/namespaces/navigation/functions/navigateToAuthentication.md",sourceDirName:"namespaces/navigation/functions",slug:"/namespaces/navigation/functions/navigateToAuthentication",permalink:"/api/namespaces/navigation/functions/navigateToAuthentication",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"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",p:"p",strong:"strong",...(0,a.a)(),...n.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(e.h1,{id:"function-navigatetoauthentication",children:"Function: navigateToAuthentication()"}),"\n",(0,i.jsxs)(e.blockquote,{children:["\n",(0,i.jsxs)(e.p,{children:[(0,i.jsx)(e.strong,{children:"navigateToAuthentication"}),"(): ",(0,i.jsx)(e.code,{children:"Promise"}),"<",(0,i.jsx)(e.code,{children:"void"}),">"]}),"\n"]}),"\n",(0,i.jsx)(e.p,{children:"Navigate to Authentication settings page"}),"\n",(0,i.jsx)(e.h2,{id:"returns",children:"Returns"}),"\n",(0,i.jsxs)(e.p,{children:[(0,i.jsx)(e.code,{children:"Promise"}),"<",(0,i.jsx)(e.code,{children:"void"}),">"]}),"\n",(0,i.jsx)(e.h2,{id:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L4467",children:"packages/extension-api/src/extension-api.d.ts:4467"})})]})}function p(n={}){const{wrapper:e}={...(0,a.a)(),...n.components};return e?(0,i.jsx)(e,{...n,children:(0,i.jsx)(u,{...n})}):u(n)}},71670:(n,e,t)=>{t.d(e,{Z:()=>c,a:()=>s});var i=t(27378);const a={},o=i.createContext(a);function s(n){const e=i.useContext(o);return i.useMemo((function(){return"function"==typeof n?n(e):{...e,...n}}),[e,n])}function c(n){let e;return e=n.disableParentContext?"function"==typeof n.components?n.components(a):n.components||a:s(n.components),i.createElement(o.Provider,{value:e},n.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[41976],{5862:(n,e,t)=>{t.r(e),t.d(e,{assets:()=>r,contentTitle:()=>s,default:()=>p,frontMatter:()=>o,metadata:()=>c,toc:()=>d});var i=t(24246),a=t(71670);const o={},s="Function: navigateToAuthentication()",c={id:"namespaces/navigation/functions/navigateToAuthentication",title:"Function: navigateToAuthentication()",description:"navigateToAuthentication(): Promise\\",source:"@site/api/namespaces/navigation/functions/navigateToAuthentication.md",sourceDirName:"namespaces/navigation/functions",slug:"/namespaces/navigation/functions/navigateToAuthentication",permalink:"/api/namespaces/navigation/functions/navigateToAuthentication",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"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",p:"p",strong:"strong",...(0,a.a)(),...n.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(e.h1,{id:"function-navigatetoauthentication",children:"Function: navigateToAuthentication()"}),"\n",(0,i.jsxs)(e.blockquote,{children:["\n",(0,i.jsxs)(e.p,{children:[(0,i.jsx)(e.strong,{children:"navigateToAuthentication"}),"(): ",(0,i.jsx)(e.code,{children:"Promise"}),"<",(0,i.jsx)(e.code,{children:"void"}),">"]}),"\n"]}),"\n",(0,i.jsx)(e.p,{children:"Navigate to Authentication settings page"}),"\n",(0,i.jsx)(e.h2,{id:"returns",children:"Returns"}),"\n",(0,i.jsxs)(e.p,{children:[(0,i.jsx)(e.code,{children:"Promise"}),"<",(0,i.jsx)(e.code,{children:"void"}),">"]}),"\n",(0,i.jsx)(e.h2,{id:"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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L4467",children:"packages/extension-api/src/extension-api.d.ts:4467"})})]})}function p(n={}){const{wrapper:e}={...(0,a.a)(),...n.components};return e?(0,i.jsx)(e,{...n,children:(0,i.jsx)(u,{...n})}):u(n)}},71670:(n,e,t)=>{t.d(e,{Z:()=>c,a:()=>s});var i=t(27378);const a={},o=i.createContext(a);function s(n){const e=i.useContext(o);return i.useMemo((function(){return"function"==typeof n?n(e):{...e,...n}}),[e,n])}function c(n){let e;return e=n.disableParentContext?"function"==typeof n.components?n.components(a):n.components||a:s(n.components),i.createElement(o.Provider,{value:e},n.children)}}}]); \ No newline at end of file diff --git a/assets/js/0cab2b3a.524d4798.js b/assets/js/0cab2b3a.a7bf6278.js similarity index 92% rename from assets/js/0cab2b3a.524d4798.js rename to assets/js/0cab2b3a.a7bf6278.js index 3249595b398..d64b46a1019 100644 --- a/assets/js/0cab2b3a.524d4798.js +++ b/assets/js/0cab2b3a.a7bf6278.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[85714],{25710:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>a,contentTitle:()=>o,default:()=>l,frontMatter:()=>c,metadata:()=>i,toc:()=>d});var t=s(24246),r=s(71670);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"}},a={},d=[{value:"Type Parameters",id:"type-parameters",level:2},{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Throws",id:"throws",level:2},{value:"Throws",id:"throws-1",level:2},{value:"Defined in",id:"defined-in",level:2}];function m(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,r.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"function-executecommand",children:"Function: executeCommand()"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"executeCommand"}),"<",(0,t.jsx)(n.code,{children:"T"}),">(",(0,t.jsx)(n.code,{children:"command"}),", ...",(0,t.jsx)(n.code,{children:"rest"}),"): ",(0,t.jsx)(n.code,{children:"PromiseLike"}),"<",(0,t.jsx)(n.code,{children:"T"}),">"]}),"\n"]}),"\n",(0,t.jsxs)(n.p,{children:["Execute a command, previously registered with ",(0,t.jsx)(n.a,{href:"/api/namespaces/commands/functions/registerCommand",children:"commands.registerCommand"})]}),"\n",(0,t.jsx)(n.h2,{id:"type-parameters",children:"Type Parameters"}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"T"})," = ",(0,t.jsx)(n.code,{children:"unknown"})]}),"\n",(0,t.jsx)(n.p,{children:"the type of the value returned by the command"}),"\n",(0,t.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"command"}),": ",(0,t.jsx)(n.code,{children:"string"})]}),"\n",(0,t.jsx)(n.p,{children:"the name used for registering the command"}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ...",(0,t.jsx)(n.strong,{children:"rest"}),": ",(0,t.jsx)(n.code,{children:"any"}),"[]"]}),"\n",(0,t.jsx)(n.p,{children:"the parameters to pass to the command"}),"\n",(0,t.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"PromiseLike"}),"<",(0,t.jsx)(n.code,{children:"T"}),">"]}),"\n",(0,t.jsx)(n.p,{children:"the value returned by the command"}),"\n",(0,t.jsx)(n.h2,{id:"throws",children:"Throws"}),"\n",(0,t.jsx)(n.p,{children:"if the command is not registered"}),"\n",(0,t.jsx)(n.h2,{id:"throws-1",children:"Throws"}),"\n",(0,t.jsx)(n.p,{children:"if the command throws an exception"}),"\n",(0,t.jsx)(n.h2,{id:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L666",children:"packages/extension-api/src/extension-api.d.ts:666"})})]})}function l(e={}){const{wrapper:n}={...(0,r.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(m,{...e})}):m(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>i,a:()=>o});var t=s(27378);const r={},c=t.createContext(r);function o(e){const n=t.useContext(c);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function i(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:o(e.components),t.createElement(c.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[85714],{25710:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>d,contentTitle:()=>o,default:()=>l,frontMatter:()=>c,metadata:()=>i,toc:()=>a});var t=s(24246),r=s(71670);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",p:"p",strong:"strong",...(0,r.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"function-executecommand",children:"Function: executeCommand()"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"executeCommand"}),"<",(0,t.jsx)(n.code,{children:"T"}),">(",(0,t.jsx)(n.code,{children:"command"}),", ...",(0,t.jsx)(n.code,{children:"rest"}),"): ",(0,t.jsx)(n.code,{children:"PromiseLike"}),"<",(0,t.jsx)(n.code,{children:"T"}),">"]}),"\n"]}),"\n",(0,t.jsxs)(n.p,{children:["Execute a command, previously registered with ",(0,t.jsx)(n.a,{href:"/api/namespaces/commands/functions/registerCommand",children:"commands.registerCommand"})]}),"\n",(0,t.jsx)(n.h2,{id:"type-parameters",children:"Type Parameters"}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"T"})," = ",(0,t.jsx)(n.code,{children:"unknown"})]}),"\n",(0,t.jsx)(n.p,{children:"the type of the value returned by the command"}),"\n",(0,t.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"command"}),": ",(0,t.jsx)(n.code,{children:"string"})]}),"\n",(0,t.jsx)(n.p,{children:"the name used for registering the command"}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ...",(0,t.jsx)(n.strong,{children:"rest"}),": ",(0,t.jsx)(n.code,{children:"any"}),"[]"]}),"\n",(0,t.jsx)(n.p,{children:"the parameters to pass to the command"}),"\n",(0,t.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"PromiseLike"}),"<",(0,t.jsx)(n.code,{children:"T"}),">"]}),"\n",(0,t.jsx)(n.p,{children:"the value returned by the command"}),"\n",(0,t.jsx)(n.h2,{id:"throws",children:"Throws"}),"\n",(0,t.jsx)(n.p,{children:"if the command is not registered"}),"\n",(0,t.jsx)(n.h2,{id:"throws-1",children:"Throws"}),"\n",(0,t.jsx)(n.p,{children:"if the command throws an exception"}),"\n",(0,t.jsx)(n.h2,{id:"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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L666",children:"packages/extension-api/src/extension-api.d.ts:666"})})]})}function l(e={}){const{wrapper:n}={...(0,r.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(m,{...e})}):m(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>i,a:()=>o});var t=s(27378);const r={},c=t.createContext(r);function o(e){const n=t.useContext(c);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function i(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:o(e.components),t.createElement(c.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/0e3a398f.c9cb4b0e.js b/assets/js/0e3a398f.7fd010fe.js similarity index 94% rename from assets/js/0e3a398f.c9cb4b0e.js rename to assets/js/0e3a398f.7fd010fe.js index 75ce0c2b957..8f3bcc239f6 100644 --- a/assets/js/0e3a398f.c9cb4b0e.js +++ b/assets/js/0e3a398f.7fd010fe.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[30466],{80171:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>d,contentTitle:()=>s,default:()=>u,frontMatter:()=>o,metadata:()=>c,toc:()=>a});var r=t(24246),i=t(71670);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",p:"p",strong:"strong",...(0,i.a)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.h1,{id:"interface-kubernetesproviderconnectionendpoint",children:"Interface: KubernetesProviderConnectionEndpoint"}),"\n",(0,r.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,r.jsx)(n.h3,{id:"apiurl",children:"apiURL"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"apiURL"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L460",children:"packages/extension-api/src/extension-api.d.ts:460"})})]})}function u(e={}){const{wrapper:n}={...(0,i.a)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(p,{...e})}):p(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>c,a:()=>s});var r=t(27378);const i={},o=r.createContext(i);function s(e){const n=r.useContext(o);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:s(e.components),r.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[30466],{80171:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>d,contentTitle:()=>s,default:()=>u,frontMatter:()=>o,metadata:()=>c,toc:()=>a});var r=t(24246),i=t(71670);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",p:"p",strong:"strong",...(0,i.a)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.h1,{id:"interface-kubernetesproviderconnectionendpoint",children:"Interface: KubernetesProviderConnectionEndpoint"}),"\n",(0,r.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,r.jsx)(n.h3,{id:"apiurl",children:"apiURL"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"apiURL"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L460",children:"packages/extension-api/src/extension-api.d.ts:460"})})]})}function u(e={}){const{wrapper:n}={...(0,i.a)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(p,{...e})}):p(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>c,a:()=>s});var r=t(27378);const i={},o=r.createContext(i);function s(e){const n=r.useContext(o);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:s(e.components),r.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/0e72c11a.31e764db.js b/assets/js/0e72c11a.98724709.js similarity index 87% rename from assets/js/0e72c11a.31e764db.js rename to assets/js/0e72c11a.98724709.js index f505110ab52..c04f8fd6a4d 100644 --- a/assets/js/0e72c11a.31e764db.js +++ b/assets/js/0e72c11a.98724709.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[19536],{85226:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>r,contentTitle:()=>a,default:()=>p,frontMatter:()=>i,metadata:()=>c,toc:()=>u});var t=s(24246),o=s(71670);const i={},a="Function: navigateToResources()",c={id:"namespaces/navigation/functions/navigateToResources",title:"Function: navigateToResources()",description:"navigateToResources(): Promise\\",source:"@site/api/namespaces/navigation/functions/navigateToResources.md",sourceDirName:"namespaces/navigation/functions",slug:"/namespaces/navigation/functions/navigateToResources",permalink:"/api/namespaces/navigation/functions/navigateToResources",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"navigateToPods",permalink:"/api/namespaces/navigation/functions/navigateToPods"},next:{title:"navigateToVolume",permalink:"/api/namespaces/navigation/functions/navigateToVolume"}},r={},u=[{value:"Returns",id:"returns",level:2},{value:"Defined in",id:"defined-in",level:2}];function d(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,o.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"function-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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L4472",children:"packages/extension-api/src/extension-api.d.ts:4472"})})]})}function p(e={}){const{wrapper:n}={...(0,o.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(d,{...e})}):d(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>c,a:()=>a});var t=s(27378);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([[19536],{85226:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>r,contentTitle:()=>a,default:()=>p,frontMatter:()=>i,metadata:()=>c,toc:()=>d});var t=s(24246),o=s(71670);const i={},a="Function: navigateToResources()",c={id:"namespaces/navigation/functions/navigateToResources",title:"Function: navigateToResources()",description:"navigateToResources(): Promise\\",source:"@site/api/namespaces/navigation/functions/navigateToResources.md",sourceDirName:"namespaces/navigation/functions",slug:"/namespaces/navigation/functions/navigateToResources",permalink:"/api/namespaces/navigation/functions/navigateToResources",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"navigateToPods",permalink:"/api/namespaces/navigation/functions/navigateToPods"},next:{title:"navigateToVolume",permalink:"/api/namespaces/navigation/functions/navigateToVolume"}},r={},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",p:"p",strong:"strong",...(0,o.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L4472",children:"packages/extension-api/src/extension-api.d.ts:4472"})})]})}function p(e={}){const{wrapper:n}={...(0,o.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(u,{...e})}):u(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>c,a:()=>a});var t=s(27378);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.e9ea90aa.js b/assets/js/0f54081d.b7a0dc74.js similarity index 98% rename from assets/js/0f54081d.e9ea90aa.js rename to assets/js/0f54081d.b7a0dc74.js index 8626d7f92f1..c44d7bec1d5 100644 --- a/assets/js/0f54081d.e9ea90aa.js +++ b/assets/js/0f54081d.b7a0dc74.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[37073],{81497:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>d,contentTitle:()=>c,default:()=>p,frontMatter:()=>o,metadata:()=>s,toc:()=>a});var i=t(24246),r=t(71670);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",p:"p",strong:"strong",...(0,r.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L826",children:"packages/extension-api/src/extension-api.d.ts:826"})})]})}function p(e={}){const{wrapper:n}={...(0,r.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>s,a:()=>c});var i=t(27378);const r={},o=i.createContext(r);function c(e){const n=i.useContext(o);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function s(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:c(e.components),i.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[37073],{81497:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>d,contentTitle:()=>c,default:()=>p,frontMatter:()=>o,metadata:()=>s,toc:()=>a});var i=t(24246),r=t(71670);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",p:"p",strong:"strong",...(0,r.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L826",children:"packages/extension-api/src/extension-api.d.ts:826"})})]})}function p(e={}){const{wrapper:n}={...(0,r.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>s,a:()=>c});var i=t(27378);const r={},o=i.createContext(r);function c(e){const n=i.useContext(o);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function s(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:c(e.components),i.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/0fa6e9bf.5f4df978.js b/assets/js/0fa6e9bf.cef402d3.js similarity index 89% rename from assets/js/0fa6e9bf.5f4df978.js rename to assets/js/0fa6e9bf.cef402d3.js index c17dea76645..cea83803a9d 100644 --- a/assets/js/0fa6e9bf.5f4df978.js +++ b/assets/js/0fa6e9bf.cef402d3.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[54063],{71683:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>c,contentTitle:()=>o,default:()=>p,frontMatter:()=>r,metadata:()=>a,toc:()=>l});var t=s(24246),i=s(71670);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={},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",p:"p",strong:"strong",...(0,i.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"function-openexternal",children:"Function: openExternal()"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"openExternal"}),"(",(0,t.jsx)(n.code,{children:"uri"}),"): ",(0,t.jsx)(n.code,{children:"Promise"}),"<",(0,t.jsx)(n.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"Opens a link externally using the default application. Depending on the"}),"\n",(0,t.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"uri"}),": ",(0,t.jsx)(n.a,{href:"/api/classes/Uri",children:(0,t.jsx)(n.code,{children:"Uri"})})]}),"\n",(0,t.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"Promise"}),"<",(0,t.jsx)(n.code,{children:"boolean"}),">"]}),"\n",(0,t.jsx)(n.p,{children:"A promise indicating if open was successful."}),"\n",(0,t.jsx)(n.h2,{id:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L3989",children:"packages/extension-api/src/extension-api.d.ts:3989"})})]})}function p(e={}){const{wrapper:n}={...(0,i.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(d,{...e})}):d(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>a,a:()=>o});var t=s(27378);const i={},r=t.createContext(i);function o(e){const n=t.useContext(r);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function a(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:o(e.components),t.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[54063],{71683:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>c,contentTitle:()=>o,default:()=>p,frontMatter:()=>r,metadata:()=>a,toc:()=>d});var t=s(24246),i=s(71670);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",p:"p",strong:"strong",...(0,i.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"function-openexternal",children:"Function: openExternal()"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"openExternal"}),"(",(0,t.jsx)(n.code,{children:"uri"}),"): ",(0,t.jsx)(n.code,{children:"Promise"}),"<",(0,t.jsx)(n.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"Opens a link externally using the default application. Depending on the"}),"\n",(0,t.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"uri"}),": ",(0,t.jsx)(n.a,{href:"/api/classes/Uri",children:(0,t.jsx)(n.code,{children:"Uri"})})]}),"\n",(0,t.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"Promise"}),"<",(0,t.jsx)(n.code,{children:"boolean"}),">"]}),"\n",(0,t.jsx)(n.p,{children:"A promise indicating if open was successful."}),"\n",(0,t.jsx)(n.h2,{id:"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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L3989",children:"packages/extension-api/src/extension-api.d.ts:3989"})})]})}function p(e={}){const{wrapper:n}={...(0,i.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>a,a:()=>o});var t=s(27378);const i={},r=t.createContext(i);function o(e){const n=t.useContext(r);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function a(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:o(e.components),t.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/10210328.972ef8bb.js b/assets/js/10210328.647188f4.js similarity index 96% rename from assets/js/10210328.972ef8bb.js rename to assets/js/10210328.647188f4.js index 7f2ba1979f6..93a75e5b415 100644 --- a/assets/js/10210328.972ef8bb.js +++ b/assets/js/10210328.647188f4.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[38943],{97958:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>d,contentTitle:()=>r,default:()=>x,frontMatter:()=>o,metadata:()=>c,toc:()=>a});var t=s(24246),i=s(71670);const o={},r="Function: getExtension()",c={id:"namespaces/extensions/functions/getExtension",title:"Function: getExtension()",description:"getExtension\\(extensionId): Extension\\ \\| undefined",source:"@site/api/namespaces/extensions/functions/getExtension.md",sourceDirName:"namespaces/extensions/functions",slug:"/namespaces/extensions/functions/getExtension",permalink:"/api/namespaces/extensions/functions/getExtension",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"all",permalink:"/api/namespaces/extensions/variables/all"},next:{title:"onDidChange",permalink:"/api/namespaces/extensions/functions/onDidChange"}},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",p:"p",strong:"strong",...(0,i.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"function-getextension",children:"Function: getExtension()"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"getExtension"}),"<",(0,t.jsx)(n.code,{children:"T"}),">(",(0,t.jsx)(n.code,{children:"extensionId"}),"): ",(0,t.jsx)(n.a,{href:"/api/interfaces/Extension",children:(0,t.jsx)(n.code,{children:"Extension"})}),"<",(0,t.jsx)(n.code,{children:"T"}),"> | ",(0,t.jsx)(n.code,{children:"undefined"})]}),"\n"]}),"\n",(0,t.jsxs)(n.p,{children:["Get an extension by its full identifier in the form of: ",(0,t.jsx)(n.code,{children:"publisher.name"}),"."]}),"\n",(0,t.jsx)(n.h2,{id:"type-parameters",children:"Type Parameters"}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"T"})," = ",(0,t.jsx)(n.code,{children:"any"})]}),"\n",(0,t.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"extensionId"}),": ",(0,t.jsx)(n.code,{children:"string"})]}),"\n",(0,t.jsx)(n.p,{children:"An extension identifier."}),"\n",(0,t.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.a,{href:"/api/interfaces/Extension",children:(0,t.jsx)(n.code,{children:"Extension"})}),"<",(0,t.jsx)(n.code,{children:"T"}),"> | ",(0,t.jsx)(n.code,{children:"undefined"})]}),"\n",(0,t.jsxs)(n.p,{children:["An extension or ",(0,t.jsx)(n.code,{children:"undefined"}),"."]}),"\n",(0,t.jsx)(n.h2,{id:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L234",children:"packages/extension-api/src/extension-api.d.ts:234"})})]})}function x(e={}){const{wrapper:n}={...(0,i.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>c,a:()=>r});var t=s(27378);const i={},o=t.createContext(i);function r(e){const n=t.useContext(o);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:r(e.components),t.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[38943],{97958:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>d,contentTitle:()=>r,default:()=>x,frontMatter:()=>o,metadata:()=>c,toc:()=>a});var t=s(24246),i=s(71670);const o={},r="Function: getExtension()",c={id:"namespaces/extensions/functions/getExtension",title:"Function: getExtension()",description:"getExtension\\(extensionId): Extension\\ \\| undefined",source:"@site/api/namespaces/extensions/functions/getExtension.md",sourceDirName:"namespaces/extensions/functions",slug:"/namespaces/extensions/functions/getExtension",permalink:"/api/namespaces/extensions/functions/getExtension",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"all",permalink:"/api/namespaces/extensions/variables/all"},next:{title:"onDidChange",permalink:"/api/namespaces/extensions/functions/onDidChange"}},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",p:"p",strong:"strong",...(0,i.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"function-getextension",children:"Function: getExtension()"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"getExtension"}),"<",(0,t.jsx)(n.code,{children:"T"}),">(",(0,t.jsx)(n.code,{children:"extensionId"}),"): ",(0,t.jsx)(n.a,{href:"/api/interfaces/Extension",children:(0,t.jsx)(n.code,{children:"Extension"})}),"<",(0,t.jsx)(n.code,{children:"T"}),"> | ",(0,t.jsx)(n.code,{children:"undefined"})]}),"\n"]}),"\n",(0,t.jsxs)(n.p,{children:["Get an extension by its full identifier in the form of: ",(0,t.jsx)(n.code,{children:"publisher.name"}),"."]}),"\n",(0,t.jsx)(n.h2,{id:"type-parameters",children:"Type Parameters"}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"T"})," = ",(0,t.jsx)(n.code,{children:"any"})]}),"\n",(0,t.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"extensionId"}),": ",(0,t.jsx)(n.code,{children:"string"})]}),"\n",(0,t.jsx)(n.p,{children:"An extension identifier."}),"\n",(0,t.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.a,{href:"/api/interfaces/Extension",children:(0,t.jsx)(n.code,{children:"Extension"})}),"<",(0,t.jsx)(n.code,{children:"T"}),"> | ",(0,t.jsx)(n.code,{children:"undefined"})]}),"\n",(0,t.jsxs)(n.p,{children:["An extension or ",(0,t.jsx)(n.code,{children:"undefined"}),"."]}),"\n",(0,t.jsx)(n.h2,{id:"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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L234",children:"packages/extension-api/src/extension-api.d.ts:234"})})]})}function x(e={}){const{wrapper:n}={...(0,i.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>c,a:()=>r});var t=s(27378);const i={},o=t.createContext(i);function r(e){const n=t.useContext(o);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:r(e.components),t.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/107d77e6.e6df946e.js b/assets/js/107d77e6.02a445dd.js similarity index 95% rename from assets/js/107d77e6.e6df946e.js rename to assets/js/107d77e6.02a445dd.js index f4f1df1bebf..945e275441c 100644 --- a/assets/js/107d77e6.e6df946e.js +++ b/assets/js/107d77e6.02a445dd.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[51051],{14914:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>c,contentTitle:()=>o,default:()=>p,frontMatter:()=>r,metadata:()=>a,toc:()=>d});var i=t(24246),s=t(71670);const r={},o="Interface: 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",p:"p",pre:"pre",strong:"strong",...(0,s.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"interface-listinfosoptions",children:"Interface: ListInfosOptions"}),"\n",(0,i.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(n.h3,{id:"provider",children:"provider?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"provider"}),": ",(0,i.jsx)(n.a,{href:"/api/interfaces/ContainerProviderConnection",children:(0,i.jsx)(n.code,{children:"ContainerProviderConnection"})})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"The provider we want to list the infos. If not provided, will return info for all engines."}),"\n",(0,i.jsx)(n.h4,{id:"default-value",children:"Default Value"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-ts",children:"undefined\n"})}),"\n",(0,i.jsx)(n.h4,{id:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L3431",children:"packages/extension-api/src/extension-api.d.ts:3431"})})]})}function p(e={}){const{wrapper:n}={...(0,s.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>a,a:()=>o});var i=t(27378);const s={},r=i.createContext(s);function o(e){const n=i.useContext(r);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function a(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:o(e.components),i.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[51051],{14914:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>c,contentTitle:()=>o,default:()=>p,frontMatter:()=>r,metadata:()=>a,toc:()=>d});var i=t(24246),s=t(71670);const r={},o="Interface: 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",p:"p",pre:"pre",strong:"strong",...(0,s.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"interface-listinfosoptions",children:"Interface: ListInfosOptions"}),"\n",(0,i.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(n.h3,{id:"provider",children:"provider?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"provider"}),": ",(0,i.jsx)(n.a,{href:"/api/interfaces/ContainerProviderConnection",children:(0,i.jsx)(n.code,{children:"ContainerProviderConnection"})})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"The provider we want to list the infos. If not provided, will return info for all engines."}),"\n",(0,i.jsx)(n.h4,{id:"default-value",children:"Default Value"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-ts",children:"undefined\n"})}),"\n",(0,i.jsx)(n.h4,{id:"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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L3431",children:"packages/extension-api/src/extension-api.d.ts:3431"})})]})}function p(e={}){const{wrapper:n}={...(0,s.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>a,a:()=>o});var i=t(27378);const s={},r=i.createContext(s);function o(e){const n=i.useContext(r);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function a(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:o(e.components),i.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/123a454a.ab643bdf.js b/assets/js/123a454a.6cc4a9b6.js similarity index 93% rename from assets/js/123a454a.ab643bdf.js rename to assets/js/123a454a.6cc4a9b6.js index d5c88e9edab..8316720bec2 100644 --- a/assets/js/123a454a.ab643bdf.js +++ b/assets/js/123a454a.6cc4a9b6.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[29693],{55600:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>c,contentTitle:()=>d,default:()=>p,frontMatter:()=>r,metadata:()=>o,toc:()=>a});var s=t(24246),i=t(71670);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",hr:"hr",p:"p",strong:"strong",...(0,i.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"interface-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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L4048",children:"packages/extension-api/src/extension-api.d.ts:4048"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L4058",children:"packages/extension-api/src/extension-api.d.ts:4058"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L4053",children:"packages/extension-api/src/extension-api.d.ts:4053"})})]})}function p(e={}){const{wrapper:n}={...(0,i.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>o,a:()=>d});var s=t(27378);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([[29693],{55600:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>c,contentTitle:()=>d,default:()=>p,frontMatter:()=>r,metadata:()=>o,toc:()=>a});var s=t(24246),i=t(71670);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",hr:"hr",p:"p",strong:"strong",...(0,i.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"interface-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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L4048",children:"packages/extension-api/src/extension-api.d.ts:4048"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L4058",children:"packages/extension-api/src/extension-api.d.ts:4058"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L4053",children:"packages/extension-api/src/extension-api.d.ts:4053"})})]})}function p(e={}){const{wrapper:n}={...(0,i.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>o,a:()=>d});var s=t(27378);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 diff --git a/assets/js/125d93c1.78ce2776.js b/assets/js/125d93c1.cf6f1cba.js similarity index 94% rename from assets/js/125d93c1.78ce2776.js rename to assets/js/125d93c1.cf6f1cba.js index bf448e2aee7..8241bb36290 100644 --- a/assets/js/125d93c1.78ce2776.js +++ b/assets/js/125d93c1.cf6f1cba.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[22228],{14566:(n,e,t)=>{t.r(e),t.d(e,{assets:()=>r,contentTitle:()=>a,default:()=>p,frontMatter:()=>s,metadata:()=>c,toc:()=>d});var o=t(24246),i=t(71670);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(n){const e={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,i.a)(),...n.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(e.h1,{id:"function-navigatetopods",children:"Function: navigateToPods()"}),"\n",(0,o.jsxs)(e.blockquote,{children:["\n",(0,o.jsxs)(e.p,{children:[(0,o.jsx)(e.strong,{children:"navigateToPods"}),"(): ",(0,o.jsx)(e.code,{children:"Promise"}),"<",(0,o.jsx)(e.code,{children:"void"}),">"]}),"\n"]}),"\n",(0,o.jsx)(e.h2,{id:"returns",children:"Returns"}),"\n",(0,o.jsxs)(e.p,{children:[(0,o.jsx)(e.code,{children:"Promise"}),"<",(0,o.jsx)(e.code,{children:"void"}),">"]}),"\n",(0,o.jsx)(e.h2,{id:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L4449",children:"packages/extension-api/src/extension-api.d.ts:4449"})})]})}function p(n={}){const{wrapper:e}={...(0,i.a)(),...n.components};return e?(0,o.jsx)(e,{...n,children:(0,o.jsx)(u,{...n})}):u(n)}},71670:(n,e,t)=>{t.d(e,{Z:()=>c,a:()=>a});var o=t(27378);const i={},s=o.createContext(i);function a(n){const e=o.useContext(s);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(i):n.components||i:a(n.components),o.createElement(s.Provider,{value:e},n.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[22228],{14566:(n,e,t)=>{t.r(e),t.d(e,{assets:()=>r,contentTitle:()=>a,default:()=>p,frontMatter:()=>s,metadata:()=>c,toc:()=>d});var o=t(24246),i=t(71670);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(n){const e={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,i.a)(),...n.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(e.h1,{id:"function-navigatetopods",children:"Function: navigateToPods()"}),"\n",(0,o.jsxs)(e.blockquote,{children:["\n",(0,o.jsxs)(e.p,{children:[(0,o.jsx)(e.strong,{children:"navigateToPods"}),"(): ",(0,o.jsx)(e.code,{children:"Promise"}),"<",(0,o.jsx)(e.code,{children:"void"}),">"]}),"\n"]}),"\n",(0,o.jsx)(e.h2,{id:"returns",children:"Returns"}),"\n",(0,o.jsxs)(e.p,{children:[(0,o.jsx)(e.code,{children:"Promise"}),"<",(0,o.jsx)(e.code,{children:"void"}),">"]}),"\n",(0,o.jsx)(e.h2,{id:"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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L4449",children:"packages/extension-api/src/extension-api.d.ts:4449"})})]})}function p(n={}){const{wrapper:e}={...(0,i.a)(),...n.components};return e?(0,o.jsx)(e,{...n,children:(0,o.jsx)(u,{...n})}):u(n)}},71670:(n,e,t)=>{t.d(e,{Z:()=>c,a:()=>a});var o=t(27378);const i={},s=o.createContext(i);function a(n){const e=o.useContext(s);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(i):n.components||i:a(n.components),o.createElement(s.Provider,{value:e},n.children)}}}]); \ No newline at end of file diff --git a/assets/js/12eb386e.2e1a1154.js b/assets/js/12eb386e.0b54149b.js similarity index 89% rename from assets/js/12eb386e.2e1a1154.js rename to assets/js/12eb386e.0b54149b.js index 9464dfbeb0b..2c8fd3262c2 100644 --- a/assets/js/12eb386e.2e1a1154.js +++ b/assets/js/12eb386e.0b54149b.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[89950],{71960:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>a,contentTitle:()=>d,default:()=>p,frontMatter:()=>o,metadata:()=>r,toc:()=>c});var s=i(24246),t=i(71670);const o={},d="Interface: CliToolOptions",r={id:"interfaces/CliToolOptions",title:"Interface: CliToolOptions",description:"Options to create new CliTool instance and register it in podman desktop",source:"@site/api/interfaces/CliToolOptions.md",sourceDirName:"interfaces",slug:"/interfaces/CliToolOptions",permalink:"/api/interfaces/CliToolOptions",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"CliTool",permalink:"/api/interfaces/CliTool"},next:{title:"CliToolUpdate",permalink:"/api/interfaces/CliToolUpdate"}},a={},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:"markdownDescription",id:"markdowndescription",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:"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",hr:"hr",p:"p",strong:"strong",...(0,t.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"interface-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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L4286",children:"packages/extension-api/src/extension-api.d.ts:4286"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L4288",children:"packages/extension-api/src/extension-api.d.ts:4288"})}),"\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-2",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L4287",children:"packages/extension-api/src/extension-api.d.ts:4287"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L4285",children:"packages/extension-api/src/extension-api.d.ts:4285"})}),"\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-4",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L4298",children:"packages/extension-api/src/extension-api.d.ts:4298"})}),"\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.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'."]}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L4297",children:"packages/extension-api/src/extension-api.d.ts:4297"})})]})}function p(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>r,a:()=>d});var s=i(27378);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([[89950],{71960:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>a,contentTitle:()=>d,default:()=>p,frontMatter:()=>o,metadata:()=>r,toc:()=>c});var s=i(24246),t=i(71670);const o={},d="Interface: CliToolOptions",r={id:"interfaces/CliToolOptions",title:"Interface: CliToolOptions",description:"Options to create new CliTool instance and register it in podman desktop",source:"@site/api/interfaces/CliToolOptions.md",sourceDirName:"interfaces",slug:"/interfaces/CliToolOptions",permalink:"/api/interfaces/CliToolOptions",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"CliTool",permalink:"/api/interfaces/CliTool"},next:{title:"CliToolUpdate",permalink:"/api/interfaces/CliToolUpdate"}},a={},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:"markdownDescription",id:"markdowndescription",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:"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",hr:"hr",p:"p",strong:"strong",...(0,t.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"interface-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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L4286",children:"packages/extension-api/src/extension-api.d.ts:4286"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L4288",children:"packages/extension-api/src/extension-api.d.ts:4288"})}),"\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-2",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L4287",children:"packages/extension-api/src/extension-api.d.ts:4287"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L4285",children:"packages/extension-api/src/extension-api.d.ts:4285"})}),"\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-4",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L4298",children:"packages/extension-api/src/extension-api.d.ts:4298"})}),"\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.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'."]}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L4297",children:"packages/extension-api/src/extension-api.d.ts:4297"})})]})}function p(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>r,a:()=>d});var s=i(27378);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/148448cb.2077b18d.js b/assets/js/148448cb.3d585449.js similarity index 87% rename from assets/js/148448cb.2077b18d.js rename to assets/js/148448cb.3d585449.js index 4155682f445..723b9711761 100644 --- a/assets/js/148448cb.2077b18d.js +++ b/assets/js/148448cb.3d585449.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[72092],{66137:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>a,contentTitle:()=>c,default:()=>h,frontMatter:()=>t,metadata:()=>o,toc:()=>r});var s=i(24246),d=i(71670);const t={},c="Interface: ContainerCreateOptions",o={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"}},a={},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",hr:"hr",p:"p",pre:"pre",strong:"strong",...(0,d.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L2971",children:"packages/extension-api/src/extension-api.d.ts:2971"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L2939",children:"packages/extension-api/src/extension-api.d.ts:2939"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L2929",children:"packages/extension-api/src/extension-api.d.ts:2929"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L2934",children:"packages/extension-api/src/extension-api.d.ts:2934"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/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:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/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:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L2871",children:"packages/extension-api/src/extension-api.d.ts:2871"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L2924",children:"packages/extension-api/src/extension-api.d.ts:2924"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/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:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/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:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L2897",children:"packages/extension-api/src/extension-api.d.ts:2897"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/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:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L2902",children:"packages/extension-api/src/extension-api.d.ts:2902"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L2866",children:"packages/extension-api/src/extension-api.d.ts:2866"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L2907",children:"packages/extension-api/src/extension-api.d.ts:2907"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/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:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/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:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L3015",children:"packages/extension-api/src/extension-api.d.ts:3015"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L2986",children:"packages/extension-api/src/extension-api.d.ts:2986"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/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:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/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:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L3013",children:"packages/extension-api/src/extension-api.d.ts:3013"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/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:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/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:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L3008",children:"packages/extension-api/src/extension-api.d.ts:3008"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L2912",children:"packages/extension-api/src/extension-api.d.ts:2912"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L2876",children:"packages/extension-api/src/extension-api.d.ts:2876"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L2976",children:"packages/extension-api/src/extension-api.d.ts:2976"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L2981",children:"packages/extension-api/src/extension-api.d.ts:2981"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/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:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L2861",children:"packages/extension-api/src/extension-api.d.ts:2861"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L3020",children:"packages/extension-api/src/extension-api.d.ts:3020"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L2959",children:"packages/extension-api/src/extension-api.d.ts:2959"})})]})}function h(e={}){const{wrapper:n}={...(0,d.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>o,a:()=>c});var s=i(27378);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([[72092],{66137:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>o,contentTitle:()=>c,default:()=>h,frontMatter:()=>t,metadata:()=>a,toc:()=>r});var s=i(24246),d=i(71670);const t={},c="Interface: ContainerCreateOptions",a={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",hr:"hr",p:"p",pre:"pre",strong:"strong",...(0,d.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2971",children:"packages/extension-api/src/extension-api.d.ts:2971"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2939",children:"packages/extension-api/src/extension-api.d.ts:2939"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2929",children:"packages/extension-api/src/extension-api.d.ts:2929"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2934",children:"packages/extension-api/src/extension-api.d.ts:2934"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/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:"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/bd83a8b2bb8ab886dc757381b589638cbda150d0/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:"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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2871",children:"packages/extension-api/src/extension-api.d.ts:2871"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2924",children:"packages/extension-api/src/extension-api.d.ts:2924"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"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/bd83a8b2bb8ab886dc757381b589638cbda150d0/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:"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/bd83a8b2bb8ab886dc757381b589638cbda150d0/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:"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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2897",children:"packages/extension-api/src/extension-api.d.ts:2897"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/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:"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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2902",children:"packages/extension-api/src/extension-api.d.ts:2902"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2866",children:"packages/extension-api/src/extension-api.d.ts:2866"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2907",children:"packages/extension-api/src/extension-api.d.ts:2907"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/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:"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/bd83a8b2bb8ab886dc757381b589638cbda150d0/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:"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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L3015",children:"packages/extension-api/src/extension-api.d.ts:3015"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2986",children:"packages/extension-api/src/extension-api.d.ts:2986"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/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:"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/bd83a8b2bb8ab886dc757381b589638cbda150d0/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:"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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L3013",children:"packages/extension-api/src/extension-api.d.ts:3013"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/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:"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/bd83a8b2bb8ab886dc757381b589638cbda150d0/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:"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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L3008",children:"packages/extension-api/src/extension-api.d.ts:3008"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2912",children:"packages/extension-api/src/extension-api.d.ts:2912"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2876",children:"packages/extension-api/src/extension-api.d.ts:2876"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2976",children:"packages/extension-api/src/extension-api.d.ts:2976"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2981",children:"packages/extension-api/src/extension-api.d.ts:2981"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/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:"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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2861",children:"packages/extension-api/src/extension-api.d.ts:2861"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L3020",children:"packages/extension-api/src/extension-api.d.ts:3020"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2959",children:"packages/extension-api/src/extension-api.d.ts:2959"})})]})}function h(e={}){const{wrapper:n}={...(0,d.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>a,a:()=>c});var s=i(27378);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 a(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/14ae68e7.f03eb54b.js b/assets/js/14ae68e7.cf72c50a.js similarity index 90% rename from assets/js/14ae68e7.f03eb54b.js rename to assets/js/14ae68e7.cf72c50a.js index 63e63a18e11..3b8beed9f9b 100644 --- a/assets/js/14ae68e7.f03eb54b.js +++ b/assets/js/14ae68e7.cf72c50a.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[60574],{42761:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>c,contentTitle:()=>o,default:()=>p,frontMatter:()=>d,metadata:()=>r,toc:()=>a});var s=i(24246),t=i(71670);const d={},o="Interface: EndpointIPAMConfig",r={id:"interfaces/EndpointIPAMConfig",title:"Interface: EndpointIPAMConfig",description:"Properties",source:"@site/api/interfaces/EndpointIPAMConfig.md",sourceDirName:"interfaces",slug:"/interfaces/EndpointIPAMConfig",permalink:"/api/interfaces/EndpointIPAMConfig",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"DeviceRequest",permalink:"/api/interfaces/DeviceRequest"},next:{title:"EndpointSettings",permalink:"/api/interfaces/EndpointSettings"}},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",hr:"hr",p:"p",strong:"strong",...(0,t.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"interface-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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L2739",children:"packages/extension-api/src/extension-api.d.ts:2739"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L2740",children:"packages/extension-api/src/extension-api.d.ts:2740"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L2741",children:"packages/extension-api/src/extension-api.d.ts:2741"})})]})}function p(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>r,a:()=>o});var s=i(27378);const t={},d=s.createContext(t);function o(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:o(e.components),s.createElement(d.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[60574],{42761:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>c,contentTitle:()=>o,default:()=>p,frontMatter:()=>d,metadata:()=>r,toc:()=>a});var s=i(24246),t=i(71670);const d={},o="Interface: EndpointIPAMConfig",r={id:"interfaces/EndpointIPAMConfig",title:"Interface: EndpointIPAMConfig",description:"Properties",source:"@site/api/interfaces/EndpointIPAMConfig.md",sourceDirName:"interfaces",slug:"/interfaces/EndpointIPAMConfig",permalink:"/api/interfaces/EndpointIPAMConfig",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"DeviceRequest",permalink:"/api/interfaces/DeviceRequest"},next:{title:"EndpointSettings",permalink:"/api/interfaces/EndpointSettings"}},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",hr:"hr",p:"p",strong:"strong",...(0,t.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"interface-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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2739",children:"packages/extension-api/src/extension-api.d.ts:2739"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2740",children:"packages/extension-api/src/extension-api.d.ts:2740"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2741",children:"packages/extension-api/src/extension-api.d.ts:2741"})})]})}function p(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>r,a:()=>o});var s=i(27378);const t={},d=s.createContext(t);function o(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:o(e.components),s.createElement(d.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/1515c895.d7af2c73.js b/assets/js/1515c895.be79b40a.js similarity index 97% rename from assets/js/1515c895.d7af2c73.js rename to assets/js/1515c895.be79b40a.js index 58817bd8bd7..2859dfa00a4 100644 --- a/assets/js/1515c895.d7af2c73.js +++ b/assets/js/1515c895.be79b40a.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[38134],{86522:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>c,contentTitle:()=>o,default:()=>g,frontMatter:()=>s,metadata:()=>r,toc:()=>d});var t=i(24246),a=i(71670);const s={},o="Function: navigateToImage()",r={id:"namespaces/navigation/functions/navigateToImage",title:"Function: navigateToImage()",description:"navigateToImage(id, engineId, tag): Promise\\",source:"@site/api/namespaces/navigation/functions/navigateToImage.md",sourceDirName:"namespaces/navigation/functions",slug:"/namespaces/navigation/functions/navigateToImage",permalink:"/api/namespaces/navigation/functions/navigateToImage",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"navigateToEditProviderContainerConnection",permalink:"/api/namespaces/navigation/functions/navigateToEditProviderContainerConnection"},next:{title:"navigateToImages",permalink:"/api/namespaces/navigation/functions/navigateToImages"}},c={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Defined in",id:"defined-in",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,a.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L4441",children:"packages/extension-api/src/extension-api.d.ts:4441"})})]})}function g(e={}){const{wrapper:n}={...(0,a.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>r,a:()=>o});var t=i(27378);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([[38134],{86522:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>c,contentTitle:()=>o,default:()=>g,frontMatter:()=>s,metadata:()=>r,toc:()=>d});var t=i(24246),a=i(71670);const s={},o="Function: navigateToImage()",r={id:"namespaces/navigation/functions/navigateToImage",title:"Function: navigateToImage()",description:"navigateToImage(id, engineId, tag): Promise\\",source:"@site/api/namespaces/navigation/functions/navigateToImage.md",sourceDirName:"namespaces/navigation/functions",slug:"/namespaces/navigation/functions/navigateToImage",permalink:"/api/namespaces/navigation/functions/navigateToImage",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"navigateToEditProviderContainerConnection",permalink:"/api/namespaces/navigation/functions/navigateToEditProviderContainerConnection"},next:{title:"navigateToImages",permalink:"/api/namespaces/navigation/functions/navigateToImages"}},c={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Defined in",id:"defined-in",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,a.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L4441",children:"packages/extension-api/src/extension-api.d.ts:4441"})})]})}function g(e={}){const{wrapper:n}={...(0,a.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>r,a:()=>o});var t=i(27378);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.4c3b7eba.js b/assets/js/160cb329.0db74b23.js similarity index 75% rename from assets/js/160cb329.4c3b7eba.js rename to assets/js/160cb329.0db74b23.js index 1ad4c911605..eba5614882f 100644 --- a/assets/js/160cb329.4c3b7eba.js +++ b/assets/js/160cb329.0db74b23.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[3984],{2227:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>d,contentTitle:()=>o,default:()=>h,frontMatter:()=>r,metadata:()=>c,toc:()=>a});var t=i(24246),s=i(71670);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",hr:"hr",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"interface-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/804b2198fda0957e1ecfb87539f019eb9b79a66f/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/804b2198fda0957e1ecfb87539f019eb9b79a66f/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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L308",children:"packages/extension-api/src/extension-api.d.ts:308"})})]})}function h(e={}){const{wrapper:n}={...(0,s.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>c,a:()=>o});var t=i(27378);const s={},r=t.createContext(s);function o(e){const n=t.useContext(r);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:o(e.components),t.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[3984],{2227:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>o,contentTitle:()=>c,default:()=>h,frontMatter:()=>r,metadata:()=>d,toc:()=>a});var t=i(24246),s=i(71670);const r={},c="Interface: ProviderDetectionCheck",d={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"}},o={},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",hr:"hr",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"interface-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/bd83a8b2bb8ab886dc757381b589638cbda150d0/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/bd83a8b2bb8ab886dc757381b589638cbda150d0/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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L308",children:"packages/extension-api/src/extension-api.d.ts:308"})})]})}function h(e={}){const{wrapper:n}={...(0,s.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>d,a:()=>c});var t=i(27378);const s={},r=t.createContext(s);function c(e){const n=t.useContext(r);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function 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/164937d2.75cf51aa.js b/assets/js/164937d2.e72c01c0.js similarity index 92% rename from assets/js/164937d2.75cf51aa.js rename to assets/js/164937d2.e72c01c0.js index 6151d0fa595..1c706e2a0c4 100644 --- a/assets/js/164937d2.75cf51aa.js +++ b/assets/js/164937d2.e72c01c0.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[5477],{64010:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>o,contentTitle:()=>d,default:()=>h,frontMatter:()=>t,metadata:()=>c,toc:()=>a});var s=r(24246),i=r(71670);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"}},o={},a=[{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",hr:"hr",p:"p",strong:"strong",...(0,i.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"interface-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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L4518",children:"packages/extension-api/src/extension-api.d.ts:4518"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L4513",children:"packages/extension-api/src/extension-api.d.ts:4513"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L4500",children:"packages/extension-api/src/extension-api.d.ts:4500"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L4507",children:"packages/extension-api/src/extension-api.d.ts:4507"})})]})}function h(e={}){const{wrapper:n}={...(0,i.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},71670:(e,n,r)=>{r.d(n,{Z:()=>c,a:()=>d});var s=r(27378);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([[5477],{64010:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>a,contentTitle:()=>d,default:()=>h,frontMatter:()=>t,metadata:()=>c,toc:()=>o});var s=r(24246),i=r(71670);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",hr:"hr",p:"p",strong:"strong",...(0,i.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"interface-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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L4518",children:"packages/extension-api/src/extension-api.d.ts:4518"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L4513",children:"packages/extension-api/src/extension-api.d.ts:4513"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L4500",children:"packages/extension-api/src/extension-api.d.ts:4500"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L4507",children:"packages/extension-api/src/extension-api.d.ts:4507"})})]})}function h(e={}){const{wrapper:n}={...(0,i.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},71670:(e,n,r)=>{r.d(n,{Z:()=>c,a:()=>d});var s=r(27378);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.a7d7be93.js b/assets/js/16914cba.a3250adf.js similarity index 96% rename from assets/js/16914cba.a7d7be93.js rename to assets/js/16914cba.a3250adf.js index 068dbc1b9f2..52ac4427382 100644 --- a/assets/js/16914cba.a7d7be93.js +++ b/assets/js/16914cba.a3250adf.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[64315],{57276:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>c,contentTitle:()=>o,default:()=>h,frontMatter:()=>r,metadata:()=>a,toc:()=>d});var i=t(24246),s=t(71670);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",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"function-deletecontainer",children:"Function: deleteContainer()"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"deleteContainer"}),"(",(0,i.jsx)(n.code,{children:"engineId"}),", ",(0,i.jsx)(n.code,{children:"id"}),"): ",(0,i.jsx)(n.code,{children:"Promise"}),"<",(0,i.jsx)(n.code,{children:"void"}),">"]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Delete an existing container"}),"\n",(0,i.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"engineId"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n",(0,i.jsxs)(n.p,{children:["the id of the engine managing the container, obtained from the result of ",(0,i.jsx)(n.a,{href:"/api/namespaces/containerEngine/functions/listContainers",children:"containerEngine.listContainers"})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"id"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n",(0,i.jsxs)(n.p,{children:["the id of the container on this engine, obtained from the result of ",(0,i.jsx)(n.a,{href:"/api/namespaces/containerEngine/functions/listContainers",children:"containerEngine.listContainers"})," or as the result of ",(0,i.jsx)(n.a,{href:"/api/namespaces/containerEngine/functions/createContainer",children:"containerEngine.createContainer"})]}),"\n",(0,i.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"Promise"}),"<",(0,i.jsx)(n.code,{children:"void"}),">"]}),"\n",(0,i.jsx)(n.h2,{id:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L3528",children:"packages/extension-api/src/extension-api.d.ts:3528"})})]})}function h(e={}){const{wrapper:n}={...(0,s.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>a,a:()=>o});var i=t(27378);const s={},r=i.createContext(s);function o(e){const n=i.useContext(r);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function a(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:o(e.components),i.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[64315],{57276:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>c,contentTitle:()=>o,default:()=>h,frontMatter:()=>r,metadata:()=>a,toc:()=>d});var i=t(24246),s=t(71670);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",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"function-deletecontainer",children:"Function: deleteContainer()"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"deleteContainer"}),"(",(0,i.jsx)(n.code,{children:"engineId"}),", ",(0,i.jsx)(n.code,{children:"id"}),"): ",(0,i.jsx)(n.code,{children:"Promise"}),"<",(0,i.jsx)(n.code,{children:"void"}),">"]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Delete an existing container"}),"\n",(0,i.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"engineId"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n",(0,i.jsxs)(n.p,{children:["the id of the engine managing the container, obtained from the result of ",(0,i.jsx)(n.a,{href:"/api/namespaces/containerEngine/functions/listContainers",children:"containerEngine.listContainers"})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"id"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n",(0,i.jsxs)(n.p,{children:["the id of the container on this engine, obtained from the result of ",(0,i.jsx)(n.a,{href:"/api/namespaces/containerEngine/functions/listContainers",children:"containerEngine.listContainers"})," or as the result of ",(0,i.jsx)(n.a,{href:"/api/namespaces/containerEngine/functions/createContainer",children:"containerEngine.createContainer"})]}),"\n",(0,i.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"Promise"}),"<",(0,i.jsx)(n.code,{children:"void"}),">"]}),"\n",(0,i.jsx)(n.h2,{id:"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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L3528",children:"packages/extension-api/src/extension-api.d.ts:3528"})})]})}function h(e={}){const{wrapper:n}={...(0,s.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>a,a:()=>o});var i=t(27378);const s={},r=i.createContext(s);function o(e){const n=i.useContext(r);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function a(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:o(e.components),i.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/17612ae7.b1aa5916.js b/assets/js/17612ae7.e0be363a.js similarity index 85% rename from assets/js/17612ae7.b1aa5916.js rename to assets/js/17612ae7.e0be363a.js index 62318b2203d..a01c5f57522 100644 --- a/assets/js/17612ae7.b1aa5916.js +++ b/assets/js/17612ae7.e0be363a.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[97767],{72267:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>c,contentTitle:()=>r,default:()=>m,frontMatter:()=>a,metadata:()=>o,toc:()=>d});var t=i(24246),s=i(71670);const a={},r="Function: deleteImage()",o={id:"namespaces/containerEngine/functions/deleteImage",title:"Function: deleteImage()",description:"deleteImage(engineId, id): Promise\\",source:"@site/api/namespaces/containerEngine/functions/deleteImage.md",sourceDirName:"namespaces/containerEngine/functions",slug:"/namespaces/containerEngine/functions/deleteImage",permalink:"/api/namespaces/containerEngine/functions/deleteImage",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"deleteContainer",permalink:"/api/namespaces/containerEngine/functions/deleteContainer"},next:{title:"deleteVolume",permalink:"/api/namespaces/containerEngine/functions/deleteVolume"}},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",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L3616",children:"packages/extension-api/src/extension-api.d.ts:3616"})})]})}function m(e={}){const{wrapper:n}={...(0,s.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>o,a:()=>r});var t=i(27378);const s={},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 o(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([[97767],{72267:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>o,contentTitle:()=>r,default:()=>m,frontMatter:()=>a,metadata:()=>c,toc:()=>d});var t=i(24246),s=i(71670);const a={},r="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",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L3616",children:"packages/extension-api/src/extension-api.d.ts:3616"})})]})}function m(e={}){const{wrapper:n}={...(0,s.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>c,a:()=>r});var t=i(27378);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/17d2ebc8.1a610fa4.js b/assets/js/17d2ebc8.5ebeaea8.js similarity index 80% rename from assets/js/17d2ebc8.1a610fa4.js rename to assets/js/17d2ebc8.5ebeaea8.js index e3197d3aba9..2e9f72f18b4 100644 --- a/assets/js/17d2ebc8.1a610fa4.js +++ b/assets/js/17d2ebc8.5ebeaea8.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[14142],{89533:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>c,contentTitle:()=>o,default:()=>p,frontMatter:()=>r,metadata:()=>d,toc:()=>a});var t=i(24246),s=i(71670);const r={},o="Interface: ContainerJSONEvent",d={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={},a=[{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",hr:"hr",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"interface-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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L2648",children:"packages/extension-api/src/extension-api.d.ts:2648"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L2647",children:"packages/extension-api/src/extension-api.d.ts:2647"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L2646",children:"packages/extension-api/src/extension-api.d.ts:2646"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L2645",children:"packages/extension-api/src/extension-api.d.ts:2645"})})]})}function p(e={}){const{wrapper:n}={...(0,s.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>d,a:()=>o});var t=i(27378);const s={},r=t.createContext(s);function o(e){const n=t.useContext(r);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function 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([[14142],{89533:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>c,contentTitle:()=>d,default:()=>p,frontMatter:()=>r,metadata:()=>o,toc:()=>a});var t=i(24246),s=i(71670);const r={},d="Interface: ContainerJSONEvent",o={id:"interfaces/ContainerJSONEvent",title:"Interface: ContainerJSONEvent",description:"Properties",source:"@site/api/interfaces/ContainerJSONEvent.md",sourceDirName:"interfaces",slug:"/interfaces/ContainerJSONEvent",permalink:"/api/interfaces/ContainerJSONEvent",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"ContainerInspectInfo",permalink:"/api/interfaces/ContainerInspectInfo"},next:{title:"ContainerProviderConnection",permalink:"/api/interfaces/ContainerProviderConnection"}},c={},a=[{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",hr:"hr",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"interface-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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2648",children:"packages/extension-api/src/extension-api.d.ts:2648"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2647",children:"packages/extension-api/src/extension-api.d.ts:2647"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2646",children:"packages/extension-api/src/extension-api.d.ts:2646"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2645",children:"packages/extension-api/src/extension-api.d.ts:2645"})})]})}function p(e={}){const{wrapper:n}={...(0,s.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>o,a:()=>d});var t=i(27378);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/180d0c5f.4e42472e.js b/assets/js/180d0c5f.da98afd2.js similarity index 87% rename from assets/js/180d0c5f.4e42472e.js rename to assets/js/180d0c5f.da98afd2.js index a503fcd4884..c3aef4fe0c6 100644 --- a/assets/js/180d0c5f.4e42472e.js +++ b/assets/js/180d0c5f.da98afd2.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[51499],{21101:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>c,contentTitle:()=>r,default:()=>l,frontMatter:()=>o,metadata:()=>a,toc:()=>h});var i=t(24246),s=t(71670);const o={},r="Interface: AuthenticationSessionsChangeEvent",a={id:"interfaces/AuthenticationSessionsChangeEvent",title:"Interface: AuthenticationSessionsChangeEvent",description:"An event which fires when an AuthenticationSession is added, removed, or changed.",source:"@site/api/interfaces/AuthenticationSessionsChangeEvent.md",sourceDirName:"interfaces",slug:"/interfaces/AuthenticationSessionsChangeEvent",permalink:"/api/interfaces/AuthenticationSessionsChangeEvent",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"AuthenticationSessionAccountInformation",permalink:"/api/interfaces/AuthenticationSessionAccountInformation"},next:{title:"BlkioStatEntry",permalink:"/api/interfaces/BlkioStatEntry"}},c={},h=[{value:"Properties",id:"properties",level:2},{value:"provider",id:"provider",level:3},{value:"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",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"interface-authenticationsessionschangeevent",children:"Interface: AuthenticationSessionsChangeEvent"}),"\n",(0,i.jsxs)(n.p,{children:["An ",(0,i.jsx)(n.a,{href:"#Event",children:"event"})," which fires when an ",(0,i.jsx)(n.a,{href:"#AuthenticationSession",children:"AuthenticationSession"})," is added, removed, or changed."]}),"\n",(0,i.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(n.h3,{id:"provider",children:"provider"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"readonly"})," ",(0,i.jsx)(n.strong,{children:"provider"}),": ",(0,i.jsx)(n.a,{href:"/api/interfaces/AuthenticationProviderInformation",children:(0,i.jsx)(n.code,{children:"AuthenticationProviderInformation"})})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["The ",(0,i.jsx)(n.a,{href:"#AuthenticationProvider",children:"authenticationProvider"})," that has had its sessions change."]}),"\n",(0,i.jsx)(n.h4,{id:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L3793",children:"packages/extension-api/src/extension-api.d.ts:3793"})})]})}function l(e={}){const{wrapper:n}={...(0,s.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(d,{...e})}):d(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>a,a:()=>r});var i=t(27378);const s={},o=i.createContext(s);function r(e){const n=i.useContext(o);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function a(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:r(e.components),i.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[51499],{21101:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>c,contentTitle:()=>r,default:()=>l,frontMatter:()=>o,metadata:()=>a,toc:()=>d});var i=t(24246),s=t(71670);const o={},r="Interface: AuthenticationSessionsChangeEvent",a={id:"interfaces/AuthenticationSessionsChangeEvent",title:"Interface: AuthenticationSessionsChangeEvent",description:"An event which fires when an AuthenticationSession is added, removed, or changed.",source:"@site/api/interfaces/AuthenticationSessionsChangeEvent.md",sourceDirName:"interfaces",slug:"/interfaces/AuthenticationSessionsChangeEvent",permalink:"/api/interfaces/AuthenticationSessionsChangeEvent",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"AuthenticationSessionAccountInformation",permalink:"/api/interfaces/AuthenticationSessionAccountInformation"},next:{title:"BlkioStatEntry",permalink:"/api/interfaces/BlkioStatEntry"}},c={},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",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"interface-authenticationsessionschangeevent",children:"Interface: AuthenticationSessionsChangeEvent"}),"\n",(0,i.jsxs)(n.p,{children:["An ",(0,i.jsx)(n.a,{href:"#Event",children:"event"})," which fires when an ",(0,i.jsx)(n.a,{href:"#AuthenticationSession",children:"AuthenticationSession"})," is added, removed, or changed."]}),"\n",(0,i.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(n.h3,{id:"provider",children:"provider"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"readonly"})," ",(0,i.jsx)(n.strong,{children:"provider"}),": ",(0,i.jsx)(n.a,{href:"/api/interfaces/AuthenticationProviderInformation",children:(0,i.jsx)(n.code,{children:"AuthenticationProviderInformation"})})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["The ",(0,i.jsx)(n.a,{href:"#AuthenticationProvider",children:"authenticationProvider"})," that has had its sessions change."]}),"\n",(0,i.jsx)(n.h4,{id:"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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L3793",children:"packages/extension-api/src/extension-api.d.ts:3793"})})]})}function l(e={}){const{wrapper:n}={...(0,s.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(h,{...e})}):h(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>a,a:()=>r});var i=t(27378);const s={},o=i.createContext(s);function r(e){const n=i.useContext(o);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function a(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:r(e.components),i.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/185c52e7.02144c17.js b/assets/js/185c52e7.55a33813.js similarity index 80% rename from assets/js/185c52e7.02144c17.js rename to assets/js/185c52e7.55a33813.js index 48a34443e9e..f9c3390de6a 100644 --- a/assets/js/185c52e7.02144c17.js +++ b/assets/js/185c52e7.55a33813.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[90051],{36918:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>c,contentTitle:()=>r,default:()=>p,frontMatter:()=>d,metadata:()=>o,toc:()=>a});var s=i(24246),t=i(71670);const d={},r="Interface: VolumeCreateResponseInfo",o={id:"interfaces/VolumeCreateResponseInfo",title:"Interface: VolumeCreateResponseInfo",description:"Properties",source:"@site/api/interfaces/VolumeCreateResponseInfo.md",sourceDirName:"interfaces",slug:"/interfaces/VolumeCreateResponseInfo",permalink:"/api/interfaces/VolumeCreateResponseInfo",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"VolumeCreateOptions",permalink:"/api/interfaces/VolumeCreateOptions"},next:{title:"VolumeDeleteOptions",permalink:"/api/interfaces/VolumeDeleteOptions"}},c={},a=[{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",hr:"hr",p:"p",strong:"strong",...(0,t.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"interface-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/804b2198fda0957e1ecfb87539f019eb9b79a66f/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:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L3417",children:"packages/extension-api/src/extension-api.d.ts:3417"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L3421",children:"packages/extension-api/src/extension-api.d.ts:3421"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/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:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L3416",children:"packages/extension-api/src/extension-api.d.ts:3416"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L3422",children:"packages/extension-api/src/extension-api.d.ts:3422"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L3420",children:"packages/extension-api/src/extension-api.d.ts:3420"})})]})}function p(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>o,a:()=>r});var s=i(27378);const t={},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([[90051],{36918:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>o,contentTitle:()=>r,default:()=>p,frontMatter:()=>t,metadata:()=>c,toc:()=>a});var s=i(24246),d=i(71670);const t={},r="Interface: VolumeCreateResponseInfo",c={id:"interfaces/VolumeCreateResponseInfo",title:"Interface: VolumeCreateResponseInfo",description:"Properties",source:"@site/api/interfaces/VolumeCreateResponseInfo.md",sourceDirName:"interfaces",slug:"/interfaces/VolumeCreateResponseInfo",permalink:"/api/interfaces/VolumeCreateResponseInfo",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"VolumeCreateOptions",permalink:"/api/interfaces/VolumeCreateOptions"},next:{title:"VolumeDeleteOptions",permalink:"/api/interfaces/VolumeDeleteOptions"}},o={},a=[{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",hr:"hr",p:"p",strong:"strong",...(0,d.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{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/bd83a8b2bb8ab886dc757381b589638cbda150d0/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:"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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L3417",children:"packages/extension-api/src/extension-api.d.ts:3417"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L3421",children:"packages/extension-api/src/extension-api.d.ts:3421"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/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:"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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L3416",children:"packages/extension-api/src/extension-api.d.ts:3416"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L3422",children:"packages/extension-api/src/extension-api.d.ts:3422"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L3420",children:"packages/extension-api/src/extension-api.d.ts:3420"})})]})}function p(e={}){const{wrapper:n}={...(0,d.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>c,a:()=>r});var s=i(27378);const 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 diff --git a/assets/js/19e69ccd.f6c4b88d.js b/assets/js/19e69ccd.0a7f4a02.js similarity index 82% rename from assets/js/19e69ccd.f6c4b88d.js rename to assets/js/19e69ccd.0a7f4a02.js index 963e3b21234..2cf809a4fe7 100644 --- a/assets/js/19e69ccd.f6c4b88d.js +++ b/assets/js/19e69ccd.0a7f4a02.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[76091],{56826:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>d,contentTitle:()=>c,default:()=>p,frontMatter:()=>a,metadata:()=>r,toc:()=>o});var i=s(24246),t=s(71670);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",hr:"hr",p:"p",strong:"strong",...(0,t.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"interface-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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L3146",children:"packages/extension-api/src/extension-api.d.ts:3146"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L3148",children:"packages/extension-api/src/extension-api.d.ts:3148"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L3147",children:"packages/extension-api/src/extension-api.d.ts:3147"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L3149",children:"packages/extension-api/src/extension-api.d.ts:3149"})})]})}function p(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>r,a:()=>c});var i=s(27378);const t={},a=i.createContext(t);function c(e){const n=i.useContext(a);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function r(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:c(e.components),i.createElement(a.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[76091],{56826:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>r,contentTitle:()=>c,default:()=>p,frontMatter:()=>a,metadata:()=>d,toc:()=>o});var i=s(24246),t=s(71670);const a={},c="Interface: CPUStats",d={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"}},r={},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",hr:"hr",p:"p",strong:"strong",...(0,t.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"interface-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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L3146",children:"packages/extension-api/src/extension-api.d.ts:3146"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L3148",children:"packages/extension-api/src/extension-api.d.ts:3148"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L3147",children:"packages/extension-api/src/extension-api.d.ts:3147"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L3149",children:"packages/extension-api/src/extension-api.d.ts:3149"})})]})}function p(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>d,a:()=>c});var i=s(27378);const t={},a=i.createContext(t);function c(e){const n=i.useContext(a);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function d(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.9eb4e740.js b/assets/js/1a906644.1d4921e9.js similarity index 96% rename from assets/js/1a906644.9eb4e740.js rename to assets/js/1a906644.1d4921e9.js index a023014cd34..a6917a15aa3 100644 --- a/assets/js/1a906644.9eb4e740.js +++ b/assets/js/1a906644.1d4921e9.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[52525],{67681:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>o,contentTitle:()=>c,default:()=>p,frontMatter:()=>r,metadata:()=>a,toc:()=>d});var i=t(24246),s=t(71670);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",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{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/804b2198fda0957e1ecfb87539f019eb9b79a66f/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,s.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>a,a:()=>c});var i=t(27378);const s={},r=i.createContext(s);function c(e){const n=i.useContext(r);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function a(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:c(e.components),i.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[52525],{67681:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>o,contentTitle:()=>c,default:()=>p,frontMatter:()=>r,metadata:()=>a,toc:()=>d});var i=t(24246),s=t(71670);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",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{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/bd83a8b2bb8ab886dc757381b589638cbda150d0/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,s.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>a,a:()=>c});var i=t(27378);const s={},r=i.createContext(s);function c(e){const n=i.useContext(r);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function a(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:c(e.components),i.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/1dfee34e.e49e0d91.js b/assets/js/1dfee34e.9b7b44e5.js similarity index 83% rename from assets/js/1dfee34e.e49e0d91.js rename to assets/js/1dfee34e.9b7b44e5.js index fb4012ecdbf..24444654f8f 100644 --- a/assets/js/1dfee34e.e49e0d91.js +++ b/assets/js/1dfee34e.9b7b44e5.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[15554],{93686:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>r,contentTitle:()=>t,default:()=>h,frontMatter:()=>c,metadata:()=>l,toc:()=>a});var i=s(24246),o=s(71670);const c={},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",hr:"hr",p:"p",strong:"strong",...(0,o.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L1075",children:"packages/extension-api/src/extension-api.d.ts:1075"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L1080",children:"packages/extension-api/src/extension-api.d.ts:1080"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L1085",children:"packages/extension-api/src/extension-api.d.ts:1085"})})]})}function h(e={}){const{wrapper:n}={...(0,o.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(d,{...e})}):d(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>l,a:()=>t});var i=s(27378);const o={},c=i.createContext(o);function t(e){const n=i.useContext(c);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function l(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:t(e.components),i.createElement(c.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[15554],{93686:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>r,contentTitle:()=>t,default:()=>h,frontMatter:()=>o,metadata:()=>l,toc:()=>a});var i=s(24246),c=s(71670);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",hr:"hr",p:"p",strong:"strong",...(0,c.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L1075",children:"packages/extension-api/src/extension-api.d.ts:1075"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L1080",children:"packages/extension-api/src/extension-api.d.ts:1080"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L1085",children:"packages/extension-api/src/extension-api.d.ts:1085"})})]})}function h(e={}){const{wrapper:n}={...(0,c.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(d,{...e})}):d(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>l,a:()=>t});var i=s(27378);const c={},o=i.createContext(c);function t(e){const n=i.useContext(o);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function 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.e06e9aa0.js b/assets/js/1ee92283.0d060cf7.js similarity index 88% rename from assets/js/1ee92283.e06e9aa0.js rename to assets/js/1ee92283.0d060cf7.js index 5edc5de3cce..7db69034fc2 100644 --- a/assets/js/1ee92283.e06e9aa0.js +++ b/assets/js/1ee92283.0d060cf7.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[65144],{4226:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>c,contentTitle:()=>t,default:()=>h,frontMatter:()=>d,metadata:()=>a,toc:()=>o});var s=i(24246),r=i(71670);const d={},t="Interface: Provider",a={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",hr:"hr",p:"p",strong:"strong",...(0,r.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"interface-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/804b2198fda0957e1ecfb87539f019eb9b79a66f/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:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L614",children:"packages/extension-api/src/extension-api.d.ts:614"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L624",children:"packages/extension-api/src/extension-api.d.ts:624"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/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:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/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:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L640",children:"packages/extension-api/src/extension-api.d.ts:640"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L617",children:"packages/extension-api/src/extension-api.d.ts:617"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L622",children:"packages/extension-api/src/extension-api.d.ts:622"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L615",children:"packages/extension-api/src/extension-api.d.ts:615"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/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:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L636",children:"packages/extension-api/src/extension-api.d.ts:636"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L612",children:"packages/extension-api/src/extension-api.d.ts:612"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L608",children:"packages/extension-api/src/extension-api.d.ts:608"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L610",children:"packages/extension-api/src/extension-api.d.ts:610"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L597",children:"packages/extension-api/src/extension-api.d.ts:597"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L602",children:"packages/extension-api/src/extension-api.d.ts:602"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L598",children:"packages/extension-api/src/extension-api.d.ts:598"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L599",children:"packages/extension-api/src/extension-api.d.ts:599"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L605",children:"packages/extension-api/src/extension-api.d.ts:605"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L588",children:"packages/extension-api/src/extension-api.d.ts:588"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L592",children:"packages/extension-api/src/extension-api.d.ts:592"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/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:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L616",children:"packages/extension-api/src/extension-api.d.ts:616"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L621",children:"packages/extension-api/src/extension-api.d.ts:621"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L637",children:"packages/extension-api/src/extension-api.d.ts:637"})})]})}function h(e={}){const{wrapper:n}={...(0,r.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>a,a:()=>t});var s=i(27378);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 a(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([[65144],{4226:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>t,contentTitle:()=>a,default:()=>h,frontMatter:()=>d,metadata:()=>c,toc:()=>o});var s=i(24246),r=i(71670);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",hr:"hr",p:"p",strong:"strong",...(0,r.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"interface-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/bd83a8b2bb8ab886dc757381b589638cbda150d0/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:"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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L614",children:"packages/extension-api/src/extension-api.d.ts:614"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L624",children:"packages/extension-api/src/extension-api.d.ts:624"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/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:"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/bd83a8b2bb8ab886dc757381b589638cbda150d0/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:"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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L640",children:"packages/extension-api/src/extension-api.d.ts:640"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L617",children:"packages/extension-api/src/extension-api.d.ts:617"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L622",children:"packages/extension-api/src/extension-api.d.ts:622"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L615",children:"packages/extension-api/src/extension-api.d.ts:615"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/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:"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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L636",children:"packages/extension-api/src/extension-api.d.ts:636"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L612",children:"packages/extension-api/src/extension-api.d.ts:612"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L608",children:"packages/extension-api/src/extension-api.d.ts:608"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L610",children:"packages/extension-api/src/extension-api.d.ts:610"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L597",children:"packages/extension-api/src/extension-api.d.ts:597"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L602",children:"packages/extension-api/src/extension-api.d.ts:602"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L598",children:"packages/extension-api/src/extension-api.d.ts:598"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L599",children:"packages/extension-api/src/extension-api.d.ts:599"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L605",children:"packages/extension-api/src/extension-api.d.ts:605"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L588",children:"packages/extension-api/src/extension-api.d.ts:588"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L592",children:"packages/extension-api/src/extension-api.d.ts:592"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/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:"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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L616",children:"packages/extension-api/src/extension-api.d.ts:616"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L621",children:"packages/extension-api/src/extension-api.d.ts:621"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L637",children:"packages/extension-api/src/extension-api.d.ts:637"})})]})}function h(e={}){const{wrapper:n}={...(0,r.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>c,a:()=>a});var s=i(27378);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.9a1d3298.js b/assets/js/1fbe0675.85b3feae.js similarity index 77% rename from assets/js/1fbe0675.9a1d3298.js rename to assets/js/1fbe0675.85b3feae.js index d44be34427f..03f81fcdc13 100644 --- a/assets/js/1fbe0675.9a1d3298.js +++ b/assets/js/1fbe0675.85b3feae.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[39613],{68579:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>o,contentTitle:()=>a,default:()=>h,frontMatter:()=>c,metadata:()=>i,toc:()=>l});var s=n(24246),r=n(71670);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",p:"p",strong:"strong",...(0,r.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(t.h1,{id:"function-createfilesystemwatcher",children:"Function: createFileSystemWatcher()"}),"\n",(0,s.jsxs)(t.blockquote,{children:["\n",(0,s.jsxs)(t.p,{children:[(0,s.jsx)(t.strong,{children:"createFileSystemWatcher"}),"(",(0,s.jsx)(t.code,{children:"path"}),"): ",(0,s.jsx)(t.a,{href:"/api/interfaces/FileSystemWatcher",children:(0,s.jsx)(t.code,{children:"FileSystemWatcher"})})]}),"\n"]}),"\n",(0,s.jsx)(t.h2,{id:"parameters",children:"Parameters"}),"\n",(0,s.jsxs)(t.p,{children:["\u2022 ",(0,s.jsx)(t.strong,{children:"path"}),": ",(0,s.jsx)(t.code,{children:"string"})]}),"\n",(0,s.jsx)(t.h2,{id:"returns",children:"Returns"}),"\n",(0,s.jsx)(t.p,{children:(0,s.jsx)(t.a,{href:"/api/interfaces/FileSystemWatcher",children:(0,s.jsx)(t.code,{children:"FileSystemWatcher"})})}),"\n",(0,s.jsx)(t.h2,{id:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L1657",children:"packages/extension-api/src/extension-api.d.ts:1657"})})]})}function h(e={}){const{wrapper:t}={...(0,r.a)(),...e.components};return t?(0,s.jsx)(t,{...e,children:(0,s.jsx)(d,{...e})}):d(e)}},71670:(e,t,n)=>{n.d(t,{Z:()=>i,a:()=>a});var s=n(27378);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([[39613],{68579:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>o,contentTitle:()=>a,default:()=>h,frontMatter:()=>r,metadata:()=>i,toc:()=>l});var s=n(24246),c=n(71670);const r={},a="Function: createFileSystemWatcher()",i={id:"namespaces/fs/functions/createFileSystemWatcher",title:"Function: createFileSystemWatcher()",description:"createFileSystemWatcher(path): FileSystemWatcher",source:"@site/api/namespaces/fs/functions/createFileSystemWatcher.md",sourceDirName:"namespaces/fs/functions",slug:"/namespaces/fs/functions/createFileSystemWatcher",permalink:"/api/namespaces/fs/functions/createFileSystemWatcher",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"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",p:"p",strong:"strong",...(0,c.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(t.h1,{id:"function-createfilesystemwatcher",children:"Function: createFileSystemWatcher()"}),"\n",(0,s.jsxs)(t.blockquote,{children:["\n",(0,s.jsxs)(t.p,{children:[(0,s.jsx)(t.strong,{children:"createFileSystemWatcher"}),"(",(0,s.jsx)(t.code,{children:"path"}),"): ",(0,s.jsx)(t.a,{href:"/api/interfaces/FileSystemWatcher",children:(0,s.jsx)(t.code,{children:"FileSystemWatcher"})})]}),"\n"]}),"\n",(0,s.jsx)(t.h2,{id:"parameters",children:"Parameters"}),"\n",(0,s.jsxs)(t.p,{children:["\u2022 ",(0,s.jsx)(t.strong,{children:"path"}),": ",(0,s.jsx)(t.code,{children:"string"})]}),"\n",(0,s.jsx)(t.h2,{id:"returns",children:"Returns"}),"\n",(0,s.jsx)(t.p,{children:(0,s.jsx)(t.a,{href:"/api/interfaces/FileSystemWatcher",children:(0,s.jsx)(t.code,{children:"FileSystemWatcher"})})}),"\n",(0,s.jsx)(t.h2,{id:"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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L1657",children:"packages/extension-api/src/extension-api.d.ts:1657"})})]})}function h(e={}){const{wrapper:t}={...(0,c.a)(),...e.components};return t?(0,s.jsx)(t,{...e,children:(0,s.jsx)(d,{...e})}):d(e)}},71670:(e,t,n)=>{n.d(t,{Z:()=>i,a:()=>a});var s=n(27378);const c={},r=s.createContext(c);function a(e){const t=s.useContext(r);return s.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function i(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(c):e.components||c:a(e.components),s.createElement(r.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/1fc83a28.b1603d0d.js b/assets/js/1fc83a28.92e11025.js similarity index 84% rename from assets/js/1fc83a28.b1603d0d.js rename to assets/js/1fc83a28.92e11025.js index 53459969a97..1d4a3a77138 100644 --- a/assets/js/1fc83a28.b1603d0d.js +++ b/assets/js/1fc83a28.92e11025.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[70633],{9146:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>a,contentTitle:()=>o,default:()=>l,frontMatter:()=>c,metadata:()=>r,toc:()=>d});var s=i(24246),t=i(71670);const c={},o="Interface: AuthenticationSession",r={id:"interfaces/AuthenticationSession",title:"Interface: AuthenticationSession",description:"Represents a session of a currently logged in user.",source:"@site/api/interfaces/AuthenticationSession.md",sourceDirName:"interfaces",slug:"/interfaces/AuthenticationSession",permalink:"/api/interfaces/AuthenticationSession",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"AuthenticationProviderOptions",permalink:"/api/interfaces/AuthenticationProviderOptions"},next:{title:"AuthenticationSessionAccountInformation",permalink:"/api/interfaces/AuthenticationSessionAccountInformation"}},a={},d=[{value:"Properties",id:"properties",level:2},{value:"accessToken",id:"accesstoken",level:3},{value:"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",hr:"hr",p:"p",strong:"strong",...(0,t.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"interface-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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L3687",children:"packages/extension-api/src/extension-api.d.ts:3687"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L3692",children:"packages/extension-api/src/extension-api.d.ts:3692"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L3682",children:"packages/extension-api/src/extension-api.d.ts:3682"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L3698",children:"packages/extension-api/src/extension-api.d.ts:3698"})})]})}function l(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(h,{...e})}):h(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>r,a:()=>o});var s=i(27378);const t={},c=s.createContext(t);function o(e){const n=s.useContext(c);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function r(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:o(e.components),s.createElement(c.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[70633],{9146:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>r,contentTitle:()=>o,default:()=>l,frontMatter:()=>c,metadata:()=>d,toc:()=>a});var s=i(24246),t=i(71670);const c={},o="Interface: AuthenticationSession",d={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"}},r={},a=[{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",hr:"hr",p:"p",strong:"strong",...(0,t.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"interface-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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L3687",children:"packages/extension-api/src/extension-api.d.ts:3687"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L3692",children:"packages/extension-api/src/extension-api.d.ts:3692"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L3682",children:"packages/extension-api/src/extension-api.d.ts:3682"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L3698",children:"packages/extension-api/src/extension-api.d.ts:3698"})})]})}function l(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(h,{...e})}):h(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>d,a:()=>o});var s=i(27378);const t={},c=s.createContext(t);function o(e){const n=s.useContext(c);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function d(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.e20a2df7.js b/assets/js/22e2140b.7315a161.js similarity index 98% rename from assets/js/22e2140b.e20a2df7.js rename to assets/js/22e2140b.7315a161.js index 88f17a8836c..7f7a63a34ff 100644 --- a/assets/js/22e2140b.e20a2df7.js +++ b/assets/js/22e2140b.7315a161.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[24260],{47227:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>d,contentTitle:()=>a,default:()=>h,frontMatter:()=>s,metadata:()=>o,toc:()=>c});var t=r(24246),i=r(71670);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",p:"p",pre:"pre",strong:"strong",...(0,i.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{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/804b2198fda0957e1ecfb87539f019eb9b79a66f/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.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},71670:(e,n,r)=>{r.d(n,{Z:()=>o,a:()=>a});var t=r(27378);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([[24260],{47227:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>d,contentTitle:()=>a,default:()=>h,frontMatter:()=>s,metadata:()=>o,toc:()=>c});var t=r(24246),i=r(71670);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",p:"p",pre:"pre",strong:"strong",...(0,i.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{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/bd83a8b2bb8ab886dc757381b589638cbda150d0/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.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},71670:(e,n,r)=>{r.d(n,{Z:()=>o,a:()=>a});var t=r(27378);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.91eeef42.js b/assets/js/2340b3ee.a32df5be.js similarity index 91% rename from assets/js/2340b3ee.91eeef42.js rename to assets/js/2340b3ee.a32df5be.js index caed3629f95..124701cc552 100644 --- a/assets/js/2340b3ee.91eeef42.js +++ b/assets/js/2340b3ee.a32df5be.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[20205],{37099:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>a,contentTitle:()=>i,default:()=>p,frontMatter:()=>t,metadata:()=>o,toc:()=>d});var r=s(24246),c=s(71670);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/"}},a={},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 l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,c.a)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.h1,{id:"function-exec",children:"Function: exec()"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"exec"}),"(",(0,r.jsx)(n.code,{children:"command"}),", ",(0,r.jsx)(n.code,{children:"args"}),"?, ",(0,r.jsx)(n.code,{children:"options"}),"?): ",(0,r.jsx)(n.code,{children:"Promise"}),"<",(0,r.jsx)(n.a,{href:"/api/interfaces/RunResult",children:(0,r.jsx)(n.code,{children:"RunResult"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"Executes the provided command and returns an object containing the exit code,\nstdout, and stderr content."}),"\n",(0,r.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"command"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n",(0,r.jsx)(n.p,{children:"The command to execute."}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"args?"}),": ",(0,r.jsx)(n.code,{children:"string"}),"[]"]}),"\n",(0,r.jsx)(n.p,{children:"The command arguments."}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"options?"}),": ",(0,r.jsx)(n.a,{href:"/api/interfaces/RunOptions",children:(0,r.jsx)(n.code,{children:"RunOptions"})})]}),"\n",(0,r.jsx)(n.p,{children:"Options, such as environment variables."}),"\n",(0,r.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"Promise"}),"<",(0,r.jsx)(n.a,{href:"/api/interfaces/RunResult",children:(0,r.jsx)(n.code,{children:"RunResult"})}),">"]}),"\n",(0,r.jsx)(n.p,{children:"A promise that resolves to a RunResult object."}),"\n",(0,r.jsx)(n.h2,{id:"throws",children:"Throws"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.a,{href:"/api/interfaces/RunError",children:"RunError"})," if provided command can not be executed."]}),"\n",(0,r.jsx)(n.h2,{id:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L4114",children:"packages/extension-api/src/extension-api.d.ts:4114"})})]})}function p(e={}){const{wrapper:n}={...(0,c.a)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(l,{...e})}):l(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>o,a:()=>i});var r=s(27378);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([[20205],{37099:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>d,contentTitle:()=>i,default:()=>p,frontMatter:()=>t,metadata:()=>o,toc:()=>a});var r=s(24246),c=s(71670);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",p:"p",strong:"strong",...(0,c.a)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.h1,{id:"function-exec",children:"Function: exec()"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"exec"}),"(",(0,r.jsx)(n.code,{children:"command"}),", ",(0,r.jsx)(n.code,{children:"args"}),"?, ",(0,r.jsx)(n.code,{children:"options"}),"?): ",(0,r.jsx)(n.code,{children:"Promise"}),"<",(0,r.jsx)(n.a,{href:"/api/interfaces/RunResult",children:(0,r.jsx)(n.code,{children:"RunResult"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"Executes the provided command and returns an object containing the exit code,\nstdout, and stderr content."}),"\n",(0,r.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"command"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n",(0,r.jsx)(n.p,{children:"The command to execute."}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"args?"}),": ",(0,r.jsx)(n.code,{children:"string"}),"[]"]}),"\n",(0,r.jsx)(n.p,{children:"The command arguments."}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"options?"}),": ",(0,r.jsx)(n.a,{href:"/api/interfaces/RunOptions",children:(0,r.jsx)(n.code,{children:"RunOptions"})})]}),"\n",(0,r.jsx)(n.p,{children:"Options, such as environment variables."}),"\n",(0,r.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"Promise"}),"<",(0,r.jsx)(n.a,{href:"/api/interfaces/RunResult",children:(0,r.jsx)(n.code,{children:"RunResult"})}),">"]}),"\n",(0,r.jsx)(n.p,{children:"A promise that resolves to a RunResult object."}),"\n",(0,r.jsx)(n.h2,{id:"throws",children:"Throws"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.a,{href:"/api/interfaces/RunError",children:"RunError"})," if provided command can not be executed."]}),"\n",(0,r.jsx)(n.h2,{id:"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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L4114",children:"packages/extension-api/src/extension-api.d.ts:4114"})})]})}function p(e={}){const{wrapper:n}={...(0,c.a)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(l,{...e})}):l(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>o,a:()=>i});var r=s(27378);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.9e6b8c5e.js b/assets/js/23a8e291.4532fe7a.js similarity index 94% rename from assets/js/23a8e291.9e6b8c5e.js rename to assets/js/23a8e291.4532fe7a.js index 78e8c4b5d08..16a6114b395 100644 --- a/assets/js/23a8e291.9e6b8c5e.js +++ b/assets/js/23a8e291.4532fe7a.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[43274],{87634:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>a,contentTitle:()=>r,default:()=>f,frontMatter:()=>s,metadata:()=>c,toc:()=>d});var t=i(24246),o=i(71670);const s={},r="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",p:"p",strong:"strong",...(0,o.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L995",children:"packages/extension-api/src/extension-api.d.ts:995"})})]})}function f(e={}){const{wrapper:n}={...(0,o.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(h,{...e})}):h(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>c,a:()=>r});var t=i(27378);const 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([[43274],{87634:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>a,contentTitle:()=>r,default:()=>l,frontMatter:()=>s,metadata:()=>c,toc:()=>d});var t=i(24246),o=i(71670);const s={},r="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",p:"p",strong:"strong",...(0,o.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L995",children:"packages/extension-api/src/extension-api.d.ts:995"})})]})}function l(e={}){const{wrapper:n}={...(0,o.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(h,{...e})}):h(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>c,a:()=>r});var t=i(27378);const 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/24dadce3.1cbdd028.js b/assets/js/24dadce3.2336fe8c.js similarity index 91% rename from assets/js/24dadce3.1cbdd028.js rename to assets/js/24dadce3.2336fe8c.js index 8a92637ae41..41c9c599af7 100644 --- a/assets/js/24dadce3.1cbdd028.js +++ b/assets/js/24dadce3.2336fe8c.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[70595],{30172:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>o,default:()=>f,frontMatter:()=>c,metadata:()=>s,toc:()=>l});var i=t(24246),r=t(71670);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",p:"p",strong:"strong",...(0,r.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{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/804b2198fda0957e1ecfb87539f019eb9b79a66f/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.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(d,{...e})}):d(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>s,a:()=>o});var i=t(27378);const r={},c=i.createContext(r);function o(e){const n=i.useContext(c);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function 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([[70595],{30172:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>o,default:()=>p,frontMatter:()=>c,metadata:()=>s,toc:()=>l});var i=t(24246),r=t(71670);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",p:"p",strong:"strong",...(0,r.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{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/bd83a8b2bb8ab886dc757381b589638cbda150d0/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.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(d,{...e})}):d(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>s,a:()=>o});var i=t(27378);const r={},c=i.createContext(r);function o(e){const n=i.useContext(c);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function 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.1e4ed3ed.js b/assets/js/254d0ff5.4205c849.js similarity index 91% rename from assets/js/254d0ff5.1e4ed3ed.js rename to assets/js/254d0ff5.4205c849.js index ae066ef8637..1f5c24ef991 100644 --- a/assets/js/254d0ff5.1e4ed3ed.js +++ b/assets/js/254d0ff5.4205c849.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[60810],{37340:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>d,contentTitle:()=>s,default:()=>p,frontMatter:()=>t,metadata:()=>c,toc:()=>a});var r=i(24246),o=i(71670);const t={},s="Interface: ProviderImages",c={id:"interfaces/ProviderImages",title:"Interface: ProviderImages",description:"Properties",source:"@site/api/interfaces/ProviderImages.md",sourceDirName:"interfaces",slug:"/interfaces/ProviderImages",permalink:"/api/interfaces/ProviderImages",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"ProviderEvent",permalink:"/api/interfaces/ProviderEvent"},next:{title:"ProviderInformation",permalink:"/api/interfaces/ProviderInformation"}},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",hr:"hr",p:"p",strong:"strong",...(0,o.a)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.h1,{id:"interface-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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L583",children:"packages/extension-api/src/extension-api.d.ts:583"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L584",children:"packages/extension-api/src/extension-api.d.ts:584"})})]})}function p(e={}){const{wrapper:n}={...(0,o.a)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(l,{...e})}):l(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>c,a:()=>s});var r=i(27378);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([[60810],{37340:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>d,contentTitle:()=>s,default:()=>p,frontMatter:()=>t,metadata:()=>c,toc:()=>a});var r=i(24246),o=i(71670);const t={},s="Interface: ProviderImages",c={id:"interfaces/ProviderImages",title:"Interface: ProviderImages",description:"Properties",source:"@site/api/interfaces/ProviderImages.md",sourceDirName:"interfaces",slug:"/interfaces/ProviderImages",permalink:"/api/interfaces/ProviderImages",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"ProviderEvent",permalink:"/api/interfaces/ProviderEvent"},next:{title:"ProviderInformation",permalink:"/api/interfaces/ProviderInformation"}},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",hr:"hr",p:"p",strong:"strong",...(0,o.a)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.h1,{id:"interface-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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L583",children:"packages/extension-api/src/extension-api.d.ts:583"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L584",children:"packages/extension-api/src/extension-api.d.ts:584"})})]})}function p(e={}){const{wrapper:n}={...(0,o.a)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(l,{...e})}):l(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>c,a:()=>s});var r=i(27378);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.48b5df45.js b/assets/js/271ff0d1.936d03da.js similarity index 96% rename from assets/js/271ff0d1.48b5df45.js rename to assets/js/271ff0d1.936d03da.js index 3a7a73d3769..2a302e29e60 100644 --- a/assets/js/271ff0d1.48b5df45.js +++ b/assets/js/271ff0d1.936d03da.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[86335],{89714:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>a,contentTitle:()=>c,default:()=>p,frontMatter:()=>t,metadata:()=>r,toc:()=>d});var i=s(24246),o=s(71670);const t={},c="Function: showOpenDialog()",r={id:"namespaces/window/functions/showOpenDialog",title:"Function: showOpenDialog()",description:"showOpenDialog(options?): Promise\\",source:"@site/api/namespaces/window/functions/showOpenDialog.md",sourceDirName:"namespaces/window/functions",slug:"/namespaces/window/functions/showOpenDialog",permalink:"/api/namespaces/window/functions/showOpenDialog",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"showNotification",permalink:"/api/namespaces/window/functions/showNotification"},next:{title:"showQuickPick",permalink:"/api/namespaces/window/functions/showQuickPick"}},a={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Defined in",id:"defined-in",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,o.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L1993",children:"packages/extension-api/src/extension-api.d.ts:1993"})})]})}function p(e={}){const{wrapper:n}={...(0,o.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>r,a:()=>c});var i=s(27378);const o={},t=i.createContext(o);function c(e){const n=i.useContext(t);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function r(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:c(e.components),i.createElement(t.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[86335],{89714:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>a,contentTitle:()=>c,default:()=>p,frontMatter:()=>t,metadata:()=>r,toc:()=>d});var i=s(24246),o=s(71670);const t={},c="Function: showOpenDialog()",r={id:"namespaces/window/functions/showOpenDialog",title:"Function: showOpenDialog()",description:"showOpenDialog(options?): Promise\\",source:"@site/api/namespaces/window/functions/showOpenDialog.md",sourceDirName:"namespaces/window/functions",slug:"/namespaces/window/functions/showOpenDialog",permalink:"/api/namespaces/window/functions/showOpenDialog",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"showNotification",permalink:"/api/namespaces/window/functions/showNotification"},next:{title:"showQuickPick",permalink:"/api/namespaces/window/functions/showQuickPick"}},a={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Defined in",id:"defined-in",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,o.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L1993",children:"packages/extension-api/src/extension-api.d.ts:1993"})})]})}function p(e={}){const{wrapper:n}={...(0,o.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>r,a:()=>c});var i=s(27378);const o={},t=i.createContext(o);function c(e){const n=i.useContext(t);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function r(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:c(e.components),i.createElement(t.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/280646e4.30b1d368.js b/assets/js/280646e4.60afcc63.js similarity index 79% rename from assets/js/280646e4.30b1d368.js rename to assets/js/280646e4.60afcc63.js index e5e5e83612a..c0b1e6ddedc 100644 --- a/assets/js/280646e4.30b1d368.js +++ b/assets/js/280646e4.60afcc63.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[24726],{11024:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>l,contentTitle:()=>c,default:()=>d,frontMatter:()=>a,metadata:()=>r,toc:()=>h});var s=t(24246),i=t(71670);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",hr:"hr",p:"p",strong:"strong",...(0,i.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"interface-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/804b2198fda0957e1ecfb87539f019eb9b79a66f/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:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/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:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L2489",children:"packages/extension-api/src/extension-api.d.ts:2489"})})]})}function d(e={}){const{wrapper:n}={...(0,i.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(o,{...e})}):o(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>r,a:()=>c});var s=t(27378);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 +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[24726],{11024:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>l,contentTitle:()=>c,default:()=>o,frontMatter:()=>a,metadata:()=>r,toc:()=>d});var s=t(24246),i=t(71670);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={},d=[{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 h(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,i.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{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/bd83a8b2bb8ab886dc757381b589638cbda150d0/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:"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/bd83a8b2bb8ab886dc757381b589638cbda150d0/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:"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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2489",children:"packages/extension-api/src/extension-api.d.ts:2489"})})]})}function o(e={}){const{wrapper:n}={...(0,i.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(h,{...e})}):h(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>r,a:()=>c});var s=t(27378);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.5a617c15.js b/assets/js/2bb2c1cd.0a8a3b0b.js similarity index 88% rename from assets/js/2bb2c1cd.5a617c15.js rename to assets/js/2bb2c1cd.0a8a3b0b.js index 57e917e0d82..1d8032011af 100644 --- a/assets/js/2bb2c1cd.5a617c15.js +++ b/assets/js/2bb2c1cd.0a8a3b0b.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[74340],{8108:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>a,contentTitle:()=>s,default:()=>l,frontMatter:()=>r,metadata:()=>c,toc:()=>d});var t=i(24246),o=i(71670);const r={},s="Interface: NetworkingConfig",c={id:"interfaces/NetworkingConfig",title:"Interface: NetworkingConfig",description:"Properties",source:"@site/api/interfaces/NetworkingConfig.md",sourceDirName:"interfaces",slug:"/interfaces/NetworkingConfig",permalink:"/api/interfaces/NetworkingConfig",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"NetworkStats",permalink:"/api/interfaces/NetworkStats"},next:{title:"NotificationOptions",permalink:"/api/interfaces/NotificationOptions"}},a={},d=[{value:"Properties",id:"properties",level:2},{value:"EndpointsConfig?",id:"endpointsconfig",level:3},{value:"Index Signature",id:"index-signature",level:4},{value:"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",p:"p",strong:"strong",...(0,o.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L2816",children:"packages/extension-api/src/extension-api.d.ts:2816"})})]})}function l(e={}){const{wrapper:n}={...(0,o.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(p,{...e})}):p(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>c,a:()=>s});var t=i(27378);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([[74340],{8108:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>d,contentTitle:()=>s,default:()=>l,frontMatter:()=>r,metadata:()=>c,toc:()=>a});var t=i(24246),o=i(71670);const r={},s="Interface: NetworkingConfig",c={id:"interfaces/NetworkingConfig",title:"Interface: NetworkingConfig",description:"Properties",source:"@site/api/interfaces/NetworkingConfig.md",sourceDirName:"interfaces",slug:"/interfaces/NetworkingConfig",permalink:"/api/interfaces/NetworkingConfig",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"NetworkStats",permalink:"/api/interfaces/NetworkStats"},next:{title:"NotificationOptions",permalink:"/api/interfaces/NotificationOptions"}},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",p:"p",strong:"strong",...(0,o.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2816",children:"packages/extension-api/src/extension-api.d.ts:2816"})})]})}function l(e={}){const{wrapper:n}={...(0,o.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(p,{...e})}):p(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>c,a:()=>s});var t=i(27378);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.b228ef90.js b/assets/js/2cb13d6d.a5460e4a.js similarity index 86% rename from assets/js/2cb13d6d.b228ef90.js rename to assets/js/2cb13d6d.a5460e4a.js index 33ff9ed2b8d..eeca7e50f1a 100644 --- a/assets/js/2cb13d6d.b228ef90.js +++ b/assets/js/2cb13d6d.a5460e4a.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[86528],{69729:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>c,contentTitle:()=>o,default:()=>p,frontMatter:()=>r,metadata:()=>a,toc:()=>d});var t=i(24246),s=i(71670);const r={},o="Interface: BlkioStatEntry",a={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",hr:"hr",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"interface-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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L3049",children:"packages/extension-api/src/extension-api.d.ts:3049"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L3050",children:"packages/extension-api/src/extension-api.d.ts:3050"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L3051",children:"packages/extension-api/src/extension-api.d.ts:3051"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L3052",children:"packages/extension-api/src/extension-api.d.ts:3052"})})]})}function p(e={}){const{wrapper:n}={...(0,s.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>a,a:()=>o});var t=i(27378);const s={},r=t.createContext(s);function o(e){const n=t.useContext(r);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function 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([[86528],{69729:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>d,contentTitle:()=>o,default:()=>p,frontMatter:()=>r,metadata:()=>a,toc:()=>c});var t=i(24246),s=i(71670);const r={},o="Interface: BlkioStatEntry",a={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",hr:"hr",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"interface-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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L3049",children:"packages/extension-api/src/extension-api.d.ts:3049"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L3050",children:"packages/extension-api/src/extension-api.d.ts:3050"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L3051",children:"packages/extension-api/src/extension-api.d.ts:3051"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L3052",children:"packages/extension-api/src/extension-api.d.ts:3052"})})]})}function p(e={}){const{wrapper:n}={...(0,s.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>a,a:()=>o});var t=i(27378);const s={},r=t.createContext(s);function o(e){const n=t.useContext(r);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function 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/30a9912a.a0ed2fc1.js b/assets/js/30a9912a.4ba520a7.js similarity index 94% rename from assets/js/30a9912a.a0ed2fc1.js rename to assets/js/30a9912a.4ba520a7.js index 85455f944ee..894cfce94d4 100644 --- a/assets/js/30a9912a.a0ed2fc1.js +++ b/assets/js/30a9912a.4ba520a7.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[10014],{73515:(e,i,s)=>{s.r(i),s.d(i,{assets:()=>c,contentTitle:()=>a,default:()=>h,frontMatter:()=>d,metadata:()=>l,toc:()=>t});var n=s(24246),r=s(71670);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",hr:"hr",li:"li",p:"p",strong:"strong",ul:"ul",...(0,r.a)(),...e.components};return(0,n.jsxs)(n.Fragment,{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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L788",children:"packages/extension-api/src/extension-api.d.ts:788"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L784",children:"packages/extension-api/src/extension-api.d.ts:784"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L802",children:"packages/extension-api/src/extension-api.d.ts:802"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L792",children:"packages/extension-api/src/extension-api.d.ts:792"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L797",children:"packages/extension-api/src/extension-api.d.ts:797"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/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.a)(),...e.components};return i?(0,n.jsx)(i,{...e,children:(0,n.jsx)(o,{...e})}):o(e)}},71670:(e,i,s)=>{s.d(i,{Z:()=>l,a:()=>a});var n=s(27378);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([[10014],{73515:(e,i,s)=>{s.r(i),s.d(i,{assets:()=>c,contentTitle:()=>a,default:()=>h,frontMatter:()=>d,metadata:()=>l,toc:()=>t});var n=s(24246),r=s(71670);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",hr:"hr",li:"li",p:"p",strong:"strong",ul:"ul",...(0,r.a)(),...e.components};return(0,n.jsxs)(n.Fragment,{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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L788",children:"packages/extension-api/src/extension-api.d.ts:788"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L784",children:"packages/extension-api/src/extension-api.d.ts:784"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L802",children:"packages/extension-api/src/extension-api.d.ts:802"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L792",children:"packages/extension-api/src/extension-api.d.ts:792"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L797",children:"packages/extension-api/src/extension-api.d.ts:797"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/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.a)(),...e.components};return i?(0,n.jsx)(i,{...e,children:(0,n.jsx)(o,{...e})}):o(e)}},71670:(e,i,s)=>{s.d(i,{Z:()=>l,a:()=>a});var n=s(27378);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.06282814.js b/assets/js/3109d9d2.102ae179.js similarity index 96% rename from assets/js/3109d9d2.06282814.js rename to assets/js/3109d9d2.102ae179.js index bebf5d342c6..ea6c6cd65c5 100644 --- a/assets/js/3109d9d2.06282814.js +++ b/assets/js/3109d9d2.102ae179.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[3745],{61123:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>d,contentTitle:()=>r,default:()=>h,frontMatter:()=>o,metadata:()=>t,toc:()=>l});var s=i(24246),c=i(71670);const o={},r="Function: showQuickPick()",t={id:"namespaces/window/functions/showQuickPick",title:"Function: showQuickPick()",description:"showQuickPick(items, options, token)",source:"@site/api/namespaces/window/functions/showQuickPick.md",sourceDirName:"namespaces/window/functions",slug:"/namespaces/window/functions/showQuickPick",permalink:"/api/namespaces/window/functions/showQuickPick",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"showOpenDialog",permalink:"/api/namespaces/window/functions/showOpenDialog"},next:{title:"showSaveDialog",permalink:"/api/namespaces/window/functions/showSaveDialog"}},d={},l=[{value:"showQuickPick(items, options, token)",id:"showquickpickitems-options-token",level:2},{value:"Parameters",id:"parameters",level:3},{value:"Returns",id:"returns",level:3},{value:"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",p:"p",strong:"strong",...(0,c.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L2012",children:"packages/extension-api/src/extension-api.d.ts:2012"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L2026",children:"packages/extension-api/src/extension-api.d.ts:2026"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L2040",children:"packages/extension-api/src/extension-api.d.ts:2040"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L2054",children:"packages/extension-api/src/extension-api.d.ts:2054"})})]})}function h(e={}){const{wrapper:n}={...(0,c.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(a,{...e})}):a(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>t,a:()=>r});var s=i(27378);const c={},o=s.createContext(c);function r(e){const n=s.useContext(o);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function 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([[3745],{61123:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>d,contentTitle:()=>r,default:()=>h,frontMatter:()=>o,metadata:()=>t,toc:()=>l});var s=i(24246),c=i(71670);const o={},r="Function: showQuickPick()",t={id:"namespaces/window/functions/showQuickPick",title:"Function: showQuickPick()",description:"showQuickPick(items, options, token)",source:"@site/api/namespaces/window/functions/showQuickPick.md",sourceDirName:"namespaces/window/functions",slug:"/namespaces/window/functions/showQuickPick",permalink:"/api/namespaces/window/functions/showQuickPick",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"showOpenDialog",permalink:"/api/namespaces/window/functions/showOpenDialog"},next:{title:"showSaveDialog",permalink:"/api/namespaces/window/functions/showSaveDialog"}},d={},l=[{value:"showQuickPick(items, options, token)",id:"showquickpickitems-options-token",level:2},{value:"Parameters",id:"parameters",level:3},{value:"Returns",id:"returns",level:3},{value:"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",p:"p",strong:"strong",...(0,c.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2012",children:"packages/extension-api/src/extension-api.d.ts:2012"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2026",children:"packages/extension-api/src/extension-api.d.ts:2026"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2040",children:"packages/extension-api/src/extension-api.d.ts:2040"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2054",children:"packages/extension-api/src/extension-api.d.ts:2054"})})]})}function h(e={}){const{wrapper:n}={...(0,c.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(a,{...e})}):a(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>t,a:()=>r});var s=i(27378);const c={},o=s.createContext(c);function r(e){const n=s.useContext(o);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function 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.b02f6004.js b/assets/js/3132913e.009f2712.js similarity index 83% rename from assets/js/3132913e.b02f6004.js rename to assets/js/3132913e.009f2712.js index 19048b73d07..9087b02491b 100644 --- a/assets/js/3132913e.b02f6004.js +++ b/assets/js/3132913e.009f2712.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[68732],{83659:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>d,contentTitle:()=>r,default:()=>h,frontMatter:()=>a,metadata:()=>o,toc:()=>l});var s=i(24246),t=i(71670);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",hr:"hr",p:"p",strong:"strong",...(0,t.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"interface-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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L1832",children:"packages/extension-api/src/extension-api.d.ts:1832"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L1842",children:"packages/extension-api/src/extension-api.d.ts:1842"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L1837",children:"packages/extension-api/src/extension-api.d.ts:1837"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L1850",children:"packages/extension-api/src/extension-api.d.ts:1850"})})]})}function h(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(c,{...e})}):c(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>o,a:()=>r});var s=i(27378);const t={},a=s.createContext(t);function r(e){const n=s.useContext(a);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function 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([[68732],{83659:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>o,contentTitle:()=>r,default:()=>h,frontMatter:()=>a,metadata:()=>d,toc:()=>l});var s=i(24246),t=i(71670);const a={},r="Interface: SaveDialogOptions",d={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"}},o={},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",hr:"hr",p:"p",strong:"strong",...(0,t.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"interface-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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L1832",children:"packages/extension-api/src/extension-api.d.ts:1832"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L1842",children:"packages/extension-api/src/extension-api.d.ts:1842"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L1837",children:"packages/extension-api/src/extension-api.d.ts:1837"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L1850",children:"packages/extension-api/src/extension-api.d.ts:1850"})})]})}function h(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(c,{...e})}):c(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>d,a:()=>r});var s=i(27378);const t={},a=s.createContext(t);function r(e){const n=s.useContext(a);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function 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/35300761.0ca6b52b.js b/assets/js/35300761.0ca6b52b.js deleted file mode 100644 index 019c681b524..00000000000 --- a/assets/js/35300761.0ca6b52b.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[96120],{5052:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>r,contentTitle:()=>t,default:()=>h,frontMatter:()=>c,metadata:()=>l,toc:()=>o});var s=i(24246),d=i(71670);const c={},t="Interface: MenuItem",l={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={},o=[{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 a(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,d.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"interface-menuitem",children:"Interface: MenuItem"}),"\n",(0,s.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,s.jsx)(n.h3,{id:"checked",children:"checked?"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"optional"})," ",(0,s.jsx)(n.strong,{children:"checked"}),": ",(0,s.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:["Should only be specified for ",(0,s.jsx)(n.code,{children:"checkbox"})," or ",(0,s.jsx)(n.code,{children:"radio"})," type menu items."]}),"\n",(0,s.jsx)(n.h4,{id:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/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/804b2198fda0957e1ecfb87539f019eb9b79a66f/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/804b2198fda0957e1ecfb87539f019eb9b79a66f/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/804b2198fda0957e1ecfb87539f019eb9b79a66f/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/804b2198fda0957e1ecfb87539f019eb9b79a66f/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/804b2198fda0957e1ecfb87539f019eb9b79a66f/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/804b2198fda0957e1ecfb87539f019eb9b79a66f/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/804b2198fda0957e1ecfb87539f019eb9b79a66f/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.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(a,{...e})}):a(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>l,a:()=>t});var s=i(27378);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 l(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/35300761.7b25beec.js b/assets/js/35300761.7b25beec.js new file mode 100644 index 00000000000..81bfa41ef1c --- /dev/null +++ b/assets/js/35300761.7b25beec.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[96120],{5052:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>r,contentTitle:()=>t,default:()=>h,frontMatter:()=>c,metadata:()=>l,toc:()=>o});var d=i(24246),s=i(71670);const c={},t="Interface: MenuItem",l={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={},o=[{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 a(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,d.jsxs)(d.Fragment,{children:[(0,d.jsx)(n.h1,{id:"interface-menuitem",children:"Interface: MenuItem"}),"\n",(0,d.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,d.jsx)(n.h3,{id:"checked",children:"checked?"}),"\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:"checked"}),": ",(0,d.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,d.jsxs)(n.p,{children:["Should only be specified for ",(0,d.jsx)(n.code,{children:"checkbox"})," or ",(0,d.jsx)(n.code,{children:"radio"})," type menu items."]}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L79",children:"packages/extension-api/src/extension-api.d.ts:79"})}),"\n",(0,d.jsx)(n.hr,{}),"\n",(0,d.jsx)(n.h3,{id:"enabled",children:"enabled?"}),"\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:"enabled"}),": ",(0,d.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,d.jsx)(n.p,{children:"If false, the menu item will be greyed out and unclickable."}),"\n",(0,d.jsx)(n.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,d.jsx)(n.p,{children:(0,d.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L71",children:"packages/extension-api/src/extension-api.d.ts:71"})}),"\n",(0,d.jsx)(n.hr,{}),"\n",(0,d.jsx)(n.h3,{id:"icon",children:"icon?"}),"\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:"icon"}),": ",(0,d.jsx)(n.code,{children:"string"})]}),"\n"]}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L67",children:"packages/extension-api/src/extension-api.d.ts:67"})}),"\n",(0,d.jsx)(n.hr,{}),"\n",(0,d.jsx)(n.h3,{id:"id",children:"id"}),"\n",(0,d.jsxs)(n.blockquote,{children:["\n",(0,d.jsxs)(n.p,{children:[(0,d.jsx)(n.strong,{children:"id"}),": ",(0,d.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,d.jsx)(n.p,{children:"Unique within a single menu. Should be same as commandId for handler"}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L62",children:"packages/extension-api/src/extension-api.d.ts:62"})}),"\n",(0,d.jsx)(n.hr,{}),"\n",(0,d.jsx)(n.h3,{id:"label",children:"label?"}),"\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:"label"}),": ",(0,d.jsx)(n.code,{children:"string"})]}),"\n"]}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L65",children:"packages/extension-api/src/extension-api.d.ts:65"})}),"\n",(0,d.jsx)(n.hr,{}),"\n",(0,d.jsx)(n.h3,{id:"submenu",children:"submenu?"}),"\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:"submenu"}),": ",(0,d.jsx)(n.a,{href:"/api/interfaces/MenuItem",children:(0,d.jsx)(n.code,{children:"MenuItem"})}),"[]"]}),"\n"]}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L81",children:"packages/extension-api/src/extension-api.d.ts:81"})}),"\n",(0,d.jsx)(n.hr,{}),"\n",(0,d.jsx)(n.h3,{id:"type",children:"type?"}),"\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:"type"}),": ",(0,d.jsx)(n.code,{children:'"normal"'})," | ",(0,d.jsx)(n.code,{children:'"separator"'})," | ",(0,d.jsx)(n.code,{children:'"submenu"'})," | ",(0,d.jsx)(n.code,{children:'"checkbox"'})," | ",(0,d.jsx)(n.code,{children:'"radio"'})]}),"\n"]}),"\n",(0,d.jsx)(n.h4,{id:"defined-in-6",children:"Defined in"}),"\n",(0,d.jsx)(n.p,{children:(0,d.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L64",children:"packages/extension-api/src/extension-api.d.ts:64"})}),"\n",(0,d.jsx)(n.hr,{}),"\n",(0,d.jsx)(n.h3,{id:"visible",children:"visible?"}),"\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:"visible"}),": ",(0,d.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,d.jsx)(n.p,{children:"If false, the menu item will be entirely hidden."}),"\n",(0,d.jsx)(n.h4,{id:"defined-in-7",children:"Defined in"}),"\n",(0,d.jsx)(n.p,{children:(0,d.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/bd83a8b2bb8ab886dc757381b589638cbda150d0/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,s.a)(),...e.components};return n?(0,d.jsx)(n,{...e,children:(0,d.jsx)(a,{...e})}):a(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>l,a:()=>t});var d=i(27378);const s={},c=d.createContext(s);function t(e){const n=d.useContext(c);return d.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(s):e.components||s:t(e.components),d.createElement(c.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/382e0557.3d92cb2e.js b/assets/js/382e0557.9855cd1d.js similarity index 94% rename from assets/js/382e0557.3d92cb2e.js rename to assets/js/382e0557.9855cd1d.js index dc56997cb0a..25207e8ca3d 100644 --- a/assets/js/382e0557.3d92cb2e.js +++ b/assets/js/382e0557.9855cd1d.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[71426],{44187:(e,s,t)=>{t.r(s),t.d(s,{assets:()=>o,contentTitle:()=>a,default:()=>m,frontMatter:()=>r,metadata:()=>c,toc:()=>l});var n=t(24246),i=t(71670);const r={},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",p:"p",strong:"strong",...(0,i.a)(),...e.components};return(0,n.jsxs)(n.Fragment,{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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L760",children:"packages/extension-api/src/extension-api.d.ts:760"})})]})}function m(e={}){const{wrapper:s}={...(0,i.a)(),...e.components};return s?(0,n.jsx)(s,{...e,children:(0,n.jsx)(d,{...e})}):d(e)}},71670:(e,s,t)=>{t.d(s,{Z:()=>c,a:()=>a});var n=t(27378);const i={},r=n.createContext(i);function a(e){const s=n.useContext(r);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(i):e.components||i:a(e.components),n.createElement(r.Provider,{value:s},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[71426],{44187:(e,s,t)=>{t.r(s),t.d(s,{assets:()=>o,contentTitle:()=>a,default:()=>m,frontMatter:()=>r,metadata:()=>c,toc:()=>l});var n=t(24246),i=t(71670);const r={},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",p:"p",strong:"strong",...(0,i.a)(),...e.components};return(0,n.jsxs)(n.Fragment,{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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L760",children:"packages/extension-api/src/extension-api.d.ts:760"})})]})}function m(e={}){const{wrapper:s}={...(0,i.a)(),...e.components};return s?(0,n.jsx)(s,{...e,children:(0,n.jsx)(d,{...e})}):d(e)}},71670:(e,s,t)=>{t.d(s,{Z:()=>c,a:()=>a});var n=t(27378);const i={},r=n.createContext(i);function a(e){const s=n.useContext(r);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(i):e.components||i:a(e.components),n.createElement(r.Provider,{value:s},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/3866940b.78df73c3.js b/assets/js/3866940b.cf8cc856.js similarity index 91% rename from assets/js/3866940b.78df73c3.js rename to assets/js/3866940b.cf8cc856.js index 3c7c3b4c855..5a8eccd4984 100644 --- a/assets/js/3866940b.78df73c3.js +++ b/assets/js/3866940b.cf8cc856.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[6082],{9215:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>d,contentTitle:()=>s,default:()=>p,frontMatter:()=>o,metadata:()=>a,toc:()=>c});var t=i(24246),r=i(71670);const o={},s="Interface: ProviderInformation",a={id:"interfaces/ProviderInformation",title:"Interface: ProviderInformation",description:"Properties",source:"@site/api/interfaces/ProviderInformation.md",sourceDirName:"interfaces",slug:"/interfaces/ProviderInformation",permalink:"/api/interfaces/ProviderInformation",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"ProviderImages",permalink:"/api/interfaces/ProviderImages"},next:{title:"ProviderInstallation",permalink:"/api/interfaces/ProviderInstallation"}},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",hr:"hr",p:"p",strong:"strong",...(0,r.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"interface-providerinformation",children:"Interface: ProviderInformation"}),"\n",(0,t.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,t.jsx)(n.h3,{id:"details",children:"details?"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"optional"})," ",(0,t.jsx)(n.strong,{children:"details"}),": ",(0,t.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L302",children:"packages/extension-api/src/extension-api.d.ts:302"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"name",children:"name"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"name"}),": ",(0,t.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/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,r.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>a,a:()=>s});var t=i(27378);const r={},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([[6082],{9215:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>d,contentTitle:()=>s,default:()=>p,frontMatter:()=>o,metadata:()=>a,toc:()=>c});var t=i(24246),r=i(71670);const o={},s="Interface: ProviderInformation",a={id:"interfaces/ProviderInformation",title:"Interface: ProviderInformation",description:"Properties",source:"@site/api/interfaces/ProviderInformation.md",sourceDirName:"interfaces",slug:"/interfaces/ProviderInformation",permalink:"/api/interfaces/ProviderInformation",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"ProviderImages",permalink:"/api/interfaces/ProviderImages"},next:{title:"ProviderInstallation",permalink:"/api/interfaces/ProviderInstallation"}},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",hr:"hr",p:"p",strong:"strong",...(0,r.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"interface-providerinformation",children:"Interface: ProviderInformation"}),"\n",(0,t.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,t.jsx)(n.h3,{id:"details",children:"details?"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"optional"})," ",(0,t.jsx)(n.strong,{children:"details"}),": ",(0,t.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L302",children:"packages/extension-api/src/extension-api.d.ts:302"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"name",children:"name"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"name"}),": ",(0,t.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"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/bd83a8b2bb8ab886dc757381b589638cbda150d0/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,r.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>a,a:()=>s});var t=i(27378);const r={},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/39ae3791.ebed5c2f.js b/assets/js/39ae3791.1d3dac04.js similarity index 93% rename from assets/js/39ae3791.ebed5c2f.js rename to assets/js/39ae3791.1d3dac04.js index 2fe891ac14c..b4071dec614 100644 --- a/assets/js/39ae3791.ebed5c2f.js +++ b/assets/js/39ae3791.1d3dac04.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[955],{82687:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>a,contentTitle:()=>d,default:()=>h,frontMatter:()=>t,metadata:()=>c,toc:()=>o});var s=i(24246),r=i(71670);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",hr:"hr",p:"p",strong:"strong",...(0,r.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"interface-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/804b2198fda0957e1ecfb87539f019eb9b79a66f/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/804b2198fda0957e1ecfb87539f019eb9b79a66f/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/804b2198fda0957e1ecfb87539f019eb9b79a66f/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/804b2198fda0957e1ecfb87539f019eb9b79a66f/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.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>c,a:()=>d});var s=i(27378);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([[955],{82687:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>a,contentTitle:()=>d,default:()=>h,frontMatter:()=>t,metadata:()=>c,toc:()=>o});var s=i(24246),r=i(71670);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",hr:"hr",p:"p",strong:"strong",...(0,r.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"interface-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/bd83a8b2bb8ab886dc757381b589638cbda150d0/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/bd83a8b2bb8ab886dc757381b589638cbda150d0/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/bd83a8b2bb8ab886dc757381b589638cbda150d0/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/bd83a8b2bb8ab886dc757381b589638cbda150d0/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.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>c,a:()=>d});var s=i(27378);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.5137418c.js b/assets/js/3a38a610.71acd643.js similarity index 81% rename from assets/js/3a38a610.5137418c.js rename to assets/js/3a38a610.71acd643.js index a464a642cb3..2b97d8d6942 100644 --- a/assets/js/3a38a610.5137418c.js +++ b/assets/js/3a38a610.71acd643.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[91721],{12426:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>c,contentTitle:()=>r,default:()=>h,frontMatter:()=>t,metadata:()=>a,toc:()=>l});var s=i(24246),d=i(71670);const t={},r="Interface: ImageInfo",a={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",hr:"hr",p:"p",strong:"strong",...(0,d.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L2149",children:"packages/extension-api/src/extension-api.d.ts:2149"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L2144",children:"packages/extension-api/src/extension-api.d.ts:2144"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L2151",children:"packages/extension-api/src/extension-api.d.ts:2151"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L2150",children:"packages/extension-api/src/extension-api.d.ts:2150"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L2140",children:"packages/extension-api/src/extension-api.d.ts:2140"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L2148",children:"packages/extension-api/src/extension-api.d.ts:2148"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L2141",children:"packages/extension-api/src/extension-api.d.ts:2141"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L2143",children:"packages/extension-api/src/extension-api.d.ts:2143"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L2142",children:"packages/extension-api/src/extension-api.d.ts:2142"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L2147",children:"packages/extension-api/src/extension-api.d.ts:2147"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L2145",children:"packages/extension-api/src/extension-api.d.ts:2145"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L2146",children:"packages/extension-api/src/extension-api.d.ts:2146"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L2138",children:"packages/extension-api/src/extension-api.d.ts:2138"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L2139",children:"packages/extension-api/src/extension-api.d.ts:2139"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/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,d.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(o,{...e})}):o(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>a,a:()=>r});var s=i(27378);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([[91721],{12426:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>r,contentTitle:()=>t,default:()=>h,frontMatter:()=>a,metadata:()=>c,toc:()=>l});var s=i(24246),d=i(71670);const a={},t="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"}},r={},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",hr:"hr",p:"p",strong:"strong",...(0,d.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2149",children:"packages/extension-api/src/extension-api.d.ts:2149"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2144",children:"packages/extension-api/src/extension-api.d.ts:2144"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2151",children:"packages/extension-api/src/extension-api.d.ts:2151"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2150",children:"packages/extension-api/src/extension-api.d.ts:2150"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2140",children:"packages/extension-api/src/extension-api.d.ts:2140"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2148",children:"packages/extension-api/src/extension-api.d.ts:2148"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2141",children:"packages/extension-api/src/extension-api.d.ts:2141"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2143",children:"packages/extension-api/src/extension-api.d.ts:2143"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2142",children:"packages/extension-api/src/extension-api.d.ts:2142"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2147",children:"packages/extension-api/src/extension-api.d.ts:2147"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2145",children:"packages/extension-api/src/extension-api.d.ts:2145"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2146",children:"packages/extension-api/src/extension-api.d.ts:2146"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2138",children:"packages/extension-api/src/extension-api.d.ts:2138"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2139",children:"packages/extension-api/src/extension-api.d.ts:2139"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/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,d.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(o,{...e})}):o(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>c,a:()=>t});var s=i(27378);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/3ba80b69.a88766f4.js b/assets/js/3ba80b69.9b306541.js similarity index 80% rename from assets/js/3ba80b69.a88766f4.js rename to assets/js/3ba80b69.9b306541.js index a9c23adc79a..daf6dece59e 100644 --- a/assets/js/3ba80b69.a88766f4.js +++ b/assets/js/3ba80b69.9b306541.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[3408],{60205:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>r,default:()=>h,frontMatter:()=>c,metadata:()=>d,toc:()=>o});var i=t(24246),s=t(71670);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 l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"interface-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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L2511",children:"packages/extension-api/src/extension-api.d.ts:2511"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L2515",children:"packages/extension-api/src/extension-api.d.ts:2515"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L2519",children:"packages/extension-api/src/extension-api.d.ts:2519"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L2507",children:"packages/extension-api/src/extension-api.d.ts:2507"})})]})}function h(e={}){const{wrapper:n}={...(0,s.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>d,a:()=>r});var i=t(27378);const s={},c=i.createContext(s);function r(e){const n=i.useContext(c);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function 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 +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[3408],{60205:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>c,default:()=>h,frontMatter:()=>d,metadata:()=>r,toc:()=>o});var i=t(24246),s=t(71670);const d={},c="Interface: HealthCheckLog",r={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 l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"interface-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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2511",children:"packages/extension-api/src/extension-api.d.ts:2511"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2515",children:"packages/extension-api/src/extension-api.d.ts:2515"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2519",children:"packages/extension-api/src/extension-api.d.ts:2519"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2507",children:"packages/extension-api/src/extension-api.d.ts:2507"})})]})}function h(e={}){const{wrapper:n}={...(0,s.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>r,a:()=>c});var i=t(27378);const s={},d=i.createContext(s);function c(e){const n=i.useContext(d);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(s):e.components||s:c(e.components),i.createElement(d.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/3e2b82eb.5840292b.js b/assets/js/3e2b82eb.76f3000a.js similarity index 97% rename from assets/js/3e2b82eb.5840292b.js rename to assets/js/3e2b82eb.76f3000a.js index 6bbbe9caaec..ed709f8a855 100644 --- a/assets/js/3e2b82eb.5840292b.js +++ b/assets/js/3e2b82eb.76f3000a.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[40683],{64994:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>r,contentTitle:()=>a,default:()=>u,frontMatter:()=>s,metadata:()=>c,toc:()=>d});var t=i(24246),o=i(71670);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",p:"p",strong:"strong",...(0,o.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L4446",children:"packages/extension-api/src/extension-api.d.ts:4446"})})]})}function u(e={}){const{wrapper:n}={...(0,o.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>c,a:()=>a});var t=i(27378);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 +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[40683],{64994:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>r,contentTitle:()=>a,default:()=>u,frontMatter:()=>s,metadata:()=>c,toc:()=>d});var t=i(24246),o=i(71670);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",p:"p",strong:"strong",...(0,o.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L4446",children:"packages/extension-api/src/extension-api.d.ts:4446"})})]})}function u(e={}){const{wrapper:n}={...(0,o.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>c,a:()=>a});var t=i(27378);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.68b5cfb3.js b/assets/js/3f66023b.068982ab.js similarity index 84% rename from assets/js/3f66023b.68b5cfb3.js rename to assets/js/3f66023b.068982ab.js index 6e120308061..939f035b2e4 100644 --- a/assets/js/3f66023b.68b5cfb3.js +++ b/assets/js/3f66023b.068982ab.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[80161],{91328:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>a,contentTitle:()=>r,default:()=>h,frontMatter:()=>t,metadata:()=>c,toc:()=>o});var s=i(24246),d=i(71670);const t={},r="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"}},a={},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",hr:"hr",p:"p",strong:"strong",...(0,d.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{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/804b2198fda0957e1ecfb87539f019eb9b79a66f/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:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/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:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/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:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/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:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/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:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/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:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/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:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L2285",children:"packages/extension-api/src/extension-api.d.ts:2285"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/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:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/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:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/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:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/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:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/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:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/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:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L2267",children:"packages/extension-api/src/extension-api.d.ts:2267"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L2268",children:"packages/extension-api/src/extension-api.d.ts:2268"})})]})}function h(e={}){const{wrapper:n}={...(0,d.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>c,a:()=>r});var s=i(27378);const 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([[80161],{91328:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>a,contentTitle:()=>c,default:()=>h,frontMatter:()=>t,metadata:()=>r,toc:()=>o});var s=i(24246),d=i(71670);const t={},c="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"}},a={},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",hr:"hr",p:"p",strong:"strong",...(0,d.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{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/bd83a8b2bb8ab886dc757381b589638cbda150d0/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:"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/bd83a8b2bb8ab886dc757381b589638cbda150d0/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:"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/bd83a8b2bb8ab886dc757381b589638cbda150d0/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:"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/bd83a8b2bb8ab886dc757381b589638cbda150d0/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:"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/bd83a8b2bb8ab886dc757381b589638cbda150d0/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:"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/bd83a8b2bb8ab886dc757381b589638cbda150d0/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:"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/bd83a8b2bb8ab886dc757381b589638cbda150d0/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:"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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2285",children:"packages/extension-api/src/extension-api.d.ts:2285"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/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:"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/bd83a8b2bb8ab886dc757381b589638cbda150d0/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:"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/bd83a8b2bb8ab886dc757381b589638cbda150d0/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:"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/bd83a8b2bb8ab886dc757381b589638cbda150d0/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:"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/bd83a8b2bb8ab886dc757381b589638cbda150d0/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:"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/bd83a8b2bb8ab886dc757381b589638cbda150d0/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:"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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2267",children:"packages/extension-api/src/extension-api.d.ts:2267"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2268",children:"packages/extension-api/src/extension-api.d.ts:2268"})})]})}function h(e={}){const{wrapper:n}={...(0,d.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>r,a:()=>c});var s=i(27378);const 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 r(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/3f797343.d50d437d.js b/assets/js/3f797343.9959f05f.js similarity index 94% rename from assets/js/3f797343.d50d437d.js rename to assets/js/3f797343.9959f05f.js index 63b77fc4c5e..5737d9efdfe 100644 --- a/assets/js/3f797343.d50d437d.js +++ b/assets/js/3f797343.9959f05f.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[85632],{2310:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>a,contentTitle:()=>s,default:()=>p,frontMatter:()=>o,metadata:()=>c,toc:()=>d});var t=i(24246),r=i(71670);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",hr:"hr",p:"p",strong:"strong",...(0,r.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"interface-providercleanupexecuteoptions",children:"Interface: ProviderCleanupExecuteOptions"}),"\n",(0,t.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,t.jsx)(n.h3,{id:"logger",children:"logger"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"logger"}),": ",(0,t.jsx)(n.a,{href:"/api/interfaces/Logger",children:(0,t.jsx)(n.code,{children:"Logger"})})]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L568",children:"packages/extension-api/src/extension-api.d.ts:568"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L569",children:"packages/extension-api/src/extension-api.d.ts:569"})})]})}function p(e={}){const{wrapper:n}={...(0,r.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>c,a:()=>s});var t=i(27378);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([[85632],{2310:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>a,contentTitle:()=>s,default:()=>p,frontMatter:()=>o,metadata:()=>c,toc:()=>d});var t=i(24246),r=i(71670);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",hr:"hr",p:"p",strong:"strong",...(0,r.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"interface-providercleanupexecuteoptions",children:"Interface: ProviderCleanupExecuteOptions"}),"\n",(0,t.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,t.jsx)(n.h3,{id:"logger",children:"logger"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"logger"}),": ",(0,t.jsx)(n.a,{href:"/api/interfaces/Logger",children:(0,t.jsx)(n.code,{children:"Logger"})})]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L568",children:"packages/extension-api/src/extension-api.d.ts:568"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L569",children:"packages/extension-api/src/extension-api.d.ts:569"})})]})}function p(e={}){const{wrapper:n}={...(0,r.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>c,a:()=>s});var t=i(27378);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.419b15aa.js b/assets/js/40d377be.8613aff9.js similarity index 78% rename from assets/js/40d377be.419b15aa.js rename to assets/js/40d377be.8613aff9.js index e1915b6db0f..e26ede6cb8f 100644 --- a/assets/js/40d377be.419b15aa.js +++ b/assets/js/40d377be.8613aff9.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[14077],{53910:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>o,contentTitle:()=>a,default:()=>p,frontMatter:()=>r,metadata:()=>d,toc:()=>c});var s=i(24246),t=i(71670);const r={},a="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",hr:"hr",p:"p",strong:"strong",...(0,t.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"interface-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/804b2198fda0957e1ecfb87539f019eb9b79a66f/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:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/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:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L432",children:"packages/extension-api/src/extension-api.d.ts:432"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/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:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L438",children:"packages/extension-api/src/extension-api.d.ts:438"})})]})}function p(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>d,a:()=>a});var s=i(27378);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([[14077],{53910:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>o,contentTitle:()=>a,default:()=>p,frontMatter:()=>d,metadata:()=>r,toc:()=>c});var s=i(24246),t=i(71670);const d={},a="Interface: ManifestCreateOptions",r={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",hr:"hr",p:"p",strong:"strong",...(0,t.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"interface-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/bd83a8b2bb8ab886dc757381b589638cbda150d0/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:"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/bd83a8b2bb8ab886dc757381b589638cbda150d0/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:"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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L432",children:"packages/extension-api/src/extension-api.d.ts:432"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/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:"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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L438",children:"packages/extension-api/src/extension-api.d.ts:438"})})]})}function p(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>r,a:()=>a});var s=i(27378);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/416d4fcf.864faaad.js b/assets/js/416d4fcf.cd66173c.js similarity index 93% rename from assets/js/416d4fcf.864faaad.js rename to assets/js/416d4fcf.cd66173c.js index 71cf35b2cc8..aff7e77e570 100644 --- a/assets/js/416d4fcf.864faaad.js +++ b/assets/js/416d4fcf.cd66173c.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[44422],{60855:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>c,contentTitle:()=>s,default:()=>h,frontMatter:()=>a,metadata:()=>o,toc:()=>d});var t=i(24246),r=i(71670);const a={},s="Interface: ContainerCreateResult",o={id:"interfaces/ContainerCreateResult",title:"Interface: ContainerCreateResult",description:"Information about the container created by calling the containerEngine.createContainer method",source:"@site/api/interfaces/ContainerCreateResult.md",sourceDirName:"interfaces",slug:"/interfaces/ContainerCreateResult",permalink:"/api/interfaces/ContainerCreateResult",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"ContainerCreateOptions",permalink:"/api/interfaces/ContainerCreateOptions"},next:{title:"ContainerEngineInfo",permalink:"/api/interfaces/ContainerEngineInfo"}},c={},d=[{value:"Properties",id:"properties",level:2},{value:"engineId",id:"engineid",level:3},{value:"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",hr:"hr",p:"p",strong:"strong",...(0,r.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L3034",children:"packages/extension-api/src/extension-api.d.ts:3034"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L3030",children:"packages/extension-api/src/extension-api.d.ts:3030"})})]})}function h(e={}){const{wrapper:n}={...(0,r.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>o,a:()=>s});var t=i(27378);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([[44422],{60855:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>c,contentTitle:()=>s,default:()=>h,frontMatter:()=>a,metadata:()=>o,toc:()=>d});var t=i(24246),r=i(71670);const a={},s="Interface: ContainerCreateResult",o={id:"interfaces/ContainerCreateResult",title:"Interface: ContainerCreateResult",description:"Information about the container created by calling the containerEngine.createContainer method",source:"@site/api/interfaces/ContainerCreateResult.md",sourceDirName:"interfaces",slug:"/interfaces/ContainerCreateResult",permalink:"/api/interfaces/ContainerCreateResult",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"ContainerCreateOptions",permalink:"/api/interfaces/ContainerCreateOptions"},next:{title:"ContainerEngineInfo",permalink:"/api/interfaces/ContainerEngineInfo"}},c={},d=[{value:"Properties",id:"properties",level:2},{value:"engineId",id:"engineid",level:3},{value:"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",hr:"hr",p:"p",strong:"strong",...(0,r.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L3034",children:"packages/extension-api/src/extension-api.d.ts:3034"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L3030",children:"packages/extension-api/src/extension-api.d.ts:3030"})})]})}function h(e={}){const{wrapper:n}={...(0,r.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>o,a:()=>s});var t=i(27378);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.e2f810a4.js b/assets/js/41b2e801.11f6865c.js similarity index 98% rename from assets/js/41b2e801.e2f810a4.js rename to assets/js/41b2e801.11f6865c.js index bea3de173e9..3a987871537 100644 --- a/assets/js/41b2e801.e2f810a4.js +++ b/assets/js/41b2e801.11f6865c.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[35137],{80995:(e,r,n)=>{n.r(r),n.d(r,{assets:()=>o,contentTitle:()=>t,default:()=>l,frontMatter:()=>a,metadata:()=>c,toc:()=>d});var i=n(24246),s=n(71670);const a={},t="Function: registerImageCheckerProvider()",c={id:"namespaces/imageChecker/functions/registerImageCheckerProvider",title:"Function: registerImageCheckerProvider()",description:"registerImageCheckerProvider(imageCheckerProvider, metadata?): Disposable",source:"@site/api/namespaces/imageChecker/functions/registerImageCheckerProvider.md",sourceDirName:"namespaces/imageChecker/functions",slug:"/namespaces/imageChecker/functions/registerImageCheckerProvider",permalink:"/api/namespaces/imageChecker/functions/registerImageCheckerProvider",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"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",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L4420",children:"packages/extension-api/src/extension-api.d.ts:4420"})})]})}function l(e={}){const{wrapper:r}={...(0,s.a)(),...e.components};return r?(0,i.jsx)(r,{...e,children:(0,i.jsx)(h,{...e})}):h(e)}},71670:(e,r,n)=>{n.d(r,{Z:()=>c,a:()=>t});var i=n(27378);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([[35137],{80995:(e,r,n)=>{n.r(r),n.d(r,{assets:()=>o,contentTitle:()=>t,default:()=>l,frontMatter:()=>a,metadata:()=>c,toc:()=>d});var i=n(24246),s=n(71670);const a={},t="Function: registerImageCheckerProvider()",c={id:"namespaces/imageChecker/functions/registerImageCheckerProvider",title:"Function: registerImageCheckerProvider()",description:"registerImageCheckerProvider(imageCheckerProvider, metadata?): Disposable",source:"@site/api/namespaces/imageChecker/functions/registerImageCheckerProvider.md",sourceDirName:"namespaces/imageChecker/functions",slug:"/namespaces/imageChecker/functions/registerImageCheckerProvider",permalink:"/api/namespaces/imageChecker/functions/registerImageCheckerProvider",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"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",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L4420",children:"packages/extension-api/src/extension-api.d.ts:4420"})})]})}function l(e={}){const{wrapper:r}={...(0,s.a)(),...e.components};return r?(0,i.jsx)(r,{...e,children:(0,i.jsx)(h,{...e})}):h(e)}},71670:(e,r,n)=>{n.d(r,{Z:()=>c,a:()=>t});var i=n(27378);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.f3e5a21d.js b/assets/js/423842d7.bec0b4e6.js similarity index 96% rename from assets/js/423842d7.f3e5a21d.js rename to assets/js/423842d7.bec0b4e6.js index 05cc16e530a..98ce24460ab 100644 --- a/assets/js/423842d7.f3e5a21d.js +++ b/assets/js/423842d7.bec0b4e6.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[27328],{88952:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>o,default:()=>p,frontMatter:()=>i,metadata:()=>c,toc:()=>d});var r=t(24246),s=t(71670);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",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.h1,{id:"type-alias-kubernetesgeneratorargument",children:"Type Alias: KubernetesGeneratorArgument"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"KubernetesGeneratorArgument"}),": ",(0,r.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,r.jsx)(n.h2,{id:"type-declaration",children:"Type declaration"}),"\n",(0,r.jsx)(n.h3,{id:"compose",children:"compose?"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"optional"})," ",(0,r.jsx)(n.strong,{children:"compose"}),": ",(0,r.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,r.jsx)(n.h3,{id:"containers",children:"containers?"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"optional"})," ",(0,r.jsx)(n.strong,{children:"containers"}),": ",(0,r.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,r.jsx)(n.h3,{id:"engineid",children:"engineId"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"engineId"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.h3,{id:"pods",children:"pods?"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"optional"})," ",(0,r.jsx)(n.strong,{children:"pods"}),": ",(0,r.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,r.jsx)(n.h2,{id:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L2120",children:"packages/extension-api/src/extension-api.d.ts:2120"})})]})}function p(e={}){const{wrapper:n}={...(0,s.a)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(l,{...e})}):l(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>c,a:()=>o});var r=t(27378);const s={},i=r.createContext(s);function o(e){const n=r.useContext(i);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:o(e.components),r.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[27328],{88952:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>o,default:()=>p,frontMatter:()=>i,metadata:()=>c,toc:()=>d});var r=t(24246),s=t(71670);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",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.h1,{id:"type-alias-kubernetesgeneratorargument",children:"Type Alias: KubernetesGeneratorArgument"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"KubernetesGeneratorArgument"}),": ",(0,r.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,r.jsx)(n.h2,{id:"type-declaration",children:"Type declaration"}),"\n",(0,r.jsx)(n.h3,{id:"compose",children:"compose?"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"optional"})," ",(0,r.jsx)(n.strong,{children:"compose"}),": ",(0,r.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,r.jsx)(n.h3,{id:"containers",children:"containers?"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"optional"})," ",(0,r.jsx)(n.strong,{children:"containers"}),": ",(0,r.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,r.jsx)(n.h3,{id:"engineid",children:"engineId"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"engineId"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.h3,{id:"pods",children:"pods?"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"optional"})," ",(0,r.jsx)(n.strong,{children:"pods"}),": ",(0,r.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,r.jsx)(n.h2,{id:"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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2120",children:"packages/extension-api/src/extension-api.d.ts:2120"})})]})}function p(e={}){const{wrapper:n}={...(0,s.a)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(l,{...e})}):l(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>c,a:()=>o});var r=t(27378);const s={},i=r.createContext(s);function o(e){const n=r.useContext(i);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:o(e.components),r.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/42b67a8e.46532e76.js b/assets/js/42b67a8e.c33ea390.js similarity index 91% rename from assets/js/42b67a8e.46532e76.js rename to assets/js/42b67a8e.c33ea390.js index 96fc4cda592..16383d0df7d 100644 --- a/assets/js/42b67a8e.46532e76.js +++ b/assets/js/42b67a8e.c33ea390.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[54774],{38472:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>o,default:()=>p,frontMatter:()=>r,metadata:()=>c,toc:()=>d});var i=t(24246),s=t(71670);const r={},o="Interface: 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",hr:"hr",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"interface-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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L2366",children:"packages/extension-api/src/extension-api.d.ts:2366"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L2365",children:"packages/extension-api/src/extension-api.d.ts:2365"})})]})}function p(e={}){const{wrapper:n}={...(0,s.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>c,a:()=>o});var i=t(27378);const s={},r=i.createContext(s);function o(e){const n=i.useContext(r);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:o(e.components),i.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[54774],{38472:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>o,default:()=>p,frontMatter:()=>r,metadata:()=>c,toc:()=>d});var i=t(24246),s=t(71670);const r={},o="Interface: 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",hr:"hr",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"interface-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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2366",children:"packages/extension-api/src/extension-api.d.ts:2366"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2365",children:"packages/extension-api/src/extension-api.d.ts:2365"})})]})}function p(e={}){const{wrapper:n}={...(0,s.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>c,a:()=>o});var i=t(27378);const s={},r=i.createContext(s);function o(e){const n=i.useContext(r);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:o(e.components),i.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/43be69c9.84ff854d.js b/assets/js/43be69c9.365e8195.js similarity index 92% rename from assets/js/43be69c9.84ff854d.js rename to assets/js/43be69c9.365e8195.js index 84c70e452d6..23af98464e9 100644 --- a/assets/js/43be69c9.84ff854d.js +++ b/assets/js/43be69c9.365e8195.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[86661],{48168:(e,i,n)=>{n.r(i),n.d(i,{assets:()=>a,contentTitle:()=>d,default:()=>h,frontMatter:()=>c,metadata:()=>r,toc:()=>o});var s=n(24246),t=n(71670);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 l(e){const i={a:"a",blockquote:"blockquote",code:"code",em:"em",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,t.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(i.h1,{id:"interface-quickpickitem",children:"Interface: QuickPickItem"}),"\n",(0,s.jsx)(i.p,{children:"Represents an item that can be selected from\na list of items."}),"\n",(0,s.jsx)(i.h2,{id:"properties",children:"Properties"}),"\n",(0,s.jsx)(i.h3,{id:"alwaysshow",children:"alwaysShow?"}),"\n",(0,s.jsxs)(i.blockquote,{children:["\n",(0,s.jsxs)(i.p,{children:[(0,s.jsx)(i.code,{children:"optional"})," ",(0,s.jsx)(i.strong,{children:"alwaysShow"}),": ",(0,s.jsx)(i.code,{children:"boolean"})]}),"\n"]}),"\n",(0,s.jsx)(i.p,{children:"Always show this item."}),"\n",(0,s.jsxs)(i.p,{children:["Note: this property is ignored when ",(0,s.jsx)(i.a,{href:"/api/interfaces/QuickPickItem#kind",children:"kind"})," is set to ",(0,s.jsx)(i.a,{href:"/api/enumerations/QuickPickItemKind#separator",children:"QuickPickItemKind.Separator"})]}),"\n",(0,s.jsx)(i.h4,{id:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L1308",children:"packages/extension-api/src/extension-api.d.ts:1308"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L1318",children:"packages/extension-api/src/extension-api.d.ts:1318"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L1280",children:"packages/extension-api/src/extension-api.d.ts:1280"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L1288",children:"packages/extension-api/src/extension-api.d.ts:1288"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L1272",children:"packages/extension-api/src/extension-api.d.ts:1272"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L1266",children:"packages/extension-api/src/extension-api.d.ts:1266"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L1301",children:"packages/extension-api/src/extension-api.d.ts:1301"})})]})}function h(e={}){const{wrapper:i}={...(0,t.a)(),...e.components};return i?(0,s.jsx)(i,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},71670:(e,i,n)=>{n.d(i,{Z:()=>r,a:()=>d});var s=n(27378);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([[86661],{48168:(e,i,n)=>{n.r(i),n.d(i,{assets:()=>a,contentTitle:()=>d,default:()=>h,frontMatter:()=>c,metadata:()=>r,toc:()=>o});var s=n(24246),t=n(71670);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 l(e){const i={a:"a",blockquote:"blockquote",code:"code",em:"em",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,t.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(i.h1,{id:"interface-quickpickitem",children:"Interface: QuickPickItem"}),"\n",(0,s.jsx)(i.p,{children:"Represents an item that can be selected from\na list of items."}),"\n",(0,s.jsx)(i.h2,{id:"properties",children:"Properties"}),"\n",(0,s.jsx)(i.h3,{id:"alwaysshow",children:"alwaysShow?"}),"\n",(0,s.jsxs)(i.blockquote,{children:["\n",(0,s.jsxs)(i.p,{children:[(0,s.jsx)(i.code,{children:"optional"})," ",(0,s.jsx)(i.strong,{children:"alwaysShow"}),": ",(0,s.jsx)(i.code,{children:"boolean"})]}),"\n"]}),"\n",(0,s.jsx)(i.p,{children:"Always show this item."}),"\n",(0,s.jsxs)(i.p,{children:["Note: this property is ignored when ",(0,s.jsx)(i.a,{href:"/api/interfaces/QuickPickItem#kind",children:"kind"})," is set to ",(0,s.jsx)(i.a,{href:"/api/enumerations/QuickPickItemKind#separator",children:"QuickPickItemKind.Separator"})]}),"\n",(0,s.jsx)(i.h4,{id:"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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L1308",children:"packages/extension-api/src/extension-api.d.ts:1308"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L1318",children:"packages/extension-api/src/extension-api.d.ts:1318"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L1280",children:"packages/extension-api/src/extension-api.d.ts:1280"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L1288",children:"packages/extension-api/src/extension-api.d.ts:1288"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L1272",children:"packages/extension-api/src/extension-api.d.ts:1272"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L1266",children:"packages/extension-api/src/extension-api.d.ts:1266"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L1301",children:"packages/extension-api/src/extension-api.d.ts:1301"})})]})}function h(e={}){const{wrapper:i}={...(0,t.a)(),...e.components};return i?(0,s.jsx)(i,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},71670:(e,i,n)=>{n.d(i,{Z:()=>r,a:()=>d});var s=n(27378);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/44287967.10efc4d5.js b/assets/js/44287967.10efc4d5.js new file mode 100644 index 00000000000..eca74c7f0a1 --- /dev/null +++ b/assets/js/44287967.10efc4d5.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[49867],{19142:(n,e,s)=>{s.r(e),s.d(e,{assets:()=>c,contentTitle:()=>r,default:()=>p,frontMatter:()=>a,metadata:()=>o,toc:()=>d});var t=s(24246),i=s(71670);const a={},r="Function: statsContainer()",o={id:"namespaces/containerEngine/functions/statsContainer",title:"Function: statsContainer()",description:"statsContainer(engineId, id, callback): Promise\\",source:"@site/api/namespaces/containerEngine/functions/statsContainer.md",sourceDirName:"namespaces/containerEngine/functions",slug:"/namespaces/containerEngine/functions/statsContainer",permalink:"/api/namespaces/containerEngine/functions/statsContainer",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"startPod",permalink:"/api/namespaces/containerEngine/functions/startPod"},next:{title:"stopContainer",permalink:"/api/namespaces/containerEngine/functions/stopContainer"}},c={},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(n){const e={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",pre:"pre",strong:"strong",...(0,i.a)(),...n.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(e.h1,{id:"function-statscontainer",children:"Function: statsContainer()"}),"\n",(0,t.jsxs)(e.blockquote,{children:["\n",(0,t.jsxs)(e.p,{children:[(0,t.jsx)(e.strong,{children:"statsContainer"}),"(",(0,t.jsx)(e.code,{children:"engineId"}),", ",(0,t.jsx)(e.code,{children:"id"}),", ",(0,t.jsx)(e.code,{children:"callback"}),"): ",(0,t.jsx)(e.code,{children:"Promise"}),"<",(0,t.jsx)(e.a,{href:"/api/classes/Disposable",children:(0,t.jsx)(e.code,{children:"Disposable"})}),">"]}),"\n"]}),"\n",(0,t.jsx)(e.p,{children:"Get the streamed stats of a running 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.jsxs)(e.p,{children:["\u2022 ",(0,t.jsx)(e.strong,{children:"callback"})]}),"\n",(0,t.jsx)(e.p,{children:"the function called when container stats info are emitted."}),"\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/classes/Disposable",children:(0,t.jsx)(e.code,{children:"Disposable"})}),">"]}),"\n",(0,t.jsxs)(e.p,{children:["A Promise resolving a ",(0,t.jsx)(e.a,{href:"/api/classes/Disposable",children:"Disposable"})," that unregister the callback when called."]}),"\n",(0,t.jsx)(e.h2,{id:"example",children:"Example"}),"\n",(0,t.jsx)(e.p,{children:"Here is a usage example"}),"\n",(0,t.jsx)(e.pre,{children:(0,t.jsx)(e.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)(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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L3507",children:"packages/extension-api/src/extension-api.d.ts:3507"})})]})}function p(n={}){const{wrapper:e}={...(0,i.a)(),...n.components};return e?(0,t.jsx)(e,{...n,children:(0,t.jsx)(l,{...n})}):l(n)}},71670:(n,e,s)=>{s.d(e,{Z:()=>o,a:()=>r});var t=s(27378);const i={},a=t.createContext(i);function r(n){const e=t.useContext(a);return t.useMemo((function(){return"function"==typeof n?n(e):{...e,...n}}),[e,n])}function o(n){let e;return e=n.disableParentContext?"function"==typeof n.components?n.components(i):n.components||i:r(n.components),t.createElement(a.Provider,{value:e},n.children)}}}]); \ No newline at end of file diff --git a/assets/js/44287967.2dc4ee83.js b/assets/js/44287967.2dc4ee83.js deleted file mode 100644 index 69a479d8322..00000000000 --- a/assets/js/44287967.2dc4ee83.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[49867],{19142:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>c,contentTitle:()=>r,default:()=>p,frontMatter:()=>a,metadata:()=>o,toc:()=>l});var t=s(24246),i=s(71670);const a={},r="Function: statsContainer()",o={id:"namespaces/containerEngine/functions/statsContainer",title:"Function: statsContainer()",description:"statsContainer(engineId, id, callback): Promise\\",source:"@site/api/namespaces/containerEngine/functions/statsContainer.md",sourceDirName:"namespaces/containerEngine/functions",slug:"/namespaces/containerEngine/functions/statsContainer",permalink:"/api/namespaces/containerEngine/functions/statsContainer",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"startPod",permalink:"/api/namespaces/containerEngine/functions/startPod"},next:{title:"stopContainer",permalink:"/api/namespaces/containerEngine/functions/stopContainer"}},c={},l=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Example",id:"example",level:2},{value:"Defined in",id:"defined-in",level:2}];function d(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",pre:"pre",strong:"strong",...(0,i.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"function-statscontainer",children:"Function: statsContainer()"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"statsContainer"}),"(",(0,t.jsx)(n.code,{children:"engineId"}),", ",(0,t.jsx)(n.code,{children:"id"}),", ",(0,t.jsx)(n.code,{children:"callback"}),"): ",(0,t.jsx)(n.code,{children:"Promise"}),"<",(0,t.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,t.jsx)(n.code,{children:"Disposable"})}),">"]}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"Get the streamed stats of a running container."}),"\n",(0,t.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"engineId"}),": ",(0,t.jsx)(n.code,{children:"string"})]}),"\n",(0,t.jsxs)(n.p,{children:["the id of the engine managing the container, obtained from the result of ",(0,t.jsx)(n.a,{href:"/api/namespaces/containerEngine/functions/listContainers",children:"containerEngine.listContainers"})]}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"id"}),": ",(0,t.jsx)(n.code,{children:"string"})]}),"\n",(0,t.jsxs)(n.p,{children:["the id or name of the container on this engine, obtained from the result of ",(0,t.jsx)(n.a,{href:"/api/namespaces/containerEngine/functions/listContainers",children:"containerEngine.listContainers"})," or as the result of ",(0,t.jsx)(n.a,{href:"/api/namespaces/containerEngine/functions/createContainer",children:"containerEngine.createContainer"})]}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"callback"})]}),"\n",(0,t.jsx)(n.p,{children:"the function called when container stats info are emitted."}),"\n",(0,t.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"Promise"}),"<",(0,t.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,t.jsx)(n.code,{children:"Disposable"})}),">"]}),"\n",(0,t.jsxs)(n.p,{children:["A Promise resolving a ",(0,t.jsx)(n.a,{href:"/api/classes/Disposable",children:"Disposable"})," that unregister the callback when called."]}),"\n",(0,t.jsx)(n.h2,{id:"example",children:"Example"}),"\n",(0,t.jsx)(n.p,{children:"Here is a usage example"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-ts",children:"const disposable = await statsContainer('engineId', 'containerId', (stats: ContainerStatsInfo): void => {\n console.log('CPU Usage', stats.cpu_stats.cpu_usage.total_usage);\n});\n\n// When no longer needed\ndisposable.dispose();\n"})}),"\n",(0,t.jsx)(n.h2,{id:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L3507",children:"packages/extension-api/src/extension-api.d.ts:3507"})})]})}function p(e={}){const{wrapper:n}={...(0,i.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(d,{...e})}):d(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>o,a:()=>r});var t=s(27378);const i={},a=t.createContext(i);function r(e){const n=t.useContext(a);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:r(e.components),t.createElement(a.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/456c0e28.96f71e8b.js b/assets/js/456c0e28.1bdb17b6.js similarity index 78% rename from assets/js/456c0e28.96f71e8b.js rename to assets/js/456c0e28.1bdb17b6.js index e6f278f1302..377beb5210d 100644 --- a/assets/js/456c0e28.96f71e8b.js +++ b/assets/js/456c0e28.1bdb17b6.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[33279],{3494:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>a,contentTitle:()=>o,default:()=>p,frontMatter:()=>r,metadata:()=>d,toc:()=>c});var t=i(24246),s=i(71670);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",hr:"hr",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"interface-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/804b2198fda0957e1ecfb87539f019eb9b79a66f/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:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L2321",children:"packages/extension-api/src/extension-api.d.ts:2321"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L2322",children:"packages/extension-api/src/extension-api.d.ts:2322"})})]})}function p(e={}){const{wrapper:n}={...(0,s.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>d,a:()=>o});var t=i(27378);const s={},r=t.createContext(s);function o(e){const n=t.useContext(r);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function 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([[33279],{3494:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>a,contentTitle:()=>r,default:()=>p,frontMatter:()=>d,metadata:()=>o,toc:()=>c});var t=i(24246),s=i(71670);const d={},r="Interface: PodContainerInfo",o={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",hr:"hr",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"interface-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/bd83a8b2bb8ab886dc757381b589638cbda150d0/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:"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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2321",children:"packages/extension-api/src/extension-api.d.ts:2321"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2322",children:"packages/extension-api/src/extension-api.d.ts:2322"})})]})}function p(e={}){const{wrapper:n}={...(0,s.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>o,a:()=>r});var t=i(27378);const s={},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 diff --git a/assets/js/46669adc.fdd98020.js b/assets/js/46669adc.c57531f0.js similarity index 76% rename from assets/js/46669adc.fdd98020.js rename to assets/js/46669adc.c57531f0.js index 1943235fa71..cbc5f7e243c 100644 --- a/assets/js/46669adc.fdd98020.js +++ b/assets/js/46669adc.c57531f0.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[51320],{60964:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>o,contentTitle:()=>c,default:()=>p,frontMatter:()=>s,metadata:()=>d,toc:()=>a});var i=t(24246),r=t(71670);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",hr:"hr",p:"p",strong:"strong",...(0,r.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"interface-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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L495",children:"packages/extension-api/src/extension-api.d.ts:495"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L494",children:"packages/extension-api/src/extension-api.d.ts:494"})})]})}function p(e={}){const{wrapper:n}={...(0,r.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>d,a:()=>c});var i=t(27378);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 +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[51320],{60964:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>o,contentTitle:()=>d,default:()=>p,frontMatter:()=>s,metadata:()=>c,toc:()=>a});var i=t(24246),r=t(71670);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",hr:"hr",p:"p",strong:"strong",...(0,r.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"interface-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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L495",children:"packages/extension-api/src/extension-api.d.ts:495"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L494",children:"packages/extension-api/src/extension-api.d.ts:494"})})]})}function p(e={}){const{wrapper:n}={...(0,r.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>c,a:()=>d});var i=t(27378);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 diff --git a/assets/js/46b3c144.b182109f.js b/assets/js/46b3c144.3d2d761d.js similarity index 89% rename from assets/js/46b3c144.b182109f.js rename to assets/js/46b3c144.3d2d761d.js index a751fb13a69..06e128001cb 100644 --- a/assets/js/46b3c144.b182109f.js +++ b/assets/js/46b3c144.3d2d761d.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[1868],{69884:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>c,contentTitle:()=>r,default:()=>l,frontMatter:()=>o,metadata:()=>d,toc:()=>a});var t=i(24246),s=i(71670);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",hr:"hr",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"interface-podcreateportoptions",children:"Interface: PodCreatePortOptions"}),"\n",(0,t.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,t.jsx)(n.h3,{id:"container_port",children:"container_port"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"container_port"}),": ",(0,t.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L369",children:"packages/extension-api/src/extension-api.d.ts:369"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"host_ip",children:"host_ip"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"host_ip"}),": ",(0,t.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L368",children:"packages/extension-api/src/extension-api.d.ts:368"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"host_port",children:"host_port"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"host_port"}),": ",(0,t.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L370",children:"packages/extension-api/src/extension-api.d.ts:370"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"protocol",children:"protocol"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"protocol"}),": ",(0,t.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L371",children:"packages/extension-api/src/extension-api.d.ts:371"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"range",children:"range"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"range"}),": ",(0,t.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L372",children:"packages/extension-api/src/extension-api.d.ts:372"})})]})}function l(e={}){const{wrapper:n}={...(0,s.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(p,{...e})}):p(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>d,a:()=>r});var t=i(27378);const s={},o=t.createContext(s);function r(e){const n=t.useContext(o);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function 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([[1868],{69884:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>c,contentTitle:()=>r,default:()=>l,frontMatter:()=>o,metadata:()=>d,toc:()=>a});var t=i(24246),s=i(71670);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",hr:"hr",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"interface-podcreateportoptions",children:"Interface: PodCreatePortOptions"}),"\n",(0,t.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,t.jsx)(n.h3,{id:"container_port",children:"container_port"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"container_port"}),": ",(0,t.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L369",children:"packages/extension-api/src/extension-api.d.ts:369"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"host_ip",children:"host_ip"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"host_ip"}),": ",(0,t.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L368",children:"packages/extension-api/src/extension-api.d.ts:368"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"host_port",children:"host_port"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"host_port"}),": ",(0,t.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L370",children:"packages/extension-api/src/extension-api.d.ts:370"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"protocol",children:"protocol"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"protocol"}),": ",(0,t.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L371",children:"packages/extension-api/src/extension-api.d.ts:371"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"range",children:"range"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"range"}),": ",(0,t.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L372",children:"packages/extension-api/src/extension-api.d.ts:372"})})]})}function l(e={}){const{wrapper:n}={...(0,s.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(p,{...e})}):p(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>d,a:()=>r});var t=i(27378);const s={},o=t.createContext(s);function r(e){const n=t.useContext(o);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function 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.3bb40cf7.js b/assets/js/494e8e75.c459a1cc.js similarity index 94% rename from assets/js/494e8e75.3bb40cf7.js rename to assets/js/494e8e75.c459a1cc.js index 587b9c8ad3a..94705fdd052 100644 --- a/assets/js/494e8e75.3bb40cf7.js +++ b/assets/js/494e8e75.c459a1cc.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[49076],{8812:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>s,default:()=>l,frontMatter:()=>o,metadata:()=>c,toc:()=>d});var r=t(24246),i=t(71670);const o={},s="Interface: UnregisterContainerConnectionEvent",c={id:"interfaces/UnregisterContainerConnectionEvent",title:"Interface: UnregisterContainerConnectionEvent",description:"Properties",source:"@site/api/interfaces/UnregisterContainerConnectionEvent.md",sourceDirName:"interfaces",slug:"/interfaces/UnregisterContainerConnectionEvent",permalink:"/api/interfaces/UnregisterContainerConnectionEvent",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"ThrottlingData",permalink:"/api/interfaces/ThrottlingData"},next:{title:"UnregisterKubernetesConnectionEvent",permalink:"/api/interfaces/UnregisterKubernetesConnectionEvent"}},a={},d=[{value:"Properties",id:"properties",level:2},{value:"providerId",id:"providerid",level:3},{value:"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",p:"p",strong:"strong",...(0,i.a)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.h1,{id:"interface-unregistercontainerconnectionevent",children:"Interface: UnregisterContainerConnectionEvent"}),"\n",(0,r.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,r.jsx)(n.h3,{id:"providerid",children:"providerId"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"providerId"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L688",children:"packages/extension-api/src/extension-api.d.ts:688"})})]})}function l(e={}){const{wrapper:n}={...(0,i.a)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(p,{...e})}):p(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>c,a:()=>s});var r=t(27378);const i={},o=r.createContext(i);function s(e){const n=r.useContext(o);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:s(e.components),r.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[49076],{8812:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>s,default:()=>l,frontMatter:()=>o,metadata:()=>c,toc:()=>d});var r=t(24246),i=t(71670);const o={},s="Interface: UnregisterContainerConnectionEvent",c={id:"interfaces/UnregisterContainerConnectionEvent",title:"Interface: UnregisterContainerConnectionEvent",description:"Properties",source:"@site/api/interfaces/UnregisterContainerConnectionEvent.md",sourceDirName:"interfaces",slug:"/interfaces/UnregisterContainerConnectionEvent",permalink:"/api/interfaces/UnregisterContainerConnectionEvent",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"ThrottlingData",permalink:"/api/interfaces/ThrottlingData"},next:{title:"UnregisterKubernetesConnectionEvent",permalink:"/api/interfaces/UnregisterKubernetesConnectionEvent"}},a={},d=[{value:"Properties",id:"properties",level:2},{value:"providerId",id:"providerid",level:3},{value:"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",p:"p",strong:"strong",...(0,i.a)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.h1,{id:"interface-unregistercontainerconnectionevent",children:"Interface: UnregisterContainerConnectionEvent"}),"\n",(0,r.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,r.jsx)(n.h3,{id:"providerid",children:"providerId"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"providerId"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L688",children:"packages/extension-api/src/extension-api.d.ts:688"})})]})}function l(e={}){const{wrapper:n}={...(0,i.a)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(p,{...e})}):p(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>c,a:()=>s});var r=t(27378);const i={},o=r.createContext(i);function s(e){const n=r.useContext(o);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:s(e.components),r.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/49bee2be.a1cf9074.js b/assets/js/49bee2be.2b175c8e.js similarity index 97% rename from assets/js/49bee2be.a1cf9074.js rename to assets/js/49bee2be.2b175c8e.js index f3546c4c0d7..4936af18e48 100644 --- a/assets/js/49bee2be.a1cf9074.js +++ b/assets/js/49bee2be.2b175c8e.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[80448],{88557:(n,e,t)=>{t.r(e),t.d(e,{assets:()=>c,contentTitle:()=>s,default:()=>l,frontMatter:()=>o,metadata:()=>r,toc:()=>d});var i=t(24246),a=t(71670);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",p:"p",strong:"strong",...(0,a.a)(),...n.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(e.h1,{id:"function-navigatetocontainers",children:"Function: navigateToContainers()"}),"\n",(0,i.jsxs)(e.blockquote,{children:["\n",(0,i.jsxs)(e.p,{children:[(0,i.jsx)(e.strong,{children:"navigateToContainers"}),"(): ",(0,i.jsx)(e.code,{children:"Promise"}),"<",(0,i.jsx)(e.code,{children:"void"}),">"]}),"\n"]}),"\n",(0,i.jsx)(e.h2,{id:"returns",children:"Returns"}),"\n",(0,i.jsxs)(e.p,{children:[(0,i.jsx)(e.code,{children:"Promise"}),"<",(0,i.jsx)(e.code,{children:"void"}),">"]}),"\n",(0,i.jsx)(e.h2,{id:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L4428",children:"packages/extension-api/src/extension-api.d.ts:4428"})})]})}function l(n={}){const{wrapper:e}={...(0,a.a)(),...n.components};return e?(0,i.jsx)(e,{...n,children:(0,i.jsx)(u,{...n})}):u(n)}},71670:(n,e,t)=>{t.d(e,{Z:()=>r,a:()=>s});var i=t(27378);const a={},o=i.createContext(a);function s(n){const e=i.useContext(o);return i.useMemo((function(){return"function"==typeof n?n(e):{...e,...n}}),[e,n])}function r(n){let e;return e=n.disableParentContext?"function"==typeof n.components?n.components(a):n.components||a:s(n.components),i.createElement(o.Provider,{value:e},n.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[80448],{88557:(n,e,t)=>{t.r(e),t.d(e,{assets:()=>c,contentTitle:()=>s,default:()=>l,frontMatter:()=>o,metadata:()=>r,toc:()=>d});var i=t(24246),a=t(71670);const o={},s="Function: 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",p:"p",strong:"strong",...(0,a.a)(),...n.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(e.h1,{id:"function-navigatetocontainers",children:"Function: navigateToContainers()"}),"\n",(0,i.jsxs)(e.blockquote,{children:["\n",(0,i.jsxs)(e.p,{children:[(0,i.jsx)(e.strong,{children:"navigateToContainers"}),"(): ",(0,i.jsx)(e.code,{children:"Promise"}),"<",(0,i.jsx)(e.code,{children:"void"}),">"]}),"\n"]}),"\n",(0,i.jsx)(e.h2,{id:"returns",children:"Returns"}),"\n",(0,i.jsxs)(e.p,{children:[(0,i.jsx)(e.code,{children:"Promise"}),"<",(0,i.jsx)(e.code,{children:"void"}),">"]}),"\n",(0,i.jsx)(e.h2,{id:"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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L4428",children:"packages/extension-api/src/extension-api.d.ts:4428"})})]})}function l(n={}){const{wrapper:e}={...(0,a.a)(),...n.components};return e?(0,i.jsx)(e,{...n,children:(0,i.jsx)(u,{...n})}):u(n)}},71670:(n,e,t)=>{t.d(e,{Z:()=>r,a:()=>s});var i=t(27378);const a={},o=i.createContext(a);function s(n){const e=i.useContext(o);return i.useMemo((function(){return"function"==typeof n?n(e):{...e,...n}}),[e,n])}function r(n){let e;return e=n.disableParentContext?"function"==typeof n.components?n.components(a):n.components||a:s(n.components),i.createElement(o.Provider,{value:e},n.children)}}}]); \ No newline at end of file diff --git a/assets/js/49d9416a.70d10f6d.js b/assets/js/49d9416a.6a892cb3.js similarity index 98% rename from assets/js/49d9416a.70d10f6d.js rename to assets/js/49d9416a.6a892cb3.js index bfd859c3cf7..8cc71415496 100644 --- a/assets/js/49d9416a.70d10f6d.js +++ b/assets/js/49d9416a.6a892cb3.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[11077],{31978:(n,e,t)=>{t.r(e),t.d(e,{assets:()=>c,contentTitle:()=>a,default:()=>h,frontMatter:()=>r,metadata:()=>o,toc:()=>d});var i=t(24246),s=t(71670);const r={},a="Function: startContainer()",o={id:"namespaces/containerEngine/functions/startContainer",title:"Function: startContainer()",description:"startContainer(engineId, id): Promise\\",source:"@site/api/namespaces/containerEngine/functions/startContainer.md",sourceDirName:"namespaces/containerEngine/functions",slug:"/namespaces/containerEngine/functions/startContainer",permalink:"/api/namespaces/containerEngine/functions/startContainer",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"saveImage",permalink:"/api/namespaces/containerEngine/functions/saveImage"},next:{title:"startPod",permalink:"/api/namespaces/containerEngine/functions/startPod"}},c={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Defined in",id:"defined-in",level:2}];function l(n){const e={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,s.a)(),...n.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(e.h1,{id:"function-startcontainer",children:"Function: startContainer()"}),"\n",(0,i.jsxs)(e.blockquote,{children:["\n",(0,i.jsxs)(e.p,{children:[(0,i.jsx)(e.strong,{children:"startContainer"}),"(",(0,i.jsx)(e.code,{children:"engineId"}),", ",(0,i.jsx)(e.code,{children:"id"}),"): ",(0,i.jsx)(e.code,{children:"Promise"}),"<",(0,i.jsx)(e.code,{children:"void"}),">"]}),"\n"]}),"\n",(0,i.jsx)(e.p,{children:"Start an existing container"}),"\n",(0,i.jsx)(e.h2,{id:"parameters",children:"Parameters"}),"\n",(0,i.jsxs)(e.p,{children:["\u2022 ",(0,i.jsx)(e.strong,{children:"engineId"}),": ",(0,i.jsx)(e.code,{children:"string"})]}),"\n",(0,i.jsxs)(e.p,{children:["the id of the engine managing the container, obtained from the result of ",(0,i.jsx)(e.a,{href:"/api/namespaces/containerEngine/functions/listContainers",children:"containerEngine.listContainers"})]}),"\n",(0,i.jsxs)(e.p,{children:["\u2022 ",(0,i.jsx)(e.strong,{children:"id"}),": ",(0,i.jsx)(e.code,{children:"string"})]}),"\n",(0,i.jsxs)(e.p,{children:["the id or name of the container on this engine, obtained from the result of ",(0,i.jsx)(e.a,{href:"/api/namespaces/containerEngine/functions/listContainers",children:"containerEngine.listContainers"})," or as the result of ",(0,i.jsx)(e.a,{href:"/api/namespaces/containerEngine/functions/createContainer",children:"containerEngine.createContainer"})]}),"\n",(0,i.jsx)(e.h2,{id:"returns",children:"Returns"}),"\n",(0,i.jsxs)(e.p,{children:[(0,i.jsx)(e.code,{children:"Promise"}),"<",(0,i.jsx)(e.code,{children:"void"}),">"]}),"\n",(0,i.jsx)(e.h2,{id:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L3472",children:"packages/extension-api/src/extension-api.d.ts:3472"})})]})}function h(n={}){const{wrapper:e}={...(0,s.a)(),...n.components};return e?(0,i.jsx)(e,{...n,children:(0,i.jsx)(l,{...n})}):l(n)}},71670:(n,e,t)=>{t.d(e,{Z:()=>o,a:()=>a});var i=t(27378);const s={},r=i.createContext(s);function a(n){const e=i.useContext(r);return i.useMemo((function(){return"function"==typeof n?n(e):{...e,...n}}),[e,n])}function o(n){let e;return e=n.disableParentContext?"function"==typeof n.components?n.components(s):n.components||s:a(n.components),i.createElement(r.Provider,{value:e},n.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[11077],{31978:(n,e,t)=>{t.r(e),t.d(e,{assets:()=>c,contentTitle:()=>a,default:()=>h,frontMatter:()=>r,metadata:()=>o,toc:()=>d});var i=t(24246),s=t(71670);const r={},a="Function: startContainer()",o={id:"namespaces/containerEngine/functions/startContainer",title:"Function: startContainer()",description:"startContainer(engineId, id): Promise\\",source:"@site/api/namespaces/containerEngine/functions/startContainer.md",sourceDirName:"namespaces/containerEngine/functions",slug:"/namespaces/containerEngine/functions/startContainer",permalink:"/api/namespaces/containerEngine/functions/startContainer",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"saveImage",permalink:"/api/namespaces/containerEngine/functions/saveImage"},next:{title:"startPod",permalink:"/api/namespaces/containerEngine/functions/startPod"}},c={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Defined in",id:"defined-in",level:2}];function l(n){const e={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,s.a)(),...n.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(e.h1,{id:"function-startcontainer",children:"Function: startContainer()"}),"\n",(0,i.jsxs)(e.blockquote,{children:["\n",(0,i.jsxs)(e.p,{children:[(0,i.jsx)(e.strong,{children:"startContainer"}),"(",(0,i.jsx)(e.code,{children:"engineId"}),", ",(0,i.jsx)(e.code,{children:"id"}),"): ",(0,i.jsx)(e.code,{children:"Promise"}),"<",(0,i.jsx)(e.code,{children:"void"}),">"]}),"\n"]}),"\n",(0,i.jsx)(e.p,{children:"Start an existing container"}),"\n",(0,i.jsx)(e.h2,{id:"parameters",children:"Parameters"}),"\n",(0,i.jsxs)(e.p,{children:["\u2022 ",(0,i.jsx)(e.strong,{children:"engineId"}),": ",(0,i.jsx)(e.code,{children:"string"})]}),"\n",(0,i.jsxs)(e.p,{children:["the id of the engine managing the container, obtained from the result of ",(0,i.jsx)(e.a,{href:"/api/namespaces/containerEngine/functions/listContainers",children:"containerEngine.listContainers"})]}),"\n",(0,i.jsxs)(e.p,{children:["\u2022 ",(0,i.jsx)(e.strong,{children:"id"}),": ",(0,i.jsx)(e.code,{children:"string"})]}),"\n",(0,i.jsxs)(e.p,{children:["the id or name of the container on this engine, obtained from the result of ",(0,i.jsx)(e.a,{href:"/api/namespaces/containerEngine/functions/listContainers",children:"containerEngine.listContainers"})," or as the result of ",(0,i.jsx)(e.a,{href:"/api/namespaces/containerEngine/functions/createContainer",children:"containerEngine.createContainer"})]}),"\n",(0,i.jsx)(e.h2,{id:"returns",children:"Returns"}),"\n",(0,i.jsxs)(e.p,{children:[(0,i.jsx)(e.code,{children:"Promise"}),"<",(0,i.jsx)(e.code,{children:"void"}),">"]}),"\n",(0,i.jsx)(e.h2,{id:"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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L3472",children:"packages/extension-api/src/extension-api.d.ts:3472"})})]})}function h(n={}){const{wrapper:e}={...(0,s.a)(),...n.components};return e?(0,i.jsx)(e,{...n,children:(0,i.jsx)(l,{...n})}):l(n)}},71670:(n,e,t)=>{t.d(e,{Z:()=>o,a:()=>a});var i=t(27378);const s={},r=i.createContext(s);function a(n){const e=i.useContext(r);return i.useMemo((function(){return"function"==typeof n?n(e):{...e,...n}}),[e,n])}function o(n){let e;return e=n.disableParentContext?"function"==typeof n.components?n.components(s):n.components||s:a(n.components),i.createElement(r.Provider,{value:e},n.children)}}}]); \ No newline at end of file diff --git a/assets/js/4c217c25.3c2338da.js b/assets/js/4c217c25.1df348e9.js similarity index 97% rename from assets/js/4c217c25.3c2338da.js rename to assets/js/4c217c25.1df348e9.js index 2c81483a53b..214ae91b4d1 100644 --- a/assets/js/4c217c25.3c2338da.js +++ b/assets/js/4c217c25.1df348e9.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[81900],{23697:(n,e,t)=>{t.r(e),t.d(e,{assets:()=>c,contentTitle:()=>r,default:()=>p,frontMatter:()=>o,metadata:()=>a,toc:()=>l});var i=t(24246),s=t(71670);const o={},r="Function: listContainers()",a={id:"namespaces/containerEngine/functions/listContainers",title:"Function: listContainers()",description:"listContainers(): Promise\\",source:"@site/api/namespaces/containerEngine/functions/listContainers.md",sourceDirName:"namespaces/containerEngine/functions",slug:"/namespaces/containerEngine/functions/listContainers",permalink:"/api/namespaces/containerEngine/functions/listContainers",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"inspectManifest",permalink:"/api/namespaces/containerEngine/functions/inspectManifest"},next:{title:"listImages",permalink:"/api/namespaces/containerEngine/functions/listImages"}},c={},l=[{value:"Returns",id:"returns",level:2},{value:"Defined in",id:"defined-in",level:2}];function d(n){const e={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,s.a)(),...n.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(e.h1,{id:"function-listcontainers",children:"Function: listContainers()"}),"\n",(0,i.jsxs)(e.blockquote,{children:["\n",(0,i.jsxs)(e.p,{children:[(0,i.jsx)(e.strong,{children:"listContainers"}),"(): ",(0,i.jsx)(e.code,{children:"Promise"}),"<",(0,i.jsx)(e.a,{href:"/api/interfaces/ContainerInfo",children:(0,i.jsx)(e.code,{children:"ContainerInfo"})}),"[]>"]}),"\n"]}),"\n",(0,i.jsx)(e.p,{children:"Returns the list of containers across all container engines, in any state (running or not)."}),"\n",(0,i.jsx)(e.h2,{id:"returns",children:"Returns"}),"\n",(0,i.jsxs)(e.p,{children:[(0,i.jsx)(e.code,{children:"Promise"}),"<",(0,i.jsx)(e.a,{href:"/api/interfaces/ContainerInfo",children:(0,i.jsx)(e.code,{children:"ContainerInfo"})}),"[]>"]}),"\n",(0,i.jsxs)(e.p,{children:["A promise resolving to an array of containers information. This method returns a subset of the available information for containers. To get the complete description of a specific container, you can use the ",(0,i.jsx)(e.a,{href:"/api/namespaces/containerEngine/functions/inspectContainer",children:"containerEngine.inspectContainer"})," method."]}),"\n",(0,i.jsx)(e.h2,{id:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L3443",children:"packages/extension-api/src/extension-api.d.ts:3443"})})]})}function p(n={}){const{wrapper:e}={...(0,s.a)(),...n.components};return e?(0,i.jsx)(e,{...n,children:(0,i.jsx)(d,{...n})}):d(n)}},71670:(n,e,t)=>{t.d(e,{Z:()=>a,a:()=>r});var i=t(27378);const s={},o=i.createContext(s);function r(n){const e=i.useContext(o);return i.useMemo((function(){return"function"==typeof n?n(e):{...e,...n}}),[e,n])}function a(n){let e;return e=n.disableParentContext?"function"==typeof n.components?n.components(s):n.components||s:r(n.components),i.createElement(o.Provider,{value:e},n.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[81900],{23697:(n,e,t)=>{t.r(e),t.d(e,{assets:()=>c,contentTitle:()=>r,default:()=>p,frontMatter:()=>o,metadata:()=>a,toc:()=>l});var i=t(24246),s=t(71670);const o={},r="Function: listContainers()",a={id:"namespaces/containerEngine/functions/listContainers",title:"Function: listContainers()",description:"listContainers(): Promise\\",source:"@site/api/namespaces/containerEngine/functions/listContainers.md",sourceDirName:"namespaces/containerEngine/functions",slug:"/namespaces/containerEngine/functions/listContainers",permalink:"/api/namespaces/containerEngine/functions/listContainers",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"inspectManifest",permalink:"/api/namespaces/containerEngine/functions/inspectManifest"},next:{title:"listImages",permalink:"/api/namespaces/containerEngine/functions/listImages"}},c={},l=[{value:"Returns",id:"returns",level:2},{value:"Defined in",id:"defined-in",level:2}];function d(n){const e={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,s.a)(),...n.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(e.h1,{id:"function-listcontainers",children:"Function: listContainers()"}),"\n",(0,i.jsxs)(e.blockquote,{children:["\n",(0,i.jsxs)(e.p,{children:[(0,i.jsx)(e.strong,{children:"listContainers"}),"(): ",(0,i.jsx)(e.code,{children:"Promise"}),"<",(0,i.jsx)(e.a,{href:"/api/interfaces/ContainerInfo",children:(0,i.jsx)(e.code,{children:"ContainerInfo"})}),"[]>"]}),"\n"]}),"\n",(0,i.jsx)(e.p,{children:"Returns the list of containers across all container engines, in any state (running or not)."}),"\n",(0,i.jsx)(e.h2,{id:"returns",children:"Returns"}),"\n",(0,i.jsxs)(e.p,{children:[(0,i.jsx)(e.code,{children:"Promise"}),"<",(0,i.jsx)(e.a,{href:"/api/interfaces/ContainerInfo",children:(0,i.jsx)(e.code,{children:"ContainerInfo"})}),"[]>"]}),"\n",(0,i.jsxs)(e.p,{children:["A promise resolving to an array of containers information. This method returns a subset of the available information for containers. To get the complete description of a specific container, you can use the ",(0,i.jsx)(e.a,{href:"/api/namespaces/containerEngine/functions/inspectContainer",children:"containerEngine.inspectContainer"})," method."]}),"\n",(0,i.jsx)(e.h2,{id:"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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L3443",children:"packages/extension-api/src/extension-api.d.ts:3443"})})]})}function p(n={}){const{wrapper:e}={...(0,s.a)(),...n.components};return e?(0,i.jsx)(e,{...n,children:(0,i.jsx)(d,{...n})}):d(n)}},71670:(n,e,t)=>{t.d(e,{Z:()=>a,a:()=>r});var i=t(27378);const s={},o=i.createContext(s);function r(n){const e=i.useContext(o);return i.useMemo((function(){return"function"==typeof n?n(e):{...e,...n}}),[e,n])}function a(n){let e;return e=n.disableParentContext?"function"==typeof n.components?n.components(s):n.components||s:r(n.components),i.createElement(o.Provider,{value:e},n.children)}}}]); \ No newline at end of file diff --git a/assets/js/4c5becac.59f99f99.js b/assets/js/4c5becac.c23a41d2.js similarity index 94% rename from assets/js/4c5becac.59f99f99.js rename to assets/js/4c5becac.c23a41d2.js index 203b530f354..dc2739cb6c0 100644 --- a/assets/js/4c5becac.59f99f99.js +++ b/assets/js/4c5becac.c23a41d2.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[74961],{65340:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>l,contentTitle:()=>d,default:()=>h,frontMatter:()=>r,metadata:()=>c,toc:()=>o});var t=s(24246),i=s(71670);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",hr:"hr",p:"p",strong:"strong",...(0,i.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{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/804b2198fda0957e1ecfb87539f019eb9b79a66f/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/804b2198fda0957e1ecfb87539f019eb9b79a66f/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.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/804b2198fda0957e1ecfb87539f019eb9b79a66f/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.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(a,{...e})}):a(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>c,a:()=>d});var t=s(27378);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([[74961],{65340:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>l,contentTitle:()=>d,default:()=>h,frontMatter:()=>r,metadata:()=>c,toc:()=>o});var t=s(24246),i=s(71670);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",hr:"hr",p:"p",strong:"strong",...(0,i.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{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/bd83a8b2bb8ab886dc757381b589638cbda150d0/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/bd83a8b2bb8ab886dc757381b589638cbda150d0/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.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/bd83a8b2bb8ab886dc757381b589638cbda150d0/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.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(a,{...e})}):a(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>c,a:()=>d});var t=s(27378);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.d4b655c1.js b/assets/js/4f425ff4.e829c062.js similarity index 98% rename from assets/js/4f425ff4.d4b655c1.js rename to assets/js/4f425ff4.e829c062.js index fbd5fa790de..4ddf6ee8b4a 100644 --- a/assets/js/4f425ff4.d4b655c1.js +++ b/assets/js/4f425ff4.e829c062.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[89799],{45174:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>a,contentTitle:()=>r,default:()=>p,frontMatter:()=>o,metadata:()=>c,toc:()=>d});var i=s(24246),t=s(71670);const o={},r="Function: onDidUpdateContainerConnection()",c={id:"namespaces/provider/functions/onDidUpdateContainerConnection",title:"Function: onDidUpdateContainerConnection()",description:"onDidUpdateContainerConnection(listener, thisArgs?, disposables?): Disposable",source:"@site/api/namespaces/provider/functions/onDidUpdateContainerConnection.md",sourceDirName:"namespaces/provider/functions",slug:"/namespaces/provider/functions/onDidUpdateContainerConnection",permalink:"/api/namespaces/provider/functions/onDidUpdateContainerConnection",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"onDidUnregisterContainerConnection",permalink:"/api/namespaces/provider/functions/onDidUnregisterContainerConnection"},next:{title:"onDidUpdateKubernetesConnection",permalink:"/api/namespaces/provider/functions/onDidUpdateKubernetesConnection"}},a={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Defined in",id:"defined-in",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,t.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"function-ondidupdatecontainerconnection",children:"Function: onDidUpdateContainerConnection()"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"onDidUpdateContainerConnection"}),"(",(0,i.jsx)(n.code,{children:"listener"}),", ",(0,i.jsx)(n.code,{children:"thisArgs"}),"?, ",(0,i.jsx)(n.code,{children:"disposables"}),"?): ",(0,i.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(n.code,{children:"Disposable"})})]}),"\n"]}),"\n",(0,i.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"listener"})]}),"\n",(0,i.jsx)(n.p,{children:"The listener function will be called when the event happens."}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"thisArgs?"}),": ",(0,i.jsx)(n.code,{children:"any"})]}),"\n",(0,i.jsxs)(n.p,{children:["The ",(0,i.jsx)(n.code,{children:"this"}),"-argument which will be used when calling the event listener."]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"disposables?"}),": ",(0,i.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(n.code,{children:"Disposable"})}),"[]"]}),"\n",(0,i.jsxs)(n.p,{children:["An array to which a ",(0,i.jsx)(n.a,{href:"/api/classes/Disposable",children:"Disposable"})," will be added."]}),"\n",(0,i.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(n.code,{children:"Disposable"})})}),"\n",(0,i.jsx)(n.p,{children:"A disposable which unsubscribes the event listener."}),"\n",(0,i.jsx)(n.h2,{id:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L812",children:"packages/extension-api/src/extension-api.d.ts:812"})})]})}function p(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>c,a:()=>r});var i=s(27378);const t={},o=i.createContext(t);function r(e){const n=i.useContext(o);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:r(e.components),i.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[89799],{45174:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>a,contentTitle:()=>r,default:()=>p,frontMatter:()=>o,metadata:()=>c,toc:()=>d});var i=s(24246),t=s(71670);const o={},r="Function: onDidUpdateContainerConnection()",c={id:"namespaces/provider/functions/onDidUpdateContainerConnection",title:"Function: onDidUpdateContainerConnection()",description:"onDidUpdateContainerConnection(listener, thisArgs?, disposables?): Disposable",source:"@site/api/namespaces/provider/functions/onDidUpdateContainerConnection.md",sourceDirName:"namespaces/provider/functions",slug:"/namespaces/provider/functions/onDidUpdateContainerConnection",permalink:"/api/namespaces/provider/functions/onDidUpdateContainerConnection",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"onDidUnregisterContainerConnection",permalink:"/api/namespaces/provider/functions/onDidUnregisterContainerConnection"},next:{title:"onDidUpdateKubernetesConnection",permalink:"/api/namespaces/provider/functions/onDidUpdateKubernetesConnection"}},a={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Defined in",id:"defined-in",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,t.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"function-ondidupdatecontainerconnection",children:"Function: onDidUpdateContainerConnection()"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"onDidUpdateContainerConnection"}),"(",(0,i.jsx)(n.code,{children:"listener"}),", ",(0,i.jsx)(n.code,{children:"thisArgs"}),"?, ",(0,i.jsx)(n.code,{children:"disposables"}),"?): ",(0,i.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(n.code,{children:"Disposable"})})]}),"\n"]}),"\n",(0,i.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"listener"})]}),"\n",(0,i.jsx)(n.p,{children:"The listener function will be called when the event happens."}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"thisArgs?"}),": ",(0,i.jsx)(n.code,{children:"any"})]}),"\n",(0,i.jsxs)(n.p,{children:["The ",(0,i.jsx)(n.code,{children:"this"}),"-argument which will be used when calling the event listener."]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"disposables?"}),": ",(0,i.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(n.code,{children:"Disposable"})}),"[]"]}),"\n",(0,i.jsxs)(n.p,{children:["An array to which a ",(0,i.jsx)(n.a,{href:"/api/classes/Disposable",children:"Disposable"})," will be added."]}),"\n",(0,i.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(n.code,{children:"Disposable"})})}),"\n",(0,i.jsx)(n.p,{children:"A disposable which unsubscribes the event listener."}),"\n",(0,i.jsx)(n.h2,{id:"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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L812",children:"packages/extension-api/src/extension-api.d.ts:812"})})]})}function p(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>c,a:()=>r});var i=s(27378);const t={},o=i.createContext(t);function r(e){const n=i.useContext(o);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:r(e.components),i.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/4f9e8711.936dfb19.js b/assets/js/4f9e8711.abebb938.js similarity index 84% rename from assets/js/4f9e8711.936dfb19.js rename to assets/js/4f9e8711.abebb938.js index 33b39d498cc..1b7747e64bc 100644 --- a/assets/js/4f9e8711.936dfb19.js +++ b/assets/js/4f9e8711.abebb938.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[27177],{23912:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>d,contentTitle:()=>c,default:()=>h,frontMatter:()=>o,metadata:()=>s,toc:()=>a});var t=i(24246),r=i(71670);const o={},c="Interface: ProviderConnectionFactory",s={id:"interfaces/ProviderConnectionFactory",title:"Interface: ProviderConnectionFactory",description:"Extended by",source:"@site/api/interfaces/ProviderConnectionFactory.md",sourceDirName:"interfaces",slug:"/interfaces/ProviderConnectionFactory",permalink:"/api/interfaces/ProviderConnectionFactory",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"ProviderCleanupExecuteOptions",permalink:"/api/interfaces/ProviderCleanupExecuteOptions"},next:{title:"ProviderConnectionLifecycle",permalink:"/api/interfaces/ProviderConnectionLifecycle"}},d={},a=[{value:"Extended by",id:"extended-by",level:2},{value:"Properties",id:"properties",level:2},{value:"creationButtonTitle?",id:"creationbuttontitle",level:3},{value:"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",hr:"hr",li:"li",p:"p",strong:"strong",ul:"ul",...(0,r.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"interface-providerconnectionfactory",children:"Interface: ProviderConnectionFactory"}),"\n",(0,t.jsx)(n.h2,{id:"extended-by",children:"Extended by"}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsx)(n.li,{children:(0,t.jsx)(n.a,{href:"/api/interfaces/ContainerProviderConnectionFactory",children:(0,t.jsx)(n.code,{children:"ContainerProviderConnectionFactory"})})}),"\n",(0,t.jsx)(n.li,{children:(0,t.jsx)(n.a,{href:"/api/interfaces/KubernetesProviderConnectionFactory",children:(0,t.jsx)(n.code,{children:"KubernetesProviderConnectionFactory"})})}),"\n"]}),"\n",(0,t.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,t.jsx)(n.h3,{id:"creationbuttontitle",children:"creationButtonTitle?"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"optional"})," ",(0,t.jsx)(n.strong,{children:"creationButtonTitle"}),": ",(0,t.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L478",children:"packages/extension-api/src/extension-api.d.ts:478"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L475",children:"packages/extension-api/src/extension-api.d.ts:475"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L472",children:"packages/extension-api/src/extension-api.d.ts:472"})})]})}function h(e={}){const{wrapper:n}={...(0,r.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>s,a:()=>c});var t=i(27378);const r={},o=t.createContext(r);function c(e){const n=t.useContext(o);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function s(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:c(e.components),t.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[27177],{23912:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>s,contentTitle:()=>c,default:()=>h,frontMatter:()=>o,metadata:()=>d,toc:()=>a});var t=i(24246),r=i(71670);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",hr:"hr",li:"li",p:"p",strong:"strong",ul:"ul",...(0,r.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"interface-providerconnectionfactory",children:"Interface: ProviderConnectionFactory"}),"\n",(0,t.jsx)(n.h2,{id:"extended-by",children:"Extended by"}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsx)(n.li,{children:(0,t.jsx)(n.a,{href:"/api/interfaces/ContainerProviderConnectionFactory",children:(0,t.jsx)(n.code,{children:"ContainerProviderConnectionFactory"})})}),"\n",(0,t.jsx)(n.li,{children:(0,t.jsx)(n.a,{href:"/api/interfaces/KubernetesProviderConnectionFactory",children:(0,t.jsx)(n.code,{children:"KubernetesProviderConnectionFactory"})})}),"\n"]}),"\n",(0,t.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,t.jsx)(n.h3,{id:"creationbuttontitle",children:"creationButtonTitle?"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"optional"})," ",(0,t.jsx)(n.strong,{children:"creationButtonTitle"}),": ",(0,t.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L478",children:"packages/extension-api/src/extension-api.d.ts:478"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L475",children:"packages/extension-api/src/extension-api.d.ts:475"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L472",children:"packages/extension-api/src/extension-api.d.ts:472"})})]})}function h(e={}){const{wrapper:n}={...(0,r.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>d,a:()=>c});var t=i(27378);const r={},o=t.createContext(r);function c(e){const n=t.useContext(o);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function 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 diff --git a/assets/js/5046ea8f.052d116d.js b/assets/js/5046ea8f.7eeebda8.js similarity index 84% rename from assets/js/5046ea8f.052d116d.js rename to assets/js/5046ea8f.7eeebda8.js index 32156da2d5f..2f05ff0213c 100644 --- a/assets/js/5046ea8f.052d116d.js +++ b/assets/js/5046ea8f.7eeebda8.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[75167],{55434:(e,s,t)=>{t.r(s),t.d(s,{assets:()=>a,contentTitle:()=>c,default:()=>u,frontMatter:()=>i,metadata:()=>o,toc:()=>d});var n=t(24246),r=t(71670);const i={},c="Function: suggestRegistry()",o={id:"namespaces/registry/functions/suggestRegistry",title:"Function: suggestRegistry()",description:"suggestRegistry(registry): Disposable",source:"@site/api/namespaces/registry/functions/suggestRegistry.md",sourceDirName:"namespaces/registry/functions",slug:"/namespaces/registry/functions/suggestRegistry",permalink:"/api/namespaces/registry/functions/suggestRegistry",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"registerRegistryProvider",permalink:"/api/namespaces/registry/functions/registerRegistryProvider"},next:{title:"unregisterRegistry",permalink:"/api/namespaces/registry/functions/unregisterRegistry"}},a={},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",p:"p",strong:"strong",...(0,r.a)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(s.h1,{id:"function-suggestregistry",children:"Function: suggestRegistry()"}),"\n",(0,n.jsxs)(s.blockquote,{children:["\n",(0,n.jsxs)(s.p,{children:[(0,n.jsx)(s.strong,{children:"suggestRegistry"}),"(",(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/RegistrySuggestedProvider",children:(0,n.jsx)(s.code,{children:"RegistrySuggestedProvider"})})]}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L908",children:"packages/extension-api/src/extension-api.d.ts:908"})})]})}function u(e={}){const{wrapper:s}={...(0,r.a)(),...e.components};return s?(0,n.jsx)(s,{...e,children:(0,n.jsx)(g,{...e})}):g(e)}},71670:(e,s,t)=>{t.d(s,{Z:()=>o,a:()=>c});var n=t(27378);const r={},i=n.createContext(r);function c(e){const s=n.useContext(i);return n.useMemo((function(){return"function"==typeof e?e(s):{...s,...e}}),[s,e])}function o(e){let s;return s=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:c(e.components),n.createElement(i.Provider,{value:s},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[75167],{55434:(e,s,t)=>{t.r(s),t.d(s,{assets:()=>o,contentTitle:()=>c,default:()=>u,frontMatter:()=>i,metadata:()=>a,toc:()=>d});var n=t(24246),r=t(71670);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",p:"p",strong:"strong",...(0,r.a)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(s.h1,{id:"function-suggestregistry",children:"Function: suggestRegistry()"}),"\n",(0,n.jsxs)(s.blockquote,{children:["\n",(0,n.jsxs)(s.p,{children:[(0,n.jsx)(s.strong,{children:"suggestRegistry"}),"(",(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/RegistrySuggestedProvider",children:(0,n.jsx)(s.code,{children:"RegistrySuggestedProvider"})})]}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L908",children:"packages/extension-api/src/extension-api.d.ts:908"})})]})}function u(e={}){const{wrapper:s}={...(0,r.a)(),...e.components};return s?(0,n.jsx)(s,{...e,children:(0,n.jsx)(g,{...e})}):g(e)}},71670:(e,s,t)=>{t.d(s,{Z:()=>a,a:()=>c});var n=t(27378);const r={},i=n.createContext(r);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(r):e.components||r:c(e.components),n.createElement(i.Provider,{value:s},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/54d805e4.8012831c.js b/assets/js/54d805e4.89519418.js similarity index 82% rename from assets/js/54d805e4.8012831c.js rename to assets/js/54d805e4.89519418.js index 1fc19fd005d..9bd6d205c55 100644 --- a/assets/js/54d805e4.8012831c.js +++ b/assets/js/54d805e4.89519418.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[33356],{63845:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>c,contentTitle:()=>r,default:()=>h,frontMatter:()=>o,metadata:()=>d,toc:()=>a});var s=i(24246),t=i(71670);const o={},r="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"}},c={},a=[{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",hr:"hr",p:"p",strong:"strong",...(0,t.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"interface-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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L3398",children:"packages/extension-api/src/extension-api.d.ts:3398"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L3399",children:"packages/extension-api/src/extension-api.d.ts:3399"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L3400",children:"packages/extension-api/src/extension-api.d.ts:3400"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L3401",children:"packages/extension-api/src/extension-api.d.ts:3401"})})]})}function h(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>d,a:()=>r});var s=i(27378);const t={},o=s.createContext(t);function r(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:r(e.components),s.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[33356],{63845:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>c,contentTitle:()=>o,default:()=>h,frontMatter:()=>d,metadata:()=>r,toc:()=>a});var s=i(24246),t=i(71670);const d={},o="Interface: VolumeListInfo",r={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"}},c={},a=[{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",hr:"hr",p:"p",strong:"strong",...(0,t.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"interface-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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L3398",children:"packages/extension-api/src/extension-api.d.ts:3398"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L3399",children:"packages/extension-api/src/extension-api.d.ts:3399"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L3400",children:"packages/extension-api/src/extension-api.d.ts:3400"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L3401",children:"packages/extension-api/src/extension-api.d.ts:3401"})})]})}function h(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>r,a:()=>o});var s=i(27378);const t={},d=s.createContext(t);function o(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:o(e.components),s.createElement(d.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/56a9df4f.c2a9f26b.js b/assets/js/56a9df4f.01e2995d.js similarity index 86% rename from assets/js/56a9df4f.c2a9f26b.js rename to assets/js/56a9df4f.01e2995d.js index 7a935483428..0f0a1c6c049 100644 --- a/assets/js/56a9df4f.c2a9f26b.js +++ b/assets/js/56a9df4f.01e2995d.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[97355],{90873:(e,i,n)=>{n.r(i),n.d(i,{assets:()=>c,contentTitle:()=>l,default:()=>o,frontMatter:()=>r,metadata:()=>a,toc:()=>t});var d=n(24246),s=n(71670);const r={},l="Interface: ImageFileSymlink",a={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",hr:"hr",li:"li",p:"p",strong:"strong",ul:"ul",...(0,s.a)(),...e.components};return(0,d.jsxs)(d.Fragment,{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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L717",children:"packages/extension-api/src/extension-api.d.ts:717"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L716",children:"packages/extension-api/src/extension-api.d.ts:716"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L714",children:"packages/extension-api/src/extension-api.d.ts:714"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L727",children:"packages/extension-api/src/extension-api.d.ts:727"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L712",children:"packages/extension-api/src/extension-api.d.ts:712"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L718",children:"packages/extension-api/src/extension-api.d.ts:718"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L709",children:"packages/extension-api/src/extension-api.d.ts:709"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L715",children:"packages/extension-api/src/extension-api.d.ts:715"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L725",children:"packages/extension-api/src/extension-api.d.ts:725"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L713",children:"packages/extension-api/src/extension-api.d.ts:713"})})]})}function o(e={}){const{wrapper:i}={...(0,s.a)(),...e.components};return i?(0,d.jsx)(i,{...e,children:(0,d.jsx)(h,{...e})}):h(e)}},71670:(e,i,n)=>{n.d(i,{Z:()=>a,a:()=>l});var d=n(27378);const s={},r=d.createContext(s);function l(e){const i=d.useContext(r);return d.useMemo((function(){return"function"==typeof e?e(i):{...i,...e}}),[i,e])}function a(e){let i;return i=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:l(e.components),d.createElement(r.Provider,{value:i},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[97355],{90873:(e,i,n)=>{n.r(i),n.d(i,{assets:()=>c,contentTitle:()=>a,default:()=>o,frontMatter:()=>r,metadata:()=>l,toc:()=>t});var d=n(24246),s=n(71670);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",hr:"hr",li:"li",p:"p",strong:"strong",ul:"ul",...(0,s.a)(),...e.components};return(0,d.jsxs)(d.Fragment,{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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L717",children:"packages/extension-api/src/extension-api.d.ts:717"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L716",children:"packages/extension-api/src/extension-api.d.ts:716"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L714",children:"packages/extension-api/src/extension-api.d.ts:714"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L727",children:"packages/extension-api/src/extension-api.d.ts:727"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L712",children:"packages/extension-api/src/extension-api.d.ts:712"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L718",children:"packages/extension-api/src/extension-api.d.ts:718"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L709",children:"packages/extension-api/src/extension-api.d.ts:709"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L715",children:"packages/extension-api/src/extension-api.d.ts:715"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L725",children:"packages/extension-api/src/extension-api.d.ts:725"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L713",children:"packages/extension-api/src/extension-api.d.ts:713"})})]})}function o(e={}){const{wrapper:i}={...(0,s.a)(),...e.components};return i?(0,d.jsx)(i,{...e,children:(0,d.jsx)(h,{...e})}):h(e)}},71670:(e,i,n)=>{n.d(i,{Z:()=>l,a:()=>a});var d=n(27378);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.18258b5c.js b/assets/js/57a8015d.2c32bb17.js similarity index 96% rename from assets/js/57a8015d.18258b5c.js rename to assets/js/57a8015d.2c32bb17.js index 44eca51ff34..049bb727a0d 100644 --- a/assets/js/57a8015d.18258b5c.js +++ b/assets/js/57a8015d.2c32bb17.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[27268],{85996:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>r,contentTitle:()=>o,default:()=>v,frontMatter:()=>a,metadata:()=>c,toc:()=>d});var s=i(24246),t=i(71670);const a={},o="Function: navigateToWebview()",c={id:"namespaces/navigation/functions/navigateToWebview",title:"Function: navigateToWebview()",description:"navigateToWebview(webviewId): Promise\\",source:"@site/api/namespaces/navigation/functions/navigateToWebview.md",sourceDirName:"namespaces/navigation/functions",slug:"/namespaces/navigation/functions/navigateToWebview",permalink:"/api/namespaces/navigation/functions/navigateToWebview",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"navigateToVolumes",permalink:"/api/namespaces/navigation/functions/navigateToVolumes"},next:{title:"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",li:"li",p:"p",strong:"strong",ul:"ul",...(0,t.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"function-navigatetowebview",children:"Function: navigateToWebview()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"navigateToWebview"}),"(",(0,s.jsx)(n.code,{children:"webviewId"}),"): ",(0,s.jsx)(n.code,{children:"Promise"}),"<",(0,s.jsx)(n.code,{children:"void"}),">"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Navigate to a specific Webview"}),"\n",(0,s.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"webviewId"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n",(0,s.jsx)(n.p,{children:"The id of the Webview to navigate to"}),"\n",(0,s.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"Promise"}),"<",(0,s.jsx)(n.code,{children:"void"}),">"]}),"\n",(0,s.jsx)(n.h2,{id:"see",children:"See"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.a,{href:"/api/namespaces/window/functions/listWebviews",children:"listWebviews"})," to get a list of Webviews and their ids"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.a,{href:"/api/namespaces/window/functions/createWebviewPanel",children:"createWebviewPanel"})," for creating a Webview"]}),"\n"]}),"\n",(0,s.jsx)(n.h2,{id:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L4462",children:"packages/extension-api/src/extension-api.d.ts:4462"})})]})}function v(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>c,a:()=>o});var s=i(27378);const t={},a=s.createContext(t);function o(e){const n=s.useContext(a);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:o(e.components),s.createElement(a.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[27268],{85996:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>r,contentTitle:()=>o,default:()=>v,frontMatter:()=>a,metadata:()=>c,toc:()=>d});var s=i(24246),t=i(71670);const a={},o="Function: navigateToWebview()",c={id:"namespaces/navigation/functions/navigateToWebview",title:"Function: navigateToWebview()",description:"navigateToWebview(webviewId): Promise\\",source:"@site/api/namespaces/navigation/functions/navigateToWebview.md",sourceDirName:"namespaces/navigation/functions",slug:"/namespaces/navigation/functions/navigateToWebview",permalink:"/api/namespaces/navigation/functions/navigateToWebview",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"navigateToVolumes",permalink:"/api/namespaces/navigation/functions/navigateToVolumes"},next:{title:"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",li:"li",p:"p",strong:"strong",ul:"ul",...(0,t.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"function-navigatetowebview",children:"Function: navigateToWebview()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"navigateToWebview"}),"(",(0,s.jsx)(n.code,{children:"webviewId"}),"): ",(0,s.jsx)(n.code,{children:"Promise"}),"<",(0,s.jsx)(n.code,{children:"void"}),">"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Navigate to a specific Webview"}),"\n",(0,s.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"webviewId"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n",(0,s.jsx)(n.p,{children:"The id of the Webview to navigate to"}),"\n",(0,s.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"Promise"}),"<",(0,s.jsx)(n.code,{children:"void"}),">"]}),"\n",(0,s.jsx)(n.h2,{id:"see",children:"See"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.a,{href:"/api/namespaces/window/functions/listWebviews",children:"listWebviews"})," to get a list of Webviews and their ids"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.a,{href:"/api/namespaces/window/functions/createWebviewPanel",children:"createWebviewPanel"})," for creating a Webview"]}),"\n"]}),"\n",(0,s.jsx)(n.h2,{id:"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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L4462",children:"packages/extension-api/src/extension-api.d.ts:4462"})})]})}function v(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>c,a:()=>o});var s=i(27378);const t={},a=s.createContext(t);function o(e){const n=s.useContext(a);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:o(e.components),s.createElement(a.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/57dba496.56a0a8ac.js b/assets/js/57dba496.a1c375a3.js similarity index 87% rename from assets/js/57dba496.56a0a8ac.js rename to assets/js/57dba496.a1c375a3.js index 48447a62533..cfbb8e1de47 100644 --- a/assets/js/57dba496.56a0a8ac.js +++ b/assets/js/57dba496.a1c375a3.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[5886],{59278:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>o,contentTitle:()=>d,default:()=>h,frontMatter:()=>t,metadata:()=>c,toc:()=>l});var s=i(24246),r=i(71670);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",hr:"hr",p:"p",strong:"strong",...(0,r.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"interface-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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L2670",children:"packages/extension-api/src/extension-api.d.ts:2670"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L2671",children:"packages/extension-api/src/extension-api.d.ts:2671"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L2663",children:"packages/extension-api/src/extension-api.d.ts:2663"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L2665",children:"packages/extension-api/src/extension-api.d.ts:2665"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L2666",children:"packages/extension-api/src/extension-api.d.ts:2666"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L2664",children:"packages/extension-api/src/extension-api.d.ts:2664"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L2662",children:"packages/extension-api/src/extension-api.d.ts:2662"})})]})}function h(e={}){const{wrapper:n}={...(0,r.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(a,{...e})}):a(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>c,a:()=>d});var s=i(27378);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([[5886],{59278:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>o,contentTitle:()=>t,default:()=>h,frontMatter:()=>d,metadata:()=>c,toc:()=>l});var s=i(24246),r=i(71670);const d={},t="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",hr:"hr",p:"p",strong:"strong",...(0,r.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"interface-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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2670",children:"packages/extension-api/src/extension-api.d.ts:2670"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2671",children:"packages/extension-api/src/extension-api.d.ts:2671"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2663",children:"packages/extension-api/src/extension-api.d.ts:2663"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2665",children:"packages/extension-api/src/extension-api.d.ts:2665"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2666",children:"packages/extension-api/src/extension-api.d.ts:2666"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2664",children:"packages/extension-api/src/extension-api.d.ts:2664"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2662",children:"packages/extension-api/src/extension-api.d.ts:2662"})})]})}function h(e={}){const{wrapper:n}={...(0,r.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(a,{...e})}):a(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>c,a:()=>t});var s=i(27378);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/57e01cd5.bf0916c6.js b/assets/js/57e01cd5.09087985.js similarity index 82% rename from assets/js/57e01cd5.bf0916c6.js rename to assets/js/57e01cd5.09087985.js index 93688dd0faf..914842cac57 100644 --- a/assets/js/57e01cd5.bf0916c6.js +++ b/assets/js/57e01cd5.09087985.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[43546],{39734:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>o,contentTitle:()=>r,default:()=>d,frontMatter:()=>i,metadata:()=>l,toc:()=>c});var a=n(24246),s=n(71670);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 p(e){const t={a:"a",blockquote:"blockquote",code:"code",em:"em",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,a.jsxs)(a.Fragment,{children:[(0,a.jsx)(t.h1,{id:"type-alias-statusbaralignment",children:"Type Alias: StatusBarAlignment"}),"\n",(0,a.jsxs)(t.blockquote,{children:["\n",(0,a.jsxs)(t.p,{children:[(0,a.jsx)(t.strong,{children:"StatusBarAlignment"}),": ",(0,a.jsx)(t.em,{children:"typeof"})," ",(0,a.jsx)(t.a,{href:"/api/variables/StatusBarAlignLeft",children:(0,a.jsx)(t.code,{children:"StatusBarAlignLeft"})})," | ",(0,a.jsx)(t.em,{children:"typeof"})," ",(0,a.jsx)(t.a,{href:"/api/variables/StatusBarAlignRight",children:(0,a.jsx)(t.code,{children:"StatusBarAlignRight"})})]}),"\n"]}),"\n",(0,a.jsx)(t.p,{children:"Represents the alignment of status bar items."}),"\n",(0,a.jsx)(t.h2,{id:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L1470",children:"packages/extension-api/src/extension-api.d.ts:1470"})})]})}function d(e={}){const{wrapper:t}={...(0,s.a)(),...e.components};return t?(0,a.jsx)(t,{...e,children:(0,a.jsx)(p,{...e})}):p(e)}},71670:(e,t,n)=>{n.d(t,{Z:()=>l,a:()=>r});var a=n(27378);const s={},i=a.createContext(s);function r(e){const t=a.useContext(i);return a.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function 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([[43546],{39734:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>o,contentTitle:()=>r,default:()=>p,frontMatter:()=>i,metadata:()=>l,toc:()=>c});var a=n(24246),s=n(71670);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",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,a.jsxs)(a.Fragment,{children:[(0,a.jsx)(t.h1,{id:"type-alias-statusbaralignment",children:"Type Alias: StatusBarAlignment"}),"\n",(0,a.jsxs)(t.blockquote,{children:["\n",(0,a.jsxs)(t.p,{children:[(0,a.jsx)(t.strong,{children:"StatusBarAlignment"}),": ",(0,a.jsx)(t.em,{children:"typeof"})," ",(0,a.jsx)(t.a,{href:"/api/variables/StatusBarAlignLeft",children:(0,a.jsx)(t.code,{children:"StatusBarAlignLeft"})})," | ",(0,a.jsx)(t.em,{children:"typeof"})," ",(0,a.jsx)(t.a,{href:"/api/variables/StatusBarAlignRight",children:(0,a.jsx)(t.code,{children:"StatusBarAlignRight"})})]}),"\n"]}),"\n",(0,a.jsx)(t.p,{children:"Represents the alignment of status bar items."}),"\n",(0,a.jsx)(t.h2,{id:"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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L1470",children:"packages/extension-api/src/extension-api.d.ts:1470"})})]})}function p(e={}){const{wrapper:t}={...(0,s.a)(),...e.components};return t?(0,a.jsx)(t,{...e,children:(0,a.jsx)(d,{...e})}):d(e)}},71670:(e,t,n)=>{n.d(t,{Z:()=>l,a:()=>r});var a=n(27378);const s={},i=a.createContext(s);function r(e){const t=a.useContext(i);return a.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function 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.9c5cddee.js b/assets/js/5a7aef43.05c2a381.js similarity index 94% rename from assets/js/5a7aef43.9c5cddee.js rename to assets/js/5a7aef43.05c2a381.js index b5d681f2869..f9ee51a914b 100644 --- a/assets/js/5a7aef43.9c5cddee.js +++ b/assets/js/5a7aef43.05c2a381.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[59081],{68341:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>r,contentTitle:()=>o,default:()=>p,frontMatter:()=>s,metadata:()=>c,toc:()=>d});var a=t(24246),i=t(71670);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",p:"p",strong:"strong",...(0,i.a)(),...e.components};return(0,a.jsxs)(a.Fragment,{children:[(0,a.jsx)(n.h1,{id:"function-navigatetoimages",children:"Function: navigateToImages()"}),"\n",(0,a.jsxs)(n.blockquote,{children:["\n",(0,a.jsxs)(n.p,{children:[(0,a.jsx)(n.strong,{children:"navigateToImages"}),"(): ",(0,a.jsx)(n.code,{children:"Promise"}),"<",(0,a.jsx)(n.code,{children:"void"}),">"]}),"\n"]}),"\n",(0,a.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,a.jsxs)(n.p,{children:[(0,a.jsx)(n.code,{children:"Promise"}),"<",(0,a.jsx)(n.code,{children:"void"}),">"]}),"\n",(0,a.jsx)(n.h2,{id:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L4439",children:"packages/extension-api/src/extension-api.d.ts:4439"})})]})}function p(e={}){const{wrapper:n}={...(0,i.a)(),...e.components};return n?(0,a.jsx)(n,{...e,children:(0,a.jsx)(u,{...e})}):u(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>c,a:()=>o});var a=t(27378);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([[59081],{68341:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>r,contentTitle:()=>o,default:()=>p,frontMatter:()=>s,metadata:()=>c,toc:()=>d});var a=t(24246),i=t(71670);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",p:"p",strong:"strong",...(0,i.a)(),...e.components};return(0,a.jsxs)(a.Fragment,{children:[(0,a.jsx)(n.h1,{id:"function-navigatetoimages",children:"Function: navigateToImages()"}),"\n",(0,a.jsxs)(n.blockquote,{children:["\n",(0,a.jsxs)(n.p,{children:[(0,a.jsx)(n.strong,{children:"navigateToImages"}),"(): ",(0,a.jsx)(n.code,{children:"Promise"}),"<",(0,a.jsx)(n.code,{children:"void"}),">"]}),"\n"]}),"\n",(0,a.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,a.jsxs)(n.p,{children:[(0,a.jsx)(n.code,{children:"Promise"}),"<",(0,a.jsx)(n.code,{children:"void"}),">"]}),"\n",(0,a.jsx)(n.h2,{id:"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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L4439",children:"packages/extension-api/src/extension-api.d.ts:4439"})})]})}function p(e={}){const{wrapper:n}={...(0,i.a)(),...e.components};return n?(0,a.jsx)(n,{...e,children:(0,a.jsx)(u,{...e})}):u(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>c,a:()=>o});var a=t(27378);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.294226ac.js b/assets/js/5a9a7a02.b215f246.js similarity index 97% rename from assets/js/5a9a7a02.294226ac.js rename to assets/js/5a9a7a02.b215f246.js index 095bb892db8..b49bac5133c 100644 --- a/assets/js/5a9a7a02.294226ac.js +++ b/assets/js/5a9a7a02.b215f246.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[89472],{27807:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>c,default:()=>u,frontMatter:()=>o,metadata:()=>r,toc:()=>d});var s=t(24246),i=t(71670);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",p:"p",strong:"strong",...(0,i.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"function-deletevolume",children:"Function: deleteVolume()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"deleteVolume"}),"(",(0,s.jsx)(n.code,{children:"volumeName"}),", ",(0,s.jsx)(n.code,{children:"options"}),"?): ",(0,s.jsx)(n.code,{children:"Promise"}),"<",(0,s.jsx)(n.code,{children:"void"}),">"]}),"\n"]}),"\n",(0,s.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"volumeName"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"options?"}),": ",(0,s.jsx)(n.a,{href:"/api/interfaces/VolumeDeleteOptions",children:(0,s.jsx)(n.code,{children:"VolumeDeleteOptions"})})]}),"\n",(0,s.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"Promise"}),"<",(0,s.jsx)(n.code,{children:"void"}),">"]}),"\n",(0,s.jsx)(n.h2,{id:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L3657",children:"packages/extension-api/src/extension-api.d.ts:3657"})})]})}function u(e={}){const{wrapper:n}={...(0,i.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>r,a:()=>c});var s=t(27378);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([[89472],{27807:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>c,default:()=>u,frontMatter:()=>o,metadata:()=>r,toc:()=>d});var s=t(24246),i=t(71670);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",p:"p",strong:"strong",...(0,i.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"function-deletevolume",children:"Function: deleteVolume()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"deleteVolume"}),"(",(0,s.jsx)(n.code,{children:"volumeName"}),", ",(0,s.jsx)(n.code,{children:"options"}),"?): ",(0,s.jsx)(n.code,{children:"Promise"}),"<",(0,s.jsx)(n.code,{children:"void"}),">"]}),"\n"]}),"\n",(0,s.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"volumeName"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"options?"}),": ",(0,s.jsx)(n.a,{href:"/api/interfaces/VolumeDeleteOptions",children:(0,s.jsx)(n.code,{children:"VolumeDeleteOptions"})})]}),"\n",(0,s.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"Promise"}),"<",(0,s.jsx)(n.code,{children:"void"}),">"]}),"\n",(0,s.jsx)(n.h2,{id:"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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L3657",children:"packages/extension-api/src/extension-api.d.ts:3657"})})]})}function u(e={}){const{wrapper:n}={...(0,i.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>r,a:()=>c});var s=t(27378);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.e8d76bc9.js b/assets/js/5b10a003.68d56976.js similarity index 86% rename from assets/js/5b10a003.e8d76bc9.js rename to assets/js/5b10a003.68d56976.js index dde809952e8..079bb443d43 100644 --- a/assets/js/5b10a003.e8d76bc9.js +++ b/assets/js/5b10a003.68d56976.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[28437],{78997:(e,i,n)=>{n.r(i),n.d(i,{assets:()=>o,contentTitle:()=>c,default:()=>h,frontMatter:()=>t,metadata:()=>d,toc:()=>a});var s=n(24246),r=n(71670);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"}},o={},a=[{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",hr:"hr",p:"p",strong:"strong",...(0,r.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L3061",children:"packages/extension-api/src/extension-api.d.ts:3061"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L3058",children:"packages/extension-api/src/extension-api.d.ts:3058"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L3056",children:"packages/extension-api/src/extension-api.d.ts:3056"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L3059",children:"packages/extension-api/src/extension-api.d.ts:3059"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L3057",children:"packages/extension-api/src/extension-api.d.ts:3057"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L3062",children:"packages/extension-api/src/extension-api.d.ts:3062"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L3060",children:"packages/extension-api/src/extension-api.d.ts:3060"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L3063",children:"packages/extension-api/src/extension-api.d.ts:3063"})})]})}function h(e={}){const{wrapper:i}={...(0,r.a)(),...e.components};return i?(0,s.jsx)(i,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},71670:(e,i,n)=>{n.d(i,{Z:()=>d,a:()=>c});var s=n(27378);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([[28437],{78997:(e,i,n)=>{n.r(i),n.d(i,{assets:()=>a,contentTitle:()=>c,default:()=>h,frontMatter:()=>t,metadata:()=>d,toc:()=>o});var s=n(24246),r=n(71670);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",hr:"hr",p:"p",strong:"strong",...(0,r.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L3061",children:"packages/extension-api/src/extension-api.d.ts:3061"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L3058",children:"packages/extension-api/src/extension-api.d.ts:3058"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L3056",children:"packages/extension-api/src/extension-api.d.ts:3056"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L3059",children:"packages/extension-api/src/extension-api.d.ts:3059"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L3057",children:"packages/extension-api/src/extension-api.d.ts:3057"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L3062",children:"packages/extension-api/src/extension-api.d.ts:3062"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L3060",children:"packages/extension-api/src/extension-api.d.ts:3060"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L3063",children:"packages/extension-api/src/extension-api.d.ts:3063"})})]})}function h(e={}){const{wrapper:i}={...(0,r.a)(),...e.components};return i?(0,s.jsx)(i,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},71670:(e,i,n)=>{n.d(i,{Z:()=>d,a:()=>c});var s=n(27378);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.df70dde4.js b/assets/js/5b7d9ef2.34875336.js similarity index 94% rename from assets/js/5b7d9ef2.df70dde4.js rename to assets/js/5b7d9ef2.34875336.js index 9e15cdb7aa7..dc3a8a5555f 100644 --- a/assets/js/5b7d9ef2.df70dde4.js +++ b/assets/js/5b7d9ef2.34875336.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[86112],{65941:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>c,contentTitle:()=>a,default:()=>l,frontMatter:()=>o,metadata:()=>i,toc:()=>p});var r=t(24246),s=t(71670);const o={},a="Type Alias: KubernetesGeneratorType",i={id:"type-aliases/KubernetesGeneratorType",title:"Type Alias: KubernetesGeneratorType",description:'KubernetesGeneratorType: "Compose" \\| "Pod" \\| "Container"',source:"@site/api/type-aliases/KubernetesGeneratorType.md",sourceDirName:"type-aliases",slug:"/type-aliases/KubernetesGeneratorType",permalink:"/api/type-aliases/KubernetesGeneratorType",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"KubernetesGeneratorSelector",permalink:"/api/type-aliases/KubernetesGeneratorSelector"},next:{title:"MountConfig",permalink:"/api/type-aliases/MountConfig"}},c={},p=[{value:"Defined in",id:"defined-in",level:2}];function d(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.h1,{id:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L2111",children:"packages/extension-api/src/extension-api.d.ts:2111"})})]})}function l(e={}){const{wrapper:n}={...(0,s.a)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(d,{...e})}):d(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>i,a:()=>a});var r=t(27378);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([[86112],{65941:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>c,contentTitle:()=>a,default:()=>l,frontMatter:()=>o,metadata:()=>i,toc:()=>p});var r=t(24246),s=t(71670);const o={},a="Type Alias: KubernetesGeneratorType",i={id:"type-aliases/KubernetesGeneratorType",title:"Type Alias: KubernetesGeneratorType",description:'KubernetesGeneratorType: "Compose" \\| "Pod" \\| "Container"',source:"@site/api/type-aliases/KubernetesGeneratorType.md",sourceDirName:"type-aliases",slug:"/type-aliases/KubernetesGeneratorType",permalink:"/api/type-aliases/KubernetesGeneratorType",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"KubernetesGeneratorSelector",permalink:"/api/type-aliases/KubernetesGeneratorSelector"},next:{title:"MountConfig",permalink:"/api/type-aliases/MountConfig"}},c={},p=[{value:"Defined in",id:"defined-in",level:2}];function d(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.h1,{id:"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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2111",children:"packages/extension-api/src/extension-api.d.ts:2111"})})]})}function l(e={}){const{wrapper:n}={...(0,s.a)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(d,{...e})}):d(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>i,a:()=>a});var r=t(27378);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.04d503d6.js b/assets/js/5bc09a53.88a05c89.js similarity index 90% rename from assets/js/5bc09a53.04d503d6.js rename to assets/js/5bc09a53.88a05c89.js index 01a13c7a4a3..127f66f3065 100644 --- a/assets/js/5bc09a53.04d503d6.js +++ b/assets/js/5bc09a53.88a05c89.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[79649],{43844:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>l,contentTitle:()=>r,default:()=>h,frontMatter:()=>a,metadata:()=>c,toc:()=>o});var t=i(24246),s=i(71670);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",hr:"hr",p:"p",pre:"pre",strong:"strong",...(0,s.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"interface-healthconfig",children:"Interface: HealthConfig"}),"\n",(0,t.jsxs)(n.p,{children:["Configuration options for defining a healthcheck for a container.\nTo get health check result you can use ",(0,t.jsx)(n.a,{href:"/api/namespaces/containerEngine/functions/inspectContainer",children:"containerEngine.inspectContainer"})," and inside the obtained ",(0,t.jsx)(n.a,{href:"/api/interfaces/ContainerInspectInfo",children:"ContainerInspectInfo"})," you can access the ",(0,t.jsx)(n.code,{children:"Status.Health"})," property containing a ",(0,t.jsx)(n.a,{href:"/api/interfaces/HealthCheckResults",children:"HealthCheckResults"}),"."]}),"\n",(0,t.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,t.jsx)(n.h3,{id:"interval",children:"Interval?"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"optional"})," ",(0,t.jsx)(n.strong,{children:"Interval"}),": ",(0,t.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"The time to wait between checks in nanoseconds. It should be 0 or at least 1000000 (1 ms). 0 means inherit."}),"\n",(0,t.jsx)(n.h4,{id:"example",children:"Example"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-ts",children:"// Set interval to 1 second\nInterval?: 1000000000;\n"})}),"\n",(0,t.jsx)(n.h4,{id:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L2707",children:"packages/extension-api/src/extension-api.d.ts:2707"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L2735",children:"packages/extension-api/src/extension-api.d.ts:2735"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L2726",children:"packages/extension-api/src/extension-api.d.ts:2726"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L2698",children:"packages/extension-api/src/extension-api.d.ts:2698"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L2716",children:"packages/extension-api/src/extension-api.d.ts:2716"})})]})}function h(e={}){const{wrapper:n}={...(0,s.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(d,{...e})}):d(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>c,a:()=>r});var t=i(27378);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([[79649],{43844:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>d,contentTitle:()=>r,default:()=>h,frontMatter:()=>a,metadata:()=>c,toc:()=>l});var t=i(24246),s=i(71670);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"}},d={},l=[{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 o(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",pre:"pre",strong:"strong",...(0,s.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"interface-healthconfig",children:"Interface: HealthConfig"}),"\n",(0,t.jsxs)(n.p,{children:["Configuration options for defining a healthcheck for a container.\nTo get health check result you can use ",(0,t.jsx)(n.a,{href:"/api/namespaces/containerEngine/functions/inspectContainer",children:"containerEngine.inspectContainer"})," and inside the obtained ",(0,t.jsx)(n.a,{href:"/api/interfaces/ContainerInspectInfo",children:"ContainerInspectInfo"})," you can access the ",(0,t.jsx)(n.code,{children:"Status.Health"})," property containing a ",(0,t.jsx)(n.a,{href:"/api/interfaces/HealthCheckResults",children:"HealthCheckResults"}),"."]}),"\n",(0,t.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,t.jsx)(n.h3,{id:"interval",children:"Interval?"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"optional"})," ",(0,t.jsx)(n.strong,{children:"Interval"}),": ",(0,t.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"The time to wait between checks in nanoseconds. It should be 0 or at least 1000000 (1 ms). 0 means inherit."}),"\n",(0,t.jsx)(n.h4,{id:"example",children:"Example"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-ts",children:"// Set interval to 1 second\nInterval?: 1000000000;\n"})}),"\n",(0,t.jsx)(n.h4,{id:"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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2707",children:"packages/extension-api/src/extension-api.d.ts:2707"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2735",children:"packages/extension-api/src/extension-api.d.ts:2735"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2726",children:"packages/extension-api/src/extension-api.d.ts:2726"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2698",children:"packages/extension-api/src/extension-api.d.ts:2698"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2716",children:"packages/extension-api/src/extension-api.d.ts:2716"})})]})}function h(e={}){const{wrapper:n}={...(0,s.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(o,{...e})}):o(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>c,a:()=>r});var t=i(27378);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.7b98703a.js b/assets/js/5c0f0993.568e69eb.js similarity index 95% rename from assets/js/5c0f0993.7b98703a.js rename to assets/js/5c0f0993.568e69eb.js index 7b28e9a89dc..9eb5763e949 100644 --- a/assets/js/5c0f0993.7b98703a.js +++ b/assets/js/5c0f0993.568e69eb.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[5674],{79003:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>c,contentTitle:()=>d,default:()=>h,frontMatter:()=>i,metadata:()=>a,toc:()=>l});var s=r(24246),t=r(71670);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",hr:"hr",p:"p",strong:"strong",...(0,t.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"interface-telemetrysender",children:"Interface: TelemetrySender"}),"\n",(0,s.jsxs)(n.p,{children:["The telemetry sender is the contract between a telemetry logger and some telemetry service. ",(0,s.jsx)(n.strong,{children:"Note"})," that extensions must NOT\ncall the methods of their sender directly as the logger provides extra guards and cleaning."]}),"\n",(0,s.jsx)(n.h2,{id:"methods",children:"Methods"}),"\n",(0,s.jsx)(n.h3,{id:"flush",children:"flush()?"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"optional"})," ",(0,s.jsx)(n.strong,{children:"flush"}),"(): ",(0,s.jsx)(n.code,{children:"void"})," | ",(0,s.jsx)(n.code,{children:"Promise"}),"<",(0,s.jsx)(n.code,{children:"void"}),">"]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:["Optional flush function which will give this sender a chance to send any remaining events\nas its ",(0,s.jsx)(n.a,{href:"/api/interfaces/TelemetryLogger",children:"TelemetryLogger"})," is being disposed"]}),"\n",(0,s.jsx)(n.h4,{id:"returns",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"void"})," | ",(0,s.jsx)(n.code,{children:"Promise"}),"<",(0,s.jsx)(n.code,{children:"void"}),">"]}),"\n",(0,s.jsx)(n.h4,{id:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L4220",children:"packages/extension-api/src/extension-api.d.ts:4220"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L4214",children:"packages/extension-api/src/extension-api.d.ts:4214"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L4205",children:"packages/extension-api/src/extension-api.d.ts:4205"})})]})}function h(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(o,{...e})}):o(e)}},71670:(e,n,r)=>{r.d(n,{Z:()=>a,a:()=>d});var s=r(27378);const t={},i=s.createContext(t);function d(e){const n=s.useContext(i);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function 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([[5674],{79003:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>c,contentTitle:()=>d,default:()=>h,frontMatter:()=>i,metadata:()=>a,toc:()=>l});var s=r(24246),t=r(71670);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",hr:"hr",p:"p",strong:"strong",...(0,t.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"interface-telemetrysender",children:"Interface: TelemetrySender"}),"\n",(0,s.jsxs)(n.p,{children:["The telemetry sender is the contract between a telemetry logger and some telemetry service. ",(0,s.jsx)(n.strong,{children:"Note"})," that extensions must NOT\ncall the methods of their sender directly as the logger provides extra guards and cleaning."]}),"\n",(0,s.jsx)(n.h2,{id:"methods",children:"Methods"}),"\n",(0,s.jsx)(n.h3,{id:"flush",children:"flush()?"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"optional"})," ",(0,s.jsx)(n.strong,{children:"flush"}),"(): ",(0,s.jsx)(n.code,{children:"void"})," | ",(0,s.jsx)(n.code,{children:"Promise"}),"<",(0,s.jsx)(n.code,{children:"void"}),">"]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:["Optional flush function which will give this sender a chance to send any remaining events\nas its ",(0,s.jsx)(n.a,{href:"/api/interfaces/TelemetryLogger",children:"TelemetryLogger"})," is being disposed"]}),"\n",(0,s.jsx)(n.h4,{id:"returns",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"void"})," | ",(0,s.jsx)(n.code,{children:"Promise"}),"<",(0,s.jsx)(n.code,{children:"void"}),">"]}),"\n",(0,s.jsx)(n.h4,{id:"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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L4220",children:"packages/extension-api/src/extension-api.d.ts:4220"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L4214",children:"packages/extension-api/src/extension-api.d.ts:4214"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L4205",children:"packages/extension-api/src/extension-api.d.ts:4205"})})]})}function h(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(o,{...e})}):o(e)}},71670:(e,n,r)=>{r.d(n,{Z:()=>a,a:()=>d});var s=r(27378);const t={},i=s.createContext(t);function d(e){const n=s.useContext(i);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function 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.373720fc.js b/assets/js/5db8318c.12796fd6.js similarity index 96% rename from assets/js/5db8318c.373720fc.js rename to assets/js/5db8318c.12796fd6.js index 27c4a7fe7fc..106534890f1 100644 --- a/assets/js/5db8318c.373720fc.js +++ b/assets/js/5db8318c.12796fd6.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[58792],{58718:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>o,contentTitle:()=>r,default:()=>l,frontMatter:()=>a,metadata:()=>c,toc:()=>d});var t=s(24246),i=s(71670);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",p:"p",strong:"strong",...(0,i.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"function-registercommand",children:"Function: registerCommand()"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"registerCommand"}),"(",(0,t.jsx)(n.code,{children:"command"}),", ",(0,t.jsx)(n.code,{children:"callback"}),", ",(0,t.jsx)(n.code,{children:"thisArg"}),"?): ",(0,t.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,t.jsx)(n.code,{children:"Disposable"})})]}),"\n"]}),"\n",(0,t.jsxs)(n.p,{children:["Define a command, to be executed later, either by calling ",(0,t.jsx)(n.a,{href:"/api/namespaces/commands/functions/executeCommand",children:"commands.executeCommand"})," or by referencing its name in the ",(0,t.jsx)(n.code,{children:"command"})," field of a ",(0,t.jsx)(n.a,{href:"/api/interfaces/StatusBarItem",children:"StatusBarItem"}),"."]}),"\n",(0,t.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"command"}),": ",(0,t.jsx)(n.code,{children:"string"})]}),"\n",(0,t.jsx)(n.p,{children:"the name of the command. The name must be unique over all extensions. It is recommended to prefix this name with the name of the extension, to avoid conflicts with commands from other extensions."}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"callback"})]}),"\n",(0,t.jsx)(n.p,{children:"the command to execute"}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"thisArg?"}),": ",(0,t.jsx)(n.code,{children:"any"})]}),"\n",(0,t.jsxs)(n.p,{children:["The value of ",(0,t.jsx)(n.code,{children:"this"})," provided for the call to callback"]}),"\n",(0,t.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,t.jsx)(n.code,{children:"Disposable"})})}),"\n",(0,t.jsx)(n.p,{children:"A disposable that unregisters this command when being disposed"}),"\n",(0,t.jsx)(n.h2,{id:"throws",children:"Throws"}),"\n",(0,t.jsx)(n.p,{children:"if a command with the same name is already registered."}),"\n",(0,t.jsx)(n.h2,{id:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L654",children:"packages/extension-api/src/extension-api.d.ts:654"})})]})}function l(e={}){const{wrapper:n}={...(0,i.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(m,{...e})}):m(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>c,a:()=>r});var t=s(27378);const i={},a=t.createContext(i);function r(e){const n=t.useContext(a);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:r(e.components),t.createElement(a.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[58792],{58718:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>o,contentTitle:()=>r,default:()=>l,frontMatter:()=>a,metadata:()=>c,toc:()=>d});var t=s(24246),i=s(71670);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",p:"p",strong:"strong",...(0,i.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"function-registercommand",children:"Function: registerCommand()"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"registerCommand"}),"(",(0,t.jsx)(n.code,{children:"command"}),", ",(0,t.jsx)(n.code,{children:"callback"}),", ",(0,t.jsx)(n.code,{children:"thisArg"}),"?): ",(0,t.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,t.jsx)(n.code,{children:"Disposable"})})]}),"\n"]}),"\n",(0,t.jsxs)(n.p,{children:["Define a command, to be executed later, either by calling ",(0,t.jsx)(n.a,{href:"/api/namespaces/commands/functions/executeCommand",children:"commands.executeCommand"})," or by referencing its name in the ",(0,t.jsx)(n.code,{children:"command"})," field of a ",(0,t.jsx)(n.a,{href:"/api/interfaces/StatusBarItem",children:"StatusBarItem"}),"."]}),"\n",(0,t.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"command"}),": ",(0,t.jsx)(n.code,{children:"string"})]}),"\n",(0,t.jsx)(n.p,{children:"the name of the command. The name must be unique over all extensions. It is recommended to prefix this name with the name of the extension, to avoid conflicts with commands from other extensions."}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"callback"})]}),"\n",(0,t.jsx)(n.p,{children:"the command to execute"}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"thisArg?"}),": ",(0,t.jsx)(n.code,{children:"any"})]}),"\n",(0,t.jsxs)(n.p,{children:["The value of ",(0,t.jsx)(n.code,{children:"this"})," provided for the call to callback"]}),"\n",(0,t.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,t.jsx)(n.code,{children:"Disposable"})})}),"\n",(0,t.jsx)(n.p,{children:"A disposable that unregisters this command when being disposed"}),"\n",(0,t.jsx)(n.h2,{id:"throws",children:"Throws"}),"\n",(0,t.jsx)(n.p,{children:"if a command with the same name is already registered."}),"\n",(0,t.jsx)(n.h2,{id:"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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L654",children:"packages/extension-api/src/extension-api.d.ts:654"})})]})}function l(e={}){const{wrapper:n}={...(0,i.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(m,{...e})}):m(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>c,a:()=>r});var t=s(27378);const i={},a=t.createContext(i);function r(e){const n=t.useContext(a);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:r(e.components),t.createElement(a.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/5e30269e.2c0a57b6.js b/assets/js/5e30269e.5b48dea2.js similarity index 95% rename from assets/js/5e30269e.2c0a57b6.js rename to assets/js/5e30269e.5b48dea2.js index 0c25af6878e..e8e0ea75c41 100644 --- a/assets/js/5e30269e.2c0a57b6.js +++ b/assets/js/5e30269e.5b48dea2.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[27135],{81619:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>d,contentTitle:()=>o,default:()=>p,frontMatter:()=>r,metadata:()=>a,toc:()=>c});var s=n(24246),i=n(71670);const r={},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",p:"p",strong:"strong",...(0,i.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(t.h1,{id:"type-alias-providerstatus",children:"Type Alias: ProviderStatus"}),"\n",(0,s.jsxs)(t.blockquote,{children:["\n",(0,s.jsxs)(t.p,{children:[(0,s.jsx)(t.strong,{children:"ProviderStatus"}),": ",(0,s.jsx)(t.code,{children:'"not-installed"'})," | ",(0,s.jsx)(t.code,{children:'"installed"'})," | ",(0,s.jsx)(t.code,{children:'"configuring"'})," | ",(0,s.jsx)(t.code,{children:'"configured"'})," | ",(0,s.jsx)(t.code,{children:'"ready"'})," | ",(0,s.jsx)(t.code,{children:'"started"'})," | ",(0,s.jsx)(t.code,{children:'"stopped"'})," | ",(0,s.jsx)(t.code,{children:'"starting"'})," | ",(0,s.jsx)(t.code,{children:'"stopping"'})," | ",(0,s.jsx)(t.code,{children:'"error"'})," | ",(0,s.jsx)(t.code,{children:'"unknown"'})]}),"\n"]}),"\n",(0,s.jsx)(t.h2,{id:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/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,i.a)(),...e.components};return t?(0,s.jsx)(t,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},71670:(e,t,n)=>{n.d(t,{Z:()=>a,a:()=>o});var s=n(27378);const i={},r=s.createContext(i);function o(e){const t=s.useContext(r);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(i):e.components||i:o(e.components),s.createElement(r.Provider,{value:t},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[27135],{81619:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>d,contentTitle:()=>o,default:()=>p,frontMatter:()=>r,metadata:()=>a,toc:()=>c});var s=n(24246),i=n(71670);const r={},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",p:"p",strong:"strong",...(0,i.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(t.h1,{id:"type-alias-providerstatus",children:"Type Alias: ProviderStatus"}),"\n",(0,s.jsxs)(t.blockquote,{children:["\n",(0,s.jsxs)(t.p,{children:[(0,s.jsx)(t.strong,{children:"ProviderStatus"}),": ",(0,s.jsx)(t.code,{children:'"not-installed"'})," | ",(0,s.jsx)(t.code,{children:'"installed"'})," | ",(0,s.jsx)(t.code,{children:'"configuring"'})," | ",(0,s.jsx)(t.code,{children:'"configured"'})," | ",(0,s.jsx)(t.code,{children:'"ready"'})," | ",(0,s.jsx)(t.code,{children:'"started"'})," | ",(0,s.jsx)(t.code,{children:'"stopped"'})," | ",(0,s.jsx)(t.code,{children:'"starting"'})," | ",(0,s.jsx)(t.code,{children:'"stopping"'})," | ",(0,s.jsx)(t.code,{children:'"error"'})," | ",(0,s.jsx)(t.code,{children:'"unknown"'})]}),"\n"]}),"\n",(0,s.jsx)(t.h2,{id:"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/bd83a8b2bb8ab886dc757381b589638cbda150d0/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,i.a)(),...e.components};return t?(0,s.jsx)(t,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},71670:(e,t,n)=>{n.d(t,{Z:()=>a,a:()=>o});var s=n(27378);const i={},r=s.createContext(i);function o(e){const t=s.useContext(r);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(i):e.components||i:o(e.components),s.createElement(r.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/5e486140.366b04cd.js b/assets/js/5e486140.27f2fc47.js similarity index 95% rename from assets/js/5e486140.366b04cd.js rename to assets/js/5e486140.27f2fc47.js index 53ab55020c1..dd093ab1599 100644 --- a/assets/js/5e486140.366b04cd.js +++ b/assets/js/5e486140.27f2fc47.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[26557],{6974:(n,e,s)=>{s.r(e),s.d(e,{assets:()=>a,contentTitle:()=>c,default:()=>u,frontMatter:()=>o,metadata:()=>r,toc:()=>d});var t=s(24246),i=s(71670);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(n){const e={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,i.a)(),...n.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(e.h1,{id:"function-listpods",children:"Function: listPods()"}),"\n",(0,t.jsxs)(e.blockquote,{children:["\n",(0,t.jsxs)(e.p,{children:[(0,t.jsx)(e.strong,{children:"listPods"}),"(): ",(0,t.jsx)(e.code,{children:"Promise"}),"<",(0,t.jsx)(e.a,{href:"/api/interfaces/PodInfo",children:(0,t.jsx)(e.code,{children:"PodInfo"})}),"[]>"]}),"\n"]}),"\n",(0,t.jsx)(e.h2,{id:"returns",children:"Returns"}),"\n",(0,t.jsxs)(e.p,{children:[(0,t.jsx)(e.code,{children:"Promise"}),"<",(0,t.jsx)(e.a,{href:"/api/interfaces/PodInfo",children:(0,t.jsx)(e.code,{children:"PodInfo"})}),"[]>"]}),"\n",(0,t.jsx)(e.h2,{id:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L3666",children:"packages/extension-api/src/extension-api.d.ts:3666"})})]})}function u(n={}){const{wrapper:e}={...(0,i.a)(),...n.components};return e?(0,t.jsx)(e,{...n,children:(0,t.jsx)(l,{...n})}):l(n)}},71670:(n,e,s)=>{s.d(e,{Z:()=>r,a:()=>c});var t=s(27378);const i={},o=t.createContext(i);function c(n){const e=t.useContext(o);return t.useMemo((function(){return"function"==typeof n?n(e):{...e,...n}}),[e,n])}function r(n){let e;return e=n.disableParentContext?"function"==typeof n.components?n.components(i):n.components||i:c(n.components),t.createElement(o.Provider,{value:e},n.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[26557],{6974:(n,e,s)=>{s.r(e),s.d(e,{assets:()=>a,contentTitle:()=>c,default:()=>u,frontMatter:()=>o,metadata:()=>r,toc:()=>d});var t=s(24246),i=s(71670);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(n){const e={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,i.a)(),...n.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(e.h1,{id:"function-listpods",children:"Function: listPods()"}),"\n",(0,t.jsxs)(e.blockquote,{children:["\n",(0,t.jsxs)(e.p,{children:[(0,t.jsx)(e.strong,{children:"listPods"}),"(): ",(0,t.jsx)(e.code,{children:"Promise"}),"<",(0,t.jsx)(e.a,{href:"/api/interfaces/PodInfo",children:(0,t.jsx)(e.code,{children:"PodInfo"})}),"[]>"]}),"\n"]}),"\n",(0,t.jsx)(e.h2,{id:"returns",children:"Returns"}),"\n",(0,t.jsxs)(e.p,{children:[(0,t.jsx)(e.code,{children:"Promise"}),"<",(0,t.jsx)(e.a,{href:"/api/interfaces/PodInfo",children:(0,t.jsx)(e.code,{children:"PodInfo"})}),"[]>"]}),"\n",(0,t.jsx)(e.h2,{id:"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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L3666",children:"packages/extension-api/src/extension-api.d.ts:3666"})})]})}function u(n={}){const{wrapper:e}={...(0,i.a)(),...n.components};return e?(0,t.jsx)(e,{...n,children:(0,t.jsx)(l,{...n})}):l(n)}},71670:(n,e,s)=>{s.d(e,{Z:()=>r,a:()=>c});var t=s(27378);const i={},o=t.createContext(i);function c(n){const e=t.useContext(o);return t.useMemo((function(){return"function"==typeof n?n(e):{...e,...n}}),[e,n])}function r(n){let e;return e=n.disableParentContext?"function"==typeof n.components?n.components(i):n.components||i:c(n.components),t.createElement(o.Provider,{value:e},n.children)}}}]); \ No newline at end of file diff --git a/assets/js/5e8fbcdf.eb8ea6d9.js b/assets/js/5e8fbcdf.ce7fa9eb.js similarity index 86% rename from assets/js/5e8fbcdf.eb8ea6d9.js rename to assets/js/5e8fbcdf.ce7fa9eb.js index 180af66b935..2344b0bcff4 100644 --- a/assets/js/5e8fbcdf.eb8ea6d9.js +++ b/assets/js/5e8fbcdf.ce7fa9eb.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[5417],{28786:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>c,contentTitle:()=>t,default:()=>h,frontMatter:()=>r,metadata:()=>o,toc:()=>a});var s=i(24246),d=i(71670);const r={},t="Interface: BuildImageOptions",o={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={},a=[{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",hr:"hr",p:"p",strong:"strong",...(0,d.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{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/804b2198fda0957e1ecfb87539f019eb9b79a66f/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:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L3275",children:"packages/extension-api/src/extension-api.d.ts:3275"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L3217",children:"packages/extension-api/src/extension-api.d.ts:3217"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L3171",children:"packages/extension-api/src/extension-api.d.ts:3171"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/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:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/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:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/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:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L3251",children:"packages/extension-api/src/extension-api.d.ts:3251"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/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:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L3236",children:"packages/extension-api/src/extension-api.d.ts:3236"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L3290",children:"packages/extension-api/src/extension-api.d.ts:3290"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L3241",children:"packages/extension-api/src/extension-api.d.ts:3241"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L3246",children:"packages/extension-api/src/extension-api.d.ts:3246"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L3297",children:"packages/extension-api/src/extension-api.d.ts:3297"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L3318",children:"packages/extension-api/src/extension-api.d.ts:3318"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L3311",children:"packages/extension-api/src/extension-api.d.ts:3311"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/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:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L3186",children:"packages/extension-api/src/extension-api.d.ts:3186"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L3222",children:"packages/extension-api/src/extension-api.d.ts:3222"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L3212",children:"packages/extension-api/src/extension-api.d.ts:3212"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L3205",children:"packages/extension-api/src/extension-api.d.ts:3205"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L3229",children:"packages/extension-api/src/extension-api.d.ts:3229"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L3280",children:"packages/extension-api/src/extension-api.d.ts:3280"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L3285",children:"packages/extension-api/src/extension-api.d.ts:3285"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/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:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L3304",children:"packages/extension-api/src/extension-api.d.ts:3304"})})]})}function h(e={}){const{wrapper:n}={...(0,d.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>o,a:()=>t});var s=i(27378);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 o(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([[5417],{28786:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>o,contentTitle:()=>t,default:()=>h,frontMatter:()=>r,metadata:()=>c,toc:()=>a});var s=i(24246),d=i(71670);const r={},t="Interface: BuildImageOptions",c={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={},a=[{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",hr:"hr",p:"p",strong:"strong",...(0,d.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{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/bd83a8b2bb8ab886dc757381b589638cbda150d0/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:"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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L3275",children:"packages/extension-api/src/extension-api.d.ts:3275"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L3217",children:"packages/extension-api/src/extension-api.d.ts:3217"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L3171",children:"packages/extension-api/src/extension-api.d.ts:3171"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/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:"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/bd83a8b2bb8ab886dc757381b589638cbda150d0/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:"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/bd83a8b2bb8ab886dc757381b589638cbda150d0/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:"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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L3251",children:"packages/extension-api/src/extension-api.d.ts:3251"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/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:"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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L3236",children:"packages/extension-api/src/extension-api.d.ts:3236"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L3290",children:"packages/extension-api/src/extension-api.d.ts:3290"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L3241",children:"packages/extension-api/src/extension-api.d.ts:3241"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L3246",children:"packages/extension-api/src/extension-api.d.ts:3246"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L3297",children:"packages/extension-api/src/extension-api.d.ts:3297"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L3318",children:"packages/extension-api/src/extension-api.d.ts:3318"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L3311",children:"packages/extension-api/src/extension-api.d.ts:3311"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/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:"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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L3186",children:"packages/extension-api/src/extension-api.d.ts:3186"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L3222",children:"packages/extension-api/src/extension-api.d.ts:3222"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L3212",children:"packages/extension-api/src/extension-api.d.ts:3212"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L3205",children:"packages/extension-api/src/extension-api.d.ts:3205"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L3229",children:"packages/extension-api/src/extension-api.d.ts:3229"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L3280",children:"packages/extension-api/src/extension-api.d.ts:3280"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L3285",children:"packages/extension-api/src/extension-api.d.ts:3285"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/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:"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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L3304",children:"packages/extension-api/src/extension-api.d.ts:3304"})})]})}function h(e={}){const{wrapper:n}={...(0,d.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>c,a:()=>t});var s=i(27378);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/604e05e4.c0c8c913.js b/assets/js/604e05e4.bb73438b.js similarity index 81% rename from assets/js/604e05e4.c0c8c913.js rename to assets/js/604e05e4.bb73438b.js index 3de12e7439f..516c2b23268 100644 --- a/assets/js/604e05e4.c0c8c913.js +++ b/assets/js/604e05e4.bb73438b.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[62871],{98771:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>c,contentTitle:()=>t,default:()=>h,frontMatter:()=>r,metadata:()=>a,toc:()=>o});var s=i(24246),d=i(71670);const r={},t="Interface: NetworkInfo",a={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",hr:"hr",p:"p",strong:"strong",...(0,d.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L2307",children:"packages/extension-api/src/extension-api.d.ts:2307"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L2309",children:"packages/extension-api/src/extension-api.d.ts:2309"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L2310",children:"packages/extension-api/src/extension-api.d.ts:2310"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L2314",children:"packages/extension-api/src/extension-api.d.ts:2314"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L2315",children:"packages/extension-api/src/extension-api.d.ts:2315"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/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:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L2311",children:"packages/extension-api/src/extension-api.d.ts:2311"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L2312",children:"packages/extension-api/src/extension-api.d.ts:2312"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L2313",children:"packages/extension-api/src/extension-api.d.ts:2313"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L2306",children:"packages/extension-api/src/extension-api.d.ts:2306"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L2316",children:"packages/extension-api/src/extension-api.d.ts:2316"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L2308",children:"packages/extension-api/src/extension-api.d.ts:2308"})})]})}function h(e={}){const{wrapper:n}={...(0,d.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>a,a:()=>t});var s=i(27378);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([[62871],{98771:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>c,contentTitle:()=>r,default:()=>h,frontMatter:()=>a,metadata:()=>t,toc:()=>o});var s=i(24246),d=i(71670);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",hr:"hr",p:"p",strong:"strong",...(0,d.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2307",children:"packages/extension-api/src/extension-api.d.ts:2307"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2309",children:"packages/extension-api/src/extension-api.d.ts:2309"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2310",children:"packages/extension-api/src/extension-api.d.ts:2310"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2314",children:"packages/extension-api/src/extension-api.d.ts:2314"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2315",children:"packages/extension-api/src/extension-api.d.ts:2315"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/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:"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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2311",children:"packages/extension-api/src/extension-api.d.ts:2311"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2312",children:"packages/extension-api/src/extension-api.d.ts:2312"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2313",children:"packages/extension-api/src/extension-api.d.ts:2313"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2306",children:"packages/extension-api/src/extension-api.d.ts:2306"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2316",children:"packages/extension-api/src/extension-api.d.ts:2316"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2308",children:"packages/extension-api/src/extension-api.d.ts:2308"})})]})}function h(e={}){const{wrapper:n}={...(0,d.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>t,a:()=>r});var s=i(27378);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.ae86abe4.js b/assets/js/60c82955.d3eab794.js similarity index 84% rename from assets/js/60c82955.ae86abe4.js rename to assets/js/60c82955.d3eab794.js index 14466820721..762ff631875 100644 --- a/assets/js/60c82955.ae86abe4.js +++ b/assets/js/60c82955.d3eab794.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[48926],{92095:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>a,contentTitle:()=>l,default:()=>h,frontMatter:()=>r,metadata:()=>t,toc:()=>o});var s=i(24246),d=i(71670);const r={},l="Interface: CliTool",t={id:"interfaces/CliTool",title:"Interface: CliTool",description:"Extends",source:"@site/api/interfaces/CliTool.md",sourceDirName:"interfaces",slug:"/interfaces/CliTool",permalink:"/api/interfaces/CliTool",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"CheckResultFixCommand",permalink:"/api/interfaces/CheckResultFixCommand"},next:{title:"CliToolOptions",permalink:"/api/interfaces/CliToolOptions"}},a={},o=[{value:"Extends",id:"extends",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:"onDidUpdateVersion",id:"ondidupdateversion",level:3},{value:"Defined in",id:"defined-in-6",level:4},{value:"state",id:"state",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:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in-8",level:4},{value:"registerUpdate()",id:"registerupdate",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Defined in",id:"defined-in-9",level:4},{value:"updateVersion()",id:"updateversion",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-2",level:4},{value:"Defined in",id:"defined-in-10",level:4}];function c(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",li:"li",p:"p",strong:"strong",ul:"ul",...(0,d.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{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.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:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L4322",children:"packages/extension-api/src/extension-api.d.ts:4322"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L4326",children:"packages/extension-api/src/extension-api.d.ts:4326"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L4320",children:"packages/extension-api/src/extension-api.d.ts:4320"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L4325",children:"packages/extension-api/src/extension-api.d.ts:4325"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L4323",children:"packages/extension-api/src/extension-api.d.ts:4323"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L4321",children:"packages/extension-api/src/extension-api.d.ts:4321"})}),"\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-6",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L4332",children:"packages/extension-api/src/extension-api.d.ts:4332"})}),"\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-7",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L4324",children:"packages/extension-api/src/extension-api.d.ts:4324"})}),"\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-8",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/804b2198fda0957e1ecfb87539f019eb9b79a66f/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:"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",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"})})]}),"\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-9",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L4335",children:"packages/extension-api/src/extension-api.d.ts:4335"})}),"\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-1",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-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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L4331",children:"packages/extension-api/src/extension-api.d.ts:4331"})})]})}function h(e={}){const{wrapper:n}={...(0,d.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(c,{...e})}):c(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>t,a:()=>l});var s=i(27378);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 t(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([[48926],{92095:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>t,contentTitle:()=>l,default:()=>h,frontMatter:()=>r,metadata:()=>a,toc:()=>c});var s=i(24246),d=i(71670);const r={},l="Interface: CliTool",a={id:"interfaces/CliTool",title:"Interface: CliTool",description:"Extends",source:"@site/api/interfaces/CliTool.md",sourceDirName:"interfaces",slug:"/interfaces/CliTool",permalink:"/api/interfaces/CliTool",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"CheckResultFixCommand",permalink:"/api/interfaces/CheckResultFixCommand"},next:{title:"CliToolOptions",permalink:"/api/interfaces/CliToolOptions"}},t={},c=[{value:"Extends",id:"extends",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:"onDidUpdateVersion",id:"ondidupdateversion",level:3},{value:"Defined in",id:"defined-in-6",level:4},{value:"state",id:"state",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:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in-8",level:4},{value:"registerUpdate()",id:"registerupdate",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Defined in",id:"defined-in-9",level:4},{value:"updateVersion()",id:"updateversion",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-2",level:4},{value:"Defined in",id:"defined-in-10",level:4}];function o(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",li:"li",p:"p",strong:"strong",ul:"ul",...(0,d.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{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.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:"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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L4322",children:"packages/extension-api/src/extension-api.d.ts:4322"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L4326",children:"packages/extension-api/src/extension-api.d.ts:4326"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L4320",children:"packages/extension-api/src/extension-api.d.ts:4320"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L4325",children:"packages/extension-api/src/extension-api.d.ts:4325"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L4323",children:"packages/extension-api/src/extension-api.d.ts:4323"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L4321",children:"packages/extension-api/src/extension-api.d.ts:4321"})}),"\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-6",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L4332",children:"packages/extension-api/src/extension-api.d.ts:4332"})}),"\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-7",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L4324",children:"packages/extension-api/src/extension-api.d.ts:4324"})}),"\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-8",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/bd83a8b2bb8ab886dc757381b589638cbda150d0/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:"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",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"})})]}),"\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-9",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L4335",children:"packages/extension-api/src/extension-api.d.ts:4335"})}),"\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-1",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-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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L4331",children:"packages/extension-api/src/extension-api.d.ts:4331"})})]})}function h(e={}){const{wrapper:n}={...(0,d.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(o,{...e})}):o(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>a,a:()=>l});var s=i(27378);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 a(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.93183271.js b/assets/js/610f2c47.363eb6be.js similarity index 98% rename from assets/js/610f2c47.93183271.js rename to assets/js/610f2c47.363eb6be.js index 507003a6c9e..7cd38e7363e 100644 --- a/assets/js/610f2c47.93183271.js +++ b/assets/js/610f2c47.363eb6be.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[23937],{19355:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>d,contentTitle:()=>r,default:()=>h,frontMatter:()=>i,metadata:()=>c,toc:()=>a});var t=s(24246),o=s(71670);const i={},r="Function: showInputBox()",c={id:"namespaces/window/functions/showInputBox",title:"Function: showInputBox()",description:"showInputBox(options?, token?): Promise\\",source:"@site/api/namespaces/window/functions/showInputBox.md",sourceDirName:"namespaces/window/functions",slug:"/namespaces/window/functions/showInputBox",permalink:"/api/namespaces/window/functions/showInputBox",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"showInformationMessage",permalink:"/api/namespaces/window/functions/showInformationMessage"},next:{title:"showNotification",permalink:"/api/namespaces/window/functions/showNotification"}},d={},a=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Defined in",id:"defined-in",level:2}];function p(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,o.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"function-showinputbox",children:"Function: showInputBox()"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"showInputBox"}),"(",(0,t.jsx)(n.code,{children:"options"}),"?, ",(0,t.jsx)(n.code,{children:"token"}),"?): ",(0,t.jsx)(n.code,{children:"Promise"}),"<",(0,t.jsx)(n.code,{children:"string"})," | ",(0,t.jsx)(n.code,{children:"undefined"}),">"]}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"Opens an input box to ask the user for input."}),"\n",(0,t.jsxs)(n.p,{children:["The returned value will be ",(0,t.jsx)(n.code,{children:"undefined"})," if the input box was canceled (e.g. pressing ESC). Otherwise the\nreturned value will be the string typed by the user or an empty string if the user did not type\nanything but dismissed the input box with OK."]}),"\n",(0,t.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"options?"}),": ",(0,t.jsx)(n.a,{href:"/api/interfaces/InputBoxOptions",children:(0,t.jsx)(n.code,{children:"InputBoxOptions"})})]}),"\n",(0,t.jsx)(n.p,{children:"Configures the behavior of the input box."}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"token?"}),": ",(0,t.jsx)(n.a,{href:"/api/interfaces/CancellationToken",children:(0,t.jsx)(n.code,{children:"CancellationToken"})})]}),"\n",(0,t.jsx)(n.p,{children:"A token that can be used to signal cancellation."}),"\n",(0,t.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"Promise"}),"<",(0,t.jsx)(n.code,{children:"string"})," | ",(0,t.jsx)(n.code,{children:"undefined"}),">"]}),"\n",(0,t.jsxs)(n.p,{children:["A promise that resolves to a string the user provided or to ",(0,t.jsx)(n.code,{children:"undefined"})," in case of dismissal."]}),"\n",(0,t.jsx)(n.h2,{id:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L1984",children:"packages/extension-api/src/extension-api.d.ts:1984"})})]})}function h(e={}){const{wrapper:n}={...(0,o.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(p,{...e})}):p(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>c,a:()=>r});var t=s(27378);const o={},i=t.createContext(o);function r(e){const n=t.useContext(i);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:r(e.components),t.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[23937],{19355:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>d,contentTitle:()=>r,default:()=>h,frontMatter:()=>i,metadata:()=>c,toc:()=>a});var t=s(24246),o=s(71670);const i={},r="Function: showInputBox()",c={id:"namespaces/window/functions/showInputBox",title:"Function: showInputBox()",description:"showInputBox(options?, token?): Promise\\",source:"@site/api/namespaces/window/functions/showInputBox.md",sourceDirName:"namespaces/window/functions",slug:"/namespaces/window/functions/showInputBox",permalink:"/api/namespaces/window/functions/showInputBox",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"showInformationMessage",permalink:"/api/namespaces/window/functions/showInformationMessage"},next:{title:"showNotification",permalink:"/api/namespaces/window/functions/showNotification"}},d={},a=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Defined in",id:"defined-in",level:2}];function p(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,o.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"function-showinputbox",children:"Function: showInputBox()"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"showInputBox"}),"(",(0,t.jsx)(n.code,{children:"options"}),"?, ",(0,t.jsx)(n.code,{children:"token"}),"?): ",(0,t.jsx)(n.code,{children:"Promise"}),"<",(0,t.jsx)(n.code,{children:"string"})," | ",(0,t.jsx)(n.code,{children:"undefined"}),">"]}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"Opens an input box to ask the user for input."}),"\n",(0,t.jsxs)(n.p,{children:["The returned value will be ",(0,t.jsx)(n.code,{children:"undefined"})," if the input box was canceled (e.g. pressing ESC). Otherwise the\nreturned value will be the string typed by the user or an empty string if the user did not type\nanything but dismissed the input box with OK."]}),"\n",(0,t.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"options?"}),": ",(0,t.jsx)(n.a,{href:"/api/interfaces/InputBoxOptions",children:(0,t.jsx)(n.code,{children:"InputBoxOptions"})})]}),"\n",(0,t.jsx)(n.p,{children:"Configures the behavior of the input box."}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"token?"}),": ",(0,t.jsx)(n.a,{href:"/api/interfaces/CancellationToken",children:(0,t.jsx)(n.code,{children:"CancellationToken"})})]}),"\n",(0,t.jsx)(n.p,{children:"A token that can be used to signal cancellation."}),"\n",(0,t.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"Promise"}),"<",(0,t.jsx)(n.code,{children:"string"})," | ",(0,t.jsx)(n.code,{children:"undefined"}),">"]}),"\n",(0,t.jsxs)(n.p,{children:["A promise that resolves to a string the user provided or to ",(0,t.jsx)(n.code,{children:"undefined"})," in case of dismissal."]}),"\n",(0,t.jsx)(n.h2,{id:"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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L1984",children:"packages/extension-api/src/extension-api.d.ts:1984"})})]})}function h(e={}){const{wrapper:n}={...(0,o.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(p,{...e})}):p(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>c,a:()=>r});var t=s(27378);const o={},i=t.createContext(o);function r(e){const n=t.useContext(i);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:r(e.components),t.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/612345e6.d20d4ee0.js b/assets/js/612345e6.bb1e59a7.js similarity index 95% rename from assets/js/612345e6.d20d4ee0.js rename to assets/js/612345e6.bb1e59a7.js index 4854cd870d3..71ff982b840 100644 --- a/assets/js/612345e6.d20d4ee0.js +++ b/assets/js/612345e6.bb1e59a7.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[47389],{8846:(n,e,t)=>{t.r(e),t.d(e,{assets:()=>c,contentTitle:()=>s,default:()=>l,frontMatter:()=>a,metadata:()=>r,toc:()=>d});var i=t(24246),o=t(71670);const a={},s="Function: navigateToContribution()",r={id:"namespaces/navigation/functions/navigateToContribution",title:"Function: navigateToContribution()",description:"navigateToContribution(name): Promise\\",source:"@site/api/namespaces/navigation/functions/navigateToContribution.md",sourceDirName:"namespaces/navigation/functions",slug:"/namespaces/navigation/functions/navigateToContribution",permalink:"/api/namespaces/navigation/functions/navigateToContribution",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"navigateToContainers",permalink:"/api/namespaces/navigation/functions/navigateToContainers"},next:{title:"navigateToEditProviderContainerConnection",permalink:"/api/namespaces/navigation/functions/navigateToEditProviderContainerConnection"}},c={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Defined in",id:"defined-in",level:2}];function u(n){const e={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,o.a)(),...n.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(e.h1,{id:"function-navigatetocontribution",children:"Function: navigateToContribution()"}),"\n",(0,i.jsxs)(e.blockquote,{children:["\n",(0,i.jsxs)(e.p,{children:[(0,i.jsx)(e.strong,{children:"navigateToContribution"}),"(",(0,i.jsx)(e.code,{children:"name"}),"): ",(0,i.jsx)(e.code,{children:"Promise"}),"<",(0,i.jsx)(e.code,{children:"void"}),">"]}),"\n"]}),"\n",(0,i.jsx)(e.h2,{id:"parameters",children:"Parameters"}),"\n",(0,i.jsxs)(e.p,{children:["\u2022 ",(0,i.jsx)(e.strong,{children:"name"}),": ",(0,i.jsx)(e.code,{children:"string"})]}),"\n",(0,i.jsx)(e.h2,{id:"returns",children:"Returns"}),"\n",(0,i.jsxs)(e.p,{children:[(0,i.jsx)(e.code,{children:"Promise"}),"<",(0,i.jsx)(e.code,{children:"void"}),">"]}),"\n",(0,i.jsx)(e.h2,{id:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L4454",children:"packages/extension-api/src/extension-api.d.ts:4454"})})]})}function l(n={}){const{wrapper:e}={...(0,o.a)(),...n.components};return e?(0,i.jsx)(e,{...n,children:(0,i.jsx)(u,{...n})}):u(n)}},71670:(n,e,t)=>{t.d(e,{Z:()=>r,a:()=>s});var i=t(27378);const o={},a=i.createContext(o);function s(n){const e=i.useContext(a);return i.useMemo((function(){return"function"==typeof n?n(e):{...e,...n}}),[e,n])}function r(n){let e;return e=n.disableParentContext?"function"==typeof n.components?n.components(o):n.components||o:s(n.components),i.createElement(a.Provider,{value:e},n.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[47389],{8846:(n,e,t)=>{t.r(e),t.d(e,{assets:()=>c,contentTitle:()=>s,default:()=>l,frontMatter:()=>a,metadata:()=>r,toc:()=>d});var i=t(24246),o=t(71670);const a={},s="Function: navigateToContribution()",r={id:"namespaces/navigation/functions/navigateToContribution",title:"Function: navigateToContribution()",description:"navigateToContribution(name): Promise\\",source:"@site/api/namespaces/navigation/functions/navigateToContribution.md",sourceDirName:"namespaces/navigation/functions",slug:"/namespaces/navigation/functions/navigateToContribution",permalink:"/api/namespaces/navigation/functions/navigateToContribution",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"navigateToContainers",permalink:"/api/namespaces/navigation/functions/navigateToContainers"},next:{title:"navigateToEditProviderContainerConnection",permalink:"/api/namespaces/navigation/functions/navigateToEditProviderContainerConnection"}},c={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Defined in",id:"defined-in",level:2}];function u(n){const e={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,o.a)(),...n.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(e.h1,{id:"function-navigatetocontribution",children:"Function: navigateToContribution()"}),"\n",(0,i.jsxs)(e.blockquote,{children:["\n",(0,i.jsxs)(e.p,{children:[(0,i.jsx)(e.strong,{children:"navigateToContribution"}),"(",(0,i.jsx)(e.code,{children:"name"}),"): ",(0,i.jsx)(e.code,{children:"Promise"}),"<",(0,i.jsx)(e.code,{children:"void"}),">"]}),"\n"]}),"\n",(0,i.jsx)(e.h2,{id:"parameters",children:"Parameters"}),"\n",(0,i.jsxs)(e.p,{children:["\u2022 ",(0,i.jsx)(e.strong,{children:"name"}),": ",(0,i.jsx)(e.code,{children:"string"})]}),"\n",(0,i.jsx)(e.h2,{id:"returns",children:"Returns"}),"\n",(0,i.jsxs)(e.p,{children:[(0,i.jsx)(e.code,{children:"Promise"}),"<",(0,i.jsx)(e.code,{children:"void"}),">"]}),"\n",(0,i.jsx)(e.h2,{id:"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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L4454",children:"packages/extension-api/src/extension-api.d.ts:4454"})})]})}function l(n={}){const{wrapper:e}={...(0,o.a)(),...n.components};return e?(0,i.jsx)(e,{...n,children:(0,i.jsx)(u,{...n})}):u(n)}},71670:(n,e,t)=>{t.d(e,{Z:()=>r,a:()=>s});var i=t(27378);const o={},a=i.createContext(o);function s(n){const e=i.useContext(a);return i.useMemo((function(){return"function"==typeof n?n(e):{...e,...n}}),[e,n])}function r(n){let e;return e=n.disableParentContext?"function"==typeof n.components?n.components(o):n.components||o:s(n.components),i.createElement(a.Provider,{value:e},n.children)}}}]); \ No newline at end of file diff --git a/assets/js/62e21724.dcea6959.js b/assets/js/62e21724.978aed76.js similarity index 92% rename from assets/js/62e21724.dcea6959.js rename to assets/js/62e21724.978aed76.js index 54a0de1119b..e3768f81caf 100644 --- a/assets/js/62e21724.dcea6959.js +++ b/assets/js/62e21724.978aed76.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[33067],{38536:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>r,default:()=>p,frontMatter:()=>c,metadata:()=>s,toc:()=>d});var i=t(24246),o=t(71670);const c={},r="Interface: QuickInputButton",s={id:"interfaces/QuickInputButton",title:"Interface: QuickInputButton",description:"Button for an action in a QuickPick or InputBox.",source:"@site/api/interfaces/QuickInputButton.md",sourceDirName:"interfaces",slug:"/interfaces/QuickInputButton",permalink:"/api/interfaces/QuickInputButton",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"PullEvent",permalink:"/api/interfaces/PullEvent"},next:{title:"QuickPickItem",permalink:"/api/interfaces/QuickPickItem"}},a={},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",hr:"hr",p:"p",strong:"strong",...(0,o.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"interface-quickinputbutton",children:"Interface: QuickInputButton"}),"\n",(0,i.jsx)(n.p,{children:"Button for an action in a QuickPick or InputBox."}),"\n",(0,i.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(n.h3,{id:"iconpath",children:"iconPath"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"readonly"})," ",(0,i.jsx)(n.strong,{children:"iconPath"}),": ",(0,i.jsx)(n.a,{href:"/api/classes/Uri",children:(0,i.jsx)(n.code,{children:"Uri"})})," | ",(0,i.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Icon for the button."}),"\n",(0,i.jsx)(n.h4,{id:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L1207",children:"packages/extension-api/src/extension-api.d.ts:1207"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L1212",children:"packages/extension-api/src/extension-api.d.ts:1212"})})]})}function p(e={}){const{wrapper:n}={...(0,o.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>s,a:()=>r});var i=t(27378);const o={},c=i.createContext(o);function r(e){const n=i.useContext(c);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function s(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:r(e.components),i.createElement(c.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[33067],{38536:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>r,default:()=>p,frontMatter:()=>c,metadata:()=>s,toc:()=>d});var i=t(24246),o=t(71670);const c={},r="Interface: QuickInputButton",s={id:"interfaces/QuickInputButton",title:"Interface: QuickInputButton",description:"Button for an action in a QuickPick or InputBox.",source:"@site/api/interfaces/QuickInputButton.md",sourceDirName:"interfaces",slug:"/interfaces/QuickInputButton",permalink:"/api/interfaces/QuickInputButton",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"PullEvent",permalink:"/api/interfaces/PullEvent"},next:{title:"QuickPickItem",permalink:"/api/interfaces/QuickPickItem"}},a={},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",hr:"hr",p:"p",strong:"strong",...(0,o.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"interface-quickinputbutton",children:"Interface: QuickInputButton"}),"\n",(0,i.jsx)(n.p,{children:"Button for an action in a QuickPick or InputBox."}),"\n",(0,i.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(n.h3,{id:"iconpath",children:"iconPath"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"readonly"})," ",(0,i.jsx)(n.strong,{children:"iconPath"}),": ",(0,i.jsx)(n.a,{href:"/api/classes/Uri",children:(0,i.jsx)(n.code,{children:"Uri"})})," | ",(0,i.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Icon for the button."}),"\n",(0,i.jsx)(n.h4,{id:"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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L1207",children:"packages/extension-api/src/extension-api.d.ts:1207"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L1212",children:"packages/extension-api/src/extension-api.d.ts:1212"})})]})}function p(e={}){const{wrapper:n}={...(0,o.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>s,a:()=>r});var i=t(27378);const o={},c=i.createContext(o);function r(e){const n=i.useContext(c);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function s(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:r(e.components),i.createElement(c.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/640277b9.ed7e9841.js b/assets/js/640277b9.f91e6c9a.js similarity index 97% rename from assets/js/640277b9.ed7e9841.js rename to assets/js/640277b9.f91e6c9a.js index de6611ffc01..4ee70cf2848 100644 --- a/assets/js/640277b9.ed7e9841.js +++ b/assets/js/640277b9.f91e6c9a.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[48901],{18630:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>a,contentTitle:()=>c,default:()=>u,frontMatter:()=>o,metadata:()=>r,toc:()=>d});var i=s(24246),t=s(71670);const o={},c="Function: listWebviews()",r={id:"namespaces/window/functions/listWebviews",title:"Function: listWebviews()",description:"listWebviews(): Promise\\",source:"@site/api/namespaces/window/functions/listWebviews.md",sourceDirName:"namespaces/window/functions",slug:"/namespaces/window/functions/listWebviews",permalink:"/api/namespaces/window/functions/listWebviews",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"createWebviewPanel",permalink:"/api/namespaces/window/functions/createWebviewPanel"},next:{title:"showErrorMessage",permalink:"/api/namespaces/window/functions/showErrorMessage"}},a={},d=[{value:"Returns",id:"returns",level:2},{value:"Defined in",id:"defined-in",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,t.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"function-listwebviews",children:"Function: listWebviews()"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"listWebviews"}),"(): ",(0,i.jsx)(n.code,{children:"Promise"}),"<",(0,i.jsx)(n.a,{href:"/api/interfaces/WebviewInfo",children:(0,i.jsx)(n.code,{children:"WebviewInfo"})}),"[]>"]}),"\n"]}),"\n",(0,i.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"Promise"}),"<",(0,i.jsx)(n.a,{href:"/api/interfaces/WebviewInfo",children:(0,i.jsx)(n.code,{children:"WebviewInfo"})}),"[]>"]}),"\n",(0,i.jsx)(n.h2,{id:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L2077",children:"packages/extension-api/src/extension-api.d.ts:2077"})})]})}function u(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>r,a:()=>c});var i=s(27378);const t={},o=i.createContext(t);function c(e){const n=i.useContext(o);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function r(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:c(e.components),i.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[48901],{18630:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>a,contentTitle:()=>c,default:()=>u,frontMatter:()=>o,metadata:()=>r,toc:()=>d});var i=s(24246),t=s(71670);const o={},c="Function: listWebviews()",r={id:"namespaces/window/functions/listWebviews",title:"Function: listWebviews()",description:"listWebviews(): Promise\\",source:"@site/api/namespaces/window/functions/listWebviews.md",sourceDirName:"namespaces/window/functions",slug:"/namespaces/window/functions/listWebviews",permalink:"/api/namespaces/window/functions/listWebviews",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"createWebviewPanel",permalink:"/api/namespaces/window/functions/createWebviewPanel"},next:{title:"showErrorMessage",permalink:"/api/namespaces/window/functions/showErrorMessage"}},a={},d=[{value:"Returns",id:"returns",level:2},{value:"Defined in",id:"defined-in",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,t.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"function-listwebviews",children:"Function: listWebviews()"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"listWebviews"}),"(): ",(0,i.jsx)(n.code,{children:"Promise"}),"<",(0,i.jsx)(n.a,{href:"/api/interfaces/WebviewInfo",children:(0,i.jsx)(n.code,{children:"WebviewInfo"})}),"[]>"]}),"\n"]}),"\n",(0,i.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"Promise"}),"<",(0,i.jsx)(n.a,{href:"/api/interfaces/WebviewInfo",children:(0,i.jsx)(n.code,{children:"WebviewInfo"})}),"[]>"]}),"\n",(0,i.jsx)(n.h2,{id:"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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2077",children:"packages/extension-api/src/extension-api.d.ts:2077"})})]})}function u(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>r,a:()=>c});var i=s(27378);const t={},o=i.createContext(t);function c(e){const n=i.useContext(o);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function r(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:c(e.components),i.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/64134c03.aa535a12.js b/assets/js/64134c03.25b6385e.js similarity index 94% rename from assets/js/64134c03.aa535a12.js rename to assets/js/64134c03.25b6385e.js index b57a33b5ef7..9972ffd5b5c 100644 --- a/assets/js/64134c03.aa535a12.js +++ b/assets/js/64134c03.25b6385e.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[71796],{28:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>r,contentTitle:()=>a,default:()=>p,frontMatter:()=>o,metadata:()=>c,toc:()=>d});var s=t(24246),i=t(71670);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",p:"p",strong:"strong",...(0,i.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"function-isenabled",children:"Function: isEnabled()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"isEnabled"}),"(): ",(0,s.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,s.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"boolean"})}),"\n",(0,s.jsx)(n.h2,{id:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L859",children:"packages/extension-api/src/extension-api.d.ts:859"})})]})}function p(e={}){const{wrapper:n}={...(0,i.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>c,a:()=>a});var s=t(27378);const i={},o=s.createContext(i);function a(e){const n=s.useContext(o);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function 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 +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[71796],{28:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>r,contentTitle:()=>a,default:()=>p,frontMatter:()=>o,metadata:()=>c,toc:()=>d});var s=t(24246),i=t(71670);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",p:"p",strong:"strong",...(0,i.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"function-isenabled",children:"Function: isEnabled()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"isEnabled"}),"(): ",(0,s.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,s.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"boolean"})}),"\n",(0,s.jsx)(n.h2,{id:"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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L859",children:"packages/extension-api/src/extension-api.d.ts:859"})})]})}function p(e={}){const{wrapper:n}={...(0,i.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>c,a:()=>a});var s=t(27378);const i={},o=s.createContext(i);function a(e){const n=s.useContext(o);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function 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.1514bd82.js b/assets/js/6477cdc2.16883f3c.js similarity index 98% rename from assets/js/6477cdc2.1514bd82.js rename to assets/js/6477cdc2.16883f3c.js index 2a7ffb6fdec..5496eccda2c 100644 --- a/assets/js/6477cdc2.1514bd82.js +++ b/assets/js/6477cdc2.16883f3c.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[16696],{52321:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>a,contentTitle:()=>o,default:()=>p,frontMatter:()=>i,metadata:()=>c,toc:()=>l});var t=r(24246),s=r(71670);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",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"function-createtelemetrylogger",children:"Function: createTelemetryLogger()"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"createTelemetryLogger"}),"(",(0,t.jsx)(n.code,{children:"sender"}),"?, ",(0,t.jsx)(n.code,{children:"options"}),"?): ",(0,t.jsx)(n.a,{href:"/api/interfaces/TelemetryLogger",children:(0,t.jsx)(n.code,{children:"TelemetryLogger"})})]}),"\n"]}),"\n",(0,t.jsxs)(n.p,{children:["Creates a new ",(0,t.jsx)(n.a,{href:"/api/interfaces/TelemetryLogger",children:"telemetry logger"}),"."]}),"\n",(0,t.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"sender?"}),": ",(0,t.jsx)(n.a,{href:"/api/interfaces/TelemetrySender",children:(0,t.jsx)(n.code,{children:"TelemetrySender"})})]}),"\n",(0,t.jsx)(n.p,{children:"The telemetry sender that is used by the telemetry logger."}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"options?"}),": ",(0,t.jsx)(n.a,{href:"/api/interfaces/TelemetryLoggerOptions",children:(0,t.jsx)(n.code,{children:"TelemetryLoggerOptions"})})]}),"\n",(0,t.jsx)(n.p,{children:"Options for the telemetry logger."}),"\n",(0,t.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"/api/interfaces/TelemetryLogger",children:(0,t.jsx)(n.code,{children:"TelemetryLogger"})})}),"\n",(0,t.jsx)(n.p,{children:"A new telemetry logger"}),"\n",(0,t.jsx)(n.h2,{id:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/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,s.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(d,{...e})}):d(e)}},71670:(e,n,r)=>{r.d(n,{Z:()=>c,a:()=>o});var t=r(27378);const s={},i=t.createContext(s);function o(e){const n=t.useContext(i);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:o(e.components),t.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[16696],{52321:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>a,contentTitle:()=>o,default:()=>p,frontMatter:()=>i,metadata:()=>c,toc:()=>l});var t=r(24246),s=r(71670);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",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"function-createtelemetrylogger",children:"Function: createTelemetryLogger()"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"createTelemetryLogger"}),"(",(0,t.jsx)(n.code,{children:"sender"}),"?, ",(0,t.jsx)(n.code,{children:"options"}),"?): ",(0,t.jsx)(n.a,{href:"/api/interfaces/TelemetryLogger",children:(0,t.jsx)(n.code,{children:"TelemetryLogger"})})]}),"\n"]}),"\n",(0,t.jsxs)(n.p,{children:["Creates a new ",(0,t.jsx)(n.a,{href:"/api/interfaces/TelemetryLogger",children:"telemetry logger"}),"."]}),"\n",(0,t.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"sender?"}),": ",(0,t.jsx)(n.a,{href:"/api/interfaces/TelemetrySender",children:(0,t.jsx)(n.code,{children:"TelemetrySender"})})]}),"\n",(0,t.jsx)(n.p,{children:"The telemetry sender that is used by the telemetry logger."}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"options?"}),": ",(0,t.jsx)(n.a,{href:"/api/interfaces/TelemetryLoggerOptions",children:(0,t.jsx)(n.code,{children:"TelemetryLoggerOptions"})})]}),"\n",(0,t.jsx)(n.p,{children:"Options for the telemetry logger."}),"\n",(0,t.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"/api/interfaces/TelemetryLogger",children:(0,t.jsx)(n.code,{children:"TelemetryLogger"})})}),"\n",(0,t.jsx)(n.p,{children:"A new telemetry logger"}),"\n",(0,t.jsx)(n.h2,{id:"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/bd83a8b2bb8ab886dc757381b589638cbda150d0/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,s.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(d,{...e})}):d(e)}},71670:(e,n,r)=>{r.d(n,{Z:()=>c,a:()=>o});var t=r(27378);const s={},i=t.createContext(s);function o(e){const n=t.useContext(i);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:o(e.components),t.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/6494b798.57708eca.js b/assets/js/6494b798.2f4a97b5.js similarity index 97% rename from assets/js/6494b798.57708eca.js rename to assets/js/6494b798.2f4a97b5.js index f1b2fa89e3a..4efe03145b9 100644 --- a/assets/js/6494b798.57708eca.js +++ b/assets/js/6494b798.2f4a97b5.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[41619],{92650:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>c,contentTitle:()=>o,default:()=>p,frontMatter:()=>a,metadata:()=>r,toc:()=>d});var i=s(24246),t=s(71670);const a={},o="Variable: isWindows",r={id:"namespaces/env/variables/isWindows",title:"Variable: isWindows",description:"const isWindows: boolean",source:"@site/api/namespaces/env/variables/isWindows.md",sourceDirName:"namespaces/env/variables",slug:"/namespaces/env/variables/isWindows",permalink:"/api/namespaces/env/variables/isWindows",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"isTelemetryEnabled",permalink:"/api/namespaces/env/variables/isTelemetryEnabled"},next:{title:"createTelemetryLogger",permalink:"/api/namespaces/env/functions/createTelemetryLogger"}},c={},d=[{value:"Defined in",id:"defined-in",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,t.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L3961",children:"packages/extension-api/src/extension-api.d.ts:3961"})})]})}function p(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>r,a:()=>o});var i=s(27378);const t={},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([[41619],{92650:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>c,contentTitle:()=>o,default:()=>p,frontMatter:()=>a,metadata:()=>r,toc:()=>d});var i=s(24246),t=s(71670);const a={},o="Variable: isWindows",r={id:"namespaces/env/variables/isWindows",title:"Variable: isWindows",description:"const isWindows: boolean",source:"@site/api/namespaces/env/variables/isWindows.md",sourceDirName:"namespaces/env/variables",slug:"/namespaces/env/variables/isWindows",permalink:"/api/namespaces/env/variables/isWindows",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"isTelemetryEnabled",permalink:"/api/namespaces/env/variables/isTelemetryEnabled"},next:{title:"createTelemetryLogger",permalink:"/api/namespaces/env/functions/createTelemetryLogger"}},c={},d=[{value:"Defined in",id:"defined-in",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,t.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L3961",children:"packages/extension-api/src/extension-api.d.ts:3961"})})]})}function p(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>r,a:()=>o});var i=s(27378);const t={},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/64bd32f2.9f5502cb.js b/assets/js/64bd32f2.d520aa3d.js similarity index 95% rename from assets/js/64bd32f2.9f5502cb.js rename to assets/js/64bd32f2.d520aa3d.js index b02bbb0724f..2cf56296201 100644 --- a/assets/js/64bd32f2.9f5502cb.js +++ b/assets/js/64bd32f2.d520aa3d.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[76192],{11197:(n,e,i)=>{i.r(e),i.d(e,{assets:()=>o,contentTitle:()=>r,default:()=>l,frontMatter:()=>c,metadata:()=>a,toc:()=>d});var s=i(24246),t=i(71670);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(n){const e={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,t.a)(),...n.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(e.h1,{id:"function-inspectmanifest",children:"Function: inspectManifest()"}),"\n",(0,s.jsxs)(e.blockquote,{children:["\n",(0,s.jsxs)(e.p,{children:[(0,s.jsx)(e.strong,{children:"inspectManifest"}),"(",(0,s.jsx)(e.code,{children:"engineId"}),", ",(0,s.jsx)(e.code,{children:"id"}),"): ",(0,s.jsx)(e.code,{children:"Promise"}),"<",(0,s.jsx)(e.a,{href:"/api/interfaces/ManifestInspectInfo",children:(0,s.jsx)(e.code,{children:"ManifestInspectInfo"})}),">"]}),"\n"]}),"\n",(0,s.jsx)(e.h2,{id:"parameters",children:"Parameters"}),"\n",(0,s.jsxs)(e.p,{children:["\u2022 ",(0,s.jsx)(e.strong,{children:"engineId"}),": ",(0,s.jsx)(e.code,{children:"string"})]}),"\n",(0,s.jsxs)(e.p,{children:["\u2022 ",(0,s.jsx)(e.strong,{children:"id"}),": ",(0,s.jsx)(e.code,{children:"string"})]}),"\n",(0,s.jsx)(e.h2,{id:"returns",children:"Returns"}),"\n",(0,s.jsxs)(e.p,{children:[(0,s.jsx)(e.code,{children:"Promise"}),"<",(0,s.jsx)(e.a,{href:"/api/interfaces/ManifestInspectInfo",children:(0,s.jsx)(e.code,{children:"ManifestInspectInfo"})}),">"]}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L3672",children:"packages/extension-api/src/extension-api.d.ts:3672"})})]})}function l(n={}){const{wrapper:e}={...(0,t.a)(),...n.components};return e?(0,s.jsx)(e,{...n,children:(0,s.jsx)(p,{...n})}):p(n)}},71670:(n,e,i)=>{i.d(e,{Z:()=>a,a:()=>r});var s=i(27378);const t={},c=s.createContext(t);function r(n){const e=s.useContext(c);return s.useMemo((function(){return"function"==typeof n?n(e):{...e,...n}}),[e,n])}function a(n){let e;return e=n.disableParentContext?"function"==typeof n.components?n.components(t):n.components||t:r(n.components),s.createElement(c.Provider,{value:e},n.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[76192],{11197:(n,e,i)=>{i.r(e),i.d(e,{assets:()=>o,contentTitle:()=>r,default:()=>l,frontMatter:()=>c,metadata:()=>a,toc:()=>d});var s=i(24246),t=i(71670);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(n){const e={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,t.a)(),...n.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(e.h1,{id:"function-inspectmanifest",children:"Function: inspectManifest()"}),"\n",(0,s.jsxs)(e.blockquote,{children:["\n",(0,s.jsxs)(e.p,{children:[(0,s.jsx)(e.strong,{children:"inspectManifest"}),"(",(0,s.jsx)(e.code,{children:"engineId"}),", ",(0,s.jsx)(e.code,{children:"id"}),"): ",(0,s.jsx)(e.code,{children:"Promise"}),"<",(0,s.jsx)(e.a,{href:"/api/interfaces/ManifestInspectInfo",children:(0,s.jsx)(e.code,{children:"ManifestInspectInfo"})}),">"]}),"\n"]}),"\n",(0,s.jsx)(e.h2,{id:"parameters",children:"Parameters"}),"\n",(0,s.jsxs)(e.p,{children:["\u2022 ",(0,s.jsx)(e.strong,{children:"engineId"}),": ",(0,s.jsx)(e.code,{children:"string"})]}),"\n",(0,s.jsxs)(e.p,{children:["\u2022 ",(0,s.jsx)(e.strong,{children:"id"}),": ",(0,s.jsx)(e.code,{children:"string"})]}),"\n",(0,s.jsx)(e.h2,{id:"returns",children:"Returns"}),"\n",(0,s.jsxs)(e.p,{children:[(0,s.jsx)(e.code,{children:"Promise"}),"<",(0,s.jsx)(e.a,{href:"/api/interfaces/ManifestInspectInfo",children:(0,s.jsx)(e.code,{children:"ManifestInspectInfo"})}),">"]}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L3672",children:"packages/extension-api/src/extension-api.d.ts:3672"})})]})}function l(n={}){const{wrapper:e}={...(0,t.a)(),...n.components};return e?(0,s.jsx)(e,{...n,children:(0,s.jsx)(p,{...n})}):p(n)}},71670:(n,e,i)=>{i.d(e,{Z:()=>a,a:()=>r});var s=i(27378);const t={},c=s.createContext(t);function r(n){const e=s.useContext(c);return s.useMemo((function(){return"function"==typeof n?n(e):{...e,...n}}),[e,n])}function a(n){let e;return e=n.disableParentContext?"function"==typeof n.components?n.components(t):n.components||t:r(n.components),s.createElement(c.Provider,{value:e},n.children)}}}]); \ No newline at end of file diff --git a/assets/js/67386898.a8a280a8.js b/assets/js/67386898.2ca4b3f0.js similarity index 91% rename from assets/js/67386898.a8a280a8.js rename to assets/js/67386898.2ca4b3f0.js index 46e180b85e8..d24c694d573 100644 --- a/assets/js/67386898.a8a280a8.js +++ b/assets/js/67386898.2ca4b3f0.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[20406],{39607:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>c,contentTitle:()=>s,default:()=>l,frontMatter:()=>o,metadata:()=>a,toc:()=>d});var i=t(24246),r=t(71670);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",hr:"hr",p:"p",strong:"strong",...(0,r.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"interface-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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L3405",children:"packages/extension-api/src/extension-api.d.ts:3405"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L3407",children:"packages/extension-api/src/extension-api.d.ts:3407"})})]})}function l(e={}){const{wrapper:n}={...(0,r.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(p,{...e})}):p(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>a,a:()=>s});var i=t(27378);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([[20406],{39607:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>c,contentTitle:()=>s,default:()=>l,frontMatter:()=>o,metadata:()=>a,toc:()=>d});var i=t(24246),r=t(71670);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",hr:"hr",p:"p",strong:"strong",...(0,r.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"interface-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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L3405",children:"packages/extension-api/src/extension-api.d.ts:3405"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L3407",children:"packages/extension-api/src/extension-api.d.ts:3407"})})]})}function l(e={}){const{wrapper:n}={...(0,r.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(p,{...e})}):p(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>a,a:()=>s});var i=t(27378);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.ef410b8f.js b/assets/js/6763d4e0.ced8b8c6.js similarity index 95% rename from assets/js/6763d4e0.ef410b8f.js rename to assets/js/6763d4e0.ced8b8c6.js index cf73f66336f..65ed7e70b9d 100644 --- a/assets/js/6763d4e0.ef410b8f.js +++ b/assets/js/6763d4e0.ced8b8c6.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[84513],{23558:(n,e,i)=>{i.r(e),i.d(e,{assets:()=>a,contentTitle:()=>r,default:()=>l,frontMatter:()=>o,metadata:()=>c,toc:()=>d});var t=i(24246),s=i(71670);const o={},r="Function: info()",c={id:"namespaces/containerEngine/functions/info",title:"Function: info()",description:"info(engineId): Promise\\",source:"@site/api/namespaces/containerEngine/functions/info.md",sourceDirName:"namespaces/containerEngine/functions",slug:"/namespaces/containerEngine/functions/info",permalink:"/api/namespaces/containerEngine/functions/info",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"getImageInspect",permalink:"/api/namespaces/containerEngine/functions/getImageInspect"},next:{title:"inspectContainer",permalink:"/api/namespaces/containerEngine/functions/inspectContainer"}},a={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Defined in",id:"defined-in",level:2}];function p(n){const e={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,s.a)(),...n.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(e.h1,{id:"function-info",children:"Function: info()"}),"\n",(0,t.jsxs)(e.blockquote,{children:["\n",(0,t.jsxs)(e.p,{children:[(0,t.jsx)(e.strong,{children:"info"}),"(",(0,t.jsx)(e.code,{children:"engineId"}),"): ",(0,t.jsx)(e.code,{children:"Promise"}),"<",(0,t.jsx)(e.a,{href:"/api/interfaces/ContainerEngineInfo",children:(0,t.jsx)(e.code,{children:"ContainerEngineInfo"})}),">"]}),"\n"]}),"\n",(0,t.jsx)(e.h2,{id:"parameters",children:"Parameters"}),"\n",(0,t.jsxs)(e.p,{children:["\u2022 ",(0,t.jsx)(e.strong,{children:"engineId"}),": ",(0,t.jsx)(e.code,{children:"string"})]}),"\n",(0,t.jsx)(e.h2,{id:"returns",children:"Returns"}),"\n",(0,t.jsxs)(e.p,{children:[(0,t.jsx)(e.code,{children:"Promise"}),"<",(0,t.jsx)(e.a,{href:"/api/interfaces/ContainerEngineInfo",children:(0,t.jsx)(e.code,{children:"ContainerEngineInfo"})}),">"]}),"\n",(0,t.jsx)(e.h2,{id:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L3627",children:"packages/extension-api/src/extension-api.d.ts:3627"})})]})}function l(n={}){const{wrapper:e}={...(0,s.a)(),...n.components};return e?(0,t.jsx)(e,{...n,children:(0,t.jsx)(p,{...n})}):p(n)}},71670:(n,e,i)=>{i.d(e,{Z:()=>c,a:()=>r});var t=i(27378);const s={},o=t.createContext(s);function r(n){const e=t.useContext(o);return t.useMemo((function(){return"function"==typeof n?n(e):{...e,...n}}),[e,n])}function c(n){let e;return e=n.disableParentContext?"function"==typeof n.components?n.components(s):n.components||s:r(n.components),t.createElement(o.Provider,{value:e},n.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[84513],{23558:(n,e,i)=>{i.r(e),i.d(e,{assets:()=>a,contentTitle:()=>r,default:()=>l,frontMatter:()=>o,metadata:()=>c,toc:()=>d});var t=i(24246),s=i(71670);const o={},r="Function: info()",c={id:"namespaces/containerEngine/functions/info",title:"Function: info()",description:"info(engineId): Promise\\",source:"@site/api/namespaces/containerEngine/functions/info.md",sourceDirName:"namespaces/containerEngine/functions",slug:"/namespaces/containerEngine/functions/info",permalink:"/api/namespaces/containerEngine/functions/info",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"getImageInspect",permalink:"/api/namespaces/containerEngine/functions/getImageInspect"},next:{title:"inspectContainer",permalink:"/api/namespaces/containerEngine/functions/inspectContainer"}},a={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Defined in",id:"defined-in",level:2}];function p(n){const e={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,s.a)(),...n.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(e.h1,{id:"function-info",children:"Function: info()"}),"\n",(0,t.jsxs)(e.blockquote,{children:["\n",(0,t.jsxs)(e.p,{children:[(0,t.jsx)(e.strong,{children:"info"}),"(",(0,t.jsx)(e.code,{children:"engineId"}),"): ",(0,t.jsx)(e.code,{children:"Promise"}),"<",(0,t.jsx)(e.a,{href:"/api/interfaces/ContainerEngineInfo",children:(0,t.jsx)(e.code,{children:"ContainerEngineInfo"})}),">"]}),"\n"]}),"\n",(0,t.jsx)(e.h2,{id:"parameters",children:"Parameters"}),"\n",(0,t.jsxs)(e.p,{children:["\u2022 ",(0,t.jsx)(e.strong,{children:"engineId"}),": ",(0,t.jsx)(e.code,{children:"string"})]}),"\n",(0,t.jsx)(e.h2,{id:"returns",children:"Returns"}),"\n",(0,t.jsxs)(e.p,{children:[(0,t.jsx)(e.code,{children:"Promise"}),"<",(0,t.jsx)(e.a,{href:"/api/interfaces/ContainerEngineInfo",children:(0,t.jsx)(e.code,{children:"ContainerEngineInfo"})}),">"]}),"\n",(0,t.jsx)(e.h2,{id:"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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L3627",children:"packages/extension-api/src/extension-api.d.ts:3627"})})]})}function l(n={}){const{wrapper:e}={...(0,s.a)(),...n.components};return e?(0,t.jsx)(e,{...n,children:(0,t.jsx)(p,{...n})}):p(n)}},71670:(n,e,i)=>{i.d(e,{Z:()=>c,a:()=>r});var t=i(27378);const s={},o=t.createContext(s);function r(n){const e=t.useContext(o);return t.useMemo((function(){return"function"==typeof n?n(e):{...e,...n}}),[e,n])}function c(n){let e;return e=n.disableParentContext?"function"==typeof n.components?n.components(s):n.components||s:r(n.components),t.createElement(o.Provider,{value:e},n.children)}}}]); \ No newline at end of file diff --git a/assets/js/6774f806.12300671.js b/assets/js/6774f806.ac8fc9a6.js similarity index 80% rename from assets/js/6774f806.12300671.js rename to assets/js/6774f806.ac8fc9a6.js index f784a9313e6..14f00ec0b01 100644 --- a/assets/js/6774f806.12300671.js +++ b/assets/js/6774f806.ac8fc9a6.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[35572],{81117:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>a,contentTitle:()=>s,default:()=>p,frontMatter:()=>r,metadata:()=>c,toc:()=>l});var t=i(24246),o=i(71670);const r={},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",p:"p",strong:"strong",...(0,o.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"function-pullimage",children:"Function: pullImage()"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"pullImage"}),"(",(0,t.jsx)(n.code,{children:"containerProviderConnection"}),", ",(0,t.jsx)(n.code,{children:"imageName"}),", ",(0,t.jsx)(n.code,{children:"callback"}),"): ",(0,t.jsx)(n.code,{children:"Promise"}),"<",(0,t.jsx)(n.code,{children:"void"}),">"]}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"Pull an image from a registry"}),"\n",(0,t.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"containerProviderConnection"}),": ",(0,t.jsx)(n.a,{href:"/api/interfaces/ContainerProviderConnection",children:(0,t.jsx)(n.code,{children:"ContainerProviderConnection"})})]}),"\n",(0,t.jsx)(n.p,{children:"the connection to the local engine to use for pulling the image"}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"imageName"}),": ",(0,t.jsx)(n.code,{children:"string"})]}),"\n",(0,t.jsx)(n.p,{children:"the name of the image to pull"}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"callback"})]}),"\n",(0,t.jsx)(n.p,{children:"the function called when new logs are emitted during the pull operation"}),"\n",(0,t.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"Promise"}),"<",(0,t.jsx)(n.code,{children:"void"}),">"]}),"\n",(0,t.jsx)(n.h2,{id:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L3604",children:"packages/extension-api/src/extension-api.d.ts:3604"})})]})}function p(e={}){const{wrapper:n}={...(0,o.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(d,{...e})}):d(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>c,a:()=>s});var t=i(27378);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([[35572],{81117:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>a,contentTitle:()=>r,default:()=>p,frontMatter:()=>c,metadata:()=>s,toc:()=>l});var t=i(24246),o=i(71670);const c={},r="Function: pullImage()",s={id:"namespaces/containerEngine/functions/pullImage",title:"Function: pullImage()",description:"pullImage(containerProviderConnection, imageName, callback): Promise\\",source:"@site/api/namespaces/containerEngine/functions/pullImage.md",sourceDirName:"namespaces/containerEngine/functions",slug:"/namespaces/containerEngine/functions/pullImage",permalink:"/api/namespaces/containerEngine/functions/pullImage",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"onEvent",permalink:"/api/namespaces/containerEngine/functions/onEvent"},next:{title:"pushImage",permalink:"/api/namespaces/containerEngine/functions/pushImage"}},a={},l=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Defined in",id:"defined-in",level:2}];function d(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,o.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"function-pullimage",children:"Function: pullImage()"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"pullImage"}),"(",(0,t.jsx)(n.code,{children:"containerProviderConnection"}),", ",(0,t.jsx)(n.code,{children:"imageName"}),", ",(0,t.jsx)(n.code,{children:"callback"}),"): ",(0,t.jsx)(n.code,{children:"Promise"}),"<",(0,t.jsx)(n.code,{children:"void"}),">"]}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"Pull an image from a registry"}),"\n",(0,t.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"containerProviderConnection"}),": ",(0,t.jsx)(n.a,{href:"/api/interfaces/ContainerProviderConnection",children:(0,t.jsx)(n.code,{children:"ContainerProviderConnection"})})]}),"\n",(0,t.jsx)(n.p,{children:"the connection to the local engine to use for pulling the image"}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"imageName"}),": ",(0,t.jsx)(n.code,{children:"string"})]}),"\n",(0,t.jsx)(n.p,{children:"the name of the image to pull"}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"callback"})]}),"\n",(0,t.jsx)(n.p,{children:"the function called when new logs are emitted during the pull operation"}),"\n",(0,t.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"Promise"}),"<",(0,t.jsx)(n.code,{children:"void"}),">"]}),"\n",(0,t.jsx)(n.h2,{id:"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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L3604",children:"packages/extension-api/src/extension-api.d.ts:3604"})})]})}function p(e={}){const{wrapper:n}={...(0,o.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(d,{...e})}):d(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>s,a:()=>r});var t=i(27378);const o={},c=t.createContext(o);function r(e){const n=t.useContext(c);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function s(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:r(e.components),t.createElement(c.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/67eba1be.42aa7e7c.js b/assets/js/67eba1be.81a299ef.js similarity index 76% rename from assets/js/67eba1be.42aa7e7c.js rename to assets/js/67eba1be.81a299ef.js index dda50b75d79..c884014cda1 100644 --- a/assets/js/67eba1be.42aa7e7c.js +++ b/assets/js/67eba1be.81a299ef.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[52950],{70166:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>a,contentTitle:()=>d,default:()=>p,frontMatter:()=>o,metadata:()=>r,toc:()=>c});var t=i(24246),s=i(71670);const o={},d="Interface: Command",r={id:"interfaces/Command",title:"Interface: Command",description:"Represents a reference to a command. Provides a title which",source:"@site/api/interfaces/Command.md",sourceDirName:"interfaces",slug:"/interfaces/Command",permalink:"/api/interfaces/Command",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Clipboard",permalink:"/api/interfaces/Clipboard"},next:{title:"Configuration",permalink:"/api/interfaces/Configuration"}},a={},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",hr:"hr",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"interface-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/804b2198fda0957e1ecfb87539f019eb9b79a66f/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/804b2198fda0957e1ecfb87539f019eb9b79a66f/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/804b2198fda0957e1ecfb87539f019eb9b79a66f/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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L53",children:"packages/extension-api/src/extension-api.d.ts:53"})})]})}function p(e={}){const{wrapper:n}={...(0,s.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>r,a:()=>d});var t=i(27378);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 r(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([[52950],{70166:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>r,contentTitle:()=>o,default:()=>p,frontMatter:()=>d,metadata:()=>a,toc:()=>c});var t=i(24246),s=i(71670);const d={},o="Interface: Command",a={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",hr:"hr",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"interface-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/bd83a8b2bb8ab886dc757381b589638cbda150d0/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/bd83a8b2bb8ab886dc757381b589638cbda150d0/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/bd83a8b2bb8ab886dc757381b589638cbda150d0/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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L53",children:"packages/extension-api/src/extension-api.d.ts:53"})})]})}function p(e={}){const{wrapper:n}={...(0,s.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>a,a:()=>o});var t=i(27378);const s={},d=t.createContext(s);function o(e){const n=t.useContext(d);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(d.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/67fccd64.09714cf5.js b/assets/js/67fccd64.b1c45f47.js similarity index 86% rename from assets/js/67fccd64.09714cf5.js rename to assets/js/67fccd64.b1c45f47.js index 12c6bff6958..ebad7c22693 100644 --- a/assets/js/67fccd64.09714cf5.js +++ b/assets/js/67fccd64.b1c45f47.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[77319],{33837:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>c,contentTitle:()=>a,default:()=>h,frontMatter:()=>d,metadata:()=>r,toc:()=>o});var s=i(24246),t=i(71670);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",hr:"hr",p:"p",strong:"strong",...(0,t.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"interface-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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L3158",children:"packages/extension-api/src/extension-api.d.ts:3158"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L3163",children:"packages/extension-api/src/extension-api.d.ts:3163"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L3153",children:"packages/extension-api/src/extension-api.d.ts:3153"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L3154",children:"packages/extension-api/src/extension-api.d.ts:3154"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L3162",children:"packages/extension-api/src/extension-api.d.ts:3162"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L3161",children:"packages/extension-api/src/extension-api.d.ts:3161"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L3159",children:"packages/extension-api/src/extension-api.d.ts:3159"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L3157",children:"packages/extension-api/src/extension-api.d.ts:3157"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L3164",children:"packages/extension-api/src/extension-api.d.ts:3164"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L3156",children:"packages/extension-api/src/extension-api.d.ts:3156"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L3155",children:"packages/extension-api/src/extension-api.d.ts:3155"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L3160",children:"packages/extension-api/src/extension-api.d.ts:3160"})})]})}function h(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>r,a:()=>a});var s=i(27378);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([[77319],{33837:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>c,contentTitle:()=>a,default:()=>h,frontMatter:()=>d,metadata:()=>r,toc:()=>o});var s=i(24246),t=i(71670);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",hr:"hr",p:"p",strong:"strong",...(0,t.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"interface-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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L3158",children:"packages/extension-api/src/extension-api.d.ts:3158"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L3163",children:"packages/extension-api/src/extension-api.d.ts:3163"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L3153",children:"packages/extension-api/src/extension-api.d.ts:3153"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L3154",children:"packages/extension-api/src/extension-api.d.ts:3154"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L3162",children:"packages/extension-api/src/extension-api.d.ts:3162"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L3161",children:"packages/extension-api/src/extension-api.d.ts:3161"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L3159",children:"packages/extension-api/src/extension-api.d.ts:3159"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L3157",children:"packages/extension-api/src/extension-api.d.ts:3157"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L3164",children:"packages/extension-api/src/extension-api.d.ts:3164"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L3156",children:"packages/extension-api/src/extension-api.d.ts:3156"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L3155",children:"packages/extension-api/src/extension-api.d.ts:3155"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L3160",children:"packages/extension-api/src/extension-api.d.ts:3160"})})]})}function h(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>r,a:()=>a});var s=i(27378);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/688ee267.24940500.js b/assets/js/688ee267.3d6d192d.js similarity index 96% rename from assets/js/688ee267.24940500.js rename to assets/js/688ee267.3d6d192d.js index bbb7c8321d0..744dcb99936 100644 --- a/assets/js/688ee267.24940500.js +++ b/assets/js/688ee267.3d6d192d.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[17708],{61733:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>r,contentTitle:()=>o,default:()=>h,frontMatter:()=>a,metadata:()=>c,toc:()=>d});var i=s(24246),t=s(71670);const a={},o="Function: onDidChangeSessions()",c={id:"namespaces/authentication/functions/onDidChangeSessions",title:"Function: onDidChangeSessions()",description:"onDidChangeSessions(listener, thisArgs?, disposables?): Disposable",source:"@site/api/namespaces/authentication/functions/onDidChangeSessions.md",sourceDirName:"namespaces/authentication/functions",slug:"/namespaces/authentication/functions/onDidChangeSessions",permalink:"/api/namespaces/authentication/functions/onDidChangeSessions",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"getSession",permalink:"/api/namespaces/authentication/functions/getSession"},next:{title:"registerAuthenticationProvider",permalink:"/api/namespaces/authentication/functions/registerAuthenticationProvider"}},r={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Defined in",id:"defined-in",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,t.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"function-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.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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L3921",children:"packages/extension-api/src/extension-api.d.ts:3921"})})]})}function h(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>c,a:()=>o});var i=s(27378);const t={},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 c(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([[17708],{61733:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>r,contentTitle:()=>o,default:()=>h,frontMatter:()=>a,metadata:()=>c,toc:()=>d});var i=s(24246),t=s(71670);const a={},o="Function: onDidChangeSessions()",c={id:"namespaces/authentication/functions/onDidChangeSessions",title:"Function: onDidChangeSessions()",description:"onDidChangeSessions(listener, thisArgs?, disposables?): Disposable",source:"@site/api/namespaces/authentication/functions/onDidChangeSessions.md",sourceDirName:"namespaces/authentication/functions",slug:"/namespaces/authentication/functions/onDidChangeSessions",permalink:"/api/namespaces/authentication/functions/onDidChangeSessions",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"getSession",permalink:"/api/namespaces/authentication/functions/getSession"},next:{title:"registerAuthenticationProvider",permalink:"/api/namespaces/authentication/functions/registerAuthenticationProvider"}},r={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Defined in",id:"defined-in",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,t.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"function-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.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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L3921",children:"packages/extension-api/src/extension-api.d.ts:3921"})})]})}function h(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>c,a:()=>o});var i=s(27378);const t={},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 c(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.86fa7388.js b/assets/js/6a1fe514.92025eb8.js similarity index 93% rename from assets/js/6a1fe514.86fa7388.js rename to assets/js/6a1fe514.92025eb8.js index 0568b4d8061..1071b6e144f 100644 --- a/assets/js/6a1fe514.86fa7388.js +++ b/assets/js/6a1fe514.92025eb8.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[96017],{70908:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>c,contentTitle:()=>d,default:()=>p,frontMatter:()=>t,metadata:()=>o,toc:()=>a});var r=i(24246),s=i(71670);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",hr:"hr",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.h1,{id:"interface-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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L871",children:"packages/extension-api/src/extension-api.d.ts:871"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L867",children:"packages/extension-api/src/extension-api.d.ts:867"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L868",children:"packages/extension-api/src/extension-api.d.ts:868"})})]})}function p(e={}){const{wrapper:n}={...(0,s.a)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(l,{...e})}):l(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>o,a:()=>d});var r=i(27378);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([[96017],{70908:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>c,contentTitle:()=>d,default:()=>p,frontMatter:()=>t,metadata:()=>o,toc:()=>a});var r=i(24246),s=i(71670);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",hr:"hr",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.h1,{id:"interface-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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L871",children:"packages/extension-api/src/extension-api.d.ts:871"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L867",children:"packages/extension-api/src/extension-api.d.ts:867"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L868",children:"packages/extension-api/src/extension-api.d.ts:868"})})]})}function p(e={}){const{wrapper:n}={...(0,s.a)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(l,{...e})}):l(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>o,a:()=>d});var r=i(27378);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.05eed424.js b/assets/js/6aa0b043.9f443ce4.js similarity index 92% rename from assets/js/6aa0b043.05eed424.js rename to assets/js/6aa0b043.9f443ce4.js index 984ac7be108..f3bc5998562 100644 --- a/assets/js/6aa0b043.05eed424.js +++ b/assets/js/6aa0b043.9f443ce4.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[84507],{28923:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>d,contentTitle:()=>c,default:()=>p,frontMatter:()=>t,metadata:()=>s,toc:()=>a});var r=i(24246),o=i(71670);const t={},c="Interface: ProviderContainerConnection",s={id:"interfaces/ProviderContainerConnection",title:"Interface: ProviderContainerConnection",description:"Properties",source:"@site/api/interfaces/ProviderContainerConnection.md",sourceDirName:"interfaces",slug:"/interfaces/ProviderContainerConnection",permalink:"/api/interfaces/ProviderContainerConnection",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"ProviderConnectionLifecycle",permalink:"/api/interfaces/ProviderConnectionLifecycle"},next:{title:"ProviderDetectionCheck",permalink:"/api/interfaces/ProviderDetectionCheck"}},d={},a=[{value:"Properties",id:"properties",level:2},{value:"connection",id:"connection",level:3},{value:"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",hr:"hr",p:"p",strong:"strong",...(0,o.a)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.h1,{id:"interface-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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L702",children:"packages/extension-api/src/extension-api.d.ts:702"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L701",children:"packages/extension-api/src/extension-api.d.ts:701"})})]})}function p(e={}){const{wrapper:n}={...(0,o.a)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(l,{...e})}):l(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>s,a:()=>c});var r=i(27378);const o={},t=r.createContext(o);function c(e){const n=r.useContext(t);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function s(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:c(e.components),r.createElement(t.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[84507],{28923:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>d,contentTitle:()=>c,default:()=>p,frontMatter:()=>t,metadata:()=>s,toc:()=>a});var r=i(24246),o=i(71670);const t={},c="Interface: ProviderContainerConnection",s={id:"interfaces/ProviderContainerConnection",title:"Interface: ProviderContainerConnection",description:"Properties",source:"@site/api/interfaces/ProviderContainerConnection.md",sourceDirName:"interfaces",slug:"/interfaces/ProviderContainerConnection",permalink:"/api/interfaces/ProviderContainerConnection",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"ProviderConnectionLifecycle",permalink:"/api/interfaces/ProviderConnectionLifecycle"},next:{title:"ProviderDetectionCheck",permalink:"/api/interfaces/ProviderDetectionCheck"}},d={},a=[{value:"Properties",id:"properties",level:2},{value:"connection",id:"connection",level:3},{value:"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",hr:"hr",p:"p",strong:"strong",...(0,o.a)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.h1,{id:"interface-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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L702",children:"packages/extension-api/src/extension-api.d.ts:702"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L701",children:"packages/extension-api/src/extension-api.d.ts:701"})})]})}function p(e={}){const{wrapper:n}={...(0,o.a)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(l,{...e})}):l(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>s,a:()=>c});var r=i(27378);const o={},t=r.createContext(o);function c(e){const n=r.useContext(t);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function s(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:c(e.components),r.createElement(t.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/6e30ac7b.db84a10c.js b/assets/js/6e30ac7b.51958463.js similarity index 85% rename from assets/js/6e30ac7b.db84a10c.js rename to assets/js/6e30ac7b.51958463.js index a91e003595a..e7fe1238804 100644 --- a/assets/js/6e30ac7b.db84a10c.js +++ b/assets/js/6e30ac7b.51958463.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[57368],{91803:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>r,contentTitle:()=>o,default:()=>h,frontMatter:()=>c,metadata:()=>d,toc:()=>a});var t=i(24246),s=i(71670);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",hr:"hr",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"interface-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/804b2198fda0957e1ecfb87539f019eb9b79a66f/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:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L1243",children:"packages/extension-api/src/extension-api.d.ts:1243"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L1227",children:"packages/extension-api/src/extension-api.d.ts:1227"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L1232",children:"packages/extension-api/src/extension-api.d.ts:1232"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L1237",children:"packages/extension-api/src/extension-api.d.ts:1237"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L1222",children:"packages/extension-api/src/extension-api.d.ts:1222"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L1254",children:"packages/extension-api/src/extension-api.d.ts:1254"})})]})}function h(e={}){const{wrapper:n}={...(0,s.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>d,a:()=>o});var t=i(27378);const s={},c=t.createContext(s);function o(e){const n=t.useContext(c);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function 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([[57368],{91803:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>r,contentTitle:()=>d,default:()=>h,frontMatter:()=>c,metadata:()=>o,toc:()=>a});var t=i(24246),s=i(71670);const c={},d="Interface: QuickPickOptions",o={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",hr:"hr",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"interface-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/bd83a8b2bb8ab886dc757381b589638cbda150d0/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:"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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L1243",children:"packages/extension-api/src/extension-api.d.ts:1243"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L1227",children:"packages/extension-api/src/extension-api.d.ts:1227"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L1232",children:"packages/extension-api/src/extension-api.d.ts:1232"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L1237",children:"packages/extension-api/src/extension-api.d.ts:1237"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L1222",children:"packages/extension-api/src/extension-api.d.ts:1222"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L1254",children:"packages/extension-api/src/extension-api.d.ts:1254"})})]})}function h(e={}){const{wrapper:n}={...(0,s.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>o,a:()=>d});var t=i(27378);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 o(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/6e92edd9.4b3268b3.js b/assets/js/6e92edd9.93630a35.js similarity index 89% rename from assets/js/6e92edd9.4b3268b3.js rename to assets/js/6e92edd9.93630a35.js index 53b41ad617e..73957eb0378 100644 --- a/assets/js/6e92edd9.4b3268b3.js +++ b/assets/js/6e92edd9.93630a35.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[63652],{26589:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>a,contentTitle:()=>t,default:()=>h,frontMatter:()=>d,metadata:()=>c,toc:()=>l});var s=i(24246),r=i(71670);const d={},t="Interface: Configuration",c={id:"interfaces/Configuration",title:"Interface: Configuration",description:"Indexable",source:"@site/api/interfaces/Configuration.md",sourceDirName:"interfaces",slug:"/interfaces/Configuration",permalink:"/api/interfaces/Configuration",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Command",permalink:"/api/interfaces/Command"},next:{title:"ConfigurationChangeEvent",permalink:"/api/interfaces/ConfigurationChangeEvent"}},a={},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",hr:"hr",p:"p",strong:"strong",...(0,r.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"interface-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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L951",children:"packages/extension-api/src/extension-api.d.ts:951"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L960",children:"packages/extension-api/src/extension-api.d.ts:960"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L968",children:"packages/extension-api/src/extension-api.d.ts:968"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L974",children:"packages/extension-api/src/extension-api.d.ts:974"})})]})}function h(e={}){const{wrapper:n}={...(0,r.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(o,{...e})}):o(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>c,a:()=>t});var s=i(27378);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([[63652],{26589:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>a,contentTitle:()=>t,default:()=>h,frontMatter:()=>r,metadata:()=>c,toc:()=>l});var s=i(24246),d=i(71670);const r={},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",hr:"hr",p:"p",strong:"strong",...(0,d.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L951",children:"packages/extension-api/src/extension-api.d.ts:951"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L960",children:"packages/extension-api/src/extension-api.d.ts:960"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L968",children:"packages/extension-api/src/extension-api.d.ts:968"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L974",children:"packages/extension-api/src/extension-api.d.ts:974"})})]})}function h(e={}){const{wrapper:n}={...(0,d.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(o,{...e})}):o(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>c,a:()=>t});var s=i(27378);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/6eafe0c7.08524986.js b/assets/js/6eafe0c7.241d1080.js similarity index 87% rename from assets/js/6eafe0c7.08524986.js rename to assets/js/6eafe0c7.241d1080.js index b38406bcc00..7534dcf5c7b 100644 --- a/assets/js/6eafe0c7.08524986.js +++ b/assets/js/6eafe0c7.241d1080.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[88089],{87532:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>o,contentTitle:()=>r,default:()=>h,frontMatter:()=>t,metadata:()=>a,toc:()=>c});var s=i(24246),d=i(71670);const t={},r="Interface: EndpointSettings",a={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"}},o={},c=[{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",hr:"hr",p:"p",strong:"strong",...(0,d.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L2757",children:"packages/extension-api/src/extension-api.d.ts:2757"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/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:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/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:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L2767",children:"packages/extension-api/src/extension-api.d.ts:2767"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L2772",children:"packages/extension-api/src/extension-api.d.ts:2772"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/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:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/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:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L2748",children:"packages/extension-api/src/extension-api.d.ts:2748"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/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:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L2782",children:"packages/extension-api/src/extension-api.d.ts:2782"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/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:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L2750",children:"packages/extension-api/src/extension-api.d.ts:2750"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L2755",children:"packages/extension-api/src/extension-api.d.ts:2755"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L2762",children:"packages/extension-api/src/extension-api.d.ts:2762"})})]})}function h(e={}){const{wrapper:n}={...(0,d.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>a,a:()=>r});var s=i(27378);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([[88089],{87532:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>c,contentTitle:()=>r,default:()=>h,frontMatter:()=>t,metadata:()=>a,toc:()=>o});var s=i(24246),d=i(71670);const t={},r="Interface: EndpointSettings",a={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",hr:"hr",p:"p",strong:"strong",...(0,d.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2757",children:"packages/extension-api/src/extension-api.d.ts:2757"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/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:"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/bd83a8b2bb8ab886dc757381b589638cbda150d0/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:"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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2767",children:"packages/extension-api/src/extension-api.d.ts:2767"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2772",children:"packages/extension-api/src/extension-api.d.ts:2772"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/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:"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/bd83a8b2bb8ab886dc757381b589638cbda150d0/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:"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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2748",children:"packages/extension-api/src/extension-api.d.ts:2748"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/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:"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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2782",children:"packages/extension-api/src/extension-api.d.ts:2782"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/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:"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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2750",children:"packages/extension-api/src/extension-api.d.ts:2750"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2755",children:"packages/extension-api/src/extension-api.d.ts:2755"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2762",children:"packages/extension-api/src/extension-api.d.ts:2762"})})]})}function h(e={}){const{wrapper:n}={...(0,d.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>a,a:()=>r});var s=i(27378);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 diff --git a/assets/js/70bd0abb.a8a1129f.js b/assets/js/70bd0abb.183fa272.js similarity index 96% rename from assets/js/70bd0abb.a8a1129f.js rename to assets/js/70bd0abb.183fa272.js index 9e58bfd5d4b..2de2515243c 100644 --- a/assets/js/70bd0abb.a8a1129f.js +++ b/assets/js/70bd0abb.183fa272.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[76952],{94297:(e,i,r)=>{r.r(i),r.d(i,{assets:()=>o,contentTitle:()=>t,default:()=>p,frontMatter:()=>a,metadata:()=>c,toc:()=>d});var n=r(24246),s=r(71670);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"}},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 i={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(i.h1,{id:"function-createimagefilesprovider",children:"Function: createImageFilesProvider()"}),"\n",(0,n.jsxs)(i.blockquote,{children:["\n",(0,n.jsxs)(i.p,{children:[(0,n.jsx)(i.strong,{children:"createImageFilesProvider"}),"(",(0,n.jsx)(i.code,{children:"imageFilesCallbacks"}),", ",(0,n.jsx)(i.code,{children:"metadata"}),"?): ",(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:(0,n.jsx)(i.strong,{children:(0,n.jsx)(i.code,{children:"Beta"})})}),"\n",(0,n.jsx)(i.p,{children:"Register the extension as an Image Files provider."}),"\n",(0,n.jsx)(i.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)(i.h2,{id:"parameters",children:"Parameters"}),"\n",(0,n.jsxs)(i.p,{children:["\u2022 ",(0,n.jsx)(i.strong,{children:"imageFilesCallbacks"}),": ",(0,n.jsx)(i.a,{href:"/api/interfaces/ImageFilesCallbacks",children:(0,n.jsx)(i.code,{children:"ImageFilesCallbacks"})})]}),"\n",(0,n.jsxs)(i.p,{children:["an object implementing the ",(0,n.jsx)(i.code,{children:"ImageFilesProvider"})," interface"]}),"\n",(0,n.jsxs)(i.p,{children:["\u2022 ",(0,n.jsx)(i.strong,{children:"metadata?"}),": ",(0,n.jsx)(i.a,{href:"/api/interfaces/ImageFilesProviderMetadata",children:(0,n.jsx)(i.code,{children:"ImageFilesProviderMetadata"})})]}),"\n",(0,n.jsx)(i.p,{children:"optional metadata attached to this provider"}),"\n",(0,n.jsx)(i.h2,{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.p,{children:"A disposable that unregisters this provider when being disposed"}),"\n",(0,n.jsx)(i.h2,{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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L840",children:"packages/extension-api/src/extension-api.d.ts:840"})})]})}function p(e={}){const{wrapper:i}={...(0,s.a)(),...e.components};return i?(0,n.jsx)(i,{...e,children:(0,n.jsx)(l,{...e})}):l(e)}},71670:(e,i,r)=>{r.d(i,{Z:()=>c,a:()=>t});var n=r(27378);const s={},a=n.createContext(s);function t(e){const i=n.useContext(a);return n.useMemo((function(){return"function"==typeof e?e(i):{...i,...e}}),[i,e])}function c(e){let i;return i=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:t(e.components),n.createElement(a.Provider,{value:i},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[76952],{94297:(e,i,r)=>{r.r(i),r.d(i,{assets:()=>o,contentTitle:()=>t,default:()=>p,frontMatter:()=>a,metadata:()=>c,toc:()=>d});var n=r(24246),s=r(71670);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"}},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 i={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(i.h1,{id:"function-createimagefilesprovider",children:"Function: createImageFilesProvider()"}),"\n",(0,n.jsxs)(i.blockquote,{children:["\n",(0,n.jsxs)(i.p,{children:[(0,n.jsx)(i.strong,{children:"createImageFilesProvider"}),"(",(0,n.jsx)(i.code,{children:"imageFilesCallbacks"}),", ",(0,n.jsx)(i.code,{children:"metadata"}),"?): ",(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:(0,n.jsx)(i.strong,{children:(0,n.jsx)(i.code,{children:"Beta"})})}),"\n",(0,n.jsx)(i.p,{children:"Register the extension as an Image Files provider."}),"\n",(0,n.jsx)(i.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)(i.h2,{id:"parameters",children:"Parameters"}),"\n",(0,n.jsxs)(i.p,{children:["\u2022 ",(0,n.jsx)(i.strong,{children:"imageFilesCallbacks"}),": ",(0,n.jsx)(i.a,{href:"/api/interfaces/ImageFilesCallbacks",children:(0,n.jsx)(i.code,{children:"ImageFilesCallbacks"})})]}),"\n",(0,n.jsxs)(i.p,{children:["an object implementing the ",(0,n.jsx)(i.code,{children:"ImageFilesProvider"})," interface"]}),"\n",(0,n.jsxs)(i.p,{children:["\u2022 ",(0,n.jsx)(i.strong,{children:"metadata?"}),": ",(0,n.jsx)(i.a,{href:"/api/interfaces/ImageFilesProviderMetadata",children:(0,n.jsx)(i.code,{children:"ImageFilesProviderMetadata"})})]}),"\n",(0,n.jsx)(i.p,{children:"optional metadata attached to this provider"}),"\n",(0,n.jsx)(i.h2,{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.p,{children:"A disposable that unregisters this provider when being disposed"}),"\n",(0,n.jsx)(i.h2,{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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L840",children:"packages/extension-api/src/extension-api.d.ts:840"})})]})}function p(e={}){const{wrapper:i}={...(0,s.a)(),...e.components};return i?(0,n.jsx)(i,{...e,children:(0,n.jsx)(l,{...e})}):l(e)}},71670:(e,i,r)=>{r.d(i,{Z:()=>c,a:()=>t});var n=r(27378);const s={},a=n.createContext(s);function t(e){const i=n.useContext(a);return n.useMemo((function(){return"function"==typeof e?e(i):{...i,...e}}),[i,e])}function c(e){let i;return i=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:t(e.components),n.createElement(a.Provider,{value:i},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/70e3b13c.af3f867a.js b/assets/js/70e3b13c.a39d7cf1.js similarity index 95% rename from assets/js/70e3b13c.af3f867a.js rename to assets/js/70e3b13c.a39d7cf1.js index da2fda6838a..09072003c1e 100644 --- a/assets/js/70e3b13c.af3f867a.js +++ b/assets/js/70e3b13c.a39d7cf1.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[25817],{2656:(e,s,r)=>{r.r(s),r.d(s,{assets:()=>o,contentTitle:()=>c,default:()=>p,frontMatter:()=>i,metadata:()=>a,toc:()=>d});var n=r(24246),t=r(71670);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",p:"p",strong:"strong",...(0,t.a)(),...e.components};return(0,n.jsxs)(n.Fragment,{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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L902",children:"packages/extension-api/src/extension-api.d.ts:902"})})]})}function p(e={}){const{wrapper:s}={...(0,t.a)(),...e.components};return s?(0,n.jsx)(s,{...e,children:(0,n.jsx)(l,{...e})}):l(e)}},71670:(e,s,r)=>{r.d(s,{Z:()=>a,a:()=>c});var n=r(27378);const t={},i=n.createContext(t);function c(e){const s=n.useContext(i);return n.useMemo((function(){return"function"==typeof e?e(s):{...s,...e}}),[s,e])}function 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([[25817],{2656:(e,s,r)=>{r.r(s),r.d(s,{assets:()=>o,contentTitle:()=>c,default:()=>p,frontMatter:()=>i,metadata:()=>a,toc:()=>d});var n=r(24246),t=r(71670);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",p:"p",strong:"strong",...(0,t.a)(),...e.components};return(0,n.jsxs)(n.Fragment,{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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L902",children:"packages/extension-api/src/extension-api.d.ts:902"})})]})}function p(e={}){const{wrapper:s}={...(0,t.a)(),...e.components};return s?(0,n.jsx)(s,{...e,children:(0,n.jsx)(l,{...e})}):l(e)}},71670:(e,s,r)=>{r.d(s,{Z:()=>a,a:()=>c});var n=r(27378);const t={},i=n.createContext(t);function c(e){const s=n.useContext(i);return n.useMemo((function(){return"function"==typeof e?e(s):{...s,...e}}),[s,e])}function 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.da045914.js b/assets/js/714e70d1.45e092b5.js similarity index 80% rename from assets/js/714e70d1.da045914.js rename to assets/js/714e70d1.45e092b5.js index 36c12dd389e..37ce0961097 100644 --- a/assets/js/714e70d1.da045914.js +++ b/assets/js/714e70d1.45e092b5.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[648],{80071:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>a,contentTitle:()=>d,default:()=>p,frontMatter:()=>r,metadata:()=>o,toc:()=>c});var t=i(24246),s=i(71670);const r={},d="Interface: ProviderEvent",o={id:"interfaces/ProviderEvent",title:"Interface: ProviderEvent",description:"Properties",source:"@site/api/interfaces/ProviderEvent.md",sourceDirName:"interfaces",slug:"/interfaces/ProviderEvent",permalink:"/api/interfaces/ProviderEvent",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"ProviderDetectionCheck",permalink:"/api/interfaces/ProviderDetectionCheck"},next:{title:"ProviderImages",permalink:"/api/interfaces/ProviderImages"}},a={},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",hr:"hr",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"interface-providerevent",children:"Interface: ProviderEvent"}),"\n",(0,t.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,t.jsx)(n.h3,{id:"id",children:"id"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"id"}),": ",(0,t.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L670",children:"packages/extension-api/src/extension-api.d.ts:670"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L671",children:"packages/extension-api/src/extension-api.d.ts:671"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L672",children:"packages/extension-api/src/extension-api.d.ts:672"})})]})}function p(e={}){const{wrapper:n}={...(0,s.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>o,a:()=>d});var t=i(27378);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([[648],{80071:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>c,contentTitle:()=>d,default:()=>p,frontMatter:()=>r,metadata:()=>a,toc:()=>o});var t=i(24246),s=i(71670);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",hr:"hr",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"interface-providerevent",children:"Interface: ProviderEvent"}),"\n",(0,t.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,t.jsx)(n.h3,{id:"id",children:"id"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"id"}),": ",(0,t.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L670",children:"packages/extension-api/src/extension-api.d.ts:670"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L671",children:"packages/extension-api/src/extension-api.d.ts:671"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L672",children:"packages/extension-api/src/extension-api.d.ts:672"})})]})}function p(e={}){const{wrapper:n}={...(0,s.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>a,a:()=>d});var t=i(27378);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.52adcf7a.js b/assets/js/71748509.472cbc48.js similarity index 97% rename from assets/js/71748509.52adcf7a.js rename to assets/js/71748509.472cbc48.js index d1225f27457..f51cef22c9c 100644 --- a/assets/js/71748509.52adcf7a.js +++ b/assets/js/71748509.472cbc48.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[97227],{17001:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>a,contentTitle:()=>c,default:()=>l,frontMatter:()=>i,metadata:()=>o,toc:()=>d});var t=s(24246),r=s(71670);const i={},c="Function: unregisterRegistry()",o={id:"namespaces/registry/functions/unregisterRegistry",title:"Function: unregisterRegistry()",description:"unregisterRegistry(registry): void",source:"@site/api/namespaces/registry/functions/unregisterRegistry.md",sourceDirName:"namespaces/registry/functions",slug:"/namespaces/registry/functions/unregisterRegistry",permalink:"/api/namespaces/registry/functions/unregisterRegistry",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"suggestRegistry",permalink:"/api/namespaces/registry/functions/suggestRegistry"},next:{title:"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",p:"p",strong:"strong",...(0,r.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"function-unregisterregistry",children:"Function: unregisterRegistry()"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"unregisterRegistry"}),"(",(0,t.jsx)(n.code,{children:"registry"}),"): ",(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:"registry"}),": ",(0,t.jsx)(n.a,{href:"/api/interfaces/Registry",children:(0,t.jsx)(n.code,{children:"Registry"})})]}),"\n",(0,t.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,t.jsx)(n.p,{children:(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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L905",children:"packages/extension-api/src/extension-api.d.ts:905"})})]})}function l(e={}){const{wrapper:n}={...(0,r.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(u,{...e})}):u(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>o,a:()=>c});var t=s(27378);const r={},i=t.createContext(r);function c(e){const n=t.useContext(i);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:c(e.components),t.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[97227],{17001:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>a,contentTitle:()=>c,default:()=>l,frontMatter:()=>i,metadata:()=>o,toc:()=>d});var t=s(24246),r=s(71670);const i={},c="Function: unregisterRegistry()",o={id:"namespaces/registry/functions/unregisterRegistry",title:"Function: unregisterRegistry()",description:"unregisterRegistry(registry): void",source:"@site/api/namespaces/registry/functions/unregisterRegistry.md",sourceDirName:"namespaces/registry/functions",slug:"/namespaces/registry/functions/unregisterRegistry",permalink:"/api/namespaces/registry/functions/unregisterRegistry",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"suggestRegistry",permalink:"/api/namespaces/registry/functions/suggestRegistry"},next:{title:"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",p:"p",strong:"strong",...(0,r.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"function-unregisterregistry",children:"Function: unregisterRegistry()"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"unregisterRegistry"}),"(",(0,t.jsx)(n.code,{children:"registry"}),"): ",(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:"registry"}),": ",(0,t.jsx)(n.a,{href:"/api/interfaces/Registry",children:(0,t.jsx)(n.code,{children:"Registry"})})]}),"\n",(0,t.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,t.jsx)(n.p,{children:(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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L905",children:"packages/extension-api/src/extension-api.d.ts:905"})})]})}function l(e={}){const{wrapper:n}={...(0,r.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(u,{...e})}):u(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>o,a:()=>c});var t=s(27378);const r={},i=t.createContext(r);function c(e){const n=t.useContext(i);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:c(e.components),t.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/7258860f.8f91e78e.js b/assets/js/7258860f.069d2532.js similarity index 96% rename from assets/js/7258860f.8f91e78e.js rename to assets/js/7258860f.069d2532.js index 2fbd3bf5c9c..ae5511c25b0 100644 --- a/assets/js/7258860f.8f91e78e.js +++ b/assets/js/7258860f.069d2532.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[92423],{87064:(n,e,i)=>{i.r(e),i.d(e,{assets:()=>c,contentTitle:()=>r,default:()=>h,frontMatter:()=>o,metadata:()=>a,toc:()=>d});var t=i(24246),s=i(71670);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(n){const e={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,s.a)(),...n.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(e.h1,{id:"function-logscontainer",children:"Function: logsContainer()"}),"\n",(0,t.jsxs)(e.blockquote,{children:["\n",(0,t.jsxs)(e.p,{children:[(0,t.jsx)(e.strong,{children:"logsContainer"}),"(",(0,t.jsx)(e.code,{children:"engineId"}),", ",(0,t.jsx)(e.code,{children:"id"}),", ",(0,t.jsx)(e.code,{children:"callback"}),"): ",(0,t.jsx)(e.code,{children:"Promise"}),"<",(0,t.jsx)(e.code,{children:"void"}),">"]}),"\n"]}),"\n",(0,t.jsx)(e.p,{children:"Get the streamed logs of a 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 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.jsxs)(e.p,{children:["\u2022 ",(0,t.jsx)(e.strong,{children:"callback"})]}),"\n",(0,t.jsxs)(e.p,{children:["the function called when new logs are emitted or new events happen on the stream. The value of ",(0,t.jsx)(e.code,{children:"name"})," can be either ",(0,t.jsx)(e.code,{children:"data"})," (and ",(0,t.jsx)(e.code,{children:"data"})," contains the logs), or ",(0,t.jsx)(e.code,{children:"end"})," indicating the end of the stream, or ",(0,t.jsx)(e.code,{children:"first-message"})," indicating no data has been emitted yet on the stream."]}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L3481",children:"packages/extension-api/src/extension-api.d.ts:3481"})})]})}function h(n={}){const{wrapper:e}={...(0,s.a)(),...n.components};return e?(0,t.jsx)(e,{...n,children:(0,t.jsx)(l,{...n})}):l(n)}},71670:(n,e,i)=>{i.d(e,{Z:()=>a,a:()=>r});var t=i(27378);const s={},o=t.createContext(s);function r(n){const e=t.useContext(o);return t.useMemo((function(){return"function"==typeof n?n(e):{...e,...n}}),[e,n])}function 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([[92423],{87064:(n,e,i)=>{i.r(e),i.d(e,{assets:()=>c,contentTitle:()=>r,default:()=>h,frontMatter:()=>o,metadata:()=>a,toc:()=>d});var t=i(24246),s=i(71670);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(n){const e={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,s.a)(),...n.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(e.h1,{id:"function-logscontainer",children:"Function: logsContainer()"}),"\n",(0,t.jsxs)(e.blockquote,{children:["\n",(0,t.jsxs)(e.p,{children:[(0,t.jsx)(e.strong,{children:"logsContainer"}),"(",(0,t.jsx)(e.code,{children:"engineId"}),", ",(0,t.jsx)(e.code,{children:"id"}),", ",(0,t.jsx)(e.code,{children:"callback"}),"): ",(0,t.jsx)(e.code,{children:"Promise"}),"<",(0,t.jsx)(e.code,{children:"void"}),">"]}),"\n"]}),"\n",(0,t.jsx)(e.p,{children:"Get the streamed logs of a 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 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.jsxs)(e.p,{children:["\u2022 ",(0,t.jsx)(e.strong,{children:"callback"})]}),"\n",(0,t.jsxs)(e.p,{children:["the function called when new logs are emitted or new events happen on the stream. The value of ",(0,t.jsx)(e.code,{children:"name"})," can be either ",(0,t.jsx)(e.code,{children:"data"})," (and ",(0,t.jsx)(e.code,{children:"data"})," contains the logs), or ",(0,t.jsx)(e.code,{children:"end"})," indicating the end of the stream, or ",(0,t.jsx)(e.code,{children:"first-message"})," indicating no data has been emitted yet on the stream."]}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L3481",children:"packages/extension-api/src/extension-api.d.ts:3481"})})]})}function h(n={}){const{wrapper:e}={...(0,s.a)(),...n.components};return e?(0,t.jsx)(e,{...n,children:(0,t.jsx)(l,{...n})}):l(n)}},71670:(n,e,i)=>{i.d(e,{Z:()=>a,a:()=>r});var t=i(27378);const s={},o=t.createContext(s);function r(n){const e=t.useContext(o);return t.useMemo((function(){return"function"==typeof n?n(e):{...e,...n}}),[e,n])}function 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/73f18a6f.ea20a973.js b/assets/js/73f18a6f.ac67b8b7.js similarity index 95% rename from assets/js/73f18a6f.ea20a973.js rename to assets/js/73f18a6f.ac67b8b7.js index 487dab3670e..5d65c350c2e 100644 --- a/assets/js/73f18a6f.ea20a973.js +++ b/assets/js/73f18a6f.ac67b8b7.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[14499],{46403:(e,r,n)=>{n.r(r),n.d(r,{assets:()=>a,contentTitle:()=>s,default:()=>l,frontMatter:()=>o,metadata:()=>c,toc:()=>d});var i=n(24246),t=n(71670);const o={},s="Function: createProvider()",c={id:"namespaces/provider/functions/createProvider",title:"Function: createProvider()",description:"createProvider(provider): Provider",source:"@site/api/namespaces/provider/functions/createProvider.md",sourceDirName:"namespaces/provider/functions",slug:"/namespaces/provider/functions/createProvider",permalink:"/api/namespaces/provider/functions/createProvider",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"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",p:"p",strong:"strong",...(0,t.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L810",children:"packages/extension-api/src/extension-api.d.ts:810"})})]})}function l(e={}){const{wrapper:r}={...(0,t.a)(),...e.components};return r?(0,i.jsx)(r,{...e,children:(0,i.jsx)(p,{...e})}):p(e)}},71670:(e,r,n)=>{n.d(r,{Z:()=>c,a:()=>s});var i=n(27378);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([[14499],{46403:(e,r,n)=>{n.r(r),n.d(r,{assets:()=>a,contentTitle:()=>s,default:()=>l,frontMatter:()=>o,metadata:()=>c,toc:()=>d});var i=n(24246),t=n(71670);const o={},s="Function: createProvider()",c={id:"namespaces/provider/functions/createProvider",title:"Function: createProvider()",description:"createProvider(provider): Provider",source:"@site/api/namespaces/provider/functions/createProvider.md",sourceDirName:"namespaces/provider/functions",slug:"/namespaces/provider/functions/createProvider",permalink:"/api/namespaces/provider/functions/createProvider",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"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",p:"p",strong:"strong",...(0,t.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L810",children:"packages/extension-api/src/extension-api.d.ts:810"})})]})}function l(e={}){const{wrapper:r}={...(0,t.a)(),...e.components};return r?(0,i.jsx)(r,{...e,children:(0,i.jsx)(p,{...e})}):p(e)}},71670:(e,r,n)=>{n.d(r,{Z:()=>c,a:()=>s});var i=n(27378);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.007c7565.js b/assets/js/73f9658e.dd941f40.js similarity index 97% rename from assets/js/73f9658e.007c7565.js rename to assets/js/73f9658e.dd941f40.js index 6d67477c7c3..704eae0e5f4 100644 --- a/assets/js/73f9658e.007c7565.js +++ b/assets/js/73f9658e.dd941f40.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[61305],{34683:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>o,contentTitle:()=>r,default:()=>l,frontMatter:()=>a,metadata:()=>c,toc:()=>d});var s=i(24246),t=i(71670);const a={},r="Function: pushImage()",c={id:"namespaces/containerEngine/functions/pushImage",title:"Function: pushImage()",description:"pushImage(engineId, imageId, callback, authInfo?): Promise\\",source:"@site/api/namespaces/containerEngine/functions/pushImage.md",sourceDirName:"namespaces/containerEngine/functions",slug:"/namespaces/containerEngine/functions/pushImage",permalink:"/api/namespaces/containerEngine/functions/pushImage",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"pullImage",permalink:"/api/namespaces/containerEngine/functions/pullImage"},next:{title:"removePod",permalink:"/api/namespaces/containerEngine/functions/removePod"}},o={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Defined in",id:"defined-in",level:2}];function h(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,t.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"function-pushimage",children:"Function: pushImage()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"pushImage"}),"(",(0,s.jsx)(n.code,{children:"engineId"}),", ",(0,s.jsx)(n.code,{children:"imageId"}),", ",(0,s.jsx)(n.code,{children:"callback"}),", ",(0,s.jsx)(n.code,{children:"authInfo"}),"?): ",(0,s.jsx)(n.code,{children:"Promise"}),"<",(0,s.jsx)(n.code,{children:"void"}),">"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Push an image to a registry."}),"\n",(0,s.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,s.jsx)(n.code,{children:"registry.example.com/myimage:latest"}),"."]}),"\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:"callback"})]}),"\n",(0,s.jsxs)(n.p,{children:["the function called when new logs are emitted or new events happen on the stream. The value of ",(0,s.jsx)(n.code,{children:"name"})," can be either ",(0,s.jsx)(n.code,{children:"data"}),"(and ",(0,s.jsx)(n.code,{children:"data"})," contains the logs), or ",(0,s.jsx)(n.code,{children:"end"})," indicating the end of the stream, or ",(0,s.jsx)(n.code,{children:"first-message"})," indicating no data has been emitted yet on the stream."]}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"authInfo?"}),": ",(0,s.jsx)(n.a,{href:"/api/interfaces/ContainerAuthInfo",children:(0,s.jsx)(n.code,{children:"ContainerAuthInfo"})})]}),"\n",(0,s.jsx)(n.p,{children:"Authentication credentials"}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L3590",children:"packages/extension-api/src/extension-api.d.ts:3590"})})]})}function l(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(h,{...e})}):h(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>c,a:()=>r});var s=i(27378);const t={},a=s.createContext(t);function r(e){const n=s.useContext(a);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:r(e.components),s.createElement(a.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[61305],{34683:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>o,contentTitle:()=>r,default:()=>l,frontMatter:()=>a,metadata:()=>c,toc:()=>d});var s=i(24246),t=i(71670);const a={},r="Function: pushImage()",c={id:"namespaces/containerEngine/functions/pushImage",title:"Function: pushImage()",description:"pushImage(engineId, imageId, callback, authInfo?): Promise\\",source:"@site/api/namespaces/containerEngine/functions/pushImage.md",sourceDirName:"namespaces/containerEngine/functions",slug:"/namespaces/containerEngine/functions/pushImage",permalink:"/api/namespaces/containerEngine/functions/pushImage",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"pullImage",permalink:"/api/namespaces/containerEngine/functions/pullImage"},next:{title:"removePod",permalink:"/api/namespaces/containerEngine/functions/removePod"}},o={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Defined in",id:"defined-in",level:2}];function h(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,t.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"function-pushimage",children:"Function: pushImage()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"pushImage"}),"(",(0,s.jsx)(n.code,{children:"engineId"}),", ",(0,s.jsx)(n.code,{children:"imageId"}),", ",(0,s.jsx)(n.code,{children:"callback"}),", ",(0,s.jsx)(n.code,{children:"authInfo"}),"?): ",(0,s.jsx)(n.code,{children:"Promise"}),"<",(0,s.jsx)(n.code,{children:"void"}),">"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Push an image to a registry."}),"\n",(0,s.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,s.jsx)(n.code,{children:"registry.example.com/myimage:latest"}),"."]}),"\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:"callback"})]}),"\n",(0,s.jsxs)(n.p,{children:["the function called when new logs are emitted or new events happen on the stream. The value of ",(0,s.jsx)(n.code,{children:"name"})," can be either ",(0,s.jsx)(n.code,{children:"data"}),"(and ",(0,s.jsx)(n.code,{children:"data"})," contains the logs), or ",(0,s.jsx)(n.code,{children:"end"})," indicating the end of the stream, or ",(0,s.jsx)(n.code,{children:"first-message"})," indicating no data has been emitted yet on the stream."]}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"authInfo?"}),": ",(0,s.jsx)(n.a,{href:"/api/interfaces/ContainerAuthInfo",children:(0,s.jsx)(n.code,{children:"ContainerAuthInfo"})})]}),"\n",(0,s.jsx)(n.p,{children:"Authentication credentials"}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L3590",children:"packages/extension-api/src/extension-api.d.ts:3590"})})]})}function l(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(h,{...e})}):h(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>c,a:()=>r});var s=i(27378);const t={},a=s.createContext(t);function r(e){const n=s.useContext(a);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:r(e.components),s.createElement(a.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/74b658de.c75a1fe2.js b/assets/js/74b658de.d82000ee.js similarity index 95% rename from assets/js/74b658de.c75a1fe2.js rename to assets/js/74b658de.d82000ee.js index 39ad52e6b53..9a576a531da 100644 --- a/assets/js/74b658de.c75a1fe2.js +++ b/assets/js/74b658de.d82000ee.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[62283],{96350:(e,n,o)=>{o.r(n),o.d(n,{assets:()=>d,contentTitle:()=>r,default:()=>p,frontMatter:()=>t,metadata:()=>c,toc:()=>a});var i=o(24246),s=o(71670);const t={},r="Function: removePod()",c={id:"namespaces/containerEngine/functions/removePod",title:"Function: removePod()",description:"removePod(engineId, podId): Promise\\",source:"@site/api/namespaces/containerEngine/functions/removePod.md",sourceDirName:"namespaces/containerEngine/functions",slug:"/namespaces/containerEngine/functions/removePod",permalink:"/api/namespaces/containerEngine/functions/removePod",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"pushImage",permalink:"/api/namespaces/containerEngine/functions/pushImage"},next:{title:"replicatePodmanContainer",permalink:"/api/namespaces/containerEngine/functions/replicatePodmanContainer"}},d={},a=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Defined in",id:"defined-in",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"function-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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L3668",children:"packages/extension-api/src/extension-api.d.ts:3668"})})]})}function p(e={}){const{wrapper:n}={...(0,s.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},71670:(e,n,o)=>{o.d(n,{Z:()=>c,a:()=>r});var i=o(27378);const s={},t=i.createContext(s);function r(e){const n=i.useContext(t);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:r(e.components),i.createElement(t.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[62283],{96350:(e,n,o)=>{o.r(n),o.d(n,{assets:()=>d,contentTitle:()=>r,default:()=>p,frontMatter:()=>t,metadata:()=>c,toc:()=>a});var i=o(24246),s=o(71670);const t={},r="Function: removePod()",c={id:"namespaces/containerEngine/functions/removePod",title:"Function: removePod()",description:"removePod(engineId, podId): Promise\\",source:"@site/api/namespaces/containerEngine/functions/removePod.md",sourceDirName:"namespaces/containerEngine/functions",slug:"/namespaces/containerEngine/functions/removePod",permalink:"/api/namespaces/containerEngine/functions/removePod",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"pushImage",permalink:"/api/namespaces/containerEngine/functions/pushImage"},next:{title:"replicatePodmanContainer",permalink:"/api/namespaces/containerEngine/functions/replicatePodmanContainer"}},d={},a=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Defined in",id:"defined-in",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"function-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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L3668",children:"packages/extension-api/src/extension-api.d.ts:3668"})})]})}function p(e={}){const{wrapper:n}={...(0,s.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},71670:(e,n,o)=>{o.d(n,{Z:()=>c,a:()=>r});var i=o(27378);const s={},t=i.createContext(s);function r(e){const n=i.useContext(t);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:r(e.components),i.createElement(t.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/7500e360.96c70e1f.js b/assets/js/7500e360.31ab4c14.js similarity index 84% rename from assets/js/7500e360.96c70e1f.js rename to assets/js/7500e360.31ab4c14.js index b595d9a89b2..079f8051251 100644 --- a/assets/js/7500e360.96c70e1f.js +++ b/assets/js/7500e360.31ab4c14.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[86272],{7809:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>c,contentTitle:()=>a,default:()=>h,frontMatter:()=>t,metadata:()=>r,toc:()=>d});var i=s(24246),o=s(71670);const t={},a="Function: showSaveDialog()",r={id:"namespaces/window/functions/showSaveDialog",title:"Function: showSaveDialog()",description:"showSaveDialog(options?): Promise\\",source:"@site/api/namespaces/window/functions/showSaveDialog.md",sourceDirName:"namespaces/window/functions",slug:"/namespaces/window/functions/showSaveDialog",permalink:"/api/namespaces/window/functions/showSaveDialog",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"showQuickPick",permalink:"/api/namespaces/window/functions/showQuickPick"},next:{title:"showWarningMessage",permalink:"/api/namespaces/window/functions/showWarningMessage"}},c={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Defined in",id:"defined-in",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,o.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L2002",children:"packages/extension-api/src/extension-api.d.ts:2002"})})]})}function h(e={}){const{wrapper:n}={...(0,o.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>r,a:()=>a});var i=s(27378);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([[86272],{7809:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>r,contentTitle:()=>a,default:()=>h,frontMatter:()=>t,metadata:()=>c,toc:()=>d});var i=s(24246),o=s(71670);const t={},a="Function: showSaveDialog()",c={id:"namespaces/window/functions/showSaveDialog",title:"Function: showSaveDialog()",description:"showSaveDialog(options?): Promise\\",source:"@site/api/namespaces/window/functions/showSaveDialog.md",sourceDirName:"namespaces/window/functions",slug:"/namespaces/window/functions/showSaveDialog",permalink:"/api/namespaces/window/functions/showSaveDialog",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"showQuickPick",permalink:"/api/namespaces/window/functions/showQuickPick"},next:{title:"showWarningMessage",permalink:"/api/namespaces/window/functions/showWarningMessage"}},r={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Defined in",id:"defined-in",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,o.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2002",children:"packages/extension-api/src/extension-api.d.ts:2002"})})]})}function h(e={}){const{wrapper:n}={...(0,o.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>c,a:()=>a});var i=s(27378);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 c(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.62d570f1.js b/assets/js/7547d3bb.2602af44.js similarity index 97% rename from assets/js/7547d3bb.62d570f1.js rename to assets/js/7547d3bb.2602af44.js index 81d10b56830..6045b708f10 100644 --- a/assets/js/7547d3bb.62d570f1.js +++ b/assets/js/7547d3bb.2602af44.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[45835],{99145:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>a,contentTitle:()=>s,default:()=>p,frontMatter:()=>o,metadata:()=>c,toc:()=>d});var t=r(24246),i=r(71670);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",p:"p",strong:"strong",...(0,i.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"interface-providercleanup",children:"Interface: ProviderCleanup"}),"\n",(0,t.jsx)(n.p,{children:"Allow to clean some resources in case for example"}),"\n",(0,t.jsx)(n.h2,{id:"methods",children:"Methods"}),"\n",(0,t.jsx)(n.h3,{id:"getactions",children:"getActions()"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"getActions"}),"(): ",(0,t.jsx)(n.code,{children:"Promise"}),"<",(0,t.jsx)(n.a,{href:"/api/interfaces/ProviderCleanupAction",children:(0,t.jsx)(n.code,{children:"ProviderCleanupAction"})}),"[]>"]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"returns",children:"Returns"}),"\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"Promise"}),"<",(0,t.jsx)(n.a,{href:"/api/interfaces/ProviderCleanupAction",children:(0,t.jsx)(n.code,{children:"ProviderCleanupAction"})}),"[]>"]}),"\n",(0,t.jsx)(n.h4,{id:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L564",children:"packages/extension-api/src/extension-api.d.ts:564"})})]})}function p(e={}){const{wrapper:n}={...(0,i.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},71670:(e,n,r)=>{r.d(n,{Z:()=>c,a:()=>s});var t=r(27378);const i={},o=t.createContext(i);function s(e){const n=t.useContext(o);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:s(e.components),t.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[45835],{99145:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>a,contentTitle:()=>s,default:()=>p,frontMatter:()=>o,metadata:()=>c,toc:()=>d});var t=r(24246),i=r(71670);const o={},s="Interface: 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",p:"p",strong:"strong",...(0,i.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"interface-providercleanup",children:"Interface: ProviderCleanup"}),"\n",(0,t.jsx)(n.p,{children:"Allow to clean some resources in case for example"}),"\n",(0,t.jsx)(n.h2,{id:"methods",children:"Methods"}),"\n",(0,t.jsx)(n.h3,{id:"getactions",children:"getActions()"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"getActions"}),"(): ",(0,t.jsx)(n.code,{children:"Promise"}),"<",(0,t.jsx)(n.a,{href:"/api/interfaces/ProviderCleanupAction",children:(0,t.jsx)(n.code,{children:"ProviderCleanupAction"})}),"[]>"]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"returns",children:"Returns"}),"\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"Promise"}),"<",(0,t.jsx)(n.a,{href:"/api/interfaces/ProviderCleanupAction",children:(0,t.jsx)(n.code,{children:"ProviderCleanupAction"})}),"[]>"]}),"\n",(0,t.jsx)(n.h4,{id:"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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L564",children:"packages/extension-api/src/extension-api.d.ts:564"})})]})}function p(e={}){const{wrapper:n}={...(0,i.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},71670:(e,n,r)=>{r.d(n,{Z:()=>c,a:()=>s});var t=r(27378);const i={},o=t.createContext(i);function s(e){const n=t.useContext(o);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:s(e.components),t.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/786fee93.77c73ffe.js b/assets/js/786fee93.608ba676.js similarity index 61% rename from assets/js/786fee93.77c73ffe.js rename to assets/js/786fee93.608ba676.js index 71c0e48737e..d38746a50c1 100644 --- a/assets/js/786fee93.77c73ffe.js +++ b/assets/js/786fee93.608ba676.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[7371],{26440:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>c,contentTitle:()=>r,default:()=>u,frontMatter:()=>a,metadata:()=>o,toc:()=>l});var s=i(24246),t=i(71670);const a={},r="Variable: isLinux",o={id:"namespaces/env/variables/isLinux",title:"Variable: isLinux",description:"const isLinux: boolean",source:"@site/api/namespaces/env/variables/isLinux.md",sourceDirName:"namespaces/env/variables",slug:"/namespaces/env/variables/isLinux",permalink:"/api/namespaces/env/variables/isLinux",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"clipboard",permalink:"/api/namespaces/env/variables/clipboard"},next:{title:"isMac",permalink:"/api/namespaces/env/variables/isMac"}},c={},l=[{value:"Defined in",id:"defined-in",level:2}];function d(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,t.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L3969",children:"packages/extension-api/src/extension-api.d.ts:3969"})})]})}function u(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(d,{...e})}):d(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>o,a:()=>r});var s=i(27378);const t={},a=s.createContext(t);function r(e){const n=s.useContext(a);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function 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([[7371],{26440:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>o,contentTitle:()=>r,default:()=>u,frontMatter:()=>t,metadata:()=>c,toc:()=>l});var s=i(24246),a=i(71670);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",p:"p",strong:"strong",...(0,a.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L3969",children:"packages/extension-api/src/extension-api.d.ts:3969"})})]})}function u(e={}){const{wrapper:n}={...(0,a.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(d,{...e})}):d(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>c,a:()=>r});var s=i(27378);const 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.a25cf773.js b/assets/js/79f18c88.2abcf36a.js similarity index 90% rename from assets/js/79f18c88.a25cf773.js rename to assets/js/79f18c88.2abcf36a.js index 828baa4816c..1740ba59e51 100644 --- a/assets/js/79f18c88.a25cf773.js +++ b/assets/js/79f18c88.2abcf36a.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[36006],{66472:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>o,contentTitle:()=>a,default:()=>h,frontMatter:()=>r,metadata:()=>d,toc:()=>c});var s=i(24246),t=i(71670);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",hr:"hr",p:"p",strong:"strong",...(0,t.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"interface-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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L2658",children:"packages/extension-api/src/extension-api.d.ts:2658"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L2656",children:"packages/extension-api/src/extension-api.d.ts:2656"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L2657",children:"packages/extension-api/src/extension-api.d.ts:2657"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L2655",children:"packages/extension-api/src/extension-api.d.ts:2655"})})]})}function h(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>d,a:()=>a});var s=i(27378);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([[36006],{66472:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>o,contentTitle:()=>a,default:()=>h,frontMatter:()=>r,metadata:()=>d,toc:()=>c});var s=i(24246),t=i(71670);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",hr:"hr",p:"p",strong:"strong",...(0,t.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"interface-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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2658",children:"packages/extension-api/src/extension-api.d.ts:2658"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2656",children:"packages/extension-api/src/extension-api.d.ts:2656"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2657",children:"packages/extension-api/src/extension-api.d.ts:2657"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2655",children:"packages/extension-api/src/extension-api.d.ts:2655"})})]})}function h(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>d,a:()=>a});var s=i(27378);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.b5304b58.js b/assets/js/7aa856d6.fc30d2f7.js similarity index 93% rename from assets/js/7aa856d6.b5304b58.js rename to assets/js/7aa856d6.fc30d2f7.js index 8344bfe2b8b..15cc8cdf760 100644 --- a/assets/js/7aa856d6.b5304b58.js +++ b/assets/js/7aa856d6.fc30d2f7.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[886],{56886:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>c,contentTitle:()=>o,default:()=>p,frontMatter:()=>r,metadata:()=>a,toc:()=>d});var s=t(24246),i=t(71670);const r={},o="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",p:"p",strong:"strong",...(0,i.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"variable-version",children:"Variable: version"}),"\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:"version"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The version of Podman Desktop."}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/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,i.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>a,a:()=>o});var s=t(27378);const i={},r=s.createContext(i);function o(e){const n=s.useContext(r);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function a(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:o(e.components),s.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[886],{56886:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>c,contentTitle:()=>o,default:()=>p,frontMatter:()=>r,metadata:()=>a,toc:()=>d});var s=t(24246),i=t(71670);const r={},o="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",p:"p",strong:"strong",...(0,i.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"variable-version",children:"Variable: version"}),"\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:"version"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The version of Podman Desktop."}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/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,i.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>a,a:()=>o});var s=t(27378);const i={},r=s.createContext(i);function o(e){const n=s.useContext(r);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function a(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:o(e.components),s.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/7bef3f04.afafc97c.js b/assets/js/7bef3f04.04f5625b.js similarity index 96% rename from assets/js/7bef3f04.afafc97c.js rename to assets/js/7bef3f04.04f5625b.js index 62975a055e5..f0559f5d757 100644 --- a/assets/js/7bef3f04.afafc97c.js +++ b/assets/js/7bef3f04.04f5625b.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[24498],{7346:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>a,contentTitle:()=>o,default:()=>p,frontMatter:()=>r,metadata:()=>c,toc:()=>d});var s=i(24246),t=i(71670);const r={},o="Function: onDidRegisterContainerConnection()",c={id:"namespaces/provider/functions/onDidRegisterContainerConnection",title:"Function: onDidRegisterContainerConnection()",description:"onDidRegisterContainerConnection(listener, thisArgs?, disposables?): Disposable",source:"@site/api/namespaces/provider/functions/onDidRegisterContainerConnection.md",sourceDirName:"namespaces/provider/functions",slug:"/namespaces/provider/functions/onDidRegisterContainerConnection",permalink:"/api/namespaces/provider/functions/onDidRegisterContainerConnection",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"getProviderLifecycleContext",permalink:"/api/namespaces/provider/functions/getProviderLifecycleContext"},next:{title:"onDidUnregisterContainerConnection",permalink:"/api/namespaces/provider/functions/onDidUnregisterContainerConnection"}},a={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Defined in",id:"defined-in",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,t.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"function-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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L815",children:"packages/extension-api/src/extension-api.d.ts:815"})})]})}function p(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>c,a:()=>o});var s=i(27378);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([[24498],{7346:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>a,contentTitle:()=>o,default:()=>p,frontMatter:()=>r,metadata:()=>c,toc:()=>d});var s=i(24246),t=i(71670);const r={},o="Function: onDidRegisterContainerConnection()",c={id:"namespaces/provider/functions/onDidRegisterContainerConnection",title:"Function: onDidRegisterContainerConnection()",description:"onDidRegisterContainerConnection(listener, thisArgs?, disposables?): Disposable",source:"@site/api/namespaces/provider/functions/onDidRegisterContainerConnection.md",sourceDirName:"namespaces/provider/functions",slug:"/namespaces/provider/functions/onDidRegisterContainerConnection",permalink:"/api/namespaces/provider/functions/onDidRegisterContainerConnection",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"getProviderLifecycleContext",permalink:"/api/namespaces/provider/functions/getProviderLifecycleContext"},next:{title:"onDidUnregisterContainerConnection",permalink:"/api/namespaces/provider/functions/onDidUnregisterContainerConnection"}},a={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Defined in",id:"defined-in",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,t.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"function-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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L815",children:"packages/extension-api/src/extension-api.d.ts:815"})})]})}function p(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>c,a:()=>o});var s=i(27378);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.a1c452c8.js b/assets/js/7c7a772e.3fee7f43.js similarity index 92% rename from assets/js/7c7a772e.a1c452c8.js rename to assets/js/7c7a772e.3fee7f43.js index dba0844100c..bbf0012dd90 100644 --- a/assets/js/7c7a772e.a1c452c8.js +++ b/assets/js/7c7a772e.3fee7f43.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[77060],{44215:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>r,contentTitle:()=>c,default:()=>h,frontMatter:()=>t,metadata:()=>a,toc:()=>l});var s=i(24246),d=i(71670);const t={},c="Interface: WebviewPanel",a={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",hr:"hr",p:"p",strong:"strong",...(0,d.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{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/804b2198fda0957e1ecfb87539f019eb9b79a66f/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:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L1732",children:"packages/extension-api/src/extension-api.d.ts:1732"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L1763",children:"packages/extension-api/src/extension-api.d.ts:1763"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L1773",children:"packages/extension-api/src/extension-api.d.ts:1773"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/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:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L1722",children:"packages/extension-api/src/extension-api.d.ts:1722"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L1758",children:"packages/extension-api/src/extension-api.d.ts:1758"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L1748",children:"packages/extension-api/src/extension-api.d.ts:1748"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L1788",children:"packages/extension-api/src/extension-api.d.ts:1788"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L1779",children:"packages/extension-api/src/extension-api.d.ts:1779"})})]})}function h(e={}){const{wrapper:n}={...(0,d.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(o,{...e})}):o(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>a,a:()=>c});var s=i(27378);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 a(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([[77060],{44215:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>r,contentTitle:()=>c,default:()=>h,frontMatter:()=>t,metadata:()=>a,toc:()=>l});var s=i(24246),d=i(71670);const t={},c="Interface: WebviewPanel",a={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",hr:"hr",p:"p",strong:"strong",...(0,d.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{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/bd83a8b2bb8ab886dc757381b589638cbda150d0/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:"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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L1732",children:"packages/extension-api/src/extension-api.d.ts:1732"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L1763",children:"packages/extension-api/src/extension-api.d.ts:1763"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L1773",children:"packages/extension-api/src/extension-api.d.ts:1773"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/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:"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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L1722",children:"packages/extension-api/src/extension-api.d.ts:1722"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L1758",children:"packages/extension-api/src/extension-api.d.ts:1758"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L1748",children:"packages/extension-api/src/extension-api.d.ts:1748"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L1788",children:"packages/extension-api/src/extension-api.d.ts:1788"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L1779",children:"packages/extension-api/src/extension-api.d.ts:1779"})})]})}function h(e={}){const{wrapper:n}={...(0,d.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(o,{...e})}):o(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>a,a:()=>c});var s=i(27378);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 a(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/7cde3c49.cf847a2f.js b/assets/js/7cde3c49.49415742.js similarity index 97% rename from assets/js/7cde3c49.cf847a2f.js rename to assets/js/7cde3c49.49415742.js index 1257b4cb56f..4e952c67c1d 100644 --- a/assets/js/7cde3c49.cf847a2f.js +++ b/assets/js/7cde3c49.49415742.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[37836],{30393:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>s,default:()=>p,frontMatter:()=>r,metadata:()=>c,toc:()=>l});var o=t(24246),i=t(71670);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",p:"p",strong:"strong",...(0,i.a)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(n.h1,{id:"interface-volumedeleteoptions",children:"Interface: VolumeDeleteOptions"}),"\n",(0,o.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,o.jsx)(n.h3,{id:"provider",children:"provider?"}),"\n",(0,o.jsxs)(n.blockquote,{children:["\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.code,{children:"optional"})," ",(0,o.jsx)(n.strong,{children:"provider"}),": ",(0,o.jsx)(n.a,{href:"/api/interfaces/ContainerProviderConnection",children:(0,o.jsx)(n.code,{children:"ContainerProviderConnection"})})]}),"\n"]}),"\n",(0,o.jsx)(n.h4,{id:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L3412",children:"packages/extension-api/src/extension-api.d.ts:3412"})})]})}function p(e={}){const{wrapper:n}={...(0,i.a)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(d,{...e})}):d(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>c,a:()=>s});var o=t(27378);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([[37836],{30393:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>s,default:()=>p,frontMatter:()=>r,metadata:()=>c,toc:()=>l});var o=t(24246),i=t(71670);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",p:"p",strong:"strong",...(0,i.a)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(n.h1,{id:"interface-volumedeleteoptions",children:"Interface: VolumeDeleteOptions"}),"\n",(0,o.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,o.jsx)(n.h3,{id:"provider",children:"provider?"}),"\n",(0,o.jsxs)(n.blockquote,{children:["\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.code,{children:"optional"})," ",(0,o.jsx)(n.strong,{children:"provider"}),": ",(0,o.jsx)(n.a,{href:"/api/interfaces/ContainerProviderConnection",children:(0,o.jsx)(n.code,{children:"ContainerProviderConnection"})})]}),"\n"]}),"\n",(0,o.jsx)(n.h4,{id:"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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L3412",children:"packages/extension-api/src/extension-api.d.ts:3412"})})]})}function p(e={}){const{wrapper:n}={...(0,i.a)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(d,{...e})}):d(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>c,a:()=>s});var o=t(27378);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.fa815603.js b/assets/js/7d9edfb8.968a3be8.js similarity index 96% rename from assets/js/7d9edfb8.fa815603.js rename to assets/js/7d9edfb8.968a3be8.js index 4f46e94c0be..5df343e5012 100644 --- a/assets/js/7d9edfb8.fa815603.js +++ b/assets/js/7d9edfb8.968a3be8.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[90125],{38654:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>c,contentTitle:()=>o,default:()=>p,frontMatter:()=>a,metadata:()=>r,toc:()=>l});var i=s(24246),t=s(71670);const a={},o="Function: listImages()",r={id:"namespaces/containerEngine/functions/listImages",title:"Function: listImages()",description:"listImages(options?): Promise\\",source:"@site/api/namespaces/containerEngine/functions/listImages.md",sourceDirName:"namespaces/containerEngine/functions",slug:"/namespaces/containerEngine/functions/listImages",permalink:"/api/namespaces/containerEngine/functions/listImages",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"listContainers",permalink:"/api/namespaces/containerEngine/functions/listContainers"},next:{title:"listInfos",permalink:"/api/namespaces/containerEngine/functions/listInfos"}},c={},l=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Examples",id:"examples",level:2},{value:"Defined in",id:"defined-in",level:2}];function d(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",pre:"pre",strong:"strong",...(0,t.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"function-listimages",children:"Function: listImages()"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"listImages"}),"(",(0,i.jsx)(n.code,{children:"options"}),"?): ",(0,i.jsx)(n.code,{children:"Promise"}),"<",(0,i.jsx)(n.a,{href:"/api/interfaces/ImageInfo",children:(0,i.jsx)(n.code,{children:"ImageInfo"})}),"[]>"]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"List the container images. Only images from a final layer (no children) are returned."}),"\n",(0,i.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"options?"}),": ",(0,i.jsx)(n.a,{href:"/api/interfaces/ListImagesOptions",children:(0,i.jsx)(n.code,{children:"ListImagesOptions"})})]}),"\n",(0,i.jsx)(n.p,{children:"optional options for listing images"}),"\n",(0,i.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"Promise"}),"<",(0,i.jsx)(n.a,{href:"/api/interfaces/ImageInfo",children:(0,i.jsx)(n.code,{children:"ImageInfo"})}),"[]>"]}),"\n",(0,i.jsxs)(n.p,{children:["A promise resolving to an array of images information. This method returns a subset of the available information for images. To get the complete description of a specific image, you can use the ",(0,i.jsx)(n.a,{href:"/api/namespaces/containerEngine/functions/getImageInspect",children:"containerEngine.getImageInspect"})," method."]}),"\n",(0,i.jsx)(n.h2,{id:"examples",children:"Examples"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-ts",children:"// Example 1: List all container images when no specific provider is provided.\nconst images = await listImages();\nconsole.log(images);\n"})}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-ts",children:"// Example 2: List container images for a specific provider.\nconst provider = provider.getContainerConnections().find(connection => connection.connection.status() === 'started');\nconst images = await listImages({ provider: provider.connection });\nconsole.log(images);\n"})}),"\n",(0,i.jsx)(n.h2,{id:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L3568",children:"packages/extension-api/src/extension-api.d.ts:3568"})})]})}function p(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(d,{...e})}):d(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>r,a:()=>o});var i=s(27378);const t={},a=i.createContext(t);function o(e){const n=i.useContext(a);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function r(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:o(e.components),i.createElement(a.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[90125],{38654:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>c,contentTitle:()=>o,default:()=>p,frontMatter:()=>a,metadata:()=>r,toc:()=>l});var i=s(24246),t=s(71670);const a={},o="Function: listImages()",r={id:"namespaces/containerEngine/functions/listImages",title:"Function: listImages()",description:"listImages(options?): Promise\\",source:"@site/api/namespaces/containerEngine/functions/listImages.md",sourceDirName:"namespaces/containerEngine/functions",slug:"/namespaces/containerEngine/functions/listImages",permalink:"/api/namespaces/containerEngine/functions/listImages",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"listContainers",permalink:"/api/namespaces/containerEngine/functions/listContainers"},next:{title:"listInfos",permalink:"/api/namespaces/containerEngine/functions/listInfos"}},c={},l=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Examples",id:"examples",level:2},{value:"Defined in",id:"defined-in",level:2}];function d(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",pre:"pre",strong:"strong",...(0,t.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"function-listimages",children:"Function: listImages()"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"listImages"}),"(",(0,i.jsx)(n.code,{children:"options"}),"?): ",(0,i.jsx)(n.code,{children:"Promise"}),"<",(0,i.jsx)(n.a,{href:"/api/interfaces/ImageInfo",children:(0,i.jsx)(n.code,{children:"ImageInfo"})}),"[]>"]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"List the container images. Only images from a final layer (no children) are returned."}),"\n",(0,i.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"options?"}),": ",(0,i.jsx)(n.a,{href:"/api/interfaces/ListImagesOptions",children:(0,i.jsx)(n.code,{children:"ListImagesOptions"})})]}),"\n",(0,i.jsx)(n.p,{children:"optional options for listing images"}),"\n",(0,i.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"Promise"}),"<",(0,i.jsx)(n.a,{href:"/api/interfaces/ImageInfo",children:(0,i.jsx)(n.code,{children:"ImageInfo"})}),"[]>"]}),"\n",(0,i.jsxs)(n.p,{children:["A promise resolving to an array of images information. This method returns a subset of the available information for images. To get the complete description of a specific image, you can use the ",(0,i.jsx)(n.a,{href:"/api/namespaces/containerEngine/functions/getImageInspect",children:"containerEngine.getImageInspect"})," method."]}),"\n",(0,i.jsx)(n.h2,{id:"examples",children:"Examples"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-ts",children:"// Example 1: List all container images when no specific provider is provided.\nconst images = await listImages();\nconsole.log(images);\n"})}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-ts",children:"// Example 2: List container images for a specific provider.\nconst provider = provider.getContainerConnections().find(connection => connection.connection.status() === 'started');\nconst images = await listImages({ provider: provider.connection });\nconsole.log(images);\n"})}),"\n",(0,i.jsx)(n.h2,{id:"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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L3568",children:"packages/extension-api/src/extension-api.d.ts:3568"})})]})}function p(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(d,{...e})}):d(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>r,a:()=>o});var i=s(27378);const t={},a=i.createContext(t);function o(e){const n=i.useContext(a);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function r(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:o(e.components),i.createElement(a.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/7e2ae3df.c3658761.js b/assets/js/7e2ae3df.a2b9f3f3.js similarity index 98% rename from assets/js/7e2ae3df.c3658761.js rename to assets/js/7e2ae3df.a2b9f3f3.js index 28c707a9542..425bd1a3fc3 100644 --- a/assets/js/7e2ae3df.c3658761.js +++ b/assets/js/7e2ae3df.a2b9f3f3.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[28143],{38230:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>c,contentTitle:()=>o,default:()=>l,frontMatter:()=>s,metadata:()=>a,toc:()=>d});var r=i(24246),t=i(71670);const s={},o="Function: registerAuthenticationProvider()",a={id:"namespaces/authentication/functions/registerAuthenticationProvider",title:"Function: registerAuthenticationProvider()",description:"registerAuthenticationProvider(id, label, provider, options?): Disposable",source:"@site/api/namespaces/authentication/functions/registerAuthenticationProvider.md",sourceDirName:"namespaces/authentication/functions",slug:"/namespaces/authentication/functions/registerAuthenticationProvider",permalink:"/api/namespaces/authentication/functions/registerAuthenticationProvider",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"onDidChangeSessions",permalink:"/api/namespaces/authentication/functions/onDidChangeSessions"},next:{title:"cli",permalink:"/api/namespaces/cli/"}},c={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Params",id:"params",level:2},{value:"Defined in",id:"defined-in",level:2}];function h(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,t.a)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.h1,{id:"function-registerauthenticationprovider",children:"Function: registerAuthenticationProvider()"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"registerAuthenticationProvider"}),"(",(0,r.jsx)(n.code,{children:"id"}),", ",(0,r.jsx)(n.code,{children:"label"}),", ",(0,r.jsx)(n.code,{children:"provider"}),", ",(0,r.jsx)(n.code,{children:"options"}),"?): ",(0,r.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,r.jsx)(n.code,{children:"Disposable"})})]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"Register an authentication provider."}),"\n",(0,r.jsx)(n.p,{children:"There can only be one provider per id and an error is being thrown when an id\nhas already been used by another provider. Ids are case-sensitive."}),"\n",(0,r.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"id"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n",(0,r.jsx)(n.p,{children:"The unique identifier of the provider."}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"label"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n",(0,r.jsx)(n.p,{children:"The human-readable name of the provider."}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"provider"}),": ",(0,r.jsx)(n.a,{href:"/api/interfaces/AuthenticationProvider",children:(0,r.jsx)(n.code,{children:"AuthenticationProvider"})})]}),"\n",(0,r.jsx)(n.p,{children:"The authentication provider provider."}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"options?"}),": ",(0,r.jsx)(n.a,{href:"/api/interfaces/AuthenticationProviderOptions",children:(0,r.jsx)(n.code,{children:"AuthenticationProviderOptions"})})]}),"\n",(0,r.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,r.jsx)(n.code,{children:"Disposable"})})}),"\n",(0,r.jsxs)(n.p,{children:["A ",(0,r.jsx)(n.a,{href:"#Disposable",children:"disposable"})," that unregisters this provider when being disposed."]}),"\n",(0,r.jsx)(n.h2,{id:"params",children:"Params"}),"\n",(0,r.jsx)(n.p,{children:"options Additional options for the provider."}),"\n",(0,r.jsx)(n.h2,{id:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L3935",children:"packages/extension-api/src/extension-api.d.ts:3935"})})]})}function l(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(h,{...e})}):h(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>a,a:()=>o});var r=i(27378);const t={},s=r.createContext(t);function o(e){const n=r.useContext(s);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function a(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:o(e.components),r.createElement(s.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[28143],{38230:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>c,contentTitle:()=>o,default:()=>l,frontMatter:()=>s,metadata:()=>a,toc:()=>d});var r=i(24246),t=i(71670);const s={},o="Function: registerAuthenticationProvider()",a={id:"namespaces/authentication/functions/registerAuthenticationProvider",title:"Function: registerAuthenticationProvider()",description:"registerAuthenticationProvider(id, label, provider, options?): Disposable",source:"@site/api/namespaces/authentication/functions/registerAuthenticationProvider.md",sourceDirName:"namespaces/authentication/functions",slug:"/namespaces/authentication/functions/registerAuthenticationProvider",permalink:"/api/namespaces/authentication/functions/registerAuthenticationProvider",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"onDidChangeSessions",permalink:"/api/namespaces/authentication/functions/onDidChangeSessions"},next:{title:"cli",permalink:"/api/namespaces/cli/"}},c={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Params",id:"params",level:2},{value:"Defined in",id:"defined-in",level:2}];function h(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,t.a)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.h1,{id:"function-registerauthenticationprovider",children:"Function: registerAuthenticationProvider()"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"registerAuthenticationProvider"}),"(",(0,r.jsx)(n.code,{children:"id"}),", ",(0,r.jsx)(n.code,{children:"label"}),", ",(0,r.jsx)(n.code,{children:"provider"}),", ",(0,r.jsx)(n.code,{children:"options"}),"?): ",(0,r.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,r.jsx)(n.code,{children:"Disposable"})})]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"Register an authentication provider."}),"\n",(0,r.jsx)(n.p,{children:"There can only be one provider per id and an error is being thrown when an id\nhas already been used by another provider. Ids are case-sensitive."}),"\n",(0,r.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"id"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n",(0,r.jsx)(n.p,{children:"The unique identifier of the provider."}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"label"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n",(0,r.jsx)(n.p,{children:"The human-readable name of the provider."}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"provider"}),": ",(0,r.jsx)(n.a,{href:"/api/interfaces/AuthenticationProvider",children:(0,r.jsx)(n.code,{children:"AuthenticationProvider"})})]}),"\n",(0,r.jsx)(n.p,{children:"The authentication provider provider."}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"options?"}),": ",(0,r.jsx)(n.a,{href:"/api/interfaces/AuthenticationProviderOptions",children:(0,r.jsx)(n.code,{children:"AuthenticationProviderOptions"})})]}),"\n",(0,r.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,r.jsx)(n.code,{children:"Disposable"})})}),"\n",(0,r.jsxs)(n.p,{children:["A ",(0,r.jsx)(n.a,{href:"#Disposable",children:"disposable"})," that unregisters this provider when being disposed."]}),"\n",(0,r.jsx)(n.h2,{id:"params",children:"Params"}),"\n",(0,r.jsx)(n.p,{children:"options Additional options for the provider."}),"\n",(0,r.jsx)(n.h2,{id:"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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L3935",children:"packages/extension-api/src/extension-api.d.ts:3935"})})]})}function l(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(h,{...e})}):h(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>a,a:()=>o});var r=i(27378);const t={},s=r.createContext(t);function o(e){const n=r.useContext(s);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function a(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:o(e.components),r.createElement(s.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/7e5a2776.6986b656.js b/assets/js/7e5a2776.d54c3462.js similarity index 88% rename from assets/js/7e5a2776.6986b656.js rename to assets/js/7e5a2776.d54c3462.js index 269a8f7a686..6da0a8b246e 100644 --- a/assets/js/7e5a2776.6986b656.js +++ b/assets/js/7e5a2776.d54c3462.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[51171],{40733:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>o,contentTitle:()=>t,default:()=>h,frontMatter:()=>r,metadata:()=>c,toc:()=>l});var s=i(24246),d=i(71670);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"}},o={},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 a(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",li:"li",p:"p",strong:"strong",ul:"ul",...(0,d.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L1652",children:"packages/extension-api/src/extension-api.d.ts:1652"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L1651",children:"packages/extension-api/src/extension-api.d.ts:1651"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L1653",children:"packages/extension-api/src/extension-api.d.ts:1653"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/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.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(a,{...e})}):a(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>c,a:()=>t});var s=i(27378);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([[51171],{40733:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>a,contentTitle:()=>t,default:()=>h,frontMatter:()=>r,metadata:()=>c,toc:()=>o});var s=i(24246),d=i(71670);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={},o=[{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 l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",li:"li",p:"p",strong:"strong",ul:"ul",...(0,d.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L1652",children:"packages/extension-api/src/extension-api.d.ts:1652"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L1651",children:"packages/extension-api/src/extension-api.d.ts:1651"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L1653",children:"packages/extension-api/src/extension-api.d.ts:1653"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/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.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>c,a:()=>t});var s=i(27378);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.18372773.js b/assets/js/7f0476bd.b5fbc363.js similarity index 87% rename from assets/js/7f0476bd.18372773.js rename to assets/js/7f0476bd.b5fbc363.js index 2649b2cda2a..777398d8d4a 100644 --- a/assets/js/7f0476bd.18372773.js +++ b/assets/js/7f0476bd.b5fbc363.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[45346],{7095:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>o,contentTitle:()=>d,default:()=>h,frontMatter:()=>t,metadata:()=>c,toc:()=>a});var s=i(24246),r=i(71670);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"}},o={},a=[{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",hr:"hr",p:"p",strong:"strong",...(0,r.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"interface-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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L1712",children:"packages/extension-api/src/extension-api.d.ts:1712"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L1689",children:"packages/extension-api/src/extension-api.d.ts:1689"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L1696",children:"packages/extension-api/src/extension-api.d.ts:1696"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L1681",children:"packages/extension-api/src/extension-api.d.ts:1681"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L1706",children:"packages/extension-api/src/extension-api.d.ts:1706"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L1701",children:"packages/extension-api/src/extension-api.d.ts:1701"})})]})}function h(e={}){const{wrapper:n}={...(0,r.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>c,a:()=>d});var s=i(27378);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([[45346],{7095:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>o,contentTitle:()=>t,default:()=>h,frontMatter:()=>d,metadata:()=>c,toc:()=>a});var s=i(24246),r=i(71670);const d={},t="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"}},o={},a=[{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",hr:"hr",p:"p",strong:"strong",...(0,r.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"interface-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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L1712",children:"packages/extension-api/src/extension-api.d.ts:1712"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L1689",children:"packages/extension-api/src/extension-api.d.ts:1689"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L1696",children:"packages/extension-api/src/extension-api.d.ts:1696"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L1681",children:"packages/extension-api/src/extension-api.d.ts:1681"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L1706",children:"packages/extension-api/src/extension-api.d.ts:1706"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L1701",children:"packages/extension-api/src/extension-api.d.ts:1701"})})]})}function h(e={}){const{wrapper:n}={...(0,r.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>c,a:()=>t});var s=i(27378);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/7fa133e1.25267803.js b/assets/js/7fa133e1.9dd84ef6.js similarity index 92% rename from assets/js/7fa133e1.25267803.js rename to assets/js/7fa133e1.9dd84ef6.js index 5c8783859d1..9c90c94d092 100644 --- a/assets/js/7fa133e1.25267803.js +++ b/assets/js/7fa133e1.9dd84ef6.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[31512],{28204:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>o,contentTitle:()=>d,default:()=>h,frontMatter:()=>c,metadata:()=>r,toc:()=>a});var t=i(24246),s=i(71670);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",hr:"hr",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"interface-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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L1354",children:"packages/extension-api/src/extension-api.d.ts:1354"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L1358",children:"packages/extension-api/src/extension-api.d.ts:1358"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L1362",children:"packages/extension-api/src/extension-api.d.ts:1362"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L1366",children:"packages/extension-api/src/extension-api.d.ts:1366"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/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.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>r,a:()=>d});var t=i(27378);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([[31512],{28204:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>o,contentTitle:()=>d,default:()=>h,frontMatter:()=>c,metadata:()=>r,toc:()=>a});var t=i(24246),s=i(71670);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",hr:"hr",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"interface-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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L1354",children:"packages/extension-api/src/extension-api.d.ts:1354"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L1358",children:"packages/extension-api/src/extension-api.d.ts:1358"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L1362",children:"packages/extension-api/src/extension-api.d.ts:1362"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L1366",children:"packages/extension-api/src/extension-api.d.ts:1366"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/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.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>r,a:()=>d});var t=i(27378);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.45a0b168.js b/assets/js/814402d7.d94a5e0d.js similarity index 95% rename from assets/js/814402d7.45a0b168.js rename to assets/js/814402d7.d94a5e0d.js index 6c927a379a7..ecab5d689b2 100644 --- a/assets/js/814402d7.45a0b168.js +++ b/assets/js/814402d7.d94a5e0d.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[70985],{87574:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>d,contentTitle:()=>a,default:()=>l,frontMatter:()=>o,metadata:()=>r,toc:()=>c});var t=i(24246),s=i(71670);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",hr:"hr",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"interface-authenticationproviderauthenticationsessionschangeevent",children:"Interface: AuthenticationProviderAuthenticationSessionsChangeEvent"}),"\n",(0,t.jsxs)(n.p,{children:["An ",(0,t.jsx)(n.a,{href:"#Event",children:"event"})," which fires when an ",(0,t.jsx)(n.a,{href:"#AuthenticationSession",children:"AuthenticationSession"})," is added, removed, or changed."]}),"\n",(0,t.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,t.jsx)(n.h3,{id:"added",children:"added?"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L3816",children:"packages/extension-api/src/extension-api.d.ts:3816"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L3828",children:"packages/extension-api/src/extension-api.d.ts:3828"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L3821",children:"packages/extension-api/src/extension-api.d.ts:3821"})})]})}function l(e={}){const{wrapper:n}={...(0,s.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(h,{...e})}):h(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>r,a:()=>a});var t=i(27378);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([[70985],{87574:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>d,contentTitle:()=>a,default:()=>l,frontMatter:()=>o,metadata:()=>r,toc:()=>c});var t=i(24246),s=i(71670);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",hr:"hr",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"interface-authenticationproviderauthenticationsessionschangeevent",children:"Interface: AuthenticationProviderAuthenticationSessionsChangeEvent"}),"\n",(0,t.jsxs)(n.p,{children:["An ",(0,t.jsx)(n.a,{href:"#Event",children:"event"})," which fires when an ",(0,t.jsx)(n.a,{href:"#AuthenticationSession",children:"AuthenticationSession"})," is added, removed, or changed."]}),"\n",(0,t.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,t.jsx)(n.h3,{id:"added",children:"added?"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L3816",children:"packages/extension-api/src/extension-api.d.ts:3816"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L3828",children:"packages/extension-api/src/extension-api.d.ts:3828"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L3821",children:"packages/extension-api/src/extension-api.d.ts:3821"})})]})}function l(e={}){const{wrapper:n}={...(0,s.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(h,{...e})}):h(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>r,a:()=>a});var t=i(27378);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.6b0c038f.js b/assets/js/814d49b7.94d2f087.js similarity index 80% rename from assets/js/814d49b7.6b0c038f.js rename to assets/js/814d49b7.94d2f087.js index 07b8e6eab7d..8ecdccced76 100644 --- a/assets/js/814d49b7.6b0c038f.js +++ b/assets/js/814d49b7.94d2f087.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[125],{52994:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>r,contentTitle:()=>d,default:()=>p,frontMatter:()=>o,metadata:()=>a,toc:()=>c});var s=i(24246),t=i(71670);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={},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:"markdownDescription?",id:"markdowndescription",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:"version",id:"version",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",hr:"hr",p:"p",strong:"strong",...(0,t.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"interface-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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L4306",children:"packages/extension-api/src/extension-api.d.ts:4306"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L4308",children:"packages/extension-api/src/extension-api.d.ts:4308"})}),"\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-2",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L4307",children:"packages/extension-api/src/extension-api.d.ts:4307"})}),"\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-3",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L4309",children:"packages/extension-api/src/extension-api.d.ts:4309"})}),"\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-4",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L4305",children:"packages/extension-api/src/extension-api.d.ts:4305"})})]})}function p(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>a,a:()=>d});var s=i(27378);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([[125],{52994:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>r,contentTitle:()=>o,default:()=>p,frontMatter:()=>t,metadata:()=>a,toc:()=>c});var s=i(24246),d=i(71670);const t={},o="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={},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:"markdownDescription?",id:"markdowndescription",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:"version",id:"version",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",hr:"hr",p:"p",strong:"strong",...(0,d.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L4306",children:"packages/extension-api/src/extension-api.d.ts:4306"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L4308",children:"packages/extension-api/src/extension-api.d.ts:4308"})}),"\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-2",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L4307",children:"packages/extension-api/src/extension-api.d.ts:4307"})}),"\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-3",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L4309",children:"packages/extension-api/src/extension-api.d.ts:4309"})}),"\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-4",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L4305",children:"packages/extension-api/src/extension-api.d.ts:4305"})})]})}function p(e={}){const{wrapper:n}={...(0,d.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>a,a:()=>o});var s=i(27378);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/81b69ac7.76605b13.js b/assets/js/81b69ac7.9f3d753d.js similarity index 87% rename from assets/js/81b69ac7.76605b13.js rename to assets/js/81b69ac7.9f3d753d.js index 77eb3e69e5f..140cee4bd90 100644 --- a/assets/js/81b69ac7.76605b13.js +++ b/assets/js/81b69ac7.9f3d753d.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[92786],{49911:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>d,contentTitle:()=>s,default:()=>h,frontMatter:()=>o,metadata:()=>c,toc:()=>a});var r=i(24246),t=i(71670);const o={},s="Interface: KubernetesProviderConnectionFactory",c={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",hr:"hr",li:"li",p:"p",strong:"strong",ul:"ul",...(0,t.a)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.h1,{id:"interface-kubernetesproviderconnectionfactory",children:"Interface: KubernetesProviderConnectionFactory"}),"\n",(0,r.jsx)(n.h2,{id:"extends",children:"Extends"}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"/api/interfaces/ProviderConnectionFactory",children:(0,r.jsx)(n.code,{children:"ProviderConnectionFactory"})})}),"\n"]}),"\n",(0,r.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,r.jsx)(n.h3,{id:"creationbuttontitle",children:"creationButtonTitle?"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"optional"})," ",(0,r.jsx)(n.strong,{children:"creationButtonTitle"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"inherited-from",children:"Inherited from"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.a,{href:"/api/interfaces/ProviderConnectionFactory",children:(0,r.jsx)(n.code,{children:"ProviderConnectionFactory"})}),".",(0,r.jsx)(n.a,{href:"/api/interfaces/ProviderConnectionFactory#creationbuttontitle",children:(0,r.jsx)(n.code,{children:"creationButtonTitle"})})]}),"\n",(0,r.jsx)(n.h4,{id:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L478",children:"packages/extension-api/src/extension-api.d.ts:478"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L475",children:"packages/extension-api/src/extension-api.d.ts:475"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L490",children:"packages/extension-api/src/extension-api.d.ts:490"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L472",children:"packages/extension-api/src/extension-api.d.ts:472"})})]})}function h(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(l,{...e})}):l(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>c,a:()=>s});var r=i(27378);const t={},o=r.createContext(t);function s(e){const n=r.useContext(o);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:s(e.components),r.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[92786],{49911:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>s,contentTitle:()=>d,default:()=>h,frontMatter:()=>o,metadata:()=>c,toc:()=>a});var r=i(24246),t=i(71670);const o={},d="Interface: KubernetesProviderConnectionFactory",c={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"}},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",hr:"hr",li:"li",p:"p",strong:"strong",ul:"ul",...(0,t.a)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.h1,{id:"interface-kubernetesproviderconnectionfactory",children:"Interface: KubernetesProviderConnectionFactory"}),"\n",(0,r.jsx)(n.h2,{id:"extends",children:"Extends"}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"/api/interfaces/ProviderConnectionFactory",children:(0,r.jsx)(n.code,{children:"ProviderConnectionFactory"})})}),"\n"]}),"\n",(0,r.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,r.jsx)(n.h3,{id:"creationbuttontitle",children:"creationButtonTitle?"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"optional"})," ",(0,r.jsx)(n.strong,{children:"creationButtonTitle"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"inherited-from",children:"Inherited from"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.a,{href:"/api/interfaces/ProviderConnectionFactory",children:(0,r.jsx)(n.code,{children:"ProviderConnectionFactory"})}),".",(0,r.jsx)(n.a,{href:"/api/interfaces/ProviderConnectionFactory#creationbuttontitle",children:(0,r.jsx)(n.code,{children:"creationButtonTitle"})})]}),"\n",(0,r.jsx)(n.h4,{id:"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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L478",children:"packages/extension-api/src/extension-api.d.ts:478"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L475",children:"packages/extension-api/src/extension-api.d.ts:475"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L490",children:"packages/extension-api/src/extension-api.d.ts:490"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L472",children:"packages/extension-api/src/extension-api.d.ts:472"})})]})}function h(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(l,{...e})}):l(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>c,a:()=>d});var r=i(27378);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 diff --git a/assets/js/82170cf7.75bf9a2b.js b/assets/js/82170cf7.36122a07.js similarity index 96% rename from assets/js/82170cf7.75bf9a2b.js rename to assets/js/82170cf7.36122a07.js index e48ece966e3..8a96d899cc6 100644 --- a/assets/js/82170cf7.75bf9a2b.js +++ b/assets/js/82170cf7.36122a07.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[28263],{38185:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>o,contentTitle:()=>a,default:()=>p,frontMatter:()=>c,metadata:()=>r,toc:()=>d});var i=t(24246),s=t(71670);const c={},a="Function: getImageInspect()",r={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",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{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/804b2198fda0957e1ecfb87539f019eb9b79a66f/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,s.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>r,a:()=>a});var i=t(27378);const s={},c=i.createContext(s);function a(e){const n=i.useContext(c);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function r(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:a(e.components),i.createElement(c.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[28263],{38185:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>o,contentTitle:()=>a,default:()=>p,frontMatter:()=>c,metadata:()=>r,toc:()=>d});var i=t(24246),s=t(71670);const c={},a="Function: getImageInspect()",r={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",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{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/bd83a8b2bb8ab886dc757381b589638cbda150d0/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,s.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>r,a:()=>a});var i=t(27378);const s={},c=i.createContext(s);function a(e){const n=i.useContext(c);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function r(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:a(e.components),i.createElement(c.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/825ec378.c9057951.js b/assets/js/825ec378.cd8f1b89.js similarity index 98% rename from assets/js/825ec378.c9057951.js rename to assets/js/825ec378.cd8f1b89.js index f276b8035db..1ee37eb2f71 100644 --- a/assets/js/825ec378.c9057951.js +++ b/assets/js/825ec378.cd8f1b89.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[83039],{91525:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>a,contentTitle:()=>o,default:()=>u,frontMatter:()=>r,metadata:()=>c,toc:()=>d});var t=i(24246),s=i(71670);const r={},o="Function: buildImage()",c={id:"namespaces/containerEngine/functions/buildImage",title:"Function: buildImage()",description:"buildImage(context, eventCollect, options?): Promise\\",source:"@site/api/namespaces/containerEngine/functions/buildImage.md",sourceDirName:"namespaces/containerEngine/functions",slug:"/namespaces/containerEngine/functions/buildImage",permalink:"/api/namespaces/containerEngine/functions/buildImage",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"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",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"function-buildimage",children:"Function: buildImage()"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"buildImage"}),"(",(0,t.jsx)(n.code,{children:"context"}),", ",(0,t.jsx)(n.code,{children:"eventCollect"}),", ",(0,t.jsx)(n.code,{children:"options"}),"?): ",(0,t.jsx)(n.code,{children:"Promise"}),"<",(0,t.jsx)(n.code,{children:"unknown"}),">"]}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"Build a container image"}),"\n",(0,t.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"context"}),": ",(0,t.jsx)(n.code,{children:"string"})]}),"\n",(0,t.jsx)(n.p,{children:"the build context directory"}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"eventCollect"})]}),"\n",(0,t.jsxs)(n.p,{children:["a function called when new build logs are emitted or new events happen during the build operation. The value of ",(0,t.jsx)(n.code,{children:"eventName"})," can be either ",(0,t.jsx)(n.code,{children:"stream"})," (and ",(0,t.jsx)(n.code,{children:"data"})," contains the logs), or ",(0,t.jsx)(n.code,{children:"finish"})," indicating the end of the build operation, or ",(0,t.jsx)(n.code,{children:"error"})," in case of build error (and ",(0,t.jsx)(n.code,{children:"data"})," contains the error message)"]}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"options?"}),": ",(0,t.jsx)(n.a,{href:"/api/interfaces/BuildImageOptions",children:(0,t.jsx)(n.code,{children:"BuildImageOptions"})})]}),"\n",(0,t.jsx)(n.p,{children:"parameters for the build operation"}),"\n",(0,t.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"Promise"}),"<",(0,t.jsx)(n.code,{children:"unknown"}),">"]}),"\n",(0,t.jsx)(n.h2,{id:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L3536",children:"packages/extension-api/src/extension-api.d.ts:3536"})})]})}function u(e={}){const{wrapper:n}={...(0,s.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>c,a:()=>o});var t=i(27378);const s={},r=t.createContext(s);function o(e){const n=t.useContext(r);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:o(e.components),t.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[83039],{91525:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>a,contentTitle:()=>o,default:()=>u,frontMatter:()=>r,metadata:()=>c,toc:()=>d});var t=i(24246),s=i(71670);const r={},o="Function: buildImage()",c={id:"namespaces/containerEngine/functions/buildImage",title:"Function: buildImage()",description:"buildImage(context, eventCollect, options?): Promise\\",source:"@site/api/namespaces/containerEngine/functions/buildImage.md",sourceDirName:"namespaces/containerEngine/functions",slug:"/namespaces/containerEngine/functions/buildImage",permalink:"/api/namespaces/containerEngine/functions/buildImage",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"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",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"function-buildimage",children:"Function: buildImage()"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"buildImage"}),"(",(0,t.jsx)(n.code,{children:"context"}),", ",(0,t.jsx)(n.code,{children:"eventCollect"}),", ",(0,t.jsx)(n.code,{children:"options"}),"?): ",(0,t.jsx)(n.code,{children:"Promise"}),"<",(0,t.jsx)(n.code,{children:"unknown"}),">"]}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"Build a container image"}),"\n",(0,t.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"context"}),": ",(0,t.jsx)(n.code,{children:"string"})]}),"\n",(0,t.jsx)(n.p,{children:"the build context directory"}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"eventCollect"})]}),"\n",(0,t.jsxs)(n.p,{children:["a function called when new build logs are emitted or new events happen during the build operation. The value of ",(0,t.jsx)(n.code,{children:"eventName"})," can be either ",(0,t.jsx)(n.code,{children:"stream"})," (and ",(0,t.jsx)(n.code,{children:"data"})," contains the logs), or ",(0,t.jsx)(n.code,{children:"finish"})," indicating the end of the build operation, or ",(0,t.jsx)(n.code,{children:"error"})," in case of build error (and ",(0,t.jsx)(n.code,{children:"data"})," contains the error message)"]}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"options?"}),": ",(0,t.jsx)(n.a,{href:"/api/interfaces/BuildImageOptions",children:(0,t.jsx)(n.code,{children:"BuildImageOptions"})})]}),"\n",(0,t.jsx)(n.p,{children:"parameters for the build operation"}),"\n",(0,t.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"Promise"}),"<",(0,t.jsx)(n.code,{children:"unknown"}),">"]}),"\n",(0,t.jsx)(n.h2,{id:"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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L3536",children:"packages/extension-api/src/extension-api.d.ts:3536"})})]})}function u(e={}){const{wrapper:n}={...(0,s.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>c,a:()=>o});var t=i(27378);const s={},r=t.createContext(s);function o(e){const n=t.useContext(r);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:o(e.components),t.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/8519c2b0.63935461.js b/assets/js/8519c2b0.7c99c33c.js similarity index 98% rename from assets/js/8519c2b0.63935461.js rename to assets/js/8519c2b0.7c99c33c.js index 964f388b73d..7803a380d33 100644 --- a/assets/js/8519c2b0.63935461.js +++ b/assets/js/8519c2b0.7c99c33c.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[40569],{93020:(e,s,n)=>{n.r(s),n.d(s,{assets:()=>a,contentTitle:()=>t,default:()=>h,frontMatter:()=>o,metadata:()=>c,toc:()=>d});var r=n(24246),i=n(71670);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",p:"p",strong:"strong",...(0,i.a)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(s.h1,{id:"function-showerrormessage",children:"Function: showErrorMessage()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"showErrorMessage"}),"(",(0,r.jsx)(s.code,{children:"message"}),", ...",(0,r.jsx)(s.code,{children:"items"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"string"})," | ",(0,r.jsx)(s.code,{children:"undefined"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Show a error message. Optionally provide an array of items which will be presented as\nclickable buttons."}),"\n",(0,r.jsx)(s.h2,{id:"parameters",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"message"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:"The message to show."}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ...",(0,r.jsx)(s.strong,{children:"items"}),": ",(0,r.jsx)(s.code,{children:"string"}),"[]"]}),"\n",(0,r.jsx)(s.p,{children:"A set of items that will be rendered as actions in the message."}),"\n",(0,r.jsx)(s.h2,{id:"returns",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"string"})," | ",(0,r.jsx)(s.code,{children:"undefined"}),">"]}),"\n",(0,r.jsxs)(s.p,{children:["A promise that resolves to the selected item or ",(0,r.jsx)(s.code,{children:"undefined"})," when being dismissed."]}),"\n",(0,r.jsx)(s.h2,{id:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L1892",children:"packages/extension-api/src/extension-api.d.ts:1892"})})]})}function h(e={}){const{wrapper:s}={...(0,i.a)(),...e.components};return s?(0,r.jsx)(s,{...e,children:(0,r.jsx)(l,{...e})}):l(e)}},71670:(e,s,n)=>{n.d(s,{Z:()=>c,a:()=>t});var r=n(27378);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([[40569],{93020:(e,s,n)=>{n.r(s),n.d(s,{assets:()=>a,contentTitle:()=>t,default:()=>h,frontMatter:()=>o,metadata:()=>c,toc:()=>d});var r=n(24246),i=n(71670);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",p:"p",strong:"strong",...(0,i.a)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(s.h1,{id:"function-showerrormessage",children:"Function: showErrorMessage()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"showErrorMessage"}),"(",(0,r.jsx)(s.code,{children:"message"}),", ...",(0,r.jsx)(s.code,{children:"items"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"string"})," | ",(0,r.jsx)(s.code,{children:"undefined"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Show a error message. Optionally provide an array of items which will be presented as\nclickable buttons."}),"\n",(0,r.jsx)(s.h2,{id:"parameters",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"message"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:"The message to show."}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ...",(0,r.jsx)(s.strong,{children:"items"}),": ",(0,r.jsx)(s.code,{children:"string"}),"[]"]}),"\n",(0,r.jsx)(s.p,{children:"A set of items that will be rendered as actions in the message."}),"\n",(0,r.jsx)(s.h2,{id:"returns",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"string"})," | ",(0,r.jsx)(s.code,{children:"undefined"}),">"]}),"\n",(0,r.jsxs)(s.p,{children:["A promise that resolves to the selected item or ",(0,r.jsx)(s.code,{children:"undefined"})," when being dismissed."]}),"\n",(0,r.jsx)(s.h2,{id:"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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L1892",children:"packages/extension-api/src/extension-api.d.ts:1892"})})]})}function h(e={}){const{wrapper:s}={...(0,i.a)(),...e.components};return s?(0,r.jsx)(s,{...e,children:(0,r.jsx)(l,{...e})}):l(e)}},71670:(e,s,n)=>{n.d(s,{Z:()=>c,a:()=>t});var r=n(27378);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.a5557716.js b/assets/js/86e64757.27da0162.js similarity index 89% rename from assets/js/86e64757.a5557716.js rename to assets/js/86e64757.27da0162.js index b456c7b59d9..51b79c1a96b 100644 --- a/assets/js/86e64757.a5557716.js +++ b/assets/js/86e64757.27da0162.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[36075],{87321:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>l,contentTitle:()=>r,default:()=>p,frontMatter:()=>i,metadata:()=>o,toc:()=>c});var t=s(24246),a=s(71670);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",p:"p",strong:"strong",...(0,a.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"variable-istelemetryenabled",children:"Variable: isTelemetryEnabled"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"const"})," ",(0,t.jsx)(n.strong,{children:"isTelemetryEnabled"}),": ",(0,t.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"Indicates whether the users has telemetry enabled.\nCan be observed to determine if the extension should send telemetry."}),"\n",(0,t.jsx)(n.h2,{id:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L3975",children:"packages/extension-api/src/extension-api.d.ts:3975"})})]})}function p(e={}){const{wrapper:n}={...(0,a.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(d,{...e})}):d(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>o,a:()=>r});var t=s(27378);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([[36075],{87321:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>l,contentTitle:()=>r,default:()=>b,frontMatter:()=>i,metadata:()=>o,toc:()=>c});var t=s(24246),a=s(71670);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",p:"p",strong:"strong",...(0,a.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"variable-istelemetryenabled",children:"Variable: isTelemetryEnabled"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"const"})," ",(0,t.jsx)(n.strong,{children:"isTelemetryEnabled"}),": ",(0,t.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"Indicates whether the users has telemetry enabled.\nCan be observed to determine if the extension should send telemetry."}),"\n",(0,t.jsx)(n.h2,{id:"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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L3975",children:"packages/extension-api/src/extension-api.d.ts:3975"})})]})}function b(e={}){const{wrapper:n}={...(0,a.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(d,{...e})}):d(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>o,a:()=>r});var t=s(27378);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.43c17c93.js b/assets/js/86f8c256.988ba385.js similarity index 91% rename from assets/js/86f8c256.43c17c93.js rename to assets/js/86f8c256.988ba385.js index 7d9fd327164..0606bcd717b 100644 --- a/assets/js/86f8c256.43c17c93.js +++ b/assets/js/86f8c256.988ba385.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[29234],{57895:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>t,contentTitle:()=>c,default:()=>a,frontMatter:()=>r,metadata:()=>l,toc:()=>o});var s=i(24246),d=i(71670);const r={},c="Interface: ImageInspectInfo",l={id:"interfaces/ImageInspectInfo",title:"Interface: ImageInspectInfo",description:"Properties",source:"@site/api/interfaces/ImageInspectInfo.md",sourceDirName:"interfaces",slug:"/interfaces/ImageInspectInfo",permalink:"/api/interfaces/ImageInspectInfo",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"ImageInfo",permalink:"/api/interfaces/ImageInfo"},next:{title:"InputBoxOptions",permalink:"/api/interfaces/InputBoxOptions"}},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 h(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",h5:"h5",hr:"hr",p:"p",strong:"strong",...(0,d.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L2211",children:"packages/extension-api/src/extension-api.d.ts:2211"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L2189",children:"packages/extension-api/src/extension-api.d.ts:2189"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/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:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L2190",children:"packages/extension-api/src/extension-api.d.ts:2190"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/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:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/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:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/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:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L2188",children:"packages/extension-api/src/extension-api.d.ts:2188"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L2215",children:"packages/extension-api/src/extension-api.d.ts:2215"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/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:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L2212",children:"packages/extension-api/src/extension-api.d.ts:2212"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/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:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/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:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/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:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L2223",children:"packages/extension-api/src/extension-api.d.ts:2223"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L2213",children:"packages/extension-api/src/extension-api.d.ts:2213"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L2214",children:"packages/extension-api/src/extension-api.d.ts:2214"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/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-18",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L2159",children:"packages/extension-api/src/extension-api.d.ts:2159"})})]})}function a(e={}){const{wrapper:n}={...(0,d.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(h,{...e})}):h(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>l,a:()=>c});var s=i(27378);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([[29234],{57895:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>t,contentTitle:()=>r,default:()=>h,frontMatter:()=>c,metadata:()=>l,toc:()=>o});var s=i(24246),d=i(71670);const c={},r="Interface: ImageInspectInfo",l={id:"interfaces/ImageInspectInfo",title:"Interface: ImageInspectInfo",description:"Properties",source:"@site/api/interfaces/ImageInspectInfo.md",sourceDirName:"interfaces",slug:"/interfaces/ImageInspectInfo",permalink:"/api/interfaces/ImageInspectInfo",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"ImageInfo",permalink:"/api/interfaces/ImageInfo"},next:{title:"InputBoxOptions",permalink:"/api/interfaces/InputBoxOptions"}},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",hr:"hr",p:"p",strong:"strong",...(0,d.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2211",children:"packages/extension-api/src/extension-api.d.ts:2211"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2189",children:"packages/extension-api/src/extension-api.d.ts:2189"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/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:"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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2190",children:"packages/extension-api/src/extension-api.d.ts:2190"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/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:"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/bd83a8b2bb8ab886dc757381b589638cbda150d0/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:"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/bd83a8b2bb8ab886dc757381b589638cbda150d0/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:"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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2188",children:"packages/extension-api/src/extension-api.d.ts:2188"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2215",children:"packages/extension-api/src/extension-api.d.ts:2215"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/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:"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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2212",children:"packages/extension-api/src/extension-api.d.ts:2212"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/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:"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/bd83a8b2bb8ab886dc757381b589638cbda150d0/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:"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/bd83a8b2bb8ab886dc757381b589638cbda150d0/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:"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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2223",children:"packages/extension-api/src/extension-api.d.ts:2223"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2213",children:"packages/extension-api/src/extension-api.d.ts:2213"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2214",children:"packages/extension-api/src/extension-api.d.ts:2214"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/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-18",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2159",children:"packages/extension-api/src/extension-api.d.ts:2159"})})]})}function h(e={}){const{wrapper:n}={...(0,d.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(a,{...e})}):a(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>l,a:()=>r});var s=i(27378);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.ff5df7bd.js b/assets/js/871ce139.6fc1809c.js similarity index 83% rename from assets/js/871ce139.ff5df7bd.js rename to assets/js/871ce139.6fc1809c.js index 4d6aaebaf31..e4fc5df098e 100644 --- a/assets/js/871ce139.ff5df7bd.js +++ b/assets/js/871ce139.6fc1809c.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[91893],{15371:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>c,contentTitle:()=>s,default:()=>l,frontMatter:()=>o,metadata:()=>a,toc:()=>p});var r=n(24246),i=n(71670);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={},p=[{value:"Properties",id:"properties",level:2},{value:"Name",id:"name",level:3},{value:"Defined in",id:"defined-in",level:4}];function d(e){const t={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",p:"p",strong:"strong",...(0,i.a)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(t.h1,{id:"interface-networkcreateoptions",children:"Interface: NetworkCreateOptions"}),"\n",(0,r.jsx)(t.h2,{id:"properties",children:"Properties"}),"\n",(0,r.jsx)(t.h3,{id:"name",children:"Name"}),"\n",(0,r.jsxs)(t.blockquote,{children:["\n",(0,r.jsxs)(t.p,{children:[(0,r.jsx)(t.strong,{children:"Name"}),": ",(0,r.jsx)(t.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(t.h4,{id:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L3331",children:"packages/extension-api/src/extension-api.d.ts:3331"})})]})}function l(e={}){const{wrapper:t}={...(0,i.a)(),...e.components};return t?(0,r.jsx)(t,{...e,children:(0,r.jsx)(d,{...e})}):d(e)}},71670:(e,t,n)=>{n.d(t,{Z:()=>a,a:()=>s});var r=n(27378);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([[91893],{15371:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>c,contentTitle:()=>s,default:()=>l,frontMatter:()=>o,metadata:()=>a,toc:()=>d});var r=n(24246),i=n(71670);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",p:"p",strong:"strong",...(0,i.a)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(t.h1,{id:"interface-networkcreateoptions",children:"Interface: NetworkCreateOptions"}),"\n",(0,r.jsx)(t.h2,{id:"properties",children:"Properties"}),"\n",(0,r.jsx)(t.h3,{id:"name",children:"Name"}),"\n",(0,r.jsxs)(t.blockquote,{children:["\n",(0,r.jsxs)(t.p,{children:[(0,r.jsx)(t.strong,{children:"Name"}),": ",(0,r.jsx)(t.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(t.h4,{id:"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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L3331",children:"packages/extension-api/src/extension-api.d.ts:3331"})})]})}function l(e={}){const{wrapper:t}={...(0,i.a)(),...e.components};return t?(0,r.jsx)(t,{...e,children:(0,r.jsx)(p,{...e})}):p(e)}},71670:(e,t,n)=>{n.d(t,{Z:()=>a,a:()=>s});var r=n(27378);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/874690d0.86ce0f15.js b/assets/js/874690d0.3a23e97a.js similarity index 84% rename from assets/js/874690d0.86ce0f15.js rename to assets/js/874690d0.3a23e97a.js index db7cc19f217..6bcd3c4c75c 100644 --- a/assets/js/874690d0.86ce0f15.js +++ b/assets/js/874690d0.3a23e97a.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[58216],{72077:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>o,contentTitle:()=>r,default:()=>h,frontMatter:()=>d,metadata:()=>a,toc:()=>c});var s=i(24246),t=i(71670);const d={},r="Interface: StatusBarItem",a={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",hr:"hr",p:"p",strong:"strong",...(0,t.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"interface-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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L1485",children:"packages/extension-api/src/extension-api.d.ts:1485"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L1513",children:"packages/extension-api/src/extension-api.d.ts:1513"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L1518",children:"packages/extension-api/src/extension-api.d.ts:1518"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L1509",children:"packages/extension-api/src/extension-api.d.ts:1509"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L1504",children:"packages/extension-api/src/extension-api.d.ts:1504"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L1490",children:"packages/extension-api/src/extension-api.d.ts:1490"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L1494",children:"packages/extension-api/src/extension-api.d.ts:1494"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L1498",children:"packages/extension-api/src/extension-api.d.ts:1498"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L1532",children:"packages/extension-api/src/extension-api.d.ts:1532"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L1526",children:"packages/extension-api/src/extension-api.d.ts:1526"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L1522",children:"packages/extension-api/src/extension-api.d.ts:1522"})})]})}function h(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>a,a:()=>r});var s=i(27378);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([[58216],{72077:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>o,contentTitle:()=>a,default:()=>h,frontMatter:()=>t,metadata:()=>r,toc:()=>c});var s=i(24246),d=i(71670);const t={},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",hr:"hr",p:"p",strong:"strong",...(0,d.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L1485",children:"packages/extension-api/src/extension-api.d.ts:1485"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L1513",children:"packages/extension-api/src/extension-api.d.ts:1513"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L1518",children:"packages/extension-api/src/extension-api.d.ts:1518"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L1509",children:"packages/extension-api/src/extension-api.d.ts:1509"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L1504",children:"packages/extension-api/src/extension-api.d.ts:1504"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L1490",children:"packages/extension-api/src/extension-api.d.ts:1490"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L1494",children:"packages/extension-api/src/extension-api.d.ts:1494"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L1498",children:"packages/extension-api/src/extension-api.d.ts:1498"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L1532",children:"packages/extension-api/src/extension-api.d.ts:1532"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L1526",children:"packages/extension-api/src/extension-api.d.ts:1526"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L1522",children:"packages/extension-api/src/extension-api.d.ts:1522"})})]})}function h(e={}){const{wrapper:n}={...(0,d.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>r,a:()=>a});var s=i(27378);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 diff --git a/assets/js/8785b74d.6ea59cdb.js b/assets/js/8785b74d.fcf8afd3.js similarity index 89% rename from assets/js/8785b74d.6ea59cdb.js rename to assets/js/8785b74d.fcf8afd3.js index 12757adb29d..184c2dc556c 100644 --- a/assets/js/8785b74d.6ea59cdb.js +++ b/assets/js/8785b74d.fcf8afd3.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[83672],{32084:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>a,contentTitle:()=>d,default:()=>h,frontMatter:()=>t,metadata:()=>l,toc:()=>o});var s=r(24246),i=r(71670);const t={},d="Interface: TelemetryLogger",l={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"}},a={},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",hr:"hr",li:"li",p:"p",strong:"strong",ul:"ul",...(0,i.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"interface-telemetrylogger",children:"Interface: TelemetryLogger"}),"\n",(0,s.jsx)(n.p,{children:"A telemetry logger which can be used by extensions to log usage and error telementry."}),"\n",(0,s.jsxs)(n.p,{children:["A logger wraps around an ",(0,s.jsx)(n.a,{href:"/api/interfaces/TelemetrySender",children:"sender"})," but it guarantees that"]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsx)(n.li,{children:"user settings to disable or tweak telemetry are respected, and that"}),"\n",(0,s.jsx)(n.li,{children:"potential sensitive data is removed"}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:'It also enables an "echo UI" that prints whatever data is send and it allows the editor\nto forward unhandled errors to the respective extensions.'}),"\n",(0,s.jsxs)(n.p,{children:["To get an instance of a ",(0,s.jsx)(n.code,{children:"TelemetryLogger"}),", use\n",(0,s.jsx)(n.a,{href:"/api/namespaces/env/functions/createTelemetryLogger",children:(0,s.jsx)(n.code,{children:"createTelemetryLogger"})}),"."]}),"\n",(0,s.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,s.jsx)(n.h3,{id:"iserrorsenabled",children:"isErrorsEnabled"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"readonly"})," ",(0,s.jsx)(n.strong,{children:"isErrorsEnabled"}),": ",(0,s.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Whether or not error telemetry is enabled for this logger."}),"\n",(0,s.jsx)(n.h4,{id:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L4155",children:"packages/extension-api/src/extension-api.d.ts:4155"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L4150",children:"packages/extension-api/src/extension-api.d.ts:4150"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L4145",children:"packages/extension-api/src/extension-api.d.ts:4145"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L4190",children:"packages/extension-api/src/extension-api.d.ts:4190"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L4177",children:"packages/extension-api/src/extension-api.d.ts:4177"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L4185",children:"packages/extension-api/src/extension-api.d.ts:4185"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L4166",children:"packages/extension-api/src/extension-api.d.ts:4166"})})]})}function h(e={}){const{wrapper:n}={...(0,i.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(c,{...e})}):c(e)}},71670:(e,n,r)=>{r.d(n,{Z:()=>l,a:()=>d});var s=r(27378);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 l(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([[83672],{32084:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>l,contentTitle:()=>t,default:()=>h,frontMatter:()=>d,metadata:()=>a,toc:()=>o});var s=r(24246),i=r(71670);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",hr:"hr",li:"li",p:"p",strong:"strong",ul:"ul",...(0,i.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"interface-telemetrylogger",children:"Interface: TelemetryLogger"}),"\n",(0,s.jsx)(n.p,{children:"A telemetry logger which can be used by extensions to log usage and error telementry."}),"\n",(0,s.jsxs)(n.p,{children:["A logger wraps around an ",(0,s.jsx)(n.a,{href:"/api/interfaces/TelemetrySender",children:"sender"})," but it guarantees that"]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsx)(n.li,{children:"user settings to disable or tweak telemetry are respected, and that"}),"\n",(0,s.jsx)(n.li,{children:"potential sensitive data is removed"}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:'It also enables an "echo UI" that prints whatever data is send and it allows the editor\nto forward unhandled errors to the respective extensions.'}),"\n",(0,s.jsxs)(n.p,{children:["To get an instance of a ",(0,s.jsx)(n.code,{children:"TelemetryLogger"}),", use\n",(0,s.jsx)(n.a,{href:"/api/namespaces/env/functions/createTelemetryLogger",children:(0,s.jsx)(n.code,{children:"createTelemetryLogger"})}),"."]}),"\n",(0,s.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,s.jsx)(n.h3,{id:"iserrorsenabled",children:"isErrorsEnabled"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"readonly"})," ",(0,s.jsx)(n.strong,{children:"isErrorsEnabled"}),": ",(0,s.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Whether or not error telemetry is enabled for this logger."}),"\n",(0,s.jsx)(n.h4,{id:"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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L4155",children:"packages/extension-api/src/extension-api.d.ts:4155"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L4150",children:"packages/extension-api/src/extension-api.d.ts:4150"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L4145",children:"packages/extension-api/src/extension-api.d.ts:4145"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L4190",children:"packages/extension-api/src/extension-api.d.ts:4190"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L4177",children:"packages/extension-api/src/extension-api.d.ts:4177"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L4185",children:"packages/extension-api/src/extension-api.d.ts:4185"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L4166",children:"packages/extension-api/src/extension-api.d.ts:4166"})})]})}function h(e={}){const{wrapper:n}={...(0,i.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(c,{...e})}):c(e)}},71670:(e,n,r)=>{r.d(n,{Z:()=>a,a:()=>t});var s=r(27378);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 diff --git a/assets/js/878aa0e7.4c7f7a9d.js b/assets/js/878aa0e7.e8f3d48d.js similarity index 95% rename from assets/js/878aa0e7.4c7f7a9d.js rename to assets/js/878aa0e7.e8f3d48d.js index 3cc657a63cc..b99ad586ed5 100644 --- a/assets/js/878aa0e7.4c7f7a9d.js +++ b/assets/js/878aa0e7.e8f3d48d.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[16467],{55606:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>c,contentTitle:()=>s,default:()=>l,frontMatter:()=>r,metadata:()=>a,toc:()=>p});var o=t(24246),i=t(71670);const r={},s="Type Alias: ConfigurationScope",a={id:"type-aliases/ConfigurationScope",title:"Type Alias: ConfigurationScope",description:"ConfigurationScope: string \\| ContainerProviderConnection \\| KubernetesProviderConnection",source:"@site/api/type-aliases/ConfigurationScope.md",sourceDirName:"type-aliases",slug:"/type-aliases/ConfigurationScope",permalink:"/api/type-aliases/ConfigurationScope",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"CliToolState",permalink:"/api/type-aliases/CliToolState"},next:{title:"KubernetesGeneratorArgument",permalink:"/api/type-aliases/KubernetesGeneratorArgument"}},c={},p=[{value:"Defined in",id:"defined-in",level:2}];function d(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,i.a)(),...e.components};return(0,o.jsxs)(o.Fragment,{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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L942",children:"packages/extension-api/src/extension-api.d.ts:942"})})]})}function l(e={}){const{wrapper:n}={...(0,i.a)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(d,{...e})}):d(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>a,a:()=>s});var o=t(27378);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([[16467],{55606:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>c,contentTitle:()=>s,default:()=>l,frontMatter:()=>r,metadata:()=>a,toc:()=>p});var o=t(24246),i=t(71670);const r={},s="Type Alias: ConfigurationScope",a={id:"type-aliases/ConfigurationScope",title:"Type Alias: ConfigurationScope",description:"ConfigurationScope: string \\| ContainerProviderConnection \\| KubernetesProviderConnection",source:"@site/api/type-aliases/ConfigurationScope.md",sourceDirName:"type-aliases",slug:"/type-aliases/ConfigurationScope",permalink:"/api/type-aliases/ConfigurationScope",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"CliToolState",permalink:"/api/type-aliases/CliToolState"},next:{title:"KubernetesGeneratorArgument",permalink:"/api/type-aliases/KubernetesGeneratorArgument"}},c={},p=[{value:"Defined in",id:"defined-in",level:2}];function d(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,i.a)(),...e.components};return(0,o.jsxs)(o.Fragment,{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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L942",children:"packages/extension-api/src/extension-api.d.ts:942"})})]})}function l(e={}){const{wrapper:n}={...(0,i.a)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(d,{...e})}):d(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>a,a:()=>s});var o=t(27378);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.3461d2a6.js b/assets/js/87a5fc8a.f5ebd8fe.js similarity index 87% rename from assets/js/87a5fc8a.3461d2a6.js rename to assets/js/87a5fc8a.f5ebd8fe.js index 1b1ead01492..764964bd60f 100644 --- a/assets/js/87a5fc8a.3461d2a6.js +++ b/assets/js/87a5fc8a.f5ebd8fe.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[61573],{81089:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>o,default:()=>p,frontMatter:()=>r,metadata:()=>c,toc:()=>d});var i=t(24246),s=t(71670);const r={},o="Interface: PidsStats",c={id:"interfaces/PidsStats",title:"Interface: PidsStats",description:"Properties",source:"@site/api/interfaces/PidsStats.md",sourceDirName:"interfaces",slug:"/interfaces/PidsStats",permalink:"/api/interfaces/PidsStats",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"OpenDialogOptions",permalink:"/api/interfaces/OpenDialogOptions"},next:{title:"PodContainerInfo",permalink:"/api/interfaces/PodContainerInfo"}},a={},d=[{value:"Properties",id:"properties",level:2},{value:"current?",id:"current",level:3},{value:"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",hr:"hr",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"interface-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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L3044",children:"packages/extension-api/src/extension-api.d.ts:3044"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L3045",children:"packages/extension-api/src/extension-api.d.ts:3045"})})]})}function p(e={}){const{wrapper:n}={...(0,s.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>c,a:()=>o});var i=t(27378);const s={},r=i.createContext(s);function o(e){const n=i.useContext(r);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:o(e.components),i.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[61573],{81089:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>d,contentTitle:()=>o,default:()=>p,frontMatter:()=>r,metadata:()=>c,toc:()=>a});var i=t(24246),s=t(71670);const r={},o="Interface: PidsStats",c={id:"interfaces/PidsStats",title:"Interface: PidsStats",description:"Properties",source:"@site/api/interfaces/PidsStats.md",sourceDirName:"interfaces",slug:"/interfaces/PidsStats",permalink:"/api/interfaces/PidsStats",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"OpenDialogOptions",permalink:"/api/interfaces/OpenDialogOptions"},next:{title:"PodContainerInfo",permalink:"/api/interfaces/PodContainerInfo"}},d={},a=[{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",hr:"hr",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"interface-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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L3044",children:"packages/extension-api/src/extension-api.d.ts:3044"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L3045",children:"packages/extension-api/src/extension-api.d.ts:3045"})})]})}function p(e={}){const{wrapper:n}={...(0,s.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>c,a:()=>o});var i=t(27378);const s={},r=i.createContext(s);function o(e){const n=i.useContext(r);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:o(e.components),i.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/883e2c3c.31455d24.js b/assets/js/883e2c3c.06bdf71d.js similarity index 97% rename from assets/js/883e2c3c.31455d24.js rename to assets/js/883e2c3c.06bdf71d.js index e893484ce72..efbfbe148a7 100644 --- a/assets/js/883e2c3c.31455d24.js +++ b/assets/js/883e2c3c.06bdf71d.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[53479],{70830:(n,e,t)=>{t.r(e),t.d(e,{assets:()=>a,contentTitle:()=>o,default:()=>p,frontMatter:()=>r,metadata:()=>c,toc:()=>d});var s=t(24246),i=t(71670);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(n){const e={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,i.a)(),...n.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(e.h1,{id:"function-startpod",children:"Function: startPod()"}),"\n",(0,s.jsxs)(e.blockquote,{children:["\n",(0,s.jsxs)(e.p,{children:[(0,s.jsx)(e.strong,{children:"startPod"}),"(",(0,s.jsx)(e.code,{children:"engineId"}),", ",(0,s.jsx)(e.code,{children:"podId"}),"): ",(0,s.jsx)(e.code,{children:"Promise"}),"<",(0,s.jsx)(e.code,{children:"void"}),">"]}),"\n"]}),"\n",(0,s.jsx)(e.h2,{id:"parameters",children:"Parameters"}),"\n",(0,s.jsxs)(e.p,{children:["\u2022 ",(0,s.jsx)(e.strong,{children:"engineId"}),": ",(0,s.jsx)(e.code,{children:"string"})]}),"\n",(0,s.jsxs)(e.p,{children:["\u2022 ",(0,s.jsx)(e.strong,{children:"podId"}),": ",(0,s.jsx)(e.code,{children:"string"})]}),"\n",(0,s.jsx)(e.h2,{id:"returns",children:"Returns"}),"\n",(0,s.jsxs)(e.p,{children:[(0,s.jsx)(e.code,{children:"Promise"}),"<",(0,s.jsx)(e.code,{children:"void"}),">"]}),"\n",(0,s.jsx)(e.h2,{id:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L3665",children:"packages/extension-api/src/extension-api.d.ts:3665"})})]})}function p(n={}){const{wrapper:e}={...(0,i.a)(),...n.components};return e?(0,s.jsx)(e,{...n,children:(0,s.jsx)(l,{...n})}):l(n)}},71670:(n,e,t)=>{t.d(e,{Z:()=>c,a:()=>o});var s=t(27378);const i={},r=s.createContext(i);function o(n){const e=s.useContext(r);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(i):n.components||i:o(n.components),s.createElement(r.Provider,{value:e},n.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[53479],{70830:(n,e,t)=>{t.r(e),t.d(e,{assets:()=>a,contentTitle:()=>o,default:()=>p,frontMatter:()=>r,metadata:()=>c,toc:()=>d});var s=t(24246),i=t(71670);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(n){const e={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,i.a)(),...n.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(e.h1,{id:"function-startpod",children:"Function: startPod()"}),"\n",(0,s.jsxs)(e.blockquote,{children:["\n",(0,s.jsxs)(e.p,{children:[(0,s.jsx)(e.strong,{children:"startPod"}),"(",(0,s.jsx)(e.code,{children:"engineId"}),", ",(0,s.jsx)(e.code,{children:"podId"}),"): ",(0,s.jsx)(e.code,{children:"Promise"}),"<",(0,s.jsx)(e.code,{children:"void"}),">"]}),"\n"]}),"\n",(0,s.jsx)(e.h2,{id:"parameters",children:"Parameters"}),"\n",(0,s.jsxs)(e.p,{children:["\u2022 ",(0,s.jsx)(e.strong,{children:"engineId"}),": ",(0,s.jsx)(e.code,{children:"string"})]}),"\n",(0,s.jsxs)(e.p,{children:["\u2022 ",(0,s.jsx)(e.strong,{children:"podId"}),": ",(0,s.jsx)(e.code,{children:"string"})]}),"\n",(0,s.jsx)(e.h2,{id:"returns",children:"Returns"}),"\n",(0,s.jsxs)(e.p,{children:[(0,s.jsx)(e.code,{children:"Promise"}),"<",(0,s.jsx)(e.code,{children:"void"}),">"]}),"\n",(0,s.jsx)(e.h2,{id:"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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L3665",children:"packages/extension-api/src/extension-api.d.ts:3665"})})]})}function p(n={}){const{wrapper:e}={...(0,i.a)(),...n.components};return e?(0,s.jsx)(e,{...n,children:(0,s.jsx)(l,{...n})}):l(n)}},71670:(n,e,t)=>{t.d(e,{Z:()=>c,a:()=>o});var s=t(27378);const i={},r=s.createContext(i);function o(n){const e=s.useContext(r);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(i):n.components||i:o(n.components),s.createElement(r.Provider,{value:e},n.children)}}}]); \ No newline at end of file diff --git a/assets/js/8a864d1e.ceb03814.js b/assets/js/8a864d1e.c636e1f8.js similarity index 94% rename from assets/js/8a864d1e.ceb03814.js rename to assets/js/8a864d1e.c636e1f8.js index b10742ad42d..10fec005651 100644 --- a/assets/js/8a864d1e.ceb03814.js +++ b/assets/js/8a864d1e.c636e1f8.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[68974],{97197:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>c,contentTitle:()=>r,default:()=>l,frontMatter:()=>s,metadata:()=>a,toc:()=>d});var i=t(24246),o=t(71670);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",p:"p",strong:"strong",...(0,o.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{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/804b2198fda0957e1ecfb87539f019eb9b79a66f/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.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(p,{...e})}):p(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>a,a:()=>r});var i=t(27378);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([[68974],{97197:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>c,contentTitle:()=>r,default:()=>l,frontMatter:()=>s,metadata:()=>a,toc:()=>d});var i=t(24246),o=t(71670);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",p:"p",strong:"strong",...(0,o.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{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/bd83a8b2bb8ab886dc757381b589638cbda150d0/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.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(p,{...e})}):p(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>a,a:()=>r});var i=t(27378);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.c82b85fa.js b/assets/js/8abd0ba5.bf65c896.js similarity index 87% rename from assets/js/8abd0ba5.c82b85fa.js rename to assets/js/8abd0ba5.bf65c896.js index f0ec73a2c99..67ff6507247 100644 --- a/assets/js/8abd0ba5.c82b85fa.js +++ b/assets/js/8abd0ba5.bf65c896.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[1516],{8972:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>r,default:()=>h,frontMatter:()=>c,metadata:()=>o,toc:()=>d});var i=t(24246),s=t(71670);const c={},r="Interface: CustomPickSectionItem",o={id:"interfaces/CustomPickSectionItem",title:"Interface: CustomPickSectionItem",description:"Represents an item that can be selected from",source:"@site/api/interfaces/CustomPickSectionItem.md",sourceDirName:"interfaces",slug:"/interfaces/CustomPickSectionItem",permalink:"/api/interfaces/CustomPickSectionItem",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"CustomPickItem",permalink:"/api/interfaces/CustomPickItem"},next:{title:"DeviceRequest",permalink:"/api/interfaces/DeviceRequest"}},a={},d=[{value:"Properties",id:"properties",level:2},{value:"content?",id:"content",level:3},{value:"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",hr:"hr",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"interface-custompicksectionitem",children:"Interface: CustomPickSectionItem"}),"\n",(0,i.jsx)(n.p,{children:"Represents an item that can be selected from\na list of items."}),"\n",(0,i.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(n.h3,{id:"content",children:"content?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"content"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"A human-readable string which is rendered in a separate line."}),"\n",(0,i.jsx)(n.h4,{id:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L1334",children:"packages/extension-api/src/extension-api.d.ts:1334"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L1339",children:"packages/extension-api/src/extension-api.d.ts:1339"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L1329",children:"packages/extension-api/src/extension-api.d.ts:1329"})})]})}function h(e={}){const{wrapper:n}={...(0,s.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>o,a:()=>r});var i=t(27378);const s={},c=i.createContext(s);function r(e){const n=i.useContext(c);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:r(e.components),i.createElement(c.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[1516],{8972:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>d,contentTitle:()=>r,default:()=>h,frontMatter:()=>c,metadata:()=>o,toc:()=>a});var i=t(24246),s=t(71670);const c={},r="Interface: CustomPickSectionItem",o={id:"interfaces/CustomPickSectionItem",title:"Interface: CustomPickSectionItem",description:"Represents an item that can be selected from",source:"@site/api/interfaces/CustomPickSectionItem.md",sourceDirName:"interfaces",slug:"/interfaces/CustomPickSectionItem",permalink:"/api/interfaces/CustomPickSectionItem",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"CustomPickItem",permalink:"/api/interfaces/CustomPickItem"},next:{title:"DeviceRequest",permalink:"/api/interfaces/DeviceRequest"}},d={},a=[{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",hr:"hr",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"interface-custompicksectionitem",children:"Interface: CustomPickSectionItem"}),"\n",(0,i.jsx)(n.p,{children:"Represents an item that can be selected from\na list of items."}),"\n",(0,i.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(n.h3,{id:"content",children:"content?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"content"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"A human-readable string which is rendered in a separate line."}),"\n",(0,i.jsx)(n.h4,{id:"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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L1334",children:"packages/extension-api/src/extension-api.d.ts:1334"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L1339",children:"packages/extension-api/src/extension-api.d.ts:1339"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L1329",children:"packages/extension-api/src/extension-api.d.ts:1329"})})]})}function h(e={}){const{wrapper:n}={...(0,s.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>o,a:()=>r});var i=t(27378);const s={},c=i.createContext(s);function r(e){const n=i.useContext(c);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:r(e.components),i.createElement(c.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/8b4ba22f.0698faa8.js b/assets/js/8b4ba22f.ba8a4b51.js similarity index 92% rename from assets/js/8b4ba22f.0698faa8.js rename to assets/js/8b4ba22f.ba8a4b51.js index 82911f7b9dc..46102c1f7c1 100644 --- a/assets/js/8b4ba22f.0698faa8.js +++ b/assets/js/8b4ba22f.ba8a4b51.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[60564],{346:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>a,contentTitle:()=>o,default:()=>p,frontMatter:()=>r,metadata:()=>d,toc:()=>c});var t=i(24246),s=i(71670);const r={},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:"CliToolOptions",permalink:"/api/interfaces/CliToolOptions"},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",hr:"hr",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"interface-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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L4314",children:"packages/extension-api/src/extension-api.d.ts:4314"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L4313",children:"packages/extension-api/src/extension-api.d.ts:4313"})})]})}function p(e={}){const{wrapper:n}={...(0,s.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>d,a:()=>o});var t=i(27378);const s={},r=t.createContext(s);function o(e){const n=t.useContext(r);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function 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([[60564],{346:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>a,contentTitle:()=>o,default:()=>p,frontMatter:()=>r,metadata:()=>d,toc:()=>c});var t=i(24246),s=i(71670);const r={},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:"CliToolOptions",permalink:"/api/interfaces/CliToolOptions"},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",hr:"hr",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"interface-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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L4314",children:"packages/extension-api/src/extension-api.d.ts:4314"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L4313",children:"packages/extension-api/src/extension-api.d.ts:4313"})})]})}function p(e={}){const{wrapper:n}={...(0,s.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>d,a:()=>o});var t=i(27378);const s={},r=t.createContext(s);function o(e){const n=t.useContext(r);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function 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/8c6c72f9.d83125d4.js b/assets/js/8c6c72f9.6863ceb9.js similarity index 94% rename from assets/js/8c6c72f9.d83125d4.js rename to assets/js/8c6c72f9.6863ceb9.js index abe65cc6efa..36e428fa850 100644 --- a/assets/js/8c6c72f9.d83125d4.js +++ b/assets/js/8c6c72f9.6863ceb9.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[63707],{50243:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>r,contentTitle:()=>c,default:()=>p,frontMatter:()=>a,metadata:()=>o,toc:()=>l});var i=t(24246),s=t(71670);const a={},c="Type Alias: CheckResultLink",o={id:"type-aliases/CheckResultLink",title:"Type Alias: CheckResultLink",description:"CheckResultLink: Link",source:"@site/api/type-aliases/CheckResultLink.md",sourceDirName:"type-aliases",slug:"/type-aliases/CheckResultLink",permalink:"/api/type-aliases/CheckResultLink",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"WebviewPanelOnDidChangeViewStateEvent",permalink:"/api/interfaces/WebviewPanelOnDidChangeViewStateEvent"},next:{title:"CliToolState",permalink:"/api/type-aliases/CliToolState"}},r={},l=[{value:"Defined in",id:"defined-in",level:2}];function d(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L516",children:"packages/extension-api/src/extension-api.d.ts:516"})})]})}function p(e={}){const{wrapper:n}={...(0,s.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(d,{...e})}):d(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>o,a:()=>c});var i=t(27378);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([[63707],{50243:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>r,contentTitle:()=>c,default:()=>p,frontMatter:()=>a,metadata:()=>o,toc:()=>l});var i=t(24246),s=t(71670);const a={},c="Type Alias: CheckResultLink",o={id:"type-aliases/CheckResultLink",title:"Type Alias: CheckResultLink",description:"CheckResultLink: Link",source:"@site/api/type-aliases/CheckResultLink.md",sourceDirName:"type-aliases",slug:"/type-aliases/CheckResultLink",permalink:"/api/type-aliases/CheckResultLink",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"WebviewPanelOnDidChangeViewStateEvent",permalink:"/api/interfaces/WebviewPanelOnDidChangeViewStateEvent"},next:{title:"CliToolState",permalink:"/api/type-aliases/CliToolState"}},r={},l=[{value:"Defined in",id:"defined-in",level:2}];function d(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L516",children:"packages/extension-api/src/extension-api.d.ts:516"})})]})}function p(e={}){const{wrapper:n}={...(0,s.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(d,{...e})}):d(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>o,a:()=>c});var i=t(27378);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.ed8cc7c2.js b/assets/js/8c8ef21f.3c7a6e7a.js similarity index 80% rename from assets/js/8c8ef21f.ed8cc7c2.js rename to assets/js/8c8ef21f.3c7a6e7a.js index f981ea81e8c..60de1e72095 100644 --- a/assets/js/8c8ef21f.ed8cc7c2.js +++ b/assets/js/8c8ef21f.3c7a6e7a.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[80954],{46629:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>d,contentTitle:()=>c,default:()=>p,frontMatter:()=>r,metadata:()=>o,toc:()=>a});var t=i(24246),s=i(71670);const r={},c="Interface: Link",o={id:"interfaces/Link",title:"Interface: Link",description:"Properties",source:"@site/api/interfaces/Link.md",sourceDirName:"interfaces",slug:"/interfaces/Link",permalink:"/api/interfaces/Link",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"LifecycleContext",permalink:"/api/interfaces/LifecycleContext"},next:{title:"ListImagesOptions",permalink:"/api/interfaces/ListImagesOptions"}},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",hr:"hr",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"interface-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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L514",children:"packages/extension-api/src/extension-api.d.ts:514"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L512",children:"packages/extension-api/src/extension-api.d.ts:512"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L513",children:"packages/extension-api/src/extension-api.d.ts:513"})})]})}function p(e={}){const{wrapper:n}={...(0,s.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>o,a:()=>c});var t=i(27378);const s={},r=t.createContext(s);function c(e){const n=t.useContext(r);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:c(e.components),t.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[80954],{46629:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>o,contentTitle:()=>c,default:()=>p,frontMatter:()=>r,metadata:()=>d,toc:()=>a});var t=i(24246),s=i(71670);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",hr:"hr",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"interface-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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L514",children:"packages/extension-api/src/extension-api.d.ts:514"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L512",children:"packages/extension-api/src/extension-api.d.ts:512"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L513",children:"packages/extension-api/src/extension-api.d.ts:513"})})]})}function p(e={}){const{wrapper:n}={...(0,s.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>d,a:()=>c});var t=i(27378);const s={},r=t.createContext(s);function c(e){const n=t.useContext(r);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function 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/8cb0269b.63811af8.js b/assets/js/8cb0269b.ab2359f7.js similarity index 93% rename from assets/js/8cb0269b.63811af8.js rename to assets/js/8cb0269b.ab2359f7.js index 8dea2f7ed0d..e89c27a1704 100644 --- a/assets/js/8cb0269b.63811af8.js +++ b/assets/js/8cb0269b.ab2359f7.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[35281],{88782:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>h,contentTitle:()=>t,default:()=>o,frontMatter:()=>d,metadata:()=>c,toc:()=>a});var i=s(24246),r=s(71670);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",hr:"hr",p:"p",pre:"pre",strong:"strong",...(0,r.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L1585",children:"packages/extension-api/src/extension-api.d.ts:1585"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L1605",children:"packages/extension-api/src/extension-api.d.ts:1605"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L1595",children:"packages/extension-api/src/extension-api.d.ts:1595"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L1590",children:"packages/extension-api/src/extension-api.d.ts:1590"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L1600",children:"packages/extension-api/src/extension-api.d.ts:1600"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L1579",children:"packages/extension-api/src/extension-api.d.ts:1579"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L1644",children:"packages/extension-api/src/extension-api.d.ts:1644"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/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:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L1558",children:"packages/extension-api/src/extension-api.d.ts:1558"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L1568",children:"packages/extension-api/src/extension-api.d.ts:1568"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L1552",children:"packages/extension-api/src/extension-api.d.ts:1552"})})]})}function o(e={}){const{wrapper:n}={...(0,r.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>c,a:()=>t});var i=s(27378);const r={},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([[35281],{88782:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>h,contentTitle:()=>t,default:()=>o,frontMatter:()=>d,metadata:()=>c,toc:()=>a});var i=s(24246),r=s(71670);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",hr:"hr",p:"p",pre:"pre",strong:"strong",...(0,r.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L1585",children:"packages/extension-api/src/extension-api.d.ts:1585"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L1605",children:"packages/extension-api/src/extension-api.d.ts:1605"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L1595",children:"packages/extension-api/src/extension-api.d.ts:1595"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L1590",children:"packages/extension-api/src/extension-api.d.ts:1590"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L1600",children:"packages/extension-api/src/extension-api.d.ts:1600"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L1579",children:"packages/extension-api/src/extension-api.d.ts:1579"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L1644",children:"packages/extension-api/src/extension-api.d.ts:1644"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/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:"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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L1558",children:"packages/extension-api/src/extension-api.d.ts:1558"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L1568",children:"packages/extension-api/src/extension-api.d.ts:1568"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L1552",children:"packages/extension-api/src/extension-api.d.ts:1552"})})]})}function o(e={}){const{wrapper:n}={...(0,r.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>c,a:()=>t});var i=s(27378);const r={},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.c1f154b0.js b/assets/js/8ccdb99f.c213634b.js similarity index 94% rename from assets/js/8ccdb99f.c1f154b0.js rename to assets/js/8ccdb99f.c213634b.js index a1986c81081..6850195bc24 100644 --- a/assets/js/8ccdb99f.c1f154b0.js +++ b/assets/js/8ccdb99f.c213634b.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[6639],{38630:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>r,contentTitle:()=>c,default:()=>p,frontMatter:()=>i,metadata:()=>a,toc:()=>d});var s=t(24246),o=t(71670);const i={},c="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",p:"p",strong:"strong",...(0,o.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"type-alias-mountconsistency",children:"Type Alias: MountConsistency"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"MountConsistency"}),": ",(0,s.jsx)(n.code,{children:'"default"'})," | ",(0,s.jsx)(n.code,{children:'"consistent"'})," | ",(0,s.jsx)(n.code,{children:'"cached"'})," | ",(0,s.jsx)(n.code,{children:'"delegated"'})]}),"\n"]}),"\n",(0,s.jsx)(n.h2,{id:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L2371",children:"packages/extension-api/src/extension-api.d.ts:2371"})})]})}function p(e={}){const{wrapper:n}={...(0,o.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>a,a:()=>c});var s=t(27378);const o={},i=s.createContext(o);function c(e){const n=s.useContext(i);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function a(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:c(e.components),s.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[6639],{38630:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>r,contentTitle:()=>c,default:()=>p,frontMatter:()=>i,metadata:()=>a,toc:()=>d});var s=t(24246),o=t(71670);const i={},c="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",p:"p",strong:"strong",...(0,o.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"type-alias-mountconsistency",children:"Type Alias: MountConsistency"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"MountConsistency"}),": ",(0,s.jsx)(n.code,{children:'"default"'})," | ",(0,s.jsx)(n.code,{children:'"consistent"'})," | ",(0,s.jsx)(n.code,{children:'"cached"'})," | ",(0,s.jsx)(n.code,{children:'"delegated"'})]}),"\n"]}),"\n",(0,s.jsx)(n.h2,{id:"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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2371",children:"packages/extension-api/src/extension-api.d.ts:2371"})})]})}function p(e={}){const{wrapper:n}={...(0,o.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>a,a:()=>c});var s=t(27378);const o={},i=s.createContext(o);function c(e){const n=s.useContext(i);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function a(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:c(e.components),s.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/8dbb6800.b6870e64.js b/assets/js/8dbb6800.23d34493.js similarity index 83% rename from assets/js/8dbb6800.b6870e64.js rename to assets/js/8dbb6800.23d34493.js index faa58f4e28f..c77490cbcac 100644 --- a/assets/js/8dbb6800.b6870e64.js +++ b/assets/js/8dbb6800.23d34493.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[46738],{62926:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>a,contentTitle:()=>c,default:()=>d,frontMatter:()=>o,metadata:()=>r,toc:()=>l});var t=s(24246),i=s(71670);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 u(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,i.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"function-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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L3655",children:"packages/extension-api/src/extension-api.d.ts:3655"})})]})}function d(e={}){const{wrapper:n}={...(0,i.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(u,{...e})}):u(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>r,a:()=>c});var t=s(27378);const 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([[46738],{62926:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>a,contentTitle:()=>c,default:()=>u,frontMatter:()=>o,metadata:()=>r,toc:()=>l});var t=s(24246),i=s(71670);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",p:"p",strong:"strong",...(0,i.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"function-listvolumes",children:"Function: listVolumes()"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"listVolumes"}),"(): ",(0,t.jsx)(n.code,{children:"Promise"}),"<",(0,t.jsx)(n.a,{href:"/api/interfaces/VolumeListInfo",children:(0,t.jsx)(n.code,{children:"VolumeListInfo"})}),"[]>"]}),"\n"]}),"\n",(0,t.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"Promise"}),"<",(0,t.jsx)(n.a,{href:"/api/interfaces/VolumeListInfo",children:(0,t.jsx)(n.code,{children:"VolumeListInfo"})}),"[]>"]}),"\n",(0,t.jsx)(n.h2,{id:"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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L3655",children:"packages/extension-api/src/extension-api.d.ts:3655"})})]})}function u(e={}){const{wrapper:n}={...(0,i.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(d,{...e})}):d(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>r,a:()=>c});var t=s(27378);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.8df7bd53.js b/assets/js/8eeedb31.770e98d2.js similarity index 88% rename from assets/js/8eeedb31.8df7bd53.js rename to assets/js/8eeedb31.770e98d2.js index 23e7d379c4a..2952593915f 100644 --- a/assets/js/8eeedb31.8df7bd53.js +++ b/assets/js/8eeedb31.770e98d2.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[28682],{32799:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>o,contentTitle:()=>r,default:()=>h,frontMatter:()=>s,metadata:()=>c,toc:()=>l});var i=t(24246),a=t(71670);const s={},r="Interface: WebviewPanelOnDidChangeViewStateEvent",c={id:"interfaces/WebviewPanelOnDidChangeViewStateEvent",title:"Interface: WebviewPanelOnDidChangeViewStateEvent",description:"Event fired when a webview panel's view state changes.",source:"@site/api/interfaces/WebviewPanelOnDidChangeViewStateEvent.md",sourceDirName:"interfaces",slug:"/interfaces/WebviewPanelOnDidChangeViewStateEvent",permalink:"/api/interfaces/WebviewPanelOnDidChangeViewStateEvent",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"WebviewPanel",permalink:"/api/interfaces/WebviewPanel"},next:{title:"CheckResultLink",permalink:"/api/type-aliases/CheckResultLink"}},o={},l=[{value:"Properties",id:"properties",level:2},{value:"webviewPanel",id:"webviewpanel",level:3},{value:"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",p:"p",strong:"strong",...(0,a.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"interface-webviewpanelondidchangeviewstateevent",children:"Interface: WebviewPanelOnDidChangeViewStateEvent"}),"\n",(0,i.jsx)(n.p,{children:"Event fired when a webview panel's view state changes."}),"\n",(0,i.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(n.h3,{id:"webviewpanel",children:"webviewPanel"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"readonly"})," ",(0,i.jsx)(n.strong,{children:"webviewPanel"}),": ",(0,i.jsx)(n.a,{href:"/api/interfaces/WebviewPanel",children:(0,i.jsx)(n.code,{children:"WebviewPanel"})})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Webview panel whose view state changed."}),"\n",(0,i.jsx)(n.h4,{id:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L1860",children:"packages/extension-api/src/extension-api.d.ts:1860"})})]})}function h(e={}){const{wrapper:n}={...(0,a.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(d,{...e})}):d(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>c,a:()=>r});var i=t(27378);const a={},s=i.createContext(a);function r(e){const n=i.useContext(s);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(a):e.components||a:r(e.components),i.createElement(s.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[28682],{32799:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>o,contentTitle:()=>r,default:()=>h,frontMatter:()=>s,metadata:()=>c,toc:()=>d});var i=t(24246),a=t(71670);const s={},r="Interface: WebviewPanelOnDidChangeViewStateEvent",c={id:"interfaces/WebviewPanelOnDidChangeViewStateEvent",title:"Interface: WebviewPanelOnDidChangeViewStateEvent",description:"Event fired when a webview panel's view state changes.",source:"@site/api/interfaces/WebviewPanelOnDidChangeViewStateEvent.md",sourceDirName:"interfaces",slug:"/interfaces/WebviewPanelOnDidChangeViewStateEvent",permalink:"/api/interfaces/WebviewPanelOnDidChangeViewStateEvent",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"WebviewPanel",permalink:"/api/interfaces/WebviewPanel"},next:{title:"CheckResultLink",permalink:"/api/type-aliases/CheckResultLink"}},o={},d=[{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",p:"p",strong:"strong",...(0,a.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"interface-webviewpanelondidchangeviewstateevent",children:"Interface: WebviewPanelOnDidChangeViewStateEvent"}),"\n",(0,i.jsx)(n.p,{children:"Event fired when a webview panel's view state changes."}),"\n",(0,i.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(n.h3,{id:"webviewpanel",children:"webviewPanel"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"readonly"})," ",(0,i.jsx)(n.strong,{children:"webviewPanel"}),": ",(0,i.jsx)(n.a,{href:"/api/interfaces/WebviewPanel",children:(0,i.jsx)(n.code,{children:"WebviewPanel"})})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Webview panel whose view state changed."}),"\n",(0,i.jsx)(n.h4,{id:"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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L1860",children:"packages/extension-api/src/extension-api.d.ts:1860"})})]})}function h(e={}){const{wrapper:n}={...(0,a.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>c,a:()=>r});var i=t(27378);const a={},s=i.createContext(a);function r(e){const n=i.useContext(s);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(a):e.components||a:r(e.components),i.createElement(s.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/905702d2.d76daff9.js b/assets/js/905702d2.70cb1c3f.js similarity index 95% rename from assets/js/905702d2.d76daff9.js rename to assets/js/905702d2.70cb1c3f.js index 18034a70fd3..fd7ed22657e 100644 --- a/assets/js/905702d2.d76daff9.js +++ b/assets/js/905702d2.70cb1c3f.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[38056],{29700:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>o,contentTitle:()=>a,default:()=>l,frontMatter:()=>i,metadata:()=>c,toc:()=>d});var s=t(24246),r=t(71670);const i={},a="Function: registerMenuItem()",c={id:"namespaces/tray/functions/registerMenuItem",title:"Function: registerMenuItem()",description:"registerMenuItem(item): Disposable",source:"@site/api/namespaces/tray/functions/registerMenuItem.md",sourceDirName:"namespaces/tray/functions",slug:"/namespaces/tray/functions/registerMenuItem",permalink:"/api/namespaces/tray/functions/registerMenuItem",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"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",p:"p",strong:"strong",...(0,r.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"function-registermenuitem",children:"Function: registerMenuItem()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"registerMenuItem"}),"(",(0,s.jsx)(n.code,{children:"item"}),"): ",(0,s.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,s.jsx)(n.code,{children:"Disposable"})})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Creates a menu not related to a Provider"}),"\n",(0,s.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"item"}),": ",(0,s.jsx)(n.a,{href:"/api/interfaces/MenuItem",children:(0,s.jsx)(n.code,{children:"MenuItem"})})]}),"\n",(0,s.jsx)(n.p,{children:"the item to add in the tray menu"}),"\n",(0,s.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,s.jsx)(n.code,{children:"Disposable"})})}),"\n",(0,s.jsx)(n.h2,{id:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L920",children:"packages/extension-api/src/extension-api.d.ts:920"})})]})}function l(e={}){const{wrapper:n}={...(0,r.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(u,{...e})}):u(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>c,a:()=>a});var s=t(27378);const r={},i=s.createContext(r);function a(e){const n=s.useContext(i);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:a(e.components),s.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[38056],{29700:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>o,contentTitle:()=>a,default:()=>l,frontMatter:()=>i,metadata:()=>c,toc:()=>d});var s=t(24246),r=t(71670);const i={},a="Function: registerMenuItem()",c={id:"namespaces/tray/functions/registerMenuItem",title:"Function: registerMenuItem()",description:"registerMenuItem(item): Disposable",source:"@site/api/namespaces/tray/functions/registerMenuItem.md",sourceDirName:"namespaces/tray/functions",slug:"/namespaces/tray/functions/registerMenuItem",permalink:"/api/namespaces/tray/functions/registerMenuItem",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"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",p:"p",strong:"strong",...(0,r.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"function-registermenuitem",children:"Function: registerMenuItem()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"registerMenuItem"}),"(",(0,s.jsx)(n.code,{children:"item"}),"): ",(0,s.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,s.jsx)(n.code,{children:"Disposable"})})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Creates a menu not related to a Provider"}),"\n",(0,s.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"item"}),": ",(0,s.jsx)(n.a,{href:"/api/interfaces/MenuItem",children:(0,s.jsx)(n.code,{children:"MenuItem"})})]}),"\n",(0,s.jsx)(n.p,{children:"the item to add in the tray menu"}),"\n",(0,s.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,s.jsx)(n.code,{children:"Disposable"})})}),"\n",(0,s.jsx)(n.h2,{id:"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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L920",children:"packages/extension-api/src/extension-api.d.ts:920"})})]})}function l(e={}){const{wrapper:n}={...(0,r.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(u,{...e})}):u(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>c,a:()=>a});var s=t(27378);const r={},i=s.createContext(r);function a(e){const n=s.useContext(i);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:a(e.components),s.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/91008145.475388d8.js b/assets/js/91008145.475388d8.js deleted file mode 100644 index 01d140de49a..00000000000 --- a/assets/js/91008145.475388d8.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[42423],{87811:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>r,default:()=>p,frontMatter:()=>o,metadata:()=>c,toc:()=>d});var s=t(24246),i=t(71670);const o={},r="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",p:"p",strong:"strong",...(0,i.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"function-listnetworks",children:"Function: listNetworks()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"listNetworks"}),"(): ",(0,s.jsx)(n.code,{children:"Promise"}),"<",(0,s.jsx)(n.a,{href:"/api/interfaces/NetworkInspectInfo",children:(0,s.jsx)(n.code,{children:"NetworkInspectInfo"})}),"[]>"]}),"\n"]}),"\n",(0,s.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"Promise"}),"<",(0,s.jsx)(n.a,{href:"/api/interfaces/NetworkInspectInfo",children:(0,s.jsx)(n.code,{children:"NetworkInspectInfo"})}),"[]>"]}),"\n",(0,s.jsx)(n.h2,{id:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L3649",children:"packages/extension-api/src/extension-api.d.ts:3649"})})]})}function p(e={}){const{wrapper:n}={...(0,i.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>c,a:()=>r});var s=t(27378);const i={},o=s.createContext(i);function r(e){const n=s.useContext(o);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:r(e.components),s.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/91008145.a04f03c3.js b/assets/js/91008145.a04f03c3.js new file mode 100644 index 00000000000..f36de5d86e7 --- /dev/null +++ b/assets/js/91008145.a04f03c3.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[42423],{87811:(n,e,t)=>{t.r(e),t.d(e,{assets:()=>a,contentTitle:()=>r,default:()=>p,frontMatter:()=>o,metadata:()=>c,toc:()=>d});var s=t(24246),i=t(71670);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(n){const e={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,i.a)(),...n.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(e.h1,{id:"function-listnetworks",children:"Function: listNetworks()"}),"\n",(0,s.jsxs)(e.blockquote,{children:["\n",(0,s.jsxs)(e.p,{children:[(0,s.jsx)(e.strong,{children:"listNetworks"}),"(): ",(0,s.jsx)(e.code,{children:"Promise"}),"<",(0,s.jsx)(e.a,{href:"/api/interfaces/NetworkInspectInfo",children:(0,s.jsx)(e.code,{children:"NetworkInspectInfo"})}),"[]>"]}),"\n"]}),"\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/NetworkInspectInfo",children:(0,s.jsx)(e.code,{children:"NetworkInspectInfo"})}),"[]>"]}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L3649",children:"packages/extension-api/src/extension-api.d.ts:3649"})})]})}function p(n={}){const{wrapper:e}={...(0,i.a)(),...n.components};return e?(0,s.jsx)(e,{...n,children:(0,s.jsx)(l,{...n})}):l(n)}},71670:(n,e,t)=>{t.d(e,{Z:()=>c,a:()=>r});var s=t(27378);const i={},o=s.createContext(i);function r(n){const e=s.useContext(o);return s.useMemo((function(){return"function"==typeof n?n(e):{...e,...n}}),[e,n])}function c(n){let e;return e=n.disableParentContext?"function"==typeof n.components?n.components(i):n.components||i:r(n.components),s.createElement(o.Provider,{value:e},n.children)}}}]); \ No newline at end of file diff --git a/assets/js/91392348.c03d01cd.js b/assets/js/91392348.be96e172.js similarity index 97% rename from assets/js/91392348.c03d01cd.js rename to assets/js/91392348.be96e172.js index 19c06f641ad..0620257edab 100644 --- a/assets/js/91392348.c03d01cd.js +++ b/assets/js/91392348.be96e172.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[60637],{47084:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>s,default:()=>l,frontMatter:()=>o,metadata:()=>c,toc:()=>d});var r=t(24246),i=t(71670);const o={},s="Interface: UnregisterKubernetesConnectionEvent",c={id:"interfaces/UnregisterKubernetesConnectionEvent",title:"Interface: UnregisterKubernetesConnectionEvent",description:"Properties",source:"@site/api/interfaces/UnregisterKubernetesConnectionEvent.md",sourceDirName:"interfaces",slug:"/interfaces/UnregisterKubernetesConnectionEvent",permalink:"/api/interfaces/UnregisterKubernetesConnectionEvent",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"UnregisterContainerConnectionEvent",permalink:"/api/interfaces/UnregisterContainerConnectionEvent"},next:{title:"UpdateContainerConnectionEvent",permalink:"/api/interfaces/UpdateContainerConnectionEvent"}},a={},d=[{value:"Properties",id:"properties",level:2},{value:"providerId",id:"providerid",level:3},{value:"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",p:"p",strong:"strong",...(0,i.a)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.h1,{id:"interface-unregisterkubernetesconnectionevent",children:"Interface: UnregisterKubernetesConnectionEvent"}),"\n",(0,r.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,r.jsx)(n.h3,{id:"providerid",children:"providerId"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"providerId"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L691",children:"packages/extension-api/src/extension-api.d.ts:691"})})]})}function l(e={}){const{wrapper:n}={...(0,i.a)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(p,{...e})}):p(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>c,a:()=>s});var r=t(27378);const i={},o=r.createContext(i);function s(e){const n=r.useContext(o);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:s(e.components),r.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[60637],{47084:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>s,default:()=>l,frontMatter:()=>o,metadata:()=>c,toc:()=>d});var r=t(24246),i=t(71670);const o={},s="Interface: 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",p:"p",strong:"strong",...(0,i.a)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.h1,{id:"interface-unregisterkubernetesconnectionevent",children:"Interface: UnregisterKubernetesConnectionEvent"}),"\n",(0,r.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,r.jsx)(n.h3,{id:"providerid",children:"providerId"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"providerId"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L691",children:"packages/extension-api/src/extension-api.d.ts:691"})})]})}function l(e={}){const{wrapper:n}={...(0,i.a)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(p,{...e})}):p(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>c,a:()=>s});var r=t(27378);const i={},o=r.createContext(i);function s(e){const n=r.useContext(o);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:s(e.components),r.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/91fe1403.6a92cdf3.js b/assets/js/91fe1403.9755cc06.js similarity index 94% rename from assets/js/91fe1403.6a92cdf3.js rename to assets/js/91fe1403.9755cc06.js index e591a5f1a5d..a5242807d1c 100644 --- a/assets/js/91fe1403.6a92cdf3.js +++ b/assets/js/91fe1403.9755cc06.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[92916],{53968:(e,n,a)=>{a.r(n),a.d(n,{assets:()=>o,contentTitle:()=>r,default:()=>p,frontMatter:()=>t,metadata:()=>c,toc:()=>d});var i=a(24246),s=a(71670);const t={},r="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",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L4003",children:"packages/extension-api/src/extension-api.d.ts:4003"})})]})}function p(e={}){const{wrapper:n}={...(0,s.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},71670:(e,n,a)=>{a.d(n,{Z:()=>c,a:()=>r});var i=a(27378);const s={},t=i.createContext(s);function r(e){const n=i.useContext(t);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:r(e.components),i.createElement(t.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[92916],{53968:(e,n,a)=>{a.r(n),a.d(n,{assets:()=>o,contentTitle:()=>r,default:()=>p,frontMatter:()=>t,metadata:()=>c,toc:()=>d});var i=a(24246),s=a(71670);const t={},r="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",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L4003",children:"packages/extension-api/src/extension-api.d.ts:4003"})})]})}function p(e={}){const{wrapper:n}={...(0,s.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},71670:(e,n,a)=>{a.d(n,{Z:()=>c,a:()=>r});var i=a(27378);const s={},t=i.createContext(s);function r(e){const n=i.useContext(t);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:r(e.components),i.createElement(t.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/920c2ac2.6b146f65.js b/assets/js/920c2ac2.db71990c.js similarity index 93% rename from assets/js/920c2ac2.6b146f65.js rename to assets/js/920c2ac2.db71990c.js index 99a727d4ff1..a03f8e122ee 100644 --- a/assets/js/920c2ac2.6b146f65.js +++ b/assets/js/920c2ac2.db71990c.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[2281],{6207:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>r,contentTitle:()=>c,default:()=>h,frontMatter:()=>t,metadata:()=>d,toc:()=>a});var s=i(24246),l=i(71670);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:"ManifestInspectInfo",permalink:"/api/interfaces/ManifestInspectInfo"},next:{title:"MenuItem",permalink:"/api/interfaces/MenuItem"}},r={},a=[{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",hr:"hr",p:"p",strong:"strong",...(0,l.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"interface-memorystats",children:"Interface: MemoryStats"}),"\n",(0,s.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,s.jsx)(n.h3,{id:"commitbytes",children:"commitbytes?"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"optional"})," ",(0,s.jsx)(n.strong,{children:"commitbytes"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L3127",children:"packages/extension-api/src/extension-api.d.ts:3127"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L3128",children:"packages/extension-api/src/extension-api.d.ts:3128"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L3123",children:"packages/extension-api/src/extension-api.d.ts:3123"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L3124",children:"packages/extension-api/src/extension-api.d.ts:3124"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L3121",children:"packages/extension-api/src/extension-api.d.ts:3121"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L3129",children:"packages/extension-api/src/extension-api.d.ts:3129"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L3090",children:"packages/extension-api/src/extension-api.d.ts:3090"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L3122",children:"packages/extension-api/src/extension-api.d.ts:3122"})})]})}function h(e={}){const{wrapper:n}={...(0,l.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(o,{...e})}):o(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>d,a:()=>c});var s=i(27378);const l={},t=s.createContext(l);function c(e){const n=s.useContext(t);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function 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([[2281],{6207:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>a,contentTitle:()=>c,default:()=>h,frontMatter:()=>t,metadata:()=>d,toc:()=>r});var s=i(24246),l=i(71670);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:"ManifestInspectInfo",permalink:"/api/interfaces/ManifestInspectInfo"},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",hr:"hr",p:"p",strong:"strong",...(0,l.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"interface-memorystats",children:"Interface: MemoryStats"}),"\n",(0,s.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,s.jsx)(n.h3,{id:"commitbytes",children:"commitbytes?"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"optional"})," ",(0,s.jsx)(n.strong,{children:"commitbytes"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L3127",children:"packages/extension-api/src/extension-api.d.ts:3127"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L3128",children:"packages/extension-api/src/extension-api.d.ts:3128"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L3123",children:"packages/extension-api/src/extension-api.d.ts:3123"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L3124",children:"packages/extension-api/src/extension-api.d.ts:3124"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L3121",children:"packages/extension-api/src/extension-api.d.ts:3121"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L3129",children:"packages/extension-api/src/extension-api.d.ts:3129"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L3090",children:"packages/extension-api/src/extension-api.d.ts:3090"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L3122",children:"packages/extension-api/src/extension-api.d.ts:3122"})})]})}function h(e={}){const{wrapper:n}={...(0,l.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(o,{...e})}):o(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>d,a:()=>c});var s=i(27378);const l={},t=s.createContext(l);function c(e){const n=s.useContext(t);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function 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 diff --git a/assets/js/927c84a6.0deb5f84.js b/assets/js/927c84a6.0f0d693f.js similarity index 80% rename from assets/js/927c84a6.0deb5f84.js rename to assets/js/927c84a6.0f0d693f.js index 23d055c6302..ca834a7e7a9 100644 --- a/assets/js/927c84a6.0deb5f84.js +++ b/assets/js/927c84a6.0f0d693f.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[8039],{78986:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>d,contentTitle:()=>c,default:()=>h,frontMatter:()=>r,metadata:()=>o,toc:()=>a});var i=t(24246),s=t(71670);const r={},c="Interface: CheckResultFixCommand",o={id:"interfaces/CheckResultFixCommand",title:"Interface: CheckResultFixCommand",description:"Properties",source:"@site/api/interfaces/CheckResultFixCommand.md",sourceDirName:"interfaces",slug:"/interfaces/CheckResultFixCommand",permalink:"/api/interfaces/CheckResultFixCommand",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"CheckResult",permalink:"/api/interfaces/CheckResult"},next:{title:"CliTool",permalink:"/api/interfaces/CliTool"}},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",hr:"hr",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"interface-checkresultfixcommand",children:"Interface: CheckResultFixCommand"}),"\n",(0,i.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(n.h3,{id:"id",children:"id"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"id"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L519",children:"packages/extension-api/src/extension-api.d.ts:519"})}),"\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.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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L520",children:"packages/extension-api/src/extension-api.d.ts:520"})})]})}function h(e={}){const{wrapper:n}={...(0,s.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>o,a:()=>c});var i=t(27378);const s={},r=i.createContext(s);function c(e){const n=i.useContext(r);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:c(e.components),i.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[8039],{78986:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>d,contentTitle:()=>r,default:()=>h,frontMatter:()=>c,metadata:()=>o,toc:()=>a});var i=t(24246),s=t(71670);const c={},r="Interface: CheckResultFixCommand",o={id:"interfaces/CheckResultFixCommand",title:"Interface: CheckResultFixCommand",description:"Properties",source:"@site/api/interfaces/CheckResultFixCommand.md",sourceDirName:"interfaces",slug:"/interfaces/CheckResultFixCommand",permalink:"/api/interfaces/CheckResultFixCommand",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"CheckResult",permalink:"/api/interfaces/CheckResult"},next:{title:"CliTool",permalink:"/api/interfaces/CliTool"}},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",hr:"hr",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"interface-checkresultfixcommand",children:"Interface: CheckResultFixCommand"}),"\n",(0,i.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(n.h3,{id:"id",children:"id"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"id"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L519",children:"packages/extension-api/src/extension-api.d.ts:519"})}),"\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.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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L520",children:"packages/extension-api/src/extension-api.d.ts:520"})})]})}function h(e={}){const{wrapper:n}={...(0,s.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>o,a:()=>r});var i=t(27378);const s={},c=i.createContext(s);function r(e){const n=i.useContext(c);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:r(e.components),i.createElement(c.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/9286a297.01b47b04.js b/assets/js/9286a297.d65a23e5.js similarity index 96% rename from assets/js/9286a297.01b47b04.js rename to assets/js/9286a297.d65a23e5.js index 117c700e6a4..85ea4d54531 100644 --- a/assets/js/9286a297.01b47b04.js +++ b/assets/js/9286a297.d65a23e5.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[21360],{98563:(n,e,i)=>{i.r(e),i.d(e,{assets:()=>s,contentTitle:()=>r,default:()=>p,frontMatter:()=>a,metadata:()=>c,toc:()=>d});var t=i(24246),o=i(71670);const a={},r="Function: navigateToEditProviderContainerConnection()",c={id:"namespaces/navigation/functions/navigateToEditProviderContainerConnection",title:"Function: navigateToEditProviderContainerConnection()",description:"navigateToEditProviderContainerConnection(connection): Promise\\",source:"@site/api/namespaces/navigation/functions/navigateToEditProviderContainerConnection.md",sourceDirName:"namespaces/navigation/functions",slug:"/namespaces/navigation/functions/navigateToEditProviderContainerConnection",permalink:"/api/namespaces/navigation/functions/navigateToEditProviderContainerConnection",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"navigateToContribution",permalink:"/api/namespaces/navigation/functions/navigateToContribution"},next:{title:"navigateToImage",permalink:"/api/namespaces/navigation/functions/navigateToImage"}},s={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Defined in",id:"defined-in",level:2}];function l(n){const e={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,o.a)(),...n.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(e.h1,{id:"function-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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L4476",children:"packages/extension-api/src/extension-api.d.ts:4476"})})]})}function p(n={}){const{wrapper:e}={...(0,o.a)(),...n.components};return e?(0,t.jsx)(e,{...n,children:(0,t.jsx)(l,{...n})}):l(n)}},71670:(n,e,i)=>{i.d(e,{Z:()=>c,a:()=>r});var t=i(27378);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([[21360],{98563:(n,e,i)=>{i.r(e),i.d(e,{assets:()=>s,contentTitle:()=>r,default:()=>p,frontMatter:()=>a,metadata:()=>c,toc:()=>d});var t=i(24246),o=i(71670);const a={},r="Function: navigateToEditProviderContainerConnection()",c={id:"namespaces/navigation/functions/navigateToEditProviderContainerConnection",title:"Function: navigateToEditProviderContainerConnection()",description:"navigateToEditProviderContainerConnection(connection): Promise\\",source:"@site/api/namespaces/navigation/functions/navigateToEditProviderContainerConnection.md",sourceDirName:"namespaces/navigation/functions",slug:"/namespaces/navigation/functions/navigateToEditProviderContainerConnection",permalink:"/api/namespaces/navigation/functions/navigateToEditProviderContainerConnection",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"navigateToContribution",permalink:"/api/namespaces/navigation/functions/navigateToContribution"},next:{title:"navigateToImage",permalink:"/api/namespaces/navigation/functions/navigateToImage"}},s={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Defined in",id:"defined-in",level:2}];function l(n){const e={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,o.a)(),...n.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(e.h1,{id:"function-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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L4476",children:"packages/extension-api/src/extension-api.d.ts:4476"})})]})}function p(n={}){const{wrapper:e}={...(0,o.a)(),...n.components};return e?(0,t.jsx)(e,{...n,children:(0,t.jsx)(l,{...n})}):l(n)}},71670:(n,e,i)=>{i.d(e,{Z:()=>c,a:()=>r});var t=i(27378);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.7c20b017.js b/assets/js/92b08985.52899b50.js similarity index 75% rename from assets/js/92b08985.7c20b017.js rename to assets/js/92b08985.52899b50.js index 681138e9afd..a6b55f1cab0 100644 --- a/assets/js/92b08985.7c20b017.js +++ b/assets/js/92b08985.52899b50.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[57321],{3849:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>o,contentTitle:()=>r,default:()=>p,frontMatter:()=>d,metadata:()=>a,toc:()=>c});var s=i(24246),t=i(71670);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"}},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",hr:"hr",p:"p",strong:"strong",...(0,t.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"interface-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/804b2198fda0957e1ecfb87539f019eb9b79a66f/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:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/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:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/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:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/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:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L2231",children:"packages/extension-api/src/extension-api.d.ts:2231"})})]})}function p(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>a,a:()=>r});var s=i(27378);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([[57321],{3849:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>c,contentTitle:()=>r,default:()=>p,frontMatter:()=>t,metadata:()=>a,toc:()=>o});var s=i(24246),d=i(71670);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"}},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",hr:"hr",p:"p",strong:"strong",...(0,d.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{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/bd83a8b2bb8ab886dc757381b589638cbda150d0/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:"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/bd83a8b2bb8ab886dc757381b589638cbda150d0/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:"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/bd83a8b2bb8ab886dc757381b589638cbda150d0/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:"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/bd83a8b2bb8ab886dc757381b589638cbda150d0/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:"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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2231",children:"packages/extension-api/src/extension-api.d.ts:2231"})})]})}function p(e={}){const{wrapper:n}={...(0,d.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>a,a:()=>r});var s=i(27378);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 diff --git a/assets/js/92d7df62.04cd13af.js b/assets/js/92d7df62.40351446.js similarity index 95% rename from assets/js/92d7df62.04cd13af.js rename to assets/js/92d7df62.40351446.js index cf31c5711a6..ce28ac8dd54 100644 --- a/assets/js/92d7df62.04cd13af.js +++ b/assets/js/92d7df62.40351446.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[2353],{61654:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>a,contentTitle:()=>d,default:()=>l,frontMatter:()=>r,metadata:()=>c,toc:()=>o});var i=n(24246),s=n(71670);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",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L508",children:"packages/extension-api/src/extension-api.d.ts:508"})})]})}function l(e={}){const{wrapper:t}={...(0,s.a)(),...e.components};return t?(0,i.jsx)(t,{...e,children:(0,i.jsx)(u,{...e})}):u(e)}},71670:(e,t,n)=>{n.d(t,{Z:()=>c,a:()=>d});var i=n(27378);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([[2353],{61654:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>a,contentTitle:()=>d,default:()=>l,frontMatter:()=>r,metadata:()=>c,toc:()=>o});var i=n(24246),s=n(71670);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",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L508",children:"packages/extension-api/src/extension-api.d.ts:508"})})]})}function l(e={}){const{wrapper:t}={...(0,s.a)(),...e.components};return t?(0,i.jsx)(t,{...e,children:(0,i.jsx)(u,{...e})}):u(e)}},71670:(e,t,n)=>{n.d(t,{Z:()=>c,a:()=>d});var i=n(27378);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.9072374e.js b/assets/js/931e3b0a.e9c4f38e.js similarity index 93% rename from assets/js/931e3b0a.9072374e.js rename to assets/js/931e3b0a.e9c4f38e.js index b773dcc200b..3f9aafb2926 100644 --- a/assets/js/931e3b0a.9072374e.js +++ b/assets/js/931e3b0a.e9c4f38e.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[55904],{9958:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>d,contentTitle:()=>o,default:()=>l,frontMatter:()=>s,metadata:()=>c,toc:()=>a});var i=t(24246),r=t(71670);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",hr:"hr",p:"p",strong:"strong",...(0,r.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"interface-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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L2356",children:"packages/extension-api/src/extension-api.d.ts:2356"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L2357",children:"packages/extension-api/src/extension-api.d.ts:2357"})})]})}function l(e={}){const{wrapper:n}={...(0,r.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(p,{...e})}):p(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>c,a:()=>o});var i=t(27378);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 +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[55904],{9958:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>d,contentTitle:()=>o,default:()=>l,frontMatter:()=>s,metadata:()=>c,toc:()=>a});var i=t(24246),r=t(71670);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",hr:"hr",p:"p",strong:"strong",...(0,r.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"interface-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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2356",children:"packages/extension-api/src/extension-api.d.ts:2356"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2357",children:"packages/extension-api/src/extension-api.d.ts:2357"})})]})}function l(e={}){const{wrapper:n}={...(0,r.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(p,{...e})}):p(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>c,a:()=>o});var i=t(27378);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.4cd42ca9.js b/assets/js/94324b0e.573187f8.js similarity index 89% rename from assets/js/94324b0e.4cd42ca9.js rename to assets/js/94324b0e.573187f8.js index 3d6801fbaf7..b0d34951b35 100644 --- a/assets/js/94324b0e.4cd42ca9.js +++ b/assets/js/94324b0e.573187f8.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[76267],{73726:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>i,default:()=>u,frontMatter:()=>r,metadata:()=>c,toc:()=>l});var s=t(24246),o=t(71670);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={},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",p:"p",strong:"strong",...(0,o.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L3656",children:"packages/extension-api/src/extension-api.d.ts:3656"})})]})}function u(e={}){const{wrapper:n}={...(0,o.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(d,{...e})}):d(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>c,a:()=>i});var s=t(27378);const o={},r=s.createContext(o);function i(e){const n=s.useContext(r);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:i(e.components),s.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[76267],{73726:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>i,default:()=>u,frontMatter:()=>r,metadata:()=>c,toc:()=>d});var s=t(24246),o=t(71670);const r={},i="Function: 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",p:"p",strong:"strong",...(0,o.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L3656",children:"packages/extension-api/src/extension-api.d.ts:3656"})})]})}function u(e={}){const{wrapper:n}={...(0,o.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>c,a:()=>i});var s=t(27378);const o={},r=s.createContext(o);function i(e){const n=s.useContext(r);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:i(e.components),s.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/95646edb.c3e218e8.js b/assets/js/95646edb.4efc7127.js similarity index 98% rename from assets/js/95646edb.c3e218e8.js rename to assets/js/95646edb.4efc7127.js index c261e6682fc..91314f8dc0e 100644 --- a/assets/js/95646edb.c3e218e8.js +++ b/assets/js/95646edb.4efc7127.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[66e3],{81867:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>a,contentTitle:()=>c,default:()=>p,frontMatter:()=>r,metadata:()=>o,toc:()=>l});var i=s(24246),t=s(71670);const r={},c="Function: onEvent()",o={id:"namespaces/containerEngine/functions/onEvent",title:"Function: onEvent()",description:"onEvent(listener, thisArgs?, disposables?): Disposable",source:"@site/api/namespaces/containerEngine/functions/onEvent.md",sourceDirName:"namespaces/containerEngine/functions",slug:"/namespaces/containerEngine/functions/onEvent",permalink:"/api/namespaces/containerEngine/functions/onEvent",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"logsContainer",permalink:"/api/namespaces/containerEngine/functions/logsContainer"},next:{title:"pullImage",permalink:"/api/namespaces/containerEngine/functions/pullImage"}},a={},l=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Defined in",id:"defined-in",level:2}];function d(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,t.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"function-onevent",children:"Function: onEvent()"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"onEvent"}),"(",(0,i.jsx)(n.code,{children:"listener"}),", ",(0,i.jsx)(n.code,{children:"thisArgs"}),"?, ",(0,i.jsx)(n.code,{children:"disposables"}),"?): ",(0,i.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(n.code,{children:"Disposable"})})]}),"\n"]}),"\n",(0,i.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"listener"})]}),"\n",(0,i.jsx)(n.p,{children:"The listener function will be called when the event happens."}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"thisArgs?"}),": ",(0,i.jsx)(n.code,{children:"any"})]}),"\n",(0,i.jsxs)(n.p,{children:["The ",(0,i.jsx)(n.code,{children:"this"}),"-argument which will be used when calling the event listener."]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"disposables?"}),": ",(0,i.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(n.code,{children:"Disposable"})}),"[]"]}),"\n",(0,i.jsxs)(n.p,{children:["An array to which a ",(0,i.jsx)(n.a,{href:"/api/classes/Disposable",children:"Disposable"})," will be added."]}),"\n",(0,i.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(n.code,{children:"Disposable"})})}),"\n",(0,i.jsx)(n.p,{children:"A disposable which unsubscribes the event listener."}),"\n",(0,i.jsx)(n.h2,{id:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L3647",children:"packages/extension-api/src/extension-api.d.ts:3647"})})]})}function p(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(d,{...e})}):d(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>o,a:()=>c});var i=s(27378);const t={},r=i.createContext(t);function c(e){const n=i.useContext(r);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:c(e.components),i.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[66e3],{81867:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>a,contentTitle:()=>c,default:()=>p,frontMatter:()=>r,metadata:()=>o,toc:()=>l});var i=s(24246),t=s(71670);const r={},c="Function: onEvent()",o={id:"namespaces/containerEngine/functions/onEvent",title:"Function: onEvent()",description:"onEvent(listener, thisArgs?, disposables?): Disposable",source:"@site/api/namespaces/containerEngine/functions/onEvent.md",sourceDirName:"namespaces/containerEngine/functions",slug:"/namespaces/containerEngine/functions/onEvent",permalink:"/api/namespaces/containerEngine/functions/onEvent",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"logsContainer",permalink:"/api/namespaces/containerEngine/functions/logsContainer"},next:{title:"pullImage",permalink:"/api/namespaces/containerEngine/functions/pullImage"}},a={},l=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Defined in",id:"defined-in",level:2}];function d(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,t.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"function-onevent",children:"Function: onEvent()"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"onEvent"}),"(",(0,i.jsx)(n.code,{children:"listener"}),", ",(0,i.jsx)(n.code,{children:"thisArgs"}),"?, ",(0,i.jsx)(n.code,{children:"disposables"}),"?): ",(0,i.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(n.code,{children:"Disposable"})})]}),"\n"]}),"\n",(0,i.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"listener"})]}),"\n",(0,i.jsx)(n.p,{children:"The listener function will be called when the event happens."}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"thisArgs?"}),": ",(0,i.jsx)(n.code,{children:"any"})]}),"\n",(0,i.jsxs)(n.p,{children:["The ",(0,i.jsx)(n.code,{children:"this"}),"-argument which will be used when calling the event listener."]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"disposables?"}),": ",(0,i.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(n.code,{children:"Disposable"})}),"[]"]}),"\n",(0,i.jsxs)(n.p,{children:["An array to which a ",(0,i.jsx)(n.a,{href:"/api/classes/Disposable",children:"Disposable"})," will be added."]}),"\n",(0,i.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(n.code,{children:"Disposable"})})}),"\n",(0,i.jsx)(n.p,{children:"A disposable which unsubscribes the event listener."}),"\n",(0,i.jsx)(n.h2,{id:"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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L3647",children:"packages/extension-api/src/extension-api.d.ts:3647"})})]})}function p(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(d,{...e})}):d(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>o,a:()=>c});var i=s(27378);const t={},r=i.createContext(t);function c(e){const n=i.useContext(r);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:c(e.components),i.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/97c7db18.51354188.js b/assets/js/97c7db18.5ddfb558.js similarity index 82% rename from assets/js/97c7db18.51354188.js rename to assets/js/97c7db18.5ddfb558.js index 93dbbf3fd40..f941f4dac57 100644 --- a/assets/js/97c7db18.51354188.js +++ b/assets/js/97c7db18.5ddfb558.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[52343],{2610:(n,e,t)=>{t.r(e),t.d(e,{assets:()=>c,contentTitle:()=>s,default:()=>l,frontMatter:()=>o,metadata:()=>r,toc:()=>d});var i=t(24246),a=t(71670);const o={},s="Function: 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",p:"p",strong:"strong",...(0,a.a)(),...n.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(e.h1,{id:"function-navigatetocontainerinspect",children:"Function: navigateToContainerInspect()"}),"\n",(0,i.jsxs)(e.blockquote,{children:["\n",(0,i.jsxs)(e.p,{children:[(0,i.jsx)(e.strong,{children:"navigateToContainerInspect"}),"(",(0,i.jsx)(e.code,{children:"id"}),"): ",(0,i.jsx)(e.code,{children:"Promise"}),"<",(0,i.jsx)(e.code,{children:"void"}),">"]}),"\n"]}),"\n",(0,i.jsx)(e.h2,{id:"parameters",children:"Parameters"}),"\n",(0,i.jsxs)(e.p,{children:["\u2022 ",(0,i.jsx)(e.strong,{children:"id"}),": ",(0,i.jsx)(e.code,{children:"string"})]}),"\n",(0,i.jsx)(e.h2,{id:"returns",children:"Returns"}),"\n",(0,i.jsxs)(e.p,{children:[(0,i.jsx)(e.code,{children:"Promise"}),"<",(0,i.jsx)(e.code,{children:"void"}),">"]}),"\n",(0,i.jsx)(e.h2,{id:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L4434",children:"packages/extension-api/src/extension-api.d.ts:4434"})})]})}function l(n={}){const{wrapper:e}={...(0,a.a)(),...n.components};return e?(0,i.jsx)(e,{...n,children:(0,i.jsx)(p,{...n})}):p(n)}},71670:(n,e,t)=>{t.d(e,{Z:()=>r,a:()=>s});var i=t(27378);const a={},o=i.createContext(a);function s(n){const e=i.useContext(o);return i.useMemo((function(){return"function"==typeof n?n(e):{...e,...n}}),[e,n])}function r(n){let e;return e=n.disableParentContext?"function"==typeof n.components?n.components(a):n.components||a:s(n.components),i.createElement(o.Provider,{value:e},n.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[52343],{2610:(n,e,t)=>{t.r(e),t.d(e,{assets:()=>r,contentTitle:()=>s,default:()=>l,frontMatter:()=>o,metadata:()=>c,toc:()=>d});var i=t(24246),a=t(71670);const o={},s="Function: navigateToContainerInspect()",c={id:"namespaces/navigation/functions/navigateToContainerInspect",title:"Function: navigateToContainerInspect()",description:"navigateToContainerInspect(id): Promise\\",source:"@site/api/namespaces/navigation/functions/navigateToContainerInspect.md",sourceDirName:"namespaces/navigation/functions",slug:"/namespaces/navigation/functions/navigateToContainerInspect",permalink:"/api/namespaces/navigation/functions/navigateToContainerInspect",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"navigateToContainer",permalink:"/api/namespaces/navigation/functions/navigateToContainer"},next:{title:"navigateToContainerLogs",permalink:"/api/namespaces/navigation/functions/navigateToContainerLogs"}},r={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Defined in",id:"defined-in",level:2}];function p(n){const e={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,a.a)(),...n.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(e.h1,{id:"function-navigatetocontainerinspect",children:"Function: navigateToContainerInspect()"}),"\n",(0,i.jsxs)(e.blockquote,{children:["\n",(0,i.jsxs)(e.p,{children:[(0,i.jsx)(e.strong,{children:"navigateToContainerInspect"}),"(",(0,i.jsx)(e.code,{children:"id"}),"): ",(0,i.jsx)(e.code,{children:"Promise"}),"<",(0,i.jsx)(e.code,{children:"void"}),">"]}),"\n"]}),"\n",(0,i.jsx)(e.h2,{id:"parameters",children:"Parameters"}),"\n",(0,i.jsxs)(e.p,{children:["\u2022 ",(0,i.jsx)(e.strong,{children:"id"}),": ",(0,i.jsx)(e.code,{children:"string"})]}),"\n",(0,i.jsx)(e.h2,{id:"returns",children:"Returns"}),"\n",(0,i.jsxs)(e.p,{children:[(0,i.jsx)(e.code,{children:"Promise"}),"<",(0,i.jsx)(e.code,{children:"void"}),">"]}),"\n",(0,i.jsx)(e.h2,{id:"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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L4434",children:"packages/extension-api/src/extension-api.d.ts:4434"})})]})}function l(n={}){const{wrapper:e}={...(0,a.a)(),...n.components};return e?(0,i.jsx)(e,{...n,children:(0,i.jsx)(p,{...n})}):p(n)}},71670:(n,e,t)=>{t.d(e,{Z:()=>c,a:()=>s});var i=t(27378);const a={},o=i.createContext(a);function s(n){const e=i.useContext(o);return i.useMemo((function(){return"function"==typeof n?n(e):{...e,...n}}),[e,n])}function c(n){let e;return e=n.disableParentContext?"function"==typeof n.components?n.components(a):n.components||a:s(n.components),i.createElement(o.Provider,{value:e},n.children)}}}]); \ No newline at end of file diff --git a/assets/js/97d49594.f5096d46.js b/assets/js/97d49594.9a305d41.js similarity index 96% rename from assets/js/97d49594.f5096d46.js rename to assets/js/97d49594.9a305d41.js index 9d73dd6f806..3f16cc506c3 100644 --- a/assets/js/97d49594.f5096d46.js +++ b/assets/js/97d49594.9a305d41.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[45708],{42200:(n,e,i)=>{i.r(e),i.d(e,{assets:()=>a,contentTitle:()=>o,default:()=>l,frontMatter:()=>r,metadata:()=>c,toc:()=>d});var t=i(24246),s=i(71670);const r={},o="Function: inspectContainer()",c={id:"namespaces/containerEngine/functions/inspectContainer",title:"Function: inspectContainer()",description:"inspectContainer(engineId, id): Promise\\",source:"@site/api/namespaces/containerEngine/functions/inspectContainer.md",sourceDirName:"namespaces/containerEngine/functions",slug:"/namespaces/containerEngine/functions/inspectContainer",permalink:"/api/namespaces/containerEngine/functions/inspectContainer",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"info",permalink:"/api/namespaces/containerEngine/functions/info"},next:{title:"inspectManifest",permalink:"/api/namespaces/containerEngine/functions/inspectManifest"}},a={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Defined in",id:"defined-in",level:2}];function p(n){const e={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,s.a)(),...n.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(e.h1,{id:"function-inspectcontainer",children:"Function: inspectContainer()"}),"\n",(0,t.jsxs)(e.blockquote,{children:["\n",(0,t.jsxs)(e.p,{children:[(0,t.jsx)(e.strong,{children:"inspectContainer"}),"(",(0,t.jsx)(e.code,{children:"engineId"}),", ",(0,t.jsx)(e.code,{children:"id"}),"): ",(0,t.jsx)(e.code,{children:"Promise"}),"<",(0,t.jsx)(e.a,{href:"/api/interfaces/ContainerInspectInfo",children:(0,t.jsx)(e.code,{children:"ContainerInspectInfo"})}),">"]}),"\n"]}),"\n",(0,t.jsx)(e.p,{children:"Get the complete low-level information about a specific container."}),"\n",(0,t.jsx)(e.h2,{id:"parameters",children:"Parameters"}),"\n",(0,t.jsxs)(e.p,{children:["\u2022 ",(0,t.jsx)(e.strong,{children:"engineId"}),": ",(0,t.jsx)(e.code,{children:"string"})]}),"\n",(0,t.jsxs)(e.p,{children:["the id of the engine managing the container, obtained from the result of ",(0,t.jsx)(e.a,{href:"/api/namespaces/containerEngine/functions/listContainers",children:"containerEngine.listContainers"})]}),"\n",(0,t.jsxs)(e.p,{children:["\u2022 ",(0,t.jsx)(e.strong,{children:"id"}),": ",(0,t.jsx)(e.code,{children:"string"})]}),"\n",(0,t.jsxs)(e.p,{children:["the id or name of the container on this engine, obtained from the result of ",(0,t.jsx)(e.a,{href:"/api/namespaces/containerEngine/functions/listContainers",children:"containerEngine.listContainers"})," or as the result of ",(0,t.jsx)(e.a,{href:"/api/namespaces/containerEngine/functions/createContainer",children:"containerEngine.createContainer"})]}),"\n",(0,t.jsx)(e.h2,{id:"returns",children:"Returns"}),"\n",(0,t.jsxs)(e.p,{children:[(0,t.jsx)(e.code,{children:"Promise"}),"<",(0,t.jsx)(e.a,{href:"/api/interfaces/ContainerInspectInfo",children:(0,t.jsx)(e.code,{children:"ContainerInspectInfo"})}),">"]}),"\n",(0,t.jsx)(e.p,{children:"A promise resolving to a structure containing the container information"}),"\n",(0,t.jsx)(e.h2,{id:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L3452",children:"packages/extension-api/src/extension-api.d.ts:3452"})})]})}function l(n={}){const{wrapper:e}={...(0,s.a)(),...n.components};return e?(0,t.jsx)(e,{...n,children:(0,t.jsx)(p,{...n})}):p(n)}},71670:(n,e,i)=>{i.d(e,{Z:()=>c,a:()=>o});var t=i(27378);const s={},r=t.createContext(s);function o(n){const e=t.useContext(r);return t.useMemo((function(){return"function"==typeof n?n(e):{...e,...n}}),[e,n])}function c(n){let e;return e=n.disableParentContext?"function"==typeof n.components?n.components(s):n.components||s:o(n.components),t.createElement(r.Provider,{value:e},n.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[45708],{42200:(n,e,i)=>{i.r(e),i.d(e,{assets:()=>a,contentTitle:()=>o,default:()=>l,frontMatter:()=>r,metadata:()=>c,toc:()=>d});var t=i(24246),s=i(71670);const r={},o="Function: inspectContainer()",c={id:"namespaces/containerEngine/functions/inspectContainer",title:"Function: inspectContainer()",description:"inspectContainer(engineId, id): Promise\\",source:"@site/api/namespaces/containerEngine/functions/inspectContainer.md",sourceDirName:"namespaces/containerEngine/functions",slug:"/namespaces/containerEngine/functions/inspectContainer",permalink:"/api/namespaces/containerEngine/functions/inspectContainer",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"info",permalink:"/api/namespaces/containerEngine/functions/info"},next:{title:"inspectManifest",permalink:"/api/namespaces/containerEngine/functions/inspectManifest"}},a={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Defined in",id:"defined-in",level:2}];function p(n){const e={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,s.a)(),...n.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(e.h1,{id:"function-inspectcontainer",children:"Function: inspectContainer()"}),"\n",(0,t.jsxs)(e.blockquote,{children:["\n",(0,t.jsxs)(e.p,{children:[(0,t.jsx)(e.strong,{children:"inspectContainer"}),"(",(0,t.jsx)(e.code,{children:"engineId"}),", ",(0,t.jsx)(e.code,{children:"id"}),"): ",(0,t.jsx)(e.code,{children:"Promise"}),"<",(0,t.jsx)(e.a,{href:"/api/interfaces/ContainerInspectInfo",children:(0,t.jsx)(e.code,{children:"ContainerInspectInfo"})}),">"]}),"\n"]}),"\n",(0,t.jsx)(e.p,{children:"Get the complete low-level information about a specific container."}),"\n",(0,t.jsx)(e.h2,{id:"parameters",children:"Parameters"}),"\n",(0,t.jsxs)(e.p,{children:["\u2022 ",(0,t.jsx)(e.strong,{children:"engineId"}),": ",(0,t.jsx)(e.code,{children:"string"})]}),"\n",(0,t.jsxs)(e.p,{children:["the id of the engine managing the container, obtained from the result of ",(0,t.jsx)(e.a,{href:"/api/namespaces/containerEngine/functions/listContainers",children:"containerEngine.listContainers"})]}),"\n",(0,t.jsxs)(e.p,{children:["\u2022 ",(0,t.jsx)(e.strong,{children:"id"}),": ",(0,t.jsx)(e.code,{children:"string"})]}),"\n",(0,t.jsxs)(e.p,{children:["the id or name of the container on this engine, obtained from the result of ",(0,t.jsx)(e.a,{href:"/api/namespaces/containerEngine/functions/listContainers",children:"containerEngine.listContainers"})," or as the result of ",(0,t.jsx)(e.a,{href:"/api/namespaces/containerEngine/functions/createContainer",children:"containerEngine.createContainer"})]}),"\n",(0,t.jsx)(e.h2,{id:"returns",children:"Returns"}),"\n",(0,t.jsxs)(e.p,{children:[(0,t.jsx)(e.code,{children:"Promise"}),"<",(0,t.jsx)(e.a,{href:"/api/interfaces/ContainerInspectInfo",children:(0,t.jsx)(e.code,{children:"ContainerInspectInfo"})}),">"]}),"\n",(0,t.jsx)(e.p,{children:"A promise resolving to a structure containing the container information"}),"\n",(0,t.jsx)(e.h2,{id:"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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L3452",children:"packages/extension-api/src/extension-api.d.ts:3452"})})]})}function l(n={}){const{wrapper:e}={...(0,s.a)(),...n.components};return e?(0,t.jsx)(e,{...n,children:(0,t.jsx)(p,{...n})}):p(n)}},71670:(n,e,i)=>{i.d(e,{Z:()=>c,a:()=>o});var t=i(27378);const s={},r=t.createContext(s);function o(n){const e=t.useContext(r);return t.useMemo((function(){return"function"==typeof n?n(e):{...e,...n}}),[e,n])}function c(n){let e;return e=n.disableParentContext?"function"==typeof n.components?n.components(s):n.components||s:o(n.components),t.createElement(r.Provider,{value:e},n.children)}}}]); \ No newline at end of file diff --git a/assets/js/97eb992d.a1d552e6.js b/assets/js/97eb992d.a1d552e6.js new file mode 100644 index 00000000000..7a103a52ba8 --- /dev/null +++ b/assets/js/97eb992d.a1d552e6.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[53800],{85506:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>a,contentTitle:()=>r,default:()=>h,frontMatter:()=>c,metadata:()=>t,toc:()=>o});var d=i(24246),s=i(71670);const c={},r="Interface: NetworkInspectInfo",t={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"}},a={},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",hr:"hr",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,d.jsxs)(d.Fragment,{children:[(0,d.jsx)(n.h1,{id:"interface-networkinspectinfo",children:"Interface: NetworkInspectInfo"}),"\n",(0,d.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,d.jsx)(n.h3,{id:"attachable",children:"Attachable"}),"\n",(0,d.jsxs)(n.blockquote,{children:["\n",(0,d.jsxs)(n.p,{children:[(0,d.jsx)(n.strong,{children:"Attachable"}),": ",(0,d.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2256",children:"packages/extension-api/src/extension-api.d.ts:2256"})}),"\n",(0,d.jsx)(n.hr,{}),"\n",(0,d.jsx)(n.h3,{id:"configfrom",children:"ConfigFrom?"}),"\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:"ConfigFrom"}),": ",(0,d.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,d.jsx)(n.h4,{id:"network",children:"Network"}),"\n",(0,d.jsxs)(n.blockquote,{children:["\n",(0,d.jsxs)(n.p,{children:[(0,d.jsx)(n.strong,{children:"Network"}),": ",(0,d.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,d.jsx)(n.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,d.jsx)(n.p,{children:(0,d.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2258",children:"packages/extension-api/src/extension-api.d.ts:2258"})}),"\n",(0,d.jsx)(n.hr,{}),"\n",(0,d.jsx)(n.h3,{id:"configonly",children:"ConfigOnly"}),"\n",(0,d.jsxs)(n.blockquote,{children:["\n",(0,d.jsxs)(n.p,{children:[(0,d.jsx)(n.strong,{children:"ConfigOnly"}),": ",(0,d.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2259",children:"packages/extension-api/src/extension-api.d.ts:2259"})}),"\n",(0,d.jsx)(n.hr,{}),"\n",(0,d.jsx)(n.h3,{id:"containers",children:"Containers?"}),"\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:"Containers"}),": ",(0,d.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,d.jsx)(n.h4,{id:"index-signature",children:"Index Signature"}),"\n",(0,d.jsxs)(n.p,{children:["[",(0,d.jsx)(n.code,{children:"id"}),": ",(0,d.jsx)(n.code,{children:"string"}),"]: ",(0,d.jsx)(n.a,{href:"/api/interfaces/NetworkContainer",children:(0,d.jsx)(n.code,{children:"NetworkContainer"})})]}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2260",children:"packages/extension-api/src/extension-api.d.ts:2260"})}),"\n",(0,d.jsx)(n.hr,{}),"\n",(0,d.jsx)(n.h3,{id:"created",children:"Created"}),"\n",(0,d.jsxs)(n.blockquote,{children:["\n",(0,d.jsxs)(n.p,{children:[(0,d.jsx)(n.strong,{children:"Created"}),": ",(0,d.jsx)(n.code,{children:"string"})]}),"\n"]}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2250",children:"packages/extension-api/src/extension-api.d.ts:2250"})}),"\n",(0,d.jsx)(n.hr,{}),"\n",(0,d.jsx)(n.h3,{id:"driver",children:"Driver"}),"\n",(0,d.jsxs)(n.blockquote,{children:["\n",(0,d.jsxs)(n.p,{children:[(0,d.jsx)(n.strong,{children:"Driver"}),": ",(0,d.jsx)(n.code,{children:"string"})]}),"\n"]}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2252",children:"packages/extension-api/src/extension-api.d.ts:2252"})}),"\n",(0,d.jsx)(n.hr,{}),"\n",(0,d.jsx)(n.h3,{id:"enableipv6",children:"EnableIPv6"}),"\n",(0,d.jsxs)(n.blockquote,{children:["\n",(0,d.jsxs)(n.p,{children:[(0,d.jsx)(n.strong,{children:"EnableIPv6"}),": ",(0,d.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,d.jsx)(n.h4,{id:"defined-in-6",children:"Defined in"}),"\n",(0,d.jsx)(n.p,{children:(0,d.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2253",children:"packages/extension-api/src/extension-api.d.ts:2253"})}),"\n",(0,d.jsx)(n.hr,{}),"\n",(0,d.jsx)(n.h3,{id:"ipam",children:"IPAM?"}),"\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:"IPAM"}),": ",(0,d.jsx)(n.a,{href:"/api/interfaces/IPAM",children:(0,d.jsx)(n.code,{children:"IPAM"})})]}),"\n"]}),"\n",(0,d.jsx)(n.h4,{id:"defined-in-7",children:"Defined in"}),"\n",(0,d.jsx)(n.p,{children:(0,d.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2254",children:"packages/extension-api/src/extension-api.d.ts:2254"})}),"\n",(0,d.jsx)(n.hr,{}),"\n",(0,d.jsx)(n.h3,{id:"id",children:"Id"}),"\n",(0,d.jsxs)(n.blockquote,{children:["\n",(0,d.jsxs)(n.p,{children:[(0,d.jsx)(n.strong,{children:"Id"}),": ",(0,d.jsx)(n.code,{children:"string"})]}),"\n"]}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2249",children:"packages/extension-api/src/extension-api.d.ts:2249"})}),"\n",(0,d.jsx)(n.hr,{}),"\n",(0,d.jsx)(n.h3,{id:"ingress",children:"Ingress"}),"\n",(0,d.jsxs)(n.blockquote,{children:["\n",(0,d.jsxs)(n.p,{children:[(0,d.jsx)(n.strong,{children:"Ingress"}),": ",(0,d.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2257",children:"packages/extension-api/src/extension-api.d.ts:2257"})}),"\n",(0,d.jsx)(n.hr,{}),"\n",(0,d.jsx)(n.h3,{id:"internal",children:"Internal"}),"\n",(0,d.jsxs)(n.blockquote,{children:["\n",(0,d.jsxs)(n.p,{children:[(0,d.jsx)(n.strong,{children:"Internal"}),": ",(0,d.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,d.jsx)(n.h4,{id:"defined-in-10",children:"Defined in"}),"\n",(0,d.jsx)(n.p,{children:(0,d.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2255",children:"packages/extension-api/src/extension-api.d.ts:2255"})}),"\n",(0,d.jsx)(n.hr,{}),"\n",(0,d.jsx)(n.h3,{id:"labels",children:"Labels?"}),"\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:"Labels"}),": ",(0,d.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,d.jsx)(n.h4,{id:"index-signature-1",children:"Index Signature"}),"\n",(0,d.jsxs)(n.p,{children:["[",(0,d.jsx)(n.code,{children:"key"}),": ",(0,d.jsx)(n.code,{children:"string"}),"]: ",(0,d.jsx)(n.code,{children:"string"})]}),"\n",(0,d.jsx)(n.h4,{id:"defined-in-11",children:"Defined in"}),"\n",(0,d.jsx)(n.p,{children:(0,d.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2262",children:"packages/extension-api/src/extension-api.d.ts:2262"})}),"\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:"defined-in-12",children:"Defined in"}),"\n",(0,d.jsx)(n.p,{children:(0,d.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2248",children:"packages/extension-api/src/extension-api.d.ts:2248"})}),"\n",(0,d.jsx)(n.hr,{}),"\n",(0,d.jsx)(n.h3,{id:"options",children:"Options?"}),"\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:"Options"}),": ",(0,d.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,d.jsx)(n.h4,{id:"index-signature-2",children:"Index Signature"}),"\n",(0,d.jsxs)(n.p,{children:["[",(0,d.jsx)(n.code,{children:"key"}),": ",(0,d.jsx)(n.code,{children:"string"}),"]: ",(0,d.jsx)(n.code,{children:"string"})]}),"\n",(0,d.jsx)(n.h4,{id:"defined-in-13",children:"Defined in"}),"\n",(0,d.jsx)(n.p,{children:(0,d.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2261",children:"packages/extension-api/src/extension-api.d.ts:2261"})}),"\n",(0,d.jsx)(n.hr,{}),"\n",(0,d.jsx)(n.h3,{id:"scope",children:"Scope"}),"\n",(0,d.jsxs)(n.blockquote,{children:["\n",(0,d.jsxs)(n.p,{children:[(0,d.jsx)(n.strong,{children:"Scope"}),": ",(0,d.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,d.jsx)(n.h4,{id:"defined-in-14",children:"Defined in"}),"\n",(0,d.jsx)(n.p,{children:(0,d.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2251",children:"packages/extension-api/src/extension-api.d.ts:2251"})}),"\n",(0,d.jsx)(n.hr,{}),"\n",(0,d.jsx)(n.h3,{id:"engineid",children:"engineId"}),"\n",(0,d.jsxs)(n.blockquote,{children:["\n",(0,d.jsxs)(n.p,{children:[(0,d.jsx)(n.strong,{children:"engineId"}),": ",(0,d.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,d.jsx)(n.h4,{id:"defined-in-15",children:"Defined in"}),"\n",(0,d.jsx)(n.p,{children:(0,d.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2245",children:"packages/extension-api/src/extension-api.d.ts:2245"})}),"\n",(0,d.jsx)(n.hr,{}),"\n",(0,d.jsx)(n.h3,{id:"enginename",children:"engineName"}),"\n",(0,d.jsxs)(n.blockquote,{children:["\n",(0,d.jsxs)(n.p,{children:[(0,d.jsx)(n.strong,{children:"engineName"}),": ",(0,d.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,d.jsx)(n.h4,{id:"defined-in-16",children:"Defined in"}),"\n",(0,d.jsx)(n.p,{children:(0,d.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2246",children:"packages/extension-api/src/extension-api.d.ts:2246"})}),"\n",(0,d.jsx)(n.hr,{}),"\n",(0,d.jsx)(n.h3,{id:"enginetype",children:"engineType"}),"\n",(0,d.jsxs)(n.blockquote,{children:["\n",(0,d.jsxs)(n.p,{children:[(0,d.jsx)(n.strong,{children:"engineType"}),": ",(0,d.jsx)(n.code,{children:'"docker"'})," | ",(0,d.jsx)(n.code,{children:'"podman"'})]}),"\n"]}),"\n",(0,d.jsx)(n.h4,{id:"defined-in-17",children:"Defined in"}),"\n",(0,d.jsx)(n.p,{children:(0,d.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2247",children:"packages/extension-api/src/extension-api.d.ts:2247"})})]})}function h(e={}){const{wrapper:n}={...(0,s.a)(),...e.components};return n?(0,d.jsx)(n,{...e,children:(0,d.jsx)(l,{...e})}):l(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>t,a:()=>r});var d=i(27378);const s={},c=d.createContext(s);function r(e){const n=d.useContext(c);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:r(e.components),d.createElement(c.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/97eb992d.d43ab5f8.js b/assets/js/97eb992d.d43ab5f8.js deleted file mode 100644 index 8ad80f66089..00000000000 --- a/assets/js/97eb992d.d43ab5f8.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[53800],{85506:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>a,contentTitle:()=>r,default:()=>h,frontMatter:()=>c,metadata:()=>t,toc:()=>o});var s=i(24246),d=i(71670);const c={},r="Interface: NetworkInspectInfo",t={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"}},a={},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",hr:"hr",p:"p",strong:"strong",...(0,d.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L2256",children:"packages/extension-api/src/extension-api.d.ts:2256"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L2258",children:"packages/extension-api/src/extension-api.d.ts:2258"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/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:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/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:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L2250",children:"packages/extension-api/src/extension-api.d.ts:2250"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/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:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/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:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/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:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L2249",children:"packages/extension-api/src/extension-api.d.ts:2249"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L2257",children:"packages/extension-api/src/extension-api.d.ts:2257"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/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:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L2262",children:"packages/extension-api/src/extension-api.d.ts:2262"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L2248",children:"packages/extension-api/src/extension-api.d.ts:2248"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L2261",children:"packages/extension-api/src/extension-api.d.ts:2261"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L2251",children:"packages/extension-api/src/extension-api.d.ts:2251"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L2245",children:"packages/extension-api/src/extension-api.d.ts:2245"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L2246",children:"packages/extension-api/src/extension-api.d.ts:2246"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L2247",children:"packages/extension-api/src/extension-api.d.ts:2247"})})]})}function h(e={}){const{wrapper:n}={...(0,d.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>t,a:()=>r});var s=i(27378);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 t(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/98ced590.3c9cb8c9.js b/assets/js/98ced590.d78d3adf.js similarity index 97% rename from assets/js/98ced590.3c9cb8c9.js rename to assets/js/98ced590.d78d3adf.js index 8a85614acc4..a2061706eb4 100644 --- a/assets/js/98ced590.3c9cb8c9.js +++ b/assets/js/98ced590.d78d3adf.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[80325],{62282:(n,e,i)=>{i.r(e),i.d(e,{assets:()=>c,contentTitle:()=>s,default:()=>u,frontMatter:()=>o,metadata:()=>r,toc:()=>d});var t=i(24246),a=i(71670);const o={},s="Function: navigateToContainerTerminal()",r={id:"namespaces/navigation/functions/navigateToContainerTerminal",title:"Function: navigateToContainerTerminal()",description:"navigateToContainerTerminal(id): Promise\\",source:"@site/api/namespaces/navigation/functions/navigateToContainerTerminal.md",sourceDirName:"namespaces/navigation/functions",slug:"/namespaces/navigation/functions/navigateToContainerTerminal",permalink:"/api/namespaces/navigation/functions/navigateToContainerTerminal",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"navigateToContainerLogs",permalink:"/api/namespaces/navigation/functions/navigateToContainerLogs"},next:{title:"navigateToContainers",permalink:"/api/namespaces/navigation/functions/navigateToContainers"}},c={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Defined in",id:"defined-in",level:2}];function l(n){const e={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,a.a)(),...n.components};return(0,t.jsxs)(t.Fragment,{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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L4436",children:"packages/extension-api/src/extension-api.d.ts:4436"})})]})}function u(n={}){const{wrapper:e}={...(0,a.a)(),...n.components};return e?(0,t.jsx)(e,{...n,children:(0,t.jsx)(l,{...n})}):l(n)}},71670:(n,e,i)=>{i.d(e,{Z:()=>r,a:()=>s});var t=i(27378);const a={},o=t.createContext(a);function s(n){const e=t.useContext(o);return t.useMemo((function(){return"function"==typeof n?n(e):{...e,...n}}),[e,n])}function r(n){let e;return e=n.disableParentContext?"function"==typeof n.components?n.components(a):n.components||a:s(n.components),t.createElement(o.Provider,{value:e},n.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[80325],{62282:(n,e,i)=>{i.r(e),i.d(e,{assets:()=>c,contentTitle:()=>s,default:()=>u,frontMatter:()=>o,metadata:()=>r,toc:()=>d});var t=i(24246),a=i(71670);const o={},s="Function: navigateToContainerTerminal()",r={id:"namespaces/navigation/functions/navigateToContainerTerminal",title:"Function: navigateToContainerTerminal()",description:"navigateToContainerTerminal(id): Promise\\",source:"@site/api/namespaces/navigation/functions/navigateToContainerTerminal.md",sourceDirName:"namespaces/navigation/functions",slug:"/namespaces/navigation/functions/navigateToContainerTerminal",permalink:"/api/namespaces/navigation/functions/navigateToContainerTerminal",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"navigateToContainerLogs",permalink:"/api/namespaces/navigation/functions/navigateToContainerLogs"},next:{title:"navigateToContainers",permalink:"/api/namespaces/navigation/functions/navigateToContainers"}},c={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Defined in",id:"defined-in",level:2}];function l(n){const e={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,a.a)(),...n.components};return(0,t.jsxs)(t.Fragment,{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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L4436",children:"packages/extension-api/src/extension-api.d.ts:4436"})})]})}function u(n={}){const{wrapper:e}={...(0,a.a)(),...n.components};return e?(0,t.jsx)(e,{...n,children:(0,t.jsx)(l,{...n})}):l(n)}},71670:(n,e,i)=>{i.d(e,{Z:()=>r,a:()=>s});var t=i(27378);const a={},o=t.createContext(a);function s(n){const e=t.useContext(o);return t.useMemo((function(){return"function"==typeof n?n(e):{...e,...n}}),[e,n])}function r(n){let e;return e=n.disableParentContext?"function"==typeof n.components?n.components(a):n.components||a:s(n.components),t.createElement(o.Provider,{value:e},n.children)}}}]); \ No newline at end of file diff --git a/assets/js/9a22c80d.38443f95.js b/assets/js/9a22c80d.2605919f.js similarity index 94% rename from assets/js/9a22c80d.38443f95.js rename to assets/js/9a22c80d.2605919f.js index 91d3e5ed840..4493c0c0d37 100644 --- a/assets/js/9a22c80d.38443f95.js +++ b/assets/js/9a22c80d.2605919f.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[92428],{284:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>c,contentTitle:()=>o,default:()=>p,frontMatter:()=>i,metadata:()=>r,toc:()=>l});var t=s(24246),a=s(71670);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",p:"p",strong:"strong",...(0,a.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"variable-all",children:"Variable: all"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"const"})," ",(0,t.jsx)(n.strong,{children:"all"}),": readonly ",(0,t.jsx)(n.a,{href:"/api/interfaces/Extension",children:(0,t.jsx)(n.code,{children:"Extension"})}),"<",(0,t.jsx)(n.code,{children:"any"}),">[]"]}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"All extensions currently known to the system."}),"\n",(0,t.jsx)(n.h2,{id:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L240",children:"packages/extension-api/src/extension-api.d.ts:240"})})]})}function p(e={}){const{wrapper:n}={...(0,a.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(d,{...e})}):d(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>r,a:()=>o});var t=s(27378);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([[92428],{284:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>c,contentTitle:()=>o,default:()=>p,frontMatter:()=>i,metadata:()=>r,toc:()=>l});var t=s(24246),a=s(71670);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",p:"p",strong:"strong",...(0,a.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"variable-all",children:"Variable: all"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"const"})," ",(0,t.jsx)(n.strong,{children:"all"}),": readonly ",(0,t.jsx)(n.a,{href:"/api/interfaces/Extension",children:(0,t.jsx)(n.code,{children:"Extension"})}),"<",(0,t.jsx)(n.code,{children:"any"}),">[]"]}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"All extensions currently known to the system."}),"\n",(0,t.jsx)(n.h2,{id:"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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L240",children:"packages/extension-api/src/extension-api.d.ts:240"})})]})}function p(e={}){const{wrapper:n}={...(0,a.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(d,{...e})}):d(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>r,a:()=>o});var t=s(27378);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.b5dd8b79.js b/assets/js/9af13eab.b21bd9d9.js similarity index 97% rename from assets/js/9af13eab.b5dd8b79.js rename to assets/js/9af13eab.b21bd9d9.js index d760d3744b0..28daafca9e8 100644 --- a/assets/js/9af13eab.b5dd8b79.js +++ b/assets/js/9af13eab.b21bd9d9.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[45033],{11573:(n,e,t)=>{t.r(e),t.d(e,{assets:()=>a,contentTitle:()=>s,default:()=>u,frontMatter:()=>r,metadata:()=>c,toc:()=>d});var o=t(24246),i=t(71670);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(n){const e={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,i.a)(),...n.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(e.h1,{id:"function-getcontainerconnections",children:"Function: getContainerConnections()"}),"\n",(0,o.jsxs)(e.blockquote,{children:["\n",(0,o.jsxs)(e.p,{children:[(0,o.jsx)(e.strong,{children:"getContainerConnections"}),"(): ",(0,o.jsx)(e.a,{href:"/api/interfaces/ProviderContainerConnection",children:(0,o.jsx)(e.code,{children:"ProviderContainerConnection"})}),"[]"]}),"\n"]}),"\n",(0,o.jsx)(e.h2,{id:"returns",children:"Returns"}),"\n",(0,o.jsxs)(e.p,{children:[(0,o.jsx)(e.a,{href:"/api/interfaces/ProviderContainerConnection",children:(0,o.jsx)(e.code,{children:"ProviderContainerConnection"})}),"[]"]}),"\n",(0,o.jsx)(e.h2,{id:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L816",children:"packages/extension-api/src/extension-api.d.ts:816"})})]})}function u(n={}){const{wrapper:e}={...(0,i.a)(),...n.components};return e?(0,o.jsx)(e,{...n,children:(0,o.jsx)(p,{...n})}):p(n)}},71670:(n,e,t)=>{t.d(e,{Z:()=>c,a:()=>s});var o=t(27378);const i={},r=o.createContext(i);function s(n){const e=o.useContext(r);return o.useMemo((function(){return"function"==typeof n?n(e):{...e,...n}}),[e,n])}function c(n){let e;return e=n.disableParentContext?"function"==typeof n.components?n.components(i):n.components||i:s(n.components),o.createElement(r.Provider,{value:e},n.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[45033],{11573:(n,e,t)=>{t.r(e),t.d(e,{assets:()=>a,contentTitle:()=>s,default:()=>u,frontMatter:()=>r,metadata:()=>c,toc:()=>d});var o=t(24246),i=t(71670);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(n){const e={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,i.a)(),...n.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(e.h1,{id:"function-getcontainerconnections",children:"Function: getContainerConnections()"}),"\n",(0,o.jsxs)(e.blockquote,{children:["\n",(0,o.jsxs)(e.p,{children:[(0,o.jsx)(e.strong,{children:"getContainerConnections"}),"(): ",(0,o.jsx)(e.a,{href:"/api/interfaces/ProviderContainerConnection",children:(0,o.jsx)(e.code,{children:"ProviderContainerConnection"})}),"[]"]}),"\n"]}),"\n",(0,o.jsx)(e.h2,{id:"returns",children:"Returns"}),"\n",(0,o.jsxs)(e.p,{children:[(0,o.jsx)(e.a,{href:"/api/interfaces/ProviderContainerConnection",children:(0,o.jsx)(e.code,{children:"ProviderContainerConnection"})}),"[]"]}),"\n",(0,o.jsx)(e.h2,{id:"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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L816",children:"packages/extension-api/src/extension-api.d.ts:816"})})]})}function u(n={}){const{wrapper:e}={...(0,i.a)(),...n.components};return e?(0,o.jsx)(e,{...n,children:(0,o.jsx)(p,{...n})}):p(n)}},71670:(n,e,t)=>{t.d(e,{Z:()=>c,a:()=>s});var o=t(27378);const i={},r=o.createContext(i);function s(n){const e=o.useContext(r);return o.useMemo((function(){return"function"==typeof n?n(e):{...e,...n}}),[e,n])}function c(n){let e;return e=n.disableParentContext?"function"==typeof n.components?n.components(i):n.components||i:s(n.components),o.createElement(r.Provider,{value:e},n.children)}}}]); \ No newline at end of file diff --git a/assets/js/9c540f0b.6a11107c.js b/assets/js/9c540f0b.cd75314b.js similarity index 89% rename from assets/js/9c540f0b.6a11107c.js rename to assets/js/9c540f0b.cd75314b.js index 8ced036254e..9cb427b2cee 100644 --- a/assets/js/9c540f0b.6a11107c.js +++ b/assets/js/9c540f0b.cd75314b.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[14026],{99460:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>c,contentTitle:()=>t,default:()=>h,frontMatter:()=>o,metadata:()=>r,toc:()=>l});var s=i(24246),d=i(71670);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",hr:"hr",p:"p",strong:"strong",...(0,d.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L2382",children:"packages/extension-api/src/extension-api.d.ts:2382"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L2380",children:"packages/extension-api/src/extension-api.d.ts:2380"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L2381",children:"packages/extension-api/src/extension-api.d.ts:2381"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L2379",children:"packages/extension-api/src/extension-api.d.ts:2379"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L2377",children:"packages/extension-api/src/extension-api.d.ts:2377"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L2376",children:"packages/extension-api/src/extension-api.d.ts:2376"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L2393",children:"packages/extension-api/src/extension-api.d.ts:2393"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L2378",children:"packages/extension-api/src/extension-api.d.ts:2378"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L2385",children:"packages/extension-api/src/extension-api.d.ts:2385"})})]})}function h(e={}){const{wrapper:n}={...(0,d.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(a,{...e})}):a(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>r,a:()=>t});var s=i(27378);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([[14026],{99460:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>c,contentTitle:()=>t,default:()=>h,frontMatter:()=>o,metadata:()=>r,toc:()=>l});var s=i(24246),d=i(71670);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",hr:"hr",p:"p",strong:"strong",...(0,d.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2382",children:"packages/extension-api/src/extension-api.d.ts:2382"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2380",children:"packages/extension-api/src/extension-api.d.ts:2380"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2381",children:"packages/extension-api/src/extension-api.d.ts:2381"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2379",children:"packages/extension-api/src/extension-api.d.ts:2379"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2377",children:"packages/extension-api/src/extension-api.d.ts:2377"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2376",children:"packages/extension-api/src/extension-api.d.ts:2376"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2393",children:"packages/extension-api/src/extension-api.d.ts:2393"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2378",children:"packages/extension-api/src/extension-api.d.ts:2378"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2385",children:"packages/extension-api/src/extension-api.d.ts:2385"})})]})}function h(e={}){const{wrapper:n}={...(0,d.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(a,{...e})}):a(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>r,a:()=>t});var s=i(27378);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.ca2e84e1.js b/assets/js/9d2d4743.f9b8c7b5.js similarity index 94% rename from assets/js/9d2d4743.ca2e84e1.js rename to assets/js/9d2d4743.f9b8c7b5.js index 9a735dca1c2..9705aa09646 100644 --- a/assets/js/9d2d4743.ca2e84e1.js +++ b/assets/js/9d2d4743.f9b8c7b5.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[89731],{90190:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>c,default:()=>l,frontMatter:()=>r,metadata:()=>s,toc:()=>d});var o=t(24246),i=t(71670);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",p:"p",strong:"strong",...(0,i.a)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(n.h1,{id:"interface-containerproviderconnectionendpoint",children:"Interface: ContainerProviderConnectionEndpoint"}),"\n",(0,o.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,o.jsx)(n.h3,{id:"socketpath",children:"socketPath"}),"\n",(0,o.jsxs)(n.blockquote,{children:["\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.strong,{children:"socketPath"}),": ",(0,o.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,o.jsx)(n.h4,{id:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/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.a)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(p,{...e})}):p(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>s,a:()=>c});var o=t(27378);const 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([[89731],{90190:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>c,default:()=>l,frontMatter:()=>r,metadata:()=>s,toc:()=>d});var o=t(24246),i=t(71670);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",p:"p",strong:"strong",...(0,i.a)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(n.h1,{id:"interface-containerproviderconnectionendpoint",children:"Interface: ContainerProviderConnectionEndpoint"}),"\n",(0,o.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,o.jsx)(n.h3,{id:"socketpath",children:"socketPath"}),"\n",(0,o.jsxs)(n.blockquote,{children:["\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.strong,{children:"socketPath"}),": ",(0,o.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,o.jsx)(n.h4,{id:"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/bd83a8b2bb8ab886dc757381b589638cbda150d0/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.a)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(p,{...e})}):p(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>s,a:()=>c});var o=t(27378);const 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.dfc357bd.js b/assets/js/9d887a11.76cc1f6f.js similarity index 89% rename from assets/js/9d887a11.dfc357bd.js rename to assets/js/9d887a11.76cc1f6f.js index 1c15014dad1..de3870f7883 100644 --- a/assets/js/9d887a11.dfc357bd.js +++ b/assets/js/9d887a11.76cc1f6f.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[24904],{65005:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>o,contentTitle:()=>a,default:()=>p,frontMatter:()=>r,metadata:()=>c,toc:()=>l});var t=i(24246),s=i(71670);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={},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",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L2075",children:"packages/extension-api/src/extension-api.d.ts:2075"})})]})}function p(e={}){const{wrapper:n}={...(0,s.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(d,{...e})}):d(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>c,a:()=>a});var t=i(27378);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([[24904],{65005:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>o,contentTitle:()=>a,default:()=>p,frontMatter:()=>r,metadata:()=>c,toc:()=>d});var t=i(24246),s=i(71670);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",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2075",children:"packages/extension-api/src/extension-api.d.ts:2075"})})]})}function p(e={}){const{wrapper:n}={...(0,s.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>c,a:()=>a});var t=i(27378);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.cbab884f.js b/assets/js/9db962b6.fc6abef7.js similarity index 98% rename from assets/js/9db962b6.cbab884f.js rename to assets/js/9db962b6.fc6abef7.js index f3bd63098f1..37c43e9e5aa 100644 --- a/assets/js/9db962b6.cbab884f.js +++ b/assets/js/9db962b6.fc6abef7.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[41644],{11716:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>d,contentTitle:()=>r,default:()=>p,frontMatter:()=>o,metadata:()=>c,toc:()=>a});var i=s(24246),t=s(71670);const o={},r="Function: 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",p:"p",strong:"strong",...(0,t.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"function-ondidupdatekubernetesconnection",children:"Function: onDidUpdateKubernetesConnection()"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"onDidUpdateKubernetesConnection"}),"(",(0,i.jsx)(n.code,{children:"listener"}),", ",(0,i.jsx)(n.code,{children:"thisArgs"}),"?, ",(0,i.jsx)(n.code,{children:"disposables"}),"?): ",(0,i.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(n.code,{children:"Disposable"})})]}),"\n"]}),"\n",(0,i.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"listener"})]}),"\n",(0,i.jsx)(n.p,{children:"The listener function will be called when the event happens."}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"thisArgs?"}),": ",(0,i.jsx)(n.code,{children:"any"})]}),"\n",(0,i.jsxs)(n.p,{children:["The ",(0,i.jsx)(n.code,{children:"this"}),"-argument which will be used when calling the event listener."]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"disposables?"}),": ",(0,i.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(n.code,{children:"Disposable"})}),"[]"]}),"\n",(0,i.jsxs)(n.p,{children:["An array to which a ",(0,i.jsx)(n.a,{href:"/api/classes/Disposable",children:"Disposable"})," will be added."]}),"\n",(0,i.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(n.code,{children:"Disposable"})})}),"\n",(0,i.jsx)(n.p,{children:"A disposable which unsubscribes the event listener."}),"\n",(0,i.jsx)(n.h2,{id:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L813",children:"packages/extension-api/src/extension-api.d.ts:813"})})]})}function p(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>c,a:()=>r});var i=s(27378);const t={},o=i.createContext(t);function r(e){const n=i.useContext(o);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:r(e.components),i.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[41644],{11716:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>d,contentTitle:()=>r,default:()=>p,frontMatter:()=>o,metadata:()=>c,toc:()=>a});var i=s(24246),t=s(71670);const o={},r="Function: onDidUpdateKubernetesConnection()",c={id:"namespaces/provider/functions/onDidUpdateKubernetesConnection",title:"Function: onDidUpdateKubernetesConnection()",description:"onDidUpdateKubernetesConnection(listener, thisArgs?, disposables?): Disposable",source:"@site/api/namespaces/provider/functions/onDidUpdateKubernetesConnection.md",sourceDirName:"namespaces/provider/functions",slug:"/namespaces/provider/functions/onDidUpdateKubernetesConnection",permalink:"/api/namespaces/provider/functions/onDidUpdateKubernetesConnection",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"onDidUpdateContainerConnection",permalink:"/api/namespaces/provider/functions/onDidUpdateContainerConnection"},next:{title:"onDidUpdateProvider",permalink:"/api/namespaces/provider/functions/onDidUpdateProvider"}},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",p:"p",strong:"strong",...(0,t.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"function-ondidupdatekubernetesconnection",children:"Function: onDidUpdateKubernetesConnection()"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"onDidUpdateKubernetesConnection"}),"(",(0,i.jsx)(n.code,{children:"listener"}),", ",(0,i.jsx)(n.code,{children:"thisArgs"}),"?, ",(0,i.jsx)(n.code,{children:"disposables"}),"?): ",(0,i.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(n.code,{children:"Disposable"})})]}),"\n"]}),"\n",(0,i.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"listener"})]}),"\n",(0,i.jsx)(n.p,{children:"The listener function will be called when the event happens."}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"thisArgs?"}),": ",(0,i.jsx)(n.code,{children:"any"})]}),"\n",(0,i.jsxs)(n.p,{children:["The ",(0,i.jsx)(n.code,{children:"this"}),"-argument which will be used when calling the event listener."]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"disposables?"}),": ",(0,i.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(n.code,{children:"Disposable"})}),"[]"]}),"\n",(0,i.jsxs)(n.p,{children:["An array to which a ",(0,i.jsx)(n.a,{href:"/api/classes/Disposable",children:"Disposable"})," will be added."]}),"\n",(0,i.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(n.code,{children:"Disposable"})})}),"\n",(0,i.jsx)(n.p,{children:"A disposable which unsubscribes the event listener."}),"\n",(0,i.jsx)(n.h2,{id:"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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L813",children:"packages/extension-api/src/extension-api.d.ts:813"})})]})}function p(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>c,a:()=>r});var i=s(27378);const t={},o=i.createContext(t);function r(e){const n=i.useContext(o);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:r(e.components),i.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/9dd60997.4ce4ebc4.js b/assets/js/9dd60997.16e1f8fe.js similarity index 98% rename from assets/js/9dd60997.4ce4ebc4.js rename to assets/js/9dd60997.16e1f8fe.js index 112d6441f3a..9e6bbb78646 100644 --- a/assets/js/9dd60997.4ce4ebc4.js +++ b/assets/js/9dd60997.16e1f8fe.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[76518],{79961:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>d,contentTitle:()=>r,default:()=>p,frontMatter:()=>o,metadata:()=>c,toc:()=>a});var i=s(24246),t=s(71670);const o={},r="Function: getSession()",c={id:"namespaces/authentication/functions/getSession",title:"Function: getSession()",description:"getSession(providerId, scopes, options)",source:"@site/api/namespaces/authentication/functions/getSession.md",sourceDirName:"namespaces/authentication/functions",slug:"/namespaces/authentication/functions/getSession",permalink:"/api/namespaces/authentication/functions/getSession",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"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",p:"p",strong:"strong",...(0,t.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"function-getsession",children:"Function: getSession()"}),"\n",(0,i.jsx)(n.h2,{id:"getsessionproviderid-scopes-options",children:"getSession(providerId, scopes, options)"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"getSession"}),"(",(0,i.jsx)(n.code,{children:"providerId"}),", ",(0,i.jsx)(n.code,{children:"scopes"}),", ",(0,i.jsx)(n.code,{children:"options"}),"): ",(0,i.jsx)(n.code,{children:"Promise"}),"<",(0,i.jsx)(n.a,{href:"/api/interfaces/AuthenticationSession",children:(0,i.jsx)(n.code,{children:"AuthenticationSession"})})," | ",(0,i.jsx)(n.code,{children:"undefined"}),">"]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Get an authentication session matching the desired scopes. Rejects if a provider with providerId is not\nregistered, or if the user does not consent to sharing authentication information with\nthe extension. If there are multiple sessions with the same scopes, the user will be shown a\nquickpick to select which account they would like to use."}),"\n",(0,i.jsx)(n.p,{children:"Currently, there are only two authentication providers that are contributed from built in extensions\nto VS Code that implement GitHub and Microsoft authentication: their providerId's are 'github' and 'microsoft'."}),"\n",(0,i.jsx)(n.h3,{id:"parameters",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"providerId"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n",(0,i.jsx)(n.p,{children:"The id of the provider to use"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"scopes"}),": ",(0,i.jsx)(n.code,{children:"string"}),"[]"]}),"\n",(0,i.jsx)(n.p,{children:"A list of scopes representing the permissions requested. These are dependent on the authentication provider"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"options"}),": ",(0,i.jsx)(n.a,{href:"/api/interfaces/AuthenticationGetSessionOptions",children:(0,i.jsx)(n.code,{children:"AuthenticationGetSessionOptions"})})," & ",(0,i.jsx)(n.code,{children:"object"})]}),"\n",(0,i.jsxs)(n.p,{children:["The ",(0,i.jsx)(n.a,{href:"#GetSessionOptions",children:"getSessionOptions"})," to use"]}),"\n",(0,i.jsx)(n.h3,{id:"returns",children:"Returns"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"Promise"}),"<",(0,i.jsx)(n.a,{href:"/api/interfaces/AuthenticationSession",children:(0,i.jsx)(n.code,{children:"AuthenticationSession"})})," | ",(0,i.jsx)(n.code,{children:"undefined"}),">"]}),"\n",(0,i.jsx)(n.p,{children:"A promise that resolves to an authentication session"}),"\n",(0,i.jsx)(n.h3,{id:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L3892",children:"packages/extension-api/src/extension-api.d.ts:3892"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L3911",children:"packages/extension-api/src/extension-api.d.ts:3911"})})]})}function p(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(h,{...e})}):h(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>c,a:()=>r});var i=s(27378);const t={},o=i.createContext(t);function r(e){const n=i.useContext(o);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:r(e.components),i.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[76518],{79961:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>d,contentTitle:()=>r,default:()=>p,frontMatter:()=>o,metadata:()=>c,toc:()=>a});var i=s(24246),t=s(71670);const o={},r="Function: getSession()",c={id:"namespaces/authentication/functions/getSession",title:"Function: getSession()",description:"getSession(providerId, scopes, options)",source:"@site/api/namespaces/authentication/functions/getSession.md",sourceDirName:"namespaces/authentication/functions",slug:"/namespaces/authentication/functions/getSession",permalink:"/api/namespaces/authentication/functions/getSession",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"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",p:"p",strong:"strong",...(0,t.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"function-getsession",children:"Function: getSession()"}),"\n",(0,i.jsx)(n.h2,{id:"getsessionproviderid-scopes-options",children:"getSession(providerId, scopes, options)"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"getSession"}),"(",(0,i.jsx)(n.code,{children:"providerId"}),", ",(0,i.jsx)(n.code,{children:"scopes"}),", ",(0,i.jsx)(n.code,{children:"options"}),"): ",(0,i.jsx)(n.code,{children:"Promise"}),"<",(0,i.jsx)(n.a,{href:"/api/interfaces/AuthenticationSession",children:(0,i.jsx)(n.code,{children:"AuthenticationSession"})})," | ",(0,i.jsx)(n.code,{children:"undefined"}),">"]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Get an authentication session matching the desired scopes. Rejects if a provider with providerId is not\nregistered, or if the user does not consent to sharing authentication information with\nthe extension. If there are multiple sessions with the same scopes, the user will be shown a\nquickpick to select which account they would like to use."}),"\n",(0,i.jsx)(n.p,{children:"Currently, there are only two authentication providers that are contributed from built in extensions\nto VS Code that implement GitHub and Microsoft authentication: their providerId's are 'github' and 'microsoft'."}),"\n",(0,i.jsx)(n.h3,{id:"parameters",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"providerId"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n",(0,i.jsx)(n.p,{children:"The id of the provider to use"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"scopes"}),": ",(0,i.jsx)(n.code,{children:"string"}),"[]"]}),"\n",(0,i.jsx)(n.p,{children:"A list of scopes representing the permissions requested. These are dependent on the authentication provider"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"options"}),": ",(0,i.jsx)(n.a,{href:"/api/interfaces/AuthenticationGetSessionOptions",children:(0,i.jsx)(n.code,{children:"AuthenticationGetSessionOptions"})})," & ",(0,i.jsx)(n.code,{children:"object"})]}),"\n",(0,i.jsxs)(n.p,{children:["The ",(0,i.jsx)(n.a,{href:"#GetSessionOptions",children:"getSessionOptions"})," to use"]}),"\n",(0,i.jsx)(n.h3,{id:"returns",children:"Returns"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"Promise"}),"<",(0,i.jsx)(n.a,{href:"/api/interfaces/AuthenticationSession",children:(0,i.jsx)(n.code,{children:"AuthenticationSession"})})," | ",(0,i.jsx)(n.code,{children:"undefined"}),">"]}),"\n",(0,i.jsx)(n.p,{children:"A promise that resolves to an authentication session"}),"\n",(0,i.jsx)(n.h3,{id:"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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L3892",children:"packages/extension-api/src/extension-api.d.ts:3892"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L3911",children:"packages/extension-api/src/extension-api.d.ts:3911"})})]})}function p(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(h,{...e})}):h(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>c,a:()=>r});var i=s(27378);const t={},o=i.createContext(t);function r(e){const n=i.useContext(o);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:r(e.components),i.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/a08dfa31.29d4703c.js b/assets/js/a08dfa31.195b0181.js similarity index 88% rename from assets/js/a08dfa31.29d4703c.js rename to assets/js/a08dfa31.195b0181.js index ae0739e642d..2a77f4cb6ac 100644 --- a/assets/js/a08dfa31.29d4703c.js +++ b/assets/js/a08dfa31.195b0181.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[69006],{34649:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>o,contentTitle:()=>t,default:()=>h,frontMatter:()=>r,metadata:()=>c,toc:()=>a});var s=i(24246),d=i(71670);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",hr:"hr",p:"p",strong:"strong",...(0,d.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{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/804b2198fda0957e1ecfb87539f019eb9b79a66f/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/804b2198fda0957e1ecfb87539f019eb9b79a66f/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/804b2198fda0957e1ecfb87539f019eb9b79a66f/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/804b2198fda0957e1ecfb87539f019eb9b79a66f/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/804b2198fda0957e1ecfb87539f019eb9b79a66f/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/804b2198fda0957e1ecfb87539f019eb9b79a66f/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/804b2198fda0957e1ecfb87539f019eb9b79a66f/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/804b2198fda0957e1ecfb87539f019eb9b79a66f/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/804b2198fda0957e1ecfb87539f019eb9b79a66f/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.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>c,a:()=>t});var s=i(27378);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([[69006],{34649:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>o,contentTitle:()=>t,default:()=>h,frontMatter:()=>r,metadata:()=>c,toc:()=>a});var s=i(24246),d=i(71670);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",hr:"hr",p:"p",strong:"strong",...(0,d.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{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/bd83a8b2bb8ab886dc757381b589638cbda150d0/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/bd83a8b2bb8ab886dc757381b589638cbda150d0/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/bd83a8b2bb8ab886dc757381b589638cbda150d0/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/bd83a8b2bb8ab886dc757381b589638cbda150d0/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/bd83a8b2bb8ab886dc757381b589638cbda150d0/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/bd83a8b2bb8ab886dc757381b589638cbda150d0/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/bd83a8b2bb8ab886dc757381b589638cbda150d0/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/bd83a8b2bb8ab886dc757381b589638cbda150d0/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/bd83a8b2bb8ab886dc757381b589638cbda150d0/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.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>c,a:()=>t});var s=i(27378);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.88c57e6d.js b/assets/js/a2c6f402.58d9e25a.js similarity index 88% rename from assets/js/a2c6f402.88c57e6d.js rename to assets/js/a2c6f402.58d9e25a.js index 9c7e0f79c0f..1e08452bc6f 100644 --- a/assets/js/a2c6f402.88c57e6d.js +++ b/assets/js/a2c6f402.58d9e25a.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[6266],{96550:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>c,contentTitle:()=>o,default:()=>p,frontMatter:()=>r,metadata:()=>a,toc:()=>d});var t=i(24246),s=i(71670);const r={},o="Type Alias: ProviderLinks",a={id:"type-aliases/ProviderLinks",title:"Type Alias: ProviderLinks",description:"ProviderLinks: Link",source:"@site/api/type-aliases/ProviderLinks.md",sourceDirName:"type-aliases",slug:"/type-aliases/ProviderLinks",permalink:"/api/type-aliases/ProviderLinks",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"ProviderConnectionStatus",permalink:"/api/type-aliases/ProviderConnectionStatus"},next:{title:"ProviderResult",permalink:"/api/type-aliases/ProviderResult"}},c={},d=[{value:"Defined in",id:"defined-in",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L580",children:"packages/extension-api/src/extension-api.d.ts:580"})})]})}function p(e={}){const{wrapper:n}={...(0,s.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>a,a:()=>o});var t=i(27378);const s={},r=t.createContext(s);function o(e){const n=t.useContext(r);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function 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([[6266],{96550:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>d,contentTitle:()=>o,default:()=>p,frontMatter:()=>r,metadata:()=>a,toc:()=>c});var t=i(24246),s=i(71670);const r={},o="Type Alias: ProviderLinks",a={id:"type-aliases/ProviderLinks",title:"Type Alias: ProviderLinks",description:"ProviderLinks: Link",source:"@site/api/type-aliases/ProviderLinks.md",sourceDirName:"type-aliases",slug:"/type-aliases/ProviderLinks",permalink:"/api/type-aliases/ProviderLinks",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"ProviderConnectionStatus",permalink:"/api/type-aliases/ProviderConnectionStatus"},next:{title:"ProviderResult",permalink:"/api/type-aliases/ProviderResult"}},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",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L580",children:"packages/extension-api/src/extension-api.d.ts:580"})})]})}function p(e={}){const{wrapper:n}={...(0,s.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>a,a:()=>o});var t=i(27378);const s={},r=t.createContext(s);function o(e){const n=t.useContext(r);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function 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.3fcb8154.js b/assets/js/a2d1ff94.8b300a86.js similarity index 83% rename from assets/js/a2d1ff94.3fcb8154.js rename to assets/js/a2d1ff94.8b300a86.js index ba95044fdc8..5636a7f3e88 100644 --- a/assets/js/a2d1ff94.3fcb8154.js +++ b/assets/js/a2d1ff94.8b300a86.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[41169],{89703:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>c,contentTitle:()=>o,default:()=>p,frontMatter:()=>r,metadata:()=>d,toc:()=>a});var t=i(24246),s=i(71670);const r={},o="Interface: ContainerProviderConnection",d={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:"Methods",id:"methods",level:2},{value:"status()",id:"status",level:3},{value:"Returns",id:"returns",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",hr:"hr",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"interface-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/804b2198fda0957e1ecfb87539f019eb9b79a66f/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/804b2198fda0957e1ecfb87539f019eb9b79a66f/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/804b2198fda0957e1ecfb87539f019eb9b79a66f/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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L361",children:"packages/extension-api/src/extension-api.d.ts:361"})}),"\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-4",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/804b2198fda0957e1ecfb87539f019eb9b79a66f/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.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>d,a:()=>o});var t=i(27378);const s={},r=t.createContext(s);function o(e){const n=t.useContext(r);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function 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([[41169],{89703:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>c,contentTitle:()=>d,default:()=>p,frontMatter:()=>r,metadata:()=>o,toc:()=>a});var t=i(24246),s=i(71670);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:"Methods",id:"methods",level:2},{value:"status()",id:"status",level:3},{value:"Returns",id:"returns",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",hr:"hr",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"interface-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/bd83a8b2bb8ab886dc757381b589638cbda150d0/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/bd83a8b2bb8ab886dc757381b589638cbda150d0/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/bd83a8b2bb8ab886dc757381b589638cbda150d0/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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L361",children:"packages/extension-api/src/extension-api.d.ts:361"})}),"\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-4",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/bd83a8b2bb8ab886dc757381b589638cbda150d0/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.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>o,a:()=>d});var t=i(27378);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.a37c4896.js b/assets/js/a2ffcc0f.47a74cc4.js similarity index 96% rename from assets/js/a2ffcc0f.a37c4896.js rename to assets/js/a2ffcc0f.47a74cc4.js index 108827e508e..a3a9eb0d15f 100644 --- a/assets/js/a2ffcc0f.a37c4896.js +++ b/assets/js/a2ffcc0f.47a74cc4.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[51843],{15382:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>c,contentTitle:()=>o,default:()=>p,frontMatter:()=>i,metadata:()=>a,toc:()=>d});var s=r(24246),t=r(71670);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",p:"p",strong:"strong",...(0,t.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"function-registerkubernetesgenerator",children:"Function: registerKubernetesGenerator()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"registerKubernetesGenerator"}),"(",(0,s.jsx)(n.code,{children:"provider"}),"): ",(0,s.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,s.jsx)(n.code,{children:"Disposable"})})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Add a KubernetesGenerator to KubernetesGeneratorRegistry"}),"\n",(0,s.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"provider"}),": ",(0,s.jsx)(n.a,{href:"/api/interfaces/KubernetesGeneratorProvider",children:(0,s.jsx)(n.code,{children:"KubernetesGeneratorProvider"})})]}),"\n",(0,s.jsx)(n.p,{children:"the custom provider to add"}),"\n",(0,s.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,s.jsx)(n.code,{children:"Disposable"})})}),"\n",(0,s.jsx)(n.h2,{id:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L2099",children:"packages/extension-api/src/extension-api.d.ts:2099"})})]})}function p(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(u,{...e})}):u(e)}},71670:(e,n,r)=>{r.d(n,{Z:()=>a,a:()=>o});var s=r(27378);const t={},i=s.createContext(t);function o(e){const n=s.useContext(i);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function 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([[51843],{15382:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>c,contentTitle:()=>o,default:()=>p,frontMatter:()=>i,metadata:()=>a,toc:()=>d});var s=r(24246),t=r(71670);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",p:"p",strong:"strong",...(0,t.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"function-registerkubernetesgenerator",children:"Function: registerKubernetesGenerator()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"registerKubernetesGenerator"}),"(",(0,s.jsx)(n.code,{children:"provider"}),"): ",(0,s.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,s.jsx)(n.code,{children:"Disposable"})})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Add a KubernetesGenerator to KubernetesGeneratorRegistry"}),"\n",(0,s.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"provider"}),": ",(0,s.jsx)(n.a,{href:"/api/interfaces/KubernetesGeneratorProvider",children:(0,s.jsx)(n.code,{children:"KubernetesGeneratorProvider"})})]}),"\n",(0,s.jsx)(n.p,{children:"the custom provider to add"}),"\n",(0,s.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,s.jsx)(n.code,{children:"Disposable"})})}),"\n",(0,s.jsx)(n.h2,{id:"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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2099",children:"packages/extension-api/src/extension-api.d.ts:2099"})})]})}function p(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(u,{...e})}):u(e)}},71670:(e,n,r)=>{r.d(n,{Z:()=>a,a:()=>o});var s=r(27378);const t={},i=s.createContext(t);function o(e){const n=s.useContext(i);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function 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.ccb31542.js b/assets/js/a3002291.6c992b3d.js similarity index 96% rename from assets/js/a3002291.ccb31542.js rename to assets/js/a3002291.6c992b3d.js index d58ee889ff6..55b4a61a409 100644 --- a/assets/js/a3002291.ccb31542.js +++ b/assets/js/a3002291.6c992b3d.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[36424],{34403:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>s,default:()=>p,frontMatter:()=>o,metadata:()=>c,toc:()=>d});var r=t(24246),i=t(71670);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",p:"p",strong:"strong",...(0,i.a)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.h1,{id:"function-createnetwork",children:"Function: createNetwork()"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"createNetwork"}),"(",(0,r.jsx)(n.code,{children:"containerProviderConnection"}),", ",(0,r.jsx)(n.code,{children:"networkCreateOptions"}),"): ",(0,r.jsx)(n.code,{children:"Promise"}),"<",(0,r.jsx)(n.a,{href:"/api/interfaces/NetworkCreateResult",children:(0,r.jsx)(n.code,{children:"NetworkCreateResult"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"containerProviderConnection"}),": ",(0,r.jsx)(n.a,{href:"/api/interfaces/ContainerProviderConnection",children:(0,r.jsx)(n.code,{children:"ContainerProviderConnection"})})]}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"networkCreateOptions"}),": ",(0,r.jsx)(n.a,{href:"/api/interfaces/NetworkCreateOptions",children:(0,r.jsx)(n.code,{children:"NetworkCreateOptions"})})]}),"\n",(0,r.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"Promise"}),"<",(0,r.jsx)(n.a,{href:"/api/interfaces/NetworkCreateResult",children:(0,r.jsx)(n.code,{children:"NetworkCreateResult"})}),">"]}),"\n",(0,r.jsx)(n.h2,{id:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L3650",children:"packages/extension-api/src/extension-api.d.ts:3650"})})]})}function p(e={}){const{wrapper:n}={...(0,i.a)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(l,{...e})}):l(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>c,a:()=>s});var r=t(27378);const i={},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([[36424],{34403:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>s,default:()=>p,frontMatter:()=>o,metadata:()=>c,toc:()=>d});var r=t(24246),i=t(71670);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",p:"p",strong:"strong",...(0,i.a)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.h1,{id:"function-createnetwork",children:"Function: createNetwork()"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"createNetwork"}),"(",(0,r.jsx)(n.code,{children:"containerProviderConnection"}),", ",(0,r.jsx)(n.code,{children:"networkCreateOptions"}),"): ",(0,r.jsx)(n.code,{children:"Promise"}),"<",(0,r.jsx)(n.a,{href:"/api/interfaces/NetworkCreateResult",children:(0,r.jsx)(n.code,{children:"NetworkCreateResult"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"containerProviderConnection"}),": ",(0,r.jsx)(n.a,{href:"/api/interfaces/ContainerProviderConnection",children:(0,r.jsx)(n.code,{children:"ContainerProviderConnection"})})]}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"networkCreateOptions"}),": ",(0,r.jsx)(n.a,{href:"/api/interfaces/NetworkCreateOptions",children:(0,r.jsx)(n.code,{children:"NetworkCreateOptions"})})]}),"\n",(0,r.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"Promise"}),"<",(0,r.jsx)(n.a,{href:"/api/interfaces/NetworkCreateResult",children:(0,r.jsx)(n.code,{children:"NetworkCreateResult"})}),">"]}),"\n",(0,r.jsx)(n.h2,{id:"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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L3650",children:"packages/extension-api/src/extension-api.d.ts:3650"})})]})}function p(e={}){const{wrapper:n}={...(0,i.a)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(l,{...e})}):l(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>c,a:()=>s});var r=t(27378);const i={},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.1f29ad48.js b/assets/js/a30c0d44.c7d5ae93.js similarity index 87% rename from assets/js/a30c0d44.1f29ad48.js rename to assets/js/a30c0d44.c7d5ae93.js index 6b98f5cb641..b17cca538d7 100644 --- a/assets/js/a30c0d44.1f29ad48.js +++ b/assets/js/a30c0d44.c7d5ae93.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[64891],{16927:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>l,contentTitle:()=>o,default:()=>h,frontMatter:()=>d,metadata:()=>r,toc:()=>a});var s=i(24246),t=i(71670);const d={},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"}},l={},a=[{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",hr:"hr",p:"p",strong:"strong",...(0,t.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"interface-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/804b2198fda0957e1ecfb87539f019eb9b79a66f/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:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L1144",children:"packages/extension-api/src/extension-api.d.ts:1144"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/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:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L1154",children:"packages/extension-api/src/extension-api.d.ts:1154"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L1149",children:"packages/extension-api/src/extension-api.d.ts:1149"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L1139",children:"packages/extension-api/src/extension-api.d.ts:1139"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L1121",children:"packages/extension-api/src/extension-api.d.ts:1121"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L1126",children:"packages/extension-api/src/extension-api.d.ts:1126"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L1134",children:"packages/extension-api/src/extension-api.d.ts:1134"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L1175",children:"packages/extension-api/src/extension-api.d.ts:1175"})})]})}function h(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(c,{...e})}):c(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>r,a:()=>o});var s=i(27378);const t={},d=s.createContext(t);function o(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:o(e.components),s.createElement(d.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[64891],{16927:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>l,contentTitle:()=>o,default:()=>h,frontMatter:()=>t,metadata:()=>r,toc:()=>a});var s=i(24246),d=i(71670);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"}},l={},a=[{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",hr:"hr",p:"p",strong:"strong",...(0,d.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{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/bd83a8b2bb8ab886dc757381b589638cbda150d0/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:"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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L1144",children:"packages/extension-api/src/extension-api.d.ts:1144"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/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:"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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L1154",children:"packages/extension-api/src/extension-api.d.ts:1154"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L1149",children:"packages/extension-api/src/extension-api.d.ts:1149"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L1139",children:"packages/extension-api/src/extension-api.d.ts:1139"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L1121",children:"packages/extension-api/src/extension-api.d.ts:1121"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L1126",children:"packages/extension-api/src/extension-api.d.ts:1126"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L1134",children:"packages/extension-api/src/extension-api.d.ts:1134"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L1175",children:"packages/extension-api/src/extension-api.d.ts:1175"})})]})}function h(e={}){const{wrapper:n}={...(0,d.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(c,{...e})}):c(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>r,a:()=>o});var s=i(27378);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.bc3cce6d.js b/assets/js/a334b453.e20229b7.js similarity index 87% rename from assets/js/a334b453.bc3cce6d.js rename to assets/js/a334b453.e20229b7.js index 0100aef497b..3e0ddbad722 100644 --- a/assets/js/a334b453.bc3cce6d.js +++ b/assets/js/a334b453.e20229b7.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[4004],{62806:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>s,default:()=>l,frontMatter:()=>r,metadata:()=>c,toc:()=>d});var i=t(24246),o=t(71670);const r={},s="Interface: UpdateContainerConnectionEvent",c={id:"interfaces/UpdateContainerConnectionEvent",title:"Interface: UpdateContainerConnectionEvent",description:"Properties",source:"@site/api/interfaces/UpdateContainerConnectionEvent.md",sourceDirName:"interfaces",slug:"/interfaces/UpdateContainerConnectionEvent",permalink:"/api/interfaces/UpdateContainerConnectionEvent",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"UnregisterKubernetesConnectionEvent",permalink:"/api/interfaces/UnregisterKubernetesConnectionEvent"},next:{title:"UpdateKubernetesConnectionEvent",permalink:"/api/interfaces/UpdateKubernetesConnectionEvent"}},a={},d=[{value:"Properties",id:"properties",level:2},{value:"connection",id:"connection",level:3},{value:"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",hr:"hr",p:"p",strong:"strong",...(0,o.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"interface-updatecontainerconnectionevent",children:"Interface: UpdateContainerConnectionEvent"}),"\n",(0,i.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(n.h3,{id:"connection",children:"connection"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"connection"}),": ",(0,i.jsx)(n.a,{href:"/api/interfaces/ContainerProviderConnection",children:(0,i.jsx)(n.code,{children:"ContainerProviderConnection"})})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L677",children:"packages/extension-api/src/extension-api.d.ts:677"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L676",children:"packages/extension-api/src/extension-api.d.ts:676"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L678",children:"packages/extension-api/src/extension-api.d.ts:678"})})]})}function l(e={}){const{wrapper:n}={...(0,o.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(p,{...e})}):p(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>c,a:()=>s});var i=t(27378);const o={},r=i.createContext(o);function s(e){const n=i.useContext(r);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:s(e.components),i.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[4004],{62806:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>d,contentTitle:()=>s,default:()=>l,frontMatter:()=>r,metadata:()=>c,toc:()=>a});var i=t(24246),o=t(71670);const r={},s="Interface: UpdateContainerConnectionEvent",c={id:"interfaces/UpdateContainerConnectionEvent",title:"Interface: UpdateContainerConnectionEvent",description:"Properties",source:"@site/api/interfaces/UpdateContainerConnectionEvent.md",sourceDirName:"interfaces",slug:"/interfaces/UpdateContainerConnectionEvent",permalink:"/api/interfaces/UpdateContainerConnectionEvent",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"UnregisterKubernetesConnectionEvent",permalink:"/api/interfaces/UnregisterKubernetesConnectionEvent"},next:{title:"UpdateKubernetesConnectionEvent",permalink:"/api/interfaces/UpdateKubernetesConnectionEvent"}},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",hr:"hr",p:"p",strong:"strong",...(0,o.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"interface-updatecontainerconnectionevent",children:"Interface: UpdateContainerConnectionEvent"}),"\n",(0,i.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(n.h3,{id:"connection",children:"connection"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"connection"}),": ",(0,i.jsx)(n.a,{href:"/api/interfaces/ContainerProviderConnection",children:(0,i.jsx)(n.code,{children:"ContainerProviderConnection"})})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L677",children:"packages/extension-api/src/extension-api.d.ts:677"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L676",children:"packages/extension-api/src/extension-api.d.ts:676"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L678",children:"packages/extension-api/src/extension-api.d.ts:678"})})]})}function l(e={}){const{wrapper:n}={...(0,o.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(p,{...e})}):p(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>c,a:()=>s});var i=t(27378);const o={},r=i.createContext(o);function s(e){const n=i.useContext(r);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:s(e.components),i.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/a38d285e.83072723.js b/assets/js/a38d285e.f2e94a0e.js similarity index 90% rename from assets/js/a38d285e.83072723.js rename to assets/js/a38d285e.f2e94a0e.js index b8a5393a669..13083f33bbd 100644 --- a/assets/js/a38d285e.83072723.js +++ b/assets/js/a38d285e.f2e94a0e.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[86477],{58782:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>a,contentTitle:()=>s,default:()=>l,frontMatter:()=>o,metadata:()=>c,toc:()=>d});var t=i(24246),r=i(71670);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",hr:"hr",p:"p",strong:"strong",...(0,r.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L698",children:"packages/extension-api/src/extension-api.d.ts:698"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L697",children:"packages/extension-api/src/extension-api.d.ts:697"})})]})}function l(e={}){const{wrapper:n}={...(0,r.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(p,{...e})}):p(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>c,a:()=>s});var t=i(27378);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([[86477],{58782:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>d,contentTitle:()=>s,default:()=>l,frontMatter:()=>o,metadata:()=>c,toc:()=>a});var t=i(24246),r=i(71670);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"}},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 p(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,r.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L698",children:"packages/extension-api/src/extension-api.d.ts:698"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L697",children:"packages/extension-api/src/extension-api.d.ts:697"})})]})}function l(e={}){const{wrapper:n}={...(0,r.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(p,{...e})}):p(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>c,a:()=>s});var t=i(27378);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.77440120.js b/assets/js/a3f8794a.95c0f0a5.js similarity index 96% rename from assets/js/a3f8794a.77440120.js rename to assets/js/a3f8794a.95c0f0a5.js index 309207ad5be..c963f218657 100644 --- a/assets/js/a3f8794a.77440120.js +++ b/assets/js/a3f8794a.95c0f0a5.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[60334],{20120:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>o,contentTitle:()=>s,default:()=>p,frontMatter:()=>a,metadata:()=>c,toc:()=>d});var i=t(24246),r=t(71670);const a={},s="Function: createContainer()",c={id:"namespaces/containerEngine/functions/createContainer",title:"Function: createContainer()",description:"createContainer(engineId, containerCreateOptions): Promise\\",source:"@site/api/namespaces/containerEngine/functions/createContainer.md",sourceDirName:"namespaces/containerEngine/functions",slug:"/namespaces/containerEngine/functions/createContainer",permalink:"/api/namespaces/containerEngine/functions/createContainer",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"buildImage",permalink:"/api/namespaces/containerEngine/functions/buildImage"},next:{title:"createManifest",permalink:"/api/namespaces/containerEngine/functions/createManifest"}},o={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Defined in",id:"defined-in",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,r.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"function-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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L3461",children:"packages/extension-api/src/extension-api.d.ts:3461"})})]})}function p(e={}){const{wrapper:n}={...(0,r.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>c,a:()=>s});var i=t(27378);const r={},a=i.createContext(r);function s(e){const n=i.useContext(a);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:s(e.components),i.createElement(a.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[60334],{20120:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>o,contentTitle:()=>s,default:()=>p,frontMatter:()=>a,metadata:()=>c,toc:()=>d});var i=t(24246),r=t(71670);const a={},s="Function: createContainer()",c={id:"namespaces/containerEngine/functions/createContainer",title:"Function: createContainer()",description:"createContainer(engineId, containerCreateOptions): Promise\\",source:"@site/api/namespaces/containerEngine/functions/createContainer.md",sourceDirName:"namespaces/containerEngine/functions",slug:"/namespaces/containerEngine/functions/createContainer",permalink:"/api/namespaces/containerEngine/functions/createContainer",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"buildImage",permalink:"/api/namespaces/containerEngine/functions/buildImage"},next:{title:"createManifest",permalink:"/api/namespaces/containerEngine/functions/createManifest"}},o={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Defined in",id:"defined-in",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,r.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"function-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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L3461",children:"packages/extension-api/src/extension-api.d.ts:3461"})})]})}function p(e={}){const{wrapper:n}={...(0,r.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>c,a:()=>s});var i=t(27378);const r={},a=i.createContext(r);function s(e){const n=i.useContext(a);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:s(e.components),i.createElement(a.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/a4794f2e.5dd85cbf.js b/assets/js/a4794f2e.78d14a86.js similarity index 97% rename from assets/js/a4794f2e.5dd85cbf.js rename to assets/js/a4794f2e.78d14a86.js index 2a5c97032c1..f1587049078 100644 --- a/assets/js/a4794f2e.5dd85cbf.js +++ b/assets/js/a4794f2e.78d14a86.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[11161],{21926:(e,r,s)=>{s.r(r),s.d(r,{assets:()=>a,contentTitle:()=>o,default:()=>p,frontMatter:()=>n,metadata:()=>c,toc:()=>d});var i=s(24246),t=s(71670);const n={},o="Function: registerRegistryProvider()",c={id:"namespaces/registry/functions/registerRegistryProvider",title:"Function: registerRegistryProvider()",description:"registerRegistryProvider(registryProvider): Disposable",source:"@site/api/namespaces/registry/functions/registerRegistryProvider.md",sourceDirName:"namespaces/registry/functions",slug:"/namespaces/registry/functions/registerRegistryProvider",permalink:"/api/namespaces/registry/functions/registerRegistryProvider",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"registerRegistry",permalink:"/api/namespaces/registry/functions/registerRegistry"},next:{title:"suggestRegistry",permalink:"/api/namespaces/registry/functions/suggestRegistry"}},a={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Defined in",id:"defined-in",level:2}];function l(e){const r={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,t.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L899",children:"packages/extension-api/src/extension-api.d.ts:899"})})]})}function p(e={}){const{wrapper:r}={...(0,t.a)(),...e.components};return r?(0,i.jsx)(r,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},71670:(e,r,s)=>{s.d(r,{Z:()=>c,a:()=>o});var i=s(27378);const t={},n=i.createContext(t);function o(e){const r=i.useContext(n);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:o(e.components),i.createElement(n.Provider,{value:r},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[11161],{21926:(e,r,s)=>{s.r(r),s.d(r,{assets:()=>a,contentTitle:()=>o,default:()=>p,frontMatter:()=>n,metadata:()=>c,toc:()=>d});var i=s(24246),t=s(71670);const n={},o="Function: registerRegistryProvider()",c={id:"namespaces/registry/functions/registerRegistryProvider",title:"Function: registerRegistryProvider()",description:"registerRegistryProvider(registryProvider): Disposable",source:"@site/api/namespaces/registry/functions/registerRegistryProvider.md",sourceDirName:"namespaces/registry/functions",slug:"/namespaces/registry/functions/registerRegistryProvider",permalink:"/api/namespaces/registry/functions/registerRegistryProvider",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"registerRegistry",permalink:"/api/namespaces/registry/functions/registerRegistry"},next:{title:"suggestRegistry",permalink:"/api/namespaces/registry/functions/suggestRegistry"}},a={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Defined in",id:"defined-in",level:2}];function l(e){const r={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,t.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L899",children:"packages/extension-api/src/extension-api.d.ts:899"})})]})}function p(e={}){const{wrapper:r}={...(0,t.a)(),...e.components};return r?(0,i.jsx)(r,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},71670:(e,r,s)=>{s.d(r,{Z:()=>c,a:()=>o});var i=s(27378);const t={},n=i.createContext(t);function o(e){const r=i.useContext(n);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:o(e.components),i.createElement(n.Provider,{value:r},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/a9fa5b1f.95d38593.js b/assets/js/a9fa5b1f.ffe707a8.js similarity index 93% rename from assets/js/a9fa5b1f.95d38593.js rename to assets/js/a9fa5b1f.ffe707a8.js index 6a108b1aace..779635844f2 100644 --- a/assets/js/a9fa5b1f.95d38593.js +++ b/assets/js/a9fa5b1f.ffe707a8.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[44619],{51880:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>d,contentTitle:()=>o,default:()=>p,frontMatter:()=>s,metadata:()=>c,toc:()=>a});var r=i(24246),t=i(71670);const s={},o="Interface: ProviderCleanupAction",c={id:"interfaces/ProviderCleanupAction",title:"Interface: ProviderCleanupAction",description:"Properties",source:"@site/api/interfaces/ProviderCleanupAction.md",sourceDirName:"interfaces",slug:"/interfaces/ProviderCleanupAction",permalink:"/api/interfaces/ProviderCleanupAction",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"ProviderCleanup",permalink:"/api/interfaces/ProviderCleanup"},next:{title:"ProviderCleanupExecuteOptions",permalink:"/api/interfaces/ProviderCleanupExecuteOptions"}},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",p:"p",strong:"strong",...(0,t.a)(),...e.components};return(0,r.jsxs)(r.Fragment,{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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L575",children:"packages/extension-api/src/extension-api.d.ts:575"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L577",children:"packages/extension-api/src/extension-api.d.ts:577"})})]})}function p(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(l,{...e})}):l(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>c,a:()=>o});var r=i(27378);const t={},s=r.createContext(t);function o(e){const n=r.useContext(s);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function 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([[44619],{51880:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>d,contentTitle:()=>o,default:()=>p,frontMatter:()=>s,metadata:()=>c,toc:()=>a});var r=i(24246),t=i(71670);const s={},o="Interface: ProviderCleanupAction",c={id:"interfaces/ProviderCleanupAction",title:"Interface: ProviderCleanupAction",description:"Properties",source:"@site/api/interfaces/ProviderCleanupAction.md",sourceDirName:"interfaces",slug:"/interfaces/ProviderCleanupAction",permalink:"/api/interfaces/ProviderCleanupAction",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"ProviderCleanup",permalink:"/api/interfaces/ProviderCleanup"},next:{title:"ProviderCleanupExecuteOptions",permalink:"/api/interfaces/ProviderCleanupExecuteOptions"}},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",p:"p",strong:"strong",...(0,t.a)(),...e.components};return(0,r.jsxs)(r.Fragment,{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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L575",children:"packages/extension-api/src/extension-api.d.ts:575"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L577",children:"packages/extension-api/src/extension-api.d.ts:577"})})]})}function p(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(l,{...e})}):l(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>c,a:()=>o});var r=i(27378);const t={},s=r.createContext(t);function o(e){const n=r.useContext(s);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function 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.91736a75.js b/assets/js/ab69fe56.a4942a7c.js similarity index 82% rename from assets/js/ab69fe56.91736a75.js rename to assets/js/ab69fe56.a4942a7c.js index 21237f48b8b..5c10b4e2deb 100644 --- a/assets/js/ab69fe56.91736a75.js +++ b/assets/js/ab69fe56.a4942a7c.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[25314],{7641:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>c,contentTitle:()=>a,default:()=>l,frontMatter:()=>i,metadata:()=>r,toc:()=>p});var o=t(24246),s=t(71670);const i={},a="Type Alias: MountConfig",r={id:"type-aliases/MountConfig",title:"Type Alias: MountConfig",description:"MountConfig: MountSettings[]",source:"@site/api/type-aliases/MountConfig.md",sourceDirName:"type-aliases",slug:"/type-aliases/MountConfig",permalink:"/api/type-aliases/MountConfig",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"KubernetesGeneratorType",permalink:"/api/type-aliases/KubernetesGeneratorType"},next:{title:"MountConsistency",permalink:"/api/type-aliases/MountConsistency"}},c={},p=[{value:"Defined in",id:"defined-in",level:2}];function u(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(n.h1,{id:"type-alias-mountconfig",children:"Type Alias: MountConfig"}),"\n",(0,o.jsxs)(n.blockquote,{children:["\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.strong,{children:"MountConfig"}),": ",(0,o.jsx)(n.a,{href:"/api/interfaces/MountSettings",children:(0,o.jsx)(n.code,{children:"MountSettings"})}),"[]"]}),"\n"]}),"\n",(0,o.jsx)(n.h2,{id:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L2399",children:"packages/extension-api/src/extension-api.d.ts:2399"})})]})}function l(e={}){const{wrapper:n}={...(0,s.a)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(u,{...e})}):u(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>r,a:()=>a});var o=t(27378);const s={},i=o.createContext(s);function a(e){const n=o.useContext(i);return o.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function r(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:a(e.components),o.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[25314],{7641:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>c,contentTitle:()=>a,default:()=>u,frontMatter:()=>i,metadata:()=>r,toc:()=>p});var o=t(24246),s=t(71670);const i={},a="Type Alias: MountConfig",r={id:"type-aliases/MountConfig",title:"Type Alias: MountConfig",description:"MountConfig: MountSettings[]",source:"@site/api/type-aliases/MountConfig.md",sourceDirName:"type-aliases",slug:"/type-aliases/MountConfig",permalink:"/api/type-aliases/MountConfig",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"KubernetesGeneratorType",permalink:"/api/type-aliases/KubernetesGeneratorType"},next:{title:"MountConsistency",permalink:"/api/type-aliases/MountConsistency"}},c={},p=[{value:"Defined in",id:"defined-in",level:2}];function d(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(n.h1,{id:"type-alias-mountconfig",children:"Type Alias: MountConfig"}),"\n",(0,o.jsxs)(n.blockquote,{children:["\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.strong,{children:"MountConfig"}),": ",(0,o.jsx)(n.a,{href:"/api/interfaces/MountSettings",children:(0,o.jsx)(n.code,{children:"MountSettings"})}),"[]"]}),"\n"]}),"\n",(0,o.jsx)(n.h2,{id:"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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2399",children:"packages/extension-api/src/extension-api.d.ts:2399"})})]})}function u(e={}){const{wrapper:n}={...(0,s.a)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(d,{...e})}):d(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>r,a:()=>a});var o=t(27378);const s={},i=o.createContext(s);function a(e){const n=o.useContext(i);return o.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function r(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:a(e.components),o.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/adcef0a2.3f1c5cb7.js b/assets/js/adcef0a2.be39a8d7.js similarity index 83% rename from assets/js/adcef0a2.3f1c5cb7.js rename to assets/js/adcef0a2.be39a8d7.js index 20d0f75784d..285281547ce 100644 --- a/assets/js/adcef0a2.3f1c5cb7.js +++ b/assets/js/adcef0a2.be39a8d7.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[66464],{69741:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>o,contentTitle:()=>a,default:()=>l,frontMatter:()=>c,metadata:()=>s,toc:()=>d});var t=r(24246),i=r(71670);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",p:"p",strong:"strong",...(0,i.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L4395",children:"packages/extension-api/src/extension-api.d.ts:4395"})})]})}function l(e={}){const{wrapper:n}={...(0,i.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(h,{...e})}):h(e)}},71670:(e,n,r)=>{r.d(n,{Z:()=>s,a:()=>a});var t=r(27378);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([[66464],{69741:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>o,contentTitle:()=>a,default:()=>l,frontMatter:()=>i,metadata:()=>s,toc:()=>d});var t=r(24246),c=r(71670);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",p:"p",strong:"strong",...(0,c.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L4395",children:"packages/extension-api/src/extension-api.d.ts:4395"})})]})}function l(e={}){const{wrapper:n}={...(0,c.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(h,{...e})}):h(e)}},71670:(e,n,r)=>{r.d(n,{Z:()=>s,a:()=>a});var t=r(27378);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.19048dc9.js b/assets/js/adfdec4a.0c4258fc.js similarity index 87% rename from assets/js/adfdec4a.19048dc9.js rename to assets/js/adfdec4a.0c4258fc.js index 029e2a1a721..cbfb2880b68 100644 --- a/assets/js/adfdec4a.19048dc9.js +++ b/assets/js/adfdec4a.0c4258fc.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[71970],{94053:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>r,contentTitle:()=>c,default:()=>h,frontMatter:()=>t,metadata:()=>o,toc:()=>l});var s=i(24246),d=i(71670);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={},l=[{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 a(e){const n={a:"a",blockquote:"blockquote",code:"code",em:"em",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,d.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L1393",children:"packages/extension-api/src/extension-api.d.ts:1393"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L1381",children:"packages/extension-api/src/extension-api.d.ts:1381"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L1399",children:"packages/extension-api/src/extension-api.d.ts:1399"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L1385",children:"packages/extension-api/src/extension-api.d.ts:1385"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L1389",children:"packages/extension-api/src/extension-api.d.ts:1389"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L1405",children:"packages/extension-api/src/extension-api.d.ts:1405"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L1409",children:"packages/extension-api/src/extension-api.d.ts:1409"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L1413",children:"packages/extension-api/src/extension-api.d.ts:1413"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L1377",children:"packages/extension-api/src/extension-api.d.ts:1377"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L1427",children:"packages/extension-api/src/extension-api.d.ts:1427"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L1421",children:"packages/extension-api/src/extension-api.d.ts:1421"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L1417",children:"packages/extension-api/src/extension-api.d.ts:1417"})})]})}function h(e={}){const{wrapper:n}={...(0,d.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(a,{...e})}):a(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>o,a:()=>c});var s=i(27378);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([[71970],{94053:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>r,contentTitle:()=>c,default:()=>h,frontMatter:()=>t,metadata:()=>o,toc:()=>a});var s=i(24246),d=i(71670);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",hr:"hr",p:"p",strong:"strong",...(0,d.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L1393",children:"packages/extension-api/src/extension-api.d.ts:1393"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L1381",children:"packages/extension-api/src/extension-api.d.ts:1381"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L1399",children:"packages/extension-api/src/extension-api.d.ts:1399"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L1385",children:"packages/extension-api/src/extension-api.d.ts:1385"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L1389",children:"packages/extension-api/src/extension-api.d.ts:1389"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L1405",children:"packages/extension-api/src/extension-api.d.ts:1405"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L1409",children:"packages/extension-api/src/extension-api.d.ts:1409"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L1413",children:"packages/extension-api/src/extension-api.d.ts:1413"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L1377",children:"packages/extension-api/src/extension-api.d.ts:1377"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L1427",children:"packages/extension-api/src/extension-api.d.ts:1427"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L1421",children:"packages/extension-api/src/extension-api.d.ts:1421"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L1417",children:"packages/extension-api/src/extension-api.d.ts:1417"})})]})}function h(e={}){const{wrapper:n}={...(0,d.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>o,a:()=>c});var s=i(27378);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.03ca0fdd.js b/assets/js/ae4a775b.573a4b6c.js similarity index 81% rename from assets/js/ae4a775b.03ca0fdd.js rename to assets/js/ae4a775b.573a4b6c.js index f07b772b291..5c05ca584dd 100644 --- a/assets/js/ae4a775b.03ca0fdd.js +++ b/assets/js/ae4a775b.573a4b6c.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[30901],{54280:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>r,contentTitle:()=>i,default:()=>u,frontMatter:()=>c,metadata:()=>a,toc:()=>d});var s=t(24246),o=t(71670);const c={},i="Function: setValue()",a={id:"namespaces/context/functions/setValue",title:"Function: setValue()",description:"setValue(key, value, scope?): void",source:"@site/api/namespaces/context/functions/setValue.md",sourceDirName:"namespaces/context/functions",slug:"/namespaces/context/functions/setValue",permalink:"/api/namespaces/context/functions/setValue",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"context",permalink:"/api/namespaces/context/"},next:{title:"env",permalink:"/api/namespaces/env/"}},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",p:"p",strong:"strong",...(0,o.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"function-setvalue",children:"Function: setValue()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"setValue"}),"(",(0,s.jsx)(n.code,{children:"key"}),", ",(0,s.jsx)(n.code,{children:"value"}),", ",(0,s.jsx)(n.code,{children:"scope"}),"?): ",(0,s.jsx)(n.code,{children:"void"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:'Store a new value for key in the context.\nThis can be used in enablement of command or with the when property.\nThe key should consists of \'"extension-id"."actual-key"\'.'}),"\n",(0,s.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"key"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n",(0,s.jsx)(n.p,{children:"the key of the key/value pair to be added to the context"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"value"}),": ",(0,s.jsx)(n.code,{children:"any"})]}),"\n",(0,s.jsx)(n.p,{children:"value associated to the key"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"scope?"}),": ",(0,s.jsx)(n.code,{children:'"onboarding"'})]}),"\n",(0,s.jsx)(n.p,{children:"the scope to use to save the value"}),"\n",(0,s.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"void"})}),"\n",(0,s.jsx)(n.h2,{id:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L4277",children:"packages/extension-api/src/extension-api.d.ts:4277"})})]})}function u(e={}){const{wrapper:n}={...(0,o.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>a,a:()=>i});var s=t(27378);const o={},c=s.createContext(o);function i(e){const n=s.useContext(c);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function a(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:i(e.components),s.createElement(c.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[30901],{54280:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>r,contentTitle:()=>i,default:()=>u,frontMatter:()=>o,metadata:()=>a,toc:()=>d});var s=t(24246),c=t(71670);const o={},i="Function: setValue()",a={id:"namespaces/context/functions/setValue",title:"Function: setValue()",description:"setValue(key, value, scope?): void",source:"@site/api/namespaces/context/functions/setValue.md",sourceDirName:"namespaces/context/functions",slug:"/namespaces/context/functions/setValue",permalink:"/api/namespaces/context/functions/setValue",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"context",permalink:"/api/namespaces/context/"},next:{title:"env",permalink:"/api/namespaces/env/"}},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",p:"p",strong:"strong",...(0,c.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"function-setvalue",children:"Function: setValue()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"setValue"}),"(",(0,s.jsx)(n.code,{children:"key"}),", ",(0,s.jsx)(n.code,{children:"value"}),", ",(0,s.jsx)(n.code,{children:"scope"}),"?): ",(0,s.jsx)(n.code,{children:"void"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:'Store a new value for key in the context.\nThis can be used in enablement of command or with the when property.\nThe key should consists of \'"extension-id"."actual-key"\'.'}),"\n",(0,s.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"key"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n",(0,s.jsx)(n.p,{children:"the key of the key/value pair to be added to the context"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"value"}),": ",(0,s.jsx)(n.code,{children:"any"})]}),"\n",(0,s.jsx)(n.p,{children:"value associated to the key"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"scope?"}),": ",(0,s.jsx)(n.code,{children:'"onboarding"'})]}),"\n",(0,s.jsx)(n.p,{children:"the scope to use to save the value"}),"\n",(0,s.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"void"})}),"\n",(0,s.jsx)(n.h2,{id:"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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L4277",children:"packages/extension-api/src/extension-api.d.ts:4277"})})]})}function u(e={}){const{wrapper:n}={...(0,c.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>a,a:()=>i});var s=t(27378);const c={},o=s.createContext(c);function i(e){const n=s.useContext(o);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function a(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(c):e.components||c:i(e.components),s.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/b15eeff9.369891af.js b/assets/js/b15eeff9.369891af.js new file mode 100644 index 00000000000..a82a1339cf9 --- /dev/null +++ b/assets/js/b15eeff9.369891af.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[67411],{37749:(n,e,i)=>{i.r(e),i.d(e,{assets:()=>r,contentTitle:()=>c,default:()=>l,frontMatter:()=>s,metadata:()=>a,toc:()=>d});var t=i(24246),o=i(71670);const s={},c="Interface: AuthenticationSessionAccountInformation",a={id:"interfaces/AuthenticationSessionAccountInformation",title:"Interface: AuthenticationSessionAccountInformation",description:"The information of an account associated with an AuthenticationSession.",source:"@site/api/interfaces/AuthenticationSessionAccountInformation.md",sourceDirName:"interfaces",slug:"/interfaces/AuthenticationSessionAccountInformation",permalink:"/api/interfaces/AuthenticationSessionAccountInformation",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"AuthenticationSession",permalink:"/api/interfaces/AuthenticationSession"},next:{title:"AuthenticationSessionsChangeEvent",permalink:"/api/interfaces/AuthenticationSessionsChangeEvent"}},r={},d=[{value:"Properties",id:"properties",level:2},{value:"id",id:"id",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"label",id:"label",level:3},{value:"Defined in",id:"defined-in-1",level:4}];function h(n){const e={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,o.a)(),...n.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(e.h1,{id:"interface-authenticationsessionaccountinformation",children:"Interface: AuthenticationSessionAccountInformation"}),"\n",(0,t.jsxs)(e.p,{children:["The information of an account associated with an ",(0,t.jsx)(e.a,{href:"#AuthenticationSession",children:"AuthenticationSession"}),"."]}),"\n",(0,t.jsx)(e.h2,{id:"properties",children:"Properties"}),"\n",(0,t.jsx)(e.h3,{id:"id",children:"id"}),"\n",(0,t.jsxs)(e.blockquote,{children:["\n",(0,t.jsxs)(e.p,{children:[(0,t.jsx)(e.code,{children:"readonly"})," ",(0,t.jsx)(e.strong,{children:"id"}),": ",(0,t.jsx)(e.code,{children:"string"})]}),"\n"]}),"\n",(0,t.jsx)(e.p,{children:"The unique identifier of the account."}),"\n",(0,t.jsx)(e.h4,{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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L3708",children:"packages/extension-api/src/extension-api.d.ts:3708"})}),"\n",(0,t.jsx)(e.hr,{}),"\n",(0,t.jsx)(e.h3,{id:"label",children:"label"}),"\n",(0,t.jsxs)(e.blockquote,{children:["\n",(0,t.jsxs)(e.p,{children:[(0,t.jsx)(e.code,{children:"readonly"})," ",(0,t.jsx)(e.strong,{children:"label"}),": ",(0,t.jsx)(e.code,{children:"string"})]}),"\n"]}),"\n",(0,t.jsx)(e.p,{children:"The human-readable name of the account."}),"\n",(0,t.jsx)(e.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,t.jsx)(e.p,{children:(0,t.jsx)(e.a,{href:"https://github.com/containers/podman-desktop/blob/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L3713",children:"packages/extension-api/src/extension-api.d.ts:3713"})})]})}function l(n={}){const{wrapper:e}={...(0,o.a)(),...n.components};return e?(0,t.jsx)(e,{...n,children:(0,t.jsx)(h,{...n})}):h(n)}},71670:(n,e,i)=>{i.d(e,{Z:()=>a,a:()=>c});var t=i(27378);const o={},s=t.createContext(o);function c(n){const e=t.useContext(s);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:c(n.components),t.createElement(s.Provider,{value:e},n.children)}}}]); \ No newline at end of file diff --git a/assets/js/b15eeff9.968a0649.js b/assets/js/b15eeff9.968a0649.js deleted file mode 100644 index e5f00c81d13..00000000000 --- a/assets/js/b15eeff9.968a0649.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[67411],{37749:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>r,contentTitle:()=>c,default:()=>l,frontMatter:()=>s,metadata:()=>a,toc:()=>d});var t=i(24246),o=i(71670);const s={},c="Interface: AuthenticationSessionAccountInformation",a={id:"interfaces/AuthenticationSessionAccountInformation",title:"Interface: AuthenticationSessionAccountInformation",description:"The information of an account associated with an AuthenticationSession.",source:"@site/api/interfaces/AuthenticationSessionAccountInformation.md",sourceDirName:"interfaces",slug:"/interfaces/AuthenticationSessionAccountInformation",permalink:"/api/interfaces/AuthenticationSessionAccountInformation",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"AuthenticationSession",permalink:"/api/interfaces/AuthenticationSession"},next:{title:"AuthenticationSessionsChangeEvent",permalink:"/api/interfaces/AuthenticationSessionsChangeEvent"}},r={},d=[{value:"Properties",id:"properties",level:2},{value:"id",id:"id",level:3},{value:"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",hr:"hr",p:"p",strong:"strong",...(0,o.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"interface-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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L3708",children:"packages/extension-api/src/extension-api.d.ts:3708"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L3713",children:"packages/extension-api/src/extension-api.d.ts:3713"})})]})}function l(e={}){const{wrapper:n}={...(0,o.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(h,{...e})}):h(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>a,a:()=>c});var t=i(27378);const o={},s=t.createContext(o);function c(e){const n=t.useContext(s);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function 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.c9c8b47e.js b/assets/js/b3b7dd16.3822b4b8.js similarity index 97% rename from assets/js/b3b7dd16.c9c8b47e.js rename to assets/js/b3b7dd16.3822b4b8.js index 186c45a1b58..211c57bbca2 100644 --- a/assets/js/b3b7dd16.c9c8b47e.js +++ b/assets/js/b3b7dd16.3822b4b8.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[84960],{15614:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>o,default:()=>p,frontMatter:()=>i,metadata:()=>r,toc:()=>d});var s=t(24246),c=t(71670);const i={},o="Function: createCustomPick()",r={id:"namespaces/window/functions/createCustomPick",title:"Function: createCustomPick()",description:"createCustomPick\\(): CustomPick\\",source:"@site/api/namespaces/window/functions/createCustomPick.md",sourceDirName:"namespaces/window/functions",slug:"/namespaces/window/functions/createCustomPick",permalink:"/api/namespaces/window/functions/createCustomPick",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"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",p:"p",strong:"strong",...(0,c.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L2064",children:"packages/extension-api/src/extension-api.d.ts:2064"})})]})}function p(e={}){const{wrapper:n}={...(0,c.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(u,{...e})}):u(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>r,a:()=>o});var s=t(27378);const c={},i=s.createContext(c);function o(e){const n=s.useContext(i);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function r(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(c):e.components||c:o(e.components),s.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[84960],{15614:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>o,default:()=>p,frontMatter:()=>i,metadata:()=>r,toc:()=>d});var s=t(24246),c=t(71670);const i={},o="Function: createCustomPick()",r={id:"namespaces/window/functions/createCustomPick",title:"Function: createCustomPick()",description:"createCustomPick\\(): CustomPick\\",source:"@site/api/namespaces/window/functions/createCustomPick.md",sourceDirName:"namespaces/window/functions",slug:"/namespaces/window/functions/createCustomPick",permalink:"/api/namespaces/window/functions/createCustomPick",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"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",p:"p",strong:"strong",...(0,c.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2064",children:"packages/extension-api/src/extension-api.d.ts:2064"})})]})}function p(e={}){const{wrapper:n}={...(0,c.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(u,{...e})}):u(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>r,a:()=>o});var s=t(27378);const c={},i=s.createContext(c);function o(e){const n=s.useContext(i);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function r(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(c):e.components||c:o(e.components),s.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/b4df9b48.7aabbbf8.js b/assets/js/b4df9b48.da951941.js similarity index 87% rename from assets/js/b4df9b48.7aabbbf8.js rename to assets/js/b4df9b48.da951941.js index c9dbe5079f8..e16735ee464 100644 --- a/assets/js/b4df9b48.7aabbbf8.js +++ b/assets/js/b4df9b48.da951941.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[35425],{91258:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>a,contentTitle:()=>d,default:()=>h,frontMatter:()=>t,metadata:()=>c,toc:()=>o});var s=i(24246),r=i(71670);const t={},d="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={},o=[{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 l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",li:"li",p:"p",strong:"strong",ul:"ul",...(0,r.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L887",children:"packages/extension-api/src/extension-api.d.ts:887"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L879",children:"packages/extension-api/src/extension-api.d.ts:879"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L886",children:"packages/extension-api/src/extension-api.d.ts:886"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L878",children:"packages/extension-api/src/extension-api.d.ts:878"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L885",children:"packages/extension-api/src/extension-api.d.ts:885"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L883",children:"packages/extension-api/src/extension-api.d.ts:883"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L875",children:"packages/extension-api/src/extension-api.d.ts:875"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L884",children:"packages/extension-api/src/extension-api.d.ts:884"})})]})}function h(e={}){const{wrapper:n}={...(0,r.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>c,a:()=>d});var s=i(27378);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([[35425],{91258:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>a,contentTitle:()=>t,default:()=>h,frontMatter:()=>d,metadata:()=>c,toc:()=>o});var s=i(24246),r=i(71670);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={},o=[{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 l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",li:"li",p:"p",strong:"strong",ul:"ul",...(0,r.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L887",children:"packages/extension-api/src/extension-api.d.ts:887"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L879",children:"packages/extension-api/src/extension-api.d.ts:879"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L886",children:"packages/extension-api/src/extension-api.d.ts:886"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L878",children:"packages/extension-api/src/extension-api.d.ts:878"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L885",children:"packages/extension-api/src/extension-api.d.ts:885"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L883",children:"packages/extension-api/src/extension-api.d.ts:883"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L875",children:"packages/extension-api/src/extension-api.d.ts:875"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L884",children:"packages/extension-api/src/extension-api.d.ts:884"})})]})}function h(e={}){const{wrapper:n}={...(0,r.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>c,a:()=>t});var s=i(27378);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.8a9686d3.js b/assets/js/b5114993.5ddd4afd.js similarity index 87% rename from assets/js/b5114993.8a9686d3.js rename to assets/js/b5114993.5ddd4afd.js index 76f37c79da6..9778af48d45 100644 --- a/assets/js/b5114993.8a9686d3.js +++ b/assets/js/b5114993.5ddd4afd.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[54373],{48444:(e,s,n)=>{n.r(s),n.d(s,{assets:()=>c,contentTitle:()=>d,default:()=>h,frontMatter:()=>r,metadata:()=>a,toc:()=>t});var i=n(24246),l=n(71670);const r={},d="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",hr:"hr",li:"li",p:"p",strong:"strong",ul:"ul",...(0,l.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(s.h1,{id:"class-disposable",children:"Class: Disposable"}),"\n",(0,i.jsx)(s.h2,{id:"extended-by",children:"Extended by"}),"\n",(0,i.jsxs)(s.ul,{children:["\n",(0,i.jsx)(s.li,{children:(0,i.jsx)(s.a,{href:"/api/interfaces/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/804b2198fda0957e1ecfb87539f019eb9b79a66f/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/804b2198fda0957e1ecfb87539f019eb9b79a66f/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/804b2198fda0957e1ecfb87539f019eb9b79a66f/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/804b2198fda0957e1ecfb87539f019eb9b79a66f/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/804b2198fda0957e1ecfb87539f019eb9b79a66f/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,l.a)(),...e.components};return s?(0,i.jsx)(s,{...e,children:(0,i.jsx)(o,{...e})}):o(e)}},71670:(e,s,n)=>{n.d(s,{Z:()=>a,a:()=>d});var i=n(27378);const l={},r=i.createContext(l);function d(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(l):e.components||l:d(e.components),i.createElement(r.Provider,{value:s},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[54373],{48444:(e,s,n)=>{n.r(s),n.d(s,{assets:()=>c,contentTitle:()=>r,default:()=>h,frontMatter:()=>l,metadata:()=>a,toc:()=>t});var i=n(24246),d=n(71670);const l={},r="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",hr:"hr",li:"li",p:"p",strong:"strong",ul:"ul",...(0,d.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(s.h1,{id:"class-disposable",children:"Class: Disposable"}),"\n",(0,i.jsx)(s.h2,{id:"extended-by",children:"Extended by"}),"\n",(0,i.jsxs)(s.ul,{children:["\n",(0,i.jsx)(s.li,{children:(0,i.jsx)(s.a,{href:"/api/interfaces/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/bd83a8b2bb8ab886dc757381b589638cbda150d0/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/bd83a8b2bb8ab886dc757381b589638cbda150d0/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/bd83a8b2bb8ab886dc757381b589638cbda150d0/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/bd83a8b2bb8ab886dc757381b589638cbda150d0/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/bd83a8b2bb8ab886dc757381b589638cbda150d0/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.a)(),...e.components};return s?(0,i.jsx)(s,{...e,children:(0,i.jsx)(o,{...e})}):o(e)}},71670:(e,s,n)=>{n.d(s,{Z:()=>a,a:()=>r});var i=n(27378);const d={},l=i.createContext(d);function r(e){const s=i.useContext(l);return i.useMemo((function(){return"function"==typeof e?e(s):{...s,...e}}),[s,e])}function a(e){let s;return s=e.disableParentContext?"function"==typeof e.components?e.components(d):e.components||d:r(e.components),i.createElement(l.Provider,{value:s},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/b51a9aee.a6df85a8.js b/assets/js/b51a9aee.32335301.js similarity index 87% rename from assets/js/b51a9aee.a6df85a8.js rename to assets/js/b51a9aee.32335301.js index f6fc2029e09..20995b9e294 100644 --- a/assets/js/b51a9aee.a6df85a8.js +++ b/assets/js/b51a9aee.32335301.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[39620],{42154:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>r,contentTitle:()=>a,default:()=>l,frontMatter:()=>s,metadata:()=>c,toc:()=>u});var i=t(24246),o=t(71670);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={},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",p:"p",strong:"strong",...(0,o.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L4444",children:"packages/extension-api/src/extension-api.d.ts:4444"})})]})}function l(e={}){const{wrapper:n}={...(0,o.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(d,{...e})}):d(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>c,a:()=>a});var i=t(27378);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([[39620],{42154:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>r,contentTitle:()=>a,default:()=>l,frontMatter:()=>s,metadata:()=>c,toc:()=>d});var i=t(24246),o=t(71670);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",p:"p",strong:"strong",...(0,o.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L4444",children:"packages/extension-api/src/extension-api.d.ts:4444"})})]})}function l(e={}){const{wrapper:n}={...(0,o.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(u,{...e})}):u(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>c,a:()=>a});var i=t(27378);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.cdcdc183.js b/assets/js/b52d840d.06cff017.js similarity index 87% rename from assets/js/b52d840d.cdcdc183.js rename to assets/js/b52d840d.06cff017.js index 95ef67fa263..387069c5867 100644 --- a/assets/js/b52d840d.cdcdc183.js +++ b/assets/js/b52d840d.06cff017.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[35584],{26317:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>r,contentTitle:()=>c,default:()=>h,frontMatter:()=>t,metadata:()=>a,toc:()=>o});var s=i(24246),d=i(71670);const t={},c="Interface: VolumeInfo",a={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",hr:"hr",p:"p",strong:"strong",...(0,d.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L3383",children:"packages/extension-api/src/extension-api.d.ts:3383"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L3386",children:"packages/extension-api/src/extension-api.d.ts:3386"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L3389",children:"packages/extension-api/src/extension-api.d.ts:3389"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L3387",children:"packages/extension-api/src/extension-api.d.ts:3387"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/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:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L3391",children:"packages/extension-api/src/extension-api.d.ts:3391"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L3390",children:"packages/extension-api/src/extension-api.d.ts:3390"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L3388",children:"packages/extension-api/src/extension-api.d.ts:3388"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L3392",children:"packages/extension-api/src/extension-api.d.ts:3392"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L3384",children:"packages/extension-api/src/extension-api.d.ts:3384"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/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:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L3382",children:"packages/extension-api/src/extension-api.d.ts:3382"})})]})}function h(e={}){const{wrapper:n}={...(0,d.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>a,a:()=>c});var s=i(27378);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 a(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([[35584],{26317:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>r,contentTitle:()=>c,default:()=>h,frontMatter:()=>t,metadata:()=>a,toc:()=>o});var s=i(24246),d=i(71670);const t={},c="Interface: VolumeInfo",a={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",hr:"hr",p:"p",strong:"strong",...(0,d.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L3383",children:"packages/extension-api/src/extension-api.d.ts:3383"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L3386",children:"packages/extension-api/src/extension-api.d.ts:3386"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L3389",children:"packages/extension-api/src/extension-api.d.ts:3389"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L3387",children:"packages/extension-api/src/extension-api.d.ts:3387"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/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:"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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L3391",children:"packages/extension-api/src/extension-api.d.ts:3391"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L3390",children:"packages/extension-api/src/extension-api.d.ts:3390"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L3388",children:"packages/extension-api/src/extension-api.d.ts:3388"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L3392",children:"packages/extension-api/src/extension-api.d.ts:3392"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L3384",children:"packages/extension-api/src/extension-api.d.ts:3384"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/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:"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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L3382",children:"packages/extension-api/src/extension-api.d.ts:3382"})})]})}function h(e={}){const{wrapper:n}={...(0,d.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>a,a:()=>c});var s=i(27378);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 a(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/b5b19789.6c7ec83f.js b/assets/js/b5b19789.95404402.js similarity index 94% rename from assets/js/b5b19789.6c7ec83f.js rename to assets/js/b5b19789.95404402.js index 6069c8c5df7..367d894d2a1 100644 --- a/assets/js/b5b19789.6c7ec83f.js +++ b/assets/js/b5b19789.95404402.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[80355],{40508:(t,e,n)=>{n.r(e),n.d(e,{assets:()=>c,contentTitle:()=>s,default:()=>u,frontMatter:()=>r,metadata:()=>o,toc:()=>l});var i=n(24246),a=n(71670);const r={},s="Variable: StatusBarAlignRight",o={id:"variables/StatusBarAlignRight",title:"Variable: StatusBarAlignRight",description:"const StatusBarAlignRight: \"RIGHT\" = 'RIGHT'",source:"@site/api/variables/StatusBarAlignRight.md",sourceDirName:"variables",slug:"/variables/StatusBarAlignRight",permalink:"/api/variables/StatusBarAlignRight",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"StatusBarAlignLeft",permalink:"/api/variables/StatusBarAlignLeft"},next:{title:"StatusBarItemDefaultPriority",permalink:"/api/variables/StatusBarItemDefaultPriority"}},c={},l=[{value:"Defined in",id:"defined-in",level:2}];function d(t){const e={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,a.a)(),...t.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(e.h1,{id:"variable-statusbaralignright",children:"Variable: StatusBarAlignRight"}),"\n",(0,i.jsxs)(e.blockquote,{children:["\n",(0,i.jsxs)(e.p,{children:[(0,i.jsx)(e.code,{children:"const"})," ",(0,i.jsx)(e.strong,{children:"StatusBarAlignRight"}),": ",(0,i.jsx)(e.code,{children:'"RIGHT"'})," = ",(0,i.jsx)(e.code,{children:"'RIGHT'"})]}),"\n"]}),"\n",(0,i.jsx)(e.p,{children:"Aligned to the right side."}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L1466",children:"packages/extension-api/src/extension-api.d.ts:1466"})})]})}function u(t={}){const{wrapper:e}={...(0,a.a)(),...t.components};return e?(0,i.jsx)(e,{...t,children:(0,i.jsx)(d,{...t})}):d(t)}},71670:(t,e,n)=>{n.d(e,{Z:()=>o,a:()=>s});var i=n(27378);const a={},r=i.createContext(a);function s(t){const e=i.useContext(r);return i.useMemo((function(){return"function"==typeof t?t(e):{...e,...t}}),[e,t])}function o(t){let e;return e=t.disableParentContext?"function"==typeof t.components?t.components(a):t.components||a:s(t.components),i.createElement(r.Provider,{value:e},t.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[80355],{40508:(t,e,n)=>{n.r(e),n.d(e,{assets:()=>c,contentTitle:()=>s,default:()=>u,frontMatter:()=>r,metadata:()=>o,toc:()=>l});var i=n(24246),a=n(71670);const r={},s="Variable: StatusBarAlignRight",o={id:"variables/StatusBarAlignRight",title:"Variable: StatusBarAlignRight",description:"const StatusBarAlignRight: \"RIGHT\" = 'RIGHT'",source:"@site/api/variables/StatusBarAlignRight.md",sourceDirName:"variables",slug:"/variables/StatusBarAlignRight",permalink:"/api/variables/StatusBarAlignRight",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"StatusBarAlignLeft",permalink:"/api/variables/StatusBarAlignLeft"},next:{title:"StatusBarItemDefaultPriority",permalink:"/api/variables/StatusBarItemDefaultPriority"}},c={},l=[{value:"Defined in",id:"defined-in",level:2}];function d(t){const e={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,a.a)(),...t.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(e.h1,{id:"variable-statusbaralignright",children:"Variable: StatusBarAlignRight"}),"\n",(0,i.jsxs)(e.blockquote,{children:["\n",(0,i.jsxs)(e.p,{children:[(0,i.jsx)(e.code,{children:"const"})," ",(0,i.jsx)(e.strong,{children:"StatusBarAlignRight"}),": ",(0,i.jsx)(e.code,{children:'"RIGHT"'})," = ",(0,i.jsx)(e.code,{children:"'RIGHT'"})]}),"\n"]}),"\n",(0,i.jsx)(e.p,{children:"Aligned to the right side."}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L1466",children:"packages/extension-api/src/extension-api.d.ts:1466"})})]})}function u(t={}){const{wrapper:e}={...(0,a.a)(),...t.components};return e?(0,i.jsx)(e,{...t,children:(0,i.jsx)(d,{...t})}):d(t)}},71670:(t,e,n)=>{n.d(e,{Z:()=>o,a:()=>s});var i=n(27378);const a={},r=i.createContext(a);function s(t){const e=i.useContext(r);return i.useMemo((function(){return"function"==typeof t?t(e):{...e,...t}}),[e,t])}function o(t){let e;return e=t.disableParentContext?"function"==typeof t.components?t.components(a):t.components||a:s(t.components),i.createElement(r.Provider,{value:e},t.children)}}}]); \ No newline at end of file diff --git a/assets/js/b5ec5208.df89b14d.js b/assets/js/b5ec5208.78d246dd.js similarity index 96% rename from assets/js/b5ec5208.df89b14d.js rename to assets/js/b5ec5208.78d246dd.js index 4b4a70c2beb..da2823f316c 100644 --- a/assets/js/b5ec5208.df89b14d.js +++ b/assets/js/b5ec5208.78d246dd.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[92514],{45617:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>a,contentTitle:()=>o,default:()=>p,frontMatter:()=>t,metadata:()=>d,toc:()=>c});var i=s(24246),r=s(71670);const t={},o="Function: onDidUpdateProvider()",d={id:"namespaces/provider/functions/onDidUpdateProvider",title:"Function: onDidUpdateProvider()",description:"onDidUpdateProvider(listener, thisArgs?, disposables?): Disposable",source:"@site/api/namespaces/provider/functions/onDidUpdateProvider.md",sourceDirName:"namespaces/provider/functions",slug:"/namespaces/provider/functions/onDidUpdateProvider",permalink:"/api/namespaces/provider/functions/onDidUpdateProvider",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"onDidUpdateKubernetesConnection",permalink:"/api/namespaces/provider/functions/onDidUpdateKubernetesConnection"},next:{title:"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",p:"p",strong:"strong",...(0,r.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"function-ondidupdateprovider",children:"Function: onDidUpdateProvider()"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"onDidUpdateProvider"}),"(",(0,i.jsx)(n.code,{children:"listener"}),", ",(0,i.jsx)(n.code,{children:"thisArgs"}),"?, ",(0,i.jsx)(n.code,{children:"disposables"}),"?): ",(0,i.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(n.code,{children:"Disposable"})})]}),"\n"]}),"\n",(0,i.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"listener"})]}),"\n",(0,i.jsx)(n.p,{children:"The listener function will be called when the event happens."}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"thisArgs?"}),": ",(0,i.jsx)(n.code,{children:"any"})]}),"\n",(0,i.jsxs)(n.p,{children:["The ",(0,i.jsx)(n.code,{children:"this"}),"-argument which will be used when calling the event listener."]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"disposables?"}),": ",(0,i.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(n.code,{children:"Disposable"})}),"[]"]}),"\n",(0,i.jsxs)(n.p,{children:["An array to which a ",(0,i.jsx)(n.a,{href:"/api/classes/Disposable",children:"Disposable"})," will be added."]}),"\n",(0,i.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(n.code,{children:"Disposable"})})}),"\n",(0,i.jsx)(n.p,{children:"A disposable which unsubscribes the event listener."}),"\n",(0,i.jsx)(n.h2,{id:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L811",children:"packages/extension-api/src/extension-api.d.ts:811"})})]})}function p(e={}){const{wrapper:n}={...(0,r.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>d,a:()=>o});var i=s(27378);const r={},t=i.createContext(r);function o(e){const n=i.useContext(t);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function d(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:o(e.components),i.createElement(t.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[92514],{45617:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>a,contentTitle:()=>o,default:()=>p,frontMatter:()=>t,metadata:()=>d,toc:()=>c});var i=s(24246),r=s(71670);const t={},o="Function: onDidUpdateProvider()",d={id:"namespaces/provider/functions/onDidUpdateProvider",title:"Function: onDidUpdateProvider()",description:"onDidUpdateProvider(listener, thisArgs?, disposables?): Disposable",source:"@site/api/namespaces/provider/functions/onDidUpdateProvider.md",sourceDirName:"namespaces/provider/functions",slug:"/namespaces/provider/functions/onDidUpdateProvider",permalink:"/api/namespaces/provider/functions/onDidUpdateProvider",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"onDidUpdateKubernetesConnection",permalink:"/api/namespaces/provider/functions/onDidUpdateKubernetesConnection"},next:{title:"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",p:"p",strong:"strong",...(0,r.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"function-ondidupdateprovider",children:"Function: onDidUpdateProvider()"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"onDidUpdateProvider"}),"(",(0,i.jsx)(n.code,{children:"listener"}),", ",(0,i.jsx)(n.code,{children:"thisArgs"}),"?, ",(0,i.jsx)(n.code,{children:"disposables"}),"?): ",(0,i.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(n.code,{children:"Disposable"})})]}),"\n"]}),"\n",(0,i.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"listener"})]}),"\n",(0,i.jsx)(n.p,{children:"The listener function will be called when the event happens."}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"thisArgs?"}),": ",(0,i.jsx)(n.code,{children:"any"})]}),"\n",(0,i.jsxs)(n.p,{children:["The ",(0,i.jsx)(n.code,{children:"this"}),"-argument which will be used when calling the event listener."]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"disposables?"}),": ",(0,i.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(n.code,{children:"Disposable"})}),"[]"]}),"\n",(0,i.jsxs)(n.p,{children:["An array to which a ",(0,i.jsx)(n.a,{href:"/api/classes/Disposable",children:"Disposable"})," will be added."]}),"\n",(0,i.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(n.code,{children:"Disposable"})})}),"\n",(0,i.jsx)(n.p,{children:"A disposable which unsubscribes the event listener."}),"\n",(0,i.jsx)(n.h2,{id:"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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L811",children:"packages/extension-api/src/extension-api.d.ts:811"})})]})}function p(e={}){const{wrapper:n}={...(0,r.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>d,a:()=>o});var i=s(27378);const r={},t=i.createContext(r);function o(e){const n=i.useContext(t);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function d(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:o(e.components),i.createElement(t.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/b66ca8cf.52e5f450.js b/assets/js/b66ca8cf.08195aaf.js similarity index 96% rename from assets/js/b66ca8cf.52e5f450.js rename to assets/js/b66ca8cf.08195aaf.js index a92bce7e2ac..3f38e4076e1 100644 --- a/assets/js/b66ca8cf.52e5f450.js +++ b/assets/js/b66ca8cf.08195aaf.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[42205],{94022:(e,s,n)=>{n.r(s),n.d(s,{assets:()=>a,contentTitle:()=>c,default:()=>p,frontMatter:()=>t,metadata:()=>o,toc:()=>d});var i=n(24246),r=n(71670);const t={},c="Function: onDidUnregisterRegistry()",o={id:"namespaces/registry/functions/onDidUnregisterRegistry",title:"Function: onDidUnregisterRegistry()",description:"onDidUnregisterRegistry(listener, thisArgs?, disposables?): Disposable",source:"@site/api/namespaces/registry/functions/onDidUnregisterRegistry.md",sourceDirName:"namespaces/registry/functions",slug:"/namespaces/registry/functions/onDidUnregisterRegistry",permalink:"/api/namespaces/registry/functions/onDidUnregisterRegistry",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"onDidRegisterRegistry",permalink:"/api/namespaces/registry/functions/onDidRegisterRegistry"},next:{title:"onDidUpdateRegistry",permalink:"/api/namespaces/registry/functions/onDidUpdateRegistry"}},a={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Defined in",id:"defined-in",level:2}];function l(e){const s={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,r.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(s.h1,{id:"function-ondidunregisterregistry",children:"Function: onDidUnregisterRegistry()"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"onDidUnregisterRegistry"}),"(",(0,i.jsx)(s.code,{children:"listener"}),", ",(0,i.jsx)(s.code,{children:"thisArgs"}),"?, ",(0,i.jsx)(s.code,{children:"disposables"}),"?): ",(0,i.jsx)(s.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(s.code,{children:"Disposable"})})]}),"\n"]}),"\n",(0,i.jsx)(s.h2,{id:"parameters",children:"Parameters"}),"\n",(0,i.jsxs)(s.p,{children:["\u2022 ",(0,i.jsx)(s.strong,{children:"listener"})]}),"\n",(0,i.jsx)(s.p,{children:"The listener function will be called when the event happens."}),"\n",(0,i.jsxs)(s.p,{children:["\u2022 ",(0,i.jsx)(s.strong,{children:"thisArgs?"}),": ",(0,i.jsx)(s.code,{children:"any"})]}),"\n",(0,i.jsxs)(s.p,{children:["The ",(0,i.jsx)(s.code,{children:"this"}),"-argument which will be used when calling the event listener."]}),"\n",(0,i.jsxs)(s.p,{children:["\u2022 ",(0,i.jsx)(s.strong,{children:"disposables?"}),": ",(0,i.jsx)(s.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(s.code,{children:"Disposable"})}),"[]"]}),"\n",(0,i.jsxs)(s.p,{children:["An array to which a ",(0,i.jsx)(s.a,{href:"/api/classes/Disposable",children:"Disposable"})," will be added."]}),"\n",(0,i.jsx)(s.h2,{id:"returns",children:"Returns"}),"\n",(0,i.jsx)(s.p,{children:(0,i.jsx)(s.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(s.code,{children:"Disposable"})})}),"\n",(0,i.jsx)(s.p,{children:"A disposable which unsubscribes the event listener."}),"\n",(0,i.jsx)(s.h2,{id:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L912",children:"packages/extension-api/src/extension-api.d.ts:912"})})]})}function p(e={}){const{wrapper:s}={...(0,r.a)(),...e.components};return s?(0,i.jsx)(s,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},71670:(e,s,n)=>{n.d(s,{Z:()=>o,a:()=>c});var i=n(27378);const r={},t=i.createContext(r);function c(e){const s=i.useContext(t);return i.useMemo((function(){return"function"==typeof e?e(s):{...s,...e}}),[s,e])}function o(e){let s;return s=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:c(e.components),i.createElement(t.Provider,{value:s},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[42205],{94022:(e,s,n)=>{n.r(s),n.d(s,{assets:()=>a,contentTitle:()=>c,default:()=>p,frontMatter:()=>t,metadata:()=>o,toc:()=>d});var i=n(24246),r=n(71670);const t={},c="Function: onDidUnregisterRegistry()",o={id:"namespaces/registry/functions/onDidUnregisterRegistry",title:"Function: onDidUnregisterRegistry()",description:"onDidUnregisterRegistry(listener, thisArgs?, disposables?): Disposable",source:"@site/api/namespaces/registry/functions/onDidUnregisterRegistry.md",sourceDirName:"namespaces/registry/functions",slug:"/namespaces/registry/functions/onDidUnregisterRegistry",permalink:"/api/namespaces/registry/functions/onDidUnregisterRegistry",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"onDidRegisterRegistry",permalink:"/api/namespaces/registry/functions/onDidRegisterRegistry"},next:{title:"onDidUpdateRegistry",permalink:"/api/namespaces/registry/functions/onDidUpdateRegistry"}},a={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Defined in",id:"defined-in",level:2}];function l(e){const s={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,r.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(s.h1,{id:"function-ondidunregisterregistry",children:"Function: onDidUnregisterRegistry()"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"onDidUnregisterRegistry"}),"(",(0,i.jsx)(s.code,{children:"listener"}),", ",(0,i.jsx)(s.code,{children:"thisArgs"}),"?, ",(0,i.jsx)(s.code,{children:"disposables"}),"?): ",(0,i.jsx)(s.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(s.code,{children:"Disposable"})})]}),"\n"]}),"\n",(0,i.jsx)(s.h2,{id:"parameters",children:"Parameters"}),"\n",(0,i.jsxs)(s.p,{children:["\u2022 ",(0,i.jsx)(s.strong,{children:"listener"})]}),"\n",(0,i.jsx)(s.p,{children:"The listener function will be called when the event happens."}),"\n",(0,i.jsxs)(s.p,{children:["\u2022 ",(0,i.jsx)(s.strong,{children:"thisArgs?"}),": ",(0,i.jsx)(s.code,{children:"any"})]}),"\n",(0,i.jsxs)(s.p,{children:["The ",(0,i.jsx)(s.code,{children:"this"}),"-argument which will be used when calling the event listener."]}),"\n",(0,i.jsxs)(s.p,{children:["\u2022 ",(0,i.jsx)(s.strong,{children:"disposables?"}),": ",(0,i.jsx)(s.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(s.code,{children:"Disposable"})}),"[]"]}),"\n",(0,i.jsxs)(s.p,{children:["An array to which a ",(0,i.jsx)(s.a,{href:"/api/classes/Disposable",children:"Disposable"})," will be added."]}),"\n",(0,i.jsx)(s.h2,{id:"returns",children:"Returns"}),"\n",(0,i.jsx)(s.p,{children:(0,i.jsx)(s.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(s.code,{children:"Disposable"})})}),"\n",(0,i.jsx)(s.p,{children:"A disposable which unsubscribes the event listener."}),"\n",(0,i.jsx)(s.h2,{id:"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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L912",children:"packages/extension-api/src/extension-api.d.ts:912"})})]})}function p(e={}){const{wrapper:s}={...(0,r.a)(),...e.components};return s?(0,i.jsx)(s,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},71670:(e,s,n)=>{n.d(s,{Z:()=>o,a:()=>c});var i=n(27378);const r={},t=i.createContext(r);function c(e){const s=i.useContext(t);return i.useMemo((function(){return"function"==typeof e?e(s):{...s,...e}}),[s,e])}function o(e){let s;return s=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:c(e.components),i.createElement(t.Provider,{value:s},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/b678a236.46b6554f.js b/assets/js/b678a236.52fcb227.js similarity index 98% rename from assets/js/b678a236.46b6554f.js rename to assets/js/b678a236.52fcb227.js index c99b46e1316..1b85bcd7553 100644 --- a/assets/js/b678a236.46b6554f.js +++ b/assets/js/b678a236.52fcb227.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[37245],{3707:(n,e,t)=>{t.r(e),t.d(e,{assets:()=>c,contentTitle:()=>r,default:()=>l,frontMatter:()=>o,metadata:()=>a,toc:()=>d});var i=t(24246),s=t(71670);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",p:"p",strong:"strong",...(0,s.a)(),...n.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(e.h1,{id:"function-stopcontainer",children:"Function: stopContainer()"}),"\n",(0,i.jsxs)(e.blockquote,{children:["\n",(0,i.jsxs)(e.p,{children:[(0,i.jsx)(e.strong,{children:"stopContainer"}),"(",(0,i.jsx)(e.code,{children:"engineId"}),", ",(0,i.jsx)(e.code,{children:"id"}),"): ",(0,i.jsx)(e.code,{children:"Promise"}),"<",(0,i.jsx)(e.code,{children:"void"}),">"]}),"\n"]}),"\n",(0,i.jsx)(e.p,{children:"Stop an existing container"}),"\n",(0,i.jsx)(e.h2,{id:"parameters",children:"Parameters"}),"\n",(0,i.jsxs)(e.p,{children:["\u2022 ",(0,i.jsx)(e.strong,{children:"engineId"}),": ",(0,i.jsx)(e.code,{children:"string"})]}),"\n",(0,i.jsxs)(e.p,{children:["the id of the engine managing the container, obtained from the result of ",(0,i.jsx)(e.a,{href:"/api/namespaces/containerEngine/functions/listContainers",children:"containerEngine.listContainers"})]}),"\n",(0,i.jsxs)(e.p,{children:["\u2022 ",(0,i.jsx)(e.strong,{children:"id"}),": ",(0,i.jsx)(e.code,{children:"string"})]}),"\n",(0,i.jsxs)(e.p,{children:["the id of the container on this engine, obtained from the result of ",(0,i.jsx)(e.a,{href:"/api/namespaces/containerEngine/functions/listContainers",children:"containerEngine.listContainers"})," or as the result of ",(0,i.jsx)(e.a,{href:"/api/namespaces/containerEngine/functions/createContainer",children:"containerEngine.createContainer"})]}),"\n",(0,i.jsx)(e.h2,{id:"returns",children:"Returns"}),"\n",(0,i.jsxs)(e.p,{children:[(0,i.jsx)(e.code,{children:"Promise"}),"<",(0,i.jsx)(e.code,{children:"void"}),">"]}),"\n",(0,i.jsx)(e.h2,{id:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L3519",children:"packages/extension-api/src/extension-api.d.ts:3519"})})]})}function l(n={}){const{wrapper:e}={...(0,s.a)(),...n.components};return e?(0,i.jsx)(e,{...n,children:(0,i.jsx)(p,{...n})}):p(n)}},71670:(n,e,t)=>{t.d(e,{Z:()=>a,a:()=>r});var i=t(27378);const s={},o=i.createContext(s);function r(n){const e=i.useContext(o);return i.useMemo((function(){return"function"==typeof n?n(e):{...e,...n}}),[e,n])}function a(n){let e;return e=n.disableParentContext?"function"==typeof n.components?n.components(s):n.components||s:r(n.components),i.createElement(o.Provider,{value:e},n.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[37245],{3707:(n,e,t)=>{t.r(e),t.d(e,{assets:()=>c,contentTitle:()=>r,default:()=>l,frontMatter:()=>o,metadata:()=>a,toc:()=>d});var i=t(24246),s=t(71670);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",p:"p",strong:"strong",...(0,s.a)(),...n.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(e.h1,{id:"function-stopcontainer",children:"Function: stopContainer()"}),"\n",(0,i.jsxs)(e.blockquote,{children:["\n",(0,i.jsxs)(e.p,{children:[(0,i.jsx)(e.strong,{children:"stopContainer"}),"(",(0,i.jsx)(e.code,{children:"engineId"}),", ",(0,i.jsx)(e.code,{children:"id"}),"): ",(0,i.jsx)(e.code,{children:"Promise"}),"<",(0,i.jsx)(e.code,{children:"void"}),">"]}),"\n"]}),"\n",(0,i.jsx)(e.p,{children:"Stop an existing container"}),"\n",(0,i.jsx)(e.h2,{id:"parameters",children:"Parameters"}),"\n",(0,i.jsxs)(e.p,{children:["\u2022 ",(0,i.jsx)(e.strong,{children:"engineId"}),": ",(0,i.jsx)(e.code,{children:"string"})]}),"\n",(0,i.jsxs)(e.p,{children:["the id of the engine managing the container, obtained from the result of ",(0,i.jsx)(e.a,{href:"/api/namespaces/containerEngine/functions/listContainers",children:"containerEngine.listContainers"})]}),"\n",(0,i.jsxs)(e.p,{children:["\u2022 ",(0,i.jsx)(e.strong,{children:"id"}),": ",(0,i.jsx)(e.code,{children:"string"})]}),"\n",(0,i.jsxs)(e.p,{children:["the id of the container on this engine, obtained from the result of ",(0,i.jsx)(e.a,{href:"/api/namespaces/containerEngine/functions/listContainers",children:"containerEngine.listContainers"})," or as the result of ",(0,i.jsx)(e.a,{href:"/api/namespaces/containerEngine/functions/createContainer",children:"containerEngine.createContainer"})]}),"\n",(0,i.jsx)(e.h2,{id:"returns",children:"Returns"}),"\n",(0,i.jsxs)(e.p,{children:[(0,i.jsx)(e.code,{children:"Promise"}),"<",(0,i.jsx)(e.code,{children:"void"}),">"]}),"\n",(0,i.jsx)(e.h2,{id:"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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L3519",children:"packages/extension-api/src/extension-api.d.ts:3519"})})]})}function l(n={}){const{wrapper:e}={...(0,s.a)(),...n.components};return e?(0,i.jsx)(e,{...n,children:(0,i.jsx)(p,{...n})}):p(n)}},71670:(n,e,t)=>{t.d(e,{Z:()=>a,a:()=>r});var i=t(27378);const s={},o=i.createContext(s);function r(n){const e=i.useContext(o);return i.useMemo((function(){return"function"==typeof n?n(e):{...e,...n}}),[e,n])}function a(n){let e;return e=n.disableParentContext?"function"==typeof n.components?n.components(s):n.components||s:r(n.components),i.createElement(o.Provider,{value:e},n.children)}}}]); \ No newline at end of file diff --git a/assets/js/b6be2912.dc515410.js b/assets/js/b6be2912.c4e77c6e.js similarity index 98% rename from assets/js/b6be2912.dc515410.js rename to assets/js/b6be2912.c4e77c6e.js index 636a240f8e8..c130ae592b8 100644 --- a/assets/js/b6be2912.dc515410.js +++ b/assets/js/b6be2912.c4e77c6e.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[82424],{62461:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>c,contentTitle:()=>r,default:()=>h,frontMatter:()=>o,metadata:()=>a,toc:()=>d});var i=s(24246),t=s(71670);const o={},r="Function: showWarningMessage()",a={id:"namespaces/window/functions/showWarningMessage",title:"Function: showWarningMessage()",description:"showWarningMessage(message, ...items): Promise\\",source:"@site/api/namespaces/window/functions/showWarningMessage.md",sourceDirName:"namespaces/window/functions",slug:"/namespaces/window/functions/showWarningMessage",permalink:"/api/namespaces/window/functions/showWarningMessage",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"showSaveDialog",permalink:"/api/namespaces/window/functions/showSaveDialog"},next:{title:"withProgress",permalink:"/api/namespaces/window/functions/withProgress"}},c={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Defined in",id:"defined-in",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,t.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"function-showwarningmessage",children:"Function: showWarningMessage()"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"showWarningMessage"}),"(",(0,i.jsx)(n.code,{children:"message"}),", ...",(0,i.jsx)(n.code,{children:"items"}),"): ",(0,i.jsx)(n.code,{children:"Promise"}),"<",(0,i.jsx)(n.code,{children:"string"})," | ",(0,i.jsx)(n.code,{children:"undefined"}),">"]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Show a warning message. Optionally provide an array of items which will be presented as\nclickable buttons."}),"\n",(0,i.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"message"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n",(0,i.jsx)(n.p,{children:"The message to show."}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ...",(0,i.jsx)(n.strong,{children:"items"}),": ",(0,i.jsx)(n.code,{children:"string"}),"[]"]}),"\n",(0,i.jsx)(n.p,{children:"A set of items that will be rendered as actions in the message."}),"\n",(0,i.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"Promise"}),"<",(0,i.jsx)(n.code,{children:"string"})," | ",(0,i.jsx)(n.code,{children:"undefined"}),">"]}),"\n",(0,i.jsxs)(n.p,{children:["A promise that resolves to the selected item or ",(0,i.jsx)(n.code,{children:"undefined"})," when being dismissed."]}),"\n",(0,i.jsx)(n.h2,{id:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L1882",children:"packages/extension-api/src/extension-api.d.ts:1882"})})]})}function h(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>a,a:()=>r});var i=s(27378);const t={},o=i.createContext(t);function r(e){const n=i.useContext(o);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function a(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:r(e.components),i.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[82424],{62461:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>c,contentTitle:()=>r,default:()=>h,frontMatter:()=>o,metadata:()=>a,toc:()=>d});var i=s(24246),t=s(71670);const o={},r="Function: showWarningMessage()",a={id:"namespaces/window/functions/showWarningMessage",title:"Function: showWarningMessage()",description:"showWarningMessage(message, ...items): Promise\\",source:"@site/api/namespaces/window/functions/showWarningMessage.md",sourceDirName:"namespaces/window/functions",slug:"/namespaces/window/functions/showWarningMessage",permalink:"/api/namespaces/window/functions/showWarningMessage",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"showSaveDialog",permalink:"/api/namespaces/window/functions/showSaveDialog"},next:{title:"withProgress",permalink:"/api/namespaces/window/functions/withProgress"}},c={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Defined in",id:"defined-in",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,t.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"function-showwarningmessage",children:"Function: showWarningMessage()"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"showWarningMessage"}),"(",(0,i.jsx)(n.code,{children:"message"}),", ...",(0,i.jsx)(n.code,{children:"items"}),"): ",(0,i.jsx)(n.code,{children:"Promise"}),"<",(0,i.jsx)(n.code,{children:"string"})," | ",(0,i.jsx)(n.code,{children:"undefined"}),">"]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Show a warning message. Optionally provide an array of items which will be presented as\nclickable buttons."}),"\n",(0,i.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"message"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n",(0,i.jsx)(n.p,{children:"The message to show."}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ...",(0,i.jsx)(n.strong,{children:"items"}),": ",(0,i.jsx)(n.code,{children:"string"}),"[]"]}),"\n",(0,i.jsx)(n.p,{children:"A set of items that will be rendered as actions in the message."}),"\n",(0,i.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"Promise"}),"<",(0,i.jsx)(n.code,{children:"string"})," | ",(0,i.jsx)(n.code,{children:"undefined"}),">"]}),"\n",(0,i.jsxs)(n.p,{children:["A promise that resolves to the selected item or ",(0,i.jsx)(n.code,{children:"undefined"})," when being dismissed."]}),"\n",(0,i.jsx)(n.h2,{id:"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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L1882",children:"packages/extension-api/src/extension-api.d.ts:1882"})})]})}function h(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>a,a:()=>r});var i=s(27378);const t={},o=i.createContext(t);function r(e){const n=i.useContext(o);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function a(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:r(e.components),i.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/b6d76a6c.0d01bc01.js b/assets/js/b6d76a6c.a00c5803.js similarity index 96% rename from assets/js/b6d76a6c.0d01bc01.js rename to assets/js/b6d76a6c.a00c5803.js index 9531954a4be..f3fdf1240bf 100644 --- a/assets/js/b6d76a6c.0d01bc01.js +++ b/assets/js/b6d76a6c.a00c5803.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[3667],{83285:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>c,contentTitle:()=>r,default:()=>h,frontMatter:()=>a,metadata:()=>o,toc:()=>d});var i=s(24246),t=s(71670);const a={},r="Function: onDidStateChange()",o={id:"namespaces/proxy/functions/onDidStateChange",title:"Function: onDidStateChange()",description:"onDidStateChange(listener, thisArgs?, disposables?): Disposable",source:"@site/api/namespaces/proxy/functions/onDidStateChange.md",sourceDirName:"namespaces/proxy/functions",slug:"/namespaces/proxy/functions/onDidStateChange",permalink:"/api/namespaces/proxy/functions/onDidStateChange",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"isEnabled",permalink:"/api/namespaces/proxy/functions/isEnabled"},next:{title:"onDidUpdateProxy",permalink:"/api/namespaces/proxy/functions/onDidUpdateProxy"}},c={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Defined in",id:"defined-in",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,t.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"function-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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L860",children:"packages/extension-api/src/extension-api.d.ts:860"})})]})}function h(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>o,a:()=>r});var i=s(27378);const t={},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([[3667],{83285:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>c,contentTitle:()=>r,default:()=>h,frontMatter:()=>a,metadata:()=>o,toc:()=>d});var i=s(24246),t=s(71670);const a={},r="Function: onDidStateChange()",o={id:"namespaces/proxy/functions/onDidStateChange",title:"Function: onDidStateChange()",description:"onDidStateChange(listener, thisArgs?, disposables?): Disposable",source:"@site/api/namespaces/proxy/functions/onDidStateChange.md",sourceDirName:"namespaces/proxy/functions",slug:"/namespaces/proxy/functions/onDidStateChange",permalink:"/api/namespaces/proxy/functions/onDidStateChange",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"isEnabled",permalink:"/api/namespaces/proxy/functions/isEnabled"},next:{title:"onDidUpdateProxy",permalink:"/api/namespaces/proxy/functions/onDidUpdateProxy"}},c={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Defined in",id:"defined-in",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,t.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"function-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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L860",children:"packages/extension-api/src/extension-api.d.ts:860"})})]})}function h(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>o,a:()=>r});var i=s(27378);const t={},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.727518e6.js b/assets/js/b7bb2d93.2a02952d.js similarity index 95% rename from assets/js/b7bb2d93.727518e6.js rename to assets/js/b7bb2d93.2a02952d.js index 2e0d6dec9db..0ad678772d1 100644 --- a/assets/js/b7bb2d93.727518e6.js +++ b/assets/js/b7bb2d93.2a02952d.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[16855],{13075:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>d,contentTitle:()=>r,default:()=>p,frontMatter:()=>s,metadata:()=>a,toc:()=>c});var t=i(24246),o=i(71670);const s={},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",hr:"hr",p:"p",strong:"strong",...(0,o.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"enumeration-progresslocation",children:"Enumeration: ProgressLocation"}),"\n",(0,t.jsx)(n.p,{children:"A location in the editor at which progress information can be shown. It depends on the\nlocation how progress is visually represented."}),"\n",(0,t.jsx)(n.h2,{id:"enumeration-members",children:"Enumeration Members"}),"\n",(0,t.jsx)(n.h3,{id:"app_icon",children:(0,t.jsx)(n.del,{children:"APP_ICON"})}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"APP_ICON"}),": ",(0,t.jsx)(n.code,{children:"1"})]}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"Show progress bar under app icon in launcher bar."}),"\n",(0,t.jsx)(n.h4,{id:"deprecated",children:"Deprecated"}),"\n",(0,t.jsx)(n.p,{children:"This value is deprecated as it does not render equally on various supported platforms. It will be\nremoved in future versions of Podman Desktop. We strongly encourage to use TASK_WIDGET instead."}),"\n",(0,t.jsx)(n.h4,{id:"see",children:"See"}),"\n",(0,t.jsx)(n.p,{children:"TASK_WIDGET"}),"\n",(0,t.jsx)(n.h4,{id:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L1022",children:"packages/extension-api/src/extension-api.d.ts:1022"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L1027",children:"packages/extension-api/src/extension-api.d.ts:1027"})})]})}function p(e={}){const{wrapper:n}={...(0,o.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>a,a:()=>r});var t=i(27378);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 a(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([[16855],{13075:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>d,contentTitle:()=>r,default:()=>p,frontMatter:()=>s,metadata:()=>a,toc:()=>c});var t=i(24246),o=i(71670);const s={},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",hr:"hr",p:"p",strong:"strong",...(0,o.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"enumeration-progresslocation",children:"Enumeration: ProgressLocation"}),"\n",(0,t.jsx)(n.p,{children:"A location in the editor at which progress information can be shown. It depends on the\nlocation how progress is visually represented."}),"\n",(0,t.jsx)(n.h2,{id:"enumeration-members",children:"Enumeration Members"}),"\n",(0,t.jsx)(n.h3,{id:"app_icon",children:(0,t.jsx)(n.del,{children:"APP_ICON"})}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"APP_ICON"}),": ",(0,t.jsx)(n.code,{children:"1"})]}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"Show progress bar under app icon in launcher bar."}),"\n",(0,t.jsx)(n.h4,{id:"deprecated",children:"Deprecated"}),"\n",(0,t.jsx)(n.p,{children:"This value is deprecated as it does not render equally on various supported platforms. It will be\nremoved in future versions of Podman Desktop. We strongly encourage to use TASK_WIDGET instead."}),"\n",(0,t.jsx)(n.h4,{id:"see",children:"See"}),"\n",(0,t.jsx)(n.p,{children:"TASK_WIDGET"}),"\n",(0,t.jsx)(n.h4,{id:"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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L1022",children:"packages/extension-api/src/extension-api.d.ts:1022"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L1027",children:"packages/extension-api/src/extension-api.d.ts:1027"})})]})}function p(e={}){const{wrapper:n}={...(0,o.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>a,a:()=>r});var t=i(27378);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 a(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/b8eb0fce.bc0fff2e.js b/assets/js/b8eb0fce.9577fc98.js similarity index 96% rename from assets/js/b8eb0fce.bc0fff2e.js rename to assets/js/b8eb0fce.9577fc98.js index 3578fb2ba2c..bd5c4e629c8 100644 --- a/assets/js/b8eb0fce.bc0fff2e.js +++ b/assets/js/b8eb0fce.9577fc98.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[69584],{4061:(e,s,n)=>{n.r(s),n.d(s,{assets:()=>a,contentTitle:()=>c,default:()=>p,frontMatter:()=>t,metadata:()=>o,toc:()=>d});var i=n(24246),r=n(71670);const t={},c="Function: onDidRegisterRegistry()",o={id:"namespaces/registry/functions/onDidRegisterRegistry",title:"Function: onDidRegisterRegistry()",description:"onDidRegisterRegistry(listener, thisArgs?, disposables?): Disposable",source:"@site/api/namespaces/registry/functions/onDidRegisterRegistry.md",sourceDirName:"namespaces/registry/functions",slug:"/namespaces/registry/functions/onDidRegisterRegistry",permalink:"/api/namespaces/registry/functions/onDidRegisterRegistry",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"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",p:"p",strong:"strong",...(0,r.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(s.h1,{id:"function-ondidregisterregistry",children:"Function: onDidRegisterRegistry()"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"onDidRegisterRegistry"}),"(",(0,i.jsx)(s.code,{children:"listener"}),", ",(0,i.jsx)(s.code,{children:"thisArgs"}),"?, ",(0,i.jsx)(s.code,{children:"disposables"}),"?): ",(0,i.jsx)(s.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(s.code,{children:"Disposable"})})]}),"\n"]}),"\n",(0,i.jsx)(s.h2,{id:"parameters",children:"Parameters"}),"\n",(0,i.jsxs)(s.p,{children:["\u2022 ",(0,i.jsx)(s.strong,{children:"listener"})]}),"\n",(0,i.jsx)(s.p,{children:"The listener function will be called when the event happens."}),"\n",(0,i.jsxs)(s.p,{children:["\u2022 ",(0,i.jsx)(s.strong,{children:"thisArgs?"}),": ",(0,i.jsx)(s.code,{children:"any"})]}),"\n",(0,i.jsxs)(s.p,{children:["The ",(0,i.jsx)(s.code,{children:"this"}),"-argument which will be used when calling the event listener."]}),"\n",(0,i.jsxs)(s.p,{children:["\u2022 ",(0,i.jsx)(s.strong,{children:"disposables?"}),": ",(0,i.jsx)(s.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(s.code,{children:"Disposable"})}),"[]"]}),"\n",(0,i.jsxs)(s.p,{children:["An array to which a ",(0,i.jsx)(s.a,{href:"/api/classes/Disposable",children:"Disposable"})," will be added."]}),"\n",(0,i.jsx)(s.h2,{id:"returns",children:"Returns"}),"\n",(0,i.jsx)(s.p,{children:(0,i.jsx)(s.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(s.code,{children:"Disposable"})})}),"\n",(0,i.jsx)(s.p,{children:"A disposable which unsubscribes the event listener."}),"\n",(0,i.jsx)(s.h2,{id:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L910",children:"packages/extension-api/src/extension-api.d.ts:910"})})]})}function p(e={}){const{wrapper:s}={...(0,r.a)(),...e.components};return s?(0,i.jsx)(s,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},71670:(e,s,n)=>{n.d(s,{Z:()=>o,a:()=>c});var i=n(27378);const r={},t=i.createContext(r);function c(e){const s=i.useContext(t);return i.useMemo((function(){return"function"==typeof e?e(s):{...s,...e}}),[s,e])}function o(e){let s;return s=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:c(e.components),i.createElement(t.Provider,{value:s},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[69584],{4061:(e,s,n)=>{n.r(s),n.d(s,{assets:()=>a,contentTitle:()=>c,default:()=>p,frontMatter:()=>t,metadata:()=>o,toc:()=>d});var i=n(24246),r=n(71670);const t={},c="Function: onDidRegisterRegistry()",o={id:"namespaces/registry/functions/onDidRegisterRegistry",title:"Function: onDidRegisterRegistry()",description:"onDidRegisterRegistry(listener, thisArgs?, disposables?): Disposable",source:"@site/api/namespaces/registry/functions/onDidRegisterRegistry.md",sourceDirName:"namespaces/registry/functions",slug:"/namespaces/registry/functions/onDidRegisterRegistry",permalink:"/api/namespaces/registry/functions/onDidRegisterRegistry",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"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",p:"p",strong:"strong",...(0,r.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(s.h1,{id:"function-ondidregisterregistry",children:"Function: onDidRegisterRegistry()"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"onDidRegisterRegistry"}),"(",(0,i.jsx)(s.code,{children:"listener"}),", ",(0,i.jsx)(s.code,{children:"thisArgs"}),"?, ",(0,i.jsx)(s.code,{children:"disposables"}),"?): ",(0,i.jsx)(s.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(s.code,{children:"Disposable"})})]}),"\n"]}),"\n",(0,i.jsx)(s.h2,{id:"parameters",children:"Parameters"}),"\n",(0,i.jsxs)(s.p,{children:["\u2022 ",(0,i.jsx)(s.strong,{children:"listener"})]}),"\n",(0,i.jsx)(s.p,{children:"The listener function will be called when the event happens."}),"\n",(0,i.jsxs)(s.p,{children:["\u2022 ",(0,i.jsx)(s.strong,{children:"thisArgs?"}),": ",(0,i.jsx)(s.code,{children:"any"})]}),"\n",(0,i.jsxs)(s.p,{children:["The ",(0,i.jsx)(s.code,{children:"this"}),"-argument which will be used when calling the event listener."]}),"\n",(0,i.jsxs)(s.p,{children:["\u2022 ",(0,i.jsx)(s.strong,{children:"disposables?"}),": ",(0,i.jsx)(s.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(s.code,{children:"Disposable"})}),"[]"]}),"\n",(0,i.jsxs)(s.p,{children:["An array to which a ",(0,i.jsx)(s.a,{href:"/api/classes/Disposable",children:"Disposable"})," will be added."]}),"\n",(0,i.jsx)(s.h2,{id:"returns",children:"Returns"}),"\n",(0,i.jsx)(s.p,{children:(0,i.jsx)(s.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(s.code,{children:"Disposable"})})}),"\n",(0,i.jsx)(s.p,{children:"A disposable which unsubscribes the event listener."}),"\n",(0,i.jsx)(s.h2,{id:"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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L910",children:"packages/extension-api/src/extension-api.d.ts:910"})})]})}function p(e={}){const{wrapper:s}={...(0,r.a)(),...e.components};return s?(0,i.jsx)(s,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},71670:(e,s,n)=>{n.d(s,{Z:()=>o,a:()=>c});var i=n(27378);const r={},t=i.createContext(r);function c(e){const s=i.useContext(t);return i.useMemo((function(){return"function"==typeof e?e(s):{...s,...e}}),[s,e])}function o(e){let s;return s=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:c(e.components),i.createElement(t.Provider,{value:s},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/b8ec852b.f9145439.js b/assets/js/b8ec852b.31614929.js similarity index 88% rename from assets/js/b8ec852b.f9145439.js rename to assets/js/b8ec852b.31614929.js index 20a56feb5f0..fadc07936bd 100644 --- a/assets/js/b8ec852b.f9145439.js +++ b/assets/js/b8ec852b.31614929.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[63407],{73444:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>a,contentTitle:()=>r,default:()=>h,frontMatter:()=>t,metadata:()=>c,toc:()=>l});var s=i(24246),o=i(71670);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",hr:"hr",p:"p",strong:"strong",...(0,o.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"interface-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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L1051",children:"packages/extension-api/src/extension-api.d.ts:1051"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L1037",children:"packages/extension-api/src/extension-api.d.ts:1037"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L1043",children:"packages/extension-api/src/extension-api.d.ts:1043"})})]})}function h(e={}){const{wrapper:n}={...(0,o.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(d,{...e})}):d(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>c,a:()=>r});var s=i(27378);const o={},t=s.createContext(o);function r(e){const n=s.useContext(t);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:r(e.components),s.createElement(t.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[63407],{73444:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>a,contentTitle:()=>r,default:()=>h,frontMatter:()=>t,metadata:()=>c,toc:()=>d});var s=i(24246),o=i(71670);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={},d=[{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 l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,o.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L1051",children:"packages/extension-api/src/extension-api.d.ts:1051"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L1037",children:"packages/extension-api/src/extension-api.d.ts:1037"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L1043",children:"packages/extension-api/src/extension-api.d.ts:1043"})})]})}function h(e={}){const{wrapper:n}={...(0,o.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>c,a:()=>r});var s=i(27378);const o={},t=s.createContext(o);function r(e){const n=s.useContext(t);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:r(e.components),s.createElement(t.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/b9287eb6.461102ac.js b/assets/js/b9287eb6.90f5137a.js similarity index 79% rename from assets/js/b9287eb6.461102ac.js rename to assets/js/b9287eb6.90f5137a.js index 7ebb630d5e9..403247e7f82 100644 --- a/assets/js/b9287eb6.461102ac.js +++ b/assets/js/b9287eb6.90f5137a.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[89251],{16913:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>c,contentTitle:()=>r,default:()=>p,frontMatter:()=>a,metadata:()=>d,toc:()=>o});var i=s(24246),t=s(71670);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",hr:"hr",p:"p",strong:"strong",...(0,t.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"interface-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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L3133",children:"packages/extension-api/src/extension-api.d.ts:3133"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L3135",children:"packages/extension-api/src/extension-api.d.ts:3135"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L3136",children:"packages/extension-api/src/extension-api.d.ts:3136"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L3134",children:"packages/extension-api/src/extension-api.d.ts:3134"})})]})}function p(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>d,a:()=>r});var i=s(27378);const t={},a=i.createContext(t);function r(e){const n=i.useContext(a);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function 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([[89251],{16913:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>c,contentTitle:()=>d,default:()=>p,frontMatter:()=>a,metadata:()=>r,toc:()=>o});var i=s(24246),t=s(71670);const a={},d="Interface: CPUUsage",r={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",hr:"hr",p:"p",strong:"strong",...(0,t.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"interface-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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L3133",children:"packages/extension-api/src/extension-api.d.ts:3133"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L3135",children:"packages/extension-api/src/extension-api.d.ts:3135"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L3136",children:"packages/extension-api/src/extension-api.d.ts:3136"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L3134",children:"packages/extension-api/src/extension-api.d.ts:3134"})})]})}function p(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>r,a:()=>d});var i=s(27378);const t={},a=i.createContext(t);function d(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:d(e.components),i.createElement(a.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/b9a87183.ea4b6df7.js b/assets/js/b9a87183.52a551a1.js similarity index 94% rename from assets/js/b9a87183.ea4b6df7.js rename to assets/js/b9a87183.52a551a1.js index 84cbd685bf4..7d34bbedbb4 100644 --- a/assets/js/b9a87183.ea4b6df7.js +++ b/assets/js/b9a87183.52a551a1.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[25821],{91182:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>c,contentTitle:()=>a,default:()=>l,frontMatter:()=>o,metadata:()=>s,toc:()=>d});var t=i(24246),r=i(71670);const o={},a="Interface: AuthenticationProviderInformation",s={id:"interfaces/AuthenticationProviderInformation",title:"Interface: AuthenticationProviderInformation",description:"Basic information about an authenticationProvider",source:"@site/api/interfaces/AuthenticationProviderInformation.md",sourceDirName:"interfaces",slug:"/interfaces/AuthenticationProviderInformation",permalink:"/api/interfaces/AuthenticationProviderInformation",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"AuthenticationProviderAuthenticationSessionsChangeEvent",permalink:"/api/interfaces/AuthenticationProviderAuthenticationSessionsChangeEvent"},next:{title:"AuthenticationProviderOptions",permalink:"/api/interfaces/AuthenticationProviderOptions"}},c={},d=[{value:"Properties",id:"properties",level:2},{value:"id",id:"id",level:3},{value:"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",hr:"hr",p:"p",strong:"strong",...(0,r.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L3778",children:"packages/extension-api/src/extension-api.d.ts:3778"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L3783",children:"packages/extension-api/src/extension-api.d.ts:3783"})})]})}function l(e={}){const{wrapper:n}={...(0,r.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(h,{...e})}):h(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>s,a:()=>a});var t=i(27378);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([[25821],{91182:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>c,contentTitle:()=>a,default:()=>l,frontMatter:()=>o,metadata:()=>s,toc:()=>d});var t=i(24246),r=i(71670);const o={},a="Interface: AuthenticationProviderInformation",s={id:"interfaces/AuthenticationProviderInformation",title:"Interface: AuthenticationProviderInformation",description:"Basic information about an authenticationProvider",source:"@site/api/interfaces/AuthenticationProviderInformation.md",sourceDirName:"interfaces",slug:"/interfaces/AuthenticationProviderInformation",permalink:"/api/interfaces/AuthenticationProviderInformation",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"AuthenticationProviderAuthenticationSessionsChangeEvent",permalink:"/api/interfaces/AuthenticationProviderAuthenticationSessionsChangeEvent"},next:{title:"AuthenticationProviderOptions",permalink:"/api/interfaces/AuthenticationProviderOptions"}},c={},d=[{value:"Properties",id:"properties",level:2},{value:"id",id:"id",level:3},{value:"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",hr:"hr",p:"p",strong:"strong",...(0,r.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L3778",children:"packages/extension-api/src/extension-api.d.ts:3778"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L3783",children:"packages/extension-api/src/extension-api.d.ts:3783"})})]})}function l(e={}){const{wrapper:n}={...(0,r.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(h,{...e})}):h(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>s,a:()=>a});var t=i(27378);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.b09ba52b.js b/assets/js/bab44fba.9206b696.js similarity index 98% rename from assets/js/bab44fba.b09ba52b.js rename to assets/js/bab44fba.9206b696.js index 4a610a72d75..cd85b19f8b0 100644 --- a/assets/js/bab44fba.b09ba52b.js +++ b/assets/js/bab44fba.9206b696.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[98170],{51971:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>a,contentTitle:()=>c,default:()=>p,frontMatter:()=>t,metadata:()=>o,toc:()=>d});var i=r(24246),s=r(71670);const t={},c="Function: replicatePodmanContainer()",o={id:"namespaces/containerEngine/functions/replicatePodmanContainer",title:"Function: replicatePodmanContainer()",description:"replicatePodmanContainer(source, target, overrideParameters): Promise\\",source:"@site/api/namespaces/containerEngine/functions/replicatePodmanContainer.md",sourceDirName:"namespaces/containerEngine/functions",slug:"/namespaces/containerEngine/functions/replicatePodmanContainer",permalink:"/api/namespaces/containerEngine/functions/replicatePodmanContainer",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"removePod",permalink:"/api/namespaces/containerEngine/functions/removePod"},next:{title:"saveImage",permalink:"/api/namespaces/containerEngine/functions/saveImage"}},a={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Id",id:"id",level:3},{value:"Warnings",id:"warnings",level:3},{value:"Defined in",id:"defined-in",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L3660",children:"packages/extension-api/src/extension-api.d.ts:3660"})})]})}function p(e={}){const{wrapper:n}={...(0,s.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},71670:(e,n,r)=>{r.d(n,{Z:()=>o,a:()=>c});var i=r(27378);const s={},t=i.createContext(s);function c(e){const n=i.useContext(t);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function 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([[98170],{51971:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>a,contentTitle:()=>c,default:()=>p,frontMatter:()=>t,metadata:()=>o,toc:()=>d});var i=r(24246),s=r(71670);const t={},c="Function: replicatePodmanContainer()",o={id:"namespaces/containerEngine/functions/replicatePodmanContainer",title:"Function: replicatePodmanContainer()",description:"replicatePodmanContainer(source, target, overrideParameters): Promise\\",source:"@site/api/namespaces/containerEngine/functions/replicatePodmanContainer.md",sourceDirName:"namespaces/containerEngine/functions",slug:"/namespaces/containerEngine/functions/replicatePodmanContainer",permalink:"/api/namespaces/containerEngine/functions/replicatePodmanContainer",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"removePod",permalink:"/api/namespaces/containerEngine/functions/removePod"},next:{title:"saveImage",permalink:"/api/namespaces/containerEngine/functions/saveImage"}},a={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Id",id:"id",level:3},{value:"Warnings",id:"warnings",level:3},{value:"Defined in",id:"defined-in",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L3660",children:"packages/extension-api/src/extension-api.d.ts:3660"})})]})}function p(e={}){const{wrapper:n}={...(0,s.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},71670:(e,n,r)=>{r.d(n,{Z:()=>o,a:()=>c});var i=r(27378);const s={},t=i.createContext(s);function c(e){const n=i.useContext(t);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function 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.f2a019a3.js b/assets/js/bb6a5560.cbfeff5c.js similarity index 95% rename from assets/js/bb6a5560.f2a019a3.js rename to assets/js/bb6a5560.cbfeff5c.js index 9d4d47668ee..ea2efcc9988 100644 --- a/assets/js/bb6a5560.f2a019a3.js +++ b/assets/js/bb6a5560.cbfeff5c.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[2883],{36:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>r,default:()=>u,frontMatter:()=>o,metadata:()=>c,toc:()=>d});var s=t(24246),i=t(71670);const o={},r="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",p:"p",strong:"strong",...(0,i.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"function-getproxysettings",children:"Function: getProxySettings()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"getProxySettings"}),"(): ",(0,s.jsx)(n.a,{href:"/api/interfaces/ProxySettings",children:(0,s.jsx)(n.code,{children:"ProxySettings"})})," | ",(0,s.jsx)(n.code,{children:"undefined"})]}),"\n"]}),"\n",(0,s.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.a,{href:"/api/interfaces/ProxySettings",children:(0,s.jsx)(n.code,{children:"ProxySettings"})})," | ",(0,s.jsx)(n.code,{children:"undefined"})]}),"\n",(0,s.jsx)(n.h2,{id:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L853",children:"packages/extension-api/src/extension-api.d.ts:853"})})]})}function u(e={}){const{wrapper:n}={...(0,i.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(p,{...e})}):p(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>c,a:()=>r});var s=t(27378);const i={},o=s.createContext(i);function r(e){const n=s.useContext(o);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:r(e.components),s.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[2883],{36:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>r,default:()=>u,frontMatter:()=>o,metadata:()=>c,toc:()=>d});var s=t(24246),i=t(71670);const o={},r="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",p:"p",strong:"strong",...(0,i.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"function-getproxysettings",children:"Function: getProxySettings()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"getProxySettings"}),"(): ",(0,s.jsx)(n.a,{href:"/api/interfaces/ProxySettings",children:(0,s.jsx)(n.code,{children:"ProxySettings"})})," | ",(0,s.jsx)(n.code,{children:"undefined"})]}),"\n"]}),"\n",(0,s.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.a,{href:"/api/interfaces/ProxySettings",children:(0,s.jsx)(n.code,{children:"ProxySettings"})})," | ",(0,s.jsx)(n.code,{children:"undefined"})]}),"\n",(0,s.jsx)(n.h2,{id:"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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L853",children:"packages/extension-api/src/extension-api.d.ts:853"})})]})}function u(e={}){const{wrapper:n}={...(0,i.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(p,{...e})}):p(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>c,a:()=>r});var s=t(27378);const i={},o=s.createContext(i);function r(e){const n=s.useContext(o);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:r(e.components),s.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/bd45720e.a8c029b6.js b/assets/js/bd45720e.4f902ae0.js similarity index 97% rename from assets/js/bd45720e.a8c029b6.js rename to assets/js/bd45720e.4f902ae0.js index 057e073b46f..0cc01a7a363 100644 --- a/assets/js/bd45720e.a8c029b6.js +++ b/assets/js/bd45720e.4f902ae0.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[13239],{54066:(n,e,t)=>{t.r(e),t.d(e,{assets:()=>c,contentTitle:()=>s,default:()=>u,frontMatter:()=>o,metadata:()=>r,toc:()=>d});var i=t(24246),a=t(71670);const o={},s="Function: 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",p:"p",strong:"strong",...(0,a.a)(),...n.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(e.h1,{id:"function-navigatetocontainer",children:"Function: navigateToContainer()"}),"\n",(0,i.jsxs)(e.blockquote,{children:["\n",(0,i.jsxs)(e.p,{children:[(0,i.jsx)(e.strong,{children:"navigateToContainer"}),"(",(0,i.jsx)(e.code,{children:"id"}),"): ",(0,i.jsx)(e.code,{children:"Promise"}),"<",(0,i.jsx)(e.code,{children:"void"}),">"]}),"\n"]}),"\n",(0,i.jsx)(e.h2,{id:"parameters",children:"Parameters"}),"\n",(0,i.jsxs)(e.p,{children:["\u2022 ",(0,i.jsx)(e.strong,{children:"id"}),": ",(0,i.jsx)(e.code,{children:"string"})]}),"\n",(0,i.jsx)(e.h2,{id:"returns",children:"Returns"}),"\n",(0,i.jsxs)(e.p,{children:[(0,i.jsx)(e.code,{children:"Promise"}),"<",(0,i.jsx)(e.code,{children:"void"}),">"]}),"\n",(0,i.jsx)(e.h2,{id:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L4430",children:"packages/extension-api/src/extension-api.d.ts:4430"})})]})}function u(n={}){const{wrapper:e}={...(0,a.a)(),...n.components};return e?(0,i.jsx)(e,{...n,children:(0,i.jsx)(l,{...n})}):l(n)}},71670:(n,e,t)=>{t.d(e,{Z:()=>r,a:()=>s});var i=t(27378);const a={},o=i.createContext(a);function s(n){const e=i.useContext(o);return i.useMemo((function(){return"function"==typeof n?n(e):{...e,...n}}),[e,n])}function r(n){let e;return e=n.disableParentContext?"function"==typeof n.components?n.components(a):n.components||a:s(n.components),i.createElement(o.Provider,{value:e},n.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[13239],{54066:(n,e,t)=>{t.r(e),t.d(e,{assets:()=>c,contentTitle:()=>s,default:()=>u,frontMatter:()=>o,metadata:()=>r,toc:()=>d});var i=t(24246),a=t(71670);const o={},s="Function: 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",p:"p",strong:"strong",...(0,a.a)(),...n.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(e.h1,{id:"function-navigatetocontainer",children:"Function: navigateToContainer()"}),"\n",(0,i.jsxs)(e.blockquote,{children:["\n",(0,i.jsxs)(e.p,{children:[(0,i.jsx)(e.strong,{children:"navigateToContainer"}),"(",(0,i.jsx)(e.code,{children:"id"}),"): ",(0,i.jsx)(e.code,{children:"Promise"}),"<",(0,i.jsx)(e.code,{children:"void"}),">"]}),"\n"]}),"\n",(0,i.jsx)(e.h2,{id:"parameters",children:"Parameters"}),"\n",(0,i.jsxs)(e.p,{children:["\u2022 ",(0,i.jsx)(e.strong,{children:"id"}),": ",(0,i.jsx)(e.code,{children:"string"})]}),"\n",(0,i.jsx)(e.h2,{id:"returns",children:"Returns"}),"\n",(0,i.jsxs)(e.p,{children:[(0,i.jsx)(e.code,{children:"Promise"}),"<",(0,i.jsx)(e.code,{children:"void"}),">"]}),"\n",(0,i.jsx)(e.h2,{id:"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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L4430",children:"packages/extension-api/src/extension-api.d.ts:4430"})})]})}function u(n={}){const{wrapper:e}={...(0,a.a)(),...n.components};return e?(0,i.jsx)(e,{...n,children:(0,i.jsx)(l,{...n})}):l(n)}},71670:(n,e,t)=>{t.d(e,{Z:()=>r,a:()=>s});var i=t(27378);const a={},o=i.createContext(a);function s(n){const e=i.useContext(o);return i.useMemo((function(){return"function"==typeof n?n(e):{...e,...n}}),[e,n])}function r(n){let e;return e=n.disableParentContext?"function"==typeof n.components?n.components(a):n.components||a:s(n.components),i.createElement(o.Provider,{value:e},n.children)}}}]); \ No newline at end of file diff --git a/assets/js/bd65ec7e.0f623537.js b/assets/js/bd65ec7e.a98bb842.js similarity index 98% rename from assets/js/bd65ec7e.0f623537.js rename to assets/js/bd65ec7e.a98bb842.js index 8c65e909218..c0889855782 100644 --- a/assets/js/bd65ec7e.0f623537.js +++ b/assets/js/bd65ec7e.a98bb842.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[41798],{83934:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>a,contentTitle:()=>o,default:()=>l,frontMatter:()=>c,metadata:()=>i,toc:()=>d});var t=s(24246),r=s(71670);const c={},o="Function: createResources()",i={id:"namespaces/kubernetes/functions/createResources",title:"Function: createResources()",description:"createResources(context, manifests): Promise\\",source:"@site/api/namespaces/kubernetes/functions/createResources.md",sourceDirName:"namespaces/kubernetes/functions",slug:"/namespaces/kubernetes/functions/createResources",permalink:"/api/namespaces/kubernetes/functions/createResources",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"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",p:"p",strong:"strong",...(0,r.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"function-createresources",children:"Function: createResources()"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"createResources"}),"(",(0,t.jsx)(n.code,{children:"context"}),", ",(0,t.jsx)(n.code,{children:"manifests"}),"): ",(0,t.jsx)(n.code,{children:"Promise"}),"<",(0,t.jsx)(n.code,{children:"void"}),">"]}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"Create one or several Kubernetes resources on the Kubernetes contenxt."}),"\n",(0,t.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"context"}),": ",(0,t.jsx)(n.code,{children:"string"})]}),"\n",(0,t.jsx)(n.p,{children:"the Kubernetes context to use"}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"manifests"}),": ",(0,t.jsx)(n.code,{children:"unknown"}),"[]"]}),"\n",(0,t.jsx)(n.p,{children:"the manifests to create as JSON objects"}),"\n",(0,t.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"Promise"}),"<",(0,t.jsx)(n.code,{children:"void"}),">"]}),"\n",(0,t.jsx)(n.h2,{id:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L2092",children:"packages/extension-api/src/extension-api.d.ts:2092"})})]})}function l(e={}){const{wrapper:n}={...(0,r.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(u,{...e})}):u(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>i,a:()=>o});var t=s(27378);const r={},c=t.createContext(r);function o(e){const n=t.useContext(c);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function i(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:o(e.components),t.createElement(c.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[41798],{83934:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>a,contentTitle:()=>o,default:()=>l,frontMatter:()=>c,metadata:()=>i,toc:()=>d});var t=s(24246),r=s(71670);const c={},o="Function: createResources()",i={id:"namespaces/kubernetes/functions/createResources",title:"Function: createResources()",description:"createResources(context, manifests): Promise\\",source:"@site/api/namespaces/kubernetes/functions/createResources.md",sourceDirName:"namespaces/kubernetes/functions",slug:"/namespaces/kubernetes/functions/createResources",permalink:"/api/namespaces/kubernetes/functions/createResources",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"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",p:"p",strong:"strong",...(0,r.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"function-createresources",children:"Function: createResources()"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"createResources"}),"(",(0,t.jsx)(n.code,{children:"context"}),", ",(0,t.jsx)(n.code,{children:"manifests"}),"): ",(0,t.jsx)(n.code,{children:"Promise"}),"<",(0,t.jsx)(n.code,{children:"void"}),">"]}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"Create one or several Kubernetes resources on the Kubernetes contenxt."}),"\n",(0,t.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"context"}),": ",(0,t.jsx)(n.code,{children:"string"})]}),"\n",(0,t.jsx)(n.p,{children:"the Kubernetes context to use"}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"manifests"}),": ",(0,t.jsx)(n.code,{children:"unknown"}),"[]"]}),"\n",(0,t.jsx)(n.p,{children:"the manifests to create as JSON objects"}),"\n",(0,t.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"Promise"}),"<",(0,t.jsx)(n.code,{children:"void"}),">"]}),"\n",(0,t.jsx)(n.h2,{id:"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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2092",children:"packages/extension-api/src/extension-api.d.ts:2092"})})]})}function l(e={}){const{wrapper:n}={...(0,r.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(u,{...e})}):u(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>i,a:()=>o});var t=s(27378);const r={},c=t.createContext(r);function o(e){const n=t.useContext(c);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function i(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:o(e.components),t.createElement(c.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/bdb8b81b.75920c55.js b/assets/js/bdb8b81b.c0201704.js similarity index 82% rename from assets/js/bdb8b81b.75920c55.js rename to assets/js/bdb8b81b.c0201704.js index 599337df459..d903297fed1 100644 --- a/assets/js/bdb8b81b.75920c55.js +++ b/assets/js/bdb8b81b.c0201704.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[57549],{20484:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>o,contentTitle:()=>a,default:()=>p,frontMatter:()=>r,metadata:()=>d,toc:()=>c});var t=i(24246),s=i(71670);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",hr:"hr",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"interface-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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L3067",children:"packages/extension-api/src/extension-api.d.ts:3067"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L3068",children:"packages/extension-api/src/extension-api.d.ts:3068"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/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:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L3070",children:"packages/extension-api/src/extension-api.d.ts:3070"})})]})}function p(e={}){const{wrapper:n}={...(0,s.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>d,a:()=>a});var t=i(27378);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([[57549],{20484:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>o,contentTitle:()=>d,default:()=>p,frontMatter:()=>r,metadata:()=>a,toc:()=>c});var t=i(24246),s=i(71670);const r={},d="Interface: StorageStats",a={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",hr:"hr",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"interface-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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L3067",children:"packages/extension-api/src/extension-api.d.ts:3067"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L3068",children:"packages/extension-api/src/extension-api.d.ts:3068"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/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:"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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L3070",children:"packages/extension-api/src/extension-api.d.ts:3070"})})]})}function p(e={}){const{wrapper:n}={...(0,s.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>a,a:()=>d});var t=i(27378);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/be228752.040ed7ae.js b/assets/js/be228752.592ffaea.js similarity index 97% rename from assets/js/be228752.040ed7ae.js rename to assets/js/be228752.592ffaea.js index a526d55b500..f180e6f72fc 100644 --- a/assets/js/be228752.040ed7ae.js +++ b/assets/js/be228752.592ffaea.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[13573],{80699:(n,e,i)=>{i.r(e),i.d(e,{assets:()=>r,contentTitle:()=>a,default:()=>p,frontMatter:()=>o,metadata:()=>c,toc:()=>d});var t=i(24246),s=i(71670);const o={},a="Function: navigateToPod()",c={id:"namespaces/navigation/functions/navigateToPod",title:"Function: navigateToPod()",description:"navigateToPod(kind, name, engineId): Promise\\",source:"@site/api/namespaces/navigation/functions/navigateToPod.md",sourceDirName:"namespaces/navigation/functions",slug:"/namespaces/navigation/functions/navigateToPod",permalink:"/api/namespaces/navigation/functions/navigateToPod",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"navigateToImages",permalink:"/api/namespaces/navigation/functions/navigateToImages"},next:{title:"navigateToPods",permalink:"/api/namespaces/navigation/functions/navigateToPods"}},r={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Defined in",id:"defined-in",level:2}];function l(n){const e={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,s.a)(),...n.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(e.h1,{id:"function-navigatetopod",children:"Function: navigateToPod()"}),"\n",(0,t.jsxs)(e.blockquote,{children:["\n",(0,t.jsxs)(e.p,{children:[(0,t.jsx)(e.strong,{children:"navigateToPod"}),"(",(0,t.jsx)(e.code,{children:"kind"}),", ",(0,t.jsx)(e.code,{children:"name"}),", ",(0,t.jsx)(e.code,{children:"engineId"}),"): ",(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:"kind"}),": ",(0,t.jsx)(e.code,{children:"string"})]}),"\n",(0,t.jsxs)(e.p,{children:["\u2022 ",(0,t.jsx)(e.strong,{children:"name"}),": ",(0,t.jsx)(e.code,{children:"string"})]}),"\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.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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L4451",children:"packages/extension-api/src/extension-api.d.ts:4451"})})]})}function p(n={}){const{wrapper:e}={...(0,s.a)(),...n.components};return e?(0,t.jsx)(e,{...n,children:(0,t.jsx)(l,{...n})}):l(n)}},71670:(n,e,i)=>{i.d(e,{Z:()=>c,a:()=>a});var t=i(27378);const s={},o=t.createContext(s);function a(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:a(n.components),t.createElement(o.Provider,{value:e},n.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[13573],{80699:(n,e,i)=>{i.r(e),i.d(e,{assets:()=>r,contentTitle:()=>a,default:()=>p,frontMatter:()=>o,metadata:()=>c,toc:()=>d});var t=i(24246),s=i(71670);const o={},a="Function: navigateToPod()",c={id:"namespaces/navigation/functions/navigateToPod",title:"Function: navigateToPod()",description:"navigateToPod(kind, name, engineId): Promise\\",source:"@site/api/namespaces/navigation/functions/navigateToPod.md",sourceDirName:"namespaces/navigation/functions",slug:"/namespaces/navigation/functions/navigateToPod",permalink:"/api/namespaces/navigation/functions/navigateToPod",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"navigateToImages",permalink:"/api/namespaces/navigation/functions/navigateToImages"},next:{title:"navigateToPods",permalink:"/api/namespaces/navigation/functions/navigateToPods"}},r={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Defined in",id:"defined-in",level:2}];function l(n){const e={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,s.a)(),...n.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(e.h1,{id:"function-navigatetopod",children:"Function: navigateToPod()"}),"\n",(0,t.jsxs)(e.blockquote,{children:["\n",(0,t.jsxs)(e.p,{children:[(0,t.jsx)(e.strong,{children:"navigateToPod"}),"(",(0,t.jsx)(e.code,{children:"kind"}),", ",(0,t.jsx)(e.code,{children:"name"}),", ",(0,t.jsx)(e.code,{children:"engineId"}),"): ",(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:"kind"}),": ",(0,t.jsx)(e.code,{children:"string"})]}),"\n",(0,t.jsxs)(e.p,{children:["\u2022 ",(0,t.jsx)(e.strong,{children:"name"}),": ",(0,t.jsx)(e.code,{children:"string"})]}),"\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.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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L4451",children:"packages/extension-api/src/extension-api.d.ts:4451"})})]})}function p(n={}){const{wrapper:e}={...(0,s.a)(),...n.components};return e?(0,t.jsx)(e,{...n,children:(0,t.jsx)(l,{...n})}):l(n)}},71670:(n,e,i)=>{i.d(e,{Z:()=>c,a:()=>a});var t=i(27378);const s={},o=t.createContext(s);function a(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:a(n.components),t.createElement(o.Provider,{value:e},n.children)}}}]); \ No newline at end of file diff --git a/assets/js/bf11c6a2.6c3ddf86.js b/assets/js/bf11c6a2.43242bb5.js similarity index 91% rename from assets/js/bf11c6a2.6c3ddf86.js rename to assets/js/bf11c6a2.43242bb5.js index e0e9d0ef217..a87e6028068 100644 --- a/assets/js/bf11c6a2.6c3ddf86.js +++ b/assets/js/bf11c6a2.43242bb5.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[75290],{78608:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>a,contentTitle:()=>d,default:()=>h,frontMatter:()=>t,metadata:()=>c,toc:()=>o});var s=i(24246),r=i(71670);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",hr:"hr",li:"li",p:"p",strong:"strong",ul:"ul",...(0,r.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L887",children:"packages/extension-api/src/extension-api.d.ts:887"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L886",children:"packages/extension-api/src/extension-api.d.ts:886"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L885",children:"packages/extension-api/src/extension-api.d.ts:885"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L883",children:"packages/extension-api/src/extension-api.d.ts:883"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L884",children:"packages/extension-api/src/extension-api.d.ts:884"})})]})}function h(e={}){const{wrapper:n}={...(0,r.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>c,a:()=>d});var s=i(27378);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([[75290],{78608:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>a,contentTitle:()=>d,default:()=>h,frontMatter:()=>t,metadata:()=>c,toc:()=>o});var s=i(24246),r=i(71670);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",hr:"hr",li:"li",p:"p",strong:"strong",ul:"ul",...(0,r.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L887",children:"packages/extension-api/src/extension-api.d.ts:887"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L886",children:"packages/extension-api/src/extension-api.d.ts:886"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L885",children:"packages/extension-api/src/extension-api.d.ts:885"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L883",children:"packages/extension-api/src/extension-api.d.ts:883"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L884",children:"packages/extension-api/src/extension-api.d.ts:884"})})]})}function h(e={}){const{wrapper:n}={...(0,r.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>c,a:()=>d});var s=i(27378);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.2a0c4b0f.js b/assets/js/c09ab32f.7728a3eb.js similarity index 97% rename from assets/js/c09ab32f.2a0c4b0f.js rename to assets/js/c09ab32f.7728a3eb.js index 76ea77d2b06..e812bef72ee 100644 --- a/assets/js/c09ab32f.2a0c4b0f.js +++ b/assets/js/c09ab32f.7728a3eb.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[29112],{18740:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>l,contentTitle:()=>r,default:()=>u,frontMatter:()=>s,metadata:()=>o,toc:()=>c});var a=n(24246),i=n(71670);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",p:"p",strong:"strong",...(0,i.a)(),...e.components};return(0,a.jsxs)(a.Fragment,{children:[(0,a.jsx)(t.h1,{id:"variable-statusbaralignleft",children:"Variable: StatusBarAlignLeft"}),"\n",(0,a.jsxs)(t.blockquote,{children:["\n",(0,a.jsxs)(t.p,{children:[(0,a.jsx)(t.code,{children:"const"})," ",(0,a.jsx)(t.strong,{children:"StatusBarAlignLeft"}),": ",(0,a.jsx)(t.code,{children:'"LEFT"'})," = ",(0,a.jsx)(t.code,{children:"'LEFT'"})]}),"\n"]}),"\n",(0,a.jsx)(t.p,{children:"Aligned to the left side."}),"\n",(0,a.jsx)(t.h2,{id:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L1462",children:"packages/extension-api/src/extension-api.d.ts:1462"})})]})}function u(e={}){const{wrapper:t}={...(0,i.a)(),...e.components};return t?(0,a.jsx)(t,{...e,children:(0,a.jsx)(d,{...e})}):d(e)}},71670:(e,t,n)=>{n.d(t,{Z:()=>o,a:()=>r});var a=n(27378);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([[29112],{18740:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>l,contentTitle:()=>r,default:()=>u,frontMatter:()=>s,metadata:()=>o,toc:()=>c});var a=n(24246),i=n(71670);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",p:"p",strong:"strong",...(0,i.a)(),...e.components};return(0,a.jsxs)(a.Fragment,{children:[(0,a.jsx)(t.h1,{id:"variable-statusbaralignleft",children:"Variable: StatusBarAlignLeft"}),"\n",(0,a.jsxs)(t.blockquote,{children:["\n",(0,a.jsxs)(t.p,{children:[(0,a.jsx)(t.code,{children:"const"})," ",(0,a.jsx)(t.strong,{children:"StatusBarAlignLeft"}),": ",(0,a.jsx)(t.code,{children:'"LEFT"'})," = ",(0,a.jsx)(t.code,{children:"'LEFT'"})]}),"\n"]}),"\n",(0,a.jsx)(t.p,{children:"Aligned to the left side."}),"\n",(0,a.jsx)(t.h2,{id:"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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L1462",children:"packages/extension-api/src/extension-api.d.ts:1462"})})]})}function u(e={}){const{wrapper:t}={...(0,i.a)(),...e.components};return t?(0,a.jsx)(t,{...e,children:(0,a.jsx)(d,{...e})}):d(e)}},71670:(e,t,n)=>{n.d(t,{Z:()=>o,a:()=>r});var a=n(27378);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.aa578115.js b/assets/js/c104141c.2ebe1bee.js similarity index 95% rename from assets/js/c104141c.aa578115.js rename to assets/js/c104141c.2ebe1bee.js index e6856ccc211..07ea466f538 100644 --- a/assets/js/c104141c.aa578115.js +++ b/assets/js/c104141c.2ebe1bee.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[26348],{50341:(e,t,r)=>{r.r(t),r.d(t,{assets:()=>d,contentTitle:()=>o,default:()=>h,frontMatter:()=>i,metadata:()=>a,toc:()=>c});var n=r(24246),s=r(71670);const i={},o="Interface: ProviderAutostart",a={id:"interfaces/ProviderAutostart",title:"Interface: ProviderAutostart",description:"By providing this interface, when Podman Desktop is starting",source:"@site/api/interfaces/ProviderAutostart.md",sourceDirName:"interfaces",slug:"/interfaces/ProviderAutostart",permalink:"/api/interfaces/ProviderAutostart",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Provider",permalink:"/api/interfaces/Provider"},next:{title:"ProviderCleanup",permalink:"/api/interfaces/ProviderCleanup"}},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",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(t.h1,{id:"interface-providerautostart",children:"Interface: ProviderAutostart"}),"\n",(0,n.jsx)(t.p,{children:"By providing this interface, when Podman Desktop is starting\nIt'll start the provider through this interface.\nIt can be turned off/on by the user."}),"\n",(0,n.jsx)(t.h2,{id:"methods",children:"Methods"}),"\n",(0,n.jsx)(t.h3,{id:"start",children:"start()"}),"\n",(0,n.jsxs)(t.blockquote,{children:["\n",(0,n.jsxs)(t.p,{children:[(0,n.jsx)(t.strong,{children:"start"}),"(",(0,n.jsx)(t.code,{children:"logger"}),"): ",(0,n.jsx)(t.code,{children:"Promise"}),"<",(0,n.jsx)(t.code,{children:"void"}),">"]}),"\n"]}),"\n",(0,n.jsx)(t.h4,{id:"parameters",children:"Parameters"}),"\n",(0,n.jsxs)(t.p,{children:["\u2022 ",(0,n.jsx)(t.strong,{children:"logger"}),": ",(0,n.jsx)(t.a,{href:"/api/interfaces/Logger",children:(0,n.jsx)(t.code,{children:"Logger"})})]}),"\n",(0,n.jsx)(t.h4,{id:"returns",children:"Returns"}),"\n",(0,n.jsxs)(t.p,{children:[(0,n.jsx)(t.code,{children:"Promise"}),"<",(0,n.jsx)(t.code,{children:"void"}),">"]}),"\n",(0,n.jsx)(t.h4,{id:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L557",children:"packages/extension-api/src/extension-api.d.ts:557"})})]})}function h(e={}){const{wrapper:t}={...(0,s.a)(),...e.components};return t?(0,n.jsx)(t,{...e,children:(0,n.jsx)(l,{...e})}):l(e)}},71670:(e,t,r)=>{r.d(t,{Z:()=>a,a:()=>o});var n=r(27378);const s={},i=n.createContext(s);function o(e){const t=n.useContext(i);return n.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function a(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:o(e.components),n.createElement(i.Provider,{value:t},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[26348],{50341:(e,t,r)=>{r.r(t),r.d(t,{assets:()=>d,contentTitle:()=>o,default:()=>h,frontMatter:()=>i,metadata:()=>a,toc:()=>c});var n=r(24246),s=r(71670);const i={},o="Interface: ProviderAutostart",a={id:"interfaces/ProviderAutostart",title:"Interface: ProviderAutostart",description:"By providing this interface, when Podman Desktop is starting",source:"@site/api/interfaces/ProviderAutostart.md",sourceDirName:"interfaces",slug:"/interfaces/ProviderAutostart",permalink:"/api/interfaces/ProviderAutostart",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Provider",permalink:"/api/interfaces/Provider"},next:{title:"ProviderCleanup",permalink:"/api/interfaces/ProviderCleanup"}},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",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(t.h1,{id:"interface-providerautostart",children:"Interface: ProviderAutostart"}),"\n",(0,n.jsx)(t.p,{children:"By providing this interface, when Podman Desktop is starting\nIt'll start the provider through this interface.\nIt can be turned off/on by the user."}),"\n",(0,n.jsx)(t.h2,{id:"methods",children:"Methods"}),"\n",(0,n.jsx)(t.h3,{id:"start",children:"start()"}),"\n",(0,n.jsxs)(t.blockquote,{children:["\n",(0,n.jsxs)(t.p,{children:[(0,n.jsx)(t.strong,{children:"start"}),"(",(0,n.jsx)(t.code,{children:"logger"}),"): ",(0,n.jsx)(t.code,{children:"Promise"}),"<",(0,n.jsx)(t.code,{children:"void"}),">"]}),"\n"]}),"\n",(0,n.jsx)(t.h4,{id:"parameters",children:"Parameters"}),"\n",(0,n.jsxs)(t.p,{children:["\u2022 ",(0,n.jsx)(t.strong,{children:"logger"}),": ",(0,n.jsx)(t.a,{href:"/api/interfaces/Logger",children:(0,n.jsx)(t.code,{children:"Logger"})})]}),"\n",(0,n.jsx)(t.h4,{id:"returns",children:"Returns"}),"\n",(0,n.jsxs)(t.p,{children:[(0,n.jsx)(t.code,{children:"Promise"}),"<",(0,n.jsx)(t.code,{children:"void"}),">"]}),"\n",(0,n.jsx)(t.h4,{id:"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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L557",children:"packages/extension-api/src/extension-api.d.ts:557"})})]})}function h(e={}){const{wrapper:t}={...(0,s.a)(),...e.components};return t?(0,n.jsx)(t,{...e,children:(0,n.jsx)(l,{...e})}):l(e)}},71670:(e,t,r)=>{r.d(t,{Z:()=>a,a:()=>o});var n=r(27378);const s={},i=n.createContext(s);function o(e){const t=n.useContext(i);return n.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function a(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:o(e.components),n.createElement(i.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/c1584a80.b1eeaf05.js b/assets/js/c1584a80.92668091.js similarity index 83% rename from assets/js/c1584a80.b1eeaf05.js rename to assets/js/c1584a80.92668091.js index e593ce615b0..faa44ba252b 100644 --- a/assets/js/c1584a80.b1eeaf05.js +++ b/assets/js/c1584a80.92668091.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[19537],{31917:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>o,contentTitle:()=>d,default:()=>h,frontMatter:()=>t,metadata:()=>a,toc:()=>c});var s=r(24246),i=r(71670);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"}},o={},c=[{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",hr:"hr",p:"p",strong:"strong",...(0,i.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"interface-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/804b2198fda0957e1ecfb87539f019eb9b79a66f/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/804b2198fda0957e1ecfb87539f019eb9b79a66f/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/804b2198fda0957e1ecfb87539f019eb9b79a66f/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.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},71670:(e,n,r)=>{r.d(n,{Z:()=>a,a:()=>d});var s=r(27378);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([[19537],{31917:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>c,contentTitle:()=>t,default:()=>h,frontMatter:()=>d,metadata:()=>a,toc:()=>o});var s=r(24246),i=r(71670);const d={},t="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",hr:"hr",p:"p",strong:"strong",...(0,i.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"interface-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/bd83a8b2bb8ab886dc757381b589638cbda150d0/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/bd83a8b2bb8ab886dc757381b589638cbda150d0/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/bd83a8b2bb8ab886dc757381b589638cbda150d0/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.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},71670:(e,n,r)=>{r.d(n,{Z:()=>a,a:()=>t});var s=r(27378);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 diff --git a/assets/js/c1ca9e21.3b9a4a34.js b/assets/js/c1ca9e21.5754ec76.js similarity index 90% rename from assets/js/c1ca9e21.3b9a4a34.js rename to assets/js/c1ca9e21.5754ec76.js index 4d9768a096e..f9a43849522 100644 --- a/assets/js/c1ca9e21.3b9a4a34.js +++ b/assets/js/c1ca9e21.5754ec76.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[17285],{17487:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>s,default:()=>p,frontMatter:()=>r,metadata:()=>o,toc:()=>d});var i=t(24246),c=t(71670);const r={},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",hr:"hr",p:"p",strong:"strong",...(0,c.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"interface-kubeconfigupdateevent",children:"Interface: KubeconfigUpdateEvent"}),"\n",(0,i.jsx)(n.p,{children:"An event describing the update in kubeconfig location"}),"\n",(0,i.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(n.h3,{id:"location",children:"location"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"readonly"})," ",(0,i.jsx)(n.strong,{children:"location"}),": ",(0,i.jsx)(n.a,{href:"/api/classes/Uri",children:(0,i.jsx)(n.code,{children:"Uri"})})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L2106",children:"packages/extension-api/src/extension-api.d.ts:2106"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L2105",children:"packages/extension-api/src/extension-api.d.ts:2105"})})]})}function p(e={}){const{wrapper:n}={...(0,c.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>o,a:()=>s});var i=t(27378);const c={},r=i.createContext(c);function s(e){const n=i.useContext(r);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(c):e.components||c:s(e.components),i.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[17285],{17487:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>d,contentTitle:()=>s,default:()=>p,frontMatter:()=>r,metadata:()=>o,toc:()=>a});var i=t(24246),c=t(71670);const r={},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"}},d={},a=[{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",hr:"hr",p:"p",strong:"strong",...(0,c.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"interface-kubeconfigupdateevent",children:"Interface: KubeconfigUpdateEvent"}),"\n",(0,i.jsx)(n.p,{children:"An event describing the update in kubeconfig location"}),"\n",(0,i.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(n.h3,{id:"location",children:"location"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"readonly"})," ",(0,i.jsx)(n.strong,{children:"location"}),": ",(0,i.jsx)(n.a,{href:"/api/classes/Uri",children:(0,i.jsx)(n.code,{children:"Uri"})})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2106",children:"packages/extension-api/src/extension-api.d.ts:2106"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2105",children:"packages/extension-api/src/extension-api.d.ts:2105"})})]})}function p(e={}){const{wrapper:n}={...(0,c.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>o,a:()=>s});var i=t(27378);const c={},r=i.createContext(c);function s(e){const n=i.useContext(r);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(c):e.components||c:s(e.components),i.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/c239db97.f5051f29.js b/assets/js/c239db97.e0210e70.js similarity index 98% rename from assets/js/c239db97.f5051f29.js rename to assets/js/c239db97.e0210e70.js index 19c36deaead..320dbdc50f1 100644 --- a/assets/js/c239db97.f5051f29.js +++ b/assets/js/c239db97.e0210e70.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[62789],{24342:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>o,contentTitle:()=>r,default:()=>h,frontMatter:()=>a,metadata:()=>c,toc:()=>d});var s=i(24246),t=i(71670);const a={},r="Function: saveImage()",c={id:"namespaces/containerEngine/functions/saveImage",title:"Function: saveImage()",description:"saveImage(engineId, id, filename): Promise\\",source:"@site/api/namespaces/containerEngine/functions/saveImage.md",sourceDirName:"namespaces/containerEngine/functions",slug:"/namespaces/containerEngine/functions/saveImage",permalink:"/api/namespaces/containerEngine/functions/saveImage",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"replicatePodmanContainer",permalink:"/api/namespaces/containerEngine/functions/replicatePodmanContainer"},next:{title:"startContainer",permalink:"/api/namespaces/containerEngine/functions/startContainer"}},o={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Defined in",id:"defined-in",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,t.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"function-saveimage",children:"Function: saveImage()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"saveImage"}),"(",(0,s.jsx)(n.code,{children:"engineId"}),", ",(0,s.jsx)(n.code,{children:"id"}),", ",(0,s.jsx)(n.code,{children:"filename"}),"): ",(0,s.jsx)(n.code,{children:"Promise"}),"<",(0,s.jsx)(n.code,{children:"void"}),">"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Save on disk a tarball containing the image and its metadata."}),"\n",(0,s.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"engineId"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n",(0,s.jsxs)(n.p,{children:["the id of the engine managing the image, obtained from the result of ",(0,s.jsx)(n.a,{href:"/api/namespaces/containerEngine/functions/listImages",children:"containerEngine.listImages"})]}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"id"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n",(0,s.jsxs)(n.p,{children:["the id or name of the image on this engine, obtained from the result of ",(0,s.jsx)(n.a,{href:"/api/namespaces/containerEngine/functions/listImages",children:"containerEngine.listImages"})]}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"filename"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n",(0,s.jsx)(n.p,{children:"the file on which to save the container image content"}),"\n",(0,s.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"Promise"}),"<",(0,s.jsx)(n.code,{children:"void"}),">"]}),"\n",(0,s.jsx)(n.h2,{id:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L3549",children:"packages/extension-api/src/extension-api.d.ts:3549"})})]})}function h(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>c,a:()=>r});var s=i(27378);const t={},a=s.createContext(t);function r(e){const n=s.useContext(a);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:r(e.components),s.createElement(a.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[62789],{24342:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>o,contentTitle:()=>r,default:()=>h,frontMatter:()=>a,metadata:()=>c,toc:()=>d});var s=i(24246),t=i(71670);const a={},r="Function: saveImage()",c={id:"namespaces/containerEngine/functions/saveImage",title:"Function: saveImage()",description:"saveImage(engineId, id, filename): Promise\\",source:"@site/api/namespaces/containerEngine/functions/saveImage.md",sourceDirName:"namespaces/containerEngine/functions",slug:"/namespaces/containerEngine/functions/saveImage",permalink:"/api/namespaces/containerEngine/functions/saveImage",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"replicatePodmanContainer",permalink:"/api/namespaces/containerEngine/functions/replicatePodmanContainer"},next:{title:"startContainer",permalink:"/api/namespaces/containerEngine/functions/startContainer"}},o={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Defined in",id:"defined-in",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,t.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"function-saveimage",children:"Function: saveImage()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"saveImage"}),"(",(0,s.jsx)(n.code,{children:"engineId"}),", ",(0,s.jsx)(n.code,{children:"id"}),", ",(0,s.jsx)(n.code,{children:"filename"}),"): ",(0,s.jsx)(n.code,{children:"Promise"}),"<",(0,s.jsx)(n.code,{children:"void"}),">"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Save on disk a tarball containing the image and its metadata."}),"\n",(0,s.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"engineId"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n",(0,s.jsxs)(n.p,{children:["the id of the engine managing the image, obtained from the result of ",(0,s.jsx)(n.a,{href:"/api/namespaces/containerEngine/functions/listImages",children:"containerEngine.listImages"})]}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"id"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n",(0,s.jsxs)(n.p,{children:["the id or name of the image on this engine, obtained from the result of ",(0,s.jsx)(n.a,{href:"/api/namespaces/containerEngine/functions/listImages",children:"containerEngine.listImages"})]}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"filename"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n",(0,s.jsx)(n.p,{children:"the file on which to save the container image content"}),"\n",(0,s.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"Promise"}),"<",(0,s.jsx)(n.code,{children:"void"}),">"]}),"\n",(0,s.jsx)(n.h2,{id:"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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L3549",children:"packages/extension-api/src/extension-api.d.ts:3549"})})]})}function h(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>c,a:()=>r});var s=i(27378);const t={},a=s.createContext(t);function r(e){const n=s.useContext(a);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:r(e.components),s.createElement(a.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/c25913f3.b74228cb.js b/assets/js/c25913f3.b41169de.js similarity index 88% rename from assets/js/c25913f3.b74228cb.js rename to assets/js/c25913f3.b41169de.js index 78a74160147..dee5030d6c7 100644 --- a/assets/js/c25913f3.b74228cb.js +++ b/assets/js/c25913f3.b41169de.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[16311],{85626:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>c,contentTitle:()=>o,default:()=>p,frontMatter:()=>a,metadata:()=>r,toc:()=>d});var i=t(24246),s=t(71670);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",hr:"hr",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"interface-inputboxvalidationmessage",children:"Interface: InputBoxValidationMessage"}),"\n",(0,i.jsx)(n.p,{children:"Object to configure the behavior of the validation message."}),"\n",(0,i.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(n.h3,{id:"message",children:"message"}),"\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:"message"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"The validation message to display."}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L1104",children:"packages/extension-api/src/extension-api.d.ts:1104"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"severity",children:"severity"}),"\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:"severity"}),": ",(0,i.jsx)(n.a,{href:"/api/enumerations/InputBoxValidationSeverity",children:(0,i.jsx)(n.code,{children:"InputBoxValidationSeverity"})})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["The severity of the validation message.\nNOTE: When using ",(0,i.jsx)(n.code,{children:"InputBoxValidationSeverity.Error"}),", the user will not be allowed to accept (hit ENTER) the input.\n",(0,i.jsx)(n.code,{children:"Info"})," and ",(0,i.jsx)(n.code,{children:"Warning"})," will still allow the InputBox to accept the input."]}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L1111",children:"packages/extension-api/src/extension-api.d.ts:1111"})})]})}function p(e={}){const{wrapper:n}={...(0,s.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>r,a:()=>o});var i=t(27378);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 r(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([[16311],{85626:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>d,contentTitle:()=>o,default:()=>p,frontMatter:()=>a,metadata:()=>r,toc:()=>c});var i=t(24246),s=t(71670);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",hr:"hr",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"interface-inputboxvalidationmessage",children:"Interface: InputBoxValidationMessage"}),"\n",(0,i.jsx)(n.p,{children:"Object to configure the behavior of the validation message."}),"\n",(0,i.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(n.h3,{id:"message",children:"message"}),"\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:"message"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"The validation message to display."}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L1104",children:"packages/extension-api/src/extension-api.d.ts:1104"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"severity",children:"severity"}),"\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:"severity"}),": ",(0,i.jsx)(n.a,{href:"/api/enumerations/InputBoxValidationSeverity",children:(0,i.jsx)(n.code,{children:"InputBoxValidationSeverity"})})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["The severity of the validation message.\nNOTE: When using ",(0,i.jsx)(n.code,{children:"InputBoxValidationSeverity.Error"}),", the user will not be allowed to accept (hit ENTER) the input.\n",(0,i.jsx)(n.code,{children:"Info"})," and ",(0,i.jsx)(n.code,{children:"Warning"})," will still allow the InputBox to accept the input."]}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L1111",children:"packages/extension-api/src/extension-api.d.ts:1111"})})]})}function p(e={}){const{wrapper:n}={...(0,s.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>r,a:()=>o});var i=t(27378);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 r(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 diff --git a/assets/js/c2865a15.3ec62a56.js b/assets/js/c2865a15.bad52484.js similarity index 76% rename from assets/js/c2865a15.3ec62a56.js rename to assets/js/c2865a15.bad52484.js index 802f00fc813..9797f1c4f95 100644 --- a/assets/js/c2865a15.3ec62a56.js +++ b/assets/js/c2865a15.bad52484.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[93401],{74193:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>c,contentTitle:()=>a,default:()=>l,frontMatter:()=>s,metadata:()=>p,toc:()=>r});var o=t(24246),i=t(71670);const s={},a="Type Alias: MountType",p={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={},r=[{value:"Defined in",id:"defined-in",level:2}];function d(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,i.a)(),...e.components};return(0,o.jsxs)(o.Fragment,{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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L2369",children:"packages/extension-api/src/extension-api.d.ts:2369"})})]})}function l(e={}){const{wrapper:n}={...(0,i.a)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(d,{...e})}):d(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>p,a:()=>a});var o=t(27378);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 p(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([[93401],{74193:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>p,contentTitle:()=>a,default:()=>l,frontMatter:()=>s,metadata:()=>c,toc:()=>r});var o=t(24246),i=t(71670);const s={},a="Type Alias: MountType",c={id:"type-aliases/MountType",title:"Type Alias: MountType",description:'MountType: "bind" \\| "volume" \\| "tmpfs"',source:"@site/api/type-aliases/MountType.md",sourceDirName:"type-aliases",slug:"/type-aliases/MountType",permalink:"/api/type-aliases/MountType",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"MountPropagation",permalink:"/api/type-aliases/MountPropagation"},next:{title:"NotificationType",permalink:"/api/type-aliases/NotificationType"}},p={},r=[{value:"Defined in",id:"defined-in",level:2}];function d(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,i.a)(),...e.components};return(0,o.jsxs)(o.Fragment,{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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2369",children:"packages/extension-api/src/extension-api.d.ts:2369"})})]})}function l(e={}){const{wrapper:n}={...(0,i.a)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(d,{...e})}):d(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>c,a:()=>a});var o=t(27378);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/c358ebbc.ccc51432.js b/assets/js/c358ebbc.780011f5.js similarity index 94% rename from assets/js/c358ebbc.ccc51432.js rename to assets/js/c358ebbc.780011f5.js index 5f122645434..4ef221081d6 100644 --- a/assets/js/c358ebbc.ccc51432.js +++ b/assets/js/c358ebbc.780011f5.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[27910],{98358:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>c,contentTitle:()=>o,default:()=>l,frontMatter:()=>r,metadata:()=>d,toc:()=>a});var i=s(24246),t=s(71670);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",hr:"hr",p:"p",strong:"strong",...(0,t.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"interface-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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L3839",children:"packages/extension-api/src/extension-api.d.ts:3839"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L3862",children:"packages/extension-api/src/extension-api.d.ts:3862"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L3847",children:"packages/extension-api/src/extension-api.d.ts:3847"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L3872",children:"packages/extension-api/src/extension-api.d.ts:3872"})})]})}function l(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(h,{...e})}):h(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>d,a:()=>o});var i=s(27378);const t={},r=i.createContext(t);function o(e){const n=i.useContext(r);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function 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([[27910],{98358:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>c,contentTitle:()=>o,default:()=>l,frontMatter:()=>r,metadata:()=>d,toc:()=>a});var i=s(24246),t=s(71670);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",hr:"hr",p:"p",strong:"strong",...(0,t.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"interface-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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L3839",children:"packages/extension-api/src/extension-api.d.ts:3839"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L3862",children:"packages/extension-api/src/extension-api.d.ts:3862"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L3847",children:"packages/extension-api/src/extension-api.d.ts:3847"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L3872",children:"packages/extension-api/src/extension-api.d.ts:3872"})})]})}function l(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(h,{...e})}):h(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>d,a:()=>o});var i=s(27378);const t={},r=i.createContext(t);function o(e){const n=i.useContext(r);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function 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.8086540d.js b/assets/js/c544b2d7.3da570a4.js similarity index 95% rename from assets/js/c544b2d7.8086540d.js rename to assets/js/c544b2d7.3da570a4.js index 5680e73798e..a354d86cb29 100644 --- a/assets/js/c544b2d7.8086540d.js +++ b/assets/js/c544b2d7.3da570a4.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[75689],{72299:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>c,contentTitle:()=>o,default:()=>p,frontMatter:()=>r,metadata:()=>a,toc:()=>d});var i=t(24246),s=t(71670);const r={},o="Interface: ListImagesOptions",a={id:"interfaces/ListImagesOptions",title:"Interface: ListImagesOptions",description:"Properties",source:"@site/api/interfaces/ListImagesOptions.md",sourceDirName:"interfaces",slug:"/interfaces/ListImagesOptions",permalink:"/api/interfaces/ListImagesOptions",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Link",permalink:"/api/interfaces/Link"},next:{title:"ListInfosOptions",permalink:"/api/interfaces/ListInfosOptions"}},c={},d=[{value:"Properties",id:"properties",level:2},{value:"provider?",id:"provider",level:3},{value:"Default Value",id:"default-value",level:4},{value:"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",p:"p",pre:"pre",strong:"strong",...(0,s.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"interface-listimagesoptions",children:"Interface: ListImagesOptions"}),"\n",(0,i.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(n.h3,{id:"provider",children:"provider?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"provider"}),": ",(0,i.jsx)(n.a,{href:"/api/interfaces/ContainerProviderConnection",children:(0,i.jsx)(n.code,{children:"ContainerProviderConnection"})})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"The provider we want to list the images. If not provided, will return all container images across all container engines."}),"\n",(0,i.jsx)(n.h4,{id:"default-value",children:"Default Value"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-ts",children:"undefined\n"})}),"\n",(0,i.jsx)(n.h4,{id:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L3327",children:"packages/extension-api/src/extension-api.d.ts:3327"})})]})}function p(e={}){const{wrapper:n}={...(0,s.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>a,a:()=>o});var i=t(27378);const s={},r=i.createContext(s);function o(e){const n=i.useContext(r);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function a(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:o(e.components),i.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[75689],{72299:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>c,contentTitle:()=>o,default:()=>p,frontMatter:()=>r,metadata:()=>a,toc:()=>d});var i=t(24246),s=t(71670);const r={},o="Interface: ListImagesOptions",a={id:"interfaces/ListImagesOptions",title:"Interface: ListImagesOptions",description:"Properties",source:"@site/api/interfaces/ListImagesOptions.md",sourceDirName:"interfaces",slug:"/interfaces/ListImagesOptions",permalink:"/api/interfaces/ListImagesOptions",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Link",permalink:"/api/interfaces/Link"},next:{title:"ListInfosOptions",permalink:"/api/interfaces/ListInfosOptions"}},c={},d=[{value:"Properties",id:"properties",level:2},{value:"provider?",id:"provider",level:3},{value:"Default Value",id:"default-value",level:4},{value:"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",p:"p",pre:"pre",strong:"strong",...(0,s.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"interface-listimagesoptions",children:"Interface: ListImagesOptions"}),"\n",(0,i.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(n.h3,{id:"provider",children:"provider?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"provider"}),": ",(0,i.jsx)(n.a,{href:"/api/interfaces/ContainerProviderConnection",children:(0,i.jsx)(n.code,{children:"ContainerProviderConnection"})})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"The provider we want to list the images. If not provided, will return all container images across all container engines."}),"\n",(0,i.jsx)(n.h4,{id:"default-value",children:"Default Value"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-ts",children:"undefined\n"})}),"\n",(0,i.jsx)(n.h4,{id:"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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L3327",children:"packages/extension-api/src/extension-api.d.ts:3327"})})]})}function p(e={}){const{wrapper:n}={...(0,s.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>a,a:()=>o});var i=t(27378);const s={},r=i.createContext(s);function o(e){const n=i.useContext(r);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function a(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:o(e.components),i.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/c7cac05f.d2491652.js b/assets/js/c7cac05f.3b251841.js similarity index 93% rename from assets/js/c7cac05f.d2491652.js rename to assets/js/c7cac05f.3b251841.js index c5b0c7f77a4..437e9e4c42d 100644 --- a/assets/js/c7cac05f.d2491652.js +++ b/assets/js/c7cac05f.3b251841.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[73867],{66013:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>l,contentTitle:()=>d,default:()=>p,frontMatter:()=>o,metadata:()=>r,toc:()=>c});var s=i(24246),t=i(71670);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={},c=[{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 a(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,t.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"interface-opendialogoptions",children:"Interface: OpenDialogOptions"}),"\n",(0,s.jsx)(n.p,{children:"Options to configure the behaviour of a file open dialog."}),"\n",(0,s.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,s.jsx)(n.h3,{id:"defaulturi",children:"defaultUri?"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"optional"})," ",(0,s.jsx)(n.strong,{children:"defaultUri"}),": ",(0,s.jsx)(n.a,{href:"/api/classes/Uri",children:(0,s.jsx)(n.code,{children:"Uri"})})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The resource the dialog shows when opened."}),"\n",(0,s.jsx)(n.h4,{id:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L1798",children:"packages/extension-api/src/extension-api.d.ts:1798"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L1814",children:"packages/extension-api/src/extension-api.d.ts:1814"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L1803",children:"packages/extension-api/src/extension-api.d.ts:1803"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/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:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L1822",children:"packages/extension-api/src/extension-api.d.ts:1822"})})]})}function p(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(a,{...e})}):a(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>r,a:()=>d});var s=i(27378);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([[73867],{66013:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>l,contentTitle:()=>d,default:()=>p,frontMatter:()=>o,metadata:()=>r,toc:()=>c});var s=i(24246),t=i(71670);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={},c=[{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 a(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,t.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"interface-opendialogoptions",children:"Interface: OpenDialogOptions"}),"\n",(0,s.jsx)(n.p,{children:"Options to configure the behaviour of a file open dialog."}),"\n",(0,s.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,s.jsx)(n.h3,{id:"defaulturi",children:"defaultUri?"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"optional"})," ",(0,s.jsx)(n.strong,{children:"defaultUri"}),": ",(0,s.jsx)(n.a,{href:"/api/classes/Uri",children:(0,s.jsx)(n.code,{children:"Uri"})})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The resource the dialog shows when opened."}),"\n",(0,s.jsx)(n.h4,{id:"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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L1798",children:"packages/extension-api/src/extension-api.d.ts:1798"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L1814",children:"packages/extension-api/src/extension-api.d.ts:1814"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L1803",children:"packages/extension-api/src/extension-api.d.ts:1803"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/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:"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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L1822",children:"packages/extension-api/src/extension-api.d.ts:1822"})})]})}function p(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(a,{...e})}):a(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>r,a:()=>d});var s=i(27378);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.e771eafd.js b/assets/js/c813bd67.fcf0fda7.js similarity index 80% rename from assets/js/c813bd67.e771eafd.js rename to assets/js/c813bd67.fcf0fda7.js index fd4bff927ea..6a8cc8d77cd 100644 --- a/assets/js/c813bd67.e771eafd.js +++ b/assets/js/c813bd67.fcf0fda7.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[82163],{9762:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>d,contentTitle:()=>c,default:()=>p,frontMatter:()=>r,metadata:()=>o,toc:()=>a});var s=i(24246),t=i(71670);const r={},c="Interface: IPAM",o={id:"interfaces/IPAM",title:"Interface: IPAM",description:"Properties",source:"@site/api/interfaces/IPAM.md",sourceDirName:"interfaces",slug:"/interfaces/IPAM",permalink:"/api/interfaces/IPAM",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"HostRestartPolicy",permalink:"/api/interfaces/HostRestartPolicy"},next:{title:"ImageCheck",permalink:"/api/interfaces/ImageCheck"}},d={},a=[{value:"Properties",id:"properties",level:2},{value:"Config?",id:"config",level:3},{value:"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",hr:"hr",p:"p",strong:"strong",...(0,t.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"interface-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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L2240",children:"packages/extension-api/src/extension-api.d.ts:2240"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L2239",children:"packages/extension-api/src/extension-api.d.ts:2239"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L2241",children:"packages/extension-api/src/extension-api.d.ts:2241"})})]})}function p(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>o,a:()=>c});var s=i(27378);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 o(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 +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[82163],{9762:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>o,contentTitle:()=>d,default:()=>p,frontMatter:()=>r,metadata:()=>c,toc:()=>a});var s=i(24246),t=i(71670);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",hr:"hr",p:"p",strong:"strong",...(0,t.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"interface-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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2240",children:"packages/extension-api/src/extension-api.d.ts:2240"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2239",children:"packages/extension-api/src/extension-api.d.ts:2239"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2241",children:"packages/extension-api/src/extension-api.d.ts:2241"})})]})}function p(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>c,a:()=>d});var s=i(27378);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 diff --git a/assets/js/ca1234c1.a7c2d74a.js b/assets/js/ca1234c1.91ea8ce8.js similarity index 93% rename from assets/js/ca1234c1.a7c2d74a.js rename to assets/js/ca1234c1.91ea8ce8.js index 40ce82a0eb6..e1c6d521dae 100644 --- a/assets/js/ca1234c1.a7c2d74a.js +++ b/assets/js/ca1234c1.91ea8ce8.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[77401],{23783:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>c,contentTitle:()=>s,default:()=>p,frontMatter:()=>t,metadata:()=>d,toc:()=>a});var o=i(24246),r=i(71670);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",hr:"hr",p:"p",strong:"strong",...(0,r.a)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(n.h1,{id:"interface-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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L4243",children:"packages/extension-api/src/extension-api.d.ts:4243"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L4231",children:"packages/extension-api/src/extension-api.d.ts:4231"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L4237",children:"packages/extension-api/src/extension-api.d.ts:4237"})})]})}function p(e={}){const{wrapper:n}={...(0,r.a)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(l,{...e})}):l(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>d,a:()=>s});var o=i(27378);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([[77401],{23783:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>c,contentTitle:()=>s,default:()=>p,frontMatter:()=>t,metadata:()=>d,toc:()=>a});var o=i(24246),r=i(71670);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",hr:"hr",p:"p",strong:"strong",...(0,r.a)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(n.h1,{id:"interface-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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L4243",children:"packages/extension-api/src/extension-api.d.ts:4243"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L4231",children:"packages/extension-api/src/extension-api.d.ts:4231"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L4237",children:"packages/extension-api/src/extension-api.d.ts:4237"})})]})}function p(e={}){const{wrapper:n}={...(0,r.a)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(l,{...e})}):l(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>d,a:()=>s});var o=i(27378);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.b9e6f074.js b/assets/js/ca165b51.2783caf8.js similarity index 91% rename from assets/js/ca165b51.b9e6f074.js rename to assets/js/ca165b51.2783caf8.js index 2cc66576417..9567276b1aa 100644 --- a/assets/js/ca165b51.b9e6f074.js +++ b/assets/js/ca165b51.2783caf8.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[68059],{89508:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>c,contentTitle:()=>o,default:()=>l,frontMatter:()=>r,metadata:()=>d,toc:()=>a});var i=t(24246),s=t(71670);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",hr:"hr",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"interface-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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L847",children:"packages/extension-api/src/extension-api.d.ts:847"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L848",children:"packages/extension-api/src/extension-api.d.ts:848"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L849",children:"packages/extension-api/src/extension-api.d.ts:849"})})]})}function l(e={}){const{wrapper:n}={...(0,s.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(p,{...e})}):p(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>d,a:()=>o});var i=t(27378);const s={},r=i.createContext(s);function o(e){const n=i.useContext(r);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function 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([[68059],{89508:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>c,contentTitle:()=>o,default:()=>l,frontMatter:()=>r,metadata:()=>d,toc:()=>a});var i=t(24246),s=t(71670);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",hr:"hr",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"interface-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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L847",children:"packages/extension-api/src/extension-api.d.ts:847"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L848",children:"packages/extension-api/src/extension-api.d.ts:848"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L849",children:"packages/extension-api/src/extension-api.d.ts:849"})})]})}function l(e={}){const{wrapper:n}={...(0,s.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(p,{...e})}):p(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>d,a:()=>o});var i=t(27378);const s={},r=i.createContext(s);function o(e){const n=i.useContext(r);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function 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.4ec146cf.js b/assets/js/caddb1c0.34d5fe5b.js similarity index 95% rename from assets/js/caddb1c0.4ec146cf.js rename to assets/js/caddb1c0.34d5fe5b.js index 6d5252484ea..ef534fc3e6d 100644 --- a/assets/js/caddb1c0.4ec146cf.js +++ b/assets/js/caddb1c0.34d5fe5b.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[96987],{99950:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>o,contentTitle:()=>c,default:()=>h,frontMatter:()=>d,metadata:()=>t,toc:()=>l});var r=i(24246),s=i(71670);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",hr:"hr",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.h1,{id:"interface-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/804b2198fda0957e1ecfb87539f019eb9b79a66f/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/804b2198fda0957e1ecfb87539f019eb9b79a66f/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/804b2198fda0957e1ecfb87539f019eb9b79a66f/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/804b2198fda0957e1ecfb87539f019eb9b79a66f/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.a)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(a,{...e})}):a(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>t,a:()=>c});var r=i(27378);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([[96987],{99950:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>o,contentTitle:()=>c,default:()=>h,frontMatter:()=>d,metadata:()=>t,toc:()=>l});var r=i(24246),s=i(71670);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",hr:"hr",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.h1,{id:"interface-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/bd83a8b2bb8ab886dc757381b589638cbda150d0/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/bd83a8b2bb8ab886dc757381b589638cbda150d0/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/bd83a8b2bb8ab886dc757381b589638cbda150d0/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/bd83a8b2bb8ab886dc757381b589638cbda150d0/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.a)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(a,{...e})}):a(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>t,a:()=>c});var r=i(27378);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.7104633e.js b/assets/js/cb0f21df.48eac277.js similarity index 90% rename from assets/js/cb0f21df.7104633e.js rename to assets/js/cb0f21df.48eac277.js index 89e47fa8604..49d5349ae84 100644 --- a/assets/js/cb0f21df.7104633e.js +++ b/assets/js/cb0f21df.48eac277.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[6098],{14202:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>d,contentTitle:()=>o,default:()=>l,frontMatter:()=>r,metadata:()=>c,toc:()=>a});var i=t(24246),s=t(71670);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",hr:"hr",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"interface-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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L683",children:"packages/extension-api/src/extension-api.d.ts:683"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L682",children:"packages/extension-api/src/extension-api.d.ts:682"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L684",children:"packages/extension-api/src/extension-api.d.ts:684"})})]})}function l(e={}){const{wrapper:n}={...(0,s.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(p,{...e})}):p(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>c,a:()=>o});var i=t(27378);const s={},r=i.createContext(s);function o(e){const n=i.useContext(r);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:o(e.components),i.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[6098],{14202:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>d,contentTitle:()=>o,default:()=>l,frontMatter:()=>r,metadata:()=>c,toc:()=>a});var i=t(24246),s=t(71670);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",hr:"hr",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"interface-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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L683",children:"packages/extension-api/src/extension-api.d.ts:683"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L682",children:"packages/extension-api/src/extension-api.d.ts:682"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L684",children:"packages/extension-api/src/extension-api.d.ts:684"})})]})}function l(e={}){const{wrapper:n}={...(0,s.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(p,{...e})}):p(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>c,a:()=>o});var i=t(27378);const s={},r=i.createContext(s);function o(e){const n=i.useContext(r);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:o(e.components),i.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/cc6d9416.13809c24.js b/assets/js/cc6d9416.e57367f3.js similarity index 79% rename from assets/js/cc6d9416.13809c24.js rename to assets/js/cc6d9416.e57367f3.js index 506b4d5a673..0de48c1dbaa 100644 --- a/assets/js/cc6d9416.13809c24.js +++ b/assets/js/cc6d9416.e57367f3.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[71874],{2958:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>a,contentTitle:()=>d,default:()=>h,frontMatter:()=>r,metadata:()=>o,toc:()=>c});var s=i(24246),t=i(71670);const r={},d="Interface: AuthConfig",o={id:"interfaces/AuthConfig",title:"Interface: AuthConfig",description:"Properties",source:"@site/api/interfaces/AuthConfig.md",sourceDirName:"interfaces",slug:"/interfaces/AuthConfig",permalink:"/api/interfaces/AuthConfig",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Auditor",permalink:"/api/interfaces/Auditor"},next:{title:"AuthenticationGetSessionOptions",permalink:"/api/interfaces/AuthenticationGetSessionOptions"}},a={},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",hr:"hr",p:"p",strong:"strong",...(0,t.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"interface-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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L2345",children:"packages/extension-api/src/extension-api.d.ts:2345"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L2343",children:"packages/extension-api/src/extension-api.d.ts:2343"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L2344",children:"packages/extension-api/src/extension-api.d.ts:2344"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L2342",children:"packages/extension-api/src/extension-api.d.ts:2342"})})]})}function h(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>o,a:()=>d});var s=i(27378);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([[71874],{2958:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>o,contentTitle:()=>d,default:()=>h,frontMatter:()=>r,metadata:()=>a,toc:()=>c});var s=i(24246),t=i(71670);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",hr:"hr",p:"p",strong:"strong",...(0,t.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"interface-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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2345",children:"packages/extension-api/src/extension-api.d.ts:2345"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2343",children:"packages/extension-api/src/extension-api.d.ts:2343"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2344",children:"packages/extension-api/src/extension-api.d.ts:2344"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2342",children:"packages/extension-api/src/extension-api.d.ts:2342"})})]})}function h(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>a,a:()=>d});var s=i(27378);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.fe1d0baa.js b/assets/js/cc922df3.03b531fb.js similarity index 94% rename from assets/js/cc922df3.fe1d0baa.js rename to assets/js/cc922df3.03b531fb.js index d7fb97ac441..41d034eabc3 100644 --- a/assets/js/cc922df3.fe1d0baa.js +++ b/assets/js/cc922df3.03b531fb.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[53273],{71270:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>c,contentTitle:()=>r,default:()=>h,frontMatter:()=>o,metadata:()=>a,toc:()=>d});var t=i(24246),s=i(71670);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",hr:"hr",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"interface-authenticationgetsessionoptions",children:"Interface: AuthenticationGetSessionOptions"}),"\n",(0,t.jsxs)(n.p,{children:["Options to be used when getting an ",(0,t.jsx)(n.a,{href:"#AuthenticationSession",children:"AuthenticationSession"})," from an ",(0,t.jsx)(n.a,{href:"#AuthenticationProvider",children:"AuthenticationProvider"}),"."]}),"\n",(0,t.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,t.jsx)(n.h3,{id:"clearsessionpreference",children:"clearSessionPreference?"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"optional"})," ",(0,t.jsx)(n.strong,{children:"clearSessionPreference"}),": ",(0,t.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"Whether the existing user session preference should be cleared."}),"\n",(0,t.jsxs)(n.p,{children:["For authentication providers that support being signed into multiple accounts at once, the user will be\nprompted to select an account to use when ",(0,t.jsx)(n.a,{href:"#authentication.getSession",children:"getSession"})," is called. This preference\nis remembered until ",(0,t.jsx)(n.a,{href:"#authentication.getSession",children:"getSession"})," is called with this flag."]}),"\n",(0,t.jsx)(n.p,{children:"Defaults to false."}),"\n",(0,t.jsx)(n.h4,{id:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L3743",children:"packages/extension-api/src/extension-api.d.ts:3743"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L3732",children:"packages/extension-api/src/extension-api.d.ts:3732"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L3756",children:"packages/extension-api/src/extension-api.d.ts:3756"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L3768",children:"packages/extension-api/src/extension-api.d.ts:3768"})})]})}function h(e={}){const{wrapper:n}={...(0,s.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>a,a:()=>r});var t=i(27378);const s={},o=t.createContext(s);function r(e){const n=t.useContext(o);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function a(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:r(e.components),t.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[53273],{71270:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>c,contentTitle:()=>r,default:()=>h,frontMatter:()=>o,metadata:()=>a,toc:()=>d});var t=i(24246),s=i(71670);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",hr:"hr",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"interface-authenticationgetsessionoptions",children:"Interface: AuthenticationGetSessionOptions"}),"\n",(0,t.jsxs)(n.p,{children:["Options to be used when getting an ",(0,t.jsx)(n.a,{href:"#AuthenticationSession",children:"AuthenticationSession"})," from an ",(0,t.jsx)(n.a,{href:"#AuthenticationProvider",children:"AuthenticationProvider"}),"."]}),"\n",(0,t.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,t.jsx)(n.h3,{id:"clearsessionpreference",children:"clearSessionPreference?"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"optional"})," ",(0,t.jsx)(n.strong,{children:"clearSessionPreference"}),": ",(0,t.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"Whether the existing user session preference should be cleared."}),"\n",(0,t.jsxs)(n.p,{children:["For authentication providers that support being signed into multiple accounts at once, the user will be\nprompted to select an account to use when ",(0,t.jsx)(n.a,{href:"#authentication.getSession",children:"getSession"})," is called. This preference\nis remembered until ",(0,t.jsx)(n.a,{href:"#authentication.getSession",children:"getSession"})," is called with this flag."]}),"\n",(0,t.jsx)(n.p,{children:"Defaults to false."}),"\n",(0,t.jsx)(n.h4,{id:"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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L3743",children:"packages/extension-api/src/extension-api.d.ts:3743"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L3732",children:"packages/extension-api/src/extension-api.d.ts:3732"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L3756",children:"packages/extension-api/src/extension-api.d.ts:3756"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L3768",children:"packages/extension-api/src/extension-api.d.ts:3768"})})]})}function h(e={}){const{wrapper:n}={...(0,s.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>a,a:()=>r});var t=i(27378);const s={},o=t.createContext(s);function r(e){const n=t.useContext(o);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function a(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:r(e.components),t.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/cdf64ea9.34963fda.js b/assets/js/cdf64ea9.c11a6e6e.js similarity index 93% rename from assets/js/cdf64ea9.34963fda.js rename to assets/js/cdf64ea9.c11a6e6e.js index 52fd32be706..a09071dffe1 100644 --- a/assets/js/cdf64ea9.34963fda.js +++ b/assets/js/cdf64ea9.c11a6e6e.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[90681],{44337:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>l,contentTitle:()=>c,default:()=>h,frontMatter:()=>r,metadata:()=>t,toc:()=>o});var d=i(24246),s=i(71670);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",hr:"hr",li:"li",p:"p",strong:"strong",ul:"ul",...(0,s.a)(),...e.components};return(0,d.jsxs)(d.Fragment,{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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L4093",children:"packages/extension-api/src/extension-api.d.ts:4093"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L4078",children:"packages/extension-api/src/extension-api.d.ts:4078"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L4073",children:"packages/extension-api/src/extension-api.d.ts:4073"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L4098",children:"packages/extension-api/src/extension-api.d.ts:4098"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L4068",children:"packages/extension-api/src/extension-api.d.ts:4068"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L4088",children:"packages/extension-api/src/extension-api.d.ts:4088"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L4083",children:"packages/extension-api/src/extension-api.d.ts:4083"})})]})}function h(e={}){const{wrapper:n}={...(0,s.a)(),...e.components};return n?(0,d.jsx)(n,{...e,children:(0,d.jsx)(a,{...e})}):a(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>t,a:()=>c});var d=i(27378);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([[90681],{44337:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>l,contentTitle:()=>c,default:()=>h,frontMatter:()=>r,metadata:()=>t,toc:()=>o});var d=i(24246),s=i(71670);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",hr:"hr",li:"li",p:"p",strong:"strong",ul:"ul",...(0,s.a)(),...e.components};return(0,d.jsxs)(d.Fragment,{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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L4093",children:"packages/extension-api/src/extension-api.d.ts:4093"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L4078",children:"packages/extension-api/src/extension-api.d.ts:4078"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L4073",children:"packages/extension-api/src/extension-api.d.ts:4073"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L4098",children:"packages/extension-api/src/extension-api.d.ts:4098"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L4068",children:"packages/extension-api/src/extension-api.d.ts:4068"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L4088",children:"packages/extension-api/src/extension-api.d.ts:4088"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L4083",children:"packages/extension-api/src/extension-api.d.ts:4083"})})]})}function h(e={}){const{wrapper:n}={...(0,s.a)(),...e.components};return n?(0,d.jsx)(n,{...e,children:(0,d.jsx)(a,{...e})}):a(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>t,a:()=>c});var d=i(27378);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/cfdfe126.25bc901b.js b/assets/js/cfdfe126.64f63df0.js similarity index 98% rename from assets/js/cfdfe126.25bc901b.js rename to assets/js/cfdfe126.64f63df0.js index 1d8f3059bb8..0d237a3ef65 100644 --- a/assets/js/cfdfe126.25bc901b.js +++ b/assets/js/cfdfe126.64f63df0.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[64471],{86579:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>c,contentTitle:()=>r,default:()=>h,frontMatter:()=>t,metadata:()=>a,toc:()=>d});var o=s(24246),i=s(71670);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 l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,i.a)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(n.h1,{id:"function-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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L1872",children:"packages/extension-api/src/extension-api.d.ts:1872"})})]})}function h(e={}){const{wrapper:n}={...(0,i.a)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(l,{...e})}):l(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>a,a:()=>r});var o=s(27378);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([[64471],{86579:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>c,contentTitle:()=>r,default:()=>h,frontMatter:()=>t,metadata:()=>a,toc:()=>d});var o=s(24246),i=s(71670);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 l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,i.a)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(n.h1,{id:"function-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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L1872",children:"packages/extension-api/src/extension-api.d.ts:1872"})})]})}function h(e={}){const{wrapper:n}={...(0,i.a)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(l,{...e})}):l(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>a,a:()=>r});var o=s(27378);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.465997da.js b/assets/js/d103759a.40e5f24e.js similarity index 96% rename from assets/js/d103759a.465997da.js rename to assets/js/d103759a.40e5f24e.js index 00475064b97..5e67fbabbe7 100644 --- a/assets/js/d103759a.465997da.js +++ b/assets/js/d103759a.40e5f24e.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[65191],{70093:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>o,contentTitle:()=>i,default:()=>l,frontMatter:()=>s,metadata:()=>c,toc:()=>d});var a=n(24246),r=n(71670);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",p:"p",strong:"strong",...(0,r.a)(),...e.components};return(0,a.jsxs)(a.Fragment,{children:[(0,a.jsx)(t.h1,{id:"function-createstatusbaritem",children:"Function: createStatusBarItem()"}),"\n",(0,a.jsxs)(t.blockquote,{children:["\n",(0,a.jsxs)(t.p,{children:[(0,a.jsx)(t.strong,{children:"createStatusBarItem"}),"(",(0,a.jsx)(t.code,{children:"alignment"}),"?, ",(0,a.jsx)(t.code,{children:"priority"}),"?): ",(0,a.jsx)(t.a,{href:"/api/interfaces/StatusBarItem",children:(0,a.jsx)(t.code,{children:"StatusBarItem"})})]}),"\n"]}),"\n",(0,a.jsxs)(t.p,{children:["Creates a status bar ",(0,a.jsx)(t.a,{href:"/api/interfaces/StatusBarItem",children:"StatusBarItem"})," item."]}),"\n",(0,a.jsx)(t.h2,{id:"parameters",children:"Parameters"}),"\n",(0,a.jsxs)(t.p,{children:["\u2022 ",(0,a.jsx)(t.strong,{children:"alignment?"}),": ",(0,a.jsx)(t.a,{href:"/api/type-aliases/StatusBarAlignment",children:(0,a.jsx)(t.code,{children:"StatusBarAlignment"})})]}),"\n",(0,a.jsx)(t.p,{children:"The alignment of the item."}),"\n",(0,a.jsxs)(t.p,{children:["\u2022 ",(0,a.jsx)(t.strong,{children:"priority?"}),": ",(0,a.jsx)(t.code,{children:"number"})]}),"\n",(0,a.jsx)(t.p,{children:"The priority of the item. Higher values mean more to the left or more to the right."}),"\n",(0,a.jsx)(t.h2,{id:"returns",children:"Returns"}),"\n",(0,a.jsx)(t.p,{children:(0,a.jsx)(t.a,{href:"/api/interfaces/StatusBarItem",children:(0,a.jsx)(t.code,{children:"StatusBarItem"})})}),"\n",(0,a.jsx)(t.p,{children:"A new status bar item."}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L1971",children:"packages/extension-api/src/extension-api.d.ts:1971"})})]})}function l(e={}){const{wrapper:t}={...(0,r.a)(),...e.components};return t?(0,a.jsx)(t,{...e,children:(0,a.jsx)(u,{...e})}):u(e)}},71670:(e,t,n)=>{n.d(t,{Z:()=>c,a:()=>i});var a=n(27378);const r={},s=a.createContext(r);function i(e){const t=a.useContext(s);return a.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function c(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:i(e.components),a.createElement(s.Provider,{value:t},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[65191],{70093:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>o,contentTitle:()=>i,default:()=>l,frontMatter:()=>s,metadata:()=>c,toc:()=>d});var a=n(24246),r=n(71670);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",p:"p",strong:"strong",...(0,r.a)(),...e.components};return(0,a.jsxs)(a.Fragment,{children:[(0,a.jsx)(t.h1,{id:"function-createstatusbaritem",children:"Function: createStatusBarItem()"}),"\n",(0,a.jsxs)(t.blockquote,{children:["\n",(0,a.jsxs)(t.p,{children:[(0,a.jsx)(t.strong,{children:"createStatusBarItem"}),"(",(0,a.jsx)(t.code,{children:"alignment"}),"?, ",(0,a.jsx)(t.code,{children:"priority"}),"?): ",(0,a.jsx)(t.a,{href:"/api/interfaces/StatusBarItem",children:(0,a.jsx)(t.code,{children:"StatusBarItem"})})]}),"\n"]}),"\n",(0,a.jsxs)(t.p,{children:["Creates a status bar ",(0,a.jsx)(t.a,{href:"/api/interfaces/StatusBarItem",children:"StatusBarItem"})," item."]}),"\n",(0,a.jsx)(t.h2,{id:"parameters",children:"Parameters"}),"\n",(0,a.jsxs)(t.p,{children:["\u2022 ",(0,a.jsx)(t.strong,{children:"alignment?"}),": ",(0,a.jsx)(t.a,{href:"/api/type-aliases/StatusBarAlignment",children:(0,a.jsx)(t.code,{children:"StatusBarAlignment"})})]}),"\n",(0,a.jsx)(t.p,{children:"The alignment of the item."}),"\n",(0,a.jsxs)(t.p,{children:["\u2022 ",(0,a.jsx)(t.strong,{children:"priority?"}),": ",(0,a.jsx)(t.code,{children:"number"})]}),"\n",(0,a.jsx)(t.p,{children:"The priority of the item. Higher values mean more to the left or more to the right."}),"\n",(0,a.jsx)(t.h2,{id:"returns",children:"Returns"}),"\n",(0,a.jsx)(t.p,{children:(0,a.jsx)(t.a,{href:"/api/interfaces/StatusBarItem",children:(0,a.jsx)(t.code,{children:"StatusBarItem"})})}),"\n",(0,a.jsx)(t.p,{children:"A new status bar item."}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L1971",children:"packages/extension-api/src/extension-api.d.ts:1971"})})]})}function l(e={}){const{wrapper:t}={...(0,r.a)(),...e.components};return t?(0,a.jsx)(t,{...e,children:(0,a.jsx)(u,{...e})}):u(e)}},71670:(e,t,n)=>{n.d(t,{Z:()=>c,a:()=>i});var a=n(27378);const r={},s=a.createContext(r);function i(e){const t=a.useContext(s);return a.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function c(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:i(e.components),a.createElement(s.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/d1163e47.95535877.js b/assets/js/d1163e47.8ac22ed6.js similarity index 94% rename from assets/js/d1163e47.95535877.js rename to assets/js/d1163e47.8ac22ed6.js index 812d6fad62d..1b1fd6bed9e 100644 --- a/assets/js/d1163e47.95535877.js +++ b/assets/js/d1163e47.8ac22ed6.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[59860],{50575:(e,t,r)=>{r.r(t),r.d(t,{assets:()=>o,contentTitle:()=>c,default:()=>h,frontMatter:()=>i,metadata:()=>s,toc:()=>d});var n=r(24246),a=r(71670);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 t={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",p:"p",strong:"strong",...(0,a.a)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(t.h1,{id:"interface-imagecheckerprovidermetadata",children:"Interface: ImageCheckerProviderMetadata"}),"\n",(0,n.jsx)(t.h2,{id:"properties",children:"Properties"}),"\n",(0,n.jsx)(t.h3,{id:"label",children:"label"}),"\n",(0,n.jsxs)(t.blockquote,{children:["\n",(0,n.jsxs)(t.p,{children:[(0,n.jsx)(t.code,{children:"readonly"})," ",(0,n.jsx)(t.strong,{children:"label"}),": ",(0,n.jsx)(t.code,{children:"string"})]}),"\n"]}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L4399",children:"packages/extension-api/src/extension-api.d.ts:4399"})})]})}function h(e={}){const{wrapper:t}={...(0,a.a)(),...e.components};return t?(0,n.jsx)(t,{...e,children:(0,n.jsx)(l,{...e})}):l(e)}},71670:(e,t,r)=>{r.d(t,{Z:()=>s,a:()=>c});var n=r(27378);const a={},i=n.createContext(a);function c(e){const t=n.useContext(i);return n.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function s(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(a):e.components||a:c(e.components),n.createElement(i.Provider,{value:t},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[59860],{50575:(e,t,r)=>{r.r(t),r.d(t,{assets:()=>o,contentTitle:()=>c,default:()=>h,frontMatter:()=>i,metadata:()=>s,toc:()=>d});var n=r(24246),a=r(71670);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 t={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",p:"p",strong:"strong",...(0,a.a)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(t.h1,{id:"interface-imagecheckerprovidermetadata",children:"Interface: ImageCheckerProviderMetadata"}),"\n",(0,n.jsx)(t.h2,{id:"properties",children:"Properties"}),"\n",(0,n.jsx)(t.h3,{id:"label",children:"label"}),"\n",(0,n.jsxs)(t.blockquote,{children:["\n",(0,n.jsxs)(t.p,{children:[(0,n.jsx)(t.code,{children:"readonly"})," ",(0,n.jsx)(t.strong,{children:"label"}),": ",(0,n.jsx)(t.code,{children:"string"})]}),"\n"]}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L4399",children:"packages/extension-api/src/extension-api.d.ts:4399"})})]})}function h(e={}){const{wrapper:t}={...(0,a.a)(),...e.components};return t?(0,n.jsx)(t,{...e,children:(0,n.jsx)(l,{...e})}):l(e)}},71670:(e,t,r)=>{r.d(t,{Z:()=>s,a:()=>c});var n=r(27378);const a={},i=n.createContext(a);function c(e){const t=n.useContext(i);return n.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function s(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(a):e.components||a:c(e.components),n.createElement(i.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/d46ef83d.d994ec2a.js b/assets/js/d46ef83d.d94e146a.js similarity index 97% rename from assets/js/d46ef83d.d994ec2a.js rename to assets/js/d46ef83d.d94e146a.js index 3766bce93ef..b076b8ae97b 100644 --- a/assets/js/d46ef83d.d994ec2a.js +++ b/assets/js/d46ef83d.d94e146a.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[10579],{19909:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>c,contentTitle:()=>i,default:()=>l,frontMatter:()=>s,metadata:()=>r,toc:()=>p});var o=t(24246),a=t(71670);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",p:"p",strong:"strong",...(0,a.a)(),...e.components};return(0,o.jsxs)(o.Fragment,{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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L2373",children:"packages/extension-api/src/extension-api.d.ts:2373"})})]})}function l(e={}){const{wrapper:n}={...(0,a.a)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(d,{...e})}):d(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>r,a:()=>i});var o=t(27378);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([[10579],{19909:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>c,contentTitle:()=>i,default:()=>l,frontMatter:()=>s,metadata:()=>r,toc:()=>p});var o=t(24246),a=t(71670);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",p:"p",strong:"strong",...(0,a.a)(),...e.components};return(0,o.jsxs)(o.Fragment,{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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2373",children:"packages/extension-api/src/extension-api.d.ts:2373"})})]})}function l(e={}){const{wrapper:n}={...(0,a.a)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(d,{...e})}):d(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>r,a:()=>i});var o=t(27378);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.12a57378.js b/assets/js/d496897e.a56eb425.js similarity index 96% rename from assets/js/d496897e.12a57378.js rename to assets/js/d496897e.a56eb425.js index 40acf89b3ab..608a39074a4 100644 --- a/assets/js/d496897e.12a57378.js +++ b/assets/js/d496897e.a56eb425.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[25211],{87394:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>d,contentTitle:()=>r,default:()=>p,frontMatter:()=>c,metadata:()=>o,toc:()=>a});var i=t(24246),s=t(71670);const c={},r="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",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L3659",children:"packages/extension-api/src/extension-api.d.ts:3659"})})]})}function p(e={}){const{wrapper:n}={...(0,s.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>o,a:()=>r});var i=t(27378);const s={},c=i.createContext(s);function r(e){const n=i.useContext(c);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:r(e.components),i.createElement(c.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[25211],{87394:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>d,contentTitle:()=>r,default:()=>p,frontMatter:()=>c,metadata:()=>o,toc:()=>a});var i=t(24246),s=t(71670);const c={},r="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",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L3659",children:"packages/extension-api/src/extension-api.d.ts:3659"})})]})}function p(e={}){const{wrapper:n}={...(0,s.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>o,a:()=>r});var i=t(27378);const s={},c=i.createContext(s);function r(e){const n=i.useContext(c);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:r(e.components),i.createElement(c.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/d5f6644b.2c5d79a4.js b/assets/js/d5f6644b.49a947da.js similarity index 87% rename from assets/js/d5f6644b.2c5d79a4.js rename to assets/js/d5f6644b.49a947da.js index b1668ebcff0..fe607e3334d 100644 --- a/assets/js/d5f6644b.2c5d79a4.js +++ b/assets/js/d5f6644b.49a947da.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[84006],{37185:(e,s,n)=>{n.r(s),n.d(s,{assets:()=>c,contentTitle:()=>a,default:()=>h,frontMatter:()=>r,metadata:()=>l,toc:()=>o});var i=n(24246),t=n(71670);const r={},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",p:"p",strong:"strong",...(0,t.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L773",children:"packages/extension-api/src/extension-api.d.ts:773"})})]})}function h(e={}){const{wrapper:s}={...(0,t.a)(),...e.components};return s?(0,i.jsx)(s,{...e,children:(0,i.jsx)(d,{...e})}):d(e)}},71670:(e,s,n)=>{n.d(s,{Z:()=>l,a:()=>a});var i=n(27378);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 l(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([[84006],{37185:(e,s,n)=>{n.r(s),n.d(s,{assets:()=>c,contentTitle:()=>r,default:()=>h,frontMatter:()=>a,metadata:()=>l,toc:()=>o});var i=n(24246),t=n(71670);const a={},r="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",p:"p",strong:"strong",...(0,t.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L773",children:"packages/extension-api/src/extension-api.d.ts:773"})})]})}function h(e={}){const{wrapper:s}={...(0,t.a)(),...e.components};return s?(0,i.jsx)(s,{...e,children:(0,i.jsx)(d,{...e})}):d(e)}},71670:(e,s,n)=>{n.d(s,{Z:()=>l,a:()=>r});var i=n(27378);const t={},a=i.createContext(t);function r(e){const s=i.useContext(a);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(t):e.components||t:r(e.components),i.createElement(a.Provider,{value:s},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/d66cbd9e.85a0e32b.js b/assets/js/d66cbd9e.409d8b5a.js similarity index 83% rename from assets/js/d66cbd9e.85a0e32b.js rename to assets/js/d66cbd9e.409d8b5a.js index c6a98d598e7..e1447fa48af 100644 --- a/assets/js/d66cbd9e.85a0e32b.js +++ b/assets/js/d66cbd9e.409d8b5a.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[20044],{37558:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>c,contentTitle:()=>o,default:()=>p,frontMatter:()=>s,metadata:()=>d,toc:()=>a});var t=i(24246),r=i(71670);const s={},o="Interface: Port",d={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"}},c={},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",hr:"hr",p:"p",strong:"strong",...(0,r.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"interface-port",children:"Interface: Port"}),"\n",(0,t.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,t.jsx)(n.h3,{id:"ip",children:"IP"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"IP"}),": ",(0,t.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L2298",children:"packages/extension-api/src/extension-api.d.ts:2298"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L2299",children:"packages/extension-api/src/extension-api.d.ts:2299"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L2300",children:"packages/extension-api/src/extension-api.d.ts:2300"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L2301",children:"packages/extension-api/src/extension-api.d.ts:2301"})})]})}function p(e={}){const{wrapper:n}={...(0,r.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>d,a:()=>o});var t=i(27378);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([[20044],{37558:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>c,contentTitle:()=>d,default:()=>p,frontMatter:()=>s,metadata:()=>o,toc:()=>a});var t=i(24246),r=i(71670);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"}},c={},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",hr:"hr",p:"p",strong:"strong",...(0,r.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"interface-port",children:"Interface: Port"}),"\n",(0,t.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,t.jsx)(n.h3,{id:"ip",children:"IP"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"IP"}),": ",(0,t.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2298",children:"packages/extension-api/src/extension-api.d.ts:2298"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2299",children:"packages/extension-api/src/extension-api.d.ts:2299"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2300",children:"packages/extension-api/src/extension-api.d.ts:2300"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2301",children:"packages/extension-api/src/extension-api.d.ts:2301"})})]})}function p(e={}){const{wrapper:n}={...(0,r.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>o,a:()=>d});var t=i(27378);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 diff --git a/assets/js/d739767a.580d5aca.js b/assets/js/d739767a.bb34b251.js similarity index 98% rename from assets/js/d739767a.580d5aca.js rename to assets/js/d739767a.bb34b251.js index 3364a1cc7db..bb38dedfdfa 100644 --- a/assets/js/d739767a.580d5aca.js +++ b/assets/js/d739767a.bb34b251.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[64389],{12904:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>c,contentTitle:()=>a,default:()=>h,frontMatter:()=>r,metadata:()=>l,toc:()=>o});var i=s(24246),t=s(71670);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={},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",p:"p",strong:"strong",...(0,t.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{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.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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L3981",children:"packages/extension-api/src/extension-api.d.ts:3981"})})]})}function h(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(d,{...e})}):d(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>l,a:()=>a});var i=s(27378);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([[64389],{12904:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>c,contentTitle:()=>a,default:()=>h,frontMatter:()=>r,metadata:()=>l,toc:()=>o});var i=s(24246),t=s(71670);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={},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",p:"p",strong:"strong",...(0,t.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{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.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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L3981",children:"packages/extension-api/src/extension-api.d.ts:3981"})})]})}function h(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(d,{...e})}):d(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>l,a:()=>a});var i=s(27378);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.9105fe5a.js b/assets/js/d83404a8.9105fe5a.js new file mode 100644 index 00000000000..c43d2d6296e --- /dev/null +++ b/assets/js/d83404a8.9105fe5a.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[74996],{99411:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>r,contentTitle:()=>c,default:()=>h,frontMatter:()=>t,metadata:()=>a,toc:()=>l});var d=i(24246),s=i(71670);const t={},c="Interface: ImageFile",a={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",hr:"hr",li:"li",p:"p",strong:"strong",ul:"ul",...(0,s.a)(),...e.components};return(0,d.jsxs)(d.Fragment,{children:[(0,d.jsx)(n.h1,{id:"interface-imagefile",children:"Interface: ImageFile"}),"\n",(0,d.jsx)(n.p,{children:"the description of a file in an image filesystem layer"}),"\n",(0,d.jsx)(n.h2,{id:"extended-by",children:"Extended by"}),"\n",(0,d.jsxs)(n.ul,{children:["\n",(0,d.jsx)(n.li,{children:(0,d.jsx)(n.a,{href:"/api/interfaces/ImageFileSymlink",children:(0,d.jsx)(n.code,{children:"ImageFileSymlink"})})}),"\n"]}),"\n",(0,d.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,d.jsx)(n.h3,{id:"atime",children:"atime"}),"\n",(0,d.jsxs)(n.blockquote,{children:["\n",(0,d.jsxs)(n.p,{children:[(0,d.jsx)(n.strong,{children:"atime"}),": ",(0,d.jsx)(n.code,{children:"Date"})]}),"\n"]}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L717",children:"packages/extension-api/src/extension-api.d.ts:717"})}),"\n",(0,d.jsx)(n.hr,{}),"\n",(0,d.jsx)(n.h3,{id:"ctime",children:"ctime"}),"\n",(0,d.jsxs)(n.blockquote,{children:["\n",(0,d.jsxs)(n.p,{children:[(0,d.jsx)(n.strong,{children:"ctime"}),": ",(0,d.jsx)(n.code,{children:"Date"})]}),"\n"]}),"\n",(0,d.jsx)(n.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,d.jsx)(n.p,{children:(0,d.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L716",children:"packages/extension-api/src/extension-api.d.ts:716"})}),"\n",(0,d.jsx)(n.hr,{}),"\n",(0,d.jsx)(n.h3,{id:"gid",children:"gid"}),"\n",(0,d.jsxs)(n.blockquote,{children:["\n",(0,d.jsxs)(n.p,{children:[(0,d.jsx)(n.strong,{children:"gid"}),": ",(0,d.jsx)(n.code,{children:"number"})]}),"\n"]}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L714",children:"packages/extension-api/src/extension-api.d.ts:714"})}),"\n",(0,d.jsx)(n.hr,{}),"\n",(0,d.jsx)(n.h3,{id:"mode",children:"mode"}),"\n",(0,d.jsxs)(n.blockquote,{children:["\n",(0,d.jsxs)(n.p,{children:[(0,d.jsx)(n.strong,{children:"mode"}),": ",(0,d.jsx)(n.code,{children:"number"})]}),"\n"]}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L712",children:"packages/extension-api/src/extension-api.d.ts:712"})}),"\n",(0,d.jsx)(n.hr,{}),"\n",(0,d.jsx)(n.h3,{id:"mtime",children:"mtime"}),"\n",(0,d.jsxs)(n.blockquote,{children:["\n",(0,d.jsxs)(n.p,{children:[(0,d.jsx)(n.strong,{children:"mtime"}),": ",(0,d.jsx)(n.code,{children:"Date"})]}),"\n"]}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L718",children:"packages/extension-api/src/extension-api.d.ts:718"})}),"\n",(0,d.jsx)(n.hr,{}),"\n",(0,d.jsx)(n.h3,{id:"path",children:"path"}),"\n",(0,d.jsxs)(n.blockquote,{children:["\n",(0,d.jsxs)(n.p,{children:[(0,d.jsx)(n.strong,{children:"path"}),": ",(0,d.jsx)(n.code,{children:"string"})]}),"\n"]}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L709",children:"packages/extension-api/src/extension-api.d.ts:709"})}),"\n",(0,d.jsx)(n.hr,{}),"\n",(0,d.jsx)(n.h3,{id:"size",children:"size"}),"\n",(0,d.jsxs)(n.blockquote,{children:["\n",(0,d.jsxs)(n.p,{children:[(0,d.jsx)(n.strong,{children:"size"}),": ",(0,d.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,d.jsx)(n.h4,{id:"defined-in-6",children:"Defined in"}),"\n",(0,d.jsx)(n.p,{children:(0,d.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L715",children:"packages/extension-api/src/extension-api.d.ts:715"})}),"\n",(0,d.jsx)(n.hr,{}),"\n",(0,d.jsx)(n.h3,{id:"type",children:"type"}),"\n",(0,d.jsxs)(n.blockquote,{children:["\n",(0,d.jsxs)(n.p,{children:[(0,d.jsx)(n.strong,{children:"type"}),": ",(0,d.jsx)(n.code,{children:'"file"'})," | ",(0,d.jsx)(n.code,{children:'"directory"'})," | ",(0,d.jsx)(n.code,{children:'"symlink"'})]}),"\n"]}),"\n",(0,d.jsx)(n.h4,{id:"defined-in-7",children:"Defined in"}),"\n",(0,d.jsx)(n.p,{children:(0,d.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L710",children:"packages/extension-api/src/extension-api.d.ts:710"})}),"\n",(0,d.jsx)(n.hr,{}),"\n",(0,d.jsx)(n.h3,{id:"uid",children:"uid"}),"\n",(0,d.jsxs)(n.blockquote,{children:["\n",(0,d.jsxs)(n.p,{children:[(0,d.jsx)(n.strong,{children:"uid"}),": ",(0,d.jsx)(n.code,{children:"number"})]}),"\n"]}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L713",children:"packages/extension-api/src/extension-api.d.ts:713"})})]})}function h(e={}){const{wrapper:n}={...(0,s.a)(),...e.components};return n?(0,d.jsx)(n,{...e,children:(0,d.jsx)(o,{...e})}):o(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>a,a:()=>c});var d=i(27378);const s={},t=d.createContext(s);function c(e){const n=d.useContext(t);return d.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),d.createElement(t.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/d83404a8.a1e43ed3.js b/assets/js/d83404a8.a1e43ed3.js deleted file mode 100644 index acd956ffcdb..00000000000 --- a/assets/js/d83404a8.a1e43ed3.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[74996],{99411:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>r,contentTitle:()=>c,default:()=>h,frontMatter:()=>t,metadata:()=>a,toc:()=>l});var s=i(24246),d=i(71670);const t={},c="Interface: ImageFile",a={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",hr:"hr",li:"li",p:"p",strong:"strong",ul:"ul",...(0,d.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L717",children:"packages/extension-api/src/extension-api.d.ts:717"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L716",children:"packages/extension-api/src/extension-api.d.ts:716"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L714",children:"packages/extension-api/src/extension-api.d.ts:714"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L712",children:"packages/extension-api/src/extension-api.d.ts:712"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L718",children:"packages/extension-api/src/extension-api.d.ts:718"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L709",children:"packages/extension-api/src/extension-api.d.ts:709"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L715",children:"packages/extension-api/src/extension-api.d.ts:715"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L710",children:"packages/extension-api/src/extension-api.d.ts:710"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L713",children:"packages/extension-api/src/extension-api.d.ts:713"})})]})}function h(e={}){const{wrapper:n}={...(0,d.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(o,{...e})}):o(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>a,a:()=>c});var s=i(27378);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 a(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/d83f208d.e10c9428.js b/assets/js/d83f208d.d39af8c5.js similarity index 84% rename from assets/js/d83f208d.e10c9428.js rename to assets/js/d83f208d.d39af8c5.js index 7cb2edfdbb3..ad700eebbc2 100644 --- a/assets/js/d83f208d.e10c9428.js +++ b/assets/js/d83f208d.d39af8c5.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[13317],{56993:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>o,contentTitle:()=>r,default:()=>h,frontMatter:()=>t,metadata:()=>c,toc:()=>a});var s=i(24246),d=i(71670);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",hr:"hr",p:"p",strong:"strong",...(0,d.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L4028",children:"packages/extension-api/src/extension-api.d.ts:4028"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L4038",children:"packages/extension-api/src/extension-api.d.ts:4038"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L4013",children:"packages/extension-api/src/extension-api.d.ts:4013"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L4033",children:"packages/extension-api/src/extension-api.d.ts:4033"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L4023",children:"packages/extension-api/src/extension-api.d.ts:4023"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L4018",children:"packages/extension-api/src/extension-api.d.ts:4018"})})]})}function h(e={}){const{wrapper:n}={...(0,d.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>c,a:()=>r});var s=i(27378);const 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([[13317],{56993:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>o,contentTitle:()=>t,default:()=>h,frontMatter:()=>c,metadata:()=>r,toc:()=>a});var s=i(24246),d=i(71670);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",hr:"hr",p:"p",strong:"strong",...(0,d.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L4028",children:"packages/extension-api/src/extension-api.d.ts:4028"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L4038",children:"packages/extension-api/src/extension-api.d.ts:4038"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L4013",children:"packages/extension-api/src/extension-api.d.ts:4013"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L4033",children:"packages/extension-api/src/extension-api.d.ts:4033"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L4023",children:"packages/extension-api/src/extension-api.d.ts:4023"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L4018",children:"packages/extension-api/src/extension-api.d.ts:4018"})})]})}function h(e={}){const{wrapper:n}={...(0,d.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>r,a:()=>t});var s=i(27378);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.d16ac932.js b/assets/js/d9407a00.da8ad66b.js similarity index 97% rename from assets/js/d9407a00.d16ac932.js rename to assets/js/d9407a00.da8ad66b.js index 17922e7f247..c9e97d0c263 100644 --- a/assets/js/d9407a00.d16ac932.js +++ b/assets/js/d9407a00.da8ad66b.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[16728],{58836:(n,e,i)=>{i.r(e),i.d(e,{assets:()=>r,contentTitle:()=>a,default:()=>l,frontMatter:()=>t,metadata:()=>c,toc:()=>d});var o=i(24246),s=i(71670);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",p:"p",strong:"strong",...(0,s.a)(),...n.components};return(0,o.jsxs)(o.Fragment,{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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L1962",children:"packages/extension-api/src/extension-api.d.ts:1962"})})]})}function l(n={}){const{wrapper:e}={...(0,s.a)(),...n.components};return e?(0,o.jsx)(e,{...n,children:(0,o.jsx)(p,{...n})}):p(n)}},71670:(n,e,i)=>{i.d(e,{Z:()=>c,a:()=>a});var o=i(27378);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 +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[16728],{58836:(n,e,i)=>{i.r(e),i.d(e,{assets:()=>r,contentTitle:()=>a,default:()=>l,frontMatter:()=>t,metadata:()=>c,toc:()=>d});var o=i(24246),s=i(71670);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",p:"p",strong:"strong",...(0,s.a)(),...n.components};return(0,o.jsxs)(o.Fragment,{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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L1962",children:"packages/extension-api/src/extension-api.d.ts:1962"})})]})}function l(n={}){const{wrapper:e}={...(0,s.a)(),...n.components};return e?(0,o.jsx)(e,{...n,children:(0,o.jsx)(p,{...n})}):p(n)}},71670:(n,e,i)=>{i.d(e,{Z:()=>c,a:()=>a});var o=i(27378);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/d9673b17.b8118592.js b/assets/js/d9673b17.40e93ab7.js similarity index 92% rename from assets/js/d9673b17.b8118592.js rename to assets/js/d9673b17.40e93ab7.js index e0d489c8ad4..acc53aeedca 100644 --- a/assets/js/d9673b17.b8118592.js +++ b/assets/js/d9673b17.40e93ab7.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[58673],{47262:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>a,contentTitle:()=>d,default:()=>h,frontMatter:()=>o,metadata:()=>c,toc:()=>r});var t=i(24246),s=i(71670);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",hr:"hr",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"interface-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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L1440",children:"packages/extension-api/src/extension-api.d.ts:1440"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L1456",children:"packages/extension-api/src/extension-api.d.ts:1456"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L1452",children:"packages/extension-api/src/extension-api.d.ts:1452"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L1444",children:"packages/extension-api/src/extension-api.d.ts:1444"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L1436",children:"packages/extension-api/src/extension-api.d.ts:1436"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L1448",children:"packages/extension-api/src/extension-api.d.ts:1448"})})]})}function h(e={}){const{wrapper:n}={...(0,s.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>c,a:()=>d});var t=i(27378);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([[58673],{47262:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>a,contentTitle:()=>d,default:()=>h,frontMatter:()=>o,metadata:()=>c,toc:()=>r});var t=i(24246),s=i(71670);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",hr:"hr",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"interface-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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L1440",children:"packages/extension-api/src/extension-api.d.ts:1440"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L1456",children:"packages/extension-api/src/extension-api.d.ts:1456"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L1452",children:"packages/extension-api/src/extension-api.d.ts:1452"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L1444",children:"packages/extension-api/src/extension-api.d.ts:1444"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L1436",children:"packages/extension-api/src/extension-api.d.ts:1436"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L1448",children:"packages/extension-api/src/extension-api.d.ts:1448"})})]})}function h(e={}){const{wrapper:n}={...(0,s.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>c,a:()=>d});var t=i(27378);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.711cc826.js b/assets/js/d9b4ee1e.5a087dca.js similarity index 95% rename from assets/js/d9b4ee1e.711cc826.js rename to assets/js/d9b4ee1e.5a087dca.js index d73373b43e0..867914b5885 100644 --- a/assets/js/d9b4ee1e.711cc826.js +++ b/assets/js/d9b4ee1e.5a087dca.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[19841],{46693:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>c,contentTitle:()=>o,default:()=>d,frontMatter:()=>a,metadata:()=>i,toc:()=>l});var r=n(24246),s=n(71670);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",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,r.jsxs)(r.Fragment,{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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L2109",children:"packages/extension-api/src/extension-api.d.ts:2109"})})]})}function d(e={}){const{wrapper:t}={...(0,s.a)(),...e.components};return t?(0,r.jsx)(t,{...e,children:(0,r.jsx)(p,{...e})}):p(e)}},71670:(e,t,n)=>{n.d(t,{Z:()=>i,a:()=>o});var r=n(27378);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([[19841],{46693:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>c,contentTitle:()=>o,default:()=>d,frontMatter:()=>a,metadata:()=>i,toc:()=>l});var r=n(24246),s=n(71670);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",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,r.jsxs)(r.Fragment,{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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2109",children:"packages/extension-api/src/extension-api.d.ts:2109"})})]})}function d(e={}){const{wrapper:t}={...(0,s.a)(),...e.components};return t?(0,r.jsx)(t,{...e,children:(0,r.jsx)(p,{...e})}):p(e)}},71670:(e,t,n)=>{n.d(t,{Z:()=>i,a:()=>o});var r=n(27378);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.baead9f1.js b/assets/js/db22fd17.26543454.js similarity index 84% rename from assets/js/db22fd17.baead9f1.js rename to assets/js/db22fd17.26543454.js index 36322f585c2..d206db21450 100644 --- a/assets/js/db22fd17.baead9f1.js +++ b/assets/js/db22fd17.26543454.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[43474],{4088:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>r,contentTitle:()=>a,default:()=>d,frontMatter:()=>s,metadata:()=>l,toc:()=>c});var i=n(24246),o=n(71670);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:"CheckResultLink",permalink:"/api/type-aliases/CheckResultLink"},next:{title:"ConfigurationScope",permalink:"/api/type-aliases/ConfigurationScope"}},r={},c=[{value:"Defined in",id:"defined-in",level:2}];function p(e){const t={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,o.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(t.h1,{id:"type-alias-clitoolstate",children:"Type Alias: CliToolState"}),"\n",(0,i.jsxs)(t.blockquote,{children:["\n",(0,i.jsxs)(t.p,{children:[(0,i.jsx)(t.strong,{children:"CliToolState"}),": ",(0,i.jsx)(t.code,{children:'"registered"'})]}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L4317",children:"packages/extension-api/src/extension-api.d.ts:4317"})})]})}function d(e={}){const{wrapper:t}={...(0,o.a)(),...e.components};return t?(0,i.jsx)(t,{...e,children:(0,i.jsx)(p,{...e})}):p(e)}},71670:(e,t,n)=>{n.d(t,{Z:()=>l,a:()=>a});var i=n(27378);const o={},s=i.createContext(o);function a(e){const t=i.useContext(s);return i.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function l(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([[43474],{4088:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>r,contentTitle:()=>a,default:()=>p,frontMatter:()=>s,metadata:()=>l,toc:()=>c});var i=n(24246),o=n(71670);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:"CheckResultLink",permalink:"/api/type-aliases/CheckResultLink"},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",p:"p",strong:"strong",...(0,o.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(t.h1,{id:"type-alias-clitoolstate",children:"Type Alias: CliToolState"}),"\n",(0,i.jsxs)(t.blockquote,{children:["\n",(0,i.jsxs)(t.p,{children:[(0,i.jsx)(t.strong,{children:"CliToolState"}),": ",(0,i.jsx)(t.code,{children:'"registered"'})]}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L4317",children:"packages/extension-api/src/extension-api.d.ts:4317"})})]})}function p(e={}){const{wrapper:t}={...(0,o.a)(),...e.components};return t?(0,i.jsx)(t,{...e,children:(0,i.jsx)(d,{...e})}):d(e)}},71670:(e,t,n)=>{n.d(t,{Z:()=>l,a:()=>a});var i=n(27378);const o={},s=i.createContext(o);function a(e){const t=i.useContext(s);return i.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function l(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/dc23cd40.f661ba0c.js b/assets/js/dc23cd40.5cca45cb.js similarity index 87% rename from assets/js/dc23cd40.f661ba0c.js rename to assets/js/dc23cd40.5cca45cb.js index a72ce029761..34bbe7c27e6 100644 --- a/assets/js/dc23cd40.f661ba0c.js +++ b/assets/js/dc23cd40.5cca45cb.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[99124],{8051:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>a,contentTitle:()=>r,default:()=>p,frontMatter:()=>d,metadata:()=>o,toc:()=>c});var s=i(24246),t=i(71670);const d={},r="Interface: PodCreateOptions",o={id:"interfaces/PodCreateOptions",title:"Interface: PodCreateOptions",description:"Properties",source:"@site/api/interfaces/PodCreateOptions.md",sourceDirName:"interfaces",slug:"/interfaces/PodCreateOptions",permalink:"/api/interfaces/PodCreateOptions",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"PodContainerInfo",permalink:"/api/interfaces/PodContainerInfo"},next:{title:"PodCreatePortOptions",permalink:"/api/interfaces/PodCreatePortOptions"}},a={},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",hr:"hr",p:"p",pre:"pre",strong:"strong",...(0,t.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L399",children:"packages/extension-api/src/extension-api.d.ts:399"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L428",children:"packages/extension-api/src/extension-api.d.ts:428"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L389",children:"packages/extension-api/src/extension-api.d.ts:389"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L379",children:"packages/extension-api/src/extension-api.d.ts:379"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L408",children:"packages/extension-api/src/extension-api.d.ts:408"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L385",children:"packages/extension-api/src/extension-api.d.ts:385"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L391",children:"packages/extension-api/src/extension-api.d.ts:391"})})]})}function p(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>o,a:()=>r});var s=i(27378);const t={},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([[99124],{8051:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>a,contentTitle:()=>r,default:()=>p,frontMatter:()=>t,metadata:()=>o,toc:()=>c});var s=i(24246),d=i(71670);const t={},r="Interface: PodCreateOptions",o={id:"interfaces/PodCreateOptions",title:"Interface: PodCreateOptions",description:"Properties",source:"@site/api/interfaces/PodCreateOptions.md",sourceDirName:"interfaces",slug:"/interfaces/PodCreateOptions",permalink:"/api/interfaces/PodCreateOptions",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"PodContainerInfo",permalink:"/api/interfaces/PodContainerInfo"},next:{title:"PodCreatePortOptions",permalink:"/api/interfaces/PodCreatePortOptions"}},a={},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",hr:"hr",p:"p",pre:"pre",strong:"strong",...(0,d.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L399",children:"packages/extension-api/src/extension-api.d.ts:399"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L428",children:"packages/extension-api/src/extension-api.d.ts:428"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L389",children:"packages/extension-api/src/extension-api.d.ts:389"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L379",children:"packages/extension-api/src/extension-api.d.ts:379"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L408",children:"packages/extension-api/src/extension-api.d.ts:408"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L385",children:"packages/extension-api/src/extension-api.d.ts:385"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L391",children:"packages/extension-api/src/extension-api.d.ts:391"})})]})}function p(e={}){const{wrapper:n}={...(0,d.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>o,a:()=>r});var s=i(27378);const 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 o(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 diff --git a/assets/js/dec87402.69e53b17.js b/assets/js/dec87402.b22a46a1.js similarity index 87% rename from assets/js/dec87402.69e53b17.js rename to assets/js/dec87402.b22a46a1.js index 28f65b1a422..66f393982e5 100644 --- a/assets/js/dec87402.69e53b17.js +++ b/assets/js/dec87402.b22a46a1.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[1837],{70887:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>c,contentTitle:()=>a,default:()=>g,frontMatter:()=>r,metadata:()=>o,toc:()=>d});var s=i(24246),t=i(71670);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",p:"p",strong:"strong",...(0,t.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L3578",children:"packages/extension-api/src/extension-api.d.ts:3578"})})]})}function g(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>o,a:()=>a});var s=i(27378);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([[1837],{70887:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>c,contentTitle:()=>r,default:()=>g,frontMatter:()=>a,metadata:()=>o,toc:()=>d});var s=i(24246),t=i(71670);const a={},r="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",p:"p",strong:"strong",...(0,t.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L3578",children:"packages/extension-api/src/extension-api.d.ts:3578"})})]})}function g(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>o,a:()=>r});var s=i(27378);const t={},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/deccabf3.80bb8a1b.js b/assets/js/deccabf3.984c74d6.js similarity index 91% rename from assets/js/deccabf3.80bb8a1b.js rename to assets/js/deccabf3.984c74d6.js index 0b5c343e1ea..1249935ecca 100644 --- a/assets/js/deccabf3.80bb8a1b.js +++ b/assets/js/deccabf3.984c74d6.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[18880],{18654:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>d,contentTitle:()=>s,default:()=>p,frontMatter:()=>o,metadata:()=>a,toc:()=>c});var t=i(24246),r=i(71670);const o={},s="Enumeration: InputBoxValidationSeverity",a={id:"enumerations/InputBoxValidationSeverity",title:"Enumeration: InputBoxValidationSeverity",description:"Impacts the behavior and appearance of the validation message.",source:"@site/api/enumerations/InputBoxValidationSeverity.md",sourceDirName:"enumerations",slug:"/enumerations/InputBoxValidationSeverity",permalink:"/api/enumerations/InputBoxValidationSeverity",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"withProgress",permalink:"/api/namespaces/window/functions/withProgress"},next:{title:"ProgressLocation",permalink:"/api/enumerations/ProgressLocation"}},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",hr:"hr",p:"p",strong:"strong",...(0,r.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"enumeration-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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L1094",children:"packages/extension-api/src/extension-api.d.ts:1094"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L1092",children:"packages/extension-api/src/extension-api.d.ts:1092"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L1093",children:"packages/extension-api/src/extension-api.d.ts:1093"})})]})}function p(e={}){const{wrapper:n}={...(0,r.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>a,a:()=>s});var t=i(27378);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([[18880],{18654:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>d,contentTitle:()=>s,default:()=>p,frontMatter:()=>o,metadata:()=>a,toc:()=>c});var t=i(24246),r=i(71670);const o={},s="Enumeration: InputBoxValidationSeverity",a={id:"enumerations/InputBoxValidationSeverity",title:"Enumeration: InputBoxValidationSeverity",description:"Impacts the behavior and appearance of the validation message.",source:"@site/api/enumerations/InputBoxValidationSeverity.md",sourceDirName:"enumerations",slug:"/enumerations/InputBoxValidationSeverity",permalink:"/api/enumerations/InputBoxValidationSeverity",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"withProgress",permalink:"/api/namespaces/window/functions/withProgress"},next:{title:"ProgressLocation",permalink:"/api/enumerations/ProgressLocation"}},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",hr:"hr",p:"p",strong:"strong",...(0,r.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"enumeration-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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L1094",children:"packages/extension-api/src/extension-api.d.ts:1094"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L1092",children:"packages/extension-api/src/extension-api.d.ts:1092"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L1093",children:"packages/extension-api/src/extension-api.d.ts:1093"})})]})}function p(e={}){const{wrapper:n}={...(0,r.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>a,a:()=>s});var t=i(27378);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.7b26e0c9.js b/assets/js/df2a6e58.a03500d4.js similarity index 96% rename from assets/js/df2a6e58.7b26e0c9.js rename to assets/js/df2a6e58.a03500d4.js index 8f7524a2491..d4c053fd58e 100644 --- a/assets/js/df2a6e58.7b26e0c9.js +++ b/assets/js/df2a6e58.a03500d4.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[37683],{39406:(n,e,i)=>{i.r(e),i.d(e,{assets:()=>a,contentTitle:()=>r,default:()=>p,frontMatter:()=>t,metadata:()=>c,toc:()=>l});var s=i(24246),o=i(71670);const t={},r="Function: listInfos()",c={id:"namespaces/containerEngine/functions/listInfos",title:"Function: listInfos()",description:"listInfos(options?): Promise\\",source:"@site/api/namespaces/containerEngine/functions/listInfos.md",sourceDirName:"namespaces/containerEngine/functions",slug:"/namespaces/containerEngine/functions/listInfos",permalink:"/api/namespaces/containerEngine/functions/listInfos",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"listImages",permalink:"/api/namespaces/containerEngine/functions/listImages"},next:{title:"listNetworks",permalink:"/api/namespaces/containerEngine/functions/listNetworks"}},a={},l=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Examples",id:"examples",level:2},{value:"Defined in",id:"defined-in",level:2}];function d(n){const e={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",pre:"pre",strong:"strong",...(0,o.a)(),...n.components};return(0,s.jsxs)(s.Fragment,{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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L3646",children:"packages/extension-api/src/extension-api.d.ts:3646"})})]})}function p(n={}){const{wrapper:e}={...(0,o.a)(),...n.components};return e?(0,s.jsx)(e,{...n,children:(0,s.jsx)(d,{...n})}):d(n)}},71670:(n,e,i)=>{i.d(e,{Z:()=>c,a:()=>r});var s=i(27378);const o={},t=s.createContext(o);function r(n){const e=s.useContext(t);return s.useMemo((function(){return"function"==typeof n?n(e):{...e,...n}}),[e,n])}function 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([[37683],{39406:(n,e,i)=>{i.r(e),i.d(e,{assets:()=>a,contentTitle:()=>r,default:()=>p,frontMatter:()=>t,metadata:()=>c,toc:()=>l});var s=i(24246),o=i(71670);const t={},r="Function: listInfos()",c={id:"namespaces/containerEngine/functions/listInfos",title:"Function: listInfos()",description:"listInfos(options?): Promise\\",source:"@site/api/namespaces/containerEngine/functions/listInfos.md",sourceDirName:"namespaces/containerEngine/functions",slug:"/namespaces/containerEngine/functions/listInfos",permalink:"/api/namespaces/containerEngine/functions/listInfos",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"listImages",permalink:"/api/namespaces/containerEngine/functions/listImages"},next:{title:"listNetworks",permalink:"/api/namespaces/containerEngine/functions/listNetworks"}},a={},l=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Examples",id:"examples",level:2},{value:"Defined in",id:"defined-in",level:2}];function d(n){const e={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",pre:"pre",strong:"strong",...(0,o.a)(),...n.components};return(0,s.jsxs)(s.Fragment,{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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L3646",children:"packages/extension-api/src/extension-api.d.ts:3646"})})]})}function p(n={}){const{wrapper:e}={...(0,o.a)(),...n.components};return e?(0,s.jsx)(e,{...n,children:(0,s.jsx)(d,{...n})}):d(n)}},71670:(n,e,i)=>{i.d(e,{Z:()=>c,a:()=>r});var s=i(27378);const o={},t=s.createContext(o);function r(n){const e=s.useContext(t);return s.useMemo((function(){return"function"==typeof n?n(e):{...e,...n}}),[e,n])}function 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.be976545.js b/assets/js/df4d464e.40bfcf77.js similarity index 86% rename from assets/js/df4d464e.be976545.js rename to assets/js/df4d464e.40bfcf77.js index 0a157f156e3..bf509bea210 100644 --- a/assets/js/df4d464e.be976545.js +++ b/assets/js/df4d464e.40bfcf77.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[82409],{56227:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>a,contentTitle:()=>c,default:()=>l,frontMatter:()=>r,metadata:()=>o,toc:()=>u});var t=s(24246),i=s(71670);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={},u=[{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",p:"p",strong:"strong",...(0,i.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"function-setkubeconfig",children:"Function: setKubeconfig()"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"setKubeconfig"}),"(",(0,t.jsx)(n.code,{children:"kubeconfig"}),"): ",(0,t.jsx)(n.code,{children:"Promise"}),"<",(0,t.jsx)(n.code,{children:"void"}),">"]}),"\n"]}),"\n",(0,t.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"kubeconfig"}),": ",(0,t.jsx)(n.a,{href:"/api/classes/Uri",children:(0,t.jsx)(n.code,{children:"Uri"})})]}),"\n",(0,t.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"Promise"}),"<",(0,t.jsx)(n.code,{children:"void"}),">"]}),"\n",(0,t.jsx)(n.h2,{id:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L2084",children:"packages/extension-api/src/extension-api.d.ts:2084"})})]})}function l(e={}){const{wrapper:n}={...(0,i.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(d,{...e})}):d(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>o,a:()=>c});var t=s(27378);const i={},r=t.createContext(i);function c(e){const n=t.useContext(r);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:c(e.components),t.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[82409],{56227:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>a,contentTitle:()=>c,default:()=>l,frontMatter:()=>r,metadata:()=>o,toc:()=>d});var t=s(24246),i=s(71670);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",p:"p",strong:"strong",...(0,i.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"function-setkubeconfig",children:"Function: setKubeconfig()"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"setKubeconfig"}),"(",(0,t.jsx)(n.code,{children:"kubeconfig"}),"): ",(0,t.jsx)(n.code,{children:"Promise"}),"<",(0,t.jsx)(n.code,{children:"void"}),">"]}),"\n"]}),"\n",(0,t.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"kubeconfig"}),": ",(0,t.jsx)(n.a,{href:"/api/classes/Uri",children:(0,t.jsx)(n.code,{children:"Uri"})})]}),"\n",(0,t.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"Promise"}),"<",(0,t.jsx)(n.code,{children:"void"}),">"]}),"\n",(0,t.jsx)(n.h2,{id:"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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2084",children:"packages/extension-api/src/extension-api.d.ts:2084"})})]})}function l(e={}){const{wrapper:n}={...(0,i.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(u,{...e})}):u(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>o,a:()=>c});var t=s(27378);const i={},r=t.createContext(i);function c(e){const n=t.useContext(r);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:c(e.components),t.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/e064f6d4.90336e23.js b/assets/js/e064f6d4.90336e23.js deleted file mode 100644 index 91f055b6f7f..00000000000 --- a/assets/js/e064f6d4.90336e23.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[2866],{52262:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>o,contentTitle:()=>r,default:()=>h,frontMatter:()=>l,metadata:()=>c,toc:()=>t});var s=i(24246),d=i(71670);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",hr:"hr",p:"p",strong:"strong",...(0,d.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L2554",children:"packages/extension-api/src/extension-api.d.ts:2554"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L2528",children:"packages/extension-api/src/extension-api.d.ts:2528"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/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:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L2526",children:"packages/extension-api/src/extension-api.d.ts:2526"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L2550",children:"packages/extension-api/src/extension-api.d.ts:2550"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L2555",children:"packages/extension-api/src/extension-api.d.ts:2555"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L2557",children:"packages/extension-api/src/extension-api.d.ts:2557"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L2556",children:"packages/extension-api/src/extension-api.d.ts:2556"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/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:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/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:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L2525",children:"packages/extension-api/src/extension-api.d.ts:2525"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/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:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/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:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L2552",children:"packages/extension-api/src/extension-api.d.ts:2552"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/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:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/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:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/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:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L2527",children:"packages/extension-api/src/extension-api.d.ts:2527"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L2551",children:"packages/extension-api/src/extension-api.d.ts:2551"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L2553",children:"packages/extension-api/src/extension-api.d.ts:2553"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L2544",children:"packages/extension-api/src/extension-api.d.ts:2544"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/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:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L2529",children:"packages/extension-api/src/extension-api.d.ts:2529"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L2523",children:"packages/extension-api/src/extension-api.d.ts:2523"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L2524",children:"packages/extension-api/src/extension-api.d.ts:2524"})})]})}function h(e={}){const{wrapper:n}={...(0,d.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(a,{...e})}):a(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>c,a:()=>r});var s=i(27378);const 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/e064f6d4.e5ecea9b.js b/assets/js/e064f6d4.e5ecea9b.js new file mode 100644 index 00000000000..72e88ebaf52 --- /dev/null +++ b/assets/js/e064f6d4.e5ecea9b.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[2866],{52262:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>o,contentTitle:()=>r,default:()=>h,frontMatter:()=>l,metadata:()=>c,toc:()=>t});var d=i(24246),s=i(71670);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",hr:"hr",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,d.jsxs)(d.Fragment,{children:[(0,d.jsx)(n.h1,{id:"interface-containerinspectinfo",children:"Interface: ContainerInspectInfo"}),"\n",(0,d.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,d.jsx)(n.h3,{id:"apparmorprofile",children:"AppArmorProfile"}),"\n",(0,d.jsxs)(n.blockquote,{children:["\n",(0,d.jsxs)(n.p,{children:[(0,d.jsx)(n.strong,{children:"AppArmorProfile"}),": ",(0,d.jsx)(n.code,{children:"string"})]}),"\n"]}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2554",children:"packages/extension-api/src/extension-api.d.ts:2554"})}),"\n",(0,d.jsx)(n.hr,{}),"\n",(0,d.jsx)(n.h3,{id:"args",children:"Args"}),"\n",(0,d.jsxs)(n.blockquote,{children:["\n",(0,d.jsxs)(n.p,{children:[(0,d.jsx)(n.strong,{children:"Args"}),": ",(0,d.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,d.jsx)(n.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,d.jsx)(n.p,{children:(0,d.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2528",children:"packages/extension-api/src/extension-api.d.ts:2528"})}),"\n",(0,d.jsx)(n.hr,{}),"\n",(0,d.jsx)(n.h3,{id:"config",children:"Config"}),"\n",(0,d.jsxs)(n.blockquote,{children:["\n",(0,d.jsxs)(n.p,{children:[(0,d.jsx)(n.strong,{children:"Config"}),": ",(0,d.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,d.jsx)(n.h4,{id:"attachstderr",children:"AttachStderr"}),"\n",(0,d.jsxs)(n.blockquote,{children:["\n",(0,d.jsxs)(n.p,{children:[(0,d.jsx)(n.strong,{children:"AttachStderr"}),": ",(0,d.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,d.jsx)(n.h4,{id:"attachstdin",children:"AttachStdin"}),"\n",(0,d.jsxs)(n.blockquote,{children:["\n",(0,d.jsxs)(n.p,{children:[(0,d.jsx)(n.strong,{children:"AttachStdin"}),": ",(0,d.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,d.jsx)(n.h4,{id:"attachstdout",children:"AttachStdout"}),"\n",(0,d.jsxs)(n.blockquote,{children:["\n",(0,d.jsxs)(n.p,{children:[(0,d.jsx)(n.strong,{children:"AttachStdout"}),": ",(0,d.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,d.jsx)(n.h4,{id:"cmd",children:"Cmd"}),"\n",(0,d.jsxs)(n.blockquote,{children:["\n",(0,d.jsxs)(n.p,{children:[(0,d.jsx)(n.strong,{children:"Cmd"}),": ",(0,d.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,d.jsx)(n.h4,{id:"domainname",children:"Domainname"}),"\n",(0,d.jsxs)(n.blockquote,{children:["\n",(0,d.jsxs)(n.p,{children:[(0,d.jsx)(n.strong,{children:"Domainname"}),": ",(0,d.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,d.jsx)(n.h4,{id:"entrypoint",children:"Entrypoint?"}),"\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:"Entrypoint"}),": ",(0,d.jsx)(n.code,{children:"string"})," | ",(0,d.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,d.jsx)(n.h4,{id:"env",children:"Env"}),"\n",(0,d.jsxs)(n.blockquote,{children:["\n",(0,d.jsxs)(n.p,{children:[(0,d.jsx)(n.strong,{children:"Env"}),": ",(0,d.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,d.jsx)(n.h4,{id:"exposedports",children:"ExposedPorts"}),"\n",(0,d.jsxs)(n.blockquote,{children:["\n",(0,d.jsxs)(n.p,{children:[(0,d.jsx)(n.strong,{children:"ExposedPorts"}),": ",(0,d.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,d.jsx)(n.h5,{id:"index-signature",children:"Index Signature"}),"\n",(0,d.jsxs)(n.p,{children:["[",(0,d.jsx)(n.code,{children:"portAndProtocol"}),": ",(0,d.jsx)(n.code,{children:"string"}),"]: ",(0,d.jsx)(n.code,{children:"unknown"})]}),"\n",(0,d.jsx)(n.h4,{id:"hostname",children:"Hostname"}),"\n",(0,d.jsxs)(n.blockquote,{children:["\n",(0,d.jsxs)(n.p,{children:[(0,d.jsx)(n.strong,{children:"Hostname"}),": ",(0,d.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,d.jsx)(n.h4,{id:"image",children:"Image"}),"\n",(0,d.jsxs)(n.blockquote,{children:["\n",(0,d.jsxs)(n.p,{children:[(0,d.jsx)(n.strong,{children:"Image"}),": ",(0,d.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,d.jsx)(n.h4,{id:"labels",children:"Labels"}),"\n",(0,d.jsxs)(n.blockquote,{children:["\n",(0,d.jsxs)(n.p,{children:[(0,d.jsx)(n.strong,{children:"Labels"}),": ",(0,d.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,d.jsx)(n.h5,{id:"index-signature-1",children:"Index Signature"}),"\n",(0,d.jsxs)(n.p,{children:["[",(0,d.jsx)(n.code,{children:"label"}),": ",(0,d.jsx)(n.code,{children:"string"}),"]: ",(0,d.jsx)(n.code,{children:"string"})]}),"\n",(0,d.jsx)(n.h4,{id:"onbuild",children:"OnBuild?"}),"\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:"OnBuild"}),": ",(0,d.jsx)(n.code,{children:"unknown"})]}),"\n"]}),"\n",(0,d.jsx)(n.h4,{id:"openstdin",children:"OpenStdin"}),"\n",(0,d.jsxs)(n.blockquote,{children:["\n",(0,d.jsxs)(n.p,{children:[(0,d.jsx)(n.strong,{children:"OpenStdin"}),": ",(0,d.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,d.jsx)(n.h4,{id:"stdinonce",children:"StdinOnce"}),"\n",(0,d.jsxs)(n.blockquote,{children:["\n",(0,d.jsxs)(n.p,{children:[(0,d.jsx)(n.strong,{children:"StdinOnce"}),": ",(0,d.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,d.jsx)(n.h4,{id:"tty",children:"Tty"}),"\n",(0,d.jsxs)(n.blockquote,{children:["\n",(0,d.jsxs)(n.p,{children:[(0,d.jsx)(n.strong,{children:"Tty"}),": ",(0,d.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,d.jsx)(n.h4,{id:"user",children:"User"}),"\n",(0,d.jsxs)(n.blockquote,{children:["\n",(0,d.jsxs)(n.p,{children:[(0,d.jsx)(n.strong,{children:"User"}),": ",(0,d.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,d.jsx)(n.h4,{id:"volumes",children:"Volumes"}),"\n",(0,d.jsxs)(n.blockquote,{children:["\n",(0,d.jsxs)(n.p,{children:[(0,d.jsx)(n.strong,{children:"Volumes"}),": ",(0,d.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,d.jsx)(n.h5,{id:"index-signature-2",children:"Index Signature"}),"\n",(0,d.jsxs)(n.p,{children:["[",(0,d.jsx)(n.code,{children:"volume"}),": ",(0,d.jsx)(n.code,{children:"string"}),"]: ",(0,d.jsx)(n.code,{children:"unknown"})]}),"\n",(0,d.jsx)(n.h4,{id:"workingdir",children:"WorkingDir"}),"\n",(0,d.jsxs)(n.blockquote,{children:["\n",(0,d.jsxs)(n.p,{children:[(0,d.jsx)(n.strong,{children:"WorkingDir"}),": ",(0,d.jsx)(n.code,{children:"string"})]}),"\n"]}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2573",children:"packages/extension-api/src/extension-api.d.ts:2573"})}),"\n",(0,d.jsx)(n.hr,{}),"\n",(0,d.jsx)(n.h3,{id:"created",children:"Created"}),"\n",(0,d.jsxs)(n.blockquote,{children:["\n",(0,d.jsxs)(n.p,{children:[(0,d.jsx)(n.strong,{children:"Created"}),": ",(0,d.jsx)(n.code,{children:"string"})]}),"\n"]}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2526",children:"packages/extension-api/src/extension-api.d.ts:2526"})}),"\n",(0,d.jsx)(n.hr,{}),"\n",(0,d.jsx)(n.h3,{id:"driver",children:"Driver"}),"\n",(0,d.jsxs)(n.blockquote,{children:["\n",(0,d.jsxs)(n.p,{children:[(0,d.jsx)(n.strong,{children:"Driver"}),": ",(0,d.jsx)(n.code,{children:"string"})]}),"\n"]}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2550",children:"packages/extension-api/src/extension-api.d.ts:2550"})}),"\n",(0,d.jsx)(n.hr,{}),"\n",(0,d.jsx)(n.h3,{id:"execids",children:"ExecIDs?"}),"\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:"ExecIDs"}),": ",(0,d.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2555",children:"packages/extension-api/src/extension-api.d.ts:2555"})}),"\n",(0,d.jsx)(n.hr,{}),"\n",(0,d.jsx)(n.h3,{id:"graphdriver",children:"GraphDriver"}),"\n",(0,d.jsxs)(n.blockquote,{children:["\n",(0,d.jsxs)(n.p,{children:[(0,d.jsx)(n.strong,{children:"GraphDriver"}),": ",(0,d.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,d.jsx)(n.h4,{id:"data",children:"Data"}),"\n",(0,d.jsxs)(n.blockquote,{children:["\n",(0,d.jsxs)(n.p,{children:[(0,d.jsx)(n.strong,{children:"Data"}),": ",(0,d.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,d.jsx)(n.h4,{id:"datadeviceid",children:"Data.DeviceId"}),"\n",(0,d.jsxs)(n.blockquote,{children:["\n",(0,d.jsxs)(n.p,{children:[(0,d.jsx)(n.strong,{children:"DeviceId"}),": ",(0,d.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,d.jsx)(n.h4,{id:"datadevicename",children:"Data.DeviceName"}),"\n",(0,d.jsxs)(n.blockquote,{children:["\n",(0,d.jsxs)(n.p,{children:[(0,d.jsx)(n.strong,{children:"DeviceName"}),": ",(0,d.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,d.jsx)(n.h4,{id:"datadevicesize",children:"Data.DeviceSize"}),"\n",(0,d.jsxs)(n.blockquote,{children:["\n",(0,d.jsxs)(n.p,{children:[(0,d.jsx)(n.strong,{children:"DeviceSize"}),": ",(0,d.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,d.jsx)(n.h4,{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:"defined-in-6",children:"Defined in"}),"\n",(0,d.jsx)(n.p,{children:(0,d.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2557",children:"packages/extension-api/src/extension-api.d.ts:2557"})}),"\n",(0,d.jsx)(n.hr,{}),"\n",(0,d.jsx)(n.h3,{id:"hostconfig",children:"HostConfig"}),"\n",(0,d.jsxs)(n.blockquote,{children:["\n",(0,d.jsxs)(n.p,{children:[(0,d.jsx)(n.strong,{children:"HostConfig"}),": ",(0,d.jsx)(n.a,{href:"/api/interfaces/HostConfig",children:(0,d.jsx)(n.code,{children:"HostConfig"})})]}),"\n"]}),"\n",(0,d.jsx)(n.h4,{id:"defined-in-7",children:"Defined in"}),"\n",(0,d.jsx)(n.p,{children:(0,d.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2556",children:"packages/extension-api/src/extension-api.d.ts:2556"})}),"\n",(0,d.jsx)(n.hr,{}),"\n",(0,d.jsx)(n.h3,{id:"hostnamepath",children:"HostnamePath"}),"\n",(0,d.jsxs)(n.blockquote,{children:["\n",(0,d.jsxs)(n.p,{children:[(0,d.jsx)(n.strong,{children:"HostnamePath"}),": ",(0,d.jsx)(n.code,{children:"string"})]}),"\n"]}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2545",children:"packages/extension-api/src/extension-api.d.ts:2545"})}),"\n",(0,d.jsx)(n.hr,{}),"\n",(0,d.jsx)(n.h3,{id:"hostspath",children:"HostsPath"}),"\n",(0,d.jsxs)(n.blockquote,{children:["\n",(0,d.jsxs)(n.p,{children:[(0,d.jsx)(n.strong,{children:"HostsPath"}),": ",(0,d.jsx)(n.code,{children:"string"})]}),"\n"]}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2546",children:"packages/extension-api/src/extension-api.d.ts:2546"})}),"\n",(0,d.jsx)(n.hr,{}),"\n",(0,d.jsx)(n.h3,{id:"id",children:"Id"}),"\n",(0,d.jsxs)(n.blockquote,{children:["\n",(0,d.jsxs)(n.p,{children:[(0,d.jsx)(n.strong,{children:"Id"}),": ",(0,d.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,d.jsx)(n.h4,{id:"defined-in-10",children:"Defined in"}),"\n",(0,d.jsx)(n.p,{children:(0,d.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2525",children:"packages/extension-api/src/extension-api.d.ts:2525"})}),"\n",(0,d.jsx)(n.hr,{}),"\n",(0,d.jsx)(n.h3,{id:"image-1",children:"Image"}),"\n",(0,d.jsxs)(n.blockquote,{children:["\n",(0,d.jsxs)(n.p,{children:[(0,d.jsx)(n.strong,{children:"Image"}),": ",(0,d.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,d.jsx)(n.h4,{id:"defined-in-11",children:"Defined in"}),"\n",(0,d.jsx)(n.p,{children:(0,d.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2543",children:"packages/extension-api/src/extension-api.d.ts:2543"})}),"\n",(0,d.jsx)(n.hr,{}),"\n",(0,d.jsx)(n.h3,{id:"logpath",children:"LogPath"}),"\n",(0,d.jsxs)(n.blockquote,{children:["\n",(0,d.jsxs)(n.p,{children:[(0,d.jsx)(n.strong,{children:"LogPath"}),": ",(0,d.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,d.jsx)(n.h4,{id:"defined-in-12",children:"Defined in"}),"\n",(0,d.jsx)(n.p,{children:(0,d.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2547",children:"packages/extension-api/src/extension-api.d.ts:2547"})}),"\n",(0,d.jsx)(n.hr,{}),"\n",(0,d.jsx)(n.h3,{id:"mountlabel",children:"MountLabel"}),"\n",(0,d.jsxs)(n.blockquote,{children:["\n",(0,d.jsxs)(n.p,{children:[(0,d.jsx)(n.strong,{children:"MountLabel"}),": ",(0,d.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,d.jsx)(n.h4,{id:"defined-in-13",children:"Defined in"}),"\n",(0,d.jsx)(n.p,{children:(0,d.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2552",children:"packages/extension-api/src/extension-api.d.ts:2552"})}),"\n",(0,d.jsx)(n.hr,{}),"\n",(0,d.jsx)(n.h3,{id:"mounts",children:"Mounts"}),"\n",(0,d.jsxs)(n.blockquote,{children:["\n",(0,d.jsxs)(n.p,{children:[(0,d.jsx)(n.strong,{children:"Mounts"}),": ",(0,d.jsx)(n.code,{children:"object"}),"[]"]}),"\n"]}),"\n",(0,d.jsx)(n.h4,{id:"defined-in-14",children:"Defined in"}),"\n",(0,d.jsx)(n.p,{children:(0,d.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2565",children:"packages/extension-api/src/extension-api.d.ts:2565"})}),"\n",(0,d.jsx)(n.hr,{}),"\n",(0,d.jsx)(n.h3,{id:"name-1",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:"defined-in-15",children:"Defined in"}),"\n",(0,d.jsx)(n.p,{children:(0,d.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2548",children:"packages/extension-api/src/extension-api.d.ts:2548"})}),"\n",(0,d.jsx)(n.hr,{}),"\n",(0,d.jsx)(n.h3,{id:"networksettings",children:"NetworkSettings"}),"\n",(0,d.jsxs)(n.blockquote,{children:["\n",(0,d.jsxs)(n.p,{children:[(0,d.jsx)(n.strong,{children:"NetworkSettings"}),": ",(0,d.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,d.jsx)(n.h4,{id:"bridge",children:"Bridge"}),"\n",(0,d.jsxs)(n.blockquote,{children:["\n",(0,d.jsxs)(n.p,{children:[(0,d.jsx)(n.strong,{children:"Bridge"}),": ",(0,d.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,d.jsx)(n.h4,{id:"endpointid",children:"EndpointID"}),"\n",(0,d.jsxs)(n.blockquote,{children:["\n",(0,d.jsxs)(n.p,{children:[(0,d.jsx)(n.strong,{children:"EndpointID"}),": ",(0,d.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,d.jsx)(n.h4,{id:"gateway",children:"Gateway"}),"\n",(0,d.jsxs)(n.blockquote,{children:["\n",(0,d.jsxs)(n.p,{children:[(0,d.jsx)(n.strong,{children:"Gateway"}),": ",(0,d.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,d.jsx)(n.h4,{id:"globalipv6address",children:"GlobalIPv6Address"}),"\n",(0,d.jsxs)(n.blockquote,{children:["\n",(0,d.jsxs)(n.p,{children:[(0,d.jsx)(n.strong,{children:"GlobalIPv6Address"}),": ",(0,d.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,d.jsx)(n.h4,{id:"globalipv6prefixlen",children:"GlobalIPv6PrefixLen"}),"\n",(0,d.jsxs)(n.blockquote,{children:["\n",(0,d.jsxs)(n.p,{children:[(0,d.jsx)(n.strong,{children:"GlobalIPv6PrefixLen"}),": ",(0,d.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,d.jsx)(n.h4,{id:"hairpinmode",children:"HairpinMode"}),"\n",(0,d.jsxs)(n.blockquote,{children:["\n",(0,d.jsxs)(n.p,{children:[(0,d.jsx)(n.strong,{children:"HairpinMode"}),": ",(0,d.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,d.jsx)(n.h4,{id:"ipaddress",children:"IPAddress"}),"\n",(0,d.jsxs)(n.blockquote,{children:["\n",(0,d.jsxs)(n.p,{children:[(0,d.jsx)(n.strong,{children:"IPAddress"}),": ",(0,d.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,d.jsx)(n.h4,{id:"ipprefixlen",children:"IPPrefixLen"}),"\n",(0,d.jsxs)(n.blockquote,{children:["\n",(0,d.jsxs)(n.p,{children:[(0,d.jsx)(n.strong,{children:"IPPrefixLen"}),": ",(0,d.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,d.jsx)(n.h4,{id:"ipv6gateway",children:"IPv6Gateway"}),"\n",(0,d.jsxs)(n.blockquote,{children:["\n",(0,d.jsxs)(n.p,{children:[(0,d.jsx)(n.strong,{children:"IPv6Gateway"}),": ",(0,d.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,d.jsx)(n.h4,{id:"linklocalipv6address",children:"LinkLocalIPv6Address"}),"\n",(0,d.jsxs)(n.blockquote,{children:["\n",(0,d.jsxs)(n.p,{children:[(0,d.jsx)(n.strong,{children:"LinkLocalIPv6Address"}),": ",(0,d.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,d.jsx)(n.h4,{id:"linklocalipv6prefixlen",children:"LinkLocalIPv6PrefixLen"}),"\n",(0,d.jsxs)(n.blockquote,{children:["\n",(0,d.jsxs)(n.p,{children:[(0,d.jsx)(n.strong,{children:"LinkLocalIPv6PrefixLen"}),": ",(0,d.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,d.jsx)(n.h4,{id:"macaddress",children:"MacAddress"}),"\n",(0,d.jsxs)(n.blockquote,{children:["\n",(0,d.jsxs)(n.p,{children:[(0,d.jsx)(n.strong,{children:"MacAddress"}),": ",(0,d.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,d.jsx)(n.h4,{id:"networks",children:"Networks"}),"\n",(0,d.jsxs)(n.blockquote,{children:["\n",(0,d.jsxs)(n.p,{children:[(0,d.jsx)(n.strong,{children:"Networks"}),": ",(0,d.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,d.jsx)(n.h5,{id:"index-signature-3",children:"Index Signature"}),"\n",(0,d.jsxs)(n.p,{children:["[",(0,d.jsx)(n.code,{children:"type"}),": ",(0,d.jsx)(n.code,{children:"string"}),"]: ",(0,d.jsx)(n.code,{children:"object"})]}),"\n",(0,d.jsx)(n.h4,{id:"node",children:"Node?"}),"\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:"Node"}),": ",(0,d.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,d.jsx)(n.h4,{id:"nodeaddr",children:"Node.Addr"}),"\n",(0,d.jsxs)(n.blockquote,{children:["\n",(0,d.jsxs)(n.p,{children:[(0,d.jsx)(n.strong,{children:"Addr"}),": ",(0,d.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,d.jsx)(n.h4,{id:"nodecpus",children:"Node.Cpus"}),"\n",(0,d.jsxs)(n.blockquote,{children:["\n",(0,d.jsxs)(n.p,{children:[(0,d.jsx)(n.strong,{children:"Cpus"}),": ",(0,d.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,d.jsx)(n.h4,{id:"nodeid",children:"Node.ID"}),"\n",(0,d.jsxs)(n.blockquote,{children:["\n",(0,d.jsxs)(n.p,{children:[(0,d.jsx)(n.strong,{children:"ID"}),": ",(0,d.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,d.jsx)(n.h4,{id:"nodeip",children:"Node.IP"}),"\n",(0,d.jsxs)(n.blockquote,{children:["\n",(0,d.jsxs)(n.p,{children:[(0,d.jsx)(n.strong,{children:"IP"}),": ",(0,d.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,d.jsx)(n.h4,{id:"nodelabels",children:"Node.Labels"}),"\n",(0,d.jsxs)(n.blockquote,{children:["\n",(0,d.jsxs)(n.p,{children:[(0,d.jsx)(n.strong,{children:"Labels"}),": ",(0,d.jsx)(n.code,{children:"unknown"})]}),"\n"]}),"\n",(0,d.jsx)(n.h4,{id:"nodememory",children:"Node.Memory"}),"\n",(0,d.jsxs)(n.blockquote,{children:["\n",(0,d.jsxs)(n.p,{children:[(0,d.jsx)(n.strong,{children:"Memory"}),": ",(0,d.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,d.jsx)(n.h4,{id:"nodename",children:"Node.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:"ports",children:"Ports"}),"\n",(0,d.jsxs)(n.blockquote,{children:["\n",(0,d.jsxs)(n.p,{children:[(0,d.jsx)(n.strong,{children:"Ports"}),": ",(0,d.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,d.jsx)(n.h5,{id:"index-signature-4",children:"Index Signature"}),"\n",(0,d.jsxs)(n.p,{children:["[",(0,d.jsx)(n.code,{children:"portAndProtocol"}),": ",(0,d.jsx)(n.code,{children:"string"}),"]: ",(0,d.jsx)(n.code,{children:"object"}),"[]"]}),"\n",(0,d.jsx)(n.h4,{id:"sandboxid",children:"SandboxID"}),"\n",(0,d.jsxs)(n.blockquote,{children:["\n",(0,d.jsxs)(n.p,{children:[(0,d.jsx)(n.strong,{children:"SandboxID"}),": ",(0,d.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,d.jsx)(n.h4,{id:"sandboxkey",children:"SandboxKey"}),"\n",(0,d.jsxs)(n.blockquote,{children:["\n",(0,d.jsxs)(n.p,{children:[(0,d.jsx)(n.strong,{children:"SandboxKey"}),": ",(0,d.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,d.jsx)(n.h4,{id:"secondaryipaddresses",children:"SecondaryIPAddresses?"}),"\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:"SecondaryIPAddresses"}),": ",(0,d.jsx)(n.code,{children:"unknown"})]}),"\n"]}),"\n",(0,d.jsx)(n.h4,{id:"secondaryipv6addresses",children:"SecondaryIPv6Addresses?"}),"\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:"SecondaryIPv6Addresses"}),": ",(0,d.jsx)(n.code,{children:"unknown"})]}),"\n"]}),"\n",(0,d.jsx)(n.h4,{id:"defined-in-16",children:"Defined in"}),"\n",(0,d.jsx)(n.p,{children:(0,d.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2593",children:"packages/extension-api/src/extension-api.d.ts:2593"})}),"\n",(0,d.jsx)(n.hr,{}),"\n",(0,d.jsx)(n.h3,{id:"path",children:"Path"}),"\n",(0,d.jsxs)(n.blockquote,{children:["\n",(0,d.jsxs)(n.p,{children:[(0,d.jsx)(n.strong,{children:"Path"}),": ",(0,d.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,d.jsx)(n.h4,{id:"defined-in-17",children:"Defined in"}),"\n",(0,d.jsx)(n.p,{children:(0,d.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2527",children:"packages/extension-api/src/extension-api.d.ts:2527"})}),"\n",(0,d.jsx)(n.hr,{}),"\n",(0,d.jsx)(n.h3,{id:"platform",children:"Platform"}),"\n",(0,d.jsxs)(n.blockquote,{children:["\n",(0,d.jsxs)(n.p,{children:[(0,d.jsx)(n.strong,{children:"Platform"}),": ",(0,d.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,d.jsx)(n.h4,{id:"defined-in-18",children:"Defined in"}),"\n",(0,d.jsx)(n.p,{children:(0,d.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2551",children:"packages/extension-api/src/extension-api.d.ts:2551"})}),"\n",(0,d.jsx)(n.hr,{}),"\n",(0,d.jsx)(n.h3,{id:"processlabel",children:"ProcessLabel"}),"\n",(0,d.jsxs)(n.blockquote,{children:["\n",(0,d.jsxs)(n.p,{children:[(0,d.jsx)(n.strong,{children:"ProcessLabel"}),": ",(0,d.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,d.jsx)(n.h4,{id:"defined-in-19",children:"Defined in"}),"\n",(0,d.jsx)(n.p,{children:(0,d.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2553",children:"packages/extension-api/src/extension-api.d.ts:2553"})}),"\n",(0,d.jsx)(n.hr,{}),"\n",(0,d.jsx)(n.h3,{id:"resolvconfpath",children:"ResolvConfPath"}),"\n",(0,d.jsxs)(n.blockquote,{children:["\n",(0,d.jsxs)(n.p,{children:[(0,d.jsx)(n.strong,{children:"ResolvConfPath"}),": ",(0,d.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,d.jsx)(n.h4,{id:"defined-in-20",children:"Defined in"}),"\n",(0,d.jsx)(n.p,{children:(0,d.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2544",children:"packages/extension-api/src/extension-api.d.ts:2544"})}),"\n",(0,d.jsx)(n.hr,{}),"\n",(0,d.jsx)(n.h3,{id:"restartcount",children:"RestartCount"}),"\n",(0,d.jsxs)(n.blockquote,{children:["\n",(0,d.jsxs)(n.p,{children:[(0,d.jsx)(n.strong,{children:"RestartCount"}),": ",(0,d.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,d.jsx)(n.h4,{id:"defined-in-21",children:"Defined in"}),"\n",(0,d.jsx)(n.p,{children:(0,d.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2549",children:"packages/extension-api/src/extension-api.d.ts:2549"})}),"\n",(0,d.jsx)(n.hr,{}),"\n",(0,d.jsx)(n.h3,{id:"state",children:"State"}),"\n",(0,d.jsxs)(n.blockquote,{children:["\n",(0,d.jsxs)(n.p,{children:[(0,d.jsx)(n.strong,{children:"State"}),": ",(0,d.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,d.jsx)(n.h4,{id:"dead",children:"Dead"}),"\n",(0,d.jsxs)(n.blockquote,{children:["\n",(0,d.jsxs)(n.p,{children:[(0,d.jsx)(n.strong,{children:"Dead"}),": ",(0,d.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,d.jsx)(n.h4,{id:"error",children:"Error"}),"\n",(0,d.jsxs)(n.blockquote,{children:["\n",(0,d.jsxs)(n.p,{children:[(0,d.jsx)(n.strong,{children:"Error"}),": ",(0,d.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,d.jsx)(n.h4,{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.h4,{id:"finishedat",children:"FinishedAt"}),"\n",(0,d.jsxs)(n.blockquote,{children:["\n",(0,d.jsxs)(n.p,{children:[(0,d.jsx)(n.strong,{children:"FinishedAt"}),": ",(0,d.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,d.jsx)(n.h4,{id:"health",children:"Health?"}),"\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:"Health"}),": ",(0,d.jsx)(n.a,{href:"/api/interfaces/HealthCheckResults",children:(0,d.jsx)(n.code,{children:"HealthCheckResults"})})]}),"\n"]}),"\n",(0,d.jsx)(n.h4,{id:"oomkilled",children:"OOMKilled"}),"\n",(0,d.jsxs)(n.blockquote,{children:["\n",(0,d.jsxs)(n.p,{children:[(0,d.jsx)(n.strong,{children:"OOMKilled"}),": ",(0,d.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,d.jsx)(n.h4,{id:"paused",children:"Paused"}),"\n",(0,d.jsxs)(n.blockquote,{children:["\n",(0,d.jsxs)(n.p,{children:[(0,d.jsx)(n.strong,{children:"Paused"}),": ",(0,d.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,d.jsx)(n.h4,{id:"pid",children:"Pid"}),"\n",(0,d.jsxs)(n.blockquote,{children:["\n",(0,d.jsxs)(n.p,{children:[(0,d.jsx)(n.strong,{children:"Pid"}),": ",(0,d.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,d.jsx)(n.h4,{id:"restarting",children:"Restarting"}),"\n",(0,d.jsxs)(n.blockquote,{children:["\n",(0,d.jsxs)(n.p,{children:[(0,d.jsx)(n.strong,{children:"Restarting"}),": ",(0,d.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,d.jsx)(n.h4,{id:"running",children:"Running"}),"\n",(0,d.jsxs)(n.blockquote,{children:["\n",(0,d.jsxs)(n.p,{children:[(0,d.jsx)(n.strong,{children:"Running"}),": ",(0,d.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,d.jsx)(n.h4,{id:"startedat",children:"StartedAt"}),"\n",(0,d.jsxs)(n.blockquote,{children:["\n",(0,d.jsxs)(n.p,{children:[(0,d.jsx)(n.strong,{children:"StartedAt"}),": ",(0,d.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,d.jsx)(n.h4,{id:"status",children:"Status"}),"\n",(0,d.jsxs)(n.blockquote,{children:["\n",(0,d.jsxs)(n.p,{children:[(0,d.jsx)(n.strong,{children:"Status"}),": ",(0,d.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,d.jsx)(n.h4,{id:"defined-in-22",children:"Defined in"}),"\n",(0,d.jsx)(n.p,{children:(0,d.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2529",children:"packages/extension-api/src/extension-api.d.ts:2529"})}),"\n",(0,d.jsx)(n.hr,{}),"\n",(0,d.jsx)(n.h3,{id:"engineid",children:"engineId"}),"\n",(0,d.jsxs)(n.blockquote,{children:["\n",(0,d.jsxs)(n.p,{children:[(0,d.jsx)(n.strong,{children:"engineId"}),": ",(0,d.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,d.jsx)(n.h4,{id:"defined-in-23",children:"Defined in"}),"\n",(0,d.jsx)(n.p,{children:(0,d.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2523",children:"packages/extension-api/src/extension-api.d.ts:2523"})}),"\n",(0,d.jsx)(n.hr,{}),"\n",(0,d.jsx)(n.h3,{id:"enginename",children:"engineName"}),"\n",(0,d.jsxs)(n.blockquote,{children:["\n",(0,d.jsxs)(n.p,{children:[(0,d.jsx)(n.strong,{children:"engineName"}),": ",(0,d.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,d.jsx)(n.h4,{id:"defined-in-24",children:"Defined in"}),"\n",(0,d.jsx)(n.p,{children:(0,d.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2524",children:"packages/extension-api/src/extension-api.d.ts:2524"})})]})}function h(e={}){const{wrapper:n}={...(0,s.a)(),...e.components};return n?(0,d.jsx)(n,{...e,children:(0,d.jsx)(a,{...e})}):a(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>c,a:()=>r});var d=i(27378);const s={},l=d.createContext(s);function r(e){const n=d.useContext(l);return d.useMemo((function(){return"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),d.createElement(l.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/e1a2ab10.363396c7.js b/assets/js/e1a2ab10.5829bdf7.js similarity index 80% rename from assets/js/e1a2ab10.363396c7.js rename to assets/js/e1a2ab10.5829bdf7.js index 8f0db64edce..6cbf2de3e51 100644 --- a/assets/js/e1a2ab10.363396c7.js +++ b/assets/js/e1a2ab10.5829bdf7.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[70225],{99919:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>a,contentTitle:()=>c,default:()=>h,frontMatter:()=>t,metadata:()=>l,toc:()=>o});var r=i(24246),s=i(71670);const t={},c="Interface: ProviderInstallation",l={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"}},a={},o=[{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 d(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,r.jsxs)(r.Fragment,{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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L540",children:"packages/extension-api/src/extension-api.d.ts:540"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L538",children:"packages/extension-api/src/extension-api.d.ts:538"})})]})}function h(e={}){const{wrapper:n}={...(0,s.a)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(d,{...e})}):d(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>l,a:()=>c});var r=i(27378);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 l(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 +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[70225],{99919:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>l,contentTitle:()=>c,default:()=>h,frontMatter:()=>t,metadata:()=>d,toc:()=>a});var r=i(24246),s=i(71670);const t={},c="Interface: ProviderInstallation",d={id:"interfaces/ProviderInstallation",title:"Interface: ProviderInstallation",description:"Methods",source:"@site/api/interfaces/ProviderInstallation.md",sourceDirName:"interfaces",slug:"/interfaces/ProviderInstallation",permalink:"/api/interfaces/ProviderInstallation",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"ProviderInformation",permalink:"/api/interfaces/ProviderInformation"},next:{title:"ProviderLifecycle",permalink:"/api/interfaces/ProviderLifecycle"}},l={},a=[{value:"Methods",id:"methods",level:2},{value:"install()",id:"install",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"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",hr:"hr",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.h1,{id:"interface-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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L540",children:"packages/extension-api/src/extension-api.d.ts:540"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L538",children:"packages/extension-api/src/extension-api.d.ts:538"})})]})}function h(e={}){const{wrapper:n}={...(0,s.a)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(o,{...e})}):o(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>d,a:()=>c});var r=i(27378);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 d(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.f4155bfc.js b/assets/js/e1c8d71f.9c3ff73c.js similarity index 94% rename from assets/js/e1c8d71f.f4155bfc.js rename to assets/js/e1c8d71f.9c3ff73c.js index 4ae4da839cd..bc7754ff6ab 100644 --- a/assets/js/e1c8d71f.f4155bfc.js +++ b/assets/js/e1c8d71f.9c3ff73c.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[34884],{16061:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>r,contentTitle:()=>a,default:()=>l,frontMatter:()=>s,metadata:()=>c,toc:()=>p});var i=n(24246),o=n(71670);const s={},a="Type Alias: NotificationType",c={id:"type-aliases/NotificationType",title:"Type Alias: NotificationType",description:'NotificationType: "info" \\| "warn" \\| "error"',source:"@site/api/type-aliases/NotificationType.md",sourceDirName:"type-aliases",slug:"/type-aliases/NotificationType",permalink:"/api/type-aliases/NotificationType",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"MountType",permalink:"/api/type-aliases/MountType"},next:{title:"ProviderConnectionStatus",permalink:"/api/type-aliases/ProviderConnectionStatus"}},r={},p=[{value:"Defined in",id:"defined-in",level:2}];function d(e){const t={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,o.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(t.h1,{id:"type-alias-notificationtype",children:"Type Alias: NotificationType"}),"\n",(0,i.jsxs)(t.blockquote,{children:["\n",(0,i.jsxs)(t.p,{children:[(0,i.jsx)(t.strong,{children:"NotificationType"}),": ",(0,i.jsx)(t.code,{children:'"info"'})," | ",(0,i.jsx)(t.code,{children:'"warn"'})," | ",(0,i.jsx)(t.code,{children:'"error"'})]}),"\n"]}),"\n",(0,i.jsx)(t.h2,{id:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L1430",children:"packages/extension-api/src/extension-api.d.ts:1430"})})]})}function l(e={}){const{wrapper:t}={...(0,o.a)(),...e.components};return t?(0,i.jsx)(t,{...e,children:(0,i.jsx)(d,{...e})}):d(e)}},71670:(e,t,n)=>{n.d(t,{Z:()=>c,a:()=>a});var i=n(27378);const o={},s=i.createContext(o);function a(e){const t=i.useContext(s);return i.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function c(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:a(e.components),i.createElement(s.Provider,{value:t},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[34884],{16061:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>r,contentTitle:()=>a,default:()=>l,frontMatter:()=>s,metadata:()=>c,toc:()=>p});var i=n(24246),o=n(71670);const s={},a="Type Alias: NotificationType",c={id:"type-aliases/NotificationType",title:"Type Alias: NotificationType",description:'NotificationType: "info" \\| "warn" \\| "error"',source:"@site/api/type-aliases/NotificationType.md",sourceDirName:"type-aliases",slug:"/type-aliases/NotificationType",permalink:"/api/type-aliases/NotificationType",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"MountType",permalink:"/api/type-aliases/MountType"},next:{title:"ProviderConnectionStatus",permalink:"/api/type-aliases/ProviderConnectionStatus"}},r={},p=[{value:"Defined in",id:"defined-in",level:2}];function d(e){const t={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,o.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(t.h1,{id:"type-alias-notificationtype",children:"Type Alias: NotificationType"}),"\n",(0,i.jsxs)(t.blockquote,{children:["\n",(0,i.jsxs)(t.p,{children:[(0,i.jsx)(t.strong,{children:"NotificationType"}),": ",(0,i.jsx)(t.code,{children:'"info"'})," | ",(0,i.jsx)(t.code,{children:'"warn"'})," | ",(0,i.jsx)(t.code,{children:'"error"'})]}),"\n"]}),"\n",(0,i.jsx)(t.h2,{id:"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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L1430",children:"packages/extension-api/src/extension-api.d.ts:1430"})})]})}function l(e={}){const{wrapper:t}={...(0,o.a)(),...e.components};return t?(0,i.jsx)(t,{...e,children:(0,i.jsx)(d,{...e})}):d(e)}},71670:(e,t,n)=>{n.d(t,{Z:()=>c,a:()=>a});var i=n(27378);const o={},s=i.createContext(o);function a(e){const t=i.useContext(s);return i.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function c(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:a(e.components),i.createElement(s.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/e35d7c3e.d181337e.js b/assets/js/e35d7c3e.163a4fc3.js similarity index 97% rename from assets/js/e35d7c3e.d181337e.js rename to assets/js/e35d7c3e.163a4fc3.js index 2693c5452a2..c4fc96ccfa0 100644 --- a/assets/js/e35d7c3e.d181337e.js +++ b/assets/js/e35d7c3e.163a4fc3.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[5697],{20266:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>c,contentTitle:()=>o,default:()=>p,frontMatter:()=>i,metadata:()=>a,toc:()=>d});var r=n(24246),s=n(71670);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",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,r.jsxs)(r.Fragment,{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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L3335",children:"packages/extension-api/src/extension-api.d.ts:3335"})})]})}function p(e={}){const{wrapper:t}={...(0,s.a)(),...e.components};return t?(0,r.jsx)(t,{...e,children:(0,r.jsx)(l,{...e})}):l(e)}},71670:(e,t,n)=>{n.d(t,{Z:()=>a,a:()=>o});var r=n(27378);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([[5697],{20266:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>c,contentTitle:()=>o,default:()=>p,frontMatter:()=>i,metadata:()=>a,toc:()=>d});var r=n(24246),s=n(71670);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",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,r.jsxs)(r.Fragment,{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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L3335",children:"packages/extension-api/src/extension-api.d.ts:3335"})})]})}function p(e={}){const{wrapper:t}={...(0,s.a)(),...e.components};return t?(0,r.jsx)(t,{...e,children:(0,r.jsx)(l,{...e})}):l(e)}},71670:(e,t,n)=>{n.d(t,{Z:()=>a,a:()=>o});var r=n(27378);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.f8e23211.js b/assets/js/e38c422a.11e553a6.js similarity index 97% rename from assets/js/e38c422a.f8e23211.js rename to assets/js/e38c422a.11e553a6.js index 2433d0c5fb0..233a8179534 100644 --- a/assets/js/e38c422a.f8e23211.js +++ b/assets/js/e38c422a.11e553a6.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[94331],{46413:(n,e,i)=>{i.r(e),i.d(e,{assets:()=>c,contentTitle:()=>s,default:()=>f,frontMatter:()=>r,metadata:()=>a,toc:()=>u});var t=i(24246),o=i(71670);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={},u=[{value:"Parameters",id:"parameters",level:2},{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",p:"p",strong:"strong",...(0,o.a)(),...n.components};return(0,t.jsxs)(t.Fragment,{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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L931",children:"packages/extension-api/src/extension-api.d.ts:931"})})]})}function f(n={}){const{wrapper:e}={...(0,o.a)(),...n.components};return e?(0,t.jsx)(e,{...n,children:(0,t.jsx)(d,{...n})}):d(n)}},71670:(n,e,i)=>{i.d(e,{Z:()=>a,a:()=>s});var t=i(27378);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([[94331],{46413:(n,e,i)=>{i.r(e),i.d(e,{assets:()=>c,contentTitle:()=>s,default:()=>f,frontMatter:()=>r,metadata:()=>a,toc:()=>u});var t=i(24246),o=i(71670);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={},u=[{value:"Parameters",id:"parameters",level:2},{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",p:"p",strong:"strong",...(0,o.a)(),...n.components};return(0,t.jsxs)(t.Fragment,{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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L931",children:"packages/extension-api/src/extension-api.d.ts:931"})})]})}function f(n={}){const{wrapper:e}={...(0,o.a)(),...n.components};return e?(0,t.jsx)(e,{...n,children:(0,t.jsx)(d,{...n})}):d(n)}},71670:(n,e,i)=>{i.d(e,{Z:()=>a,a:()=>s});var t=i(27378);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.b64ac492.js b/assets/js/e3f28bf9.6edbd27d.js similarity index 97% rename from assets/js/e3f28bf9.b64ac492.js rename to assets/js/e3f28bf9.6edbd27d.js index f8567728ff8..78c1931b26f 100644 --- a/assets/js/e3f28bf9.b64ac492.js +++ b/assets/js/e3f28bf9.6edbd27d.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[36248],{94615:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>o,default:()=>l,frontMatter:()=>s,metadata:()=>c,toc:()=>d});var r=t(24246),i=t(71670);const s={},o="Interface: RegisterKubernetesConnectionEvent",c={id:"interfaces/RegisterKubernetesConnectionEvent",title:"Interface: RegisterKubernetesConnectionEvent",description:"Properties",source:"@site/api/interfaces/RegisterKubernetesConnectionEvent.md",sourceDirName:"interfaces",slug:"/interfaces/RegisterKubernetesConnectionEvent",permalink:"/api/interfaces/RegisterKubernetesConnectionEvent",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"RegisterContainerConnectionEvent",permalink:"/api/interfaces/RegisterContainerConnectionEvent"},next:{title:"Registry",permalink:"/api/interfaces/Registry"}},a={},d=[{value:"Properties",id:"properties",level:2},{value:"providerId",id:"providerid",level:3},{value:"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",p:"p",strong:"strong",...(0,i.a)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.h1,{id:"interface-registerkubernetesconnectionevent",children:"Interface: RegisterKubernetesConnectionEvent"}),"\n",(0,r.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,r.jsx)(n.h3,{id:"providerid",children:"providerId"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"providerId"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L694",children:"packages/extension-api/src/extension-api.d.ts:694"})})]})}function l(e={}){const{wrapper:n}={...(0,i.a)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(p,{...e})}):p(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>c,a:()=>o});var r=t(27378);const i={},s=r.createContext(i);function o(e){const n=r.useContext(s);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:o(e.components),r.createElement(s.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[36248],{94615:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>o,default:()=>l,frontMatter:()=>s,metadata:()=>c,toc:()=>d});var r=t(24246),i=t(71670);const s={},o="Interface: RegisterKubernetesConnectionEvent",c={id:"interfaces/RegisterKubernetesConnectionEvent",title:"Interface: RegisterKubernetesConnectionEvent",description:"Properties",source:"@site/api/interfaces/RegisterKubernetesConnectionEvent.md",sourceDirName:"interfaces",slug:"/interfaces/RegisterKubernetesConnectionEvent",permalink:"/api/interfaces/RegisterKubernetesConnectionEvent",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"RegisterContainerConnectionEvent",permalink:"/api/interfaces/RegisterContainerConnectionEvent"},next:{title:"Registry",permalink:"/api/interfaces/Registry"}},a={},d=[{value:"Properties",id:"properties",level:2},{value:"providerId",id:"providerid",level:3},{value:"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",p:"p",strong:"strong",...(0,i.a)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.h1,{id:"interface-registerkubernetesconnectionevent",children:"Interface: RegisterKubernetesConnectionEvent"}),"\n",(0,r.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,r.jsx)(n.h3,{id:"providerid",children:"providerId"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"providerId"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L694",children:"packages/extension-api/src/extension-api.d.ts:694"})})]})}function l(e={}){const{wrapper:n}={...(0,i.a)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(p,{...e})}):p(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>c,a:()=>o});var r=t(27378);const i={},s=r.createContext(i);function o(e){const n=r.useContext(s);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:o(e.components),r.createElement(s.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/e546fc5a.7ac9b590.js b/assets/js/e546fc5a.42bb8178.js similarity index 96% rename from assets/js/e546fc5a.7ac9b590.js rename to assets/js/e546fc5a.42bb8178.js index 9e22396ba3c..e41f582e269 100644 --- a/assets/js/e546fc5a.7ac9b590.js +++ b/assets/js/e546fc5a.42bb8178.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[63190],{7761:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>c,contentTitle:()=>o,default:()=>p,frontMatter:()=>r,metadata:()=>a,toc:()=>d});var i=s(24246),t=s(71670);const r={},o="Function: onDidUpdateProxy()",a={id:"namespaces/proxy/functions/onDidUpdateProxy",title:"Function: onDidUpdateProxy()",description:"onDidUpdateProxy(listener, thisArgs?, disposables?): Disposable",source:"@site/api/namespaces/proxy/functions/onDidUpdateProxy.md",sourceDirName:"namespaces/proxy/functions",slug:"/namespaces/proxy/functions/onDidUpdateProxy",permalink:"/api/namespaces/proxy/functions/onDidUpdateProxy",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"onDidStateChange",permalink:"/api/namespaces/proxy/functions/onDidStateChange"},next:{title:"setProxy",permalink:"/api/namespaces/proxy/functions/setProxy"}},c={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Defined in",id:"defined-in",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,t.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"function-ondidupdateproxy",children:"Function: onDidUpdateProxy()"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"onDidUpdateProxy"}),"(",(0,i.jsx)(n.code,{children:"listener"}),", ",(0,i.jsx)(n.code,{children:"thisArgs"}),"?, ",(0,i.jsx)(n.code,{children:"disposables"}),"?): ",(0,i.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(n.code,{children:"Disposable"})})]}),"\n"]}),"\n",(0,i.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"listener"})]}),"\n",(0,i.jsx)(n.p,{children:"The listener function will be called when the event happens."}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"thisArgs?"}),": ",(0,i.jsx)(n.code,{children:"any"})]}),"\n",(0,i.jsxs)(n.p,{children:["The ",(0,i.jsx)(n.code,{children:"this"}),"-argument which will be used when calling the event listener."]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"disposables?"}),": ",(0,i.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(n.code,{children:"Disposable"})}),"[]"]}),"\n",(0,i.jsxs)(n.p,{children:["An array to which a ",(0,i.jsx)(n.a,{href:"/api/classes/Disposable",children:"Disposable"})," will be added."]}),"\n",(0,i.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(n.code,{children:"Disposable"})})}),"\n",(0,i.jsx)(n.p,{children:"A disposable which unsubscribes the event listener."}),"\n",(0,i.jsx)(n.h2,{id:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L856",children:"packages/extension-api/src/extension-api.d.ts:856"})})]})}function p(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>a,a:()=>o});var i=s(27378);const t={},r=i.createContext(t);function o(e){const n=i.useContext(r);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function a(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:o(e.components),i.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[63190],{7761:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>c,contentTitle:()=>o,default:()=>p,frontMatter:()=>r,metadata:()=>a,toc:()=>d});var i=s(24246),t=s(71670);const r={},o="Function: onDidUpdateProxy()",a={id:"namespaces/proxy/functions/onDidUpdateProxy",title:"Function: onDidUpdateProxy()",description:"onDidUpdateProxy(listener, thisArgs?, disposables?): Disposable",source:"@site/api/namespaces/proxy/functions/onDidUpdateProxy.md",sourceDirName:"namespaces/proxy/functions",slug:"/namespaces/proxy/functions/onDidUpdateProxy",permalink:"/api/namespaces/proxy/functions/onDidUpdateProxy",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"onDidStateChange",permalink:"/api/namespaces/proxy/functions/onDidStateChange"},next:{title:"setProxy",permalink:"/api/namespaces/proxy/functions/setProxy"}},c={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Defined in",id:"defined-in",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,t.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"function-ondidupdateproxy",children:"Function: onDidUpdateProxy()"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"onDidUpdateProxy"}),"(",(0,i.jsx)(n.code,{children:"listener"}),", ",(0,i.jsx)(n.code,{children:"thisArgs"}),"?, ",(0,i.jsx)(n.code,{children:"disposables"}),"?): ",(0,i.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(n.code,{children:"Disposable"})})]}),"\n"]}),"\n",(0,i.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"listener"})]}),"\n",(0,i.jsx)(n.p,{children:"The listener function will be called when the event happens."}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"thisArgs?"}),": ",(0,i.jsx)(n.code,{children:"any"})]}),"\n",(0,i.jsxs)(n.p,{children:["The ",(0,i.jsx)(n.code,{children:"this"}),"-argument which will be used when calling the event listener."]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"disposables?"}),": ",(0,i.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(n.code,{children:"Disposable"})}),"[]"]}),"\n",(0,i.jsxs)(n.p,{children:["An array to which a ",(0,i.jsx)(n.a,{href:"/api/classes/Disposable",children:"Disposable"})," will be added."]}),"\n",(0,i.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(n.code,{children:"Disposable"})})}),"\n",(0,i.jsx)(n.p,{children:"A disposable which unsubscribes the event listener."}),"\n",(0,i.jsx)(n.h2,{id:"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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L856",children:"packages/extension-api/src/extension-api.d.ts:856"})})]})}function p(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>a,a:()=>o});var i=s(27378);const t={},r=i.createContext(t);function o(e){const n=i.useContext(r);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function a(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:o(e.components),i.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/e6163b65.3179bed9.js b/assets/js/e6163b65.52a67516.js similarity index 84% rename from assets/js/e6163b65.3179bed9.js rename to assets/js/e6163b65.52a67516.js index ff25fc7684b..cf91c3092c6 100644 --- a/assets/js/e6163b65.3179bed9.js +++ b/assets/js/e6163b65.52a67516.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[92045],{9405:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>r,contentTitle:()=>o,default:()=>h,frontMatter:()=>a,metadata:()=>c,toc:()=>d});var i=s(24246),t=s(71670);const a={},o="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/"}},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",p:"p",strong:"strong",...(0,t.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"function-ondidchange",children:"Function: onDidChange()"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"onDidChange"}),"(",(0,i.jsx)(n.code,{children:"listener"}),", ",(0,i.jsx)(n.code,{children:"thisArgs"}),"?, ",(0,i.jsx)(n.code,{children:"disposables"}),"?): ",(0,i.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(n.code,{children:"Disposable"})})]}),"\n"]}),"\n",(0,i.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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L246",children:"packages/extension-api/src/extension-api.d.ts:246"})})]})}function h(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>c,a:()=>o});var i=s(27378);const t={},a=i.createContext(t);function o(e){const n=i.useContext(a);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(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([[92045],{9405:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>r,contentTitle:()=>c,default:()=>h,frontMatter:()=>a,metadata:()=>o,toc:()=>d});var i=s(24246),t=s(71670);const a={},c="Function: onDidChange()",o={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/"}},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",p:"p",strong:"strong",...(0,t.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"function-ondidchange",children:"Function: onDidChange()"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"onDidChange"}),"(",(0,i.jsx)(n.code,{children:"listener"}),", ",(0,i.jsx)(n.code,{children:"thisArgs"}),"?, ",(0,i.jsx)(n.code,{children:"disposables"}),"?): ",(0,i.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(n.code,{children:"Disposable"})})]}),"\n"]}),"\n",(0,i.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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L246",children:"packages/extension-api/src/extension-api.d.ts:246"})})]})}function h(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>o,a:()=>c});var i=s(27378);const t={},a=i.createContext(t);function c(e){const n=i.useContext(a);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(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/e6412603.bbc73382.js b/assets/js/e6412603.81357e24.js similarity index 91% rename from assets/js/e6412603.bbc73382.js rename to assets/js/e6412603.81357e24.js index b9d694266de..f72f27e10d2 100644 --- a/assets/js/e6412603.bbc73382.js +++ b/assets/js/e6412603.81357e24.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[92955],{82390:(e,s,n)=>{n.r(s),n.d(s,{assets:()=>o,contentTitle:()=>a,default:()=>p,frontMatter:()=>r,metadata:()=>c,toc:()=>d});var i=n(24246),t=n(71670);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"}},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",p:"p",strong:"strong",...(0,t.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(s.h1,{id:"function-ondidupdateregistry",children:"Function: onDidUpdateRegistry()"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"onDidUpdateRegistry"}),"(",(0,i.jsx)(s.code,{children:"listener"}),", ",(0,i.jsx)(s.code,{children:"thisArgs"}),"?, ",(0,i.jsx)(s.code,{children:"disposables"}),"?): ",(0,i.jsx)(s.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(s.code,{children:"Disposable"})})]}),"\n"]}),"\n",(0,i.jsx)(s.h2,{id:"parameters",children:"Parameters"}),"\n",(0,i.jsxs)(s.p,{children:["\u2022 ",(0,i.jsx)(s.strong,{children:"listener"})]}),"\n",(0,i.jsx)(s.p,{children:"The listener function will be called when the event happens."}),"\n",(0,i.jsxs)(s.p,{children:["\u2022 ",(0,i.jsx)(s.strong,{children:"thisArgs?"}),": ",(0,i.jsx)(s.code,{children:"any"})]}),"\n",(0,i.jsxs)(s.p,{children:["The ",(0,i.jsx)(s.code,{children:"this"}),"-argument which will be used when calling the event listener."]}),"\n",(0,i.jsxs)(s.p,{children:["\u2022 ",(0,i.jsx)(s.strong,{children:"disposables?"}),": ",(0,i.jsx)(s.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(s.code,{children:"Disposable"})}),"[]"]}),"\n",(0,i.jsxs)(s.p,{children:["An array to which a ",(0,i.jsx)(s.a,{href:"/api/classes/Disposable",children:"Disposable"})," will be added."]}),"\n",(0,i.jsx)(s.h2,{id:"returns",children:"Returns"}),"\n",(0,i.jsx)(s.p,{children:(0,i.jsx)(s.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(s.code,{children:"Disposable"})})}),"\n",(0,i.jsx)(s.p,{children:"A disposable which unsubscribes the event listener."}),"\n",(0,i.jsx)(s.h2,{id:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L911",children:"packages/extension-api/src/extension-api.d.ts:911"})})]})}function p(e={}){const{wrapper:s}={...(0,t.a)(),...e.components};return s?(0,i.jsx)(s,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},71670:(e,s,n)=>{n.d(s,{Z:()=>c,a:()=>a});var i=n(27378);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([[92955],{82390:(e,s,n)=>{n.r(s),n.d(s,{assets:()=>d,contentTitle:()=>a,default:()=>p,frontMatter:()=>r,metadata:()=>c,toc:()=>o});var i=n(24246),t=n(71670);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",p:"p",strong:"strong",...(0,t.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(s.h1,{id:"function-ondidupdateregistry",children:"Function: onDidUpdateRegistry()"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"onDidUpdateRegistry"}),"(",(0,i.jsx)(s.code,{children:"listener"}),", ",(0,i.jsx)(s.code,{children:"thisArgs"}),"?, ",(0,i.jsx)(s.code,{children:"disposables"}),"?): ",(0,i.jsx)(s.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(s.code,{children:"Disposable"})})]}),"\n"]}),"\n",(0,i.jsx)(s.h2,{id:"parameters",children:"Parameters"}),"\n",(0,i.jsxs)(s.p,{children:["\u2022 ",(0,i.jsx)(s.strong,{children:"listener"})]}),"\n",(0,i.jsx)(s.p,{children:"The listener function will be called when the event happens."}),"\n",(0,i.jsxs)(s.p,{children:["\u2022 ",(0,i.jsx)(s.strong,{children:"thisArgs?"}),": ",(0,i.jsx)(s.code,{children:"any"})]}),"\n",(0,i.jsxs)(s.p,{children:["The ",(0,i.jsx)(s.code,{children:"this"}),"-argument which will be used when calling the event listener."]}),"\n",(0,i.jsxs)(s.p,{children:["\u2022 ",(0,i.jsx)(s.strong,{children:"disposables?"}),": ",(0,i.jsx)(s.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(s.code,{children:"Disposable"})}),"[]"]}),"\n",(0,i.jsxs)(s.p,{children:["An array to which a ",(0,i.jsx)(s.a,{href:"/api/classes/Disposable",children:"Disposable"})," will be added."]}),"\n",(0,i.jsx)(s.h2,{id:"returns",children:"Returns"}),"\n",(0,i.jsx)(s.p,{children:(0,i.jsx)(s.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(s.code,{children:"Disposable"})})}),"\n",(0,i.jsx)(s.p,{children:"A disposable which unsubscribes the event listener."}),"\n",(0,i.jsx)(s.h2,{id:"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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L911",children:"packages/extension-api/src/extension-api.d.ts:911"})})]})}function p(e={}){const{wrapper:s}={...(0,t.a)(),...e.components};return s?(0,i.jsx)(s,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},71670:(e,s,n)=>{n.d(s,{Z:()=>c,a:()=>a});var i=n(27378);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.c5c66120.js b/assets/js/e69dadab.9568f8be.js similarity index 83% rename from assets/js/e69dadab.c5c66120.js rename to assets/js/e69dadab.9568f8be.js index d716bc08fc6..01856401ae8 100644 --- a/assets/js/e69dadab.c5c66120.js +++ b/assets/js/e69dadab.9568f8be.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[75273],{52818:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>a,contentTitle:()=>o,default:()=>h,frontMatter:()=>t,metadata:()=>r,toc:()=>c});var s=i(24246),d=i(71670);const t={},o="Interface: PodmanContainerCreateOptions",r={id:"interfaces/PodmanContainerCreateOptions",title:"Interface: PodmanContainerCreateOptions",description:"Properties",source:"@site/api/interfaces/PodmanContainerCreateOptions.md",sourceDirName:"interfaces",slug:"/interfaces/PodmanContainerCreateOptions",permalink:"/api/interfaces/PodmanContainerCreateOptions",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"PodInfo",permalink:"/api/interfaces/PodInfo"},next:{title:"Port",permalink:"/api/interfaces/Port"}},a={},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",hr:"hr",p:"p",strong:"strong",...(0,d.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L2820",children:"packages/extension-api/src/extension-api.d.ts:2820"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L2821",children:"packages/extension-api/src/extension-api.d.ts:2821"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/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:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L2824",children:"packages/extension-api/src/extension-api.d.ts:2824"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L2825",children:"packages/extension-api/src/extension-api.d.ts:2825"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L2827",children:"packages/extension-api/src/extension-api.d.ts:2827"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L2826",children:"packages/extension-api/src/extension-api.d.ts:2826"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L2823",children:"packages/extension-api/src/extension-api.d.ts:2823"})})]})}function h(e={}){const{wrapper:n}={...(0,d.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>r,a:()=>o});var s=i(27378);const 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([[75273],{52818:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>c,contentTitle:()=>o,default:()=>h,frontMatter:()=>t,metadata:()=>a,toc:()=>r});var s=i(24246),d=i(71670);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"}},c={},r=[{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",hr:"hr",p:"p",strong:"strong",...(0,d.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2820",children:"packages/extension-api/src/extension-api.d.ts:2820"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2821",children:"packages/extension-api/src/extension-api.d.ts:2821"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"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/bd83a8b2bb8ab886dc757381b589638cbda150d0/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:"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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2824",children:"packages/extension-api/src/extension-api.d.ts:2824"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2825",children:"packages/extension-api/src/extension-api.d.ts:2825"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2827",children:"packages/extension-api/src/extension-api.d.ts:2827"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2826",children:"packages/extension-api/src/extension-api.d.ts:2826"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2823",children:"packages/extension-api/src/extension-api.d.ts:2823"})})]})}function h(e={}){const{wrapper:n}={...(0,d.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>a,a:()=>o});var s=i(27378);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.d5ed1440.js b/assets/js/e6c31e60.d4ef3531.js similarity index 93% rename from assets/js/e6c31e60.d5ed1440.js rename to assets/js/e6c31e60.d4ef3531.js index 0ec5ce03d18..6d886d62187 100644 --- a/assets/js/e6c31e60.d5ed1440.js +++ b/assets/js/e6c31e60.d4ef3531.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[72931],{98521:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>o,contentTitle:()=>d,default:()=>h,frontMatter:()=>t,metadata:()=>c,toc:()=>a});var r=i(24246),s=i(71670);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"}},o={},a=[{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",hr:"hr",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.h1,{id:"interface-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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L544",children:"packages/extension-api/src/extension-api.d.ts:544"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L548",children:"packages/extension-api/src/extension-api.d.ts:548"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L546",children:"packages/extension-api/src/extension-api.d.ts:546"})})]})}function h(e={}){const{wrapper:n}={...(0,s.a)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(l,{...e})}):l(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>c,a:()=>d});var r=i(27378);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([[72931],{98521:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>o,contentTitle:()=>d,default:()=>h,frontMatter:()=>t,metadata:()=>c,toc:()=>a});var r=i(24246),s=i(71670);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"}},o={},a=[{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",hr:"hr",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.h1,{id:"interface-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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L544",children:"packages/extension-api/src/extension-api.d.ts:544"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L548",children:"packages/extension-api/src/extension-api.d.ts:548"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L546",children:"packages/extension-api/src/extension-api.d.ts:546"})})]})}function h(e={}){const{wrapper:n}={...(0,s.a)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(l,{...e})}):l(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>c,a:()=>d});var r=i(27378);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.629f0c88.js b/assets/js/e7477a94.30c6e129.js similarity index 83% rename from assets/js/e7477a94.629f0c88.js rename to assets/js/e7477a94.30c6e129.js index 50972df1edf..3dd69283623 100644 --- a/assets/js/e7477a94.629f0c88.js +++ b/assets/js/e7477a94.30c6e129.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[12864],{50413:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>l,contentTitle:()=>r,default:()=>h,frontMatter:()=>c,metadata:()=>d,toc:()=>o});var t=i(24246),s=i(71670);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={},o=[{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 a(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"interface-installcheck",children:"Interface: InstallCheck"}),"\n",(0,t.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,t.jsx)(n.h3,{id:"title",children:"title"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"title"}),": ",(0,t.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L532",children:"packages/extension-api/src/extension-api.d.ts:532"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/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:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L534",children:"packages/extension-api/src/extension-api.d.ts:534"})})]})}function h(e={}){const{wrapper:n}={...(0,s.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(a,{...e})}):a(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>d,a:()=>r});var t=i(27378);const s={},c=t.createContext(s);function r(e){const n=t.useContext(c);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function 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 +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[12864],{50413:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>l,contentTitle:()=>r,default:()=>h,frontMatter:()=>c,metadata:()=>d,toc:()=>a});var t=i(24246),s=i(71670);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",hr:"hr",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"interface-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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L532",children:"packages/extension-api/src/extension-api.d.ts:532"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/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:"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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L534",children:"packages/extension-api/src/extension-api.d.ts:534"})})]})}function h(e={}){const{wrapper:n}={...(0,s.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(o,{...e})}):o(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>d,a:()=>r});var t=i(27378);const s={},c=t.createContext(s);function r(e){const n=t.useContext(c);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function 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.493146b4.js b/assets/js/e7923b27.1a55303d.js similarity index 96% rename from assets/js/e7923b27.493146b4.js rename to assets/js/e7923b27.1a55303d.js index 40d98ef41ab..02d1825e84d 100644 --- a/assets/js/e7923b27.493146b4.js +++ b/assets/js/e7923b27.1a55303d.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[9055],{18485:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>l,contentTitle:()=>c,default:()=>h,frontMatter:()=>r,metadata:()=>a,toc:()=>d});var t=s(24246),i=s(71670);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",p:"p",strong:"strong",...(0,i.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"interface-eventt",children:"Interface: Event()"}),"\n",(0,t.jsx)(n.p,{children:"Event to subscribe"}),"\n",(0,t.jsx)(n.h2,{id:"type-parameters",children:"Type Parameters"}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"T"})]}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"Event"}),"(",(0,t.jsx)(n.code,{children:"listener"}),", ",(0,t.jsx)(n.code,{children:"thisArgs"}),"?, ",(0,t.jsx)(n.code,{children:"disposables"}),"?): ",(0,t.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,t.jsx)(n.code,{children:"Disposable"})})]}),"\n"]}),"\n",(0,t.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"listener"})]}),"\n",(0,t.jsx)(n.p,{children:"The listener function will be called when the event happens."}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"thisArgs?"}),": ",(0,t.jsx)(n.code,{children:"any"})]}),"\n",(0,t.jsxs)(n.p,{children:["The ",(0,t.jsx)(n.code,{children:"this"}),"-argument which will be used when calling the event listener."]}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"disposables?"}),": ",(0,t.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,t.jsx)(n.code,{children:"Disposable"})}),"[]"]}),"\n",(0,t.jsxs)(n.p,{children:["An array to which a ",(0,t.jsx)(n.a,{href:"/api/classes/Disposable",children:"Disposable"})," will be added."]}),"\n",(0,t.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,t.jsx)(n.code,{children:"Disposable"})})}),"\n",(0,t.jsx)(n.p,{children:"A disposable which unsubscribes the event listener."}),"\n",(0,t.jsx)(n.h2,{id:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/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.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(o,{...e})}):o(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>a,a:()=>c});var t=s(27378);const i={},r=t.createContext(i);function c(e){const n=t.useContext(r);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function a(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:c(e.components),t.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[9055],{18485:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>l,contentTitle:()=>c,default:()=>h,frontMatter:()=>r,metadata:()=>a,toc:()=>d});var t=s(24246),i=s(71670);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",p:"p",strong:"strong",...(0,i.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"interface-eventt",children:"Interface: Event()"}),"\n",(0,t.jsx)(n.p,{children:"Event to subscribe"}),"\n",(0,t.jsx)(n.h2,{id:"type-parameters",children:"Type Parameters"}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"T"})]}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"Event"}),"(",(0,t.jsx)(n.code,{children:"listener"}),", ",(0,t.jsx)(n.code,{children:"thisArgs"}),"?, ",(0,t.jsx)(n.code,{children:"disposables"}),"?): ",(0,t.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,t.jsx)(n.code,{children:"Disposable"})})]}),"\n"]}),"\n",(0,t.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"listener"})]}),"\n",(0,t.jsx)(n.p,{children:"The listener function will be called when the event happens."}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"thisArgs?"}),": ",(0,t.jsx)(n.code,{children:"any"})]}),"\n",(0,t.jsxs)(n.p,{children:["The ",(0,t.jsx)(n.code,{children:"this"}),"-argument which will be used when calling the event listener."]}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"disposables?"}),": ",(0,t.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,t.jsx)(n.code,{children:"Disposable"})}),"[]"]}),"\n",(0,t.jsxs)(n.p,{children:["An array to which a ",(0,t.jsx)(n.a,{href:"/api/classes/Disposable",children:"Disposable"})," will be added."]}),"\n",(0,t.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,t.jsx)(n.code,{children:"Disposable"})})}),"\n",(0,t.jsx)(n.p,{children:"A disposable which unsubscribes the event listener."}),"\n",(0,t.jsx)(n.h2,{id:"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/bd83a8b2bb8ab886dc757381b589638cbda150d0/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.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(o,{...e})}):o(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>a,a:()=>c});var t=s(27378);const i={},r=t.createContext(i);function c(e){const n=t.useContext(r);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function a(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:c(e.components),t.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/e84cabb0.452b41b1.js b/assets/js/e84cabb0.45a81b9a.js similarity index 97% rename from assets/js/e84cabb0.452b41b1.js rename to assets/js/e84cabb0.45a81b9a.js index 32aa8258042..e0bd3499c6c 100644 --- a/assets/js/e84cabb0.452b41b1.js +++ b/assets/js/e84cabb0.45a81b9a.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[81145],{473:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>i,default:()=>x,frontMatter:()=>o,metadata:()=>c,toc:()=>d});var s=t(24246),r=t(71670);const o={},i="Function: setProxy()",c={id:"namespaces/proxy/functions/setProxy",title:"Function: setProxy()",description:"setProxy(proxySettings): Promise\\",source:"@site/api/namespaces/proxy/functions/setProxy.md",sourceDirName:"namespaces/proxy/functions",slug:"/namespaces/proxy/functions/setProxy",permalink:"/api/namespaces/proxy/functions/setProxy",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"onDidUpdateProxy",permalink:"/api/namespaces/proxy/functions/onDidUpdateProxy"},next:{title:"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",p:"p",strong:"strong",...(0,r.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"function-setproxy",children:"Function: setProxy()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"setProxy"}),"(",(0,s.jsx)(n.code,{children:"proxySettings"}),"): ",(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:"proxySettings"}),": ",(0,s.jsx)(n.a,{href:"/api/interfaces/ProxySettings",children:(0,s.jsx)(n.code,{children:"ProxySettings"})})]}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L854",children:"packages/extension-api/src/extension-api.d.ts:854"})})]})}function x(e={}){const{wrapper:n}={...(0,r.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(p,{...e})}):p(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>c,a:()=>i});var s=t(27378);const r={},o=s.createContext(r);function i(e){const n=s.useContext(o);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:i(e.components),s.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[81145],{473:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>i,default:()=>x,frontMatter:()=>o,metadata:()=>c,toc:()=>d});var s=t(24246),r=t(71670);const o={},i="Function: setProxy()",c={id:"namespaces/proxy/functions/setProxy",title:"Function: setProxy()",description:"setProxy(proxySettings): Promise\\",source:"@site/api/namespaces/proxy/functions/setProxy.md",sourceDirName:"namespaces/proxy/functions",slug:"/namespaces/proxy/functions/setProxy",permalink:"/api/namespaces/proxy/functions/setProxy",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"onDidUpdateProxy",permalink:"/api/namespaces/proxy/functions/onDidUpdateProxy"},next:{title:"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",p:"p",strong:"strong",...(0,r.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"function-setproxy",children:"Function: setProxy()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"setProxy"}),"(",(0,s.jsx)(n.code,{children:"proxySettings"}),"): ",(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:"proxySettings"}),": ",(0,s.jsx)(n.a,{href:"/api/interfaces/ProxySettings",children:(0,s.jsx)(n.code,{children:"ProxySettings"})})]}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L854",children:"packages/extension-api/src/extension-api.d.ts:854"})})]})}function x(e={}){const{wrapper:n}={...(0,r.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(p,{...e})}):p(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>c,a:()=>i});var s=t(27378);const r={},o=s.createContext(r);function i(e){const n=s.useContext(o);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:i(e.components),s.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/e88443f3.64855d07.js b/assets/js/e88443f3.eeefa800.js similarity index 95% rename from assets/js/e88443f3.64855d07.js rename to assets/js/e88443f3.eeefa800.js index ea2c0e870c3..73948624e32 100644 --- a/assets/js/e88443f3.64855d07.js +++ b/assets/js/e88443f3.eeefa800.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[97953],{54910:(n,e,t)=>{t.r(e),t.d(e,{assets:()=>d,contentTitle:()=>c,default:()=>l,frontMatter:()=>i,metadata:()=>r,toc:()=>a});var s=t(24246),o=t(71670);const i={},c="Function: stopPod()",r={id:"namespaces/containerEngine/functions/stopPod",title:"Function: stopPod()",description:"stopPod(engineId, podId): Promise\\",source:"@site/api/namespaces/containerEngine/functions/stopPod.md",sourceDirName:"namespaces/containerEngine/functions",slug:"/namespaces/containerEngine/functions/stopPod",permalink:"/api/namespaces/containerEngine/functions/stopPod",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"stopContainer",permalink:"/api/namespaces/containerEngine/functions/stopContainer"},next:{title:"tagImage",permalink:"/api/namespaces/containerEngine/functions/tagImage"}},d={},a=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Defined in",id:"defined-in",level:2}];function p(n){const e={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,o.a)(),...n.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(e.h1,{id:"function-stoppod",children:"Function: stopPod()"}),"\n",(0,s.jsxs)(e.blockquote,{children:["\n",(0,s.jsxs)(e.p,{children:[(0,s.jsx)(e.strong,{children:"stopPod"}),"(",(0,s.jsx)(e.code,{children:"engineId"}),", ",(0,s.jsx)(e.code,{children:"podId"}),"): ",(0,s.jsx)(e.code,{children:"Promise"}),"<",(0,s.jsx)(e.code,{children:"void"}),">"]}),"\n"]}),"\n",(0,s.jsx)(e.h2,{id:"parameters",children:"Parameters"}),"\n",(0,s.jsxs)(e.p,{children:["\u2022 ",(0,s.jsx)(e.strong,{children:"engineId"}),": ",(0,s.jsx)(e.code,{children:"string"})]}),"\n",(0,s.jsxs)(e.p,{children:["\u2022 ",(0,s.jsx)(e.strong,{children:"podId"}),": ",(0,s.jsx)(e.code,{children:"string"})]}),"\n",(0,s.jsx)(e.h2,{id:"returns",children:"Returns"}),"\n",(0,s.jsxs)(e.p,{children:[(0,s.jsx)(e.code,{children:"Promise"}),"<",(0,s.jsx)(e.code,{children:"void"}),">"]}),"\n",(0,s.jsx)(e.h2,{id:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L3667",children:"packages/extension-api/src/extension-api.d.ts:3667"})})]})}function l(n={}){const{wrapper:e}={...(0,o.a)(),...n.components};return e?(0,s.jsx)(e,{...n,children:(0,s.jsx)(p,{...n})}):p(n)}},71670:(n,e,t)=>{t.d(e,{Z:()=>r,a:()=>c});var s=t(27378);const o={},i=s.createContext(o);function c(n){const e=s.useContext(i);return s.useMemo((function(){return"function"==typeof n?n(e):{...e,...n}}),[e,n])}function r(n){let e;return e=n.disableParentContext?"function"==typeof n.components?n.components(o):n.components||o:c(n.components),s.createElement(i.Provider,{value:e},n.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[97953],{54910:(n,e,t)=>{t.r(e),t.d(e,{assets:()=>d,contentTitle:()=>c,default:()=>l,frontMatter:()=>i,metadata:()=>r,toc:()=>a});var s=t(24246),o=t(71670);const i={},c="Function: stopPod()",r={id:"namespaces/containerEngine/functions/stopPod",title:"Function: stopPod()",description:"stopPod(engineId, podId): Promise\\",source:"@site/api/namespaces/containerEngine/functions/stopPod.md",sourceDirName:"namespaces/containerEngine/functions",slug:"/namespaces/containerEngine/functions/stopPod",permalink:"/api/namespaces/containerEngine/functions/stopPod",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"stopContainer",permalink:"/api/namespaces/containerEngine/functions/stopContainer"},next:{title:"tagImage",permalink:"/api/namespaces/containerEngine/functions/tagImage"}},d={},a=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Defined in",id:"defined-in",level:2}];function p(n){const e={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,o.a)(),...n.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(e.h1,{id:"function-stoppod",children:"Function: stopPod()"}),"\n",(0,s.jsxs)(e.blockquote,{children:["\n",(0,s.jsxs)(e.p,{children:[(0,s.jsx)(e.strong,{children:"stopPod"}),"(",(0,s.jsx)(e.code,{children:"engineId"}),", ",(0,s.jsx)(e.code,{children:"podId"}),"): ",(0,s.jsx)(e.code,{children:"Promise"}),"<",(0,s.jsx)(e.code,{children:"void"}),">"]}),"\n"]}),"\n",(0,s.jsx)(e.h2,{id:"parameters",children:"Parameters"}),"\n",(0,s.jsxs)(e.p,{children:["\u2022 ",(0,s.jsx)(e.strong,{children:"engineId"}),": ",(0,s.jsx)(e.code,{children:"string"})]}),"\n",(0,s.jsxs)(e.p,{children:["\u2022 ",(0,s.jsx)(e.strong,{children:"podId"}),": ",(0,s.jsx)(e.code,{children:"string"})]}),"\n",(0,s.jsx)(e.h2,{id:"returns",children:"Returns"}),"\n",(0,s.jsxs)(e.p,{children:[(0,s.jsx)(e.code,{children:"Promise"}),"<",(0,s.jsx)(e.code,{children:"void"}),">"]}),"\n",(0,s.jsx)(e.h2,{id:"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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L3667",children:"packages/extension-api/src/extension-api.d.ts:3667"})})]})}function l(n={}){const{wrapper:e}={...(0,o.a)(),...n.components};return e?(0,s.jsx)(e,{...n,children:(0,s.jsx)(p,{...n})}):p(n)}},71670:(n,e,t)=>{t.d(e,{Z:()=>r,a:()=>c});var s=t(27378);const o={},i=s.createContext(o);function c(n){const e=s.useContext(i);return s.useMemo((function(){return"function"==typeof n?n(e):{...e,...n}}),[e,n])}function r(n){let e;return e=n.disableParentContext?"function"==typeof n.components?n.components(o):n.components||o:c(n.components),s.createElement(i.Provider,{value:e},n.children)}}}]); \ No newline at end of file diff --git a/assets/js/e983a6d7.8145ef48.js b/assets/js/e983a6d7.4b851537.js similarity index 97% rename from assets/js/e983a6d7.8145ef48.js rename to assets/js/e983a6d7.4b851537.js index 768ea91b7c1..594fc1bfc2a 100644 --- a/assets/js/e983a6d7.8145ef48.js +++ b/assets/js/e983a6d7.4b851537.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[61281],{20636:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>o,contentTitle:()=>c,default:()=>p,frontMatter:()=>t,metadata:()=>r,toc:()=>l});var a=s(24246),i=s(71670);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",p:"p",strong:"strong",...(0,i.a)(),...e.components};return(0,a.jsxs)(a.Fragment,{children:[(0,a.jsx)(n.h1,{id:"variable-ismac",children:"Variable: isMac"}),"\n",(0,a.jsxs)(n.blockquote,{children:["\n",(0,a.jsxs)(n.p,{children:[(0,a.jsx)(n.code,{children:"const"})," ",(0,a.jsx)(n.strong,{children:"isMac"}),": ",(0,a.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,a.jsx)(n.p,{children:"Flag indicating whether we are running on macOS (Mac OS X) operating system."}),"\n",(0,a.jsx)(n.p,{children:"If the value of this flag is true, it means the current system is macOS.\nIf the value is false, it means the current system is not macOS."}),"\n",(0,a.jsx)(n.h2,{id:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L3953",children:"packages/extension-api/src/extension-api.d.ts:3953"})})]})}function p(e={}){const{wrapper:n}={...(0,i.a)(),...e.components};return n?(0,a.jsx)(n,{...e,children:(0,a.jsx)(d,{...e})}):d(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>r,a:()=>c});var a=s(27378);const 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([[61281],{20636:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>o,contentTitle:()=>c,default:()=>p,frontMatter:()=>t,metadata:()=>r,toc:()=>l});var a=s(24246),i=s(71670);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",p:"p",strong:"strong",...(0,i.a)(),...e.components};return(0,a.jsxs)(a.Fragment,{children:[(0,a.jsx)(n.h1,{id:"variable-ismac",children:"Variable: isMac"}),"\n",(0,a.jsxs)(n.blockquote,{children:["\n",(0,a.jsxs)(n.p,{children:[(0,a.jsx)(n.code,{children:"const"})," ",(0,a.jsx)(n.strong,{children:"isMac"}),": ",(0,a.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,a.jsx)(n.p,{children:"Flag indicating whether we are running on macOS (Mac OS X) operating system."}),"\n",(0,a.jsx)(n.p,{children:"If the value of this flag is true, it means the current system is macOS.\nIf the value is false, it means the current system is not macOS."}),"\n",(0,a.jsx)(n.h2,{id:"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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L3953",children:"packages/extension-api/src/extension-api.d.ts:3953"})})]})}function p(e={}){const{wrapper:n}={...(0,i.a)(),...e.components};return n?(0,a.jsx)(n,{...e,children:(0,a.jsx)(d,{...e})}):d(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>r,a:()=>c});var a=s(27378);const 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.1f81b445.js b/assets/js/ea3ffc82.4c641c18.js similarity index 92% rename from assets/js/ea3ffc82.1f81b445.js rename to assets/js/ea3ffc82.4c641c18.js index d6d7807c4f7..b2c09dae862 100644 --- a/assets/js/ea3ffc82.1f81b445.js +++ b/assets/js/ea3ffc82.4c641c18.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[21181],{65494:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>d,contentTitle:()=>o,default:()=>h,frontMatter:()=>r,metadata:()=>c,toc:()=>a});var s=i(24246),t=i(71670);const r={},o="Interface: ExtensionContext",c={id:"interfaces/ExtensionContext",title:"Interface: ExtensionContext",description:"Properties",source:"@site/api/interfaces/ExtensionContext.md",sourceDirName:"interfaces",slug:"/interfaces/ExtensionContext",permalink:"/api/interfaces/ExtensionContext",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Extension",permalink:"/api/interfaces/Extension"},next:{title:"FileSystemWatcher",permalink:"/api/interfaces/FileSystemWatcher"}},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",hr:"hr",p:"p",strong:"strong",...(0,t.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"interface-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/804b2198fda0957e1ecfb87539f019eb9b79a66f/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/804b2198fda0957e1ecfb87539f019eb9b79a66f/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/804b2198fda0957e1ecfb87539f019eb9b79a66f/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/804b2198fda0957e1ecfb87539f019eb9b79a66f/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.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>c,a:()=>o});var s=i(27378);const t={},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([[21181],{65494:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>d,contentTitle:()=>o,default:()=>h,frontMatter:()=>r,metadata:()=>c,toc:()=>a});var s=i(24246),t=i(71670);const r={},o="Interface: ExtensionContext",c={id:"interfaces/ExtensionContext",title:"Interface: ExtensionContext",description:"Properties",source:"@site/api/interfaces/ExtensionContext.md",sourceDirName:"interfaces",slug:"/interfaces/ExtensionContext",permalink:"/api/interfaces/ExtensionContext",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Extension",permalink:"/api/interfaces/Extension"},next:{title:"FileSystemWatcher",permalink:"/api/interfaces/FileSystemWatcher"}},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",hr:"hr",p:"p",strong:"strong",...(0,t.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"interface-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/bd83a8b2bb8ab886dc757381b589638cbda150d0/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/bd83a8b2bb8ab886dc757381b589638cbda150d0/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/bd83a8b2bb8ab886dc757381b589638cbda150d0/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/bd83a8b2bb8ab886dc757381b589638cbda150d0/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.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>c,a:()=>o});var s=i(27378);const t={},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.b9c98dbc.js b/assets/js/ed2a4846.9c2dee85.js similarity index 86% rename from assets/js/ed2a4846.b9c98dbc.js rename to assets/js/ed2a4846.9c2dee85.js index d673fe9bccb..3cd31904670 100644 --- a/assets/js/ed2a4846.b9c98dbc.js +++ b/assets/js/ed2a4846.9c2dee85.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[40486],{41712:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>o,contentTitle:()=>a,default:()=>d,frontMatter:()=>i,metadata:()=>c,toc:()=>l});var r=t(24246),s=t(71670);const i={},a="Interface: GenerateKubeResult",c={id:"interfaces/GenerateKubeResult",title:"Interface: GenerateKubeResult",description:"The result containing a Kubernetes config files",source:"@site/api/interfaces/GenerateKubeResult.md",sourceDirName:"interfaces",slug:"/interfaces/GenerateKubeResult",permalink:"/api/interfaces/GenerateKubeResult",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"FileSystemWatcher",permalink:"/api/interfaces/FileSystemWatcher"},next:{title:"HealthCheckLog",permalink:"/api/interfaces/HealthCheckLog"}},o={},l=[{value:"Properties",id:"properties",level:2},{value:"yaml",id:"yaml",level:3},{value:"Defined in",id:"defined-in",level:4}];function u(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,r.jsxs)(r.Fragment,{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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L2117",children:"packages/extension-api/src/extension-api.d.ts:2117"})})]})}function d(e={}){const{wrapper:n}={...(0,s.a)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(u,{...e})}):u(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>c,a:()=>a});var r=t(27378);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([[40486],{41712:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>o,contentTitle:()=>a,default:()=>u,frontMatter:()=>i,metadata:()=>c,toc:()=>l});var r=t(24246),s=t(71670);const i={},a="Interface: GenerateKubeResult",c={id:"interfaces/GenerateKubeResult",title:"Interface: GenerateKubeResult",description:"The result containing a Kubernetes config files",source:"@site/api/interfaces/GenerateKubeResult.md",sourceDirName:"interfaces",slug:"/interfaces/GenerateKubeResult",permalink:"/api/interfaces/GenerateKubeResult",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"FileSystemWatcher",permalink:"/api/interfaces/FileSystemWatcher"},next:{title:"HealthCheckLog",permalink:"/api/interfaces/HealthCheckLog"}},o={},l=[{value:"Properties",id:"properties",level:2},{value:"yaml",id:"yaml",level:3},{value:"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",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,r.jsxs)(r.Fragment,{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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2117",children:"packages/extension-api/src/extension-api.d.ts:2117"})})]})}function u(e={}){const{wrapper:n}={...(0,s.a)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(d,{...e})}):d(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>c,a:()=>a});var r=t(27378);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.741b7b45.js b/assets/js/ed603d23.93d40f06.js similarity index 93% rename from assets/js/ed603d23.741b7b45.js rename to assets/js/ed603d23.93d40f06.js index 42c1935c391..cdd95c742ce 100644 --- a/assets/js/ed603d23.741b7b45.js +++ b/assets/js/ed603d23.93d40f06.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[73285],{16598:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>d,contentTitle:()=>a,default:()=>h,frontMatter:()=>i,metadata:()=>o,toc:()=>c});var t=r(24246),s=r(71670);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",hr:"hr",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"interface-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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L2132",children:"packages/extension-api/src/extension-api.d.ts:2132"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L2133",children:"packages/extension-api/src/extension-api.d.ts:2133"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L2134",children:"packages/extension-api/src/extension-api.d.ts:2134"})})]})}function h(e={}){const{wrapper:n}={...(0,s.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},71670:(e,n,r)=>{r.d(n,{Z:()=>o,a:()=>a});var t=r(27378);const s={},i=t.createContext(s);function a(e){const n=t.useContext(i);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function 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([[73285],{16598:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>d,contentTitle:()=>a,default:()=>h,frontMatter:()=>i,metadata:()=>o,toc:()=>c});var t=r(24246),s=r(71670);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",hr:"hr",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"interface-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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2132",children:"packages/extension-api/src/extension-api.d.ts:2132"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2133",children:"packages/extension-api/src/extension-api.d.ts:2133"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2134",children:"packages/extension-api/src/extension-api.d.ts:2134"})})]})}function h(e={}){const{wrapper:n}={...(0,s.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},71670:(e,n,r)=>{r.d(n,{Z:()=>o,a:()=>a});var t=r(27378);const s={},i=t.createContext(s);function a(e){const n=t.useContext(i);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function 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.90d1a8bd.js b/assets/js/edb40f78.3f9dc7e1.js similarity index 89% rename from assets/js/edb40f78.90d1a8bd.js rename to assets/js/edb40f78.3f9dc7e1.js index 812eba1f6a2..3b42cd079b8 100644 --- a/assets/js/edb40f78.90d1a8bd.js +++ b/assets/js/edb40f78.3f9dc7e1.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[54632],{5286:(e,r,n)=>{n.r(r),n.d(r,{assets:()=>c,contentTitle:()=>o,default:()=>l,frontMatter:()=>i,metadata:()=>a,toc:()=>d});var s=n(24246),t=n(71670);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"}},c={},d=[{value:"Type Parameters",id:"type-parameters",level:2},{value:"Methods",id:"methods",level:2},{value:"report()",id:"report",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Defined in",id:"defined-in",level:4}];function p(e){const r={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",p:"p",strong:"strong",...(0,t.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L1007",children:"packages/extension-api/src/extension-api.d.ts:1007"})})]})}function l(e={}){const{wrapper:r}={...(0,t.a)(),...e.components};return r?(0,s.jsx)(r,{...e,children:(0,s.jsx)(p,{...e})}):p(e)}},71670:(e,r,n)=>{n.d(r,{Z:()=>a,a:()=>o});var s=n(27378);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([[54632],{5286:(e,r,n)=>{n.r(r),n.d(r,{assets:()=>d,contentTitle:()=>o,default:()=>l,frontMatter:()=>i,metadata:()=>a,toc:()=>c});var s=n(24246),t=n(71670);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 p(e){const r={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",p:"p",strong:"strong",...(0,t.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L1007",children:"packages/extension-api/src/extension-api.d.ts:1007"})})]})}function l(e={}){const{wrapper:r}={...(0,t.a)(),...e.components};return r?(0,s.jsx)(r,{...e,children:(0,s.jsx)(p,{...e})}):p(e)}},71670:(e,r,n)=>{n.d(r,{Z:()=>a,a:()=>o});var s=n(27378);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.6b25b595.js b/assets/js/edcfca88.fa7bd258.js similarity index 74% rename from assets/js/edcfca88.6b25b595.js rename to assets/js/edcfca88.fa7bd258.js index 711c822c1ba..b3e7de4972d 100644 --- a/assets/js/edcfca88.6b25b595.js +++ b/assets/js/edcfca88.fa7bd258.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[41902],{1361:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>c,contentTitle:()=>d,default:()=>p,frontMatter:()=>a,metadata:()=>r,toc:()=>o});var s=i(24246),t=i(71670);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:"MemoryStats",permalink:"/api/interfaces/MemoryStats"}},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",hr:"hr",p:"p",strong:"strong",...(0,t.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"interface-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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L441",children:"packages/extension-api/src/extension-api.d.ts:441"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L442",children:"packages/extension-api/src/extension-api.d.ts:442"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L443",children:"packages/extension-api/src/extension-api.d.ts:443"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L455",children:"packages/extension-api/src/extension-api.d.ts:455"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L456",children:"packages/extension-api/src/extension-api.d.ts:456"})})]})}function p(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>r,a:()=>d});var s=i(27378);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([[41902],{1361:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>r,contentTitle:()=>a,default:()=>p,frontMatter:()=>d,metadata:()=>c,toc:()=>o});var s=i(24246),t=i(71670);const d={},a="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:"MemoryStats",permalink:"/api/interfaces/MemoryStats"}},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",hr:"hr",p:"p",strong:"strong",...(0,t.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"interface-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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L441",children:"packages/extension-api/src/extension-api.d.ts:441"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L442",children:"packages/extension-api/src/extension-api.d.ts:442"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L443",children:"packages/extension-api/src/extension-api.d.ts:443"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L455",children:"packages/extension-api/src/extension-api.d.ts:455"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L456",children:"packages/extension-api/src/extension-api.d.ts:456"})})]})}function p(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>c,a:()=>a});var s=i(27378);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 c(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/ef2e2003.13e78482.js b/assets/js/ef2e2003.13e78482.js deleted file mode 100644 index 53549b5357f..00000000000 --- a/assets/js/ef2e2003.13e78482.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[70586],{92169:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>c,contentTitle:()=>s,default:()=>p,frontMatter:()=>r,metadata:()=>o,toc:()=>d});var i=n(24246),a=n(71670);const r={},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"}},c={},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 t={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",p:"p",strong:"strong",...(0,a.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(t.h1,{id:"interface-imagefilesprovidermetadata",children:"Interface: ImageFilesProviderMetadata"}),"\n",(0,i.jsx)(t.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(t.h3,{id:"label",children:"label"}),"\n",(0,i.jsxs)(t.blockquote,{children:["\n",(0,i.jsxs)(t.p,{children:[(0,i.jsx)(t.code,{children:"readonly"})," ",(0,i.jsx)(t.strong,{children:"label"}),": ",(0,i.jsx)(t.code,{children:"string"})]}),"\n"]}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L806",children:"packages/extension-api/src/extension-api.d.ts:806"})})]})}function p(e={}){const{wrapper:t}={...(0,a.a)(),...e.components};return t?(0,i.jsx)(t,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},71670:(e,t,n)=>{n.d(t,{Z:()=>o,a:()=>s});var i=n(27378);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/ef2e2003.cd1ff3e5.js b/assets/js/ef2e2003.cd1ff3e5.js new file mode 100644 index 00000000000..da8c4497a77 --- /dev/null +++ b/assets/js/ef2e2003.cd1ff3e5.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[70586],{92169:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>d,contentTitle:()=>s,default:()=>p,frontMatter:()=>r,metadata:()=>o,toc:()=>c});var a=n(24246),i=n(71670);const r={},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",p:"p",strong:"strong",...(0,i.a)(),...e.components};return(0,a.jsxs)(a.Fragment,{children:[(0,a.jsx)(t.h1,{id:"interface-imagefilesprovidermetadata",children:"Interface: ImageFilesProviderMetadata"}),"\n",(0,a.jsx)(t.h2,{id:"properties",children:"Properties"}),"\n",(0,a.jsx)(t.h3,{id:"label",children:"label"}),"\n",(0,a.jsxs)(t.blockquote,{children:["\n",(0,a.jsxs)(t.p,{children:[(0,a.jsx)(t.code,{children:"readonly"})," ",(0,a.jsx)(t.strong,{children:"label"}),": ",(0,a.jsx)(t.code,{children:"string"})]}),"\n"]}),"\n",(0,a.jsx)(t.h4,{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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L806",children:"packages/extension-api/src/extension-api.d.ts:806"})})]})}function p(e={}){const{wrapper:t}={...(0,i.a)(),...e.components};return t?(0,a.jsx)(t,{...e,children:(0,a.jsx)(l,{...e})}):l(e)}},71670:(e,t,n)=>{n.d(t,{Z:()=>o,a:()=>s});var a=n(27378);const i={},r=a.createContext(i);function s(e){const t=a.useContext(r);return a.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function o(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:s(e.components),a.createElement(r.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/ef5945f7.4603f59f.js b/assets/js/ef5945f7.e8c59d51.js similarity index 86% rename from assets/js/ef5945f7.4603f59f.js rename to assets/js/ef5945f7.e8c59d51.js index 78d372d1c73..020a1aec425 100644 --- a/assets/js/ef5945f7.4603f59f.js +++ b/assets/js/ef5945f7.e8c59d51.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[63630],{12294:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>c,contentTitle:()=>o,default:()=>h,frontMatter:()=>r,metadata:()=>d,toc:()=>a});var s=i(24246),t=i(71670);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"}},c={},a=[{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 l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,t.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"interface-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/804b2198fda0957e1ecfb87539f019eb9b79a66f/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/804b2198fda0957e1ecfb87539f019eb9b79a66f/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/804b2198fda0957e1ecfb87539f019eb9b79a66f/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/804b2198fda0957e1ecfb87539f019eb9b79a66f/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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L199",children:"packages/extension-api/src/extension-api.d.ts:199"})})]})}function h(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>d,a:()=>o});var s=i(27378);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([[63630],{12294:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>c,contentTitle:()=>r,default:()=>h,frontMatter:()=>d,metadata:()=>o,toc:()=>a});var s=i(24246),t=i(71670);const d={},r="Interface: Extension",o={id:"interfaces/Extension",title:"Interface: Extension\\",description:"Represents an extension.",source:"@site/api/interfaces/Extension.md",sourceDirName:"interfaces",slug:"/interfaces/Extension",permalink:"/api/interfaces/Extension",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Event",permalink:"/api/interfaces/Event"},next:{title:"ExtensionContext",permalink:"/api/interfaces/ExtensionContext"}},c={},a=[{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 l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,t.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"interface-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/bd83a8b2bb8ab886dc757381b589638cbda150d0/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/bd83a8b2bb8ab886dc757381b589638cbda150d0/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/bd83a8b2bb8ab886dc757381b589638cbda150d0/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/bd83a8b2bb8ab886dc757381b589638cbda150d0/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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L199",children:"packages/extension-api/src/extension-api.d.ts:199"})})]})}function h(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>o,a:()=>r});var s=i(27378);const t={},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/f1ad83b2.4297dc3f.js b/assets/js/f1ad83b2.0ffa5752.js similarity index 94% rename from assets/js/f1ad83b2.4297dc3f.js rename to assets/js/f1ad83b2.0ffa5752.js index f0af7222fa0..8d1a54890be 100644 --- a/assets/js/f1ad83b2.4297dc3f.js +++ b/assets/js/f1ad83b2.0ffa5752.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[22182],{35522:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>c,contentTitle:()=>o,default:()=>p,frontMatter:()=>s,metadata:()=>d,toc:()=>a});var t=i(24246),r=i(71670);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",hr:"hr",p:"p",strong:"strong",...(0,r.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L464",children:"packages/extension-api/src/extension-api.d.ts:464"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L465",children:"packages/extension-api/src/extension-api.d.ts:465"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L463",children:"packages/extension-api/src/extension-api.d.ts:463"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L466",children:"packages/extension-api/src/extension-api.d.ts:466"})})]})}function p(e={}){const{wrapper:n}={...(0,r.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>d,a:()=>o});var t=i(27378);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([[22182],{35522:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>c,contentTitle:()=>o,default:()=>p,frontMatter:()=>s,metadata:()=>d,toc:()=>a});var t=i(24246),r=i(71670);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",hr:"hr",p:"p",strong:"strong",...(0,r.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L464",children:"packages/extension-api/src/extension-api.d.ts:464"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L465",children:"packages/extension-api/src/extension-api.d.ts:465"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L463",children:"packages/extension-api/src/extension-api.d.ts:463"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L466",children:"packages/extension-api/src/extension-api.d.ts:466"})})]})}function p(e={}){const{wrapper:n}={...(0,r.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>d,a:()=>o});var t=i(27378);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.a558de29.js b/assets/js/f20efc55.a558de29.js deleted file mode 100644 index 3866cf82227..00000000000 --- a/assets/js/f20efc55.a558de29.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[64438],{61688:(e,t,r)=>{r.r(t),r.d(t,{assets:()=>c,contentTitle:()=>s,default:()=>d,frontMatter:()=>n,metadata:()=>o,toc:()=>l});var a=r(24246),i=r(71670);const n={},s="Variable: StatusBarItemDefaultPriority",o={id:"variables/StatusBarItemDefaultPriority",title:"Variable: StatusBarItemDefaultPriority",description:"const StatusBarItemDefaultPriority: 0 = 0",source:"@site/api/variables/StatusBarItemDefaultPriority.md",sourceDirName:"variables",slug:"/variables/StatusBarItemDefaultPriority",permalink:"/api/variables/StatusBarItemDefaultPriority",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"StatusBarAlignRight",permalink:"/api/variables/StatusBarAlignRight"},next:{title:"version",permalink:"/api/variables/version"}},c={},l=[{value:"Defined in",id:"defined-in",level:2}];function u(e){const t={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,i.a)(),...e.components};return(0,a.jsxs)(a.Fragment,{children:[(0,a.jsx)(t.h1,{id:"variable-statusbaritemdefaultpriority",children:"Variable: StatusBarItemDefaultPriority"}),"\n",(0,a.jsxs)(t.blockquote,{children:["\n",(0,a.jsxs)(t.p,{children:[(0,a.jsx)(t.code,{children:"const"})," ",(0,a.jsx)(t.strong,{children:"StatusBarItemDefaultPriority"}),": ",(0,a.jsx)(t.code,{children:"0"})," = ",(0,a.jsx)(t.code,{children:"0"})]}),"\n"]}),"\n",(0,a.jsx)(t.p,{children:"Default priority for the status bar items."}),"\n",(0,a.jsx)(t.h2,{id:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L1475",children:"packages/extension-api/src/extension-api.d.ts:1475"})})]})}function d(e={}){const{wrapper:t}={...(0,i.a)(),...e.components};return t?(0,a.jsx)(t,{...e,children:(0,a.jsx)(u,{...e})}):u(e)}},71670:(e,t,r)=>{r.d(t,{Z:()=>o,a:()=>s});var a=r(27378);const i={},n=a.createContext(i);function s(e){const t=a.useContext(n);return a.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function o(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:s(e.components),a.createElement(n.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/f20efc55.d5fa13d4.js b/assets/js/f20efc55.d5fa13d4.js new file mode 100644 index 00000000000..4c4bee76e47 --- /dev/null +++ b/assets/js/f20efc55.d5fa13d4.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[64438],{61688:(t,e,r)=>{r.r(e),r.d(e,{assets:()=>c,contentTitle:()=>s,default:()=>d,frontMatter:()=>n,metadata:()=>o,toc:()=>l});var a=r(24246),i=r(71670);const n={},s="Variable: StatusBarItemDefaultPriority",o={id:"variables/StatusBarItemDefaultPriority",title:"Variable: StatusBarItemDefaultPriority",description:"const StatusBarItemDefaultPriority: 0 = 0",source:"@site/api/variables/StatusBarItemDefaultPriority.md",sourceDirName:"variables",slug:"/variables/StatusBarItemDefaultPriority",permalink:"/api/variables/StatusBarItemDefaultPriority",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"StatusBarAlignRight",permalink:"/api/variables/StatusBarAlignRight"},next:{title:"version",permalink:"/api/variables/version"}},c={},l=[{value:"Defined in",id:"defined-in",level:2}];function u(t){const e={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,i.a)(),...t.components};return(0,a.jsxs)(a.Fragment,{children:[(0,a.jsx)(e.h1,{id:"variable-statusbaritemdefaultpriority",children:"Variable: StatusBarItemDefaultPriority"}),"\n",(0,a.jsxs)(e.blockquote,{children:["\n",(0,a.jsxs)(e.p,{children:[(0,a.jsx)(e.code,{children:"const"})," ",(0,a.jsx)(e.strong,{children:"StatusBarItemDefaultPriority"}),": ",(0,a.jsx)(e.code,{children:"0"})," = ",(0,a.jsx)(e.code,{children:"0"})]}),"\n"]}),"\n",(0,a.jsx)(e.p,{children:"Default priority for the status bar items."}),"\n",(0,a.jsx)(e.h2,{id:"defined-in",children:"Defined in"}),"\n",(0,a.jsx)(e.p,{children:(0,a.jsx)(e.a,{href:"https://github.com/containers/podman-desktop/blob/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L1475",children:"packages/extension-api/src/extension-api.d.ts:1475"})})]})}function d(t={}){const{wrapper:e}={...(0,i.a)(),...t.components};return e?(0,a.jsx)(e,{...t,children:(0,a.jsx)(u,{...t})}):u(t)}},71670:(t,e,r)=>{r.d(e,{Z:()=>o,a:()=>s});var a=r(27378);const i={},n=a.createContext(i);function s(t){const e=a.useContext(n);return a.useMemo((function(){return"function"==typeof t?t(e):{...e,...t}}),[e,t])}function o(t){let e;return e=t.disableParentContext?"function"==typeof t.components?t.components(i):t.components||i:s(t.components),a.createElement(n.Provider,{value:e},t.children)}}}]); \ No newline at end of file diff --git a/assets/js/f27eaf88.67ac4b42.js b/assets/js/f27eaf88.808d6463.js similarity index 82% rename from assets/js/f27eaf88.67ac4b42.js rename to assets/js/f27eaf88.808d6463.js index 0ce4695f349..c621bb26dff 100644 --- a/assets/js/f27eaf88.67ac4b42.js +++ b/assets/js/f27eaf88.808d6463.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[75741],{13451:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>r,contentTitle:()=>o,default:()=>h,frontMatter:()=>a,metadata:()=>c,toc:()=>l});var i=t(24246),s=t(71670);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",hr:"hr",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"interface-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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L1062",children:"packages/extension-api/src/extension-api.d.ts:1062"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L1068",children:"packages/extension-api/src/extension-api.d.ts:1068"})})]})}function h(e={}){const{wrapper:n}={...(0,s.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(d,{...e})}):d(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>c,a:()=>o});var i=t(27378);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([[75741],{13451:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>r,contentTitle:()=>c,default:()=>h,frontMatter:()=>a,metadata:()=>o,toc:()=>l});var i=t(24246),s=t(71670);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",hr:"hr",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"interface-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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L1062",children:"packages/extension-api/src/extension-api.d.ts:1062"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L1068",children:"packages/extension-api/src/extension-api.d.ts:1068"})})]})}function h(e={}){const{wrapper:n}={...(0,s.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(d,{...e})}):d(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>o,a:()=>c});var i=t(27378);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.bc44af44.js b/assets/js/f4271232.e734fc44.js similarity index 95% rename from assets/js/f4271232.bc44af44.js rename to assets/js/f4271232.e734fc44.js index 444aaea4f20..d8e7555d3a7 100644 --- a/assets/js/f4271232.bc44af44.js +++ b/assets/js/f4271232.e734fc44.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[85799],{96745:(n,e,t)=>{t.r(e),t.d(e,{assets:()=>c,contentTitle:()=>s,default:()=>p,frontMatter:()=>o,metadata:()=>r,toc:()=>d});var i=t(24246),a=t(71670);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",p:"p",strong:"strong",...(0,a.a)(),...n.components};return(0,i.jsxs)(i.Fragment,{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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L4432",children:"packages/extension-api/src/extension-api.d.ts:4432"})})]})}function p(n={}){const{wrapper:e}={...(0,a.a)(),...n.components};return e?(0,i.jsx)(e,{...n,children:(0,i.jsx)(l,{...n})}):l(n)}},71670:(n,e,t)=>{t.d(e,{Z:()=>r,a:()=>s});var i=t(27378);const a={},o=i.createContext(a);function s(n){const e=i.useContext(o);return i.useMemo((function(){return"function"==typeof n?n(e):{...e,...n}}),[e,n])}function r(n){let e;return e=n.disableParentContext?"function"==typeof n.components?n.components(a):n.components||a:s(n.components),i.createElement(o.Provider,{value:e},n.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[85799],{96745:(n,e,t)=>{t.r(e),t.d(e,{assets:()=>c,contentTitle:()=>s,default:()=>p,frontMatter:()=>o,metadata:()=>r,toc:()=>d});var i=t(24246),a=t(71670);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",p:"p",strong:"strong",...(0,a.a)(),...n.components};return(0,i.jsxs)(i.Fragment,{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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L4432",children:"packages/extension-api/src/extension-api.d.ts:4432"})})]})}function p(n={}){const{wrapper:e}={...(0,a.a)(),...n.components};return e?(0,i.jsx)(e,{...n,children:(0,i.jsx)(l,{...n})}):l(n)}},71670:(n,e,t)=>{t.d(e,{Z:()=>r,a:()=>s});var i=t(27378);const a={},o=i.createContext(a);function s(n){const e=i.useContext(o);return i.useMemo((function(){return"function"==typeof n?n(e):{...e,...n}}),[e,n])}function r(n){let e;return e=n.disableParentContext?"function"==typeof n.components?n.components(a):n.components||a:s(n.components),i.createElement(o.Provider,{value:e},n.children)}}}]); \ No newline at end of file diff --git a/assets/js/f6cd0d3d.87186c51.js b/assets/js/f6cd0d3d.e1f9034a.js similarity index 83% rename from assets/js/f6cd0d3d.87186c51.js rename to assets/js/f6cd0d3d.e1f9034a.js index 1c92bd524aa..786dac31424 100644 --- a/assets/js/f6cd0d3d.87186c51.js +++ b/assets/js/f6cd0d3d.e1f9034a.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[75208],{15805:(e,r,n)=>{n.r(r),n.d(r,{assets:()=>c,contentTitle:()=>a,default:()=>p,frontMatter:()=>s,metadata:()=>d,toc:()=>o});var i=n(24246),t=n(71670);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",p:"p",strong:"strong",...(0,t.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L891",children:"packages/extension-api/src/extension-api.d.ts:891"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L892",children:"packages/extension-api/src/extension-api.d.ts:892"})})]})}function p(e={}){const{wrapper:r}={...(0,t.a)(),...e.components};return r?(0,i.jsx)(r,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},71670:(e,r,n)=>{n.d(r,{Z:()=>d,a:()=>a});var i=n(27378);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 +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[75208],{15805:(e,r,n)=>{n.r(r),n.d(r,{assets:()=>c,contentTitle:()=>d,default:()=>p,frontMatter:()=>s,metadata:()=>a,toc:()=>o});var i=n(24246),t=n(71670);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",p:"p",strong:"strong",...(0,t.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L891",children:"packages/extension-api/src/extension-api.d.ts:891"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L892",children:"packages/extension-api/src/extension-api.d.ts:892"})})]})}function p(e={}){const{wrapper:r}={...(0,t.a)(),...e.components};return r?(0,i.jsx)(r,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},71670:(e,r,n)=>{n.d(r,{Z:()=>a,a:()=>d});var i=n(27378);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 diff --git a/assets/js/f6cf66bc.6b16b70a.js b/assets/js/f6cf66bc.cd3f6748.js similarity index 98% rename from assets/js/f6cf66bc.6b16b70a.js rename to assets/js/f6cf66bc.cd3f6748.js index c71a4d58533..8d4cb8a242f 100644 --- a/assets/js/f6cf66bc.6b16b70a.js +++ b/assets/js/f6cf66bc.cd3f6748.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[65619],{44835:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>a,contentTitle:()=>c,default:()=>p,frontMatter:()=>r,metadata:()=>o,toc:()=>d});var i=s(24246),t=s(71670);const r={},c="Function: onDidUpdateKubeconfig()",o={id:"namespaces/kubernetes/functions/onDidUpdateKubeconfig",title:"Function: onDidUpdateKubeconfig()",description:"onDidUpdateKubeconfig(listener, thisArgs?, disposables?): Disposable",source:"@site/api/namespaces/kubernetes/functions/onDidUpdateKubeconfig.md",sourceDirName:"namespaces/kubernetes/functions",slug:"/namespaces/kubernetes/functions/onDidUpdateKubeconfig",permalink:"/api/namespaces/kubernetes/functions/onDidUpdateKubeconfig",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"getKubeconfig",permalink:"/api/namespaces/kubernetes/functions/getKubeconfig"},next:{title:"registerKubernetesGenerator",permalink:"/api/namespaces/kubernetes/functions/registerKubernetesGenerator"}},a={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Defined in",id:"defined-in",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,t.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"function-ondidupdatekubeconfig",children:"Function: onDidUpdateKubeconfig()"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"onDidUpdateKubeconfig"}),"(",(0,i.jsx)(n.code,{children:"listener"}),", ",(0,i.jsx)(n.code,{children:"thisArgs"}),"?, ",(0,i.jsx)(n.code,{children:"disposables"}),"?): ",(0,i.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(n.code,{children:"Disposable"})})]}),"\n"]}),"\n",(0,i.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"listener"})]}),"\n",(0,i.jsx)(n.p,{children:"The listener function will be called when the event happens."}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"thisArgs?"}),": ",(0,i.jsx)(n.code,{children:"any"})]}),"\n",(0,i.jsxs)(n.p,{children:["The ",(0,i.jsx)(n.code,{children:"this"}),"-argument which will be used when calling the event listener."]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"disposables?"}),": ",(0,i.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(n.code,{children:"Disposable"})}),"[]"]}),"\n",(0,i.jsxs)(n.p,{children:["An array to which a ",(0,i.jsx)(n.a,{href:"/api/classes/Disposable",children:"Disposable"})," will be added."]}),"\n",(0,i.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(n.code,{children:"Disposable"})})}),"\n",(0,i.jsx)(n.p,{children:"A disposable which unsubscribes the event listener."}),"\n",(0,i.jsx)(n.h2,{id:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L2083",children:"packages/extension-api/src/extension-api.d.ts:2083"})})]})}function p(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>o,a:()=>c});var i=s(27378);const t={},r=i.createContext(t);function c(e){const n=i.useContext(r);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:c(e.components),i.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[65619],{44835:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>a,contentTitle:()=>c,default:()=>p,frontMatter:()=>r,metadata:()=>o,toc:()=>d});var i=s(24246),t=s(71670);const r={},c="Function: onDidUpdateKubeconfig()",o={id:"namespaces/kubernetes/functions/onDidUpdateKubeconfig",title:"Function: onDidUpdateKubeconfig()",description:"onDidUpdateKubeconfig(listener, thisArgs?, disposables?): Disposable",source:"@site/api/namespaces/kubernetes/functions/onDidUpdateKubeconfig.md",sourceDirName:"namespaces/kubernetes/functions",slug:"/namespaces/kubernetes/functions/onDidUpdateKubeconfig",permalink:"/api/namespaces/kubernetes/functions/onDidUpdateKubeconfig",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"getKubeconfig",permalink:"/api/namespaces/kubernetes/functions/getKubeconfig"},next:{title:"registerKubernetesGenerator",permalink:"/api/namespaces/kubernetes/functions/registerKubernetesGenerator"}},a={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Defined in",id:"defined-in",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,t.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"function-ondidupdatekubeconfig",children:"Function: onDidUpdateKubeconfig()"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"onDidUpdateKubeconfig"}),"(",(0,i.jsx)(n.code,{children:"listener"}),", ",(0,i.jsx)(n.code,{children:"thisArgs"}),"?, ",(0,i.jsx)(n.code,{children:"disposables"}),"?): ",(0,i.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(n.code,{children:"Disposable"})})]}),"\n"]}),"\n",(0,i.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"listener"})]}),"\n",(0,i.jsx)(n.p,{children:"The listener function will be called when the event happens."}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"thisArgs?"}),": ",(0,i.jsx)(n.code,{children:"any"})]}),"\n",(0,i.jsxs)(n.p,{children:["The ",(0,i.jsx)(n.code,{children:"this"}),"-argument which will be used when calling the event listener."]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"disposables?"}),": ",(0,i.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(n.code,{children:"Disposable"})}),"[]"]}),"\n",(0,i.jsxs)(n.p,{children:["An array to which a ",(0,i.jsx)(n.a,{href:"/api/classes/Disposable",children:"Disposable"})," will be added."]}),"\n",(0,i.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(n.code,{children:"Disposable"})})}),"\n",(0,i.jsx)(n.p,{children:"A disposable which unsubscribes the event listener."}),"\n",(0,i.jsx)(n.h2,{id:"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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2083",children:"packages/extension-api/src/extension-api.d.ts:2083"})})]})}function p(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>o,a:()=>c});var i=s(27378);const t={},r=i.createContext(t);function c(e){const n=i.useContext(r);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:c(e.components),i.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/f7197f43.8f5aa3ed.js b/assets/js/f7197f43.7196feb1.js similarity index 84% rename from assets/js/f7197f43.8f5aa3ed.js rename to assets/js/f7197f43.7196feb1.js index a131787d562..c82656ffff0 100644 --- a/assets/js/f7197f43.8f5aa3ed.js +++ b/assets/js/f7197f43.7196feb1.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[56805],{3574:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>d,contentTitle:()=>l,default:()=>u,frontMatter:()=>i,metadata:()=>a,toc:()=>c});var t=s(24246),r=s(71670);const i={},l="Class: TelemetryTrustedValue",a={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",p:"p",strong:"strong",...(0,r.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L4125",children:"packages/extension-api/src/extension-api.d.ts:4125"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L4123",children:"packages/extension-api/src/extension-api.d.ts:4123"})})]})}function u(e={}){const{wrapper:n}={...(0,r.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(o,{...e})}):o(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>a,a:()=>l});var t=s(27378);const r={},i=t.createContext(r);function l(e){const n=t.useContext(i);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function a(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:l(e.components),t.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[56805],{3574:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>d,contentTitle:()=>a,default:()=>u,frontMatter:()=>i,metadata:()=>l,toc:()=>c});var t=s(24246),r=s(71670);const i={},a="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",p:"p",strong:"strong",...(0,r.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L4125",children:"packages/extension-api/src/extension-api.d.ts:4125"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L4123",children:"packages/extension-api/src/extension-api.d.ts:4123"})})]})}function u(e={}){const{wrapper:n}={...(0,r.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(o,{...e})}):o(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>l,a:()=>a});var t=s(27378);const r={},i=t.createContext(r);function a(e){const n=t.useContext(i);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function l(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:a(e.components),t.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/f771dec1.2b9a5779.js b/assets/js/f771dec1.bb084b60.js similarity index 95% rename from assets/js/f771dec1.2b9a5779.js rename to assets/js/f771dec1.bb084b60.js index 646abcd6001..4c3d3672abe 100644 --- a/assets/js/f771dec1.2b9a5779.js +++ b/assets/js/f771dec1.bb084b60.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[63863],{62842:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>l,contentTitle:()=>c,default:()=>p,frontMatter:()=>s,metadata:()=>r,toc:()=>a});var o=i(24246),t=i(71670);const s={},c="Function: createCliTool()",r={id:"namespaces/cli/functions/createCliTool",title:"Function: createCliTool()",description:"createCliTool(options): CliTool",source:"@site/api/namespaces/cli/functions/createCliTool.md",sourceDirName:"namespaces/cli/functions",slug:"/namespaces/cli/functions/createCliTool",permalink:"/api/namespaces/cli/functions/createCliTool",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"cli",permalink:"/api/namespaces/cli/"},next:{title:"commands",permalink:"/api/namespaces/commands/"}},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",p:"p",strong:"strong",...(0,t.a)(),...e.components};return(0,o.jsxs)(o.Fragment,{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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L4350",children:"packages/extension-api/src/extension-api.d.ts:4350"})})]})}function p(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(d,{...e})}):d(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>r,a:()=>c});var o=i(27378);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([[63863],{62842:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>l,contentTitle:()=>c,default:()=>p,frontMatter:()=>s,metadata:()=>r,toc:()=>a});var o=i(24246),t=i(71670);const s={},c="Function: createCliTool()",r={id:"namespaces/cli/functions/createCliTool",title:"Function: createCliTool()",description:"createCliTool(options): CliTool",source:"@site/api/namespaces/cli/functions/createCliTool.md",sourceDirName:"namespaces/cli/functions",slug:"/namespaces/cli/functions/createCliTool",permalink:"/api/namespaces/cli/functions/createCliTool",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"cli",permalink:"/api/namespaces/cli/"},next:{title:"commands",permalink:"/api/namespaces/commands/"}},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",p:"p",strong:"strong",...(0,t.a)(),...e.components};return(0,o.jsxs)(o.Fragment,{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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L4350",children:"packages/extension-api/src/extension-api.d.ts:4350"})})]})}function p(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(d,{...e})}):d(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>r,a:()=>c});var o=i(27378);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/f7c9e078.1fcc0214.js b/assets/js/f7c9e078.f8249261.js similarity index 79% rename from assets/js/f7c9e078.1fcc0214.js rename to assets/js/f7c9e078.f8249261.js index b237397d89b..d170229b0e7 100644 --- a/assets/js/f7c9e078.1fcc0214.js +++ b/assets/js/f7c9e078.f8249261.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[21364],{80487:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>o,default:()=>h,frontMatter:()=>s,metadata:()=>d,toc:()=>c});var i=t(24246),r=t(71670);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",hr:"hr",p:"p",strong:"strong",...(0,r.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"interface-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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L3140",children:"packages/extension-api/src/extension-api.d.ts:3140"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L3141",children:"packages/extension-api/src/extension-api.d.ts:3141"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/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,r.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>d,a:()=>o});var i=t(27378);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([[21364],{80487:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>d,default:()=>h,frontMatter:()=>s,metadata:()=>o,toc:()=>c});var i=t(24246),r=t(71670);const s={},d="Interface: ThrottlingData",o={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",hr:"hr",p:"p",strong:"strong",...(0,r.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"interface-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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L3140",children:"packages/extension-api/src/extension-api.d.ts:3140"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L3141",children:"packages/extension-api/src/extension-api.d.ts:3141"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"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/bd83a8b2bb8ab886dc757381b589638cbda150d0/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,r.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>o,a:()=>d});var i=t(27378);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 o(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 diff --git a/assets/js/f86eb50f.cfce530d.js b/assets/js/f86eb50f.c3767dfd.js similarity index 87% rename from assets/js/f86eb50f.cfce530d.js rename to assets/js/f86eb50f.c3767dfd.js index 90af23c5fd4..38f65c5fae0 100644 --- a/assets/js/f86eb50f.cfce530d.js +++ b/assets/js/f86eb50f.c3767dfd.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[48123],{5087:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>s,contentTitle:()=>c,default:()=>h,frontMatter:()=>o,metadata:()=>d,toc:()=>a});var r=i(24246),t=i(71670);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",hr:"hr",li:"li",p:"p",strong:"strong",ul:"ul",...(0,t.a)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.h1,{id:"interface-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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L478",children:"packages/extension-api/src/extension-api.d.ts:478"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L475",children:"packages/extension-api/src/extension-api.d.ts:475"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L484",children:"packages/extension-api/src/extension-api.d.ts:484"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L472",children:"packages/extension-api/src/extension-api.d.ts:472"})})]})}function h(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(l,{...e})}):l(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>d,a:()=>c});var r=i(27378);const t={},o=r.createContext(t);function c(e){const n=r.useContext(o);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function 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 +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[48123],{5087:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>s,contentTitle:()=>d,default:()=>h,frontMatter:()=>o,metadata:()=>c,toc:()=>a});var r=i(24246),t=i(71670);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",hr:"hr",li:"li",p:"p",strong:"strong",ul:"ul",...(0,t.a)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.h1,{id:"interface-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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L478",children:"packages/extension-api/src/extension-api.d.ts:478"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L475",children:"packages/extension-api/src/extension-api.d.ts:475"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L484",children:"packages/extension-api/src/extension-api.d.ts:484"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L472",children:"packages/extension-api/src/extension-api.d.ts:472"})})]})}function h(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(l,{...e})}):l(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>c,a:()=>d});var r=i(27378);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 diff --git a/assets/js/fb8cd692.b5b94ebb.js b/assets/js/fb8cd692.b5b94ebb.js new file mode 100644 index 00000000000..a69d756fb60 --- /dev/null +++ b/assets/js/fb8cd692.b5b94ebb.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[80511],{10252:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>r,contentTitle:()=>o,default:()=>h,frontMatter:()=>c,metadata:()=>l,toc:()=>a});var d=i(24246),s=i(71670);const c={},o="Interface: HostConfig",l={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"}},r={},a=[{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",hr:"hr",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,d.jsxs)(d.Fragment,{children:[(0,d.jsx)(n.h1,{id:"interface-hostconfig",children:"Interface: HostConfig"}),"\n",(0,d.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,d.jsx)(n.h3,{id:"autoremove",children:"AutoRemove?"}),"\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:"AutoRemove"}),": ",(0,d.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2410",children:"packages/extension-api/src/extension-api.d.ts:2410"})}),"\n",(0,d.jsx)(n.hr,{}),"\n",(0,d.jsx)(n.h3,{id:"binds",children:"Binds?"}),"\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:"Binds"}),": ",(0,d.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,d.jsx)(n.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,d.jsx)(n.p,{children:(0,d.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2411",children:"packages/extension-api/src/extension-api.d.ts:2411"})}),"\n",(0,d.jsx)(n.hr,{}),"\n",(0,d.jsx)(n.h3,{id:"blkiodevicereadbps",children:"BlkioDeviceReadBps?"}),"\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:"BlkioDeviceReadBps"}),": ",(0,d.jsx)(n.code,{children:"unknown"})]}),"\n"]}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2454",children:"packages/extension-api/src/extension-api.d.ts:2454"})}),"\n",(0,d.jsx)(n.hr,{}),"\n",(0,d.jsx)(n.h3,{id:"blkiodevicereadiops",children:"BlkioDeviceReadIOps?"}),"\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:"BlkioDeviceReadIOps"}),": ",(0,d.jsx)(n.code,{children:"unknown"})]}),"\n"]}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2456",children:"packages/extension-api/src/extension-api.d.ts:2456"})}),"\n",(0,d.jsx)(n.hr,{}),"\n",(0,d.jsx)(n.h3,{id:"blkiodevicewritebps",children:"BlkioDeviceWriteBps?"}),"\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:"BlkioDeviceWriteBps"}),": ",(0,d.jsx)(n.code,{children:"unknown"})]}),"\n"]}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2455",children:"packages/extension-api/src/extension-api.d.ts:2455"})}),"\n",(0,d.jsx)(n.hr,{}),"\n",(0,d.jsx)(n.h3,{id:"blkiodevicewriteiops",children:"BlkioDeviceWriteIOps?"}),"\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:"BlkioDeviceWriteIOps"}),": ",(0,d.jsx)(n.code,{children:"unknown"})]}),"\n"]}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2457",children:"packages/extension-api/src/extension-api.d.ts:2457"})}),"\n",(0,d.jsx)(n.hr,{}),"\n",(0,d.jsx)(n.h3,{id:"blkioweight",children:"BlkioWeight?"}),"\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:"BlkioWeight"}),": ",(0,d.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,d.jsx)(n.h4,{id:"defined-in-6",children:"Defined in"}),"\n",(0,d.jsx)(n.p,{children:(0,d.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2452",children:"packages/extension-api/src/extension-api.d.ts:2452"})}),"\n",(0,d.jsx)(n.hr,{}),"\n",(0,d.jsx)(n.h3,{id:"blkioweightdevice",children:"BlkioWeightDevice?"}),"\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:"BlkioWeightDevice"}),": ",(0,d.jsx)(n.code,{children:"unknown"})]}),"\n"]}),"\n",(0,d.jsx)(n.h4,{id:"defined-in-7",children:"Defined in"}),"\n",(0,d.jsx)(n.p,{children:(0,d.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2453",children:"packages/extension-api/src/extension-api.d.ts:2453"})}),"\n",(0,d.jsx)(n.hr,{}),"\n",(0,d.jsx)(n.h3,{id:"capadd",children:"CapAdd?"}),"\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:"CapAdd"}),": ",(0,d.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2423",children:"packages/extension-api/src/extension-api.d.ts:2423"})}),"\n",(0,d.jsx)(n.hr,{}),"\n",(0,d.jsx)(n.h3,{id:"capdrop",children:"CapDrop?"}),"\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:"CapDrop"}),": ",(0,d.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2424",children:"packages/extension-api/src/extension-api.d.ts:2424"})}),"\n",(0,d.jsx)(n.hr,{}),"\n",(0,d.jsx)(n.h3,{id:"cgroup",children:"Cgroup?"}),"\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:"Cgroup"}),": ",(0,d.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,d.jsx)(n.h4,{id:"defined-in-10",children:"Defined in"}),"\n",(0,d.jsx)(n.p,{children:(0,d.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2431",children:"packages/extension-api/src/extension-api.d.ts:2431"})}),"\n",(0,d.jsx)(n.hr,{}),"\n",(0,d.jsx)(n.h3,{id:"cgroupparent",children:"CgroupParent?"}),"\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:"CgroupParent"}),": ",(0,d.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,d.jsx)(n.h4,{id:"defined-in-11",children:"Defined in"}),"\n",(0,d.jsx)(n.p,{children:(0,d.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2451",children:"packages/extension-api/src/extension-api.d.ts:2451"})}),"\n",(0,d.jsx)(n.hr,{}),"\n",(0,d.jsx)(n.h3,{id:"consolesize",children:"ConsoleSize?"}),"\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:"ConsoleSize"}),": ",(0,d.jsx)(n.code,{children:"number"}),"[]"]}),"\n"]}),"\n",(0,d.jsx)(n.h4,{id:"defined-in-12",children:"Defined in"}),"\n",(0,d.jsx)(n.p,{children:(0,d.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2446",children:"packages/extension-api/src/extension-api.d.ts:2446"})}),"\n",(0,d.jsx)(n.hr,{}),"\n",(0,d.jsx)(n.h3,{id:"containeridfile",children:"ContainerIDFile?"}),"\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:"ContainerIDFile"}),": ",(0,d.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,d.jsx)(n.h4,{id:"defined-in-13",children:"Defined in"}),"\n",(0,d.jsx)(n.p,{children:(0,d.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2412",children:"packages/extension-api/src/extension-api.d.ts:2412"})}),"\n",(0,d.jsx)(n.hr,{}),"\n",(0,d.jsx)(n.h3,{id:"cpucount",children:"CpuCount?"}),"\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:"CpuCount"}),": ",(0,d.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,d.jsx)(n.h4,{id:"defined-in-14",children:"Defined in"}),"\n",(0,d.jsx)(n.p,{children:(0,d.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2476",children:"packages/extension-api/src/extension-api.d.ts:2476"})}),"\n",(0,d.jsx)(n.hr,{}),"\n",(0,d.jsx)(n.h3,{id:"cpupercent",children:"CpuPercent?"}),"\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:"CpuPercent"}),": ",(0,d.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,d.jsx)(n.h4,{id:"defined-in-15",children:"Defined in"}),"\n",(0,d.jsx)(n.p,{children:(0,d.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2477",children:"packages/extension-api/src/extension-api.d.ts:2477"})}),"\n",(0,d.jsx)(n.hr,{}),"\n",(0,d.jsx)(n.h3,{id:"cpuperiod",children:"CpuPeriod?"}),"\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:"CpuPeriod"}),": ",(0,d.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,d.jsx)(n.h4,{id:"defined-in-16",children:"Defined in"}),"\n",(0,d.jsx)(n.p,{children:(0,d.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2458",children:"packages/extension-api/src/extension-api.d.ts:2458"})}),"\n",(0,d.jsx)(n.hr,{}),"\n",(0,d.jsx)(n.h3,{id:"cpuquota",children:"CpuQuota?"}),"\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:"CpuQuota"}),": ",(0,d.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,d.jsx)(n.h4,{id:"defined-in-17",children:"Defined in"}),"\n",(0,d.jsx)(n.p,{children:(0,d.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2459",children:"packages/extension-api/src/extension-api.d.ts:2459"})}),"\n",(0,d.jsx)(n.hr,{}),"\n",(0,d.jsx)(n.h3,{id:"cpurealtimeperiod",children:"CpuRealtimePeriod?"}),"\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:"CpuRealtimePeriod"}),": ",(0,d.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,d.jsx)(n.h4,{id:"defined-in-18",children:"Defined in"}),"\n",(0,d.jsx)(n.p,{children:(0,d.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2478",children:"packages/extension-api/src/extension-api.d.ts:2478"})}),"\n",(0,d.jsx)(n.hr,{}),"\n",(0,d.jsx)(n.h3,{id:"cpurealtimeruntime",children:"CpuRealtimeRuntime?"}),"\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:"CpuRealtimeRuntime"}),": ",(0,d.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,d.jsx)(n.h4,{id:"defined-in-19",children:"Defined in"}),"\n",(0,d.jsx)(n.p,{children:(0,d.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2479",children:"packages/extension-api/src/extension-api.d.ts:2479"})}),"\n",(0,d.jsx)(n.hr,{}),"\n",(0,d.jsx)(n.h3,{id:"cpushares",children:"CpuShares?"}),"\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:"CpuShares"}),": ",(0,d.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,d.jsx)(n.h4,{id:"defined-in-20",children:"Defined in"}),"\n",(0,d.jsx)(n.p,{children:(0,d.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2450",children:"packages/extension-api/src/extension-api.d.ts:2450"})}),"\n",(0,d.jsx)(n.hr,{}),"\n",(0,d.jsx)(n.h3,{id:"cpusetcpus",children:"CpusetCpus?"}),"\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:"CpusetCpus"}),": ",(0,d.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,d.jsx)(n.h4,{id:"defined-in-21",children:"Defined in"}),"\n",(0,d.jsx)(n.p,{children:(0,d.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2460",children:"packages/extension-api/src/extension-api.d.ts:2460"})}),"\n",(0,d.jsx)(n.hr,{}),"\n",(0,d.jsx)(n.h3,{id:"cpusetmems",children:"CpusetMems?"}),"\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:"CpusetMems"}),": ",(0,d.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,d.jsx)(n.h4,{id:"defined-in-22",children:"Defined in"}),"\n",(0,d.jsx)(n.p,{children:(0,d.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2461",children:"packages/extension-api/src/extension-api.d.ts:2461"})}),"\n",(0,d.jsx)(n.hr,{}),"\n",(0,d.jsx)(n.h3,{id:"devicecgrouprules",children:"DeviceCgroupRules?"}),"\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:"DeviceCgroupRules"}),": ",(0,d.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,d.jsx)(n.h4,{id:"defined-in-23",children:"Defined in"}),"\n",(0,d.jsx)(n.p,{children:(0,d.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2463",children:"packages/extension-api/src/extension-api.d.ts:2463"})}),"\n",(0,d.jsx)(n.hr,{}),"\n",(0,d.jsx)(n.h3,{id:"devicerequests",children:"DeviceRequests?"}),"\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:"DeviceRequests"}),": ",(0,d.jsx)(n.a,{href:"/api/interfaces/DeviceRequest",children:(0,d.jsx)(n.code,{children:"DeviceRequest"})}),"[]"]}),"\n"]}),"\n",(0,d.jsx)(n.h4,{id:"defined-in-24",children:"Defined in"}),"\n",(0,d.jsx)(n.p,{children:(0,d.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2464",children:"packages/extension-api/src/extension-api.d.ts:2464"})}),"\n",(0,d.jsx)(n.hr,{}),"\n",(0,d.jsx)(n.h3,{id:"devices",children:"Devices?"}),"\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:"Devices"}),": ",(0,d.jsx)(n.code,{children:"unknown"})]}),"\n"]}),"\n",(0,d.jsx)(n.h4,{id:"defined-in-25",children:"Defined in"}),"\n",(0,d.jsx)(n.p,{children:(0,d.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2462",children:"packages/extension-api/src/extension-api.d.ts:2462"})}),"\n",(0,d.jsx)(n.hr,{}),"\n",(0,d.jsx)(n.h3,{id:"diskquota",children:"DiskQuota?"}),"\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:"DiskQuota"}),": ",(0,d.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,d.jsx)(n.h4,{id:"defined-in-26",children:"Defined in"}),"\n",(0,d.jsx)(n.p,{children:(0,d.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2465",children:"packages/extension-api/src/extension-api.d.ts:2465"})}),"\n",(0,d.jsx)(n.hr,{}),"\n",(0,d.jsx)(n.h3,{id:"dns",children:"Dns?"}),"\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:"Dns"}),": ",(0,d.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,d.jsx)(n.h4,{id:"defined-in-27",children:"Defined in"}),"\n",(0,d.jsx)(n.p,{children:(0,d.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2425",children:"packages/extension-api/src/extension-api.d.ts:2425"})}),"\n",(0,d.jsx)(n.hr,{}),"\n",(0,d.jsx)(n.h3,{id:"dnsoptions",children:"DnsOptions?"}),"\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:"DnsOptions"}),": ",(0,d.jsx)(n.code,{children:"unknown"}),"[]"]}),"\n"]}),"\n",(0,d.jsx)(n.h4,{id:"defined-in-28",children:"Defined in"}),"\n",(0,d.jsx)(n.p,{children:(0,d.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2426",children:"packages/extension-api/src/extension-api.d.ts:2426"})}),"\n",(0,d.jsx)(n.hr,{}),"\n",(0,d.jsx)(n.h3,{id:"dnssearch",children:"DnsSearch?"}),"\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:"DnsSearch"}),": ",(0,d.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,d.jsx)(n.h4,{id:"defined-in-29",children:"Defined in"}),"\n",(0,d.jsx)(n.p,{children:(0,d.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2427",children:"packages/extension-api/src/extension-api.d.ts:2427"})}),"\n",(0,d.jsx)(n.hr,{}),"\n",(0,d.jsx)(n.h3,{id:"extrahosts",children:"ExtraHosts?"}),"\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:"ExtraHosts"}),": ",(0,d.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,d.jsx)(n.h4,{id:"defined-in-30",children:"Defined in"}),"\n",(0,d.jsx)(n.p,{children:(0,d.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2428",children:"packages/extension-api/src/extension-api.d.ts:2428"})}),"\n",(0,d.jsx)(n.hr,{}),"\n",(0,d.jsx)(n.h3,{id:"groupadd",children:"GroupAdd?"}),"\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:"GroupAdd"}),": ",(0,d.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,d.jsx)(n.h4,{id:"defined-in-31",children:"Defined in"}),"\n",(0,d.jsx)(n.p,{children:(0,d.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2429",children:"packages/extension-api/src/extension-api.d.ts:2429"})}),"\n",(0,d.jsx)(n.hr,{}),"\n",(0,d.jsx)(n.h3,{id:"init",children:"Init?"}),"\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:"Init"}),": ",(0,d.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,d.jsx)(n.h4,{id:"defined-in-32",children:"Defined in"}),"\n",(0,d.jsx)(n.p,{children:(0,d.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2473",children:"packages/extension-api/src/extension-api.d.ts:2473"})}),"\n",(0,d.jsx)(n.hr,{}),"\n",(0,d.jsx)(n.h3,{id:"ipcmode",children:"IpcMode?"}),"\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:"IpcMode"}),": ",(0,d.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,d.jsx)(n.h4,{id:"defined-in-33",children:"Defined in"}),"\n",(0,d.jsx)(n.p,{children:(0,d.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2430",children:"packages/extension-api/src/extension-api.d.ts:2430"})}),"\n",(0,d.jsx)(n.hr,{}),"\n",(0,d.jsx)(n.h3,{id:"isolation",children:"Isolation?"}),"\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:"Isolation"}),": ",(0,d.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,d.jsx)(n.h4,{id:"defined-in-34",children:"Defined in"}),"\n",(0,d.jsx)(n.p,{children:(0,d.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2447",children:"packages/extension-api/src/extension-api.d.ts:2447"})}),"\n",(0,d.jsx)(n.hr,{}),"\n",(0,d.jsx)(n.h3,{id:"kernelmemory",children:"KernelMemory?"}),"\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:"KernelMemory"}),": ",(0,d.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,d.jsx)(n.h4,{id:"defined-in-35",children:"Defined in"}),"\n",(0,d.jsx)(n.p,{children:(0,d.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2466",children:"packages/extension-api/src/extension-api.d.ts:2466"})}),"\n",(0,d.jsx)(n.hr,{}),"\n",(0,d.jsx)(n.h3,{id:"links",children:"Links?"}),"\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:"Links"}),": ",(0,d.jsx)(n.code,{children:"unknown"})]}),"\n"]}),"\n",(0,d.jsx)(n.h4,{id:"defined-in-36",children:"Defined in"}),"\n",(0,d.jsx)(n.p,{children:(0,d.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2432",children:"packages/extension-api/src/extension-api.d.ts:2432"})}),"\n",(0,d.jsx)(n.hr,{}),"\n",(0,d.jsx)(n.h3,{id:"logconfig",children:"LogConfig?"}),"\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:"LogConfig"}),": ",(0,d.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,d.jsx)(n.h4,{id:"config",children:"Config"}),"\n",(0,d.jsxs)(n.blockquote,{children:["\n",(0,d.jsxs)(n.p,{children:[(0,d.jsx)(n.strong,{children:"Config"}),": ",(0,d.jsx)(n.code,{children:"unknown"})]}),"\n"]}),"\n",(0,d.jsx)(n.h4,{id:"type",children:"Type"}),"\n",(0,d.jsxs)(n.blockquote,{children:["\n",(0,d.jsxs)(n.p,{children:[(0,d.jsx)(n.strong,{children:"Type"}),": ",(0,d.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,d.jsx)(n.h4,{id:"defined-in-37",children:"Defined in"}),"\n",(0,d.jsx)(n.p,{children:(0,d.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2413",children:"packages/extension-api/src/extension-api.d.ts:2413"})}),"\n",(0,d.jsx)(n.hr,{}),"\n",(0,d.jsx)(n.h3,{id:"maskedpaths",children:"MaskedPaths?"}),"\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:"MaskedPaths"}),": ",(0,d.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,d.jsx)(n.h4,{id:"defined-in-38",children:"Defined in"}),"\n",(0,d.jsx)(n.p,{children:(0,d.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2448",children:"packages/extension-api/src/extension-api.d.ts:2448"})}),"\n",(0,d.jsx)(n.hr,{}),"\n",(0,d.jsx)(n.h3,{id:"memory",children:"Memory?"}),"\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:"Memory"}),": ",(0,d.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,d.jsx)(n.h4,{id:"defined-in-39",children:"Defined in"}),"\n",(0,d.jsx)(n.p,{children:(0,d.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2467",children:"packages/extension-api/src/extension-api.d.ts:2467"})}),"\n",(0,d.jsx)(n.hr,{}),"\n",(0,d.jsx)(n.h3,{id:"memoryreservation",children:"MemoryReservation?"}),"\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:"MemoryReservation"}),": ",(0,d.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,d.jsx)(n.h4,{id:"defined-in-40",children:"Defined in"}),"\n",(0,d.jsx)(n.p,{children:(0,d.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2468",children:"packages/extension-api/src/extension-api.d.ts:2468"})}),"\n",(0,d.jsx)(n.hr,{}),"\n",(0,d.jsx)(n.h3,{id:"memoryswap",children:"MemorySwap?"}),"\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:"MemorySwap"}),": ",(0,d.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,d.jsx)(n.h4,{id:"defined-in-41",children:"Defined in"}),"\n",(0,d.jsx)(n.p,{children:(0,d.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2469",children:"packages/extension-api/src/extension-api.d.ts:2469"})}),"\n",(0,d.jsx)(n.hr,{}),"\n",(0,d.jsx)(n.h3,{id:"memoryswappiness",children:"MemorySwappiness?"}),"\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:"MemorySwappiness"}),": ",(0,d.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,d.jsx)(n.h4,{id:"defined-in-42",children:"Defined in"}),"\n",(0,d.jsx)(n.p,{children:(0,d.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2470",children:"packages/extension-api/src/extension-api.d.ts:2470"})}),"\n",(0,d.jsx)(n.hr,{}),"\n",(0,d.jsx)(n.h3,{id:"mounts",children:"Mounts?"}),"\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:"Mounts"}),": ",(0,d.jsx)(n.a,{href:"/api/type-aliases/MountConfig",children:(0,d.jsx)(n.code,{children:"MountConfig"})})]}),"\n"]}),"\n",(0,d.jsx)(n.h4,{id:"defined-in-43",children:"Defined in"}),"\n",(0,d.jsx)(n.p,{children:(0,d.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2422",children:"packages/extension-api/src/extension-api.d.ts:2422"})}),"\n",(0,d.jsx)(n.hr,{}),"\n",(0,d.jsx)(n.h3,{id:"nanocpus",children:"NanoCpus?"}),"\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:"NanoCpus"}),": ",(0,d.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,d.jsx)(n.h4,{id:"defined-in-44",children:"Defined in"}),"\n",(0,d.jsx)(n.p,{children:(0,d.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2471",children:"packages/extension-api/src/extension-api.d.ts:2471"})}),"\n",(0,d.jsx)(n.hr,{}),"\n",(0,d.jsx)(n.h3,{id:"networkmode",children:"NetworkMode?"}),"\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:"NetworkMode"}),": ",(0,d.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,d.jsx)(n.h4,{id:"defined-in-45",children:"Defined in"}),"\n",(0,d.jsx)(n.p,{children:(0,d.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2417",children:"packages/extension-api/src/extension-api.d.ts:2417"})}),"\n",(0,d.jsx)(n.hr,{}),"\n",(0,d.jsx)(n.h3,{id:"oomkilldisable",children:"OomKillDisable?"}),"\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:"OomKillDisable"}),": ",(0,d.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,d.jsx)(n.h4,{id:"defined-in-46",children:"Defined in"}),"\n",(0,d.jsx)(n.p,{children:(0,d.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2472",children:"packages/extension-api/src/extension-api.d.ts:2472"})}),"\n",(0,d.jsx)(n.hr,{}),"\n",(0,d.jsx)(n.h3,{id:"oomscoreadj",children:"OomScoreAdj?"}),"\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:"OomScoreAdj"}),": ",(0,d.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,d.jsx)(n.h4,{id:"defined-in-47",children:"Defined in"}),"\n",(0,d.jsx)(n.p,{children:(0,d.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2433",children:"packages/extension-api/src/extension-api.d.ts:2433"})}),"\n",(0,d.jsx)(n.hr,{}),"\n",(0,d.jsx)(n.h3,{id:"pidmode",children:"PidMode?"}),"\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:"PidMode"}),": ",(0,d.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,d.jsx)(n.h4,{id:"defined-in-48",children:"Defined in"}),"\n",(0,d.jsx)(n.p,{children:(0,d.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2434",children:"packages/extension-api/src/extension-api.d.ts:2434"})}),"\n",(0,d.jsx)(n.hr,{}),"\n",(0,d.jsx)(n.h3,{id:"pidslimit",children:"PidsLimit?"}),"\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:"PidsLimit"}),": ",(0,d.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,d.jsx)(n.h4,{id:"defined-in-49",children:"Defined in"}),"\n",(0,d.jsx)(n.p,{children:(0,d.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2474",children:"packages/extension-api/src/extension-api.d.ts:2474"})}),"\n",(0,d.jsx)(n.hr,{}),"\n",(0,d.jsx)(n.h3,{id:"portbindings",children:"PortBindings?"}),"\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:"PortBindings"}),": ",(0,d.jsx)(n.code,{children:"unknown"})]}),"\n"]}),"\n",(0,d.jsx)(n.h4,{id:"defined-in-50",children:"Defined in"}),"\n",(0,d.jsx)(n.p,{children:(0,d.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2418",children:"packages/extension-api/src/extension-api.d.ts:2418"})}),"\n",(0,d.jsx)(n.hr,{}),"\n",(0,d.jsx)(n.h3,{id:"privileged",children:"Privileged?"}),"\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:"Privileged"}),": ",(0,d.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,d.jsx)(n.h4,{id:"defined-in-51",children:"Defined in"}),"\n",(0,d.jsx)(n.p,{children:(0,d.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2435",children:"packages/extension-api/src/extension-api.d.ts:2435"})}),"\n",(0,d.jsx)(n.hr,{}),"\n",(0,d.jsx)(n.h3,{id:"publishallports",children:"PublishAllPorts?"}),"\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:"PublishAllPorts"}),": ",(0,d.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,d.jsx)(n.h4,{id:"defined-in-52",children:"Defined in"}),"\n",(0,d.jsx)(n.p,{children:(0,d.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2436",children:"packages/extension-api/src/extension-api.d.ts:2436"})}),"\n",(0,d.jsx)(n.hr,{}),"\n",(0,d.jsx)(n.h3,{id:"readonlypaths",children:"ReadonlyPaths?"}),"\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:"ReadonlyPaths"}),": ",(0,d.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,d.jsx)(n.h4,{id:"defined-in-53",children:"Defined in"}),"\n",(0,d.jsx)(n.p,{children:(0,d.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2449",children:"packages/extension-api/src/extension-api.d.ts:2449"})}),"\n",(0,d.jsx)(n.hr,{}),"\n",(0,d.jsx)(n.h3,{id:"readonlyrootfs",children:"ReadonlyRootfs?"}),"\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:"ReadonlyRootfs"}),": ",(0,d.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,d.jsx)(n.h4,{id:"defined-in-54",children:"Defined in"}),"\n",(0,d.jsx)(n.p,{children:(0,d.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2437",children:"packages/extension-api/src/extension-api.d.ts:2437"})}),"\n",(0,d.jsx)(n.hr,{}),"\n",(0,d.jsx)(n.h3,{id:"restartpolicy",children:"RestartPolicy?"}),"\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:"RestartPolicy"}),": ",(0,d.jsx)(n.a,{href:"/api/interfaces/HostRestartPolicy",children:(0,d.jsx)(n.code,{children:"HostRestartPolicy"})})]}),"\n"]}),"\n",(0,d.jsx)(n.h4,{id:"defined-in-55",children:"Defined in"}),"\n",(0,d.jsx)(n.p,{children:(0,d.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2419",children:"packages/extension-api/src/extension-api.d.ts:2419"})}),"\n",(0,d.jsx)(n.hr,{}),"\n",(0,d.jsx)(n.h3,{id:"runtime",children:"Runtime?"}),"\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:"Runtime"}),": ",(0,d.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,d.jsx)(n.h4,{id:"defined-in-56",children:"Defined in"}),"\n",(0,d.jsx)(n.p,{children:(0,d.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2445",children:"packages/extension-api/src/extension-api.d.ts:2445"})}),"\n",(0,d.jsx)(n.hr,{}),"\n",(0,d.jsx)(n.h3,{id:"securityopt",children:"SecurityOpt?"}),"\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:"SecurityOpt"}),": ",(0,d.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,d.jsx)(n.h4,{id:"defined-in-57",children:"Defined in"}),"\n",(0,d.jsx)(n.p,{children:(0,d.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2438",children:"packages/extension-api/src/extension-api.d.ts:2438"})}),"\n",(0,d.jsx)(n.hr,{}),"\n",(0,d.jsx)(n.h3,{id:"shmsize",children:"ShmSize?"}),"\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:"ShmSize"}),": ",(0,d.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,d.jsx)(n.h4,{id:"defined-in-58",children:"Defined in"}),"\n",(0,d.jsx)(n.p,{children:(0,d.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2443",children:"packages/extension-api/src/extension-api.d.ts:2443"})}),"\n",(0,d.jsx)(n.hr,{}),"\n",(0,d.jsx)(n.h3,{id:"storageopt",children:"StorageOpt?"}),"\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:"StorageOpt"}),": ",(0,d.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,d.jsx)(n.h4,{id:"index-signature",children:"Index Signature"}),"\n",(0,d.jsxs)(n.p,{children:["[",(0,d.jsx)(n.code,{children:"option"}),": ",(0,d.jsx)(n.code,{children:"string"}),"]: ",(0,d.jsx)(n.code,{children:"string"})]}),"\n",(0,d.jsx)(n.h4,{id:"defined-in-59",children:"Defined in"}),"\n",(0,d.jsx)(n.p,{children:(0,d.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2439",children:"packages/extension-api/src/extension-api.d.ts:2439"})}),"\n",(0,d.jsx)(n.hr,{}),"\n",(0,d.jsx)(n.h3,{id:"sysctls",children:"Sysctls?"}),"\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:"Sysctls"}),": ",(0,d.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,d.jsx)(n.h4,{id:"index-signature-1",children:"Index Signature"}),"\n",(0,d.jsxs)(n.p,{children:["[",(0,d.jsx)(n.code,{children:"index"}),": ",(0,d.jsx)(n.code,{children:"string"}),"]: ",(0,d.jsx)(n.code,{children:"string"})]}),"\n",(0,d.jsx)(n.h4,{id:"defined-in-60",children:"Defined in"}),"\n",(0,d.jsx)(n.p,{children:(0,d.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2444",children:"packages/extension-api/src/extension-api.d.ts:2444"})}),"\n",(0,d.jsx)(n.hr,{}),"\n",(0,d.jsx)(n.h3,{id:"tmpfs",children:"Tmpfs?"}),"\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:"Tmpfs"}),": ",(0,d.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,d.jsx)(n.h4,{id:"index-signature-2",children:"Index Signature"}),"\n",(0,d.jsxs)(n.p,{children:["[",(0,d.jsx)(n.code,{children:"dir"}),": ",(0,d.jsx)(n.code,{children:"string"}),"]: ",(0,d.jsx)(n.code,{children:"string"})]}),"\n",(0,d.jsx)(n.h4,{id:"defined-in-61",children:"Defined in"}),"\n",(0,d.jsx)(n.p,{children:(0,d.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2440",children:"packages/extension-api/src/extension-api.d.ts:2440"})}),"\n",(0,d.jsx)(n.hr,{}),"\n",(0,d.jsx)(n.h3,{id:"utsmode",children:"UTSMode?"}),"\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:"UTSMode"}),": ",(0,d.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,d.jsx)(n.h4,{id:"defined-in-62",children:"Defined in"}),"\n",(0,d.jsx)(n.p,{children:(0,d.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2441",children:"packages/extension-api/src/extension-api.d.ts:2441"})}),"\n",(0,d.jsx)(n.hr,{}),"\n",(0,d.jsx)(n.h3,{id:"ulimits",children:"Ulimits?"}),"\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:"Ulimits"}),": ",(0,d.jsx)(n.code,{children:"unknown"})]}),"\n"]}),"\n",(0,d.jsx)(n.h4,{id:"defined-in-63",children:"Defined in"}),"\n",(0,d.jsx)(n.p,{children:(0,d.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2475",children:"packages/extension-api/src/extension-api.d.ts:2475"})}),"\n",(0,d.jsx)(n.hr,{}),"\n",(0,d.jsx)(n.h3,{id:"usernsmode",children:"UsernsMode?"}),"\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:"UsernsMode"}),": ",(0,d.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,d.jsx)(n.h4,{id:"defined-in-64",children:"Defined in"}),"\n",(0,d.jsx)(n.p,{children:(0,d.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2442",children:"packages/extension-api/src/extension-api.d.ts:2442"})}),"\n",(0,d.jsx)(n.hr,{}),"\n",(0,d.jsx)(n.h3,{id:"volumedriver",children:"VolumeDriver?"}),"\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:"VolumeDriver"}),": ",(0,d.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,d.jsx)(n.h4,{id:"defined-in-65",children:"Defined in"}),"\n",(0,d.jsx)(n.p,{children:(0,d.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2420",children:"packages/extension-api/src/extension-api.d.ts:2420"})}),"\n",(0,d.jsx)(n.hr,{}),"\n",(0,d.jsx)(n.h3,{id:"volumesfrom",children:"VolumesFrom?"}),"\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:"VolumesFrom"}),": ",(0,d.jsx)(n.code,{children:"unknown"})]}),"\n"]}),"\n",(0,d.jsx)(n.h4,{id:"defined-in-66",children:"Defined in"}),"\n",(0,d.jsx)(n.p,{children:(0,d.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L2421",children:"packages/extension-api/src/extension-api.d.ts:2421"})})]})}function h(e={}){const{wrapper:n}={...(0,s.a)(),...e.components};return n?(0,d.jsx)(n,{...e,children:(0,d.jsx)(t,{...e})}):t(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>l,a:()=>o});var d=i(27378);const s={},c=d.createContext(s);function o(e){const n=d.useContext(c);return d.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(s):e.components||s:o(e.components),d.createElement(c.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/fb8cd692.cc770f20.js b/assets/js/fb8cd692.cc770f20.js deleted file mode 100644 index 20dd020c6c1..00000000000 --- a/assets/js/fb8cd692.cc770f20.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[80511],{10252:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>r,contentTitle:()=>c,default:()=>h,frontMatter:()=>o,metadata:()=>l,toc:()=>t});var s=i(24246),d=i(71670);const o={},c="Interface: HostConfig",l={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"}},r={},t=[{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 a(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,d.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L2410",children:"packages/extension-api/src/extension-api.d.ts:2410"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L2411",children:"packages/extension-api/src/extension-api.d.ts:2411"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/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:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/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:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/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:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/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:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/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:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/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:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/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:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/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:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/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:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/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:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/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:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L2412",children:"packages/extension-api/src/extension-api.d.ts:2412"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/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:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/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:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/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:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/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:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/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:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/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:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/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:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/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:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/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:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/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:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/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:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/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:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/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:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/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:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L2426",children:"packages/extension-api/src/extension-api.d.ts:2426"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L2427",children:"packages/extension-api/src/extension-api.d.ts:2427"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L2428",children:"packages/extension-api/src/extension-api.d.ts:2428"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L2429",children:"packages/extension-api/src/extension-api.d.ts:2429"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/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:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/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:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/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:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/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:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/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:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/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:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/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:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/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:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/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:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/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:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/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:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/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:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/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:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L2417",children:"packages/extension-api/src/extension-api.d.ts:2417"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/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:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/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:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L2434",children:"packages/extension-api/src/extension-api.d.ts:2434"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/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:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L2418",children:"packages/extension-api/src/extension-api.d.ts:2418"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L2435",children:"packages/extension-api/src/extension-api.d.ts:2435"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L2436",children:"packages/extension-api/src/extension-api.d.ts:2436"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/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:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/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:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L2419",children:"packages/extension-api/src/extension-api.d.ts:2419"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/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:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/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:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/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:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/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:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/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:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/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:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L2441",children:"packages/extension-api/src/extension-api.d.ts:2441"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/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:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/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:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L2420",children:"packages/extension-api/src/extension-api.d.ts:2420"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L2421",children:"packages/extension-api/src/extension-api.d.ts:2421"})})]})}function h(e={}){const{wrapper:n}={...(0,d.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(a,{...e})}):a(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>l,a:()=>c});var s=i(27378);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 l(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 diff --git a/assets/js/fbfd390f.1f4cef1d.js b/assets/js/fbfd390f.12bbc1b5.js similarity index 94% rename from assets/js/fbfd390f.1f4cef1d.js rename to assets/js/fbfd390f.12bbc1b5.js index 6947e5976f7..7591e009172 100644 --- a/assets/js/fbfd390f.1f4cef1d.js +++ b/assets/js/fbfd390f.12bbc1b5.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[95921],{27916:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>d,contentTitle:()=>c,default:()=>l,frontMatter:()=>s,metadata:()=>o,toc:()=>a});var i=n(24246),r=n(71670);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",p:"p",strong:"strong",...(0,r.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(t.h1,{id:"interface-auditresult",children:"Interface: AuditResult"}),"\n",(0,i.jsx)(t.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(t.h3,{id:"records",children:"records"}),"\n",(0,i.jsxs)(t.blockquote,{children:["\n",(0,i.jsxs)(t.p,{children:[(0,i.jsx)(t.strong,{children:"records"}),": ",(0,i.jsx)(t.a,{href:"/api/interfaces/AuditRecord",children:(0,i.jsx)(t.code,{children:"AuditRecord"})}),"[]"]}),"\n"]}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L499",children:"packages/extension-api/src/extension-api.d.ts:499"})})]})}function l(e={}){const{wrapper:t}={...(0,r.a)(),...e.components};return t?(0,i.jsx)(t,{...e,children:(0,i.jsx)(u,{...e})}):u(e)}},71670:(e,t,n)=>{n.d(t,{Z:()=>o,a:()=>c});var i=n(27378);const r={},s=i.createContext(r);function c(e){const t=i.useContext(s);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(r):e.components||r:c(e.components),i.createElement(s.Provider,{value:t},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[95921],{27916:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>d,contentTitle:()=>c,default:()=>l,frontMatter:()=>s,metadata:()=>o,toc:()=>a});var i=n(24246),r=n(71670);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",p:"p",strong:"strong",...(0,r.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(t.h1,{id:"interface-auditresult",children:"Interface: AuditResult"}),"\n",(0,i.jsx)(t.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(t.h3,{id:"records",children:"records"}),"\n",(0,i.jsxs)(t.blockquote,{children:["\n",(0,i.jsxs)(t.p,{children:[(0,i.jsx)(t.strong,{children:"records"}),": ",(0,i.jsx)(t.a,{href:"/api/interfaces/AuditRecord",children:(0,i.jsx)(t.code,{children:"AuditRecord"})}),"[]"]}),"\n"]}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L499",children:"packages/extension-api/src/extension-api.d.ts:499"})})]})}function l(e={}){const{wrapper:t}={...(0,r.a)(),...e.components};return t?(0,i.jsx)(t,{...e,children:(0,i.jsx)(u,{...e})}):u(e)}},71670:(e,t,n)=>{n.d(t,{Z:()=>o,a:()=>c});var i=n(27378);const r={},s=i.createContext(r);function c(e){const t=i.useContext(s);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(r):e.components||r:c(e.components),i.createElement(s.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/fc923f19.665091cd.js b/assets/js/fc923f19.5e145a28.js similarity index 86% rename from assets/js/fc923f19.665091cd.js rename to assets/js/fc923f19.5e145a28.js index cc19cb03e8f..c1f76603ccd 100644 --- a/assets/js/fc923f19.665091cd.js +++ b/assets/js/fc923f19.5e145a28.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[73177],{96868:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>o,contentTitle:()=>c,default:()=>h,frontMatter:()=>t,metadata:()=>d,toc:()=>a});var s=i(24246),r=i(71670);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"}},o={},a=[{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 l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,r.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"interface-imagecheck",children:"Interface: ImageCheck"}),"\n",(0,s.jsx)(n.p,{children:"a specific error/recommendation found during an image check"}),"\n",(0,s.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,s.jsx)(n.h3,{id:"markdowndescription",children:"markdownDescription?"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"optional"})," ",(0,s.jsx)(n.strong,{children:"markdownDescription"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"full description of the error/recommendation"}),"\n",(0,s.jsx)(n.h4,{id:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/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:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L4360",children:"packages/extension-api/src/extension-api.d.ts:4360"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L4368",children:"packages/extension-api/src/extension-api.d.ts:4368"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L4364",children:"packages/extension-api/src/extension-api.d.ts:4364"})})]})}function h(e={}){const{wrapper:n}={...(0,r.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>d,a:()=>c});var s=i(27378);const r={},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([[73177],{96868:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>a,contentTitle:()=>c,default:()=>h,frontMatter:()=>t,metadata:()=>d,toc:()=>o});var s=i(24246),r=i(71670);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 l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,r.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"interface-imagecheck",children:"Interface: ImageCheck"}),"\n",(0,s.jsx)(n.p,{children:"a specific error/recommendation found during an image check"}),"\n",(0,s.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,s.jsx)(n.h3,{id:"markdowndescription",children:"markdownDescription?"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"optional"})," ",(0,s.jsx)(n.strong,{children:"markdownDescription"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"full description of the error/recommendation"}),"\n",(0,s.jsx)(n.h4,{id:"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/bd83a8b2bb8ab886dc757381b589638cbda150d0/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:"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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L4360",children:"packages/extension-api/src/extension-api.d.ts:4360"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L4368",children:"packages/extension-api/src/extension-api.d.ts:4368"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L4364",children:"packages/extension-api/src/extension-api.d.ts:4364"})})]})}function h(e={}){const{wrapper:n}={...(0,r.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>d,a:()=>c});var s=i(27378);const r={},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.33b57c17.js b/assets/js/fd702dc7.60bd357b.js similarity index 95% rename from assets/js/fd702dc7.33b57c17.js rename to assets/js/fd702dc7.60bd357b.js index 67b65b283d9..024a0ac15fa 100644 --- a/assets/js/fd702dc7.33b57c17.js +++ b/assets/js/fd702dc7.60bd357b.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[57694],{71523:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>r,default:()=>p,frontMatter:()=>i,metadata:()=>c,toc:()=>l});var s=t(24246),o=t(71670);const i={},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",p:"p",strong:"strong",...(0,o.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L1671",children:"packages/extension-api/src/extension-api.d.ts:1671"})})]})}function p(e={}){const{wrapper:n}={...(0,o.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(d,{...e})}):d(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>c,a:()=>r});var s=t(27378);const o={},i=s.createContext(o);function r(e){const n=s.useContext(i);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:r(e.components),s.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[57694],{71523:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>r,default:()=>p,frontMatter:()=>i,metadata:()=>c,toc:()=>l});var s=t(24246),o=t(71670);const i={},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",p:"p",strong:"strong",...(0,o.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L1671",children:"packages/extension-api/src/extension-api.d.ts:1671"})})]})}function p(e={}){const{wrapper:n}={...(0,o.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(d,{...e})}):d(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>c,a:()=>r});var s=t(27378);const o={},i=s.createContext(o);function r(e){const n=s.useContext(i);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:r(e.components),s.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/fe1a05e2.8e39e5ed.js b/assets/js/fe1a05e2.3c583c03.js similarity index 96% rename from assets/js/fe1a05e2.8e39e5ed.js rename to assets/js/fe1a05e2.3c583c03.js index 89025d638e8..0e844afa662 100644 --- a/assets/js/fe1a05e2.8e39e5ed.js +++ b/assets/js/fe1a05e2.3c583c03.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[70900],{64243:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>c,contentTitle:()=>o,default:()=>p,frontMatter:()=>i,metadata:()=>a,toc:()=>d});var t=r(24246),s=r(71670);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",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L927",children:"packages/extension-api/src/extension-api.d.ts:927"})})]})}function p(e={}){const{wrapper:n}={...(0,s.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},71670:(e,n,r)=>{r.d(n,{Z:()=>a,a:()=>o});var t=r(27378);const s={},i=t.createContext(s);function o(e){const n=t.useContext(i);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function 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([[70900],{64243:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>c,contentTitle:()=>o,default:()=>p,frontMatter:()=>i,metadata:()=>a,toc:()=>d});var t=r(24246),s=r(71670);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",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L927",children:"packages/extension-api/src/extension-api.d.ts:927"})})]})}function p(e={}){const{wrapper:n}={...(0,s.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},71670:(e,n,r)=>{r.d(n,{Z:()=>a,a:()=>o});var t=r(27378);const s={},i=t.createContext(s);function o(e){const n=t.useContext(i);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function 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.b4c2db27.js b/assets/js/fe716911.6e7318c0.js similarity index 82% rename from assets/js/fe716911.b4c2db27.js rename to assets/js/fe716911.6e7318c0.js index 02918e2ebbc..e42a02a6667 100644 --- a/assets/js/fe716911.b4c2db27.js +++ b/assets/js/fe716911.6e7318c0.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[33940],{71774:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>r,contentTitle:()=>d,default:()=>h,frontMatter:()=>t,metadata:()=>o,toc:()=>a});var s=i(24246),c=i(71670);const t={},d="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",hr:"hr",p:"p",strong:"strong",...(0,c.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"interface-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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L525",children:"packages/extension-api/src/extension-api.d.ts:525"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L527",children:"packages/extension-api/src/extension-api.d.ts:527"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L526",children:"packages/extension-api/src/extension-api.d.ts:526"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L528",children:"packages/extension-api/src/extension-api.d.ts:528"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L524",children:"packages/extension-api/src/extension-api.d.ts:524"})})]})}function h(e={}){const{wrapper:n}={...(0,c.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>o,a:()=>d});var s=i(27378);const c={},t=s.createContext(c);function d(e){const n=s.useContext(t);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(c):e.components||c:d(e.components),s.createElement(t.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[33940],{71774:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>r,contentTitle:()=>t,default:()=>h,frontMatter:()=>d,metadata:()=>o,toc:()=>a});var s=i(24246),c=i(71670);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",hr:"hr",p:"p",strong:"strong",...(0,c.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"interface-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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L525",children:"packages/extension-api/src/extension-api.d.ts:525"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L527",children:"packages/extension-api/src/extension-api.d.ts:527"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L526",children:"packages/extension-api/src/extension-api.d.ts:526"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L528",children:"packages/extension-api/src/extension-api.d.ts:528"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L524",children:"packages/extension-api/src/extension-api.d.ts:524"})})]})}function h(e={}){const{wrapper:n}={...(0,c.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>o,a:()=>t});var s=i(27378);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.010c7fc5.js b/assets/js/fee0a0be.f6dbbeae.js similarity index 84% rename from assets/js/fee0a0be.010c7fc5.js rename to assets/js/fee0a0be.f6dbbeae.js index f5a7ed59d0a..eebf9dfc403 100644 --- a/assets/js/fee0a0be.010c7fc5.js +++ b/assets/js/fee0a0be.f6dbbeae.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[81580],{76926:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>c,contentTitle:()=>o,default:()=>h,frontMatter:()=>r,metadata:()=>t,toc:()=>a});var s=i(24246),d=i(71670);const r={},o="Interface: ContainerEngineInfo",t={id:"interfaces/ContainerEngineInfo",title:"Interface: ContainerEngineInfo",description:"Resources information about a container engine",source:"@site/api/interfaces/ContainerEngineInfo.md",sourceDirName:"interfaces",slug:"/interfaces/ContainerEngineInfo",permalink:"/api/interfaces/ContainerEngineInfo",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"ContainerCreateResult",permalink:"/api/interfaces/ContainerCreateResult"},next:{title:"ContainerInfo",permalink:"/api/interfaces/ContainerInfo"}},c={},a=[{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",hr:"hr",p:"p",strong:"strong",...(0,d.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"interface-containerengineinfo",children:"Interface: ContainerEngineInfo"}),"\n",(0,s.jsx)(n.p,{children:"Resources information about a container engine"}),"\n",(0,s.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,s.jsx)(n.h3,{id:"cpuidle",children:"cpuIdle?"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"optional"})," ",(0,s.jsx)(n.strong,{children:"cpuIdle"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Percentage of idle CPUs (for Podman engines only)"}),"\n",(0,s.jsx)(n.h4,{id:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L3361",children:"packages/extension-api/src/extension-api.d.ts:3361"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L3357",children:"packages/extension-api/src/extension-api.d.ts:3357"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/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:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/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:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L3345",children:"packages/extension-api/src/extension-api.d.ts:3345"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L3349",children:"packages/extension-api/src/extension-api.d.ts:3349"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L3353",children:"packages/extension-api/src/extension-api.d.ts:3353"})}),"\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/804b2198fda0957e1ecfb87539f019eb9b79a66f/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:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L3369",children:"packages/extension-api/src/extension-api.d.ts:3369"})})]})}function h(e={}){const{wrapper:n}={...(0,d.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>t,a:()=>o});var s=i(27378);const 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 t(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([[81580],{76926:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>t,contentTitle:()=>o,default:()=>h,frontMatter:()=>r,metadata:()=>c,toc:()=>a});var s=i(24246),d=i(71670);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"}},t={},a=[{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",hr:"hr",p:"p",strong:"strong",...(0,d.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"interface-containerengineinfo",children:"Interface: ContainerEngineInfo"}),"\n",(0,s.jsx)(n.p,{children:"Resources information about a container engine"}),"\n",(0,s.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,s.jsx)(n.h3,{id:"cpuidle",children:"cpuIdle?"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"optional"})," ",(0,s.jsx)(n.strong,{children:"cpuIdle"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Percentage of idle CPUs (for Podman engines only)"}),"\n",(0,s.jsx)(n.h4,{id:"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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L3361",children:"packages/extension-api/src/extension-api.d.ts:3361"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L3357",children:"packages/extension-api/src/extension-api.d.ts:3357"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/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:"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/bd83a8b2bb8ab886dc757381b589638cbda150d0/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:"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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L3345",children:"packages/extension-api/src/extension-api.d.ts:3345"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L3349",children:"packages/extension-api/src/extension-api.d.ts:3349"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L3353",children:"packages/extension-api/src/extension-api.d.ts:3353"})}),"\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/bd83a8b2bb8ab886dc757381b589638cbda150d0/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:"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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L3369",children:"packages/extension-api/src/extension-api.d.ts:3369"})})]})}function h(e={}){const{wrapper:n}={...(0,d.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>c,a:()=>o});var s=i(27378);const 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/ff2f63f6.b31c5438.js b/assets/js/ff2f63f6.df5e14e9.js similarity index 97% rename from assets/js/ff2f63f6.b31c5438.js rename to assets/js/ff2f63f6.df5e14e9.js index debc043c00c..82b55230e9e 100644 --- a/assets/js/ff2f63f6.b31c5438.js +++ b/assets/js/ff2f63f6.df5e14e9.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[68097],{832:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>o,contentTitle:()=>i,default:()=>l,frontMatter:()=>s,metadata:()=>c,toc:()=>d});var r=n(24246),a=n(71670);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",p:"p",strong:"strong",...(0,a.a)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(t.h1,{id:"interface-secretstoragechangeevent",children:"Interface: SecretStorageChangeEvent"}),"\n",(0,r.jsx)(t.p,{children:"The event data that is fired when a secret is added or removed."}),"\n",(0,r.jsx)(t.h2,{id:"properties",children:"Properties"}),"\n",(0,r.jsx)(t.h3,{id:"key",children:"key"}),"\n",(0,r.jsxs)(t.blockquote,{children:["\n",(0,r.jsxs)(t.p,{children:[(0,r.jsx)(t.code,{children:"readonly"})," ",(0,r.jsx)(t.strong,{children:"key"}),": ",(0,r.jsx)(t.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(t.p,{children:"The key of the secret that has changed."}),"\n",(0,r.jsx)(t.h4,{id:"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/804b2198fda0957e1ecfb87539f019eb9b79a66f/packages/extension-api/src/extension-api.d.ts#L4486",children:"packages/extension-api/src/extension-api.d.ts:4486"})})]})}function l(e={}){const{wrapper:t}={...(0,a.a)(),...e.components};return t?(0,r.jsx)(t,{...e,children:(0,r.jsx)(h,{...e})}):h(e)}},71670:(e,t,n)=>{n.d(t,{Z:()=>c,a:()=>i});var r=n(27378);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([[68097],{832:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>o,contentTitle:()=>i,default:()=>l,frontMatter:()=>s,metadata:()=>c,toc:()=>d});var r=n(24246),a=n(71670);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",p:"p",strong:"strong",...(0,a.a)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(t.h1,{id:"interface-secretstoragechangeevent",children:"Interface: SecretStorageChangeEvent"}),"\n",(0,r.jsx)(t.p,{children:"The event data that is fired when a secret is added or removed."}),"\n",(0,r.jsx)(t.h2,{id:"properties",children:"Properties"}),"\n",(0,r.jsx)(t.h3,{id:"key",children:"key"}),"\n",(0,r.jsxs)(t.blockquote,{children:["\n",(0,r.jsxs)(t.p,{children:[(0,r.jsx)(t.code,{children:"readonly"})," ",(0,r.jsx)(t.strong,{children:"key"}),": ",(0,r.jsx)(t.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(t.p,{children:"The key of the secret that has changed."}),"\n",(0,r.jsx)(t.h4,{id:"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/bd83a8b2bb8ab886dc757381b589638cbda150d0/packages/extension-api/src/extension-api.d.ts#L4486",children:"packages/extension-api/src/extension-api.d.ts:4486"})})]})}function l(e={}){const{wrapper:t}={...(0,a.a)(),...e.components};return t?(0,r.jsx)(t,{...e,children:(0,r.jsx)(h,{...e})}):h(e)}},71670:(e,t,n)=>{n.d(t,{Z:()=>c,a:()=>i});var r=n(27378);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.792d8e60.js b/assets/js/runtime~main.a74149b2.js similarity index 66% rename from assets/js/runtime~main.792d8e60.js rename to assets/js/runtime~main.a74149b2.js index e2fb4215f7d..7328eea2382 100644 --- a/assets/js/runtime~main.792d8e60.js +++ b/assets/js/runtime~main.a74149b2.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/"+({125:"814d49b7",272:"aca8b082",523:"a0323d9f",648:"714e70d1",728:"6eb49eac",745:"64abd3af",822:"a00af9f0",886:"7aa856d6",899:"b985118d",955:"39ae3791",1074:"9e8f4e9c",1516:"8abd0ba5",1782:"97a89ac0",1837:"dec87402",1868:"46b3c144",2193:"c5b2f0f9",2281:"920c2ac2",2353:"92d7df62",2408:"78b70dba",2866:"e064f6d4",2883:"bb6a5560",3102:"3462068c",3207:"6603ef13",3342:"d1c21237",3408:"3ba80b69",3537:"3819c331",3584:"ed75cfcb",3614:"3b68f98c",3667:"b6d76a6c",3745:"3109d9d2",3879:"2d629ea6",3954:"898514b1",3984:"160cb329",4004:"a334b453",4117:"fd684bd6",4220:"2bbe04e6",4459:"19eded63",4918:"24bda87b",4929:"330dfcdb",5240:"22de4147",5414:"724f3974",5417:"5e8fbcdf",5477:"164937d2",5674:"5c0f0993",5697:"e35d7c3e",5886:"57dba496",6082:"3866940b",6098:"cb0f21df",6102:"8677f412",6125:"reactPlayerSoundCloud",6266:"a2c6f402",6639:"8ccdb99f",6642:"c15d9823",7371:"786fee93",7377:"708d858d",7809:"07305c4a",8039:"927c84a6",8335:"ca6c9efa",9055:"e7923b27",9973:"4213e5b1",10014:"30a9912a",10038:"bc873533",10114:"e665718d",10138:"6269f1c0",10239:"3a4a1d3a",10261:"reactPlayerKaltura",10347:"bc816bf2",10379:"a943bcee",10485:"8873cf50",10579:"d46ef83d",10588:"7afa6340",10717:"adb00d9a",11077:"49d9416a",11121:"8e49e0b0",11161:"a4794f2e",11648:"4bdb36b8",11724:"5087625a",11981:"b799648a",12121:"reactPlayerFacebook",12323:"6c80b6fe",12864:"e7477a94",13239:"bd45720e",13317:"d83f208d",13573:"be228752",13751:"3720c009",13826:"01a1d0f4",13893:"a847366a",14026:"9c540f0b",14077:"40d377be",14142:"17d2ebc8",14499:"73f18a6f",14824:"06a27da2",15150:"732d4d9b",15554:"1dfee34e",15980:"a7456010",16311:"c25913f3",16467:"878aa0e7",16696:"6477cdc2",16728:"d9407a00",16855:"b7bb2d93",17194:"9f2f2cb3",17285:"c1ca9e21",17329:"04a546a4",17708:"688ee267",17741:"7d88b63f",18518:"a7bd4aaa",18649:"49a2e93c",18768:"524ce9a0",18880:"deccabf3",19043:"473de3ed",19093:"0029a336",19204:"db320b4a",19282:"0433ef30",19536:"0e72c11a",19537:"c1584a80",19841:"d9b4ee1e",20044:"d66cbd9e",20138:"54590fd2",20205:"2340b3ee",20406:"67386898",20873:"cabda5f8",21046:"4cb6c19a",21181:"ea3ffc82",21360:"9286a297",21364:"f7c9e078",21534:"8ae04122",22182:"f1ad83b2",22228:"125d93c1",22978:"7e93d479",23427:"bd80aa65",23493:"00e9d6a1",23840:"562ca3e9",23937:"610f2c47",24260:"22e2140b",24386:"ae79aff5",24483:"9542c76a",24498:"7bef3f04",24726:"280646e4",24787:"a9bc0f5d",24904:"9d887a11",25204:"33f367df",25211:"d496897e",25314:"ab69fe56",25817:"70e3b13c",25821:"b9a87183",26011:"reactPlayerFilePlayer",26116:"52ea62e7",26348:"c104141c",26557:"5e486140",26690:"4816649b",27104:"35dda5a2",27135:"5e30269e",27168:"4ec4c6cd",27177:"4f9e8711",27222:"38f19abb",27268:"57a8015d",27328:"423842d7",27910:"c358ebbc",27918:"17896441",28143:"7e2ae3df",28145:"006e489c",28263:"82170cf7",28437:"5b10a003",28682:"8eeedb31",28813:"5fb93fc0",29112:"c09ab32f",29234:"86f8c256",29579:"09b168a7",29661:"5e95c892",29693:"123a454a",30060:"0547cb65",30466:"0e3a398f",30720:"5ebdf64d",30821:"aba485c2",30901:"ae4a775b",31004:"c141421f",31402:"0341d436",31512:"7fa133e1",31824:"4f35c7a7",32360:"7d3ae564",32472:"65a10ffa",33067:"62e21724",33124:"330b5684",33233:"59a6f192",33279:"456c0e28",33356:"54d805e4",33629:"aba21aa0",33940:"fe716911",34322:"69c5f318",34479:"0c14b239",34617:"95366386",34770:"450c2e30",34884:"e1c8d71f",35137:"41b2e801",35281:"8cb0269b",35425:"b4df9b48",35572:"6774f806",35584:"b52d840d",36006:"79f18c88",36075:"86e64757",36101:"e73930cf",36248:"e3f28bf9",36325:"c9cac9d9",36424:"a3002291",36955:"30997935",37073:"0f54081d",37245:"b678a236",37437:"3d8d8999",37573:"48b6ff5f",37683:"df2a6e58",37698:"cd23aec9",37836:"7cde3c49",37918:"10ce918d",38056:"905702d2",38134:"1515c895",38684:"815c93fd",38780:"f26f8f05",38943:"10210328",39613:"1fbe0675",39620:"b51a9aee",39684:"25d1f3de",40070:"86f2a982",40486:"ed2a4846",40569:"8519c2b0",40592:"b39cdcf9",40683:"3e2b82eb",40816:"4d71dffe",41169:"a2d1ff94",41619:"6494b798",41644:"9db962b6",41798:"bd65ec7e",41869:"c361d244",41902:"edcfca88",41976:"0c4fad6b",42205:"b66ca8cf",42326:"7b477840",42423:"91008145",43010:"56c3a9b2",43163:"232c546d",43274:"23a8e291",43474:"db22fd17",43546:"57e01cd5",43582:"016e89ec",43871:"065365b3",44031:"f81c1134",44422:"416d4fcf",44619:"a9fa5b1f",44654:"c0c3bda5",44781:"12f1535e",44958:"080a9824",45033:"9af13eab",45326:"af231220",45346:"7f0476bd",45603:"1e582a71",45708:"97d49594",45835:"7547d3bb",45974:"46cf64bb",46103:"ccc49370",46623:"b104dd1e",46738:"8dbb6800",47389:"612345e6",47596:"reactPlayerDailyMotion",47604:"ffbee6a9",47679:"83245ae6",47718:"6864e844",47875:"021eaa84",48123:"f86eb50f",48176:"5660752d",48215:"1cfced13",48610:"6875c492",48901:"640277b9",48926:"60c82955",49076:"494e8e75",49867:"44287967",50649:"512fbd77",51051:"107d77e6",51171:"7e5a2776",51320:"46669adc",51499:"180d0c5f",51796:"4f9d299b",51843:"a2ffcc0f",51978:"fe0d4a0f",52343:"97c7db18",52525:"1a906644",52535:"814f3328",52546:"reactPlayerStreamable",52920:"e0277333",52950:"67eba1be",53237:"1df93b7f",53273:"cc922df3",53479:"883e2c3c",53604:"cd7fa15a",53608:"9e4087bc",53691:"7be672a3",53800:"97eb992d",54063:"0fa6e9bf",54184:"16ce7fd2",54194:"1d31e443",54373:"b5114993",54632:"edb40f78",54774:"42b67a8e",55904:"931e3b0a",56805:"f7197f43",56843:"9f97f9d1",56870:"5a3b561f",57138:"38a042e4",57321:"92b08985",57366:"75281220",57368:"6e30ac7b",57549:"bdb8b81b",57694:"fd702dc7",57881:"2658ced2",58216:"874690d0",58262:"059d1c6a",58673:"d9673b17",58739:"7a957b04",58792:"5db8318c",58800:"e6fb1369",58989:"d4bf7e47",59081:"5a7aef43",59186:"74c26f41",59208:"36994c47",59341:"a35cf155",59671:"0e384e19",59860:"d1163e47",59875:"d7ed6ffb",60203:"c6aad055",60334:"a3f8794a",60564:"8b4ba22f",60574:"14ae68e7",60637:"91392348",60810:"254d0ff5",61021:"901c37e5",61110:"f16d562f",61281:"e983a6d7",61305:"73f9658e",61425:"fc8a94e3",61476:"a33d13d7",61573:"87a5fc8a",61866:"1369aff7",61896:"25622900",62283:"74b658de",62325:"d1462701",62789:"c239db97",62871:"604e05e4",63154:"c6346fcf",63190:"e546fc5a",63407:"b8ec852b",63630:"ef5945f7",63652:"6e92edd9",63707:"8c6c72f9",63773:"ed1f6062",63863:"f771dec1",64013:"01a85c17",64088:"0058b4c6",64258:"reactPlayerMux",64315:"16914cba",64389:"d739767a",64438:"f20efc55",64439:"reactPlayerYouTube",64471:"cfdfe126",64651:"94f3d131",64891:"a30c0d44",65144:"1ee92283",65181:"3f29ba7c",65191:"d103759a",65248:"6101b3fc",65375:"97615df2",65431:"2ab17a83",65619:"f6cf66bc",65776:"f0e3a130",66e3:"95646edb",66112:"2f8f53cb",66362:"28d80fa9",66464:"adcef0a2",66521:"014457dd",66743:"9684f8b7",67363:"583db3ef",67411:"b15eeff9",67480:"eb17771c",67539:"5c25e6fa",67690:"030ccfd9",67966:"0dd9aaeb",68059:"ca165b51",68097:"ff2f63f6",68732:"3132913e",68811:"3289a752",68888:"reactPlayerVidyard",68974:"8a864d1e",69006:"a08dfa31",69584:"b8eb0fce",69783:"7144043e",70225:"e1a2ab10",70534:"4b8121dd",70586:"ef2e2003",70595:"24dadce3",70633:"1fc83a28",70900:"fe1a05e2",70985:"814402d7",71426:"382e0557",71625:"de311ed4",71781:"fe9a92c0",71796:"64134c03",71874:"cc6d9416",71970:"adfdec4a",72079:"1a16e8bf",72092:"148448cb",72179:"34767260",72303:"f644aac7",72491:"c71cae97",72896:"abc85917",72931:"e6c31e60",72996:"7a21ccb0",73163:"cd343213",73177:"fc923f19",73285:"ed603d23",73636:"8b4dd820",73714:"894e67a6",73743:"reactPlayerVimeo",73867:"c7cac05f",74340:"2bb2c1cd",74961:"4c5becac",74996:"d83404a8",75167:"5046ea8f",75208:"f6cd0d3d",75247:"3c39daba",75273:"e69dadab",75290:"bf11c6a2",75542:"0102eb3e",75689:"c544b2d7",75697:"b7746a44",75741:"f27eaf88",75809:"8be8ac58",75862:"ada86621",76091:"19e69ccd",76158:"51e516cc",76192:"64bd32f2",76267:"94324b0e",76357:"591f7a5f",76518:"9dd60997",76932:"aaabcfd8",76952:"70bd0abb",77060:"7c7a772e",77319:"67fccd64",77401:"ca1234c1",77673:"10091836",77683:"01821883",77911:"b2973dc4",78127:"c2e1e282",78327:"360dc931",78416:"4b66c45e",78514:"d651e2ee",79106:"d4840880",79268:"c8eb055e",79649:"5bc09a53",80161:"3f66023b",80325:"98ced590",80355:"b5b19789",80448:"49bee2be",80511:"fb8cd692",80900:"4ec76dfa",80945:"df322e14",80954:"8c8ef21f",80957:"91a39dd0",81145:"e84cabb0",81580:"fee0a0be",81900:"4c217c25",81922:"d178b2c6",82144:"09788c0c",82163:"c813bd67",82323:"23b35f70",82388:"bbf561d5",82409:"df4d464e",82424:"b6be2912",82451:"fb50ea3a",82667:"368cce37",83039:"825ec378",83050:"4780c642",83152:"33a21d7d",83672:"8785b74d",83687:"8ca0e442",83870:"5df556a2",83945:"9f90a44b",83973:"f523fb3f",84006:"d5f6644b",84413:"fff8aeb8",84507:"6aa0b043",84513:"6763d4e0",84573:"f9fb4395",84667:"reactPlayerMixcloud",84940:"c11c87f7",84960:"b3b7dd16",85210:"1949cc8d",85376:"c44aa824",85632:"3f797343",85714:"0cab2b3a",85799:"f4271232",86112:"5b7d9ef2",86216:"reactPlayerTwitch",86258:"a0c37fdd",86272:"7500e360",86335:"271ff0d1",86477:"a38d285e",86528:"2cb13d6d",86535:"2f7d01f7",86661:"43be69c9",87213:"0877aebd",87664:"reactPlayerPreview",87759:"ff38b1ce",88055:"reactPlayerWistia",88089:"6eafe0c7",88566:"9dce5486",89251:"b9287eb6",89338:"8fe4c488",89372:"07f59c2a",89472:"5a9a7a02",89626:"81e486a8",89731:"9d2d4743",89799:"4f425ff4",89950:"12eb386e",90051:"185c52e7",90125:"7d9edfb8",90522:"308aae28",90681:"cdf64ea9",91447:"4974f5d2",91721:"3a38a610",91893:"871ce139",92045:"e6163b65",92217:"d7fbbe43",92423:"7258860f",92428:"9a22c80d",92514:"b5ec5208",92599:"e44de27e",92786:"81b69ac7",92916:"91fe1403",92955:"e6412603",92958:"86063cd3",93089:"a6aa9e1f",93300:"fa5f999e",93401:"c2865a15",93690:"f431c910",94331:"e38c422a",94368:"a94703ab",95921:"fbfd390f",96017:"6a1fe514",96120:"35300761",96514:"a826efc5",96915:"da802cf4",96987:"caddb1c0",97002:"a7777682",97159:"a8ce95ee",97227:"71748509",97251:"ba5b9f11",97288:"1c93995d",97355:"56a9df4f",97393:"acecf23e",97767:"17612ae7",97920:"1a4e3797",97953:"e88443f3",98170:"bab44fba",98532:"d1b15a6d",98960:"6bf124c2",99124:"dc23cd40",99361:"3a2db09e",99494:"93e05602",99924:"df203c0f"}[e]||e)+"."+{125:"6b0c038f",272:"487d8a0d",523:"fc9d4c65",648:"da045914",728:"0e528ee4",745:"69db74e3",822:"25d5509d",886:"b5304b58",899:"73352153",955:"ebed5c2f",1074:"4a960c15",1516:"c82b85fa",1782:"b4498b00",1837:"69e53b17",1868:"b182109f",2193:"44f06a24",2281:"6b146f65",2353:"04cd13af",2408:"d5a80894",2866:"90336e23",2883:"f2a019a3",3102:"66cf149b",3207:"2af97f31",3342:"31e30957",3408:"a88766f4",3537:"97a0ca6a",3584:"0532ec79",3614:"711532a9",3667:"0d01bc01",3745:"06282814",3879:"29a1efae",3954:"0bdb99ad",3984:"4c3b7eba",4004:"bc3cce6d",4117:"feec9a52",4220:"982ccc3f",4459:"e9664a86",4918:"9a35f0fb",4929:"4c13a2d1",5240:"f90b6206",5414:"f9383556",5417:"eb8ea6d9",5477:"75cf51aa",5674:"7b98703a",5697:"d181337e",5886:"56a0a8ac",6082:"78df73c3",6098:"7104633e",6102:"ace9289c",6125:"b843d475",6266:"88c57e6d",6639:"c1f154b0",6642:"4b13779e",7371:"77c73ffe",7377:"6d046a51",7809:"7581008d",8039:"0deb5f84",8335:"cf922671",9055:"493146b4",9500:"8bb8cb2a",9928:"396a67db",9973:"8fe9e7e5",10014:"a0ed2fc1",10038:"6199cbfb",10114:"5879dc09",10138:"8712a9be",10239:"d004dcc8",10261:"91ba2584",10347:"0e647aab",10349:"7d28f7e4",10379:"0915c99d",10449:"ae04e529",10485:"e453bd09",10579:"d994ec2a",10588:"8397eead",10717:"932171fd",10787:"5f73cc81",11077:"70d10f6d",11121:"d07253b3",11161:"5dd85cbf",11648:"1d06663c",11724:"0be29d98",11981:"a2158ab5",12121:"99398064",12323:"a9271200",12864:"629f0c88",13239:"a8c029b6",13317:"e10c9428",13573:"040ed7ae",13751:"55ea166c",13826:"a26fe0ce",13893:"14142e17",14026:"6a11107c",14069:"263ec6c5",14077:"419b15aa",14094:"5cb3fca4",14142:"1a610fa4",14499:"ea20a973",14824:"c261393e",15150:"6596d82d",15554:"e49e0d91",15980:"e1310600",16311:"b74228cb",16467:"4c7f7a9d",16696:"1514bd82",16728:"d16ac932",16855:"727518e6",17194:"d04c04be",17285:"3b9a4a34",17329:"2ce4b473",17708:"24940500",17741:"b163370f",18315:"57e4ce2c",18518:"5e093455",18565:"deb193b1",18649:"334fce31",18768:"7501f8cc",18880:"80bb8a1b",19043:"e59c8b16",19093:"96c77ad9",19204:"a3ccfb58",19282:"b4597d5d",19536:"31e764db",19537:"b1eeaf05",19841:"711cc826",20044:"85a0e32b",20138:"1bd76998",20205:"91eeef42",20406:"a8a280a8",20873:"60aa769d",21046:"88eed035",21181:"1f81b445",21360:"01b47b04",21364:"1fcc0214",21534:"000443f2",22182:"4297dc3f",22228:"78ce2776",22978:"779ac984",23427:"b9a70cd8",23493:"f95ab118",23840:"25373de2",23937:"93183271",24260:"e20a2df7",24386:"309238d8",24483:"ce62bc6c",24498:"afafc97c",24726:"30b1d368",24787:"5e05973c",24904:"dfc357bd",25204:"658f152b",25211:"12a57378",25314:"91736a75",25817:"af3f867a",25821:"ea4b6df7",26011:"55e8cd60",26070:"4d45da95",26116:"927c4c67",26348:"aa578115",26557:"366b04cd",26690:"00b850b4",27104:"b6a7075e",27135:"2c0a57b6",27168:"46dc5554",27177:"936dfb19",27222:"8239f5fe",27268:"18258b5c",27328:"f3e5a21d",27910:"ccc51432",27918:"1a302b83",28143:"c3658761",28145:"e2301081",28263:"75bf9a2b",28437:"e8d76bc9",28682:"8df7bd53",28813:"891b6f91",28899:"89d61cf3",29112:"2a0c4b0f",29234:"43c17c93",29579:"2315eed8",29661:"a5daa9f7",29693:"ab643bdf",30060:"6c434be8",30466:"c9cb4b0e",30720:"5c04ac32",30821:"632e2d7f",30901:"03ca0fdd",31004:"76bb3dc4",31402:"ae5f9142",31512:"25267803",31824:"74d29099",32360:"8b44957c",32472:"082a3e63",33067:"dcea6959",33124:"6e7815d3",33233:"29bbd98b",33279:"96f71e8b",33356:"8012831c",33629:"c5504259",33940:"b4c2db27",34322:"a7db3b0b",34479:"70cb17e9",34617:"f7d4a121",34670:"60f01632",34770:"d7ab3fb7",34884:"f4155bfc",35137:"e2f810a4",35281:"63811af8",35425:"7aabbbf8",35572:"12300671",35584:"cdcdc183",35711:"f33aa64e",36006:"a25cf773",36075:"a5557716",36101:"e48610da",36166:"ae8d5da7",36248:"b64ac492",36274:"4bec2dd7",36325:"180c3bc4",36424:"ccb31542",36955:"a8f5aeb1",37073:"e9ea90aa",37245:"46b6554f",37437:"b5408277",37573:"45e99dc5",37683:"7b26e0c9",37698:"866f836b",37737:"5704e252",37836:"cf847a2f",37918:"55e0e9a5",38056:"d76daff9",38134:"d7af2c73",38684:"f1715cb9",38780:"5a45d291",38943:"972ef8bb",39613:"9a1d3298",39620:"a6df85a8",39684:"9a351aa0",40070:"e6e53bf6",40486:"b9c98dbc",40569:"63935461",40592:"aedfd536",40683:"5840292b",40816:"c1347aa3",41169:"3fcb8154",41619:"57708eca",41644:"cbab884f",41798:"0f623537",41869:"96c91b31",41902:"6b25b595",41976:"5ac2b7c1",42205:"52e5f450",42326:"3e9c2ea5",42423:"475388d8",43010:"57b0b164",43163:"7065a8b5",43274:"9e6b8c5e",43474:"baead9f1",43546:"bf0916c6",43582:"e2d61fe3",43871:"c07f48b2",44031:"16f509cd",44366:"ac8e857d",44422:"864faaad",44619:"95d38593",44654:"3f4f1110",44781:"26398474",44958:"c8940fb9",45033:"b5dd8b79",45326:"e0a3035c",45346:"18372773",45603:"12fe5f3a",45708:"f5096d46",45760:"518ecc83",45835:"62d570f1",45974:"6273d94d",46103:"37e66e94",46623:"cb9740c3",46738:"b6870e64",47389:"d20d4ee0",47596:"23612a4e",47604:"cde400ad",47679:"03c5a191",47718:"e419721c",47875:"cdbb9046",48123:"cfce530d",48176:"3498ab9f",48215:"a6929280",48610:"7afeb3d0",48901:"ed7e9841",48926:"ae86abe4",49076:"3bb40cf7",49867:"2dc4ee83",50649:"5c51628c",51051:"e6df946e",51171:"6986b656",51320:"fdd98020",51499:"4e42472e",51796:"65ac89db",51843:"a37c4896",51978:"090bcb69",52343:"51354188",52525:"9eb4e740",52535:"4aa24bc5",52546:"04c929f6",52920:"f631939e",52950:"42aa7e7c",53237:"e732b113",53273:"fe1d0baa",53479:"31455d24",53604:"09a0b756",53608:"ad9fef43",53691:"8163862f",53800:"d43ab5f8",54063:"5f4df978",54184:"b0164c59",54191:"8c190567",54194:"38c1a738",54373:"8a9686d3",54632:"90d1a8bd",54774:"46532e76",54854:"1ff29b25",55904:"9072374e",56805:"8f5aa3ed",56843:"8600edfe",56870:"acbb0cc3",57076:"e0be15c4",57138:"9b2b8d17",57321:"7c20b017",57366:"9ce7fb05",57368:"db84a10c",57549:"75920c55",57694:"33b57c17",57881:"cfbd0ce3",58216:"86ce0f15",58262:"ab61feb7",58673:"b8118592",58739:"1746f861",58792:"373720fc",58800:"165a1236",58989:"f98114e9",59081:"9c5cddee",59186:"75f5e02b",59208:"d2597689",59341:"9433f032",59671:"f26e5673",59812:"747fd838",59860:"95535877",59875:"17ac522a",60203:"9d2297eb",60334:"77440120",60564:"0698faa8",60574:"f03eb54b",60637:"c03d01cd",60810:"1e4ed3ed",61021:"01819565",61110:"55e5c0bd",61281:"8145ef48",61305:"007c7565",61425:"017a2df6",61476:"1d7e3380",61573:"3461d2a6",61866:"a1c5c428",61896:"ed131ad2",62283:"c75a1fe2",62325:"2e874bfc",62789:"f5051f29",62871:"c0c8c913",63154:"f198ef2d",63190:"7ac9b590",63407:"f9145439",63630:"4603f59f",63652:"4b3268b3",63707:"d83125d4",63773:"af41b263",63863:"2b9a5779",64013:"6fd86a6a",64088:"c78f2600",64258:"98bf19a2",64315:"a7d7be93",64389:"580d5aca",64438:"a558de29",64439:"545b7965",64471:"25bc901b",64651:"b396907e",64891:"1f29ad48",65144:"e06e9aa0",65181:"0e678016",65191:"465997da",65248:"15726df6",65375:"06daf57b",65431:"466c9573",65619:"6b16b70a",65776:"cafa16f1",65909:"6f4a66dd",66e3:"c3e218e8",66112:"7fd3bbeb",66362:"57dbdd34",66464:"3f1c5cb7",66521:"75765851",66743:"ff4ddc16",67363:"316e6140",67411:"968a0649",67480:"570a09ed",67539:"36ccac13",67690:"c1cc37b5",67966:"6b31f274",68059:"b9e6f074",68097:"b31c5438",68732:"b02f6004",68811:"7e2a2804",68888:"19f0621a",68974:"ceb03814",69006:"29d4703c",69584:"bc0fff2e",69783:"788e561e",70225:"363396c7",70335:"eb92c593",70534:"6820119d",70586:"13e78482",70595:"1cbdd028",70633:"b1603d0d",70900:"8e39e5ed",70985:"45a0b168",71426:"3d92cb2e",71625:"abfada6a",71781:"ea604bc4",71796:"aa535a12",71874:"13809c24",71970:"19048dc9",72079:"bd1e92bb",72092:"2077b18d",72179:"f3d32707",72303:"26d951ec",72491:"49a1a7a4",72896:"fea0bd53",72931:"d5ed1440",72996:"1e36eaf3",73163:"78bdec1d",73177:"665091cd",73285:"741b7b45",73313:"3477b0dc",73636:"0c76ccf6",73714:"822b1d15",73743:"b8146bc5",73867:"d2491652",74340:"5a617c15",74961:"59f99f99",74988:"2c75a852",74996:"a1e43ed3",75167:"052d116d",75208:"87186c51",75247:"def31c75",75273:"c5c66120",75290:"6c3ddf86",75542:"b5af5f79",75689:"8086540d",75697:"4af8cdc9",75741:"67ac4b42",75809:"1a3d6846",75862:"bd1abb72",76091:"f6c4b88d",76158:"a831cb5c",76192:"9f5502cb",76267:"4cd42ca9",76357:"5ac50094",76518:"4ce4ebc4",76932:"1b740f9e",76952:"a8a1129f",77060:"a1c452c8",77319:"09714cf5",77401:"a7c2d74a",77673:"fca13a40",77683:"0210e27f",77911:"74763dbe",78127:"00e9be69",78327:"3b1b5d03",78416:"8b0678e1",78514:"91ec7eb3",79106:"ab591738",79268:"3b56758b",79649:"04d503d6",80161:"68b5cfb3",80299:"6c9cc63a",80325:"3c9cb8c9",80355:"6c7ec83f",80448:"a1cf9074",80511:"cc770f20",80900:"05d325f2",80945:"cb84f797",80954:"ed8cc7c2",80957:"e2d4c30a",81145:"452b41b1",81580:"010c7fc5",81900:"3c2338da",81922:"2e70b937",82144:"666b4927",82163:"e771eafd",82323:"309e62d2",82388:"7a569762",82409:"be976545",82424:"dc515410",82451:"37ee5729",82667:"1ce7c753",83039:"c9057951",83050:"d8fffb83",83152:"73efca0f",83672:"6ea59cdb",83687:"41759e7a",83870:"6fc10e9c",83945:"822080ea",83973:"d73cbaee",84006:"2c5d79a4",84413:"052b9410",84507:"05eed424",84513:"ef410b8f",84573:"5dbac12c",84667:"ec612995",84940:"150f7770",84960:"c9c8b47e",85067:"511c9e62",85210:"86dcfafa",85376:"37780c80",85632:"d50d437d",85714:"524d4798",85799:"bc44af44",86112:"df70dde4",86216:"42cf6854",86258:"3f06e9e5",86272:"96c70e1f",86335:"48b5df45",86477:"83072723",86528:"b228ef90",86535:"e784a849",86661:"84ff854d",86730:"ad9e2eb6",87213:"52d3e01b",87430:"f97de055",87664:"0aa437ad",87759:"ab2367fa",88055:"fef9a984",88089:"08524986",88566:"7e092c80",89127:"77dc02e4",89251:"461102ac",89338:"ce1c12d5",89372:"61ef36d2",89472:"294226ac",89626:"b90a4ff0",89731:"ca2e84e1",89799:"d4b655c1",89950:"2e1a1154",90051:"02144c17",90125:"fa815603",90522:"916141f8",90681:"34963fda",91447:"b9846426",91721:"5137418c",91893:"ff5df7bd",92045:"3179bed9",92217:"c5a42c29",92423:"8f91e78e",92428:"38443f95",92514:"df89b14d",92599:"5e9ee3dd",92786:"76605b13",92916:"6a92cdf3",92955:"bbc73382",92958:"519f3183",93041:"3bde6a31",93089:"9f3d61d4",93300:"338a9e60",93401:"3ec62a56",93690:"66834d12",94331:"f8e23211",94368:"d0d9f218",94875:"1f649e1a",95628:"42c1eef6",95921:"1f4cef1d",96017:"86fa7388",96120:"0ca6b52b",96514:"de2cf9f6",96915:"5e2492b1",96987:"4ec146cf",97002:"280548b4",97159:"9713e494",97227:"52adcf7a",97251:"58964465",97288:"7b94d332",97355:"c2a9f26b",97393:"1bc09864",97767:"b1aa5916",97920:"e9e04170",97953:"64855d07",98170:"b09ba52b",98327:"12f5691c",98532:"ce7eb2c0",98960:"cc2feaf5",99086:"983c6343",99124:"f661ba0c",99361:"c6acade6",99494:"928c3e3a",99924:"b60887e1",99964:"1414e8fb"}[e]+".js",t.miniCssF=e=>{},t.g=function(){if("object"==typeof globalThis)return globalThis;try{return this||new Function("return this")()}catch(e){if("object"==typeof window)return window}}(),t.o=(e,a)=>Object.prototype.hasOwnProperty.call(e,a),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:"77673",10210328:"38943",17896441:"27918",25622900:"61896",30997935:"36955",34767260:"72179",35300761:"96120",44287967:"49867",67386898:"20406",71748509:"97227",75281220:"57366",91008145:"42423",91392348:"60637",95366386:"34617","814d49b7":"125",aca8b082:"272",a0323d9f:"523","714e70d1":"648","6eb49eac":"728","64abd3af":"745",a00af9f0:"822","7aa856d6":"886",b985118d:"899","39ae3791":"955","9e8f4e9c":"1074","8abd0ba5":"1516","97a89ac0":"1782",dec87402:"1837","46b3c144":"1868",c5b2f0f9:"2193","920c2ac2":"2281","92d7df62":"2353","78b70dba":"2408",e064f6d4:"2866",bb6a5560:"2883","3462068c":"3102","6603ef13":"3207",d1c21237:"3342","3ba80b69":"3408","3819c331":"3537",ed75cfcb:"3584","3b68f98c":"3614",b6d76a6c:"3667","3109d9d2":"3745","2d629ea6":"3879","898514b1":"3954","160cb329":"3984",a334b453:"4004",fd684bd6:"4117","2bbe04e6":"4220","19eded63":"4459","24bda87b":"4918","330dfcdb":"4929","22de4147":"5240","724f3974":"5414","5e8fbcdf":"5417","164937d2":"5477","5c0f0993":"5674",e35d7c3e:"5697","57dba496":"5886","3866940b":"6082",cb0f21df:"6098","8677f412":"6102",reactPlayerSoundCloud:"6125",a2c6f402:"6266","8ccdb99f":"6639",c15d9823:"6642","786fee93":"7371","708d858d":"7377","07305c4a":"7809","927c84a6":"8039",ca6c9efa:"8335",e7923b27:"9055","4213e5b1":"9973","30a9912a":"10014",bc873533:"10038",e665718d:"10114","6269f1c0":"10138","3a4a1d3a":"10239",reactPlayerKaltura:"10261",bc816bf2:"10347",a943bcee:"10379","8873cf50":"10485",d46ef83d:"10579","7afa6340":"10588",adb00d9a:"10717","49d9416a":"11077","8e49e0b0":"11121",a4794f2e:"11161","4bdb36b8":"11648","5087625a":"11724",b799648a:"11981",reactPlayerFacebook:"12121","6c80b6fe":"12323",e7477a94:"12864",bd45720e:"13239",d83f208d:"13317",be228752:"13573","3720c009":"13751","01a1d0f4":"13826",a847366a:"13893","9c540f0b":"14026","40d377be":"14077","17d2ebc8":"14142","73f18a6f":"14499","06a27da2":"14824","732d4d9b":"15150","1dfee34e":"15554",a7456010:"15980",c25913f3:"16311","878aa0e7":"16467","6477cdc2":"16696",d9407a00:"16728",b7bb2d93:"16855","9f2f2cb3":"17194",c1ca9e21:"17285","04a546a4":"17329","688ee267":"17708","7d88b63f":"17741",a7bd4aaa:"18518","49a2e93c":"18649","524ce9a0":"18768",deccabf3:"18880","473de3ed":"19043","0029a336":"19093",db320b4a:"19204","0433ef30":"19282","0e72c11a":"19536",c1584a80:"19537",d9b4ee1e:"19841",d66cbd9e:"20044","54590fd2":"20138","2340b3ee":"20205",cabda5f8:"20873","4cb6c19a":"21046",ea3ffc82:"21181","9286a297":"21360",f7c9e078:"21364","8ae04122":"21534",f1ad83b2:"22182","125d93c1":"22228","7e93d479":"22978",bd80aa65:"23427","00e9d6a1":"23493","562ca3e9":"23840","610f2c47":"23937","22e2140b":"24260",ae79aff5:"24386","9542c76a":"24483","7bef3f04":"24498","280646e4":"24726",a9bc0f5d:"24787","9d887a11":"24904","33f367df":"25204",d496897e:"25211",ab69fe56:"25314","70e3b13c":"25817",b9a87183:"25821",reactPlayerFilePlayer:"26011","52ea62e7":"26116",c104141c:"26348","5e486140":"26557","4816649b":"26690","35dda5a2":"27104","5e30269e":"27135","4ec4c6cd":"27168","4f9e8711":"27177","38f19abb":"27222","57a8015d":"27268","423842d7":"27328",c358ebbc:"27910","7e2ae3df":"28143","006e489c":"28145","82170cf7":"28263","5b10a003":"28437","8eeedb31":"28682","5fb93fc0":"28813",c09ab32f:"29112","86f8c256":"29234","09b168a7":"29579","5e95c892":"29661","123a454a":"29693","0547cb65":"30060","0e3a398f":"30466","5ebdf64d":"30720",aba485c2:"30821",ae4a775b:"30901",c141421f:"31004","0341d436":"31402","7fa133e1":"31512","4f35c7a7":"31824","7d3ae564":"32360","65a10ffa":"32472","62e21724":"33067","330b5684":"33124","59a6f192":"33233","456c0e28":"33279","54d805e4":"33356",aba21aa0:"33629",fe716911:"33940","69c5f318":"34322","0c14b239":"34479","450c2e30":"34770",e1c8d71f:"34884","41b2e801":"35137","8cb0269b":"35281",b4df9b48:"35425","6774f806":"35572",b52d840d:"35584","79f18c88":"36006","86e64757":"36075",e73930cf:"36101",e3f28bf9:"36248",c9cac9d9:"36325",a3002291:"36424","0f54081d":"37073",b678a236:"37245","3d8d8999":"37437","48b6ff5f":"37573",df2a6e58:"37683",cd23aec9:"37698","7cde3c49":"37836","10ce918d":"37918","905702d2":"38056","1515c895":"38134","815c93fd":"38684",f26f8f05:"38780","1fbe0675":"39613",b51a9aee:"39620","25d1f3de":"39684","86f2a982":"40070",ed2a4846:"40486","8519c2b0":"40569",b39cdcf9:"40592","3e2b82eb":"40683","4d71dffe":"40816",a2d1ff94:"41169","6494b798":"41619","9db962b6":"41644",bd65ec7e:"41798",c361d244:"41869",edcfca88:"41902","0c4fad6b":"41976",b66ca8cf:"42205","7b477840":"42326","56c3a9b2":"43010","232c546d":"43163","23a8e291":"43274",db22fd17:"43474","57e01cd5":"43546","016e89ec":"43582","065365b3":"43871",f81c1134:"44031","416d4fcf":"44422",a9fa5b1f:"44619",c0c3bda5:"44654","12f1535e":"44781","080a9824":"44958","9af13eab":"45033",af231220:"45326","7f0476bd":"45346","1e582a71":"45603","97d49594":"45708","7547d3bb":"45835","46cf64bb":"45974",ccc49370:"46103",b104dd1e:"46623","8dbb6800":"46738","612345e6":"47389",reactPlayerDailyMotion:"47596",ffbee6a9:"47604","83245ae6":"47679","6864e844":"47718","021eaa84":"47875",f86eb50f:"48123","5660752d":"48176","1cfced13":"48215","6875c492":"48610","640277b9":"48901","60c82955":"48926","494e8e75":"49076","512fbd77":"50649","107d77e6":"51051","7e5a2776":"51171","46669adc":"51320","180d0c5f":"51499","4f9d299b":"51796",a2ffcc0f:"51843",fe0d4a0f:"51978","97c7db18":"52343","1a906644":"52525","814f3328":"52535",reactPlayerStreamable:"52546",e0277333:"52920","67eba1be":"52950","1df93b7f":"53237",cc922df3:"53273","883e2c3c":"53479",cd7fa15a:"53604","9e4087bc":"53608","7be672a3":"53691","97eb992d":"53800","0fa6e9bf":"54063","16ce7fd2":"54184","1d31e443":"54194",b5114993:"54373",edb40f78:"54632","42b67a8e":"54774","931e3b0a":"55904",f7197f43:"56805","9f97f9d1":"56843","5a3b561f":"56870","38a042e4":"57138","92b08985":"57321","6e30ac7b":"57368",bdb8b81b:"57549",fd702dc7:"57694","2658ced2":"57881","874690d0":"58216","059d1c6a":"58262",d9673b17:"58673","7a957b04":"58739","5db8318c":"58792",e6fb1369:"58800",d4bf7e47:"58989","5a7aef43":"59081","74c26f41":"59186","36994c47":"59208",a35cf155:"59341","0e384e19":"59671",d1163e47:"59860",d7ed6ffb:"59875",c6aad055:"60203",a3f8794a:"60334","8b4ba22f":"60564","14ae68e7":"60574","254d0ff5":"60810","901c37e5":"61021",f16d562f:"61110",e983a6d7:"61281","73f9658e":"61305",fc8a94e3:"61425",a33d13d7:"61476","87a5fc8a":"61573","1369aff7":"61866","74b658de":"62283",d1462701:"62325",c239db97:"62789","604e05e4":"62871",c6346fcf:"63154",e546fc5a:"63190",b8ec852b:"63407",ef5945f7:"63630","6e92edd9":"63652","8c6c72f9":"63707",ed1f6062:"63773",f771dec1:"63863","01a85c17":"64013","0058b4c6":"64088",reactPlayerMux:"64258","16914cba":"64315",d739767a:"64389",f20efc55:"64438",reactPlayerYouTube:"64439",cfdfe126:"64471","94f3d131":"64651",a30c0d44:"64891","1ee92283":"65144","3f29ba7c":"65181",d103759a:"65191","6101b3fc":"65248","97615df2":"65375","2ab17a83":"65431",f6cf66bc:"65619",f0e3a130:"65776","95646edb":"66000","2f8f53cb":"66112","28d80fa9":"66362",adcef0a2:"66464","014457dd":"66521","9684f8b7":"66743","583db3ef":"67363",b15eeff9:"67411",eb17771c:"67480","5c25e6fa":"67539","030ccfd9":"67690","0dd9aaeb":"67966",ca165b51:"68059",ff2f63f6:"68097","3132913e":"68732","3289a752":"68811",reactPlayerVidyard:"68888","8a864d1e":"68974",a08dfa31:"69006",b8eb0fce:"69584","7144043e":"69783",e1a2ab10:"70225","4b8121dd":"70534",ef2e2003:"70586","24dadce3":"70595","1fc83a28":"70633",fe1a05e2:"70900","814402d7":"70985","382e0557":"71426",de311ed4:"71625",fe9a92c0:"71781","64134c03":"71796",cc6d9416:"71874",adfdec4a:"71970","1a16e8bf":"72079","148448cb":"72092",f644aac7:"72303",c71cae97:"72491",abc85917:"72896",e6c31e60:"72931","7a21ccb0":"72996",cd343213:"73163",fc923f19:"73177",ed603d23:"73285","8b4dd820":"73636","894e67a6":"73714",reactPlayerVimeo:"73743",c7cac05f:"73867","2bb2c1cd":"74340","4c5becac":"74961",d83404a8:"74996","5046ea8f":"75167",f6cd0d3d:"75208","3c39daba":"75247",e69dadab:"75273",bf11c6a2:"75290","0102eb3e":"75542",c544b2d7:"75689",b7746a44:"75697",f27eaf88:"75741","8be8ac58":"75809",ada86621:"75862","19e69ccd":"76091","51e516cc":"76158","64bd32f2":"76192","94324b0e":"76267","591f7a5f":"76357","9dd60997":"76518",aaabcfd8:"76932","70bd0abb":"76952","7c7a772e":"77060","67fccd64":"77319",ca1234c1:"77401","01821883":"77683",b2973dc4:"77911",c2e1e282:"78127","360dc931":"78327","4b66c45e":"78416",d651e2ee:"78514",d4840880:"79106",c8eb055e:"79268","5bc09a53":"79649","3f66023b":"80161","98ced590":"80325",b5b19789:"80355","49bee2be":"80448",fb8cd692:"80511","4ec76dfa":"80900",df322e14:"80945","8c8ef21f":"80954","91a39dd0":"80957",e84cabb0:"81145",fee0a0be:"81580","4c217c25":"81900",d178b2c6:"81922","09788c0c":"82144",c813bd67:"82163","23b35f70":"82323",bbf561d5:"82388",df4d464e:"82409",b6be2912:"82424",fb50ea3a:"82451","368cce37":"82667","825ec378":"83039","4780c642":"83050","33a21d7d":"83152","8785b74d":"83672","8ca0e442":"83687","5df556a2":"83870","9f90a44b":"83945",f523fb3f:"83973",d5f6644b:"84006",fff8aeb8:"84413","6aa0b043":"84507","6763d4e0":"84513",f9fb4395:"84573",reactPlayerMixcloud:"84667",c11c87f7:"84940",b3b7dd16:"84960","1949cc8d":"85210",c44aa824:"85376","3f797343":"85632","0cab2b3a":"85714",f4271232:"85799","5b7d9ef2":"86112",reactPlayerTwitch:"86216",a0c37fdd:"86258","7500e360":"86272","271ff0d1":"86335",a38d285e:"86477","2cb13d6d":"86528","2f7d01f7":"86535","43be69c9":"86661","0877aebd":"87213",reactPlayerPreview:"87664",ff38b1ce:"87759",reactPlayerWistia:"88055","6eafe0c7":"88089","9dce5486":"88566",b9287eb6:"89251","8fe4c488":"89338","07f59c2a":"89372","5a9a7a02":"89472","81e486a8":"89626","9d2d4743":"89731","4f425ff4":"89799","12eb386e":"89950","185c52e7":"90051","7d9edfb8":"90125","308aae28":"90522",cdf64ea9:"90681","4974f5d2":"91447","3a38a610":"91721","871ce139":"91893",e6163b65:"92045",d7fbbe43:"92217","7258860f":"92423","9a22c80d":"92428",b5ec5208:"92514",e44de27e:"92599","81b69ac7":"92786","91fe1403":"92916",e6412603:"92955","86063cd3":"92958",a6aa9e1f:"93089",fa5f999e:"93300",c2865a15:"93401",f431c910:"93690",e38c422a:"94331",a94703ab:"94368",fbfd390f:"95921","6a1fe514":"96017",a826efc5:"96514",da802cf4:"96915",caddb1c0:"96987",a7777682:"97002",a8ce95ee:"97159",ba5b9f11:"97251","1c93995d":"97288","56a9df4f":"97355",acecf23e:"97393","17612ae7":"97767","1a4e3797":"97920",e88443f3:"97953",bab44fba:"98170",d1b15a6d:"98532","6bf124c2":"98960",dc23cd40:"99124","3a2db09e":"99361","93e05602":"99494",df203c0f:"99924"}[e]||e,t.p+t.u(e)},(()=>{var e={51303:0,40532: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(/^(40532|51303)$/.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,c,f,b,d={},r={};function t(e){var a=r[e];if(void 0!==a)return a.exports;var c=r[e]={exports:{}};return d[e].call(c.exports,c,c.exports,t),c.exports}t.m=d,e=[],t.O=(a,c,f,b)=>{if(!c){var d=1/0;for(n=0;n=b)&&Object.keys(t.O).every((e=>t.O[e](c[o])))?c.splice(o--,1):(r=!1,b0&&e[n-1][2]>b;n--)e[n]=e[n-1];e[n]=[c,f,b]},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 b=Object.create(null);t.r(b);var d={};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=>d[a]=()=>e[a]));return d.default=()=>e,t.d(b,d),b},t.d=(e,a)=>{for(var c in a)t.o(a,c)&&!t.o(e,c)&&Object.defineProperty(e,c,{enumerable:!0,get:a[c]})},t.f={},t.e=e=>Promise.all(Object.keys(t.f).reduce(((a,c)=>(t.f[c](e,a),a)),[])),t.u=e=>"assets/js/"+({125:"814d49b7",272:"aca8b082",523:"a0323d9f",648:"714e70d1",728:"6eb49eac",745:"64abd3af",822:"a00af9f0",886:"7aa856d6",899:"b985118d",955:"39ae3791",1074:"9e8f4e9c",1516:"8abd0ba5",1782:"97a89ac0",1837:"dec87402",1868:"46b3c144",2193:"c5b2f0f9",2281:"920c2ac2",2353:"92d7df62",2408:"78b70dba",2866:"e064f6d4",2883:"bb6a5560",3102:"3462068c",3207:"6603ef13",3342:"d1c21237",3408:"3ba80b69",3537:"3819c331",3584:"ed75cfcb",3614:"3b68f98c",3667:"b6d76a6c",3745:"3109d9d2",3879:"2d629ea6",3954:"898514b1",3984:"160cb329",4004:"a334b453",4117:"fd684bd6",4220:"2bbe04e6",4459:"19eded63",4918:"24bda87b",4929:"330dfcdb",5240:"22de4147",5414:"724f3974",5417:"5e8fbcdf",5477:"164937d2",5674:"5c0f0993",5697:"e35d7c3e",5886:"57dba496",6082:"3866940b",6098:"cb0f21df",6102:"8677f412",6125:"reactPlayerSoundCloud",6266:"a2c6f402",6639:"8ccdb99f",6642:"c15d9823",7371:"786fee93",7377:"708d858d",7809:"07305c4a",8039:"927c84a6",8335:"ca6c9efa",9055:"e7923b27",9973:"4213e5b1",10014:"30a9912a",10038:"bc873533",10114:"e665718d",10138:"6269f1c0",10239:"3a4a1d3a",10261:"reactPlayerKaltura",10347:"bc816bf2",10379:"a943bcee",10485:"8873cf50",10579:"d46ef83d",10588:"7afa6340",10717:"adb00d9a",11077:"49d9416a",11121:"8e49e0b0",11161:"a4794f2e",11648:"4bdb36b8",11724:"5087625a",11981:"b799648a",12121:"reactPlayerFacebook",12323:"6c80b6fe",12864:"e7477a94",13239:"bd45720e",13317:"d83f208d",13573:"be228752",13751:"3720c009",13826:"01a1d0f4",13893:"a847366a",14026:"9c540f0b",14077:"40d377be",14142:"17d2ebc8",14499:"73f18a6f",14824:"06a27da2",15150:"732d4d9b",15554:"1dfee34e",15980:"a7456010",16311:"c25913f3",16467:"878aa0e7",16696:"6477cdc2",16728:"d9407a00",16855:"b7bb2d93",17194:"9f2f2cb3",17285:"c1ca9e21",17329:"04a546a4",17708:"688ee267",17741:"7d88b63f",18518:"a7bd4aaa",18649:"49a2e93c",18768:"524ce9a0",18880:"deccabf3",19043:"473de3ed",19093:"0029a336",19204:"db320b4a",19282:"0433ef30",19536:"0e72c11a",19537:"c1584a80",19841:"d9b4ee1e",20044:"d66cbd9e",20138:"54590fd2",20205:"2340b3ee",20406:"67386898",20873:"cabda5f8",21046:"4cb6c19a",21181:"ea3ffc82",21360:"9286a297",21364:"f7c9e078",21534:"8ae04122",22182:"f1ad83b2",22228:"125d93c1",22978:"7e93d479",23427:"bd80aa65",23493:"00e9d6a1",23840:"562ca3e9",23937:"610f2c47",24260:"22e2140b",24386:"ae79aff5",24483:"9542c76a",24498:"7bef3f04",24726:"280646e4",24787:"a9bc0f5d",24904:"9d887a11",25204:"33f367df",25211:"d496897e",25314:"ab69fe56",25817:"70e3b13c",25821:"b9a87183",26011:"reactPlayerFilePlayer",26116:"52ea62e7",26348:"c104141c",26557:"5e486140",26690:"4816649b",27104:"35dda5a2",27135:"5e30269e",27168:"4ec4c6cd",27177:"4f9e8711",27222:"38f19abb",27268:"57a8015d",27328:"423842d7",27910:"c358ebbc",27918:"17896441",28143:"7e2ae3df",28145:"006e489c",28263:"82170cf7",28437:"5b10a003",28682:"8eeedb31",28813:"5fb93fc0",29112:"c09ab32f",29234:"86f8c256",29579:"09b168a7",29661:"5e95c892",29693:"123a454a",30060:"0547cb65",30466:"0e3a398f",30720:"5ebdf64d",30821:"aba485c2",30901:"ae4a775b",31004:"c141421f",31402:"0341d436",31512:"7fa133e1",31824:"4f35c7a7",32360:"7d3ae564",32472:"65a10ffa",33067:"62e21724",33124:"330b5684",33233:"59a6f192",33279:"456c0e28",33356:"54d805e4",33629:"aba21aa0",33940:"fe716911",34322:"69c5f318",34479:"0c14b239",34617:"95366386",34770:"450c2e30",34884:"e1c8d71f",35137:"41b2e801",35281:"8cb0269b",35425:"b4df9b48",35572:"6774f806",35584:"b52d840d",36006:"79f18c88",36075:"86e64757",36101:"e73930cf",36248:"e3f28bf9",36325:"c9cac9d9",36424:"a3002291",36955:"30997935",37073:"0f54081d",37245:"b678a236",37437:"3d8d8999",37573:"48b6ff5f",37683:"df2a6e58",37698:"cd23aec9",37836:"7cde3c49",37918:"10ce918d",38056:"905702d2",38134:"1515c895",38684:"815c93fd",38780:"f26f8f05",38943:"10210328",39613:"1fbe0675",39620:"b51a9aee",39684:"25d1f3de",40070:"86f2a982",40486:"ed2a4846",40569:"8519c2b0",40592:"b39cdcf9",40683:"3e2b82eb",40816:"4d71dffe",41169:"a2d1ff94",41619:"6494b798",41644:"9db962b6",41798:"bd65ec7e",41869:"c361d244",41902:"edcfca88",41976:"0c4fad6b",42205:"b66ca8cf",42326:"7b477840",42423:"91008145",43010:"56c3a9b2",43163:"232c546d",43274:"23a8e291",43474:"db22fd17",43546:"57e01cd5",43582:"016e89ec",43871:"065365b3",44031:"f81c1134",44422:"416d4fcf",44619:"a9fa5b1f",44654:"c0c3bda5",44781:"12f1535e",44958:"080a9824",45033:"9af13eab",45326:"af231220",45346:"7f0476bd",45603:"1e582a71",45708:"97d49594",45835:"7547d3bb",45974:"46cf64bb",46103:"ccc49370",46623:"b104dd1e",46738:"8dbb6800",47389:"612345e6",47596:"reactPlayerDailyMotion",47604:"ffbee6a9",47679:"83245ae6",47718:"6864e844",47875:"021eaa84",48123:"f86eb50f",48176:"5660752d",48215:"1cfced13",48610:"6875c492",48901:"640277b9",48926:"60c82955",49076:"494e8e75",49867:"44287967",50649:"512fbd77",51051:"107d77e6",51171:"7e5a2776",51320:"46669adc",51499:"180d0c5f",51796:"4f9d299b",51843:"a2ffcc0f",51978:"fe0d4a0f",52343:"97c7db18",52525:"1a906644",52535:"814f3328",52546:"reactPlayerStreamable",52920:"e0277333",52950:"67eba1be",53237:"1df93b7f",53273:"cc922df3",53479:"883e2c3c",53604:"cd7fa15a",53608:"9e4087bc",53691:"7be672a3",53800:"97eb992d",54063:"0fa6e9bf",54184:"16ce7fd2",54194:"1d31e443",54373:"b5114993",54632:"edb40f78",54774:"42b67a8e",55904:"931e3b0a",56805:"f7197f43",56843:"9f97f9d1",56870:"5a3b561f",57138:"38a042e4",57321:"92b08985",57366:"75281220",57368:"6e30ac7b",57549:"bdb8b81b",57694:"fd702dc7",57881:"2658ced2",58216:"874690d0",58262:"059d1c6a",58673:"d9673b17",58739:"7a957b04",58792:"5db8318c",58800:"e6fb1369",58989:"d4bf7e47",59081:"5a7aef43",59186:"74c26f41",59208:"36994c47",59341:"a35cf155",59671:"0e384e19",59860:"d1163e47",59875:"d7ed6ffb",60203:"c6aad055",60334:"a3f8794a",60564:"8b4ba22f",60574:"14ae68e7",60637:"91392348",60810:"254d0ff5",61021:"901c37e5",61110:"f16d562f",61281:"e983a6d7",61305:"73f9658e",61425:"fc8a94e3",61476:"a33d13d7",61573:"87a5fc8a",61866:"1369aff7",61896:"25622900",62283:"74b658de",62325:"d1462701",62789:"c239db97",62871:"604e05e4",63154:"c6346fcf",63190:"e546fc5a",63407:"b8ec852b",63630:"ef5945f7",63652:"6e92edd9",63707:"8c6c72f9",63773:"ed1f6062",63863:"f771dec1",64013:"01a85c17",64088:"0058b4c6",64258:"reactPlayerMux",64315:"16914cba",64389:"d739767a",64438:"f20efc55",64439:"reactPlayerYouTube",64471:"cfdfe126",64651:"94f3d131",64891:"a30c0d44",65144:"1ee92283",65181:"3f29ba7c",65191:"d103759a",65248:"6101b3fc",65375:"97615df2",65431:"2ab17a83",65619:"f6cf66bc",65776:"f0e3a130",66e3:"95646edb",66112:"2f8f53cb",66362:"28d80fa9",66464:"adcef0a2",66521:"014457dd",66743:"9684f8b7",67363:"583db3ef",67411:"b15eeff9",67480:"eb17771c",67539:"5c25e6fa",67690:"030ccfd9",67966:"0dd9aaeb",68059:"ca165b51",68097:"ff2f63f6",68732:"3132913e",68811:"3289a752",68888:"reactPlayerVidyard",68974:"8a864d1e",69006:"a08dfa31",69584:"b8eb0fce",69783:"7144043e",70225:"e1a2ab10",70534:"4b8121dd",70586:"ef2e2003",70595:"24dadce3",70633:"1fc83a28",70900:"fe1a05e2",70985:"814402d7",71426:"382e0557",71625:"de311ed4",71781:"fe9a92c0",71796:"64134c03",71874:"cc6d9416",71970:"adfdec4a",72079:"1a16e8bf",72092:"148448cb",72179:"34767260",72303:"f644aac7",72491:"c71cae97",72896:"abc85917",72931:"e6c31e60",72996:"7a21ccb0",73163:"cd343213",73177:"fc923f19",73285:"ed603d23",73636:"8b4dd820",73714:"894e67a6",73743:"reactPlayerVimeo",73867:"c7cac05f",74340:"2bb2c1cd",74961:"4c5becac",74996:"d83404a8",75167:"5046ea8f",75208:"f6cd0d3d",75247:"3c39daba",75273:"e69dadab",75290:"bf11c6a2",75542:"0102eb3e",75689:"c544b2d7",75697:"b7746a44",75741:"f27eaf88",75809:"8be8ac58",75862:"ada86621",76091:"19e69ccd",76158:"51e516cc",76192:"64bd32f2",76267:"94324b0e",76357:"591f7a5f",76518:"9dd60997",76932:"aaabcfd8",76952:"70bd0abb",77060:"7c7a772e",77319:"67fccd64",77401:"ca1234c1",77673:"10091836",77683:"01821883",77911:"b2973dc4",78127:"c2e1e282",78327:"360dc931",78416:"4b66c45e",78514:"d651e2ee",79106:"d4840880",79268:"c8eb055e",79649:"5bc09a53",80161:"3f66023b",80325:"98ced590",80355:"b5b19789",80448:"49bee2be",80511:"fb8cd692",80900:"4ec76dfa",80945:"df322e14",80954:"8c8ef21f",80957:"91a39dd0",81145:"e84cabb0",81580:"fee0a0be",81900:"4c217c25",81922:"d178b2c6",82144:"09788c0c",82163:"c813bd67",82323:"23b35f70",82388:"bbf561d5",82409:"df4d464e",82424:"b6be2912",82451:"fb50ea3a",82667:"368cce37",83039:"825ec378",83050:"4780c642",83152:"33a21d7d",83672:"8785b74d",83687:"8ca0e442",83870:"5df556a2",83945:"9f90a44b",83973:"f523fb3f",84006:"d5f6644b",84413:"fff8aeb8",84507:"6aa0b043",84513:"6763d4e0",84573:"f9fb4395",84667:"reactPlayerMixcloud",84940:"c11c87f7",84960:"b3b7dd16",85210:"1949cc8d",85376:"c44aa824",85632:"3f797343",85714:"0cab2b3a",85799:"f4271232",86112:"5b7d9ef2",86216:"reactPlayerTwitch",86258:"a0c37fdd",86272:"7500e360",86335:"271ff0d1",86477:"a38d285e",86528:"2cb13d6d",86535:"2f7d01f7",86661:"43be69c9",87213:"0877aebd",87664:"reactPlayerPreview",87759:"ff38b1ce",88055:"reactPlayerWistia",88089:"6eafe0c7",88566:"9dce5486",89251:"b9287eb6",89338:"8fe4c488",89372:"07f59c2a",89472:"5a9a7a02",89626:"81e486a8",89731:"9d2d4743",89799:"4f425ff4",89950:"12eb386e",90051:"185c52e7",90125:"7d9edfb8",90522:"308aae28",90681:"cdf64ea9",91447:"4974f5d2",91721:"3a38a610",91893:"871ce139",92045:"e6163b65",92217:"d7fbbe43",92423:"7258860f",92428:"9a22c80d",92514:"b5ec5208",92599:"e44de27e",92786:"81b69ac7",92916:"91fe1403",92955:"e6412603",92958:"86063cd3",93089:"a6aa9e1f",93300:"fa5f999e",93401:"c2865a15",93690:"f431c910",94331:"e38c422a",94368:"a94703ab",95921:"fbfd390f",96017:"6a1fe514",96120:"35300761",96514:"a826efc5",96915:"da802cf4",96987:"caddb1c0",97002:"a7777682",97159:"a8ce95ee",97227:"71748509",97251:"ba5b9f11",97288:"1c93995d",97355:"56a9df4f",97393:"acecf23e",97767:"17612ae7",97920:"1a4e3797",97953:"e88443f3",98170:"bab44fba",98532:"d1b15a6d",98960:"6bf124c2",99124:"dc23cd40",99361:"3a2db09e",99494:"93e05602",99924:"df203c0f"}[e]||e)+"."+{125:"94d2f087",272:"487d8a0d",523:"fc9d4c65",648:"45e092b5",728:"0e528ee4",745:"69db74e3",822:"25d5509d",886:"fc30d2f7",899:"73352153",955:"1d3dac04",1074:"4a960c15",1516:"bf65c896",1782:"b4498b00",1837:"b22a46a1",1868:"3d2d761d",2193:"44f06a24",2281:"db71990c",2353:"40351446",2408:"d5a80894",2866:"e5ecea9b",2883:"cbfeff5c",3102:"66cf149b",3207:"2af97f31",3342:"31e30957",3408:"9b306541",3537:"97a0ca6a",3584:"0532ec79",3614:"711532a9",3667:"a00c5803",3745:"102ae179",3879:"29a1efae",3954:"0bdb99ad",3984:"0db74b23",4004:"e20229b7",4117:"feec9a52",4220:"982ccc3f",4459:"e9664a86",4918:"9a35f0fb",4929:"4c13a2d1",5240:"f90b6206",5414:"f9383556",5417:"ce7fa9eb",5477:"e72c01c0",5674:"568e69eb",5697:"163a4fc3",5886:"a1c375a3",6082:"cf8cc856",6098:"48eac277",6102:"ace9289c",6125:"b843d475",6266:"58d9e25a",6639:"c213634b",6642:"4b13779e",7371:"608ba676",7377:"6d046a51",7809:"7581008d",8039:"0f0d693f",8335:"cf922671",9055:"1a55303d",9500:"8bb8cb2a",9928:"396a67db",9973:"8fe9e7e5",10014:"4ba520a7",10038:"6199cbfb",10114:"5879dc09",10138:"8712a9be",10239:"d004dcc8",10261:"91ba2584",10347:"0e647aab",10349:"7d28f7e4",10379:"0915c99d",10449:"ae04e529",10485:"e453bd09",10579:"d94e146a",10588:"8397eead",10717:"932171fd",10787:"5f73cc81",11077:"6a892cb3",11121:"d07253b3",11161:"78d14a86",11648:"1d06663c",11724:"0be29d98",11981:"a2158ab5",12121:"99398064",12323:"a9271200",12864:"30c6e129",13239:"4f902ae0",13317:"d39af8c5",13573:"592ffaea",13751:"55ea166c",13826:"60628720",13893:"14142e17",14026:"cd75314b",14069:"263ec6c5",14077:"8613aff9",14094:"5cb3fca4",14142:"5ebeaea8",14499:"ac67b8b7",14824:"b794f176",15150:"6596d82d",15554:"9b7b44e5",15980:"e1310600",16311:"b41169de",16467:"e8f3d48d",16696:"16883f3c",16728:"da8ad66b",16855:"2a02952d",17194:"d04c04be",17285:"5754ec76",17329:"987ca97b",17708:"3d6d192d",17741:"b163370f",18315:"57e4ce2c",18518:"5e093455",18565:"deb193b1",18649:"334fce31",18768:"7501f8cc",18880:"984c74d6",19043:"e59c8b16",19093:"37319785",19204:"a3ccfb58",19282:"b4597d5d",19536:"98724709",19537:"92668091",19841:"5a087dca",20044:"409d8b5a",20138:"1bd76998",20205:"a32df5be",20406:"2ca4b3f0",20873:"60aa769d",21046:"88eed035",21181:"4c641c18",21360:"d65a23e5",21364:"f8249261",21534:"000443f2",22182:"0ffa5752",22228:"cf6f1cba",22978:"779ac984",23427:"b9a70cd8",23493:"f95ab118",23840:"25373de2",23937:"363eb6be",24260:"7315a161",24386:"309238d8",24483:"ce62bc6c",24498:"04f5625b",24726:"60afcc63",24787:"5e05973c",24904:"76cc1f6f",25204:"658f152b",25211:"a56eb425",25314:"a4942a7c",25817:"a39d7cf1",25821:"52a551a1",26011:"55e8cd60",26070:"4d45da95",26116:"927c4c67",26348:"2ebe1bee",26557:"27f2fc47",26690:"00b850b4",27104:"b6a7075e",27135:"5b48dea2",27168:"46dc5554",27177:"abebb938",27222:"8239f5fe",27268:"2c32bb17",27328:"bec0b4e6",27910:"780011f5",27918:"1a302b83",28143:"a2b9f3f3",28145:"e2301081",28263:"36122a07",28437:"68d56976",28682:"770e98d2",28813:"891b6f91",28899:"89d61cf3",29112:"7728a3eb",29234:"988ba385",29579:"2315eed8",29661:"a5daa9f7",29693:"6cc4a9b6",30060:"9e9cb6f5",30466:"7fd010fe",30720:"5c04ac32",30821:"632e2d7f",30901:"573a4b6c",31004:"76bb3dc4",31402:"ae5f9142",31512:"9dd84ef6",31824:"74d29099",32360:"8b44957c",32472:"082a3e63",33067:"978aed76",33124:"6e7815d3",33233:"29bbd98b",33279:"1bdb17b6",33356:"89519418",33629:"c5504259",33940:"6e7318c0",34322:"a7db3b0b",34479:"eacdab45",34617:"f7d4a121",34670:"60f01632",34770:"d7ab3fb7",34884:"9c3ff73c",35137:"11f6865c",35281:"ab2359f7",35425:"da951941",35572:"ac8fc9a6",35584:"06cff017",35711:"f33aa64e",36006:"2abcf36a",36075:"27da0162",36101:"e48610da",36166:"ae8d5da7",36248:"6edbd27d",36274:"4bec2dd7",36325:"180c3bc4",36424:"6c992b3d",36955:"a8f5aeb1",37073:"b7a0dc74",37245:"52fcb227",37437:"b5408277",37573:"45e99dc5",37683:"a03500d4",37698:"866f836b",37737:"5704e252",37836:"49415742",37918:"55e0e9a5",38056:"70cb1c3f",38134:"be79b40a",38684:"f1715cb9",38780:"5a45d291",38943:"647188f4",39613:"85b3feae",39620:"32335301",39684:"9a351aa0",40070:"e6e53bf6",40486:"9c2dee85",40569:"7c99c33c",40592:"aedfd536",40683:"76f3000a",40816:"c1347aa3",41169:"8b300a86",41619:"2f4a97b5",41644:"fc6abef7",41798:"a98bb842",41869:"96c91b31",41902:"fa7bd258",41976:"ac419fba",42205:"08195aaf",42326:"3e9c2ea5",42423:"a04f03c3",43010:"57b0b164",43163:"7065a8b5",43274:"4532fe7a",43474:"26543454",43546:"09087985",43582:"e2d61fe3",43871:"3b2b3c69",44031:"16f509cd",44366:"ac8e857d",44422:"cd66173c",44619:"ffe707a8",44654:"3f4f1110",44781:"26398474",44958:"e99fc1a7",45033:"b21bd9d9",45326:"e0a3035c",45346:"b5fbc363",45603:"12fe5f3a",45708:"9a305d41",45760:"518ecc83",45835:"2602af44",45974:"6273d94d",46103:"37e66e94",46623:"cb9740c3",46738:"23d34493",47389:"bb1e59a7",47596:"23612a4e",47604:"cde400ad",47679:"03c5a191",47718:"e419721c",47875:"cdbb9046",48123:"c3767dfd",48176:"3498ab9f",48215:"a6929280",48610:"7afeb3d0",48901:"f91e6c9a",48926:"d3eab794",49076:"c459a1cc",49867:"10efc4d5",50649:"5c51628c",51051:"02a445dd",51171:"d54c3462",51320:"c57531f0",51499:"da98afd2",51796:"65ac89db",51843:"47a74cc4",51978:"090bcb69",52343:"5ddfb558",52525:"1d4921e9",52535:"4aa24bc5",52546:"04c929f6",52920:"f631939e",52950:"81a299ef",53237:"e732b113",53273:"03b531fb",53479:"06bdf71d",53604:"09a0b756",53608:"ad9fef43",53691:"8163862f",53800:"a1d552e6",54063:"cef402d3",54184:"b0164c59",54191:"8c190567",54194:"38c1a738",54373:"5ddd4afd",54632:"3f9dc7e1",54774:"c33ea390",54854:"1ff29b25",55904:"e9c4f38e",56805:"7196feb1",56843:"8600edfe",56870:"acbb0cc3",57076:"e0be15c4",57138:"9b2b8d17",57321:"52899b50",57366:"9ce7fb05",57368:"51958463",57549:"c0201704",57694:"60bd357b",57881:"cfbd0ce3",58216:"3a23e97a",58262:"ab61feb7",58673:"40e93ab7",58739:"1746f861",58792:"12796fd6",58800:"165a1236",58989:"f98114e9",59081:"05c2a381",59186:"75f5e02b",59208:"d2597689",59341:"9433f032",59671:"f26e5673",59812:"747fd838",59860:"8ac22ed6",59875:"17ac522a",60203:"9d2297eb",60334:"95c0f0a5",60564:"ba8a4b51",60574:"cf72c50a",60637:"be96e172",60810:"4205c849",61021:"01819565",61110:"55e5c0bd",61281:"4b851537",61305:"dd941f40",61425:"017a2df6",61476:"1d7e3380",61573:"f5ebd8fe",61866:"a1c5c428",61896:"ed131ad2",62283:"d82000ee",62325:"2e874bfc",62789:"e0210e70",62871:"bb73438b",63154:"f198ef2d",63190:"42bb8178",63407:"31614929",63630:"e8c59d51",63652:"93630a35",63707:"6863ceb9",63773:"af41b263",63863:"bb084b60",64013:"6fd86a6a",64088:"c78f2600",64258:"98bf19a2",64315:"a3250adf",64389:"bb34b251",64438:"d5fa13d4",64439:"545b7965",64471:"64f63df0",64651:"b396907e",64891:"c7d5ae93",65144:"0d060cf7",65181:"0e678016",65191:"40e5f24e",65248:"15726df6",65375:"06daf57b",65431:"466c9573",65619:"cd3f6748",65776:"cafa16f1",65909:"6f4a66dd",66e3:"4efc7127",66112:"7fd3bbeb",66362:"57dbdd34",66464:"be39a8d7",66521:"75765851",66743:"ff4ddc16",67363:"316e6140",67411:"369891af",67480:"570a09ed",67539:"36ccac13",67690:"c3ffcb97",67966:"6b31f274",68059:"2783caf8",68097:"df5e14e9",68732:"009f2712",68811:"7e2a2804",68888:"19f0621a",68974:"c636e1f8",69006:"195b0181",69584:"9577fc98",69783:"788e561e",70225:"5829bdf7",70335:"eb92c593",70534:"6820119d",70586:"cd1ff3e5",70595:"2336fe8c",70633:"92e11025",70900:"3c583c03",70985:"d94a5e0d",71426:"9855cd1d",71625:"abfada6a",71781:"ea604bc4",71796:"25b6385e",71874:"e57367f3",71970:"0c4258fc",72079:"bd1e92bb",72092:"3d585449",72179:"f3d32707",72303:"26d951ec",72491:"49a1a7a4",72896:"fea0bd53",72931:"d4ef3531",72996:"1e36eaf3",73163:"78bdec1d",73177:"5e145a28",73285:"93d40f06",73313:"3477b0dc",73636:"0c76ccf6",73714:"822b1d15",73743:"b8146bc5",73867:"3b251841",74340:"0a8a3b0b",74961:"c23a41d2",74988:"2c75a852",74996:"9105fe5a",75167:"7eeebda8",75208:"e1f9034a",75247:"def31c75",75273:"9568f8be",75290:"43242bb5",75542:"0bf3b48b",75689:"3da570a4",75697:"4af8cdc9",75741:"808d6463",75809:"1a3d6846",75862:"bd1abb72",76091:"0a7f4a02",76158:"a831cb5c",76192:"d520aa3d",76267:"573187f8",76357:"5ac50094",76518:"16e1f8fe",76932:"1b740f9e",76952:"183fa272",77060:"3fee7f43",77319:"b1c45f47",77401:"91ea8ce8",77673:"fca13a40",77683:"76008ed5",77911:"74763dbe",78127:"00e9be69",78327:"3b1b5d03",78416:"8b0678e1",78514:"91ec7eb3",79106:"ab591738",79268:"3b56758b",79649:"88a05c89",80161:"068982ab",80299:"6c9cc63a",80325:"d78d3adf",80355:"95404402",80448:"2b175c8e",80511:"b5b94ebb",80900:"05d325f2",80945:"cb84f797",80954:"3c7a6e7a",80957:"e2d4c30a",81145:"45a81b9a",81580:"f6dbbeae",81900:"1df348e9",81922:"2e70b937",82144:"666b4927",82163:"fcf0fda7",82323:"309e62d2",82388:"7a569762",82409:"40bfcf77",82424:"c4e77c6e",82451:"37ee5729",82667:"1ce7c753",83039:"cd8f1b89",83050:"d8fffb83",83152:"73efca0f",83672:"fcf8afd3",83687:"41759e7a",83870:"6fc10e9c",83945:"822080ea",83973:"d73cbaee",84006:"49a947da",84413:"052b9410",84507:"9f443ce4",84513:"ced8b8c6",84573:"5dbac12c",84667:"ec612995",84940:"150f7770",84960:"3822b4b8",85067:"511c9e62",85210:"86dcfafa",85376:"37780c80",85632:"9959f05f",85714:"a7bf6278",85799:"e734fc44",86112:"34875336",86216:"42cf6854",86258:"3f06e9e5",86272:"31ab4c14",86335:"936d03da",86477:"f2e94a0e",86528:"a5460e4a",86535:"e784a849",86661:"365e8195",86730:"ad9e2eb6",87213:"82b4b323",87430:"f97de055",87664:"0aa437ad",87759:"ab2367fa",88055:"fef9a984",88089:"241d1080",88566:"7e092c80",89127:"77dc02e4",89251:"90f5137a",89338:"ce1c12d5",89372:"61ef36d2",89472:"b215f246",89626:"b90a4ff0",89731:"f9b8c7b5",89799:"e829c062",89950:"0b54149b",90051:"55a33813",90125:"968a3be8",90522:"916141f8",90681:"c11a6e6e",91447:"b9846426",91721:"71acd643",91893:"6fc1809c",92045:"52a67516",92217:"c5a42c29",92423:"069d2532",92428:"2605919f",92514:"78d246dd",92599:"5e9ee3dd",92786:"9f3d753d",92916:"9755cc06",92955:"81357e24",92958:"519f3183",93041:"3bde6a31",93089:"9f3d61d4",93300:"338a9e60",93401:"bad52484",93690:"66834d12",94331:"11e553a6",94368:"d0d9f218",94875:"1f649e1a",95628:"42c1eef6",95921:"12bbc1b5",96017:"92025eb8",96120:"7b25beec",96514:"de2cf9f6",96915:"5e2492b1",96987:"34d5fe5b",97002:"280548b4",97159:"9713e494",97227:"472cbc48",97251:"58964465",97288:"7b94d332",97355:"01e2995d",97393:"1bc09864",97767:"e0be363a",97920:"e9e04170",97953:"eeefa800",98170:"9206b696",98327:"12f5691c",98532:"ce7eb2c0",98960:"cc2feaf5",99086:"983c6343",99124:"5cca45cb",99361:"c6acade6",99494:"928c3e3a",99924:"b60887e1",99964:"1414e8fb"}[e]+".js",t.miniCssF=e=>{},t.g=function(){if("object"==typeof globalThis)return globalThis;try{return this||new Function("return this")()}catch(e){if("object"==typeof window)return window}}(),t.o=(e,a)=>Object.prototype.hasOwnProperty.call(e,a),f={},b="docs:",t.l=(e,a,c,d)=>{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 b=f[e];if(delete f[e],r.parentNode&&r.parentNode.removeChild(r),b&&b.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:"77673",10210328:"38943",17896441:"27918",25622900:"61896",30997935:"36955",34767260:"72179",35300761:"96120",44287967:"49867",67386898:"20406",71748509:"97227",75281220:"57366",91008145:"42423",91392348:"60637",95366386:"34617","814d49b7":"125",aca8b082:"272",a0323d9f:"523","714e70d1":"648","6eb49eac":"728","64abd3af":"745",a00af9f0:"822","7aa856d6":"886",b985118d:"899","39ae3791":"955","9e8f4e9c":"1074","8abd0ba5":"1516","97a89ac0":"1782",dec87402:"1837","46b3c144":"1868",c5b2f0f9:"2193","920c2ac2":"2281","92d7df62":"2353","78b70dba":"2408",e064f6d4:"2866",bb6a5560:"2883","3462068c":"3102","6603ef13":"3207",d1c21237:"3342","3ba80b69":"3408","3819c331":"3537",ed75cfcb:"3584","3b68f98c":"3614",b6d76a6c:"3667","3109d9d2":"3745","2d629ea6":"3879","898514b1":"3954","160cb329":"3984",a334b453:"4004",fd684bd6:"4117","2bbe04e6":"4220","19eded63":"4459","24bda87b":"4918","330dfcdb":"4929","22de4147":"5240","724f3974":"5414","5e8fbcdf":"5417","164937d2":"5477","5c0f0993":"5674",e35d7c3e:"5697","57dba496":"5886","3866940b":"6082",cb0f21df:"6098","8677f412":"6102",reactPlayerSoundCloud:"6125",a2c6f402:"6266","8ccdb99f":"6639",c15d9823:"6642","786fee93":"7371","708d858d":"7377","07305c4a":"7809","927c84a6":"8039",ca6c9efa:"8335",e7923b27:"9055","4213e5b1":"9973","30a9912a":"10014",bc873533:"10038",e665718d:"10114","6269f1c0":"10138","3a4a1d3a":"10239",reactPlayerKaltura:"10261",bc816bf2:"10347",a943bcee:"10379","8873cf50":"10485",d46ef83d:"10579","7afa6340":"10588",adb00d9a:"10717","49d9416a":"11077","8e49e0b0":"11121",a4794f2e:"11161","4bdb36b8":"11648","5087625a":"11724",b799648a:"11981",reactPlayerFacebook:"12121","6c80b6fe":"12323",e7477a94:"12864",bd45720e:"13239",d83f208d:"13317",be228752:"13573","3720c009":"13751","01a1d0f4":"13826",a847366a:"13893","9c540f0b":"14026","40d377be":"14077","17d2ebc8":"14142","73f18a6f":"14499","06a27da2":"14824","732d4d9b":"15150","1dfee34e":"15554",a7456010:"15980",c25913f3:"16311","878aa0e7":"16467","6477cdc2":"16696",d9407a00:"16728",b7bb2d93:"16855","9f2f2cb3":"17194",c1ca9e21:"17285","04a546a4":"17329","688ee267":"17708","7d88b63f":"17741",a7bd4aaa:"18518","49a2e93c":"18649","524ce9a0":"18768",deccabf3:"18880","473de3ed":"19043","0029a336":"19093",db320b4a:"19204","0433ef30":"19282","0e72c11a":"19536",c1584a80:"19537",d9b4ee1e:"19841",d66cbd9e:"20044","54590fd2":"20138","2340b3ee":"20205",cabda5f8:"20873","4cb6c19a":"21046",ea3ffc82:"21181","9286a297":"21360",f7c9e078:"21364","8ae04122":"21534",f1ad83b2:"22182","125d93c1":"22228","7e93d479":"22978",bd80aa65:"23427","00e9d6a1":"23493","562ca3e9":"23840","610f2c47":"23937","22e2140b":"24260",ae79aff5:"24386","9542c76a":"24483","7bef3f04":"24498","280646e4":"24726",a9bc0f5d:"24787","9d887a11":"24904","33f367df":"25204",d496897e:"25211",ab69fe56:"25314","70e3b13c":"25817",b9a87183:"25821",reactPlayerFilePlayer:"26011","52ea62e7":"26116",c104141c:"26348","5e486140":"26557","4816649b":"26690","35dda5a2":"27104","5e30269e":"27135","4ec4c6cd":"27168","4f9e8711":"27177","38f19abb":"27222","57a8015d":"27268","423842d7":"27328",c358ebbc:"27910","7e2ae3df":"28143","006e489c":"28145","82170cf7":"28263","5b10a003":"28437","8eeedb31":"28682","5fb93fc0":"28813",c09ab32f:"29112","86f8c256":"29234","09b168a7":"29579","5e95c892":"29661","123a454a":"29693","0547cb65":"30060","0e3a398f":"30466","5ebdf64d":"30720",aba485c2:"30821",ae4a775b:"30901",c141421f:"31004","0341d436":"31402","7fa133e1":"31512","4f35c7a7":"31824","7d3ae564":"32360","65a10ffa":"32472","62e21724":"33067","330b5684":"33124","59a6f192":"33233","456c0e28":"33279","54d805e4":"33356",aba21aa0:"33629",fe716911:"33940","69c5f318":"34322","0c14b239":"34479","450c2e30":"34770",e1c8d71f:"34884","41b2e801":"35137","8cb0269b":"35281",b4df9b48:"35425","6774f806":"35572",b52d840d:"35584","79f18c88":"36006","86e64757":"36075",e73930cf:"36101",e3f28bf9:"36248",c9cac9d9:"36325",a3002291:"36424","0f54081d":"37073",b678a236:"37245","3d8d8999":"37437","48b6ff5f":"37573",df2a6e58:"37683",cd23aec9:"37698","7cde3c49":"37836","10ce918d":"37918","905702d2":"38056","1515c895":"38134","815c93fd":"38684",f26f8f05:"38780","1fbe0675":"39613",b51a9aee:"39620","25d1f3de":"39684","86f2a982":"40070",ed2a4846:"40486","8519c2b0":"40569",b39cdcf9:"40592","3e2b82eb":"40683","4d71dffe":"40816",a2d1ff94:"41169","6494b798":"41619","9db962b6":"41644",bd65ec7e:"41798",c361d244:"41869",edcfca88:"41902","0c4fad6b":"41976",b66ca8cf:"42205","7b477840":"42326","56c3a9b2":"43010","232c546d":"43163","23a8e291":"43274",db22fd17:"43474","57e01cd5":"43546","016e89ec":"43582","065365b3":"43871",f81c1134:"44031","416d4fcf":"44422",a9fa5b1f:"44619",c0c3bda5:"44654","12f1535e":"44781","080a9824":"44958","9af13eab":"45033",af231220:"45326","7f0476bd":"45346","1e582a71":"45603","97d49594":"45708","7547d3bb":"45835","46cf64bb":"45974",ccc49370:"46103",b104dd1e:"46623","8dbb6800":"46738","612345e6":"47389",reactPlayerDailyMotion:"47596",ffbee6a9:"47604","83245ae6":"47679","6864e844":"47718","021eaa84":"47875",f86eb50f:"48123","5660752d":"48176","1cfced13":"48215","6875c492":"48610","640277b9":"48901","60c82955":"48926","494e8e75":"49076","512fbd77":"50649","107d77e6":"51051","7e5a2776":"51171","46669adc":"51320","180d0c5f":"51499","4f9d299b":"51796",a2ffcc0f:"51843",fe0d4a0f:"51978","97c7db18":"52343","1a906644":"52525","814f3328":"52535",reactPlayerStreamable:"52546",e0277333:"52920","67eba1be":"52950","1df93b7f":"53237",cc922df3:"53273","883e2c3c":"53479",cd7fa15a:"53604","9e4087bc":"53608","7be672a3":"53691","97eb992d":"53800","0fa6e9bf":"54063","16ce7fd2":"54184","1d31e443":"54194",b5114993:"54373",edb40f78:"54632","42b67a8e":"54774","931e3b0a":"55904",f7197f43:"56805","9f97f9d1":"56843","5a3b561f":"56870","38a042e4":"57138","92b08985":"57321","6e30ac7b":"57368",bdb8b81b:"57549",fd702dc7:"57694","2658ced2":"57881","874690d0":"58216","059d1c6a":"58262",d9673b17:"58673","7a957b04":"58739","5db8318c":"58792",e6fb1369:"58800",d4bf7e47:"58989","5a7aef43":"59081","74c26f41":"59186","36994c47":"59208",a35cf155:"59341","0e384e19":"59671",d1163e47:"59860",d7ed6ffb:"59875",c6aad055:"60203",a3f8794a:"60334","8b4ba22f":"60564","14ae68e7":"60574","254d0ff5":"60810","901c37e5":"61021",f16d562f:"61110",e983a6d7:"61281","73f9658e":"61305",fc8a94e3:"61425",a33d13d7:"61476","87a5fc8a":"61573","1369aff7":"61866","74b658de":"62283",d1462701:"62325",c239db97:"62789","604e05e4":"62871",c6346fcf:"63154",e546fc5a:"63190",b8ec852b:"63407",ef5945f7:"63630","6e92edd9":"63652","8c6c72f9":"63707",ed1f6062:"63773",f771dec1:"63863","01a85c17":"64013","0058b4c6":"64088",reactPlayerMux:"64258","16914cba":"64315",d739767a:"64389",f20efc55:"64438",reactPlayerYouTube:"64439",cfdfe126:"64471","94f3d131":"64651",a30c0d44:"64891","1ee92283":"65144","3f29ba7c":"65181",d103759a:"65191","6101b3fc":"65248","97615df2":"65375","2ab17a83":"65431",f6cf66bc:"65619",f0e3a130:"65776","95646edb":"66000","2f8f53cb":"66112","28d80fa9":"66362",adcef0a2:"66464","014457dd":"66521","9684f8b7":"66743","583db3ef":"67363",b15eeff9:"67411",eb17771c:"67480","5c25e6fa":"67539","030ccfd9":"67690","0dd9aaeb":"67966",ca165b51:"68059",ff2f63f6:"68097","3132913e":"68732","3289a752":"68811",reactPlayerVidyard:"68888","8a864d1e":"68974",a08dfa31:"69006",b8eb0fce:"69584","7144043e":"69783",e1a2ab10:"70225","4b8121dd":"70534",ef2e2003:"70586","24dadce3":"70595","1fc83a28":"70633",fe1a05e2:"70900","814402d7":"70985","382e0557":"71426",de311ed4:"71625",fe9a92c0:"71781","64134c03":"71796",cc6d9416:"71874",adfdec4a:"71970","1a16e8bf":"72079","148448cb":"72092",f644aac7:"72303",c71cae97:"72491",abc85917:"72896",e6c31e60:"72931","7a21ccb0":"72996",cd343213:"73163",fc923f19:"73177",ed603d23:"73285","8b4dd820":"73636","894e67a6":"73714",reactPlayerVimeo:"73743",c7cac05f:"73867","2bb2c1cd":"74340","4c5becac":"74961",d83404a8:"74996","5046ea8f":"75167",f6cd0d3d:"75208","3c39daba":"75247",e69dadab:"75273",bf11c6a2:"75290","0102eb3e":"75542",c544b2d7:"75689",b7746a44:"75697",f27eaf88:"75741","8be8ac58":"75809",ada86621:"75862","19e69ccd":"76091","51e516cc":"76158","64bd32f2":"76192","94324b0e":"76267","591f7a5f":"76357","9dd60997":"76518",aaabcfd8:"76932","70bd0abb":"76952","7c7a772e":"77060","67fccd64":"77319",ca1234c1:"77401","01821883":"77683",b2973dc4:"77911",c2e1e282:"78127","360dc931":"78327","4b66c45e":"78416",d651e2ee:"78514",d4840880:"79106",c8eb055e:"79268","5bc09a53":"79649","3f66023b":"80161","98ced590":"80325",b5b19789:"80355","49bee2be":"80448",fb8cd692:"80511","4ec76dfa":"80900",df322e14:"80945","8c8ef21f":"80954","91a39dd0":"80957",e84cabb0:"81145",fee0a0be:"81580","4c217c25":"81900",d178b2c6:"81922","09788c0c":"82144",c813bd67:"82163","23b35f70":"82323",bbf561d5:"82388",df4d464e:"82409",b6be2912:"82424",fb50ea3a:"82451","368cce37":"82667","825ec378":"83039","4780c642":"83050","33a21d7d":"83152","8785b74d":"83672","8ca0e442":"83687","5df556a2":"83870","9f90a44b":"83945",f523fb3f:"83973",d5f6644b:"84006",fff8aeb8:"84413","6aa0b043":"84507","6763d4e0":"84513",f9fb4395:"84573",reactPlayerMixcloud:"84667",c11c87f7:"84940",b3b7dd16:"84960","1949cc8d":"85210",c44aa824:"85376","3f797343":"85632","0cab2b3a":"85714",f4271232:"85799","5b7d9ef2":"86112",reactPlayerTwitch:"86216",a0c37fdd:"86258","7500e360":"86272","271ff0d1":"86335",a38d285e:"86477","2cb13d6d":"86528","2f7d01f7":"86535","43be69c9":"86661","0877aebd":"87213",reactPlayerPreview:"87664",ff38b1ce:"87759",reactPlayerWistia:"88055","6eafe0c7":"88089","9dce5486":"88566",b9287eb6:"89251","8fe4c488":"89338","07f59c2a":"89372","5a9a7a02":"89472","81e486a8":"89626","9d2d4743":"89731","4f425ff4":"89799","12eb386e":"89950","185c52e7":"90051","7d9edfb8":"90125","308aae28":"90522",cdf64ea9:"90681","4974f5d2":"91447","3a38a610":"91721","871ce139":"91893",e6163b65:"92045",d7fbbe43:"92217","7258860f":"92423","9a22c80d":"92428",b5ec5208:"92514",e44de27e:"92599","81b69ac7":"92786","91fe1403":"92916",e6412603:"92955","86063cd3":"92958",a6aa9e1f:"93089",fa5f999e:"93300",c2865a15:"93401",f431c910:"93690",e38c422a:"94331",a94703ab:"94368",fbfd390f:"95921","6a1fe514":"96017",a826efc5:"96514",da802cf4:"96915",caddb1c0:"96987",a7777682:"97002",a8ce95ee:"97159",ba5b9f11:"97251","1c93995d":"97288","56a9df4f":"97355",acecf23e:"97393","17612ae7":"97767","1a4e3797":"97920",e88443f3:"97953",bab44fba:"98170",d1b15a6d:"98532","6bf124c2":"98960",dc23cd40:"99124","3a2db09e":"99361","93e05602":"99494",df203c0f:"99924"}[e]||e,t.p+t.u(e)},(()=>{var e={51303:0,40532: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(/^(40532|51303)$/.test(a))e[a]=0;else{var b=new Promise(((c,b)=>f=e[a]=[c,b]));c.push(f[2]=b);var d=t.p+t.u(a),r=new Error;t.l(d,(c=>{if(t.o(e,a)&&(0!==(f=e[a])&&(e[a]=void 0),f)){var b=c&&("load"===c.type?"missing":c.type),d=c&&c.target&&c.target.src;r.message="Loading chunk "+a+" failed.\n("+b+": "+d+")",r.name="ChunkLoadError",r.type=b,r.request=d,f[1](r)}}),"chunk-"+a,a)}},t.O.j=a=>0===e[a];var a=(a,c)=>{var f,b,d=c[0],r=c[1],o=c[2],l=0;if(d.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 - + 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 feff8254e27..016b2cbffca 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 cf58eaf3036..b6f12eb1b51 100644 --- a/blog/archive.html +++ b/blog/archive.html @@ -13,7 +13,7 @@ - + diff --git a/blog/develop-using-devcontainer.html b/blog/develop-using-devcontainer.html index abff62b4e2c..448ffb9d9a0 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 95ece158713..470fc3ba5be 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 c57034fc251..8dd596fd885 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 fd6e2ee2b47..a69af21654a 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 038452e789c..aa8a101a7bc 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 5ddcd6ee7ff..fcf96a99a12 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 8ab8073defe..062b34ee010 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 222b8166ae7..6aa659d259c 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 b0e4768bd6c..8fc239b510b 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 f3d2a63852f..15815589341 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 69d99245b13..4753fbf08c5 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 24275742275..731d26dcc41 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.2.html b/blog/podman-desktop-release-1.2.html index 0bccc631699..b9982dcb7e5 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 20b10157431..006856e61aa 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 9fe4306b88a..c23a5c7e90a 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 e7b6f3bcb76..672aa95d2f3 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 04072b3b8d7..9466e7629ac 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 7e4910ad25c..41a523c6696 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 3aca6309445..145584e8dc1 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 81bf2e641ce..b988d28f7da 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 3674c56d22b..21ef03977c7 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 a597b7de075..53cb4b7fdbd 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 de383a602ab..b6bac66e6d1 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 7623c7ce93a..be36cce51bc 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 69e05a46ef3..efa98cc69e7 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 26325647a4b..57696ac8d03 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 57d74b360fe..07526b007d2 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 c481932967c..f55c6ca5062 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 afd6b6bfce1..839dfb6db52 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 fba574e4a87..3b67b8686a8 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 eeaa8a9e83a..9c1327ad13d 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 0a331e55669..e695d81ae28 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 d0d356012fd..ed1c274edf0 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 d257bbee58d..ccb0d4131f1 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 98b9b4798cb..544c8c38471 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 c887d9e50de..a00c8350bf7 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 185f6d2162d..9329a1eb08c 100644 --- a/blog/tags/kubernetes.html +++ b/blog/tags/kubernetes.html @@ -13,7 +13,7 @@ - + diff --git a/blog/tags/migrating.html b/blog/tags/migrating.html index 553bfea5c35..a58907cb278 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 62918731f48..804ff534b9b 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 2a85d384f8a..0542bde763c 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 d4eaf23f676..ad9a27de1ee 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 f249cea1fd3..5e78ad40312 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 87f6ad0ff13..5e9b87d2719 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 a7ee4c48529..a6ac6d67a1c 100644 --- a/blog/tags/release.html +++ b/blog/tags/release.html @@ -13,7 +13,7 @@ - + diff --git a/blog/tags/settings.html b/blog/tags/settings.html index ea2be70adfc..5dfddb84668 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 f015c917a4f..f4756657979 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 afd4b172b23..c2beb624fe2 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 e0088bae075..65cf3c5bc03 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 8ce9ece9cf6..e71b339a040 100644 --- a/blog/tags/web-assembly.html +++ b/blog/tags/web-assembly.html @@ -13,7 +13,7 @@ - + diff --git a/blog/wasm-workloads-on-macos-and-windows-with-podman.html b/blog/wasm-workloads-on-macos-and-windows-with-podman.html index d6ed392a3ab..0a3f36f81b9 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 77664179d09..32625f6cdae 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 43c7d9e6a89..fee6bd56ba6 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 a5a02798e7c..b555ab4029a 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 420ba018096..24a3a22af28 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 fdee1e6533b..39a60acfe1c 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 d766060d236..11b44cce76d 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 344d9260c72..24edd796d83 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 129da154e80..69a2be03ec1 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 0da526e521f..b98a73fa74e 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 5e321a254d6..f09f48f905e 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 11584583bf0..3ba396eb464 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 34bc990215d..a68c5b08460 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 0c31d082bc5..822227debdd 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 377a7bb5151..28e2173b535 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 f8d43d28a4d..2469a8414e8 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 6311451236d..828aec9bc5e 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 6b3e9b9b079..ce34c9a2789 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 ab91ecde789..4dcfeae6091 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 c010f90153e..ff3a48e2ef4 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 dcaae166a05..da5b6c86964 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 f02f8ecb192..4565b53a981 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 5dbcfb2b7db..b9d5d84a496 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 545a8a396f6..dc42f8b5573 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 98d9cecd969..43236d912ee 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 d253684a23d..1ed35d31503 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 58b20a1edc6..05721687e59 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 a4b9c836d68..ad6e487705c 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 77552971705..50b6f997a4b 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 3693b71b525..0508a9744f3 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 4a2ead93bc7..ad44f8c6f30 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 e6e9aab4a09..516ecf193e3 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 e75ac20eb27..55c54927abb 100644 --- a/docs/extensions/publish.html +++ b/docs/extensions/publish.html @@ -13,7 +13,7 @@ - + diff --git a/docs/installation.html b/docs/installation.html index 6a10371c6a3..b01f7a14370 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 3f308223cf2..d65fd329621 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 efaa332c4c1..87d757570d5 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 958c92ee0ca..ad4e6bb78bd 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 74f2514515a..f29de39b8a1 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 dc2af6c292b..1f074989aa0 100644 --- a/docs/intro.html +++ b/docs/intro.html @@ -13,7 +13,7 @@ - + diff --git a/docs/kind.html b/docs/kind.html index ce296367f0a..baf08dbe11d 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 0b13cc54622..5742a4bdfe0 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 5a19bc08475..b4b72b90ed5 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 95b6062d31b..bb49b9c66cf 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 2cd7768c6d4..4a2f2a1f2d4 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 c02c704ece1..1186e34186a 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 48ca37b7413..f4f9d8525e1 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 96eab1fe990..cd44bb3c380 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 55bc4388df5..971dcf8bebb 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 2c6bc517be3..b1e3921613b 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 5a678da19af..bc75dfd40de 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 9c72eab61a0..ed64afdcd78 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 1aceebad740..dbeaa31b344 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 300ace4bd80..aeec06ac3c5 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 4b13bd289bb..719dab71af6 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 d0232335228..23f46a4b78a 100644 --- a/docs/kubernetes/minikube/pushing-an-image-to-minikube.html +++ b/docs/kubernetes/minikube/pushing-an-image-to-minikube.html @@ -13,7 +13,7 @@ - + diff --git a/docs/kubernetes/viewing-and-selecting-current-kubernete-context-in-the-status-bar.html b/docs/kubernetes/viewing-and-selecting-current-kubernete-context-in-the-status-bar.html index db9b66c35a5..20483050c67 100644 --- a/docs/kubernetes/viewing-and-selecting-current-kubernete-context-in-the-status-bar.html +++ b/docs/kubernetes/viewing-and-selecting-current-kubernete-context-in-the-status-bar.html @@ -13,7 +13,7 @@ - + diff --git a/docs/kubernetes/viewing-and-selecting-current-kubernete-context.html b/docs/kubernetes/viewing-and-selecting-current-kubernete-context.html index c7395528ad5..09ba94e27a8 100644 --- a/docs/kubernetes/viewing-and-selecting-current-kubernete-context.html +++ b/docs/kubernetes/viewing-and-selecting-current-kubernete-context.html @@ -13,7 +13,7 @@ - + diff --git a/docs/lima.html b/docs/lima.html index 42ab6a6fb40..b8776d9e57f 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 7bef4363117..9c1addd40bd 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 80c5ade93e6..07130b33ae8 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 e48753054b0..a448ba763a2 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 896209f9d91..a320b3a5f9f 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 918303842e0..b582fb68ebb 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 02272cbef8c..555ccb02600 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 d521183958a..0569cda3cfe 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 e31aa23a7ed..904c70f902c 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 b87008be151..671cd02bcfb 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 b72c149cf8f..7264f8b0455 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 804ebcd0dba..11fc8831ecf 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 f73f3bd5074..ee0bd67b1a6 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 0d8f3f504b9..ee710f0f78b 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 86755f95542..c6fc3fe807c 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 02e272b06a4..ff217aea62c 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 dacdef9177a..86150321388 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 cc933e86cc3..bf869bd0416 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 f66aa268e3c..e3870fc6864 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 98bb1c81779..7f26b91be89 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 880438366d4..e48e3c1d0c0 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 6f4e2914eff..bcdb1585b5f 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 106ee8332a4..4d613b7c720 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 06bab096dd7..66f5cff0dd6 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 25e3719e2e5..97b092124aa 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 a82092ca970..7fe15cd677a 100644 --- a/docs/podman/creating-a-podman-machine.html +++ b/docs/podman/creating-a-podman-machine.html @@ -13,7 +13,7 @@ - + diff --git a/docs/podman/setting-podman-machine-default-connection.html b/docs/podman/setting-podman-machine-default-connection.html index c0e10a513af..22a891161f2 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 8697d94d4dd..e9a9f46f7b4 100644 --- a/docs/proxy.html +++ b/docs/proxy.html @@ -13,7 +13,7 @@ - + diff --git a/docs/tags.html b/docs/tags.html index a4ae403f2cf..0c1f44020a0 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 54681b96d76..7c0a27b1c00 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 9761e1f5bfd..1a41dc410aa 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 00068de84cb..c41ed7649b8 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 5282aca0fd7..c93e97ea571 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 a9773422d0d..a8716648348 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 31be906b26f..0db5ad83cf3 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 34487818f93..b34759d8c38 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 c587bb9380d..0040234c2ba 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 015ec60c774..2ab07ee9ce5 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 3de67520da7..58306a5f569 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 2b6669ea9c8..8824ed19793 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 5473db162c7..d03b60e543b 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 817e599464c..ef452791c48 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 f9fe1ea889e..074d27f59b2 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 3b59424ba51..43279663451 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 479180f9a65..6ea46cd88ec 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 7b5fa12aab4..1f95bb5b62c 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 0a1499ecbd1..a7a46724f10 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 f6b2e5de459..42e178ba3a4 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 eb37f3ad57a..fb4908e13c0 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 39097a079db..59f06e3fcca 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 51537c2d948..fad413e1d82 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 2f92aef801a..4a3c57966cc 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 998ea694dd2..f90f23d17c8 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 ff1da3252b9..aaffb3457ef 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 bcc04e1292c..3d999cecf52 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 e42ad3dc167..f927e72735e 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 1325e8769e5..3d576bc0b9a 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 7d6ae3b02ca..bd2cec655fa 100644 --- a/docs/tags/publishing.html +++ b/docs/tags/publishing.html @@ -13,7 +13,7 @@ - + diff --git a/docs/tags/when-clause.html b/docs/tags/when-clause.html index 3941b8238d9..36a1434893c 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 f6237be3eea..f176d156150 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 85fd828d49c..b6b904d6c3f 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 c7b95fb9d12..04b50b4bcf8 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 90c8b5824b0..3cb8ed50c84 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 4a16ffedad6..85991754316 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 3c16cd26c53..9387dc34f10 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 15de6012877..86cf8ecf249 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 dd33dc7fb52..cce67362cc6 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 c04b5ecefab..8da372fdf8d 100644 --- a/downloads.html +++ b/downloads.html @@ -13,7 +13,7 @@ - + diff --git a/downloads/linux.html b/downloads/linux.html index 70b065adcbd..3443860aa89 100644 --- a/downloads/linux.html +++ b/downloads/linux.html @@ -13,7 +13,7 @@ - + diff --git a/downloads/macos.html b/downloads/macos.html index 132af7d99e0..68df382842f 100644 --- a/downloads/macos.html +++ b/downloads/macos.html @@ -13,7 +13,7 @@ - + diff --git a/downloads/windows.html b/downloads/windows.html index 65fd71f8891..4e28932a7ff 100644 --- a/downloads/windows.html +++ b/downloads/windows.html @@ -13,7 +13,7 @@ - + diff --git a/extend.html b/extend.html index 4ab7902ce1b..0e0d0e1d370 100644 --- a/extend.html +++ b/extend.html @@ -13,7 +13,7 @@ - + diff --git a/extensions/ai-lab.html b/extensions/ai-lab.html index 2586832346e..c9763e3f3c7 100644 --- a/extensions/ai-lab.html +++ b/extensions/ai-lab.html @@ -13,7 +13,7 @@ - + diff --git a/features.html b/features.html index fc405095b41..ddaf121fe85 100644 --- a/features.html +++ b/features.html @@ -13,7 +13,7 @@ - + diff --git a/index.html b/index.html index ea58dd01b51..2566fd9de1e 100644 --- a/index.html +++ b/index.html @@ -13,7 +13,7 @@ - + diff --git a/search.html b/search.html index d91b6fdb320..ab82117fe44 100644 --- a/search.html +++ b/search.html @@ -13,7 +13,7 @@ - + diff --git a/storybook.html b/storybook.html index e1de6a9cd05..dc133db5ee5 100644 --- a/storybook.html +++ b/storybook.html @@ -13,7 +13,7 @@ - +