From e2ed9ac5ccc4d97626860573db293a56ba2ee1ce Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Mon, 15 Apr 2024 10:17:14 +0000 Subject: [PATCH] deploy: f068631650816dc547581dcfb6cd86714f5f90b2 --- 404.html | 2 +- api.html | 2 +- api/classes/CancellationTokenSource.html | 8 +- api/classes/Disposable.html | 12 +- api/classes/EventEmitter.html | 8 +- api/classes/TelemetryTrustedValue.html | 6 +- api/classes/Uri.html | 26 ++-- .../InputBoxValidationSeverity.html | 8 +- api/enumerations/ProgressLocation.html | 6 +- api/enumerations/QuickPickItemKind.html | 6 +- api/interfaces/AuditRecord.html | 6 +- api/interfaces/AuditRequestItems.html | 2 +- api/interfaces/AuditResult.html | 4 +- api/interfaces/Auditor.html | 4 +- api/interfaces/AuthConfig.html | 10 +- .../AuthenticationGetSessionOptions.html | 10 +- api/interfaces/AuthenticationProvider.html | 10 +- ...iderAuthenticationSessionsChangeEvent.html | 8 +- .../AuthenticationProviderInformation.html | 6 +- .../AuthenticationProviderOptions.html | 6 +- api/interfaces/AuthenticationSession.html | 10 +- ...thenticationSessionAccountInformation.html | 6 +- .../AuthenticationSessionsChangeEvent.html | 4 +- api/interfaces/BlkioStatEntry.html | 10 +- api/interfaces/BlkioStats.html | 18 +-- api/interfaces/BuildImageOptions.html | 54 +++---- api/interfaces/CPUStats.html | 10 +- api/interfaces/CPUUsage.html | 10 +- api/interfaces/CancellationToken.html | 6 +- api/interfaces/CheckResult.html | 12 +- api/interfaces/CheckResultFixCommand.html | 6 +- api/interfaces/CliTool.html | 24 ++-- api/interfaces/CliToolOptions.html | 14 +- api/interfaces/CliToolUpdate.html | 6 +- api/interfaces/CliToolUpdateOptions.html | 12 +- api/interfaces/Clipboard.html | 6 +- api/interfaces/Command.html | 10 +- api/interfaces/Configuration.html | 10 +- api/interfaces/ConfigurationChangeEvent.html | 4 +- api/interfaces/ContainerAuthInfo.html | 10 +- api/interfaces/ContainerCreateOptions.html | 68 ++++----- api/interfaces/ContainerCreateResult.html | 4 +- api/interfaces/ContainerEngineInfo.html | 20 +-- api/interfaces/ContainerInfo.html | 34 ++--- api/interfaces/ContainerInspectInfo.html | 52 +++---- api/interfaces/ContainerJSONEvent.html | 10 +- .../ContainerProviderConnection.html | 12 +- .../ContainerProviderConnectionEndpoint.html | 4 +- .../ContainerProviderConnectionFactory.html | 10 +- api/interfaces/ContainerStatsInfo.html | 26 ++-- api/interfaces/CustomPick.html | 26 ++-- api/interfaces/CustomPickItem.html | 12 +- api/interfaces/CustomPickSectionItem.html | 8 +- api/interfaces/DeviceRequest.html | 12 +- api/interfaces/EndpointIPAMConfig.html | 8 +- api/interfaces/EndpointSettings.html | 30 ++-- api/interfaces/Event.html | 4 +- api/interfaces/ExtensionContext.html | 10 +- api/interfaces/FileSystemWatcher.html | 10 +- api/interfaces/GenerateKubeResult.html | 4 +- api/interfaces/HealthCheckLog.html | 10 +- api/interfaces/HealthCheckResults.html | 8 +- api/interfaces/HealthConfig.html | 12 +- api/interfaces/HostConfig.html | 136 +++++++++--------- api/interfaces/HostRestartPolicy.html | 6 +- api/interfaces/IPAM.html | 8 +- api/interfaces/ImageCheck.html | 10 +- api/interfaces/ImageCheckerProvider.html | 4 +- .../ImageCheckerProviderMetadata.html | 4 +- api/interfaces/ImageChecks.html | 4 +- api/interfaces/ImageInfo.html | 30 ++-- api/interfaces/ImageInspectInfo.html | 40 +++--- api/interfaces/InputBoxOptions.html | 22 +-- api/interfaces/InputBoxValidationMessage.html | 6 +- api/interfaces/InstallCheck.html | 8 +- api/interfaces/KubeconfigUpdateEvent.html | 6 +- .../KubernetesGeneratorProvider.html | 8 +- .../KubernetesProviderConnection.html | 10 +- .../KubernetesProviderConnectionEndpoint.html | 4 +- .../KubernetesProviderConnectionFactory.html | 10 +- api/interfaces/LifecycleContext.html | 4 +- api/interfaces/Link.html | 8 +- api/interfaces/ListImagesOptions.html | 4 +- api/interfaces/ListInfosOptions.html | 4 +- api/interfaces/Logger.html | 8 +- api/interfaces/ManifestCreateOptions.html | 12 +- api/interfaces/MemoryStats.html | 18 +-- api/interfaces/MenuItem.html | 18 +-- api/interfaces/MountSettings.html | 20 +-- api/interfaces/NetworkContainer.html | 12 +- api/interfaces/NetworkCreateOptions.html | 4 +- api/interfaces/NetworkCreateResult.html | 4 +- api/interfaces/NetworkInfo.html | 26 ++-- api/interfaces/NetworkInspectInfo.html | 38 ++--- api/interfaces/NetworkStats.html | 2 +- api/interfaces/NetworkingConfig.html | 4 +- api/interfaces/NotificationOptions.html | 14 +- api/interfaces/OpenDialogOptions.html | 12 +- api/interfaces/PidsStats.html | 6 +- api/interfaces/PodContainerInfo.html | 8 +- api/interfaces/PodCreateOptions.html | 10 +- api/interfaces/PodCreatePortOptions.html | 12 +- api/interfaces/PodInfo.html | 28 ++-- .../PodmanContainerCreateOptions.html | 18 +-- api/interfaces/Port.html | 10 +- api/interfaces/PortBinding.html | 6 +- api/interfaces/PortMap.html | 2 +- api/interfaces/Progress.html | 4 +- api/interfaces/ProgressOptions.html | 8 +- api/interfaces/Provider.html | 52 +++---- api/interfaces/ProviderAutostart.html | 4 +- api/interfaces/ProviderCleanup.html | 4 +- api/interfaces/ProviderCleanupAction.html | 6 +- .../ProviderCleanupExecuteOptions.html | 6 +- api/interfaces/ProviderConnectionFactory.html | 8 +- .../ProviderConnectionLifecycle.html | 10 +- .../ProviderContainerConnection.html | 6 +- api/interfaces/ProviderDetectionCheck.html | 8 +- api/interfaces/ProviderEvent.html | 8 +- api/interfaces/ProviderImages.html | 6 +- api/interfaces/ProviderInformation.html | 6 +- api/interfaces/ProviderInstallation.html | 6 +- api/interfaces/ProviderLifecycle.html | 10 +- api/interfaces/ProviderOptions.html | 20 +-- api/interfaces/ProviderUpdate.html | 8 +- api/interfaces/ProxySettings.html | 8 +- api/interfaces/PullEvent.html | 16 +-- api/interfaces/QuickInputButton.html | 6 +- api/interfaces/QuickPickItem.html | 16 +-- api/interfaces/QuickPickOptions.html | 16 +-- .../RegisterContainerConnectionEvent.html | 6 +- .../RegisterKubernetesConnectionEvent.html | 4 +- api/interfaces/Registry.html | 16 +-- api/interfaces/RegistryConfig.html | 2 +- api/interfaces/RegistryCreateOptions.html | 10 +- api/interfaces/RegistryProvider.html | 6 +- api/interfaces/RegistrySuggestedProvider.html | 8 +- api/interfaces/RunError.html | 16 +-- api/interfaces/RunOptions.html | 14 +- api/interfaces/RunResult.html | 8 +- api/interfaces/SaveDialogOptions.html | 10 +- api/interfaces/SecretStorage.html | 10 +- api/interfaces/SecretStorageChangeEvent.html | 4 +- api/interfaces/StatusBarItem.html | 24 ++-- api/interfaces/StorageStats.html | 10 +- api/interfaces/TelemetryLogger.html | 16 +-- api/interfaces/TelemetryLoggerOptions.html | 8 +- api/interfaces/TelemetrySender.html | 8 +- api/interfaces/ThrottlingData.html | 8 +- .../UnregisterContainerConnectionEvent.html | 4 +- .../UnregisterKubernetesConnectionEvent.html | 4 +- .../UpdateContainerConnectionEvent.html | 8 +- .../UpdateKubernetesConnectionEvent.html | 8 +- api/interfaces/VolumeCreateOptions.html | 6 +- api/interfaces/VolumeCreateResponseInfo.html | 16 +-- api/interfaces/VolumeDeleteOptions.html | 4 +- api/interfaces/VolumeInfo.html | 26 ++-- api/interfaces/VolumeListInfo.html | 10 +- api/interfaces/Webview.html | 14 +- api/interfaces/WebviewInfo.html | 8 +- api/interfaces/WebviewOptions.html | 4 +- api/interfaces/WebviewPanel.html | 22 +-- ...WebviewPanelOnDidChangeViewStateEvent.html | 4 +- api/namespaces/authentication.html | 2 +- .../authentication/functions/getSession.html | 6 +- .../functions/onDidChangeSessions.html | 4 +- .../registerAuthenticationProvider.html | 4 +- api/namespaces/cli.html | 2 +- .../cli/functions/createCliTool.html | 4 +- api/namespaces/commands.html | 2 +- .../commands/functions/executeCommand.html | 4 +- .../commands/functions/registerCommand.html | 4 +- api/namespaces/configuration.html | 2 +- .../functions/getConfiguration.html | 4 +- .../functions/onDidChangeConfiguration.html | 4 +- api/namespaces/containerEngine.html | 2 +- .../containerEngine/functions/buildImage.html | 4 +- .../functions/createContainer.html | 4 +- .../functions/createManifest.html | 4 +- .../functions/createNetwork.html | 4 +- .../containerEngine/functions/createPod.html | 4 +- .../functions/createVolume.html | 4 +- .../functions/deleteContainer.html | 4 +- .../functions/deleteImage.html | 4 +- .../functions/deleteVolume.html | 4 +- .../functions/getImageInspect.html | 4 +- .../containerEngine/functions/info.html | 4 +- .../functions/inspectContainer.html | 4 +- .../functions/listContainers.html | 4 +- .../containerEngine/functions/listImages.html | 4 +- .../containerEngine/functions/listInfos.html | 4 +- .../functions/listNetworks.html | 4 +- .../containerEngine/functions/listPods.html | 4 +- .../functions/listVolumes.html | 4 +- .../functions/logsContainer.html | 4 +- .../containerEngine/functions/onEvent.html | 4 +- .../containerEngine/functions/pullImage.html | 4 +- .../containerEngine/functions/pushImage.html | 4 +- .../containerEngine/functions/removePod.html | 4 +- .../functions/replicatePodmanContainer.html | 4 +- .../containerEngine/functions/saveImage.html | 4 +- .../functions/startContainer.html | 4 +- .../containerEngine/functions/startPod.html | 4 +- .../functions/statsContainer.html | 4 +- .../functions/stopContainer.html | 4 +- .../containerEngine/functions/stopPod.html | 4 +- .../containerEngine/functions/tagImage.html | 4 +- api/namespaces/context.html | 2 +- .../context/functions/setValue.html | 4 +- api/namespaces/env.html | 2 +- .../env/functions/createTelemetryLogger.html | 4 +- .../onDidChangeTelemetryEnabled.html | 4 +- .../env/functions/openExternal.html | 4 +- api/namespaces/env/variables/clipboard.html | 4 +- api/namespaces/env/variables/isLinux.html | 4 +- api/namespaces/env/variables/isMac.html | 4 +- .../env/variables/isTelemetryEnabled.html | 4 +- api/namespaces/env/variables/isWindows.html | 4 +- api/namespaces/fs.html | 2 +- .../fs/functions/createFileSystemWatcher.html | 4 +- api/namespaces/imageChecker.html | 2 +- .../registerImageCheckerProvider.html | 4 +- api/namespaces/kubernetes.html | 2 +- .../kubernetes/functions/createResources.html | 4 +- .../kubernetes/functions/getKubeconfig.html | 4 +- .../functions/onDidUpdateKubeconfig.html | 4 +- .../registerKubernetesGenerator.html | 4 +- .../kubernetes/functions/setKubeconfig.html | 4 +- api/namespaces/navigation.html | 2 +- .../functions/navigateToAuthentication.html | 4 +- .../functions/navigateToContainer.html | 4 +- .../functions/navigateToContainerInspect.html | 4 +- .../functions/navigateToContainerLogs.html | 4 +- .../navigateToContainerTerminal.html | 4 +- .../functions/navigateToContainers.html | 4 +- .../functions/navigateToContribution.html | 4 +- ...gateToEditProviderContainerConnection.html | 4 +- .../navigation/functions/navigateToImage.html | 4 +- .../functions/navigateToImages.html | 4 +- .../navigation/functions/navigateToPod.html | 4 +- .../navigation/functions/navigateToPods.html | 4 +- .../functions/navigateToResources.html | 4 +- .../functions/navigateToVolume.html | 4 +- .../functions/navigateToVolumes.html | 4 +- .../functions/navigateToWebview.html | 4 +- api/namespaces/process.html | 2 +- api/namespaces/process/functions/exec.html | 4 +- api/namespaces/provider.html | 2 +- .../provider/functions/createProvider.html | 4 +- .../functions/getContainerConnections.html | 4 +- .../getProviderLifecycleContext.html | 4 +- .../onDidRegisterContainerConnection.html | 4 +- .../onDidUnregisterContainerConnection.html | 4 +- .../onDidUpdateContainerConnection.html | 4 +- .../onDidUpdateKubernetesConnection.html | 4 +- .../functions/onDidUpdateProvider.html | 4 +- api/namespaces/proxy.html | 2 +- .../proxy/functions/getProxySettings.html | 4 +- api/namespaces/proxy/functions/isEnabled.html | 4 +- .../proxy/functions/onDidStateChange.html | 4 +- .../proxy/functions/onDidUpdateProxy.html | 4 +- api/namespaces/proxy/functions/setProxy.html | 4 +- api/namespaces/registry.html | 2 +- .../functions/onDidRegisterRegistry.html | 4 +- .../functions/onDidUnregisterRegistry.html | 4 +- .../functions/onDidUpdateRegistry.html | 4 +- .../registry/functions/registerRegistry.html | 4 +- .../functions/registerRegistryProvider.html | 4 +- .../registry/functions/suggestRegistry.html | 4 +- .../functions/unregisterRegistry.html | 4 +- api/namespaces/tray.html | 2 +- .../tray/functions/registerMenuItem.html | 4 +- .../functions/registerProviderMenuItem.html | 4 +- api/namespaces/window.html | 2 +- .../window/functions/createCustomPick.html | 4 +- .../window/functions/createStatusBarItem.html | 4 +- .../window/functions/createWebviewPanel.html | 4 +- .../window/functions/listWebviews.html | 4 +- .../window/functions/showErrorMessage.html | 4 +- .../functions/showInformationMessage.html | 4 +- .../window/functions/showInputBox.html | 4 +- .../window/functions/showNotification.html | 4 +- .../window/functions/showOpenDialog.html | 4 +- .../window/functions/showQuickPick.html | 10 +- .../window/functions/showSaveDialog.html | 4 +- .../window/functions/showWarningMessage.html | 4 +- .../window/functions/withProgress.html | 4 +- api/type-aliases/CheckResultLink.html | 4 +- api/type-aliases/CliToolState.html | 4 +- api/type-aliases/ConfigurationScope.html | 4 +- .../KubernetesGeneratorArgument.html | 4 +- .../KubernetesGeneratorSelector.html | 4 +- api/type-aliases/KubernetesGeneratorType.html | 4 +- api/type-aliases/MountConfig.html | 4 +- api/type-aliases/MountConsistency.html | 4 +- api/type-aliases/MountPropagation.html | 4 +- api/type-aliases/MountType.html | 4 +- api/type-aliases/NotificationType.html | 4 +- .../ProviderConnectionStatus.html | 4 +- api/type-aliases/ProviderLinks.html | 4 +- api/type-aliases/ProviderResult.html | 4 +- api/type-aliases/ProviderStatus.html | 4 +- api/type-aliases/StatusBarAlignment.html | 4 +- api/variables/StatusBarAlignLeft.html | 4 +- api/variables/StatusBarAlignRight.html | 4 +- .../StatusBarItemDefaultPriority.html | 4 +- api/variables/version.html | 4 +- ...9a336.92f134a4.js => 0029a336.b6586be4.js} | 2 +- ...2eb3e.570ca7d7.js => 0102eb3e.ec2383d1.js} | 2 +- ...21883.a60e5b32.js => 01821883.af5c3e62.js} | 2 +- ...1d0f4.ba9ae5ce.js => 01a1d0f4.cfacb70c.js} | 2 +- ...ccfd9.6af5542e.js => 030ccfd9.6701e3f5.js} | 2 +- ...546a4.9cbb3615.js => 04a546a4.cc60c712.js} | 2 +- ...7cb65.c85f6a89.js => 0547cb65.9966a371.js} | 2 +- ...365b3.f497ef4d.js => 065365b3.17d68896.js} | 2 +- ...27da2.d66ed147.js => 06a27da2.d6352c85.js} | 2 +- ...7aebd.678da894.js => 0877aebd.3d19e135.js} | 2 +- ...4b239.81af500f.js => 0c14b239.43bce9c3.js} | 2 +- ...fad6b.d4930aaf.js => 0c4fad6b.a3c675d8.js} | 2 +- ...b2b3a.d0a1f8f9.js => 0cab2b3a.0f34acb7.js} | 2 +- ...a398f.41910b52.js => 0e3a398f.983c8ec6.js} | 2 +- ...2c11a.40b87b3a.js => 0e72c11a.d764a4f4.js} | 2 +- ...4081d.93573599.js => 0f54081d.789a7dd1.js} | 2 +- ...6e9bf.8176967b.js => 0fa6e9bf.e677d805.js} | 2 +- ...d77e6.4c4887bd.js => 107d77e6.e3726056.js} | 2 +- ...a454a.c7fc15b7.js => 123a454a.18a2679b.js} | 2 +- ...d93c1.a5a33191.js => 125d93c1.62423075.js} | 2 +- ...b386e.987442d4.js => 12eb386e.8cd4f506.js} | 2 +- ...448cb.1c3ea32f.js => 148448cb.cd99b6a9.js} | 2 +- ...e68e7.8e966750.js => 14ae68e7.563eb837.js} | 2 +- ...5c895.b4fc0e7a.js => 1515c895.6929d8ee.js} | 2 +- ...cb329.b697a9ed.js => 160cb329.e6d0fc05.js} | 2 +- ...937d2.b8ed4032.js => 164937d2.5328b998.js} | 2 +- ...14cba.9101c7ce.js => 16914cba.22f20107.js} | 2 +- ...12ae7.84bb1e5e.js => 17612ae7.8a1f3e26.js} | 2 +- ...2ebc8.52d258b6.js => 17d2ebc8.fb8007b9.js} | 2 +- ...d0c5f.f9a48f81.js => 180d0c5f.472b25a6.js} | 2 +- ...c52e7.872aa714.js => 185c52e7.81fc27f9.js} | 2 +- ...69ccd.d71a6bd7.js => 19e69ccd.579209e3.js} | 2 +- ...06644.21eb35f6.js => 1a906644.4287c938.js} | 2 +- ...ee34e.dfca0ffb.js => 1dfee34e.dbcae126.js} | 2 +- ...92283.5647ff83.js => 1ee92283.5ea9394d.js} | 2 +- ...e0675.423a5b51.js => 1fbe0675.ccd83d73.js} | 2 +- ...83a28.d12148e2.js => 1fc83a28.8bbe08a8.js} | 2 +- ...2140b.e38943cf.js => 22e2140b.be32d1c9.js} | 2 +- ...0b3ee.25f180af.js => 2340b3ee.bcd754dd.js} | 2 +- ...8e291.4c4a4c64.js => 23a8e291.53f0f9ff.js} | 2 +- ...adce3.853597a2.js => 24dadce3.cfee6fc8.js} | 2 +- ...d0ff5.2442ecbb.js => 254d0ff5.0cfbe8c9.js} | 2 +- ...ff0d1.f84e17f8.js => 271ff0d1.a6cdce94.js} | 2 +- ...646e4.189c0e50.js => 280646e4.44065112.js} | 2 +- ...2c1cd.82fb5fa6.js => 2bb2c1cd.5a1566a9.js} | 2 +- ...13d6d.6c544606.js => 2cb13d6d.4bd23de0.js} | 2 +- ...9d9d2.b988a45f.js => 3109d9d2.91d5e17b.js} | 2 +- ...2913e.83a3dc68.js => 3132913e.f39d3682.js} | 2 +- assets/js/35300761.2078a56d.js | 1 + assets/js/35300761.b8007215.js | 1 - ...6940b.c2fd7ce4.js => 3866940b.9582348f.js} | 2 +- ...e3791.a43fc0cc.js => 39ae3791.7666bfbb.js} | 2 +- ...8a610.d8ef876e.js => 3a38a610.c2f3b4bc.js} | 2 +- ...80b69.6a2248b1.js => 3ba80b69.b9e2e547.js} | 2 +- ...b82eb.67b26f21.js => 3e2b82eb.bc92317e.js} | 2 +- ...6023b.17485265.js => 3f66023b.6b74b140.js} | 2 +- ...97343.14381b38.js => 3f797343.9695e3da.js} | 2 +- ...377be.f82b3048.js => 40d377be.555a9011.js} | 2 +- ...d4fcf.1c0e95c6.js => 416d4fcf.12805bec.js} | 2 +- ...2e801.e153f008.js => 41b2e801.b724f400.js} | 2 +- ...842d7.acf693fd.js => 423842d7.c3922d88.js} | 2 +- ...67a8e.ae8f374d.js => 42b67a8e.1d462849.js} | 2 +- ...e69c9.5cc7765f.js => 43be69c9.9e2f4325.js} | 2 +- assets/js/44287967.935386d3.js | 1 - assets/js/44287967.e926313c.js | 1 + ...c0e28.d959dd31.js => 456c0e28.27dcf5a9.js} | 2 +- ...69adc.7ef9ccbf.js => 46669adc.c54854c8.js} | 2 +- ...3c144.b6032b59.js => 46b3c144.1e68703a.js} | 2 +- ...e8e75.ff6efc1f.js => 494e8e75.64e87537.js} | 2 +- ...ee2be.f2002d66.js => 49bee2be.a456763c.js} | 2 +- ...9416a.9c1c7d1c.js => 49d9416a.e1d5d91d.js} | 2 +- ...17c25.480c06c7.js => 4c217c25.8f39ef22.js} | 2 +- ...becac.3618ce01.js => 4c5becac.0f710a8d.js} | 2 +- ...25ff4.31bb7041.js => 4f425ff4.f22994fc.js} | 2 +- ...e8711.62877687.js => 4f9e8711.bbd18f66.js} | 2 +- ...6ea8f.5cdba6a6.js => 5046ea8f.9a75988c.js} | 2 +- ...805e4.20c0735c.js => 54d805e4.a5d47a8f.js} | 2 +- ...8015d.97495d30.js => 57a8015d.7d826a7d.js} | 2 +- ...ba496.654997fe.js => 57dba496.54764f63.js} | 2 +- assets/js/57e01cd5.02acec70.js | 1 - assets/js/57e01cd5.8635c150.js | 1 + ...aef43.78593a3e.js => 5a7aef43.39e50b6c.js} | 2 +- ...a7a02.39f1c3c1.js => 5a9a7a02.a8f5f98e.js} | 2 +- ...0a003.4567b66d.js => 5b10a003.e57f7289.js} | 2 +- ...d9ef2.efa9bcd8.js => 5b7d9ef2.b16878c3.js} | 2 +- ...09a53.fd285884.js => 5bc09a53.d139a151.js} | 2 +- ...f0993.18d7fdbf.js => 5c0f0993.4e66892c.js} | 2 +- ...8318c.69caefe3.js => 5db8318c.5b84086f.js} | 2 +- ...0269e.b8232d0d.js => 5e30269e.34c618e1.js} | 2 +- ...86140.e0dda424.js => 5e486140.8fe86923.js} | 2 +- ...fbcdf.521014a7.js => 5e8fbcdf.8d05d07e.js} | 2 +- ...e05e4.7681f7c1.js => 604e05e4.01d5de6a.js} | 2 +- ...82955.a0d0937b.js => 60c82955.c82ac906.js} | 2 +- ...f2c47.b383cecf.js => 610f2c47.0d2aa192.js} | 2 +- ...345e6.955e4166.js => 612345e6.7d26d63e.js} | 2 +- ...21724.e85152be.js => 62e21724.82dcbf9f.js} | 2 +- ...277b9.4daaabe9.js => 640277b9.c441a0a4.js} | 2 +- ...34c03.97f21a99.js => 64134c03.0c1b6feb.js} | 2 +- ...7cdc2.40c887b4.js => 6477cdc2.f8ec3a84.js} | 2 +- ...4b798.542dea5b.js => 6494b798.25e58aff.js} | 2 +- ...86898.7394d6c9.js => 67386898.c2a2c38c.js} | 2 +- ...3d4e0.fd7e99c8.js => 6763d4e0.67e59d17.js} | 2 +- ...4f806.93c6fe56.js => 6774f806.9ee49dd1.js} | 2 +- ...ba1be.5ae1a8ca.js => 67eba1be.86b64c58.js} | 2 +- ...ccd64.93652144.js => 67fccd64.3f6541ed.js} | 2 +- ...ee267.9fc5aec0.js => 688ee267.8f8d5f25.js} | 2 +- ...fe514.085c2aa8.js => 6a1fe514.ba067b5b.js} | 2 +- ...0b043.22a2843d.js => 6aa0b043.67706045.js} | 2 +- ...0ac7b.8545b1d6.js => 6e30ac7b.a0526b47.js} | 2 +- ...2edd9.74f06cbe.js => 6e92edd9.c9596b0e.js} | 2 +- ...fe0c7.304211a7.js => 6eafe0c7.80d11545.js} | 2 +- ...3b13c.86b953f4.js => 70e3b13c.2034da55.js} | 2 +- ...e70d1.e8aa7547.js => 714e70d1.9b5a36d6.js} | 2 +- ...48509.e56064a2.js => 71748509.ed3b7894.js} | 2 +- ...8860f.68820e48.js => 7258860f.306f4d7e.js} | 2 +- ...18a6f.9ecd316f.js => 73f18a6f.5462fb52.js} | 2 +- ...9658e.8e2732f7.js => 73f9658e.55449af1.js} | 2 +- ...658de.9477da39.js => 74b658de.0a0f47e0.js} | 2 +- ...0e360.f1814908.js => 7500e360.e298db0a.js} | 2 +- ...7d3bb.9f44d157.js => 7547d3bb.fffbdd9e.js} | 2 +- ...fee93.d444be09.js => 786fee93.dba84eb4.js} | 2 +- ...18c88.3fe305ab.js => 79f18c88.d71a505f.js} | 2 +- ...856d6.8cadbd75.js => 7aa856d6.0c28b7a8.js} | 2 +- ...f3f04.c8701684.js => 7bef3f04.2a0b9418.js} | 2 +- ...a772e.3175a757.js => 7c7a772e.8c0ceae2.js} | 2 +- ...e3c49.c7a15492.js => 7cde3c49.006b7055.js} | 2 +- ...edfb8.481f6f48.js => 7d9edfb8.19b21b61.js} | 2 +- ...ae3df.a7deb713.js => 7e2ae3df.4280abc5.js} | 2 +- ...a2776.b7d8320e.js => 7e5a2776.4405dd1f.js} | 2 +- ...476bd.20f2374d.js => 7f0476bd.e7165f51.js} | 2 +- ...133e1.962898de.js => 7fa133e1.bd68b85a.js} | 2 +- ...402d7.168ecaa5.js => 814402d7.4b3642f5.js} | 2 +- ...d49b7.f35d1c27.js => 814d49b7.d64be048.js} | 2 +- ...69ac7.12bfd79d.js => 81b69ac7.e88b3c8e.js} | 2 +- ...70cf7.ef992965.js => 82170cf7.da09643d.js} | 2 +- ...ec378.4d60eb6d.js => 825ec378.6b40b5e1.js} | 2 +- ...9c2b0.6837a6bf.js => 8519c2b0.151d6303.js} | 2 +- ...64757.8612b05d.js => 86e64757.51c888a4.js} | 2 +- ...8c256.3690581c.js => 86f8c256.466d0ae2.js} | 2 +- ...ce139.6ae88921.js => 871ce139.91af4629.js} | 2 +- ...690d0.c4989b3b.js => 874690d0.087af6c1.js} | 2 +- ...5b74d.1940120b.js => 8785b74d.7bda79f2.js} | 2 +- ...aa0e7.6f1b7c68.js => 878aa0e7.239ec341.js} | 2 +- ...5fc8a.544c883c.js => 87a5fc8a.e2b44fde.js} | 2 +- ...e2c3c.c30481f9.js => 883e2c3c.87b41090.js} | 2 +- ...64d1e.81975c62.js => 8a864d1e.2ec45b44.js} | 2 +- ...d0ba5.c3076744.js => 8abd0ba5.0438e79c.js} | 2 +- ...ba22f.382b0a90.js => 8b4ba22f.354e65d0.js} | 2 +- ...c72f9.31adf943.js => 8c6c72f9.5f8a72f5.js} | 2 +- ...ef21f.1b7d7278.js => 8c8ef21f.1e58e7ca.js} | 2 +- ...0269b.6fffbe36.js => 8cb0269b.7d259e69.js} | 2 +- ...db99f.cd5305ea.js => 8ccdb99f.6dd4865a.js} | 2 +- ...b6800.53547e7f.js => 8dbb6800.33f9cde6.js} | 2 +- ...edb31.7e594d7c.js => 8eeedb31.844b4391.js} | 2 +- ...702d2.392ffcd7.js => 905702d2.04a3dd7a.js} | 2 +- assets/js/91008145.81ffd509.js | 1 + assets/js/91008145.92c7330d.js | 1 - ...92348.f5cb6f27.js => 91392348.249ac3d9.js} | 2 +- ...e1403.3ca595fb.js => 91fe1403.a5eec8d0.js} | 2 +- ...c2ac2.5a9797d9.js => 920c2ac2.c947655c.js} | 2 +- ...c84a6.f30be07f.js => 927c84a6.5f4f85e0.js} | 2 +- ...6a297.bc6850d2.js => 9286a297.84365624.js} | 2 +- ...08985.9df6d360.js => 92b08985.3381bcd2.js} | 2 +- ...7df62.224182d5.js => 92d7df62.97d668e1.js} | 2 +- ...e3b0a.7cdaf6bb.js => 931e3b0a.e529feb3.js} | 2 +- ...24b0e.7d30de25.js => 94324b0e.b1164170.js} | 2 +- ...46edb.d2a6155b.js => 95646edb.0cab0632.js} | 2 +- ...7db18.890c0ba6.js => 97c7db18.ff81a9aa.js} | 2 +- ...49594.c2ee2107.js => 97d49594.6213b55f.js} | 2 +- ...b992d.9b0c29a1.js => 97eb992d.b86d82bb.js} | 2 +- ...ed590.8c808427.js => 98ced590.ea0aabec.js} | 2 +- ...13eab.8da8ec28.js => 9af13eab.156822f7.js} | 2 +- ...40f0b.354b35e1.js => 9c540f0b.cfa53ebb.js} | 2 +- ...d4743.2d36c3d3.js => 9d2d4743.6470cd8c.js} | 2 +- ...87a11.42b6bc62.js => 9d887a11.139663b0.js} | 2 +- ...962b6.e52a7b2c.js => 9db962b6.3dc46992.js} | 2 +- ...60997.9874c0f0.js => 9dd60997.245c5ffe.js} | 2 +- ...dfa31.61512d3e.js => a08dfa31.b783495f.js} | 2 +- ...6f402.3f84d72b.js => a2c6f402.85586986.js} | 2 +- ...1ff94.cd42370c.js => a2d1ff94.02a3412b.js} | 2 +- ...fcc0f.53e8c703.js => a2ffcc0f.fa69250d.js} | 2 +- ...02291.4e03a42c.js => a3002291.b3dadeca.js} | 2 +- ...c0d44.e51907d0.js => a30c0d44.9dae885d.js} | 2 +- ...4b453.1ef49b1d.js => a334b453.159a6a62.js} | 2 +- ...d285e.c7d79b25.js => a38d285e.efa86be3.js} | 2 +- ...8794a.d031425c.js => a3f8794a.66644bd9.js} | 2 +- ...94f2e.81494862.js => a4794f2e.0a97aa4c.js} | 2 +- ...a5b1f.a33a2883.js => a9fa5b1f.619c6397.js} | 2 +- ...9fe56.af3fffe6.js => ab69fe56.d7d08ca0.js} | 2 +- ...ef0a2.6d1248c1.js => adcef0a2.b0e2c17e.js} | 2 +- ...dec4a.f70bb652.js => adfdec4a.9cd2751b.js} | 2 +- ...a775b.cd9e36d3.js => ae4a775b.839510da.js} | 2 +- ...eeff9.06e2bb8a.js => b15eeff9.3e7fee51.js} | 2 +- ...7dd16.0039922a.js => b3b7dd16.8ae196d0.js} | 2 +- ...f9b48.cf90335e.js => b4df9b48.49b7253c.js} | 2 +- ...14993.b00af05f.js => b5114993.81d24852.js} | 2 +- ...a9aee.dd9df57b.js => b51a9aee.7b963828.js} | 2 +- ...d840d.03dd79ad.js => b52d840d.ffd1d330.js} | 2 +- ...19789.9576f489.js => b5b19789.b8bf6475.js} | 2 +- ...c5208.688bc9df.js => b5ec5208.0849894e.js} | 2 +- ...ca8cf.b3e72ec0.js => b66ca8cf.50cd9fa9.js} | 2 +- ...8a236.3eb4919f.js => b678a236.77357544.js} | 2 +- ...e2912.7eef4089.js => b6be2912.768365e5.js} | 2 +- ...76a6c.36778ba0.js => b6d76a6c.65995e2c.js} | 2 +- ...b2d93.038b3ffc.js => b7bb2d93.60a94deb.js} | 2 +- ...b0fce.f4f93d82.js => b8eb0fce.8183041a.js} | 2 +- ...c852b.8536efc6.js => b8ec852b.49cb4e11.js} | 2 +- ...87eb6.96b5e71c.js => b9287eb6.e2287fd2.js} | 2 +- ...87183.9e0dfce3.js => b9a87183.20a8f42b.js} | 2 +- ...44fba.d360f8a7.js => bab44fba.3d298f80.js} | 2 +- ...a5560.7930735c.js => bb6a5560.1a8d7e23.js} | 2 +- ...5720e.a98de0bc.js => bd45720e.9b75822c.js} | 2 +- ...5ec7e.3ce21ab1.js => bd65ec7e.964a9392.js} | 2 +- ...8b81b.c3486276.js => bdb8b81b.c7c6e5e2.js} | 2 +- ...28752.327cc384.js => be228752.7692fe45.js} | 2 +- ...1c6a2.e6bd0392.js => bf11c6a2.32c6fa76.js} | 2 +- ...ab32f.748c1836.js => c09ab32f.7151f8bf.js} | 2 +- ...4141c.0e10ecdc.js => c104141c.6dae7802.js} | 2 +- ...84a80.0e9ba5ff.js => c1584a80.99228fe5.js} | 2 +- ...a9e21.ceb9c413.js => c1ca9e21.e5e26d6f.js} | 2 +- ...9db97.73bc5659.js => c239db97.ccd7100d.js} | 2 +- ...913f3.948f1162.js => c25913f3.bc57616e.js} | 2 +- ...65a15.0372eac0.js => c2865a15.fed21e58.js} | 2 +- ...8ebbc.1005b64f.js => c358ebbc.8906be27.js} | 2 +- ...4b2d7.a0a4ae19.js => c544b2d7.fecd5a8d.js} | 2 +- ...ac05f.068bcd08.js => c7cac05f.4f3bb4ed.js} | 2 +- ...3bd67.26a3edcf.js => c813bd67.14b66b49.js} | 2 +- ...234c1.265b8267.js => ca1234c1.08eea4e3.js} | 2 +- ...65b51.ce22804e.js => ca165b51.a474b20a.js} | 2 +- ...db1c0.b5ad6069.js => caddb1c0.130ef5f8.js} | 2 +- ...f21df.d3ba4f77.js => cb0f21df.b31ab9f5.js} | 2 +- ...d9416.bb85ac72.js => cc6d9416.77f78036.js} | 2 +- ...22df3.1b0315bd.js => cc922df3.a4836f17.js} | 2 +- ...64ea9.17a540d0.js => cdf64ea9.cb4bb158.js} | 2 +- ...fe126.509157cc.js => cfdfe126.cf276977.js} | 2 +- ...3759a.8077d5ff.js => d103759a.d028e56e.js} | 2 +- ...63e47.f83b2fc3.js => d1163e47.42aa0e91.js} | 2 +- ...ef83d.c5bf987b.js => d46ef83d.a65e59af.js} | 2 +- ...6897e.9944ccdd.js => d496897e.653492b3.js} | 2 +- ...cbd9e.730740ec.js => d66cbd9e.fd5078df.js} | 2 +- ...9767a.fe28638e.js => d739767a.15a11c1a.js} | 2 +- ...f208d.f05356f8.js => d83f208d.d9a894b1.js} | 2 +- ...07a00.b266d8d2.js => d9407a00.7a6b235f.js} | 2 +- ...73b17.82ee7398.js => d9673b17.e4cec172.js} | 2 +- ...4ee1e.8f64d6ef.js => d9b4ee1e.d50edb80.js} | 2 +- ...2fd17.f6898ba5.js => db22fd17.d6e67f67.js} | 2 +- ...3cd40.5525d066.js => dc23cd40.cdc36a02.js} | 2 +- ...87402.2816995e.js => dec87402.2599a454.js} | 2 +- ...cabf3.45fab54b.js => deccabf3.122e00d9.js} | 2 +- ...a6e58.eac9161d.js => df2a6e58.5de9dabd.js} | 2 +- ...d464e.2c9b2a78.js => df4d464e.afbd410d.js} | 2 +- ...4f6d4.5f434384.js => e064f6d4.8252e773.js} | 2 +- ...2ab10.e4c6b390.js => e1a2ab10.5778db0c.js} | 2 +- ...8d71f.26d3cbfc.js => e1c8d71f.e4137a89.js} | 2 +- ...d7c3e.ba8cfce9.js => e35d7c3e.f7bb8c4c.js} | 2 +- ...c422a.93fd0ffe.js => e38c422a.674e4b74.js} | 2 +- ...28bf9.15423e05.js => e3f28bf9.d055211d.js} | 2 +- ...6fc5a.59353cfa.js => e546fc5a.e8f570b5.js} | 2 +- ...12603.62be0a1e.js => e6412603.0551d01b.js} | 2 +- ...dadab.bbc7b49b.js => e69dadab.0288ce06.js} | 2 +- ...31e60.31d339aa.js => e6c31e60.c452f930.js} | 2 +- ...77a94.633316ab.js => e7477a94.eabd4d09.js} | 2 +- ...23b27.83e4a55f.js => e7923b27.e35876bd.js} | 2 +- ...cabb0.8495bcb0.js => e84cabb0.9acc24b5.js} | 2 +- assets/js/e88443f3.27a3c2d1.js | 1 - assets/js/e88443f3.5a00b1f0.js | 1 + ...3a6d7.d1657e7a.js => e983a6d7.83a88cd3.js} | 2 +- ...ffc82.c20de2c2.js => ea3ffc82.50414916.js} | 2 +- ...a4846.94dc99f5.js => ed2a4846.06d649a8.js} | 2 +- ...03d23.5da37b94.js => ed603d23.9b191ba4.js} | 2 +- ...40f78.f17db715.js => edb40f78.211eec30.js} | 2 +- ...d83b2.2358ae4e.js => f1ad83b2.d50b3f1d.js} | 2 +- ...efc55.22bbdcbd.js => f20efc55.71218c42.js} | 2 +- assets/js/f27eaf88.c736f69d.js | 1 - assets/js/f27eaf88.dc3e64e4.js | 1 + ...71232.819ea1d3.js => f4271232.65f13e39.js} | 2 +- ...d0d3d.44684c87.js => f6cd0d3d.e9026238.js} | 2 +- ...f66bc.c8ab5809.js => f6cf66bc.9cd66d41.js} | 2 +- ...97f43.651fdac2.js => f7197f43.fca65cde.js} | 2 +- ...1dec1.fe89e267.js => f771dec1.e744a9ff.js} | 2 +- ...9e078.6ca3691b.js => f7c9e078.f0651411.js} | 2 +- ...eb50f.8afe0a58.js => f86eb50f.1d740de9.js} | 2 +- ...cd692.eb9397b4.js => fb8cd692.d16ceec6.js} | 2 +- ...d390f.beb7dad5.js => fbfd390f.9219e308.js} | 2 +- ...23f19.cfe1fa4b.js => fc923f19.c804119f.js} | 2 +- ...02dc7.31ea96ca.js => fd702dc7.3ba9d8f5.js} | 2 +- ...a05e2.e35c611b.js => fe1a05e2.7e1fe783.js} | 2 +- ...16911.946349dd.js => fe716911.7099efb4.js} | 2 +- ...0a0be.22163b57.js => fee0a0be.9c93ed65.js} | 2 +- ...f63f6.fde6fbda.js => ff2f63f6.50c9ef93.js} | 2 +- ...n.2fed3aba.js => runtime~main.59037fa1.js} | 2 +- blog.html | 2 +- blog/5-things-to-know-for-a-docker-user.html | 2 +- blog/archive.html | 2 +- blog/develop-using-devcontainer.html | 2 +- blog/getting-started-with-compose.html | 2 +- blog/podman-desktop-release-0.10.html | 2 +- blog/podman-desktop-release-0.11.html | 2 +- blog/podman-desktop-release-0.12.html | 2 +- blog/podman-desktop-release-0.13.html | 2 +- blog/podman-desktop-release-0.14.html | 2 +- blog/podman-desktop-release-0.15.html | 2 +- blog/podman-desktop-release-1.0.html | 2 +- blog/podman-desktop-release-1.1.html | 2 +- blog/podman-desktop-release-1.2.html | 2 +- blog/podman-desktop-release-1.3.html | 2 +- blog/podman-desktop-release-1.4.html | 2 +- blog/podman-desktop-release-1.5.html | 2 +- blog/podman-desktop-release-1.6.html | 2 +- blog/podman-desktop-release-1.7.html | 2 +- blog/podman-desktop-release-1.8.html | 2 +- blog/podman-desktop-release-1.9.html | 2 +- blog/podman-desktop-wins-devies-award.html | 2 +- ...ubernetes-cluster-with-podman-desktop.html | 2 +- ...podman-images-with-kubernetes-cluster.html | 2 +- blog/tags.html | 2 +- blog/tags/award.html | 2 +- blog/tags/codespaces.html | 2 +- blog/tags/compose.html | 2 +- blog/tags/containerfile.html | 2 +- blog/tags/containers.html | 2 +- blog/tags/devcontainer.html | 2 +- blog/tags/docker-compose.html | 2 +- blog/tags/docker.html | 2 +- blog/tags/dockerfile.html | 2 +- blog/tags/extensions.html | 2 +- blog/tags/images.html | 2 +- blog/tags/kind.html | 2 +- blog/tags/kubernetes.html | 2 +- blog/tags/migrating.html | 2 +- blog/tags/multi-container.html | 2 +- blog/tags/onboarding.html | 2 +- blog/tags/openshift.html | 2 +- blog/tags/podman-desktop.html | 2 +- blog/tags/podman.html | 2 +- blog/tags/release.html | 2 +- blog/tags/settings.html | 2 +- blog/tags/story.html | 2 +- blog/tags/wasi.html | 2 +- blog/tags/wasm.html | 2 +- blog/tags/web-assembly.html | 2 +- ...oads-on-macos-and-windows-with-podman.html | 2 +- core-values.html | 2 +- docs/compose.html | 2 +- docs/compose/running-compose.html | 2 +- docs/compose/setting-up-compose.html | 2 +- docs/containers.html | 2 +- docs/containers/creating-a-pod.html | 2 +- docs/containers/images.html | 2 +- docs/containers/images/building-an-image.html | 2 +- docs/containers/images/pulling-an-image.html | 2 +- .../pushing-an-image-to-a-registry.html | 2 +- docs/containers/onboarding.html | 2 +- docs/containers/registries.html | 2 +- docs/containers/starting-a-container.html | 2 +- docs/extensions.html | 2 +- docs/extensions/install.html | 2 +- docs/extensions/publish.html | 2 +- docs/extensions/write.html | 2 +- docs/extensions/write/adding-icons.html | 2 +- .../extensions/write/onboarding-workflow.html | 2 +- .../extensions/write/when-clause-context.html | 2 +- docs/installation.html | 2 +- docs/installation/linux-install.html | 2 +- ...-podman-desktop-from-a-flatpak-bundle.html | 2 +- docs/installation/macos-install.html | 2 +- docs/installation/windows-install.html | 2 +- docs/intro.html | 2 +- docs/kind.html | 2 +- ...lding-an-image-and-testing-it-in-kind.html | 2 +- ...onfiguring-podman-for-kind-on-windows.html | 2 +- docs/kind/creating-a-kind-cluster.html | 2 +- docs/kind/deleting-your-kind-cluster.html | 2 +- docs/kind/installing.html | 2 +- docs/kind/pushing-an-image-to-kind.html | 2 +- docs/kind/restarting-your-kind-cluster.html | 2 +- .../working-with-your-local-kind-cluster.html | 2 +- docs/kubernetes.html | 2 +- .../deploying-a-container-to-kubernetes.html | 2 +- .../deploying-a-pod-to-kubernetes.html | 2 +- docs/kubernetes/existing-kubernetes.html | 2 +- .../kind/pushing-an-image-to-kind.html | 2 +- .../lima/pushing-an-image-to-lima.html | 2 +- .../pushing-an-image-to-minikube.html | 2 +- ...t-kubernete-context-in-the-status-bar.html | 2 +- ...d-selecting-current-kubernete-context.html | 2 +- docs/lima.html | 2 +- docs/lima/creating-a-kubernetes-instance.html | 2 +- docs/lima/creating-a-lima-instance.html | 2 +- docs/lima/customizing.html | 2 +- docs/lima/installing.html | 2 +- docs/migrating-from-docker.html | 2 +- .../emulating-docker-cli-with-podman.html | 2 +- .../importing-saved-containers.html | 2 +- .../using-podman-mac-helper.html | 2 +- ...-the-docker_host-environment-variable.html | 2 +- ...verifying-your-tools-are-using-podman.html | 2 +- docs/minikube.html | 2 +- ...g-an-image-and-testing-it-in-minikube.html | 2 +- ...guring-podman-for-minikube-on-windows.html | 2 +- .../minikube/creating-a-minikube-cluster.html | 2 +- .../deleting-your-minikube-cluster.html | 2 +- docs/minikube/installing.html | 2 +- .../pushing-an-image-to-minikube.html | 2 +- .../restarting-your-minikube-cluster.html | 2 +- ...king-with-your-local-minikube-cluster.html | 2 +- docs/openshift.html | 2 +- docs/openshift/developer-sandbox.html | 2 +- docs/openshift/openshift-local.html | 2 +- docs/podman.html | 2 +- ...sing-podman-from-another-wsl-instance.html | 2 +- docs/podman/creating-a-podman-machine.html | 2 +- ...ing-podman-machine-default-connection.html | 2 +- docs/proxy.html | 2 +- docs/tags.html | 2 +- docs/tags/compose.html | 2 +- docs/tags/containers.html | 2 +- docs/tags/docker.html | 2 +- docs/tags/extension.html | 2 +- docs/tags/flathub.html | 2 +- docs/tags/flatpak.html | 2 +- docs/tags/icons.html | 2 +- docs/tags/images.html | 2 +- docs/tags/installing.html | 2 +- docs/tags/kind.html | 2 +- docs/tags/kubernetes.html | 2 +- docs/tags/lima.html | 2 +- docs/tags/linux.html | 2 +- docs/tags/mac-0-s.html | 2 +- docs/tags/mac-os.html | 2 +- docs/tags/macos.html | 2 +- docs/tags/migrating-from-docker.html | 2 +- docs/tags/migrating-to-kubernetes.html | 2 +- docs/tags/minikube.html | 2 +- docs/tags/onboarding.html | 2 +- docs/tags/openshift.html | 2 +- docs/tags/podman-desktop.html | 2 +- docs/tags/podman.html | 2 +- docs/tags/pods.html | 2 +- docs/tags/publishing.html | 2 +- docs/tags/when-clause.html | 2 +- docs/tags/windows.html | 2 +- docs/tags/writing.html | 2 +- docs/troubleshooting.html | 2 +- .../troubleshooting-openshift-local.html | 2 +- .../troubleshooting-podman-on-linux.html | 2 +- .../troubleshooting-podman-on-macos.html | 2 +- .../troubleshooting-podman-on-windows.html | 2 +- .../troubleshooting-podman.html | 2 +- downloads.html | 2 +- downloads/linux.html | 2 +- downloads/macos.html | 2 +- downloads/windows.html | 2 +- extend.html | 2 +- features.html | 2 +- index.html | 2 +- search.html | 2 +- 764 files changed, 1717 insertions(+), 1717 deletions(-) rename assets/js/{0029a336.92f134a4.js => 0029a336.b6586be4.js} (99%) rename assets/js/{0102eb3e.570ca7d7.js => 0102eb3e.ec2383d1.js} (87%) rename assets/js/{01821883.a60e5b32.js => 01821883.af5c3e62.js} (89%) rename assets/js/{01a1d0f4.ba9ae5ce.js => 01a1d0f4.cfacb70c.js} (98%) rename assets/js/{030ccfd9.6af5542e.js => 030ccfd9.6701e3f5.js} (94%) rename assets/js/{04a546a4.9cbb3615.js => 04a546a4.cc60c712.js} (86%) rename assets/js/{0547cb65.c85f6a89.js => 0547cb65.9966a371.js} (90%) rename assets/js/{065365b3.f497ef4d.js => 065365b3.17d68896.js} (97%) rename assets/js/{06a27da2.d66ed147.js => 06a27da2.d6352c85.js} (81%) rename assets/js/{0877aebd.678da894.js => 0877aebd.3d19e135.js} (95%) rename assets/js/{0c14b239.81af500f.js => 0c14b239.43bce9c3.js} (96%) rename assets/js/{0c4fad6b.d4930aaf.js => 0c4fad6b.a3c675d8.js} (97%) rename assets/js/{0cab2b3a.d0a1f8f9.js => 0cab2b3a.0f34acb7.js} (84%) rename assets/js/{0e3a398f.41910b52.js => 0e3a398f.983c8ec6.js} (77%) rename assets/js/{0e72c11a.40b87b3a.js => 0e72c11a.d764a4f4.js} (97%) rename assets/js/{0f54081d.93573599.js => 0f54081d.789a7dd1.js} (96%) rename assets/js/{0fa6e9bf.8176967b.js => 0fa6e9bf.e677d805.js} (89%) rename assets/js/{107d77e6.4c4887bd.js => 107d77e6.e3726056.js} (84%) rename assets/js/{123a454a.c7fc15b7.js => 123a454a.18a2679b.js} (85%) rename assets/js/{125d93c1.a5a33191.js => 125d93c1.62423075.js} (94%) rename assets/js/{12eb386e.987442d4.js => 12eb386e.8cd4f506.js} (87%) rename assets/js/{148448cb.1c3ea32f.js => 148448cb.cd99b6a9.js} (87%) rename assets/js/{14ae68e7.8e966750.js => 14ae68e7.563eb837.js} (82%) rename assets/js/{1515c895.b4fc0e7a.js => 1515c895.6929d8ee.js} (98%) rename assets/js/{160cb329.b697a9ed.js => 160cb329.e6d0fc05.js} (91%) rename assets/js/{164937d2.b8ed4032.js => 164937d2.5328b998.js} (93%) rename assets/js/{16914cba.9101c7ce.js => 16914cba.22f20107.js} (96%) rename assets/js/{17612ae7.84bb1e5e.js => 17612ae7.8a1f3e26.js} (96%) rename assets/js/{17d2ebc8.52d258b6.js => 17d2ebc8.fb8007b9.js} (89%) rename assets/js/{180d0c5f.f9a48f81.js => 180d0c5f.472b25a6.js} (95%) rename assets/js/{185c52e7.872aa714.js => 185c52e7.81fc27f9.js} (84%) rename assets/js/{19e69ccd.d71a6bd7.js => 19e69ccd.579209e3.js} (84%) rename assets/js/{1a906644.21eb35f6.js => 1a906644.4287c938.js} (96%) rename assets/js/{1dfee34e.dfca0ffb.js => 1dfee34e.dbcae126.js} (96%) rename assets/js/{1ee92283.5647ff83.js => 1ee92283.5ea9394d.js} (90%) rename assets/js/{1fbe0675.423a5b51.js => 1fbe0675.ccd83d73.js} (84%) rename assets/js/{1fc83a28.d12148e2.js => 1fc83a28.8bbe08a8.js} (93%) rename assets/js/{22e2140b.e38943cf.js => 22e2140b.be32d1c9.js} (98%) rename assets/js/{2340b3ee.25f180af.js => 2340b3ee.bcd754dd.js} (96%) rename assets/js/{23a8e291.4c4a4c64.js => 23a8e291.53f0f9ff.js} (94%) rename assets/js/{24dadce3.853597a2.js => 24dadce3.cfee6fc8.js} (97%) rename assets/js/{254d0ff5.2442ecbb.js => 254d0ff5.0cfbe8c9.js} (87%) rename assets/js/{271ff0d1.f84e17f8.js => 271ff0d1.a6cdce94.js} (98%) rename assets/js/{280646e4.189c0e50.js => 280646e4.44065112.js} (95%) rename assets/js/{2bb2c1cd.82fb5fa6.js => 2bb2c1cd.5a1566a9.js} (95%) rename assets/js/{2cb13d6d.6c544606.js => 2cb13d6d.4bd23de0.js} (83%) rename assets/js/{3109d9d2.b988a45f.js => 3109d9d2.91d5e17b.js} (95%) rename assets/js/{3132913e.83a3dc68.js => 3132913e.f39d3682.js} (92%) create mode 100644 assets/js/35300761.2078a56d.js delete mode 100644 assets/js/35300761.b8007215.js rename assets/js/{3866940b.c2fd7ce4.js => 3866940b.9582348f.js} (91%) rename assets/js/{39ae3791.a43fc0cc.js => 39ae3791.7666bfbb.js} (84%) rename assets/js/{3a38a610.d8ef876e.js => 3a38a610.c2f3b4bc.js} (81%) rename assets/js/{3ba80b69.6a2248b1.js => 3ba80b69.b9e2e547.js} (81%) rename assets/js/{3e2b82eb.67b26f21.js => 3e2b82eb.bc92317e.js} (89%) rename assets/js/{3f66023b.17485265.js => 3f66023b.6b74b140.js} (84%) rename assets/js/{3f797343.14381b38.js => 3f797343.9695e3da.js} (82%) rename assets/js/{40d377be.f82b3048.js => 40d377be.555a9011.js} (91%) rename assets/js/{416d4fcf.1c0e95c6.js => 416d4fcf.12805bec.js} (90%) rename assets/js/{41b2e801.e153f008.js => 41b2e801.b724f400.js} (98%) rename assets/js/{423842d7.acf693fd.js => 423842d7.c3922d88.js} (98%) rename assets/js/{42b67a8e.ae8f374d.js => 42b67a8e.1d462849.js} (72%) rename assets/js/{43be69c9.5cc7765f.js => 43be69c9.9e2f4325.js} (91%) delete mode 100644 assets/js/44287967.935386d3.js create mode 100644 assets/js/44287967.e926313c.js rename assets/js/{456c0e28.d959dd31.js => 456c0e28.27dcf5a9.js} (92%) rename assets/js/{46669adc.7ef9ccbf.js => 46669adc.c54854c8.js} (74%) rename assets/js/{46b3c144.b6032b59.js => 46b3c144.1e68703a.js} (77%) rename assets/js/{494e8e75.ff6efc1f.js => 494e8e75.64e87537.js} (94%) rename assets/js/{49bee2be.f2002d66.js => 49bee2be.a456763c.js} (82%) rename assets/js/{49d9416a.9c1c7d1c.js => 49d9416a.e1d5d91d.js} (96%) rename assets/js/{4c217c25.480c06c7.js => 4c217c25.8f39ef22.js} (94%) rename assets/js/{4c5becac.3618ce01.js => 4c5becac.0f710a8d.js} (87%) rename assets/js/{4f425ff4.31bb7041.js => 4f425ff4.f22994fc.js} (96%) rename assets/js/{4f9e8711.62877687.js => 4f9e8711.bbd18f66.js} (93%) rename assets/js/{5046ea8f.5cdba6a6.js => 5046ea8f.9a75988c.js} (89%) rename assets/js/{54d805e4.20c0735c.js => 54d805e4.a5d47a8f.js} (83%) rename assets/js/{57a8015d.97495d30.js => 57a8015d.7d826a7d.js} (96%) rename assets/js/{57dba496.654997fe.js => 57dba496.54764f63.js} (82%) delete mode 100644 assets/js/57e01cd5.02acec70.js create mode 100644 assets/js/57e01cd5.8635c150.js rename assets/js/{5a7aef43.78593a3e.js => 5a7aef43.39e50b6c.js} (84%) rename assets/js/{5a9a7a02.39f1c3c1.js => 5a9a7a02.a8f5f98e.js} (95%) rename assets/js/{5b10a003.4567b66d.js => 5b10a003.e57f7289.js} (86%) rename assets/js/{5b7d9ef2.efa9bcd8.js => 5b7d9ef2.b16878c3.js} (97%) rename assets/js/{5bc09a53.fd285884.js => 5bc09a53.d139a151.js} (93%) rename assets/js/{5c0f0993.18d7fdbf.js => 5c0f0993.4e66892c.js} (87%) rename assets/js/{5db8318c.69caefe3.js => 5db8318c.5b84086f.js} (96%) rename assets/js/{5e30269e.b8232d0d.js => 5e30269e.34c618e1.js} (95%) rename assets/js/{5e486140.e0dda424.js => 5e486140.8fe86923.js} (95%) rename assets/js/{5e8fbcdf.521014a7.js => 5e8fbcdf.8d05d07e.js} (85%) rename assets/js/{604e05e4.7681f7c1.js => 604e05e4.01d5de6a.js} (80%) rename assets/js/{60c82955.a0d0937b.js => 60c82955.c82ac906.js} (87%) rename assets/js/{610f2c47.b383cecf.js => 610f2c47.0d2aa192.js} (91%) rename assets/js/{612345e6.955e4166.js => 612345e6.7d26d63e.js} (89%) rename assets/js/{62e21724.e85152be.js => 62e21724.82dcbf9f.js} (85%) rename assets/js/{640277b9.4daaabe9.js => 640277b9.c441a0a4.js} (97%) rename assets/js/{64134c03.97f21a99.js => 64134c03.0c1b6feb.js} (67%) rename assets/js/{6477cdc2.40c887b4.js => 6477cdc2.f8ec3a84.js} (87%) rename assets/js/{6494b798.542dea5b.js => 6494b798.25e58aff.js} (94%) rename assets/js/{67386898.7394d6c9.js => 67386898.c2a2c38c.js} (94%) rename assets/js/{6763d4e0.fd7e99c8.js => 6763d4e0.67e59d17.js} (95%) rename assets/js/{6774f806.93c6fe56.js => 6774f806.9ee49dd1.js} (98%) rename assets/js/{67eba1be.5ae1a8ca.js => 67eba1be.86b64c58.js} (91%) rename assets/js/{67fccd64.93652144.js => 67fccd64.3f6541ed.js} (84%) rename assets/js/{688ee267.9fc5aec0.js => 688ee267.8f8d5f25.js} (96%) rename assets/js/{6a1fe514.085c2aa8.js => 6a1fe514.ba067b5b.js} (91%) rename assets/js/{6aa0b043.22a2843d.js => 6aa0b043.67706045.js} (84%) rename assets/js/{6e30ac7b.8545b1d6.js => 6e30ac7b.a0526b47.js} (88%) rename assets/js/{6e92edd9.74f06cbe.js => 6e92edd9.c9596b0e.js} (89%) rename assets/js/{6eafe0c7.304211a7.js => 6eafe0c7.80d11545.js} (82%) rename assets/js/{70e3b13c.86b953f4.js => 70e3b13c.2034da55.js} (95%) rename assets/js/{714e70d1.e8aa7547.js => 714e70d1.9b5a36d6.js} (91%) rename assets/js/{71748509.e56064a2.js => 71748509.ed3b7894.js} (97%) rename assets/js/{7258860f.68820e48.js => 7258860f.306f4d7e.js} (97%) rename assets/js/{73f18a6f.9ecd316f.js => 73f18a6f.5462fb52.js} (97%) rename assets/js/{73f9658e.8e2732f7.js => 73f9658e.55449af1.js} (97%) rename assets/js/{74b658de.9477da39.js => 74b658de.0a0f47e0.js} (89%) rename assets/js/{7500e360.f1814908.js => 7500e360.e298db0a.js} (84%) rename assets/js/{7547d3bb.9f44d157.js => 7547d3bb.fffbdd9e.js} (95%) rename assets/js/{786fee93.d444be09.js => 786fee93.dba84eb4.js} (89%) rename assets/js/{79f18c88.3fe305ab.js => 79f18c88.d71a505f.js} (90%) rename assets/js/{7aa856d6.8cadbd75.js => 7aa856d6.0c28b7a8.js} (96%) rename assets/js/{7bef3f04.c8701684.js => 7bef3f04.2a0b9418.js} (96%) rename assets/js/{7c7a772e.3175a757.js => 7c7a772e.8c0ceae2.js} (85%) rename assets/js/{7cde3c49.c7a15492.js => 7cde3c49.006b7055.js} (94%) rename assets/js/{7d9edfb8.481f6f48.js => 7d9edfb8.19b21b61.js} (92%) rename assets/js/{7e2ae3df.a7deb713.js => 7e2ae3df.4280abc5.js} (98%) rename assets/js/{7e5a2776.b7d8320e.js => 7e5a2776.4405dd1f.js} (92%) rename assets/js/{7f0476bd.20f2374d.js => 7f0476bd.e7165f51.js} (87%) rename assets/js/{7fa133e1.962898de.js => 7fa133e1.bd68b85a.js} (88%) rename assets/js/{814402d7.168ecaa5.js => 814402d7.4b3642f5.js} (90%) rename assets/js/{814d49b7.f35d1c27.js => 814d49b7.d64be048.js} (85%) rename assets/js/{81b69ac7.12bfd79d.js => 81b69ac7.e88b3c8e.js} (89%) rename assets/js/{82170cf7.ef992965.js => 82170cf7.da09643d.js} (98%) rename assets/js/{825ec378.4d60eb6d.js => 825ec378.6b40b5e1.js} (96%) rename assets/js/{8519c2b0.6837a6bf.js => 8519c2b0.151d6303.js} (96%) rename assets/js/{86e64757.8612b05d.js => 86e64757.51c888a4.js} (92%) rename assets/js/{86f8c256.3690581c.js => 86f8c256.466d0ae2.js} (91%) rename assets/js/{871ce139.6ae88921.js => 871ce139.91af4629.js} (83%) rename assets/js/{874690d0.c4989b3b.js => 874690d0.087af6c1.js} (87%) rename assets/js/{8785b74d.1940120b.js => 8785b74d.7bda79f2.js} (89%) rename assets/js/{878aa0e7.6f1b7c68.js => 878aa0e7.239ec341.js} (90%) rename assets/js/{87a5fc8a.544c883c.js => 87a5fc8a.e2b44fde.js} (95%) rename assets/js/{883e2c3c.c30481f9.js => 883e2c3c.87b41090.js} (95%) rename assets/js/{8a864d1e.81975c62.js => 8a864d1e.2ec45b44.js} (94%) rename assets/js/{8abd0ba5.c3076744.js => 8abd0ba5.0438e79c.js} (90%) rename assets/js/{8b4ba22f.382b0a90.js => 8b4ba22f.354e65d0.js} (89%) rename assets/js/{8c6c72f9.31adf943.js => 8c6c72f9.5f8a72f5.js} (94%) rename assets/js/{8c8ef21f.1b7d7278.js => 8c8ef21f.1e58e7ca.js} (90%) rename assets/js/{8cb0269b.6fffbe36.js => 8cb0269b.7d259e69.js} (91%) rename assets/js/{8ccdb99f.cd5305ea.js => 8ccdb99f.6dd4865a.js} (83%) rename assets/js/{8dbb6800.53547e7f.js => 8dbb6800.33f9cde6.js} (95%) rename assets/js/{8eeedb31.7e594d7c.js => 8eeedb31.844b4391.js} (95%) rename assets/js/{905702d2.392ffcd7.js => 905702d2.04a3dd7a.js} (95%) create mode 100644 assets/js/91008145.81ffd509.js delete mode 100644 assets/js/91008145.92c7330d.js rename assets/js/{91392348.f5cb6f27.js => 91392348.249ac3d9.js} (97%) rename assets/js/{91fe1403.3ca595fb.js => 91fe1403.a5eec8d0.js} (81%) rename assets/js/{920c2ac2.5a9797d9.js => 920c2ac2.c947655c.js} (94%) rename assets/js/{927c84a6.f30be07f.js => 927c84a6.5f4f85e0.js} (84%) rename assets/js/{9286a297.bc6850d2.js => 9286a297.84365624.js} (84%) rename assets/js/{92b08985.9df6d360.js => 92b08985.3381bcd2.js} (88%) rename assets/js/{92d7df62.224182d5.js => 92d7df62.97d668e1.js} (95%) rename assets/js/{931e3b0a.7cdaf6bb.js => 931e3b0a.e529feb3.js} (85%) rename assets/js/{94324b0e.7d30de25.js => 94324b0e.b1164170.js} (95%) rename assets/js/{95646edb.d2a6155b.js => 95646edb.0cab0632.js} (98%) rename assets/js/{97c7db18.890c0ba6.js => 97c7db18.ff81a9aa.js} (97%) rename assets/js/{97d49594.c2ee2107.js => 97d49594.6213b55f.js} (96%) rename assets/js/{97eb992d.9b0c29a1.js => 97eb992d.b86d82bb.js} (84%) rename assets/js/{98ced590.8c808427.js => 98ced590.ea0aabec.js} (97%) rename assets/js/{9af13eab.8da8ec28.js => 9af13eab.156822f7.js} (97%) rename assets/js/{9c540f0b.354b35e1.js => 9c540f0b.cfa53ebb.js} (92%) rename assets/js/{9d2d4743.2d36c3d3.js => 9d2d4743.6470cd8c.js} (97%) rename assets/js/{9d887a11.42b6bc62.js => 9d887a11.139663b0.js} (96%) rename assets/js/{9db962b6.e52a7b2c.js => 9db962b6.3dc46992.js} (93%) rename assets/js/{9dd60997.9874c0f0.js => 9dd60997.245c5ffe.js} (98%) rename assets/js/{a08dfa31.61512d3e.js => a08dfa31.b783495f.js} (89%) rename assets/js/{a2c6f402.3f84d72b.js => a2c6f402.85586986.js} (94%) rename assets/js/{a2d1ff94.cd42370c.js => a2d1ff94.02a3412b.js} (87%) rename assets/js/{a2ffcc0f.53e8c703.js => a2ffcc0f.fa69250d.js} (96%) rename assets/js/{a3002291.4e03a42c.js => a3002291.b3dadeca.js} (98%) rename assets/js/{a30c0d44.e51907d0.js => a30c0d44.9dae885d.js} (91%) rename assets/js/{a334b453.1ef49b1d.js => a334b453.159a6a62.js} (90%) rename assets/js/{a38d285e.c7d79b25.js => a38d285e.efa86be3.js} (96%) rename assets/js/{a3f8794a.d031425c.js => a3f8794a.66644bd9.js} (86%) rename assets/js/{a4794f2e.81494862.js => a4794f2e.0a97aa4c.js} (95%) rename assets/js/{a9fa5b1f.a33a2883.js => a9fa5b1f.619c6397.js} (94%) rename assets/js/{ab69fe56.af3fffe6.js => ab69fe56.d7d08ca0.js} (94%) rename assets/js/{adcef0a2.6d1248c1.js => adcef0a2.b0e2c17e.js} (96%) rename assets/js/{adfdec4a.f70bb652.js => adfdec4a.9cd2751b.js} (87%) rename assets/js/{ae4a775b.cd9e36d3.js => ae4a775b.839510da.js} (96%) rename assets/js/{b15eeff9.06e2bb8a.js => b15eeff9.3e7fee51.js} (86%) rename assets/js/{b3b7dd16.0039922a.js => b3b7dd16.8ae196d0.js} (95%) rename assets/js/{b4df9b48.cf90335e.js => b4df9b48.49b7253c.js} (84%) rename assets/js/{b5114993.b00af05f.js => b5114993.81d24852.js} (88%) rename assets/js/{b51a9aee.dd9df57b.js => b51a9aee.7b963828.js} (97%) rename assets/js/{b52d840d.03dd79ad.js => b52d840d.ffd1d330.js} (86%) rename assets/js/{b5b19789.9576f489.js => b5b19789.b8bf6475.js} (97%) rename assets/js/{b5ec5208.688bc9df.js => b5ec5208.0849894e.js} (96%) rename assets/js/{b66ca8cf.b3e72ec0.js => b66ca8cf.50cd9fa9.js} (96%) rename assets/js/{b678a236.3eb4919f.js => b678a236.77357544.js} (98%) rename assets/js/{b6be2912.7eef4089.js => b6be2912.768365e5.js} (96%) rename assets/js/{b6d76a6c.36778ba0.js => b6d76a6c.65995e2c.js} (87%) rename assets/js/{b7bb2d93.038b3ffc.js => b7bb2d93.60a94deb.js} (96%) rename assets/js/{b8eb0fce.f4f93d82.js => b8eb0fce.8183041a.js} (88%) rename assets/js/{b8ec852b.8536efc6.js => b8ec852b.49cb4e11.js} (92%) rename assets/js/{b9287eb6.96b5e71c.js => b9287eb6.e2287fd2.js} (73%) rename assets/js/{b9a87183.9e0dfce3.js => b9a87183.20a8f42b.js} (93%) rename assets/js/{bab44fba.d360f8a7.js => bab44fba.3d298f80.js} (98%) rename assets/js/{bb6a5560.7930735c.js => bb6a5560.1a8d7e23.js} (97%) rename assets/js/{bd45720e.a98de0bc.js => bd45720e.9b75822c.js} (84%) rename assets/js/{bd65ec7e.3ce21ab1.js => bd65ec7e.964a9392.js} (96%) rename assets/js/{bdb8b81b.c3486276.js => bdb8b81b.c7c6e5e2.js} (83%) rename assets/js/{be228752.327cc384.js => be228752.7692fe45.js} (97%) rename assets/js/{bf11c6a2.e6bd0392.js => bf11c6a2.32c6fa76.js} (87%) rename assets/js/{c09ab32f.748c1836.js => c09ab32f.7151f8bf.js} (94%) rename assets/js/{c104141c.0e10ecdc.js => c104141c.6dae7802.js} (95%) rename assets/js/{c1584a80.0e9ba5ff.js => c1584a80.99228fe5.js} (90%) rename assets/js/{c1ca9e21.ceb9c413.js => c1ca9e21.e5e26d6f.js} (92%) rename assets/js/{c239db97.73bc5659.js => c239db97.ccd7100d.js} (84%) rename assets/js/{c25913f3.948f1162.js => c25913f3.bc57616e.js} (88%) rename assets/js/{c2865a15.0372eac0.js => c2865a15.fed21e58.js} (76%) rename assets/js/{c358ebbc.1005b64f.js => c358ebbc.8906be27.js} (94%) rename assets/js/{c544b2d7.a0a4ae19.js => c544b2d7.fecd5a8d.js} (88%) rename assets/js/{c7cac05f.068bcd08.js => c7cac05f.4f3bb4ed.js} (87%) rename assets/js/{c813bd67.26a3edcf.js => c813bd67.14b66b49.js} (86%) rename assets/js/{ca1234c1.265b8267.js => ca1234c1.08eea4e3.js} (92%) rename assets/js/{ca165b51.ce22804e.js => ca165b51.a474b20a.js} (86%) rename assets/js/{caddb1c0.b5ad6069.js => caddb1c0.130ef5f8.js} (89%) rename assets/js/{cb0f21df.d3ba4f77.js => cb0f21df.b31ab9f5.js} (95%) rename assets/js/{cc6d9416.bb85ac72.js => cc6d9416.77f78036.js} (83%) rename assets/js/{cc922df3.1b0315bd.js => cc922df3.a4836f17.js} (93%) rename assets/js/{cdf64ea9.17a540d0.js => cdf64ea9.cb4bb158.js} (93%) rename assets/js/{cfdfe126.509157cc.js => cfdfe126.cf276977.js} (98%) rename assets/js/{d103759a.8077d5ff.js => d103759a.d028e56e.js} (96%) rename assets/js/{d1163e47.f83b2fc3.js => d1163e47.42aa0e91.js} (97%) rename assets/js/{d46ef83d.c5bf987b.js => d46ef83d.a65e59af.js} (97%) rename assets/js/{d496897e.9944ccdd.js => d496897e.653492b3.js} (90%) rename assets/js/{d66cbd9e.730740ec.js => d66cbd9e.fd5078df.js} (89%) rename assets/js/{d739767a.fe28638e.js => d739767a.15a11c1a.js} (98%) rename assets/js/{d83f208d.f05356f8.js => d83f208d.d9a894b1.js} (91%) rename assets/js/{d9407a00.b266d8d2.js => d9407a00.7a6b235f.js} (97%) rename assets/js/{d9673b17.82ee7398.js => d9673b17.e4cec172.js} (87%) rename assets/js/{d9b4ee1e.8f64d6ef.js => d9b4ee1e.d50edb80.js} (97%) rename assets/js/{db22fd17.f6898ba5.js => db22fd17.d6e67f67.js} (72%) rename assets/js/{dc23cd40.5525d066.js => dc23cd40.cdc36a02.js} (88%) rename assets/js/{dec87402.2816995e.js => dec87402.2599a454.js} (98%) rename assets/js/{deccabf3.45fab54b.js => deccabf3.122e00d9.js} (91%) rename assets/js/{df2a6e58.eac9161d.js => df2a6e58.5de9dabd.js} (98%) rename assets/js/{df4d464e.2c9b2a78.js => df4d464e.afbd410d.js} (95%) rename assets/js/{e064f6d4.5f434384.js => e064f6d4.8252e773.js} (92%) rename assets/js/{e1a2ab10.e4c6b390.js => e1a2ab10.5778db0c.js} (95%) rename assets/js/{e1c8d71f.26d3cbfc.js => e1c8d71f.e4137a89.js} (94%) rename assets/js/{e35d7c3e.ba8cfce9.js => e35d7c3e.f7bb8c4c.js} (66%) rename assets/js/{e38c422a.93fd0ffe.js => e38c422a.674e4b74.js} (91%) rename assets/js/{e3f28bf9.15423e05.js => e3f28bf9.d055211d.js} (97%) rename assets/js/{e546fc5a.59353cfa.js => e546fc5a.e8f570b5.js} (96%) rename assets/js/{e6412603.62be0a1e.js => e6412603.0551d01b.js} (96%) rename assets/js/{e69dadab.bbc7b49b.js => e69dadab.0288ce06.js} (81%) rename assets/js/{e6c31e60.31d339aa.js => e6c31e60.c452f930.js} (84%) rename assets/js/{e7477a94.633316ab.js => e7477a94.eabd4d09.js} (85%) rename assets/js/{e7923b27.83e4a55f.js => e7923b27.e35876bd.js} (98%) rename assets/js/{e84cabb0.8495bcb0.js => e84cabb0.9acc24b5.js} (95%) delete mode 100644 assets/js/e88443f3.27a3c2d1.js create mode 100644 assets/js/e88443f3.5a00b1f0.js rename assets/js/{e983a6d7.d1657e7a.js => e983a6d7.83a88cd3.js} (81%) rename assets/js/{ea3ffc82.c20de2c2.js => ea3ffc82.50414916.js} (91%) rename assets/js/{ed2a4846.94dc99f5.js => ed2a4846.06d649a8.js} (97%) rename assets/js/{ed603d23.5da37b94.js => ed603d23.9b191ba4.js} (93%) rename assets/js/{edb40f78.f17db715.js => edb40f78.211eec30.js} (95%) rename assets/js/{f1ad83b2.2358ae4e.js => f1ad83b2.d50b3f1d.js} (91%) rename assets/js/{f20efc55.22bbdcbd.js => f20efc55.71218c42.js} (94%) delete mode 100644 assets/js/f27eaf88.c736f69d.js create mode 100644 assets/js/f27eaf88.dc3e64e4.js rename assets/js/{f4271232.819ea1d3.js => f4271232.65f13e39.js} (95%) rename assets/js/{f6cd0d3d.44684c87.js => f6cd0d3d.e9026238.js} (94%) rename assets/js/{f6cf66bc.c8ab5809.js => f6cf66bc.9cd66d41.js} (86%) rename assets/js/{f7197f43.651fdac2.js => f7197f43.fca65cde.js} (95%) rename assets/js/{f771dec1.fe89e267.js => f771dec1.e744a9ff.js} (84%) rename assets/js/{f7c9e078.6ca3691b.js => f7c9e078.f0651411.js} (87%) rename assets/js/{f86eb50f.8afe0a58.js => f86eb50f.1d740de9.js} (94%) rename assets/js/{fb8cd692.eb9397b4.js => fb8cd692.d16ceec6.js} (87%) rename assets/js/{fbfd390f.beb7dad5.js => fbfd390f.9219e308.js} (86%) rename assets/js/{fc923f19.cfe1fa4b.js => fc923f19.c804119f.js} (79%) rename assets/js/{fd702dc7.31ea96ca.js => fd702dc7.3ba9d8f5.js} (95%) rename assets/js/{fe1a05e2.e35c611b.js => fe1a05e2.7e1fe783.js} (98%) rename assets/js/{fe716911.946349dd.js => fe716911.7099efb4.js} (90%) rename assets/js/{fee0a0be.22163b57.js => fee0a0be.9c93ed65.js} (80%) rename assets/js/{ff2f63f6.fde6fbda.js => ff2f63f6.50c9ef93.js} (95%) rename assets/js/{runtime~main.2fed3aba.js => runtime~main.59037fa1.js} (64%) diff --git a/404.html b/404.html index 19495503a6d..12b8e85effe 100644 --- a/404.html +++ b/404.html @@ -13,7 +13,7 @@ - + diff --git a/api.html b/api.html index f646b0fb716..2641f26b2f7 100644 --- a/api.html +++ b/api.html @@ -13,7 +13,7 @@ - + diff --git a/api/classes/CancellationTokenSource.html b/api/classes/CancellationTokenSource.html index 754cfeb27a9..eaaa371e417 100644 --- a/api/classes/CancellationTokenSource.html +++ b/api/classes/CancellationTokenSource.html @@ -13,7 +13,7 @@ - + @@ -32,7 +32,7 @@

The cancellation token of this source.

Source​

-

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

+

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

Methods​

cancel()​

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

Returns​

void

Source​

-

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

+

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


dispose()​

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

Returns​

void

Source​

-

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

+

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

\ No newline at end of file diff --git a/api/classes/Disposable.html b/api/classes/Disposable.html index 77c3b68344a..0f08d722635 100644 --- a/api/classes/Disposable.html +++ b/api/classes/Disposable.html @@ -13,7 +13,7 @@ - + @@ -33,7 +33,7 @@

Returns​

Disposable

Source​

-

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

+

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

new Disposable(callOnDispose)​

new Disposable(callOnDispose): Disposable

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

Returns​

Disposable

Source​

-

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

+

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

Methods​

dispose()​

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

Returns​

void

Source​

-

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

+

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


create()​

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

Returns​

Disposable

Source​

-

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

+

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


from()​

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

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

Source​

-

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

+

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

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

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

Source​

-

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

+

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

Methods​

dispose()​

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

Returns​

void

Source​

-

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

+

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


fire()​

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

Returns​

void

Source​

-

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

+

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

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

Returns​

TelemetryTrustedValue< T >

Source​

-

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

+

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

Properties​

value​

readonly value: T

Source​

-

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

+

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

\ No newline at end of file diff --git a/api/classes/Uri.html b/api/classes/Uri.html index 9a823e1b4c5..89cce9320e1 100644 --- a/api/classes/Uri.html +++ b/api/classes/Uri.html @@ -13,7 +13,7 @@ - + @@ -34,7 +34,7 @@

Returns​

Uri

Source​

-

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

+

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

Properties​

authority​

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

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

Source​

-

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

+

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


fragment​

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

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

Source​

-

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

+

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


fsPath​

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

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

Source​

-

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

+

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


path​

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

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

Source​

-

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

+

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


query​

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

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

Source​

-

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

+

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


scheme​

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

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

Source​

-

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

+

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

Methods​

toString()​

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

Returns​

string

Source​

-

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

+

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


with()​

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

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

Source​

-

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

+

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


file()​

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

Returns​

Uri

Source​

-

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

+

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


joinPath()​

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

Uri

A new uri which path is joined with the given fragments

Source​

-

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

+

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


parse()​

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

See​

Uri.toString

Source​

-

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

+

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

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

Error: 3

Source​

-

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

+

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


Info​

Info: 1

Source​

-

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

+

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


Warning​

Warning: 2

Source​

-

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/enumerations/ProgressLocation.html b/api/enumerations/ProgressLocation.html index 43d7248ad56..97690c1d793 100644 --- a/api/enumerations/ProgressLocation.html +++ b/api/enumerations/ProgressLocation.html @@ -13,7 +13,7 @@ - + @@ -32,7 +32,7 @@ removed in future versions of Podman Desktop. We strongly encourage to use TASK_

See​

TASK_WIDGET

Source​

-

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

+

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


TASK_WIDGET​

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

Show progress in the task manager widget

Source​

-

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

+

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

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

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

Source​

-

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

+

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


Separator​

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

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

Source​

-

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

+

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

\ No newline at end of file diff --git a/api/interfaces/AuditRecord.html b/api/interfaces/AuditRecord.html index 53920486fbc..80d37dbd753 100644 --- a/api/interfaces/AuditRecord.html +++ b/api/interfaces/AuditRecord.html @@ -13,7 +13,7 @@ - + @@ -24,13 +24,13 @@

record: string

Source​

-

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

+

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


type​

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

Source​

-

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

+

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

\ No newline at end of file diff --git a/api/interfaces/AuditRequestItems.html b/api/interfaces/AuditRequestItems.html index 97417135239..aec959d5819 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 2c0fe3f781d..737b7c1a426 100644 --- a/api/interfaces/AuditResult.html +++ b/api/interfaces/AuditResult.html @@ -13,7 +13,7 @@ - + @@ -24,6 +24,6 @@

records: AuditRecord[]

Source​

-

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

+

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

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

Returns​

Promise< AuditResult >

Source​

-

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

+

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

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

optional email: string

Source​

-

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

+

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


password​

password: string

Source​

-

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

+

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


serveraddress​

serveraddress: string

Source​

-

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

+

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


username​

username: string

Source​

-

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

+

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

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

Defaults to false.

Source​

-

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

+

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


createIfNone?​

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

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

Defaults to false.

Source​

-

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

+

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


forceNewSession?​

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

createIfNone.

This defaults to false.

Source​

-

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

+

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


silent?​

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

Defaults to false.

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

Source​

-

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

+

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

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

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

Source​

-

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

+

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

Methods​

createSession()​

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

Promise< AuthenticationSession >

A promise that resolves to an authentication session.

Source​

-

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

+

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


getSessions()​

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

Promise< readonly AuthenticationSession[] >

A promise that resolves to an array of authentication sessions.

Source​

-

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

+

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


removeSession()​

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

Returns​

Promise< void >

Source​

-

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

+

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

\ No newline at end of file diff --git a/api/interfaces/AuthenticationProviderAuthenticationSessionsChangeEvent.html b/api/interfaces/AuthenticationProviderAuthenticationSessionsChangeEvent.html index 8ae79c1e481..754996c6ac5 100644 --- a/api/interfaces/AuthenticationProviderAuthenticationSessionsChangeEvent.html +++ b/api/interfaces/AuthenticationProviderAuthenticationSessionsChangeEvent.html @@ -13,7 +13,7 @@ - + @@ -26,7 +26,7 @@

The AuthenticationSessions of the AuthenticationProvider that have been added.

Source​

-

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

+

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


changed?​

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

Source​

-

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

+

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


removed?​

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

The AuthenticationSessions of the AuthenticationProvider that have been removed.

Source​

-

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

+

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

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

The unique identifier of the authentication provider.

Source​

-

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

+

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


label​

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

The human-readable name of the authentication provider.

Source​

-

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

+

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

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

optional readonly images: ProviderImages

Source​

-

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

+

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


supportsMultipleAccounts?​

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

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

Source​

-

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

+

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

\ No newline at end of file diff --git a/api/interfaces/AuthenticationSession.html b/api/interfaces/AuthenticationSession.html index 1646c060e7a..deea9c75cd6 100644 --- a/api/interfaces/AuthenticationSession.html +++ b/api/interfaces/AuthenticationSession.html @@ -13,7 +13,7 @@ - + @@ -26,7 +26,7 @@

The access token.

Source​

-

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

+

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


account​

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

The account associated with the session.

Source​

-

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

+

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


id​

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

The identifier of the authentication session.

Source​

-

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

+

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


scopes​

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

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

Source​

-

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

+

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

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

The unique identifier of the account.

Source​

-

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

+

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


label​

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

The human-readable name of the account.

Source​

-

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

+

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

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

The authenticationProvider that has had its sessions change.

Source​

-

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

+

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

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

major: number

Source​

-

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

+

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


minor​

minor: number

Source​

-

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

+

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


op​

op: string

Source​

-

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

+

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


value​

value: number

Source​

-

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

+

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

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

io_merged_recursive: BlkioStatEntry[]

Source​

-

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

+

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


io_queue_recursive​

io_queue_recursive: BlkioStatEntry[]

Source​

-

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

+

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


io_service_bytes_recursive​

io_service_bytes_recursive: BlkioStatEntry[]

Source​

-

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

+

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


io_service_time_recursive​

io_service_time_recursive: BlkioStatEntry[]

Source​

-

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

+

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


io_serviced_recursive​

io_serviced_recursive: BlkioStatEntry[]

Source​

-

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

+

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


io_time_recursive​

io_time_recursive: BlkioStatEntry[]

Source​

-

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

+

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


io_wait_time_recursive​

io_wait_time_recursive: BlkioStatEntry[]

Source​

-

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

+

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


sectors_recursive​

sectors_recursive: BlkioStatEntry[]

Source​

-

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

+

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

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

The abort controller for running the build image operation

Source​

-

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

+

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


buildargs?​

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

[key: string]: string

Source​

-

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

+

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


cachefrom?​

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

JSON array of images used for build cache resolution.

Source​

-

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

+

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


containerFile?​

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

Specifies a Containerfile which contains instructions for building the image

Source​

-

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

+

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


cpuperiod?​

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

The length of a CPU period in microseconds.

Source​

-

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

+

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


cpuquota?​

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

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

Source​

-

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

+

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


cpusetcpus?​

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

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

Source​

-

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

+

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


cpushares?​

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

CPU shares (relative weight).

Source​

-

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

+

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


extrahosts?​

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

Extra hosts to add to /etc/hosts

Source​

-

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

+

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


forcerm?​

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

Always remove intermediate containers, even upon failure.

Source​

-

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

+

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


labels?​

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

[key: string]: string

Source​

-

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

+

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


memory?​

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

Set memory limit for build.

Source​

-

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

+

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


memswap?​

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

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

Source​

-

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

+

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


networkmode?​

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

Source​

-

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

+

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


nocache?​

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

Default: false

Do not use the cache when building the image.

Source​

-

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

+

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


outputs?​

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

Default: ""

BuildKit output configuration

Source​

-

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

+

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


platform?​

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

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

Source​

-

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

+

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


provider?​

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

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

Source​

-

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

+

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


pull?​

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

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

Source​

-

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

+

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


q?​

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

Default: false

Suppress verbose build output.

Source​

-

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

+

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


remote?​

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

Source​

-

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

+

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


rm?​

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

Default: true

Remove intermediate containers after a successful build.

Source​

-

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

+

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


shmsize?​

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

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

Source​

-

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

+

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


squash?​

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

Squash the resulting images layers into a single layer.

Source​

-

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

+

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


tag?​

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

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

Source​

-

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

+

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


target?​

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

Default: ""

Target build stage

Source​

-

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

+

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

\ No newline at end of file diff --git a/api/interfaces/CPUStats.html b/api/interfaces/CPUStats.html index 730ca673bda..02e6d090bac 100644 --- a/api/interfaces/CPUStats.html +++ b/api/interfaces/CPUStats.html @@ -13,7 +13,7 @@ - + @@ -24,27 +24,27 @@

cpu_usage: CPUUsage

Source​

-

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

+

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


online_cpus​

online_cpus: number

Source​

-

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

+

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


system_cpu_usage​

system_cpu_usage: number

Source​

-

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

+

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


throttling_data​

throttling_data: ThrottlingData

Source​

-

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

+

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

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

percpu_usage: number[]

Source​

-

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

+

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


total_usage​

total_usage: number

Source​

-

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

+

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


usage_in_kernelmode​

usage_in_kernelmode: number

Source​

-

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

+

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


usage_in_usermode​

usage_in_usermode: number

Source​

-

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

+

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

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

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

Source​

-

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

+

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


onCancellationRequested​

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

An Event which fires upon cancellation.

Source​

-

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

+

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

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

optional description: string

Source​

-

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

+

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


optional docLinks: Link[]

Source​

-

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

+

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


docLinksDescription?​

optional docLinksDescription: string

Source​

-

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

+

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


fixCommand?​

optional fixCommand: CheckResultFixCommand

Source​

-

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

+

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


successful​

successful: boolean

Source​

-

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

+

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

\ No newline at end of file diff --git a/api/interfaces/CheckResultFixCommand.html b/api/interfaces/CheckResultFixCommand.html index 90ff202f0f9..018cf9cebc0 100644 --- a/api/interfaces/CheckResultFixCommand.html +++ b/api/interfaces/CheckResultFixCommand.html @@ -13,7 +13,7 @@ - + @@ -24,13 +24,13 @@

id: string

Source​

-

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

+

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


title​

title: string

Source​

-

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

+

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

\ No newline at end of file diff --git a/api/interfaces/CliTool.html b/api/interfaces/CliTool.html index 76faa53032e..bc73cbf4d62 100644 --- a/api/interfaces/CliTool.html +++ b/api/interfaces/CliTool.html @@ -13,7 +13,7 @@ - + @@ -28,7 +28,7 @@

displayName: string

Source​

-

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

+

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


extensionInfo​

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

label: string

Source​

-

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

+

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


id​

id: string

Source​

-

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

+

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


images​

images: ProviderImages

Source​

-

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

+

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


markdownDescription​

markdownDescription: string

Source​

-

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

+

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


name​

name: string

Source​

-

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

+

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


onDidUpdateVersion​

onDidUpdateVersion: Event< string >

Source​

-

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

+

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


state​

state: "registered"

Source​

-

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

+

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

Methods​

dispose()​

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

Inherited from​

Disposable.dispose

Source​

-

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

+

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


registerUpdate()​

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

Returns​

Disposable

Source​

-

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

+

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


updateVersion()​

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

Returns​

void

Source​

-

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

+

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

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

displayName: string

Source​

-

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

+

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


images​

images: ProviderImages

Source​

-

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

+

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


markdownDescription​

markdownDescription: string

Source​

-

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

+

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


name​

name: string

Source​

-

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

+

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


path​

path: string

Source​

-

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

+

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


version​

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

Source​

-

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

+

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

\ No newline at end of file diff --git a/api/interfaces/CliToolUpdate.html b/api/interfaces/CliToolUpdate.html index 7707f0315c7..5781235bf9e 100644 --- a/api/interfaces/CliToolUpdate.html +++ b/api/interfaces/CliToolUpdate.html @@ -13,7 +13,7 @@ - + @@ -28,13 +28,13 @@

Returns​

Promise< void >

Source​

-

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

+

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


version​

version: string

Source​

-

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

+

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

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

optional displayName: string

Source​

-

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

+

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


images?​

optional images: ProviderImages

Source​

-

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

+

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


markdownDescription?​

optional markdownDescription: string

Source​

-

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

+

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


path?​

optional path: string

Source​

-

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

+

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


version​

version: string

Source​

-

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

+

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

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

Promise< string >

A Promise that resolves to a string.

Source​

-

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

+

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


writeText()​

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

Promise< void >

A Promise that resolves when writing happened.

Source​

-

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

+

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

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

optional arguments: any[]

Source​

-

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

+

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


command​

command: string

Source​

-

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

+

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


title​

title: string

Source​

-

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

+

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


tooltip?​

optional tooltip: string

Source​

-

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

+

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

\ No newline at end of file diff --git a/api/interfaces/Configuration.html b/api/interfaces/Configuration.html index 4a82f2c8937..182305d8487 100644 --- a/api/interfaces/Configuration.html +++ b/api/interfaces/Configuration.html @@ -13,7 +13,7 @@ - + @@ -36,7 +36,7 @@

undefined | T

The value section denotes or undefined.

Source​
-

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

+

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

get(section, defaultValue)​

get<T>(section, defaultValue): T

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

T

The value section denotes or the default.

Source​
-

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

+

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


has()​

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

boolean

true if the section doesn't resolve to undefined.

Source​

-

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

+

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


update()​

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

Returns​

Promise< void >

Source​

-

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

+

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

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

boolean

true if the given section has changed.

Source​

-

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

+

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

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

optional email: string

Source​

-

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

+

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


password​

password: string

Source​

-

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

+

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


serveraddress​

serveraddress: string

Source​

-

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

+

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


username​

username: string

Source​

-

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

+

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

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

Default: false

Command is already escaped (Windows only)

Source​

-

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

+

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


AttachStderr?​

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

Whether to attach to stderr (default false)

Source​

-

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

+

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


AttachStdin?​

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

Whether to attach to stdin (default false)

Source​

-

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

+

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


AttachStdout?​

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

Whether to attach to stdout(default false)

Source​

-

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

+

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


Cmd?​

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

Command to run specified as an array of strings

Source​

-

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

+

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


Detach?​

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

Run the container in the background

Source​

-

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

+

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


Domainname?​

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

The domain name to use for the container.

Source​

-

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

+

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


Entrypoint?​

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

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

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

Source​

-

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

+

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


Env?​

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

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

Source​

-

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

+

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


EnvFiles?​

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

Environment files to use

Source​

-

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

+

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


ExposedPorts?​

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

Index signature​

[port: string]: object

Source​

-

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

+

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


HealthCheck?​

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

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

Source​

-

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

+

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


HostConfig?​

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

Container configuration that depends on the host we are running on

Source​

-

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

+

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


Hostname?​

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

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

Source​

-

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

+

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


Image?​

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

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

Source​

-

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

+

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


Labels?​

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

Index signature​

[label: string]: string

Source​

-

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

+

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


MacAddress?​

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

MAC address of the container.

Source​

-

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

+

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


NetworkConfig?​

optional NetworkConfig: NetworkingConfig

Source​

-

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

+

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


NetworkDisabled?​

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

Disable networking for the container.

Source​

-

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

+

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


OnBuild?​

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

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

Source​

-

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

+

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


OpenStdin?​

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

Whether to open stdin (default false)

Source​

-

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

+

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


Shell?​

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

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

Source​

-

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

+

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


StdinOnce?​

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

Close stdin after one attached client disconnects (deafult false)

Source​

-

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

+

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


StopSignal?​

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

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

Source​

-

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

+

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


StopTimeout?​

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

Default: 10

Timeout to stop a container in seconds.

Source​

-

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

+

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


Tty?​

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

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

Source​

-

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

+

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


User?​

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

The user that commands are run as inside the container

Source​

-

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

+

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


Volumes?​

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

Index signature​

[volume: string]: object

Source​

-

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

+

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


WorkingDir?​

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

The working directory for commands to run in.

Source​

-

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

+

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


name?​

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

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

Source​

-

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

+

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


platform?​

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

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

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

Source​

-

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

+

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


pod?​

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

Pod where to create the container in

Source​

-

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

+

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


start?​

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

Start the container immediately (default true)

Source​

-

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

+

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

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

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

Source​

-

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

+

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

\ No newline at end of file diff --git a/api/interfaces/ContainerEngineInfo.html b/api/interfaces/ContainerEngineInfo.html index 8c098d7aab6..0625d28fe13 100644 --- a/api/interfaces/ContainerEngineInfo.html +++ b/api/interfaces/ContainerEngineInfo.html @@ -13,7 +13,7 @@ - + @@ -26,7 +26,7 @@

Percentage of idle CPUs (for Podman engines only)

Source​

-

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

+

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


cpus?​

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

number of CPUs available for the container engine

Source​

-

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

+

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


diskSize?​

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

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

Source​

-

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

+

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


diskUsed?​

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

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

Source​

-

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

+

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


engineId​

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

unique id identifying the container engine

Source​

-

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

+

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


engineName​

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

name of the container engine

Source​

-

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

+

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


engineType​

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

engine type, either 'podman' or 'docker'

Source​

-

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

+

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


memory?​

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

Quantity of memory available for the container engine

Source​

-

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

+

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


memoryUsed?​

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

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

Source​

-

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

+

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

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

Command: string

Source​

-

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

+

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


Created​

Created: number

Source​

-

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

+

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


HostConfig​

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

NetworkMode: string

Source​

-

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

+

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


Id​

Id: string

Source​

-

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

+

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


Image​

Image: string

Source​

-

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

+

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


ImageID​

ImageID: string

Source​

-

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

+

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


Labels​

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

Index signature​

[label: string]: string

Source​

-

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

+

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


Mounts​

Mounts: object[]

Source​

-

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

+

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


Names​

Names: string[]

Source​

-

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

+

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


NetworkSettings​

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

[networkType: string]: NetworkInfo

Source​

-

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

+

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


Ports​

Ports: Port[]

Source​

-

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

+

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


State​

State: string

Source​

-

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

+

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


Status​

Status: string

Source​

-

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

+

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


engineId​

engineId: string

Source​

-

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

+

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


engineName​

engineName: string

Source​

-

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

+

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


engineType​

engineType: "docker" | "podman"

Source​

-

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

+

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

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

AppArmorProfile: string

Source​

-

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

+

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


Args​

Args: string[]

Source​

-

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

+

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


Config​

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

WorkingDir: string

Source​

-

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

+

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


Created​

Created: string

Source​

-

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

+

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


Driver​

Driver: string

Source​

-

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

+

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


ExecIDs?​

optional ExecIDs: string[]

Source​

-

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

+

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


GraphDriver​

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

Name: string

Source​

-

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

+

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


HostConfig​

HostConfig: HostConfig

Source​

-

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

+

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


HostnamePath​

HostnamePath: string

Source​

-

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

+

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


HostsPath​

HostsPath: string

Source​

-

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

+

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


Id​

Id: string

Source​

-

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

+

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


Image​

Image: string

Source​

-

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

+

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


LogPath​

LogPath: string

Source​

-

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

+

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


MountLabel​

MountLabel: string

Source​

-

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

+

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


Mounts​

Mounts: object[]

Source​

-

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

+

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


Name​

Name: string

Source​

-

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

+

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


NetworkSettings​

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

optional SecondaryIPv6Addresses: unknown

Source​

-

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

+

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


Path​

Path: string

Source​

-

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

+

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


Platform​

Platform: string

Source​

-

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

+

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


ProcessLabel​

ProcessLabel: string

Source​

-

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

+

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


ResolvConfPath​

ResolvConfPath: string

Source​

-

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

+

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


RestartCount​

RestartCount: number

Source​

-

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

+

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


State​

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

Status: string

Source​

-

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

+

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


engineId​

engineId: string

Source​

-

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

+

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


engineName​

engineName: string

Source​

-

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

+

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

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

optional Type: string

Source​

-

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

+

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


id​

id: string

Source​

-

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

+

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


status​

status: string

Source​

-

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

+

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


type​

type: string

Source​

-

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

+

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

\ No newline at end of file diff --git a/api/interfaces/ContainerProviderConnection.html b/api/interfaces/ContainerProviderConnection.html index e6dbc8de914..026a9aa4d21 100644 --- a/api/interfaces/ContainerProviderConnection.html +++ b/api/interfaces/ContainerProviderConnection.html @@ -13,7 +13,7 @@ - + @@ -24,28 +24,28 @@

endpoint: ContainerProviderConnectionEndpoint

Source​

-

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

+

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


lifecycle?​

optional lifecycle: ProviderConnectionLifecycle

Source​

-

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

+

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


name​

name: string

Source​

-

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

+

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


type​

type: "docker" | "podman"

Source​

-

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

+

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

Methods​

status()​

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

Returns​

ProviderConnectionStatus

Source​

-

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

+

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

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

socketPath: string

Source​

-

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

+

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

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

Inherited from​

ProviderConnectionFactory.creationButtonTitle

Source​

-

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

+

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


creationDisplayName?​

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

Inherited from​

ProviderConnectionFactory.creationDisplayName

Source​

-

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

+

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

Methods​

create()​

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

Returns​

Promise< void >

Source​

-

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

+

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


initialize()?​

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

Inherited from​

ProviderConnectionFactory.initialize

Source​

-

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

+

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

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

optional blkio_stats: BlkioStats

Source​

-

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

+

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


cpu_stats​

cpu_stats: CPUStats

Source​

-

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

+

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


engineId​

engineId: string

Source​

-

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

+

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


engineName​

engineName: string

Source​

-

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

+

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


memory_stats​

memory_stats: MemoryStats

Source​

-

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

+

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


networks​

networks: NetworkStats

Source​

-

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

+

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


num_procs​

num_procs: number

Source​

-

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

+

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


pids_stats?​

optional pids_stats: PidsStats

Source​

-

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

+

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


precpu_stats​

precpu_stats: CPUStats

Source​

-

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

+

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


preread​

preread: string

Source​

-

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

+

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


read​

read: string

Source​

-

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

+

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


storage_stats?​

optional storage_stats: StorageStats

Source​

-

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

+

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

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

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

Source​

-

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

+

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


description?​

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

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

Source​

-

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

+

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


hideItemSections​

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

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

Source​

-

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

+

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


icon?​

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

An optional base64 PNG image

Source​

-

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

+

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


items​

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

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

Source​

-

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

+

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


minHeight?​

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

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

Source​

-

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

+

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


onDidConfirmSelection​

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

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

Source​

-

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

+

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


onDidHide​

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

An event signaling when this input UI is hidden.

Source​

-

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

+

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


title?​

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

An optional human-readable string which is rendered prominent.

Source​

-

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

+

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

Methods​

dispose()​

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

Returns​

void

Source​

-

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

+

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


hide()​

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

Returns​

void

Source​

-

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

+

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


show()​

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

Returns​

void

Source​

-

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

+

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

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

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

Source​

-

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

+

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


markDownContent​

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

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

Source​

-

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

+

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


sections?​

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

Optional sections that will be rendered in separate lines

Source​

-

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

+

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


selected?​

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

Optional flag indicating if this item is selected initially

Source​

-

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

+

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


title​

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

A human-readable string which is rendered prominent.

Source​

-

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

+

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

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

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

Source​

-

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

+

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


markDownContent?​

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

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

Source​

-

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

+

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


title​

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

A human-readable string which is rendered prominent.

Source​

-

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

+

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

\ No newline at end of file diff --git a/api/interfaces/DeviceRequest.html b/api/interfaces/DeviceRequest.html index 96b58a4fe35..5dad8454da3 100644 --- a/api/interfaces/DeviceRequest.html +++ b/api/interfaces/DeviceRequest.html @@ -13,7 +13,7 @@ - + @@ -24,28 +24,28 @@

optional Capabilities: string[][]

Source​

-

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

+

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


Count?​

optional Count: number

Source​

-

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

+

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


DeviceIDs?​

optional DeviceIDs: string[]

Source​

-

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

+

packages/extension-api/src/extension-api.d.ts:2123


Driver?​

optional Driver: string

Source​

-

packages/extension-api/src/extension-api.d.ts:2121

+

packages/extension-api/src/extension-api.d.ts:2121


Options?​

@@ -54,6 +54,6 @@

Index signature​

[key: string]: string

Source​

-

packages/extension-api/src/extension-api.d.ts:2125

+

packages/extension-api/src/extension-api.d.ts:2125

\ No newline at end of file diff --git a/api/interfaces/EndpointIPAMConfig.html b/api/interfaces/EndpointIPAMConfig.html index b759eec8e8d..47a61c8d2ba 100644 --- a/api/interfaces/EndpointIPAMConfig.html +++ b/api/interfaces/EndpointIPAMConfig.html @@ -13,7 +13,7 @@ - + @@ -24,20 +24,20 @@

optional IPv4Address: string

Source​

-

packages/extension-api/src/extension-api.d.ts:2458

+

packages/extension-api/src/extension-api.d.ts:2458


IPv6Address?​

optional IPv6Address: string

Source​

-

packages/extension-api/src/extension-api.d.ts:2459

+

packages/extension-api/src/extension-api.d.ts:2459


LinkLocalIPs?​

optional LinkLocalIPs: string[]

Source​

-

packages/extension-api/src/extension-api.d.ts:2460

+

packages/extension-api/src/extension-api.d.ts:2460

\ No newline at end of file diff --git a/api/interfaces/EndpointSettings.html b/api/interfaces/EndpointSettings.html index 057f6575283..24fa3bf8531 100644 --- a/api/interfaces/EndpointSettings.html +++ b/api/interfaces/EndpointSettings.html @@ -13,7 +13,7 @@ - + @@ -24,7 +24,7 @@

optional Aliases: string[]

Source​

-

packages/extension-api/src/extension-api.d.ts:2476

+

packages/extension-api/src/extension-api.d.ts:2476


DNSNames?​

@@ -36,7 +36,7 @@ aliases, container short ID, and hostname.

appending .<network-name>. For instance, if container name is my.ctr and the network is named testnet, DNSNames will contain my.ctr and the FQDN will be my.ctr.testnet.

Source​

-

packages/extension-api/src/extension-api.d.ts:2531

+

packages/extension-api/src/extension-api.d.ts:2531


DriverOpts?​

@@ -46,7 +46,7 @@ appending .<network-name>. For instance, if container name is

Index signature​

[key: string]: string

Source​

-

packages/extension-api/src/extension-api.d.ts:2521

+

packages/extension-api/src/extension-api.d.ts:2521


EndpointID?​

@@ -54,7 +54,7 @@ appending .<network-name>. For instance, if container name is

Unique ID for the service endpoint in a Sandbox.

Source​

-

packages/extension-api/src/extension-api.d.ts:2486

+

packages/extension-api/src/extension-api.d.ts:2486


Gateway?​

@@ -62,7 +62,7 @@ appending .<network-name>. For instance, if container name is

Gateway address for this network.

Source​

-

packages/extension-api/src/extension-api.d.ts:2491

+

packages/extension-api/src/extension-api.d.ts:2491


GlobalIPv6Address?​

@@ -70,7 +70,7 @@ appending .<network-name>. For instance, if container name is

Global IPv6 address.

Source​

-

packages/extension-api/src/extension-api.d.ts:2511

+

packages/extension-api/src/extension-api.d.ts:2511


GlobalIPv6PrefixLen?​

@@ -78,7 +78,7 @@ appending .<network-name>. For instance, if container name is

Mask length of the global IPv6 address.

Source​

-

packages/extension-api/src/extension-api.d.ts:2516

+

packages/extension-api/src/extension-api.d.ts:2516


IPAMConfig?​

@@ -86,7 +86,7 @@ appending .<network-name>. For instance, if container name is

EndpointIPAMConfig represents an endpoint's IPAM configuration.

Source​

-

packages/extension-api/src/extension-api.d.ts:2467

+

packages/extension-api/src/extension-api.d.ts:2467


IPAddress?​

@@ -94,7 +94,7 @@ appending .<network-name>. For instance, if container name is

IPv4 address.

Source​

-

packages/extension-api/src/extension-api.d.ts:2496

+

packages/extension-api/src/extension-api.d.ts:2496


IPPrefixLen?​

@@ -102,7 +102,7 @@ appending .<network-name>. For instance, if container name is

Mask length of the IPv4 address.

Source​

-

packages/extension-api/src/extension-api.d.ts:2501

+

packages/extension-api/src/extension-api.d.ts:2501


IPv6Gateway?​

@@ -110,14 +110,14 @@ appending .<network-name>. For instance, if container name is

IPv6 gateway address.

Source​

-

packages/extension-api/src/extension-api.d.ts:2506

+

packages/extension-api/src/extension-api.d.ts:2506


optional Links: string[]

Source​

-

packages/extension-api/src/extension-api.d.ts:2469

+

packages/extension-api/src/extension-api.d.ts:2469


MacAddress?​

@@ -125,7 +125,7 @@ appending .<network-name>. For instance, if container name is

MAC address for the endpoint on this network. The network driver might ignore this parameter.

Source​

-

packages/extension-api/src/extension-api.d.ts:2474

+

packages/extension-api/src/extension-api.d.ts:2474


NetworkID?​

@@ -133,6 +133,6 @@ appending .<network-name>. For instance, if container name is

Unique ID of the network.

Source​

-

packages/extension-api/src/extension-api.d.ts:2481

+

packages/extension-api/src/extension-api.d.ts:2481

\ No newline at end of file diff --git a/api/interfaces/Event.html b/api/interfaces/Event.html index e459dc2c061..4c4750637e5 100644 --- a/api/interfaces/Event.html +++ b/api/interfaces/Event.html @@ -13,7 +13,7 @@ - + @@ -35,6 +35,6 @@

Disposable

A disposable which unsubscribes the event listener.

Source​

-

packages/extension-api/src/extension-api.d.ts:106

+

packages/extension-api/src/extension-api.d.ts:106

\ No newline at end of file diff --git a/api/interfaces/ExtensionContext.html b/api/interfaces/ExtensionContext.html index 3cce800f578..344771b346a 100644 --- a/api/interfaces/ExtensionContext.html +++ b/api/interfaces/ExtensionContext.html @@ -13,7 +13,7 @@ - + @@ -25,7 +25,7 @@

The uri of the directory containing the extension.

Source​

-

packages/extension-api/src/extension-api.d.ts:146

+

packages/extension-api/src/extension-api.d.ts:146


secrets​

@@ -33,7 +33,7 @@

A storage utility for secrets. Secrets are persisted across reloads.

Source​

-

packages/extension-api/src/extension-api.d.ts:151

+

packages/extension-api/src/extension-api.d.ts:151


storagePath​

@@ -43,13 +43,13 @@ The directory might not exist on disk and creation is up to the extension.

Source​

-

packages/extension-api/src/extension-api.d.ts:141

+

packages/extension-api/src/extension-api.d.ts:141


subscriptions​

readonly subscriptions: object[]

Source​

-

packages/extension-api/src/extension-api.d.ts:134

+

packages/extension-api/src/extension-api.d.ts:134

\ No newline at end of file diff --git a/api/interfaces/FileSystemWatcher.html b/api/interfaces/FileSystemWatcher.html index 9004c09f0c8..c5a420a84fe 100644 --- a/api/interfaces/FileSystemWatcher.html +++ b/api/interfaces/FileSystemWatcher.html @@ -13,7 +13,7 @@ - + @@ -29,21 +29,21 @@

readonly onDidChange: Event< Uri >

Source​

-

packages/extension-api/src/extension-api.d.ts:1372

+

packages/extension-api/src/extension-api.d.ts:1372


onDidCreate​

readonly onDidCreate: Event< Uri >

Source​

-

packages/extension-api/src/extension-api.d.ts:1371

+

packages/extension-api/src/extension-api.d.ts:1371


onDidDelete​

readonly onDidDelete: Event< Uri >

Source​

-

packages/extension-api/src/extension-api.d.ts:1373

+

packages/extension-api/src/extension-api.d.ts:1373

Methods​

dispose()​

@@ -55,6 +55,6 @@

Inherited from​

Disposable.dispose

Source​

-

packages/extension-api/src/extension-api.d.ts:78

+

packages/extension-api/src/extension-api.d.ts:78

\ No newline at end of file diff --git a/api/interfaces/GenerateKubeResult.html b/api/interfaces/GenerateKubeResult.html index 89c10dea504..b2b757b7c81 100644 --- a/api/interfaces/GenerateKubeResult.html +++ b/api/interfaces/GenerateKubeResult.html @@ -13,7 +13,7 @@ - + @@ -25,6 +25,6 @@

yaml: string

Source​

-

packages/extension-api/src/extension-api.d.ts:1837

+

packages/extension-api/src/extension-api.d.ts:1837

\ No newline at end of file diff --git a/api/interfaces/HealthCheckLog.html b/api/interfaces/HealthCheckLog.html index f89f2c98f5e..b615bf7f517 100644 --- a/api/interfaces/HealthCheckLog.html +++ b/api/interfaces/HealthCheckLog.html @@ -13,7 +13,7 @@ - + @@ -26,7 +26,7 @@

End time as a string

Source​

-

packages/extension-api/src/extension-api.d.ts:2230

+

packages/extension-api/src/extension-api.d.ts:2230


ExitCode​

@@ -34,7 +34,7 @@

Exitcode is 0 or 1

Source​

-

packages/extension-api/src/extension-api.d.ts:2234

+

packages/extension-api/src/extension-api.d.ts:2234


Output​

@@ -42,7 +42,7 @@

Output is the stdout/stderr from the healthcheck command

Source​

-

packages/extension-api/src/extension-api.d.ts:2238

+

packages/extension-api/src/extension-api.d.ts:2238


Start​

@@ -50,6 +50,6 @@

Start time as string

Source​

-

packages/extension-api/src/extension-api.d.ts:2226

+

packages/extension-api/src/extension-api.d.ts:2226

\ No newline at end of file diff --git a/api/interfaces/HealthCheckResults.html b/api/interfaces/HealthCheckResults.html index 89b02e4783e..5cf8ad3d8f8 100644 --- a/api/interfaces/HealthCheckResults.html +++ b/api/interfaces/HealthCheckResults.html @@ -13,7 +13,7 @@ - + @@ -26,7 +26,7 @@

FailingStreak is the number of consecutive failed healthchecks

Source​

-

packages/extension-api/src/extension-api.d.ts:2212

+

packages/extension-api/src/extension-api.d.ts:2212


Log​

@@ -34,7 +34,7 @@

Log describes healthcheck attempts and results

Source​

-

packages/extension-api/src/extension-api.d.ts:2216

+

packages/extension-api/src/extension-api.d.ts:2216


Status​

@@ -42,6 +42,6 @@

Status is starting, healthy or unhealthy

Source​

-

packages/extension-api/src/extension-api.d.ts:2208

+

packages/extension-api/src/extension-api.d.ts:2208

\ No newline at end of file diff --git a/api/interfaces/HealthConfig.html b/api/interfaces/HealthConfig.html index 1cfd436bd99..f572f37a7b9 100644 --- a/api/interfaces/HealthConfig.html +++ b/api/interfaces/HealthConfig.html @@ -13,7 +13,7 @@ - + @@ -29,7 +29,7 @@ To get health check result you can use Example​
// Set interval to 1 second
Interval?: 1000000000;

Source​

-

packages/extension-api/src/extension-api.d.ts:2426

+

packages/extension-api/src/extension-api.d.ts:2426


Retries?​

@@ -39,7 +39,7 @@ To get health check result you can use Example​
// Set retries to 3
Retries?: 3;

Source​

-

packages/extension-api/src/extension-api.d.ts:2454

+

packages/extension-api/src/extension-api.d.ts:2454


StartPeriod?​

@@ -50,7 +50,7 @@ be 0 or at least 1000000 (1 ms). 0 means inherit.

Example​

// Set start period to 2 seconds
StartPeriod?: 2000000000;

Source​

-

packages/extension-api/src/extension-api.d.ts:2445

+

packages/extension-api/src/extension-api.d.ts:2445


Test?​

@@ -66,7 +66,7 @@ be 0 or at least 1000000 (1 ms). 0 means inherit.

Example​

// Podman will execute the command inside the target container and wait for either a "0" or "failure  exit" code.
Test?: ["CMD-SHELL", "curl http://localhost || exit 1"];

Source​

-

packages/extension-api/src/extension-api.d.ts:2417

+

packages/extension-api/src/extension-api.d.ts:2417


Timeout?​

@@ -76,6 +76,6 @@ be 0 or at least 1000000 (1 ms). 0 means inherit.

Example​

// Set timeout to 5 seconds
Timeout?: 5000000000;

Source​

-

packages/extension-api/src/extension-api.d.ts:2435

+

packages/extension-api/src/extension-api.d.ts:2435

\ No newline at end of file diff --git a/api/interfaces/HostConfig.html b/api/interfaces/HostConfig.html index 6ffe79b96ad..e7f1f67f9c0 100644 --- a/api/interfaces/HostConfig.html +++ b/api/interfaces/HostConfig.html @@ -13,7 +13,7 @@ - + @@ -24,259 +24,259 @@

optional AutoRemove: boolean

Source​

-

packages/extension-api/src/extension-api.d.ts:2129

+

packages/extension-api/src/extension-api.d.ts:2129


Binds?​

optional Binds: string[]

Source​

-

packages/extension-api/src/extension-api.d.ts:2130

+

packages/extension-api/src/extension-api.d.ts:2130


BlkioDeviceReadBps?​

optional BlkioDeviceReadBps: unknown

Source​

-

packages/extension-api/src/extension-api.d.ts:2173

+

packages/extension-api/src/extension-api.d.ts:2173


BlkioDeviceReadIOps?​

optional BlkioDeviceReadIOps: unknown

Source​

-

packages/extension-api/src/extension-api.d.ts:2175

+

packages/extension-api/src/extension-api.d.ts:2175


BlkioDeviceWriteBps?​

optional BlkioDeviceWriteBps: unknown

Source​

-

packages/extension-api/src/extension-api.d.ts:2174

+

packages/extension-api/src/extension-api.d.ts:2174


BlkioDeviceWriteIOps?​

optional BlkioDeviceWriteIOps: unknown

Source​

-

packages/extension-api/src/extension-api.d.ts:2176

+

packages/extension-api/src/extension-api.d.ts:2176


BlkioWeight?​

optional BlkioWeight: number

Source​

-

packages/extension-api/src/extension-api.d.ts:2171

+

packages/extension-api/src/extension-api.d.ts:2171


BlkioWeightDevice?​

optional BlkioWeightDevice: unknown

Source​

-

packages/extension-api/src/extension-api.d.ts:2172

+

packages/extension-api/src/extension-api.d.ts:2172


CapAdd?​

optional CapAdd: string[]

Source​

-

packages/extension-api/src/extension-api.d.ts:2142

+

packages/extension-api/src/extension-api.d.ts:2142


CapDrop?​

optional CapDrop: string[]

Source​

-

packages/extension-api/src/extension-api.d.ts:2143

+

packages/extension-api/src/extension-api.d.ts:2143


Cgroup?​

optional Cgroup: string

Source​

-

packages/extension-api/src/extension-api.d.ts:2150

+

packages/extension-api/src/extension-api.d.ts:2150


CgroupParent?​

optional CgroupParent: string

Source​

-

packages/extension-api/src/extension-api.d.ts:2170

+

packages/extension-api/src/extension-api.d.ts:2170


ConsoleSize?​

optional ConsoleSize: number[]

Source​

-

packages/extension-api/src/extension-api.d.ts:2165

+

packages/extension-api/src/extension-api.d.ts:2165


ContainerIDFile?​

optional ContainerIDFile: string

Source​

-

packages/extension-api/src/extension-api.d.ts:2131

+

packages/extension-api/src/extension-api.d.ts:2131


CpuCount?​

optional CpuCount: number

Source​

-

packages/extension-api/src/extension-api.d.ts:2195

+

packages/extension-api/src/extension-api.d.ts:2195


CpuPercent?​

optional CpuPercent: number

Source​

-

packages/extension-api/src/extension-api.d.ts:2196

+

packages/extension-api/src/extension-api.d.ts:2196


CpuPeriod?​

optional CpuPeriod: number

Source​

-

packages/extension-api/src/extension-api.d.ts:2177

+

packages/extension-api/src/extension-api.d.ts:2177


CpuQuota?​

optional CpuQuota: number

Source​

-

packages/extension-api/src/extension-api.d.ts:2178

+

packages/extension-api/src/extension-api.d.ts:2178


CpuRealtimePeriod?​

optional CpuRealtimePeriod: number

Source​

-

packages/extension-api/src/extension-api.d.ts:2197

+

packages/extension-api/src/extension-api.d.ts:2197


CpuRealtimeRuntime?​

optional CpuRealtimeRuntime: number

Source​

-

packages/extension-api/src/extension-api.d.ts:2198

+

packages/extension-api/src/extension-api.d.ts:2198


CpuShares?​

optional CpuShares: number

Source​

-

packages/extension-api/src/extension-api.d.ts:2169

+

packages/extension-api/src/extension-api.d.ts:2169


CpusetCpus?​

optional CpusetCpus: string

Source​

-

packages/extension-api/src/extension-api.d.ts:2179

+

packages/extension-api/src/extension-api.d.ts:2179


CpusetMems?​

optional CpusetMems: string

Source​

-

packages/extension-api/src/extension-api.d.ts:2180

+

packages/extension-api/src/extension-api.d.ts:2180


DeviceCgroupRules?​

optional DeviceCgroupRules: string[]

Source​

-

packages/extension-api/src/extension-api.d.ts:2182

+

packages/extension-api/src/extension-api.d.ts:2182


DeviceRequests?​

optional DeviceRequests: DeviceRequest[]

Source​

-

packages/extension-api/src/extension-api.d.ts:2183

+

packages/extension-api/src/extension-api.d.ts:2183


Devices?​

optional Devices: unknown

Source​

-

packages/extension-api/src/extension-api.d.ts:2181

+

packages/extension-api/src/extension-api.d.ts:2181


DiskQuota?​

optional DiskQuota: number

Source​

-

packages/extension-api/src/extension-api.d.ts:2184

+

packages/extension-api/src/extension-api.d.ts:2184


Dns?​

optional Dns: string[]

Source​

-

packages/extension-api/src/extension-api.d.ts:2144

+

packages/extension-api/src/extension-api.d.ts:2144


DnsOptions?​

optional DnsOptions: unknown[]

Source​

-

packages/extension-api/src/extension-api.d.ts:2145

+

packages/extension-api/src/extension-api.d.ts:2145


DnsSearch?​

optional DnsSearch: string[]

Source​

-

packages/extension-api/src/extension-api.d.ts:2146

+

packages/extension-api/src/extension-api.d.ts:2146


ExtraHosts?​

optional ExtraHosts: string[]

Source​

-

packages/extension-api/src/extension-api.d.ts:2147

+

packages/extension-api/src/extension-api.d.ts:2147


GroupAdd?​

optional GroupAdd: string[]

Source​

-

packages/extension-api/src/extension-api.d.ts:2148

+

packages/extension-api/src/extension-api.d.ts:2148


Init?​

optional Init: boolean

Source​

-

packages/extension-api/src/extension-api.d.ts:2192

+

packages/extension-api/src/extension-api.d.ts:2192


IpcMode?​

optional IpcMode: string

Source​

-

packages/extension-api/src/extension-api.d.ts:2149

+

packages/extension-api/src/extension-api.d.ts:2149


Isolation?​

optional Isolation: string

Source​

-

packages/extension-api/src/extension-api.d.ts:2166

+

packages/extension-api/src/extension-api.d.ts:2166


KernelMemory?​

optional KernelMemory: number

Source​

-

packages/extension-api/src/extension-api.d.ts:2185

+

packages/extension-api/src/extension-api.d.ts:2185


optional Links: unknown

Source​

-

packages/extension-api/src/extension-api.d.ts:2151

+

packages/extension-api/src/extension-api.d.ts:2151


LogConfig?​

@@ -291,154 +291,154 @@

Type: string

Source​

-

packages/extension-api/src/extension-api.d.ts:2132

+

packages/extension-api/src/extension-api.d.ts:2132


MaskedPaths?​

optional MaskedPaths: string[]

Source​

-

packages/extension-api/src/extension-api.d.ts:2167

+

packages/extension-api/src/extension-api.d.ts:2167


Memory?​

optional Memory: number

Source​

-

packages/extension-api/src/extension-api.d.ts:2186

+

packages/extension-api/src/extension-api.d.ts:2186


MemoryReservation?​

optional MemoryReservation: number

Source​

-

packages/extension-api/src/extension-api.d.ts:2187

+

packages/extension-api/src/extension-api.d.ts:2187


MemorySwap?​

optional MemorySwap: number

Source​

-

packages/extension-api/src/extension-api.d.ts:2188

+

packages/extension-api/src/extension-api.d.ts:2188


MemorySwappiness?​

optional MemorySwappiness: number

Source​

-

packages/extension-api/src/extension-api.d.ts:2189

+

packages/extension-api/src/extension-api.d.ts:2189


Mounts?​

optional Mounts: MountConfig

Source​

-

packages/extension-api/src/extension-api.d.ts:2141

+

packages/extension-api/src/extension-api.d.ts:2141


NanoCpus?​

optional NanoCpus: number

Source​

-

packages/extension-api/src/extension-api.d.ts:2190

+

packages/extension-api/src/extension-api.d.ts:2190


NetworkMode?​

optional NetworkMode: string

Source​

-

packages/extension-api/src/extension-api.d.ts:2136

+

packages/extension-api/src/extension-api.d.ts:2136


OomKillDisable?​

optional OomKillDisable: boolean

Source​

-

packages/extension-api/src/extension-api.d.ts:2191

+

packages/extension-api/src/extension-api.d.ts:2191


OomScoreAdj?​

optional OomScoreAdj: number

Source​

-

packages/extension-api/src/extension-api.d.ts:2152

+

packages/extension-api/src/extension-api.d.ts:2152


PidMode?​

optional PidMode: string

Source​

-

packages/extension-api/src/extension-api.d.ts:2153

+

packages/extension-api/src/extension-api.d.ts:2153


PidsLimit?​

optional PidsLimit: number

Source​

-

packages/extension-api/src/extension-api.d.ts:2193

+

packages/extension-api/src/extension-api.d.ts:2193


PortBindings?​

optional PortBindings: unknown

Source​

-

packages/extension-api/src/extension-api.d.ts:2137

+

packages/extension-api/src/extension-api.d.ts:2137


Privileged?​

optional Privileged: boolean

Source​

-

packages/extension-api/src/extension-api.d.ts:2154

+

packages/extension-api/src/extension-api.d.ts:2154


PublishAllPorts?​

optional PublishAllPorts: boolean

Source​

-

packages/extension-api/src/extension-api.d.ts:2155

+

packages/extension-api/src/extension-api.d.ts:2155


ReadonlyPaths?​

optional ReadonlyPaths: string[]

Source​

-

packages/extension-api/src/extension-api.d.ts:2168

+

packages/extension-api/src/extension-api.d.ts:2168


ReadonlyRootfs?​

optional ReadonlyRootfs: boolean

Source​

-

packages/extension-api/src/extension-api.d.ts:2156

+

packages/extension-api/src/extension-api.d.ts:2156


RestartPolicy?​

optional RestartPolicy: HostRestartPolicy

Source​

-

packages/extension-api/src/extension-api.d.ts:2138

+

packages/extension-api/src/extension-api.d.ts:2138


Runtime?​

optional Runtime: string

Source​

-

packages/extension-api/src/extension-api.d.ts:2164

+

packages/extension-api/src/extension-api.d.ts:2164


SecurityOpt?​

optional SecurityOpt: string[]

Source​

-

packages/extension-api/src/extension-api.d.ts:2157

+

packages/extension-api/src/extension-api.d.ts:2157


ShmSize?​

optional ShmSize: number

Source​

-

packages/extension-api/src/extension-api.d.ts:2162

+

packages/extension-api/src/extension-api.d.ts:2162


StorageOpt?​

@@ -447,7 +447,7 @@

Index signature​

[option: string]: string

Source​

-

packages/extension-api/src/extension-api.d.ts:2158

+

packages/extension-api/src/extension-api.d.ts:2158


Sysctls?​

@@ -456,7 +456,7 @@

Index signature​

[index: string]: string

Source​

-

packages/extension-api/src/extension-api.d.ts:2163

+

packages/extension-api/src/extension-api.d.ts:2163


Tmpfs?​

@@ -465,41 +465,41 @@

Index signature​

[dir: string]: string

Source​

-

packages/extension-api/src/extension-api.d.ts:2159

+

packages/extension-api/src/extension-api.d.ts:2159


UTSMode?​

optional UTSMode: string

Source​

-

packages/extension-api/src/extension-api.d.ts:2160

+

packages/extension-api/src/extension-api.d.ts:2160


Ulimits?​

optional Ulimits: unknown

Source​

-

packages/extension-api/src/extension-api.d.ts:2194

+

packages/extension-api/src/extension-api.d.ts:2194


UsernsMode?​

optional UsernsMode: string

Source​

-

packages/extension-api/src/extension-api.d.ts:2161

+

packages/extension-api/src/extension-api.d.ts:2161


VolumeDriver?​

optional VolumeDriver: string

Source​

-

packages/extension-api/src/extension-api.d.ts:2139

+

packages/extension-api/src/extension-api.d.ts:2139


VolumesFrom?​

optional VolumesFrom: unknown

Source​

-

packages/extension-api/src/extension-api.d.ts:2140

+

packages/extension-api/src/extension-api.d.ts:2140

\ No newline at end of file diff --git a/api/interfaces/HostRestartPolicy.html b/api/interfaces/HostRestartPolicy.html index e8b2c8b6b6f..893e42ab334 100644 --- a/api/interfaces/HostRestartPolicy.html +++ b/api/interfaces/HostRestartPolicy.html @@ -13,7 +13,7 @@ - + @@ -24,13 +24,13 @@

optional MaximumRetryCount: number

Source​

-

packages/extension-api/src/extension-api.d.ts:2085

+

packages/extension-api/src/extension-api.d.ts:2085


Name​

Name: string

Source​

-

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/interfaces/IPAM.html b/api/interfaces/IPAM.html index ace2787f94f..8352af8d1ff 100644 --- a/api/interfaces/IPAM.html +++ b/api/interfaces/IPAM.html @@ -13,7 +13,7 @@ - + @@ -24,14 +24,14 @@

optional Config: object[]

Source​

-

packages/extension-api/src/extension-api.d.ts:1959

+

packages/extension-api/src/extension-api.d.ts:1959


Driver​

Driver: string

Source​

-

packages/extension-api/src/extension-api.d.ts:1958

+

packages/extension-api/src/extension-api.d.ts:1958


Options?​

@@ -40,6 +40,6 @@

Index signature​

[key: string]: string

Source​

-

packages/extension-api/src/extension-api.d.ts:1960

+

packages/extension-api/src/extension-api.d.ts:1960

\ No newline at end of file diff --git a/api/interfaces/ImageCheck.html b/api/interfaces/ImageCheck.html index 1407f87fd19..c4637c435cd 100644 --- a/api/interfaces/ImageCheck.html +++ b/api/interfaces/ImageCheck.html @@ -13,7 +13,7 @@ - + @@ -26,7 +26,7 @@

full description of the error/recommendation

Source​

-

packages/extension-api/src/extension-api.d.ts:4086

+

packages/extension-api/src/extension-api.d.ts:4086


name​

@@ -34,7 +34,7 @@

a short and descriptive name for the error/recommendation

Source​

-

packages/extension-api/src/extension-api.d.ts:4074

+

packages/extension-api/src/extension-api.d.ts:4074


severity?​

@@ -42,7 +42,7 @@

severity of the error/recommendation, when the status is failed

Source​

-

packages/extension-api/src/extension-api.d.ts:4082

+

packages/extension-api/src/extension-api.d.ts:4082


status​

@@ -50,6 +50,6 @@

either the feedback is positive or negative

Source​

-

packages/extension-api/src/extension-api.d.ts:4078

+

packages/extension-api/src/extension-api.d.ts:4078

\ No newline at end of file diff --git a/api/interfaces/ImageCheckerProvider.html b/api/interfaces/ImageCheckerProvider.html index c407872bc91..896e390d063 100644 --- a/api/interfaces/ImageCheckerProvider.html +++ b/api/interfaces/ImageCheckerProvider.html @@ -13,7 +13,7 @@ - + @@ -33,6 +33,6 @@

ProviderResult< ImageChecks >

the complete result of the analyze, either synchronously of through a Promise

Source​

-

packages/extension-api/src/extension-api.d.ts:4109

+

packages/extension-api/src/extension-api.d.ts:4109

\ No newline at end of file diff --git a/api/interfaces/ImageCheckerProviderMetadata.html b/api/interfaces/ImageCheckerProviderMetadata.html index faf5fbfde11..6611c6795fd 100644 --- a/api/interfaces/ImageCheckerProviderMetadata.html +++ b/api/interfaces/ImageCheckerProviderMetadata.html @@ -13,7 +13,7 @@ - + @@ -24,6 +24,6 @@

readonly label: string

Source​

-

packages/extension-api/src/extension-api.d.ts:4113

+

packages/extension-api/src/extension-api.d.ts:4113

\ No newline at end of file diff --git a/api/interfaces/ImageChecks.html b/api/interfaces/ImageChecks.html index c85d681bd39..64de2bf5447 100644 --- a/api/interfaces/ImageChecks.html +++ b/api/interfaces/ImageChecks.html @@ -13,7 +13,7 @@ - + @@ -26,6 +26,6 @@

the list of errors/recommendations found during the image check

Source​

-

packages/extension-api/src/extension-api.d.ts:4096

+

packages/extension-api/src/extension-api.d.ts:4096

\ No newline at end of file diff --git a/api/interfaces/ImageInfo.html b/api/interfaces/ImageInfo.html index 4eadd1d8685..dd1089833e7 100644 --- a/api/interfaces/ImageInfo.html +++ b/api/interfaces/ImageInfo.html @@ -13,7 +13,7 @@ - + @@ -24,28 +24,28 @@

Containers: number

Source​

-

packages/extension-api/src/extension-api.d.ts:1869

+

packages/extension-api/src/extension-api.d.ts:1869


Created​

Created: number

Source​

-

packages/extension-api/src/extension-api.d.ts:1864

+

packages/extension-api/src/extension-api.d.ts:1864


History?​

optional History: string[]

Source​

-

packages/extension-api/src/extension-api.d.ts:1870

+

packages/extension-api/src/extension-api.d.ts:1870


Id​

Id: string

Source​

-

packages/extension-api/src/extension-api.d.ts:1860

+

packages/extension-api/src/extension-api.d.ts:1860


Labels​

@@ -54,69 +54,69 @@

Index signature​

[label: string]: string

Source​

-

packages/extension-api/src/extension-api.d.ts:1868

+

packages/extension-api/src/extension-api.d.ts:1868


ParentId​

ParentId: string

Source​

-

packages/extension-api/src/extension-api.d.ts:1861

+

packages/extension-api/src/extension-api.d.ts:1861


RepoDigests?​

optional RepoDigests: string[]

Source​

-

packages/extension-api/src/extension-api.d.ts:1863

+

packages/extension-api/src/extension-api.d.ts:1863


RepoTags​

RepoTags: undefined | string[]

Source​

-

packages/extension-api/src/extension-api.d.ts:1862

+

packages/extension-api/src/extension-api.d.ts:1862


SharedSize​

SharedSize: number

Source​

-

packages/extension-api/src/extension-api.d.ts:1867

+

packages/extension-api/src/extension-api.d.ts:1867


Size​

Size: number

Source​

-

packages/extension-api/src/extension-api.d.ts:1865

+

packages/extension-api/src/extension-api.d.ts:1865


VirtualSize​

VirtualSize: number

Source​

-

packages/extension-api/src/extension-api.d.ts:1866

+

packages/extension-api/src/extension-api.d.ts:1866


engineId​

engineId: string

Source​

-

packages/extension-api/src/extension-api.d.ts:1858

+

packages/extension-api/src/extension-api.d.ts:1858


engineName​

engineName: string

Source​

-

packages/extension-api/src/extension-api.d.ts:1859

+

packages/extension-api/src/extension-api.d.ts:1859


isManifest?​

optional isManifest: boolean

Source​

-

packages/extension-api/src/extension-api.d.ts:1873

+

packages/extension-api/src/extension-api.d.ts:1873

\ No newline at end of file diff --git a/api/interfaces/ImageInspectInfo.html b/api/interfaces/ImageInspectInfo.html index e66a2308e14..36d4daa4d3c 100644 --- a/api/interfaces/ImageInspectInfo.html +++ b/api/interfaces/ImageInspectInfo.html @@ -13,7 +13,7 @@ - + @@ -24,21 +24,21 @@

Architecture: string

Source​

-

packages/extension-api/src/extension-api.d.ts:1930

+

packages/extension-api/src/extension-api.d.ts:1930


Author​

Author: string

Source​

-

packages/extension-api/src/extension-api.d.ts:1908

+

packages/extension-api/src/extension-api.d.ts:1908


Comment​

Comment: string

Source​

-

packages/extension-api/src/extension-api.d.ts:1883

+

packages/extension-api/src/extension-api.d.ts:1883


Config​

@@ -127,14 +127,14 @@

WorkingDir: string

Source​

-

packages/extension-api/src/extension-api.d.ts:1909

+

packages/extension-api/src/extension-api.d.ts:1909


Container​

Container: string

Source​

-

packages/extension-api/src/extension-api.d.ts:1885

+

packages/extension-api/src/extension-api.d.ts:1885


ContainerConfig​

@@ -223,21 +223,21 @@

WorkingDir: string

Source​

-

packages/extension-api/src/extension-api.d.ts:1886

+

packages/extension-api/src/extension-api.d.ts:1886


Created​

Created: string

Source​

-

packages/extension-api/src/extension-api.d.ts:1884

+

packages/extension-api/src/extension-api.d.ts:1884


DockerVersion​

DockerVersion: string

Source​

-

packages/extension-api/src/extension-api.d.ts:1907

+

packages/extension-api/src/extension-api.d.ts:1907


GraphDriver​

@@ -264,42 +264,42 @@

Name: string

Source​

-

packages/extension-api/src/extension-api.d.ts:1934

+

packages/extension-api/src/extension-api.d.ts:1934


Id​

Id: string

Source​

-

packages/extension-api/src/extension-api.d.ts:1879

+

packages/extension-api/src/extension-api.d.ts:1879


Os​

Os: string

Source​

-

packages/extension-api/src/extension-api.d.ts:1931

+

packages/extension-api/src/extension-api.d.ts:1931


Parent​

Parent: string

Source​

-

packages/extension-api/src/extension-api.d.ts:1882

+

packages/extension-api/src/extension-api.d.ts:1882


RepoDigests​

RepoDigests: string[]

Source​

-

packages/extension-api/src/extension-api.d.ts:1881

+

packages/extension-api/src/extension-api.d.ts:1881


RepoTags​

RepoTags: string[]

Source​

-

packages/extension-api/src/extension-api.d.ts:1880

+

packages/extension-api/src/extension-api.d.ts:1880


RootFS​

@@ -318,34 +318,34 @@

Type: string

Source​

-

packages/extension-api/src/extension-api.d.ts:1942

+

packages/extension-api/src/extension-api.d.ts:1942


Size​

Size: number

Source​

-

packages/extension-api/src/extension-api.d.ts:1932

+

packages/extension-api/src/extension-api.d.ts:1932


VirtualSize​

VirtualSize: number

Source​

-

packages/extension-api/src/extension-api.d.ts:1933

+

packages/extension-api/src/extension-api.d.ts:1933


engineId​

engineId: string

Source​

-

packages/extension-api/src/extension-api.d.ts:1877

+

packages/extension-api/src/extension-api.d.ts:1877


engineName​

engineName: string

Source​

-

packages/extension-api/src/extension-api.d.ts:1878

+

packages/extension-api/src/extension-api.d.ts:1878

\ No newline at end of file diff --git a/api/interfaces/InputBoxOptions.html b/api/interfaces/InputBoxOptions.html index 578584f71ec..bd003a9829e 100644 --- a/api/interfaces/InputBoxOptions.html +++ b/api/interfaces/InputBoxOptions.html @@ -13,7 +13,7 @@ - + @@ -27,7 +27,7 @@

Set to true to keep the input box open when focus moves to another part of the editor or to another window. This setting is ignored on iPad and is always false.

Source​

-

packages/extension-api/src/extension-api.d.ts:880

+

packages/extension-api/src/extension-api.d.ts:880


markdownDescription?​

@@ -35,7 +35,7 @@ This setting is ignored on iPad and is always false.

A description of the field to be show (Markdown format)

Source​

-

packages/extension-api/src/extension-api.d.ts:864

+

packages/extension-api/src/extension-api.d.ts:864


multiline?​

@@ -43,7 +43,7 @@ This setting is ignored on iPad and is always false.

Set to true when value represents a multi line content.

Source​

-

packages/extension-api/src/extension-api.d.ts:885

+

packages/extension-api/src/extension-api.d.ts:885


password?​

@@ -51,7 +51,7 @@ This setting is ignored on iPad and is always false.

Controls if a password input is shown. Password input hides the typed text.

Source​

-

packages/extension-api/src/extension-api.d.ts:874

+

packages/extension-api/src/extension-api.d.ts:874


placeHolder?​

@@ -59,7 +59,7 @@ This setting is ignored on iPad and is always false.

An optional string to show as placeholder in the input box to guide the user what to type.

Source​

-

packages/extension-api/src/extension-api.d.ts:869

+

packages/extension-api/src/extension-api.d.ts:869


prompt?​

@@ -67,7 +67,7 @@ This setting is ignored on iPad and is always false.

The text to display underneath the input box.

Source​

-

packages/extension-api/src/extension-api.d.ts:859

+

packages/extension-api/src/extension-api.d.ts:859


title?​

@@ -75,7 +75,7 @@ This setting is ignored on iPad and is always false.

An optional string that represents the title of the input box.

Source​

-

packages/extension-api/src/extension-api.d.ts:841

+

packages/extension-api/src/extension-api.d.ts:841


value?​

@@ -83,7 +83,7 @@ This setting is ignored on iPad and is always false.

The value to pre-fill in the input box.

Source​

-

packages/extension-api/src/extension-api.d.ts:846

+

packages/extension-api/src/extension-api.d.ts:846


valueSelection?​

@@ -94,7 +94,7 @@ first is the inclusive start index and the second the exclusive end index. When pre-filled value will be selected, when empty (start equals end) only the cursor will be set, otherwise the defined range will be selected.

Source​

-

packages/extension-api/src/extension-api.d.ts:854

+

packages/extension-api/src/extension-api.d.ts:854

Methods​

validateInput()?​

@@ -110,6 +110,6 @@ to the user.

Either a human-readable string which is presented as an error message or an InputBoxValidationMessage which can provide a specific message severity. Return undefined, null, or the empty string when 'value' is valid.

Source​

-

packages/extension-api/src/extension-api.d.ts:895

+

packages/extension-api/src/extension-api.d.ts:895

\ No newline at end of file diff --git a/api/interfaces/InputBoxValidationMessage.html b/api/interfaces/InputBoxValidationMessage.html index 664a3520e5f..146a49551f5 100644 --- a/api/interfaces/InputBoxValidationMessage.html +++ b/api/interfaces/InputBoxValidationMessage.html @@ -13,7 +13,7 @@ - + @@ -26,7 +26,7 @@

The validation message to display.

Source​

-

packages/extension-api/src/extension-api.d.ts:824

+

packages/extension-api/src/extension-api.d.ts:824


severity​

@@ -36,6 +36,6 @@ NOTE: When using InputBoxValidationSeverity.Error, the user will not be allowed to accept (hit ENTER) the input. Info and Warning will still allow the InputBox to accept the input.

Source​

-

packages/extension-api/src/extension-api.d.ts:831

+

packages/extension-api/src/extension-api.d.ts:831

\ No newline at end of file diff --git a/api/interfaces/InstallCheck.html b/api/interfaces/InstallCheck.html index dcfbfbc8f06..1bf27c9f3ed 100644 --- a/api/interfaces/InstallCheck.html +++ b/api/interfaces/InstallCheck.html @@ -13,7 +13,7 @@ - + @@ -24,7 +24,7 @@

title: string

Source​

-

packages/extension-api/src/extension-api.d.ts:371

+

packages/extension-api/src/extension-api.d.ts:371

Methods​

execute()​

@@ -33,7 +33,7 @@

Returns​

Promise< CheckResult >

Source​

-

packages/extension-api/src/extension-api.d.ts:372

+

packages/extension-api/src/extension-api.d.ts:372


init()?​

@@ -42,6 +42,6 @@

Returns​

Promise< void >

Source​

-

packages/extension-api/src/extension-api.d.ts:373

+

packages/extension-api/src/extension-api.d.ts:373

\ No newline at end of file diff --git a/api/interfaces/KubeconfigUpdateEvent.html b/api/interfaces/KubeconfigUpdateEvent.html index 48510a59576..d1d6630ebad 100644 --- a/api/interfaces/KubeconfigUpdateEvent.html +++ b/api/interfaces/KubeconfigUpdateEvent.html @@ -13,7 +13,7 @@ - + @@ -25,13 +25,13 @@

readonly location: Uri

Source​

-

packages/extension-api/src/extension-api.d.ts:1826

+

packages/extension-api/src/extension-api.d.ts:1826


type​

readonly type: "CREATE" | "UPDATE" | "DELETE"

Source​

-

packages/extension-api/src/extension-api.d.ts:1825

+

packages/extension-api/src/extension-api.d.ts:1825

\ No newline at end of file diff --git a/api/interfaces/KubernetesGeneratorProvider.html b/api/interfaces/KubernetesGeneratorProvider.html index c006b72562f..179f26842c0 100644 --- a/api/interfaces/KubernetesGeneratorProvider.html +++ b/api/interfaces/KubernetesGeneratorProvider.html @@ -13,7 +13,7 @@ - + @@ -26,14 +26,14 @@ KubernetesGeneratorType.

name: string

Source​

-

packages/extension-api/src/extension-api.d.ts:1852

+

packages/extension-api/src/extension-api.d.ts:1852


types​

types: KubernetesGeneratorSelector

Source​

-

packages/extension-api/src/extension-api.d.ts:1853

+

packages/extension-api/src/extension-api.d.ts:1853

Methods​

generate()​

@@ -44,6 +44,6 @@ KubernetesGeneratorType.

Returns​

Promise< GenerateKubeResult >

Source​

-

packages/extension-api/src/extension-api.d.ts:1854

+

packages/extension-api/src/extension-api.d.ts:1854

\ No newline at end of file diff --git a/api/interfaces/KubernetesProviderConnection.html b/api/interfaces/KubernetesProviderConnection.html index aab652acca6..a0aa7ccbd41 100644 --- a/api/interfaces/KubernetesProviderConnection.html +++ b/api/interfaces/KubernetesProviderConnection.html @@ -13,7 +13,7 @@ - + @@ -24,21 +24,21 @@

endpoint: KubernetesProviderConnectionEndpoint

Source​

-

packages/extension-api/src/extension-api.d.ts:303

+

packages/extension-api/src/extension-api.d.ts:303


lifecycle?​

optional lifecycle: ProviderConnectionLifecycle

Source​

-

packages/extension-api/src/extension-api.d.ts:304

+

packages/extension-api/src/extension-api.d.ts:304


name​

name: string

Source​

-

packages/extension-api/src/extension-api.d.ts:302

+

packages/extension-api/src/extension-api.d.ts:302

Methods​

status()​

@@ -47,6 +47,6 @@

Returns​

ProviderConnectionStatus

Source​

-

packages/extension-api/src/extension-api.d.ts:305

+

packages/extension-api/src/extension-api.d.ts:305

\ No newline at end of file diff --git a/api/interfaces/KubernetesProviderConnectionEndpoint.html b/api/interfaces/KubernetesProviderConnectionEndpoint.html index 5b1c9258849..9c9b47b35aa 100644 --- a/api/interfaces/KubernetesProviderConnectionEndpoint.html +++ b/api/interfaces/KubernetesProviderConnectionEndpoint.html @@ -13,7 +13,7 @@ - + @@ -24,6 +24,6 @@

apiURL: string

Source​

-

packages/extension-api/src/extension-api.d.ts:299

+

packages/extension-api/src/extension-api.d.ts:299

\ No newline at end of file diff --git a/api/interfaces/KubernetesProviderConnectionFactory.html b/api/interfaces/KubernetesProviderConnectionFactory.html index c00476c859a..1f1891de11f 100644 --- a/api/interfaces/KubernetesProviderConnectionFactory.html +++ b/api/interfaces/KubernetesProviderConnectionFactory.html @@ -13,7 +13,7 @@ - + @@ -30,7 +30,7 @@

Inherited from​

ProviderConnectionFactory.creationButtonTitle

Source​

-

packages/extension-api/src/extension-api.d.ts:317

+

packages/extension-api/src/extension-api.d.ts:317


creationDisplayName?​

@@ -39,7 +39,7 @@

Inherited from​

ProviderConnectionFactory.creationDisplayName

Source​

-

packages/extension-api/src/extension-api.d.ts:314

+

packages/extension-api/src/extension-api.d.ts:314

Methods​

create()?​

@@ -52,7 +52,7 @@

Returns​

Promise< void >

Source​

-

packages/extension-api/src/extension-api.d.ts:329

+

packages/extension-api/src/extension-api.d.ts:329


initialize()?​

@@ -63,6 +63,6 @@

Inherited from​

ProviderConnectionFactory.initialize

Source​

-

packages/extension-api/src/extension-api.d.ts:311

+

packages/extension-api/src/extension-api.d.ts:311

\ No newline at end of file diff --git a/api/interfaces/LifecycleContext.html b/api/interfaces/LifecycleContext.html index 8854e5013ef..d25ca9aabcc 100644 --- a/api/interfaces/LifecycleContext.html +++ b/api/interfaces/LifecycleContext.html @@ -13,7 +13,7 @@ - + @@ -24,6 +24,6 @@

log: Logger

Source​

-

packages/extension-api/src/extension-api.d.ts:244

+

packages/extension-api/src/extension-api.d.ts:244

\ No newline at end of file diff --git a/api/interfaces/Link.html b/api/interfaces/Link.html index 28fc5bef8fd..780ea2dfd4c 100644 --- a/api/interfaces/Link.html +++ b/api/interfaces/Link.html @@ -13,7 +13,7 @@ - + @@ -24,20 +24,20 @@

optional group: string

Source​

-

packages/extension-api/src/extension-api.d.ts:353

+

packages/extension-api/src/extension-api.d.ts:353


title​

title: string

Source​

-

packages/extension-api/src/extension-api.d.ts:351

+

packages/extension-api/src/extension-api.d.ts:351


url​

url: string

Source​

-

packages/extension-api/src/extension-api.d.ts:352

+

packages/extension-api/src/extension-api.d.ts:352

\ No newline at end of file diff --git a/api/interfaces/ListImagesOptions.html b/api/interfaces/ListImagesOptions.html index 2160d42d61d..864ad4948bc 100644 --- a/api/interfaces/ListImagesOptions.html +++ b/api/interfaces/ListImagesOptions.html @@ -13,7 +13,7 @@ - + @@ -27,6 +27,6 @@

Default Value​

undefined

Source​

-

packages/extension-api/src/extension-api.d.ts:3042

+

packages/extension-api/src/extension-api.d.ts:3042

\ No newline at end of file diff --git a/api/interfaces/ListInfosOptions.html b/api/interfaces/ListInfosOptions.html index 0e067e43841..b5326e06b4e 100644 --- a/api/interfaces/ListInfosOptions.html +++ b/api/interfaces/ListInfosOptions.html @@ -13,7 +13,7 @@ - + @@ -27,6 +27,6 @@

Default Value​

undefined

Source​

-

packages/extension-api/src/extension-api.d.ts:3146

+

packages/extension-api/src/extension-api.d.ts:3146

\ No newline at end of file diff --git a/api/interfaces/Logger.html b/api/interfaces/Logger.html index 0fff4b8ec23..202de8e68bb 100644 --- a/api/interfaces/Logger.html +++ b/api/interfaces/Logger.html @@ -13,7 +13,7 @@ - + @@ -28,7 +28,7 @@

Returns​

void

Source​

-

packages/extension-api/src/extension-api.d.ts:238

+

packages/extension-api/src/extension-api.d.ts:238


log()​

@@ -39,7 +39,7 @@

Returns​

void

Source​

-

packages/extension-api/src/extension-api.d.ts:236

+

packages/extension-api/src/extension-api.d.ts:236


warn()​

@@ -50,6 +50,6 @@

Returns​

void

Source​

-

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/interfaces/ManifestCreateOptions.html b/api/interfaces/ManifestCreateOptions.html index 53c0a2c7c7a..1aa23adca63 100644 --- a/api/interfaces/ManifestCreateOptions.html +++ b/api/interfaces/ManifestCreateOptions.html @@ -13,7 +13,7 @@ - + @@ -24,34 +24,34 @@

optional all: boolean

Source​

-

packages/extension-api/src/extension-api.d.ts:292

+

packages/extension-api/src/extension-api.d.ts:292


amend?​

optional amend: boolean

Source​

-

packages/extension-api/src/extension-api.d.ts:291

+

packages/extension-api/src/extension-api.d.ts:291


images​

images: string[]

Source​

-

packages/extension-api/src/extension-api.d.ts:289

+

packages/extension-api/src/extension-api.d.ts:289


name​

name: string

Source​

-

packages/extension-api/src/extension-api.d.ts:290

+

packages/extension-api/src/extension-api.d.ts:290


provider?​

optional provider: ContainerProviderConnection

Source​

-

packages/extension-api/src/extension-api.d.ts:295

+

packages/extension-api/src/extension-api.d.ts:295

\ No newline at end of file diff --git a/api/interfaces/MemoryStats.html b/api/interfaces/MemoryStats.html index dc197b31e2d..50bf0576f11 100644 --- a/api/interfaces/MemoryStats.html +++ b/api/interfaces/MemoryStats.html @@ -13,7 +13,7 @@ - + @@ -24,42 +24,42 @@

optional commitbytes: number

Source​

-

packages/extension-api/src/extension-api.d.ts:2842

+

packages/extension-api/src/extension-api.d.ts:2842


commitpeakbytes?​

optional commitpeakbytes: number

Source​

-

packages/extension-api/src/extension-api.d.ts:2843

+

packages/extension-api/src/extension-api.d.ts:2843


failcnt​

failcnt: number

Source​

-

packages/extension-api/src/extension-api.d.ts:2838

+

packages/extension-api/src/extension-api.d.ts:2838


limit​

limit: number

Source​

-

packages/extension-api/src/extension-api.d.ts:2839

+

packages/extension-api/src/extension-api.d.ts:2839


max_usage​

max_usage: number

Source​

-

packages/extension-api/src/extension-api.d.ts:2836

+

packages/extension-api/src/extension-api.d.ts:2836


privateworkingset?​

optional privateworkingset: number

Source​

-

packages/extension-api/src/extension-api.d.ts:2844

+

packages/extension-api/src/extension-api.d.ts:2844


stats​

@@ -182,13 +182,13 @@

writeback: number

Source​

-

packages/extension-api/src/extension-api.d.ts:2805

+

packages/extension-api/src/extension-api.d.ts:2805


usage​

usage: number

Source​

-

packages/extension-api/src/extension-api.d.ts:2837

+

packages/extension-api/src/extension-api.d.ts:2837

\ No newline at end of file diff --git a/api/interfaces/MenuItem.html b/api/interfaces/MenuItem.html index abd5ea2d3ba..fa336927d8d 100644 --- a/api/interfaces/MenuItem.html +++ b/api/interfaces/MenuItem.html @@ -13,7 +13,7 @@ - + @@ -25,7 +25,7 @@

Should only be specified for checkbox or radio type menu items.

Source​

-

packages/extension-api/src/extension-api.d.ts:60

+

packages/extension-api/src/extension-api.d.ts:60


enabled?​

@@ -33,14 +33,14 @@

If false, the menu item will be greyed out and unclickable.

Source​

-

packages/extension-api/src/extension-api.d.ts:52

+

packages/extension-api/src/extension-api.d.ts:52


icon?​

optional icon: string

Source​

-

packages/extension-api/src/extension-api.d.ts:48

+

packages/extension-api/src/extension-api.d.ts:48


id​

@@ -48,28 +48,28 @@

Unique within a single menu. Should be same as commandId for handler

Source​

-

packages/extension-api/src/extension-api.d.ts:43

+

packages/extension-api/src/extension-api.d.ts:43


label?​

optional label: string

Source​

-

packages/extension-api/src/extension-api.d.ts:46

+

packages/extension-api/src/extension-api.d.ts:46


optional submenu: MenuItem[]

Source​

-

packages/extension-api/src/extension-api.d.ts:62

+

packages/extension-api/src/extension-api.d.ts:62


type?​

optional type: "normal" | "separator" | "submenu" | "checkbox" | "radio"

Source​

-

packages/extension-api/src/extension-api.d.ts:45

+

packages/extension-api/src/extension-api.d.ts:45


visible?​

@@ -77,6 +77,6 @@

If false, the menu item will be entirely hidden.

Source​

-

packages/extension-api/src/extension-api.d.ts:56

+

packages/extension-api/src/extension-api.d.ts:56

\ No newline at end of file diff --git a/api/interfaces/MountSettings.html b/api/interfaces/MountSettings.html index 9f9068e97aa..d816455aaca 100644 --- a/api/interfaces/MountSettings.html +++ b/api/interfaces/MountSettings.html @@ -13,7 +13,7 @@ - + @@ -28,42 +28,42 @@

Propagation: MountPropagation

Source​

-

packages/extension-api/src/extension-api.d.ts:2101

+

packages/extension-api/src/extension-api.d.ts:2101


Consistency?​

optional Consistency: MountConsistency

Source​

-

packages/extension-api/src/extension-api.d.ts:2099

+

packages/extension-api/src/extension-api.d.ts:2099


Mode?​

optional Mode: string

Source​

-

packages/extension-api/src/extension-api.d.ts:2100

+

packages/extension-api/src/extension-api.d.ts:2100


ReadOnly?​

optional ReadOnly: boolean

Source​

-

packages/extension-api/src/extension-api.d.ts:2098

+

packages/extension-api/src/extension-api.d.ts:2098


Source​

Source: string

Source​

-

packages/extension-api/src/extension-api.d.ts:2096

+

packages/extension-api/src/extension-api.d.ts:2096


Target​

Target: string

Source​

-

packages/extension-api/src/extension-api.d.ts:2095

+

packages/extension-api/src/extension-api.d.ts:2095


TmpfsOptions?​

@@ -78,14 +78,14 @@

SizeBytes: number

Source​

-

packages/extension-api/src/extension-api.d.ts:2112

+

packages/extension-api/src/extension-api.d.ts:2112


Type​

Type: MountType

Source​

-

packages/extension-api/src/extension-api.d.ts:2097

+

packages/extension-api/src/extension-api.d.ts:2097


VolumeOptions?​

@@ -116,6 +116,6 @@

NoCopy: boolean

Source​

-

packages/extension-api/src/extension-api.d.ts:2104

+

packages/extension-api/src/extension-api.d.ts:2104

\ No newline at end of file diff --git a/api/interfaces/NetworkContainer.html b/api/interfaces/NetworkContainer.html index 792ae22e861..353c0f7f16a 100644 --- a/api/interfaces/NetworkContainer.html +++ b/api/interfaces/NetworkContainer.html @@ -13,7 +13,7 @@ - + @@ -24,34 +24,34 @@

EndpointID: string

Source​

-

packages/extension-api/src/extension-api.d.ts:1951

+

packages/extension-api/src/extension-api.d.ts:1951


IPv4Address​

IPv4Address: string

Source​

-

packages/extension-api/src/extension-api.d.ts:1953

+

packages/extension-api/src/extension-api.d.ts:1953


IPv6Address​

IPv6Address: string

Source​

-

packages/extension-api/src/extension-api.d.ts:1954

+

packages/extension-api/src/extension-api.d.ts:1954


MacAddress​

MacAddress: string

Source​

-

packages/extension-api/src/extension-api.d.ts:1952

+

packages/extension-api/src/extension-api.d.ts:1952


Name​

Name: string

Source​

-

packages/extension-api/src/extension-api.d.ts:1950

+

packages/extension-api/src/extension-api.d.ts:1950

\ No newline at end of file diff --git a/api/interfaces/NetworkCreateOptions.html b/api/interfaces/NetworkCreateOptions.html index 8b99854ad18..fdb94499fb2 100644 --- a/api/interfaces/NetworkCreateOptions.html +++ b/api/interfaces/NetworkCreateOptions.html @@ -13,7 +13,7 @@ - + @@ -24,6 +24,6 @@

Name: string

Source​

-

packages/extension-api/src/extension-api.d.ts:3046

+

packages/extension-api/src/extension-api.d.ts:3046

\ No newline at end of file diff --git a/api/interfaces/NetworkCreateResult.html b/api/interfaces/NetworkCreateResult.html index 1e0a3eb2f8b..f4bced7f2f8 100644 --- a/api/interfaces/NetworkCreateResult.html +++ b/api/interfaces/NetworkCreateResult.html @@ -13,7 +13,7 @@ - + @@ -24,6 +24,6 @@

Id: string

Source​

-

packages/extension-api/src/extension-api.d.ts:3050

+

packages/extension-api/src/extension-api.d.ts:3050

\ No newline at end of file diff --git a/api/interfaces/NetworkInfo.html b/api/interfaces/NetworkInfo.html index 5b15b390bed..d9a0ef044f4 100644 --- a/api/interfaces/NetworkInfo.html +++ b/api/interfaces/NetworkInfo.html @@ -13,7 +13,7 @@ - + @@ -24,83 +24,83 @@

optional Aliases: unknown

Source​

-

packages/extension-api/src/extension-api.d.ts:2026

+

packages/extension-api/src/extension-api.d.ts:2026


EndpointID​

EndpointID: string

Source​

-

packages/extension-api/src/extension-api.d.ts:2028

+

packages/extension-api/src/extension-api.d.ts:2028


Gateway​

Gateway: string

Source​

-

packages/extension-api/src/extension-api.d.ts:2029

+

packages/extension-api/src/extension-api.d.ts:2029


GlobalIPv6Address​

GlobalIPv6Address: string

Source​

-

packages/extension-api/src/extension-api.d.ts:2033

+

packages/extension-api/src/extension-api.d.ts:2033


GlobalIPv6PrefixLen​

GlobalIPv6PrefixLen: number

Source​

-

packages/extension-api/src/extension-api.d.ts:2034

+

packages/extension-api/src/extension-api.d.ts:2034


IPAMConfig?​

optional IPAMConfig: unknown

Source​

-

packages/extension-api/src/extension-api.d.ts:2024

+

packages/extension-api/src/extension-api.d.ts:2024


IPAddress​

IPAddress: string

Source​

-

packages/extension-api/src/extension-api.d.ts:2030

+

packages/extension-api/src/extension-api.d.ts:2030


IPPrefixLen​

IPPrefixLen: number

Source​

-

packages/extension-api/src/extension-api.d.ts:2031

+

packages/extension-api/src/extension-api.d.ts:2031


IPv6Gateway​

IPv6Gateway: string

Source​

-

packages/extension-api/src/extension-api.d.ts:2032

+

packages/extension-api/src/extension-api.d.ts:2032


optional Links: unknown

Source​

-

packages/extension-api/src/extension-api.d.ts:2025

+

packages/extension-api/src/extension-api.d.ts:2025


MacAddress​

MacAddress: string

Source​

-

packages/extension-api/src/extension-api.d.ts:2035

+

packages/extension-api/src/extension-api.d.ts:2035


NetworkID​

NetworkID: string

Source​

-

packages/extension-api/src/extension-api.d.ts:2027

+

packages/extension-api/src/extension-api.d.ts:2027

\ No newline at end of file diff --git a/api/interfaces/NetworkInspectInfo.html b/api/interfaces/NetworkInspectInfo.html index 8ac53efb85d..7fd12d423c2 100644 --- a/api/interfaces/NetworkInspectInfo.html +++ b/api/interfaces/NetworkInspectInfo.html @@ -13,7 +13,7 @@ - + @@ -24,7 +24,7 @@

Attachable: boolean

Source​

-

packages/extension-api/src/extension-api.d.ts:1975

+

packages/extension-api/src/extension-api.d.ts:1975


ConfigFrom?​

@@ -35,14 +35,14 @@

Network: string

Source​

-

packages/extension-api/src/extension-api.d.ts:1977

+

packages/extension-api/src/extension-api.d.ts:1977


ConfigOnly​

ConfigOnly: boolean

Source​

-

packages/extension-api/src/extension-api.d.ts:1978

+

packages/extension-api/src/extension-api.d.ts:1978


Containers?​

@@ -51,56 +51,56 @@

Index signature​

[id: string]: NetworkContainer

Source​

-

packages/extension-api/src/extension-api.d.ts:1979

+

packages/extension-api/src/extension-api.d.ts:1979


Created​

Created: string

Source​

-

packages/extension-api/src/extension-api.d.ts:1969

+

packages/extension-api/src/extension-api.d.ts:1969


Driver​

Driver: string

Source​

-

packages/extension-api/src/extension-api.d.ts:1971

+

packages/extension-api/src/extension-api.d.ts:1971


EnableIPv6​

EnableIPv6: boolean

Source​

-

packages/extension-api/src/extension-api.d.ts:1972

+

packages/extension-api/src/extension-api.d.ts:1972


IPAM?​

optional IPAM: IPAM

Source​

-

packages/extension-api/src/extension-api.d.ts:1973

+

packages/extension-api/src/extension-api.d.ts:1973


Id​

Id: string

Source​

-

packages/extension-api/src/extension-api.d.ts:1968

+

packages/extension-api/src/extension-api.d.ts:1968


Ingress​

Ingress: boolean

Source​

-

packages/extension-api/src/extension-api.d.ts:1976

+

packages/extension-api/src/extension-api.d.ts:1976


Internal​

Internal: boolean

Source​

-

packages/extension-api/src/extension-api.d.ts:1974

+

packages/extension-api/src/extension-api.d.ts:1974


Labels?​

@@ -109,14 +109,14 @@

Index signature​

[key: string]: string

Source​

-

packages/extension-api/src/extension-api.d.ts:1981

+

packages/extension-api/src/extension-api.d.ts:1981


Name​

Name: string

Source​

-

packages/extension-api/src/extension-api.d.ts:1967

+

packages/extension-api/src/extension-api.d.ts:1967


Options?​

@@ -125,34 +125,34 @@

Index signature​

[key: string]: string

Source​

-

packages/extension-api/src/extension-api.d.ts:1980

+

packages/extension-api/src/extension-api.d.ts:1980


Scope​

Scope: string

Source​

-

packages/extension-api/src/extension-api.d.ts:1970

+

packages/extension-api/src/extension-api.d.ts:1970


engineId​

engineId: string

Source​

-

packages/extension-api/src/extension-api.d.ts:1964

+

packages/extension-api/src/extension-api.d.ts:1964


engineName​

engineName: string

Source​

-

packages/extension-api/src/extension-api.d.ts:1965

+

packages/extension-api/src/extension-api.d.ts:1965


engineType​

engineType: "docker" | "podman"

Source​

-

packages/extension-api/src/extension-api.d.ts:1966

+

packages/extension-api/src/extension-api.d.ts:1966

\ No newline at end of file diff --git a/api/interfaces/NetworkStats.html b/api/interfaces/NetworkStats.html index c27b6252de5..8bca0dcf8f8 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 a407b7cad84..5368c06668a 100644 --- a/api/interfaces/NetworkingConfig.html +++ b/api/interfaces/NetworkingConfig.html @@ -13,7 +13,7 @@ - + @@ -26,6 +26,6 @@

Index signature​

[key: string]: EndpointSettings

Source​

-

packages/extension-api/src/extension-api.d.ts:2535

+

packages/extension-api/src/extension-api.d.ts:2535

\ No newline at end of file diff --git a/api/interfaces/NotificationOptions.html b/api/interfaces/NotificationOptions.html index 67475d00dd0..3541382864d 100644 --- a/api/interfaces/NotificationOptions.html +++ b/api/interfaces/NotificationOptions.html @@ -13,7 +13,7 @@ - + @@ -25,7 +25,7 @@

The body text of the notification, which will be displayed below the title.

Source​

-

packages/extension-api/src/extension-api.d.ts:1160

+

packages/extension-api/src/extension-api.d.ts:1160


highlight?​

@@ -33,7 +33,7 @@

this notification will be highlighted to the user so it draws attention

Source​

-

packages/extension-api/src/extension-api.d.ts:1176

+

packages/extension-api/src/extension-api.d.ts:1176


markdownActions?​

@@ -41,7 +41,7 @@

displayed below the description. It contains actions (like markdown commands/buttons and links)

Source​

-

packages/extension-api/src/extension-api.d.ts:1172

+

packages/extension-api/src/extension-api.d.ts:1172


silent?​

@@ -49,7 +49,7 @@

Whether or not to emit an OS notification noise when showing the notification.

Source​

-

packages/extension-api/src/extension-api.d.ts:1164

+

packages/extension-api/src/extension-api.d.ts:1164


title?​

@@ -57,7 +57,7 @@

A title for the notification, which will be shown at the top of the notification window when it is shown.

Source​

-

packages/extension-api/src/extension-api.d.ts:1156

+

packages/extension-api/src/extension-api.d.ts:1156


type?​

@@ -65,6 +65,6 @@

The type of the notification. Default value: info

Source​

-

packages/extension-api/src/extension-api.d.ts:1168

+

packages/extension-api/src/extension-api.d.ts:1168

\ No newline at end of file diff --git a/api/interfaces/OpenDialogOptions.html b/api/interfaces/OpenDialogOptions.html index a8ddae9c154..1f64273e689 100644 --- a/api/interfaces/OpenDialogOptions.html +++ b/api/interfaces/OpenDialogOptions.html @@ -13,7 +13,7 @@ - + @@ -26,7 +26,7 @@

The resource the dialog shows when opened.

Source​

-

packages/extension-api/src/extension-api.d.ts:1518

+

packages/extension-api/src/extension-api.d.ts:1518


filters?​

@@ -34,7 +34,7 @@

A set of file filters that are used by the dialog.

Source​

-

packages/extension-api/src/extension-api.d.ts:1534

+

packages/extension-api/src/extension-api.d.ts:1534


openLabel?​

@@ -42,7 +42,7 @@

A human-readable string for the open button.

Source​

-

packages/extension-api/src/extension-api.d.ts:1523

+

packages/extension-api/src/extension-api.d.ts:1523


selectors?​

@@ -51,7 +51,7 @@

Contains which features the dialog should use. The following values are supported:

Source​

-

packages/extension-api/src/extension-api.d.ts:1529

+

packages/extension-api/src/extension-api.d.ts:1529


title?​

@@ -59,6 +59,6 @@ supported:

Dialog title.

Source​

-

packages/extension-api/src/extension-api.d.ts:1542

+

packages/extension-api/src/extension-api.d.ts:1542

\ No newline at end of file diff --git a/api/interfaces/PidsStats.html b/api/interfaces/PidsStats.html index d1c882cf151..1e380454cc2 100644 --- a/api/interfaces/PidsStats.html +++ b/api/interfaces/PidsStats.html @@ -13,7 +13,7 @@ - + @@ -24,13 +24,13 @@

optional current: number

Source​

-

packages/extension-api/src/extension-api.d.ts:2759

+

packages/extension-api/src/extension-api.d.ts:2759


limit?​

optional limit: number

Source​

-

packages/extension-api/src/extension-api.d.ts:2760

+

packages/extension-api/src/extension-api.d.ts:2760

\ No newline at end of file diff --git a/api/interfaces/PodContainerInfo.html b/api/interfaces/PodContainerInfo.html index bd4f87ca0f3..162fe36a6cc 100644 --- a/api/interfaces/PodContainerInfo.html +++ b/api/interfaces/PodContainerInfo.html @@ -13,7 +13,7 @@ - + @@ -24,20 +24,20 @@

Id: string

Source​

-

packages/extension-api/src/extension-api.d.ts:2039

+

packages/extension-api/src/extension-api.d.ts:2039


Names​

Names: string

Source​

-

packages/extension-api/src/extension-api.d.ts:2040

+

packages/extension-api/src/extension-api.d.ts:2040


Status​

Status: string

Source​

-

packages/extension-api/src/extension-api.d.ts:2041

+

packages/extension-api/src/extension-api.d.ts:2041

\ No newline at end of file diff --git a/api/interfaces/PodCreateOptions.html b/api/interfaces/PodCreateOptions.html index 1d109618166..942d0811016 100644 --- a/api/interfaces/PodCreateOptions.html +++ b/api/interfaces/PodCreateOptions.html @@ -13,7 +13,7 @@ - + @@ -26,27 +26,27 @@

Index signature​

[key: string]: string

Source​

-

packages/extension-api/src/extension-api.d.ts:283

+

packages/extension-api/src/extension-api.d.ts:283


name​

name: string

Source​

-

packages/extension-api/src/extension-api.d.ts:281

+

packages/extension-api/src/extension-api.d.ts:281


portmappings?​

optional portmappings: PodCreatePortOptions[]

Source​

-

packages/extension-api/src/extension-api.d.ts:282

+

packages/extension-api/src/extension-api.d.ts:282


provider?​

optional provider: ContainerProviderConnection

Source​

-

packages/extension-api/src/extension-api.d.ts:285

+

packages/extension-api/src/extension-api.d.ts:285

\ No newline at end of file diff --git a/api/interfaces/PodCreatePortOptions.html b/api/interfaces/PodCreatePortOptions.html index 9c8746a1f05..533e00a36ba 100644 --- a/api/interfaces/PodCreatePortOptions.html +++ b/api/interfaces/PodCreatePortOptions.html @@ -13,7 +13,7 @@ - + @@ -24,34 +24,34 @@

container_port: number

Source​

-

packages/extension-api/src/extension-api.d.ts:274

+

packages/extension-api/src/extension-api.d.ts:274


host_ip​

host_ip: string

Source​

-

packages/extension-api/src/extension-api.d.ts:273

+

packages/extension-api/src/extension-api.d.ts:273


host_port​

host_port: number

Source​

-

packages/extension-api/src/extension-api.d.ts:275

+

packages/extension-api/src/extension-api.d.ts:275


protocol​

protocol: string

Source​

-

packages/extension-api/src/extension-api.d.ts:276

+

packages/extension-api/src/extension-api.d.ts:276


range​

range: number

Source​

-

packages/extension-api/src/extension-api.d.ts:277

+

packages/extension-api/src/extension-api.d.ts:277

\ No newline at end of file diff --git a/api/interfaces/PodInfo.html b/api/interfaces/PodInfo.html index dc8d1480e76..635499198b6 100644 --- a/api/interfaces/PodInfo.html +++ b/api/interfaces/PodInfo.html @@ -13,7 +13,7 @@ - + @@ -24,35 +24,35 @@

Cgroup: string

Source​

-

packages/extension-api/src/extension-api.d.ts:2048

+

packages/extension-api/src/extension-api.d.ts:2048


Containers​

Containers: PodContainerInfo[]

Source​

-

packages/extension-api/src/extension-api.d.ts:2049

+

packages/extension-api/src/extension-api.d.ts:2049


Created​

Created: string

Source​

-

packages/extension-api/src/extension-api.d.ts:2050

+

packages/extension-api/src/extension-api.d.ts:2050


Id​

Id: string

Source​

-

packages/extension-api/src/extension-api.d.ts:2051

+

packages/extension-api/src/extension-api.d.ts:2051


InfraId​

InfraId: string

Source​

-

packages/extension-api/src/extension-api.d.ts:2052

+

packages/extension-api/src/extension-api.d.ts:2052


Labels​

@@ -61,55 +61,55 @@

Index signature​

[key: string]: string

Source​

-

packages/extension-api/src/extension-api.d.ts:2053

+

packages/extension-api/src/extension-api.d.ts:2053


Name​

Name: string

Source​

-

packages/extension-api/src/extension-api.d.ts:2054

+

packages/extension-api/src/extension-api.d.ts:2054


Namespace​

Namespace: string

Source​

-

packages/extension-api/src/extension-api.d.ts:2055

+

packages/extension-api/src/extension-api.d.ts:2055


Networks​

Networks: string[]

Source​

-

packages/extension-api/src/extension-api.d.ts:2056

+

packages/extension-api/src/extension-api.d.ts:2056


Status​

Status: string

Source​

-

packages/extension-api/src/extension-api.d.ts:2057

+

packages/extension-api/src/extension-api.d.ts:2057


engineId​

engineId: string

Source​

-

packages/extension-api/src/extension-api.d.ts:2045

+

packages/extension-api/src/extension-api.d.ts:2045


engineName​

engineName: string

Source​

-

packages/extension-api/src/extension-api.d.ts:2046

+

packages/extension-api/src/extension-api.d.ts:2046


kind​

kind: "podman" | "kubernetes"

Source​

-

packages/extension-api/src/extension-api.d.ts:2047

+

packages/extension-api/src/extension-api.d.ts:2047

\ No newline at end of file diff --git a/api/interfaces/PodmanContainerCreateOptions.html b/api/interfaces/PodmanContainerCreateOptions.html index 650284c9ed1..0293e299d61 100644 --- a/api/interfaces/PodmanContainerCreateOptions.html +++ b/api/interfaces/PodmanContainerCreateOptions.html @@ -13,7 +13,7 @@ - + @@ -24,14 +24,14 @@

optional command: string[]

Source​

-

packages/extension-api/src/extension-api.d.ts:2539

+

packages/extension-api/src/extension-api.d.ts:2539


entrypoint?​

optional entrypoint: string | string[]

Source​

-

packages/extension-api/src/extension-api.d.ts:2540

+

packages/extension-api/src/extension-api.d.ts:2540


env?​

@@ -40,41 +40,41 @@

Index signature​

[key: string]: string

Source​

-

packages/extension-api/src/extension-api.d.ts:2541

+

packages/extension-api/src/extension-api.d.ts:2541


hostname?​

optional hostname: string

Source​

-

packages/extension-api/src/extension-api.d.ts:2543

+

packages/extension-api/src/extension-api.d.ts:2543


image?​

optional image: string

Source​

-

packages/extension-api/src/extension-api.d.ts:2544

+

packages/extension-api/src/extension-api.d.ts:2544


mounts?​

optional mounts: object[]

Source​

-

packages/extension-api/src/extension-api.d.ts:2546

+

packages/extension-api/src/extension-api.d.ts:2546


name?​

optional name: string

Source​

-

packages/extension-api/src/extension-api.d.ts:2545

+

packages/extension-api/src/extension-api.d.ts:2545


pod?​

optional pod: string

Source​

-

packages/extension-api/src/extension-api.d.ts:2542

+

packages/extension-api/src/extension-api.d.ts:2542

\ No newline at end of file diff --git a/api/interfaces/Port.html b/api/interfaces/Port.html index 9db89a7d030..38dffaf6d90 100644 --- a/api/interfaces/Port.html +++ b/api/interfaces/Port.html @@ -13,7 +13,7 @@ - + @@ -24,27 +24,27 @@

IP: string

Source​

-

packages/extension-api/src/extension-api.d.ts:2017

+

packages/extension-api/src/extension-api.d.ts:2017


PrivatePort​

PrivatePort: number

Source​

-

packages/extension-api/src/extension-api.d.ts:2018

+

packages/extension-api/src/extension-api.d.ts:2018


PublicPort​

PublicPort: number

Source​

-

packages/extension-api/src/extension-api.d.ts:2019

+

packages/extension-api/src/extension-api.d.ts:2019


Type​

Type: string

Source​

-

packages/extension-api/src/extension-api.d.ts:2020

+

packages/extension-api/src/extension-api.d.ts:2020

\ No newline at end of file diff --git a/api/interfaces/PortBinding.html b/api/interfaces/PortBinding.html index 7156c0feb77..987deb0099f 100644 --- a/api/interfaces/PortBinding.html +++ b/api/interfaces/PortBinding.html @@ -13,7 +13,7 @@ - + @@ -24,13 +24,13 @@

optional HostIp: string

Source​

-

packages/extension-api/src/extension-api.d.ts:2075

+

packages/extension-api/src/extension-api.d.ts:2075


HostPort?​

optional HostPort: string

Source​

-

packages/extension-api/src/extension-api.d.ts:2076

+

packages/extension-api/src/extension-api.d.ts:2076

\ No newline at end of file diff --git a/api/interfaces/PortMap.html b/api/interfaces/PortMap.html index e6f6f8e537b..e35357af0b6 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 15455fe0f54..c513943448a 100644 --- a/api/interfaces/Progress.html +++ b/api/interfaces/Progress.html @@ -13,7 +13,7 @@ - + @@ -34,6 +34,6 @@ report on how much work finished

Returns​

void

Source​

-

packages/extension-api/src/extension-api.d.ts:727

+

packages/extension-api/src/extension-api.d.ts:727

\ No newline at end of file diff --git a/api/interfaces/ProgressOptions.html b/api/interfaces/ProgressOptions.html index 92f0e5eb687..f7396ad0e71 100644 --- a/api/interfaces/ProgressOptions.html +++ b/api/interfaces/ProgressOptions.html @@ -13,7 +13,7 @@ - + @@ -29,7 +29,7 @@ cancel the long running operation. Note that currently only ProgressLocation.Notification is supporting to show a cancel button.

Source​

-

packages/extension-api/src/extension-api.d.ts:771

+

packages/extension-api/src/extension-api.d.ts:771


location​

@@ -37,7 +37,7 @@ button.

The location at which progress should show.

Source​

-

packages/extension-api/src/extension-api.d.ts:757

+

packages/extension-api/src/extension-api.d.ts:757


title?​

@@ -46,6 +46,6 @@ button.

A human-readable string which will be used to describe the operation.

Source​

-

packages/extension-api/src/extension-api.d.ts:763

+

packages/extension-api/src/extension-api.d.ts:763

\ No newline at end of file diff --git a/api/interfaces/Provider.html b/api/interfaces/Provider.html index 1dcbc338d48..a5cce2811ab 100644 --- a/api/interfaces/Provider.html +++ b/api/interfaces/Provider.html @@ -13,7 +13,7 @@ - + @@ -24,77 +24,77 @@

readonly detectionChecks: ProviderDetectionCheck[]

Source​

-

packages/extension-api/src/extension-api.d.ts:468

+

packages/extension-api/src/extension-api.d.ts:468


id​

readonly id: string

Source​

-

packages/extension-api/src/extension-api.d.ts:453

+

packages/extension-api/src/extension-api.d.ts:453


images​

readonly images: ProviderImages

Source​

-

packages/extension-api/src/extension-api.d.ts:463

+

packages/extension-api/src/extension-api.d.ts:463


readonly links: Link[]

Source​

-

packages/extension-api/src/extension-api.d.ts:465

+

packages/extension-api/src/extension-api.d.ts:465


name​

readonly name: string

Source​

-

packages/extension-api/src/extension-api.d.ts:452

+

packages/extension-api/src/extension-api.d.ts:452


onDidUpdateDetectionChecks​

onDidUpdateDetectionChecks: Event< ProviderDetectionCheck[] >

Source​

-

packages/extension-api/src/extension-api.d.ts:479

+

packages/extension-api/src/extension-api.d.ts:479


onDidUpdateStatus​

onDidUpdateStatus: Event< ProviderStatus >

Source​

-

packages/extension-api/src/extension-api.d.ts:456

+

packages/extension-api/src/extension-api.d.ts:456


onDidUpdateVersion​

onDidUpdateVersion: Event< string >

Source​

-

packages/extension-api/src/extension-api.d.ts:461

+

packages/extension-api/src/extension-api.d.ts:461


status​

readonly status: ProviderStatus

Source​

-

packages/extension-api/src/extension-api.d.ts:454

+

packages/extension-api/src/extension-api.d.ts:454


version​

readonly version: undefined | string

Source​

-

packages/extension-api/src/extension-api.d.ts:459

+

packages/extension-api/src/extension-api.d.ts:459


warnings​

readonly warnings: ProviderInformation[]

Source​

-

packages/extension-api/src/extension-api.d.ts:475

+

packages/extension-api/src/extension-api.d.ts:475

Methods​

dispose()​

@@ -103,7 +103,7 @@

Returns​

void

Source​

-

packages/extension-api/src/extension-api.d.ts:451

+

packages/extension-api/src/extension-api.d.ts:451


registerAutostart()​

@@ -114,7 +114,7 @@

Returns​

Disposable

Source​

-

packages/extension-api/src/extension-api.d.ts:447

+

packages/extension-api/src/extension-api.d.ts:447


registerCleanup()​

@@ -125,7 +125,7 @@

Returns​

Disposable

Source​

-

packages/extension-api/src/extension-api.d.ts:449

+

packages/extension-api/src/extension-api.d.ts:449


registerContainerProviderConnection()​

@@ -136,7 +136,7 @@

Returns​

Disposable

Source​

-

packages/extension-api/src/extension-api.d.ts:436

+

packages/extension-api/src/extension-api.d.ts:436


registerInstallation()​

@@ -147,7 +147,7 @@

Returns​

Disposable

Source​

-

packages/extension-api/src/extension-api.d.ts:441

+

packages/extension-api/src/extension-api.d.ts:441


registerKubernetesProviderConnection()​

@@ -158,7 +158,7 @@

Returns​

Disposable

Source​

-

packages/extension-api/src/extension-api.d.ts:437

+

packages/extension-api/src/extension-api.d.ts:437


registerLifecycle()​

@@ -169,7 +169,7 @@

Returns​

Disposable

Source​

-

packages/extension-api/src/extension-api.d.ts:438

+

packages/extension-api/src/extension-api.d.ts:438


registerUpdate()​

@@ -180,7 +180,7 @@

Returns​

Disposable

Source​

-

packages/extension-api/src/extension-api.d.ts:444

+

packages/extension-api/src/extension-api.d.ts:444


setContainerProviderConnectionFactory()​

@@ -192,7 +192,7 @@

Returns​

Disposable

Source​

-

packages/extension-api/src/extension-api.d.ts:427

+

packages/extension-api/src/extension-api.d.ts:427


setKubernetesProviderConnectionFactory()​

@@ -204,7 +204,7 @@

Returns​

Disposable

Source​

-

packages/extension-api/src/extension-api.d.ts:431

+

packages/extension-api/src/extension-api.d.ts:431


updateDetectionChecks()​

@@ -215,7 +215,7 @@

Returns​

void

Source​

-

packages/extension-api/src/extension-api.d.ts:472

+

packages/extension-api/src/extension-api.d.ts:472


updateStatus()​

@@ -226,7 +226,7 @@

Returns​

void

Source​

-

packages/extension-api/src/extension-api.d.ts:455

+

packages/extension-api/src/extension-api.d.ts:455


updateVersion()​

@@ -237,7 +237,7 @@

Returns​

void

Source​

-

packages/extension-api/src/extension-api.d.ts:460

+

packages/extension-api/src/extension-api.d.ts:460


updateWarnings()​

@@ -248,6 +248,6 @@

Returns​

void

Source​

-

packages/extension-api/src/extension-api.d.ts:476

+

packages/extension-api/src/extension-api.d.ts:476

\ No newline at end of file diff --git a/api/interfaces/ProviderAutostart.html b/api/interfaces/ProviderAutostart.html index 1c3b979e23e..e76e70af646 100644 --- a/api/interfaces/ProviderAutostart.html +++ b/api/interfaces/ProviderAutostart.html @@ -13,7 +13,7 @@ - + @@ -31,6 +31,6 @@ It can be turned off/on by the user.

Returns​

Promise< void >

Source​

-

packages/extension-api/src/extension-api.d.ts:396

+

packages/extension-api/src/extension-api.d.ts:396

\ No newline at end of file diff --git a/api/interfaces/ProviderCleanup.html b/api/interfaces/ProviderCleanup.html index 279a2af40e9..f41902b0a74 100644 --- a/api/interfaces/ProviderCleanup.html +++ b/api/interfaces/ProviderCleanup.html @@ -13,7 +13,7 @@ - + @@ -27,6 +27,6 @@

Returns​

Promise< ProviderCleanupAction[] >

Source​

-

packages/extension-api/src/extension-api.d.ts:403

+

packages/extension-api/src/extension-api.d.ts:403

\ No newline at end of file diff --git a/api/interfaces/ProviderCleanupAction.html b/api/interfaces/ProviderCleanupAction.html index 2259f3ca661..5ac2dea484f 100644 --- a/api/interfaces/ProviderCleanupAction.html +++ b/api/interfaces/ProviderCleanupAction.html @@ -13,7 +13,7 @@ - + @@ -24,7 +24,7 @@

name: string

Source​

-

packages/extension-api/src/extension-api.d.ts:414

+

packages/extension-api/src/extension-api.d.ts:414

Methods​

execute()​

@@ -35,6 +35,6 @@

Returns​

Promise< void >

Source​

-

packages/extension-api/src/extension-api.d.ts:416

+

packages/extension-api/src/extension-api.d.ts:416

\ No newline at end of file diff --git a/api/interfaces/ProviderCleanupExecuteOptions.html b/api/interfaces/ProviderCleanupExecuteOptions.html index cb7b58e887e..873d561dc91 100644 --- a/api/interfaces/ProviderCleanupExecuteOptions.html +++ b/api/interfaces/ProviderCleanupExecuteOptions.html @@ -13,7 +13,7 @@ - + @@ -24,13 +24,13 @@

logger: Logger

Source​

-

packages/extension-api/src/extension-api.d.ts:407

+

packages/extension-api/src/extension-api.d.ts:407


token?​

optional token: CancellationToken

Source​

-

packages/extension-api/src/extension-api.d.ts:408

+

packages/extension-api/src/extension-api.d.ts:408

\ No newline at end of file diff --git a/api/interfaces/ProviderConnectionFactory.html b/api/interfaces/ProviderConnectionFactory.html index f56cac7bb16..95e3b2961ad 100644 --- a/api/interfaces/ProviderConnectionFactory.html +++ b/api/interfaces/ProviderConnectionFactory.html @@ -13,7 +13,7 @@ - + @@ -29,14 +29,14 @@

optional creationButtonTitle: string

Source​

-

packages/extension-api/src/extension-api.d.ts:317

+

packages/extension-api/src/extension-api.d.ts:317


creationDisplayName?​

optional creationDisplayName: string

Source​

-

packages/extension-api/src/extension-api.d.ts:314

+

packages/extension-api/src/extension-api.d.ts:314

Methods​

initialize()?​

@@ -45,6 +45,6 @@

Returns​

Promise< void >

Source​

-

packages/extension-api/src/extension-api.d.ts:311

+

packages/extension-api/src/extension-api.d.ts:311

\ No newline at end of file diff --git a/api/interfaces/ProviderConnectionLifecycle.html b/api/interfaces/ProviderConnectionLifecycle.html index cc3cb631cde..73acb3cb202 100644 --- a/api/interfaces/ProviderConnectionLifecycle.html +++ b/api/interfaces/ProviderConnectionLifecycle.html @@ -13,7 +13,7 @@ - + @@ -28,7 +28,7 @@

Returns​

Promise< void >

Source​

-

packages/extension-api/src/extension-api.d.ts:250

+

packages/extension-api/src/extension-api.d.ts:250


edit()?​

@@ -42,7 +42,7 @@

Returns​

Promise< void >

Source​

-

packages/extension-api/src/extension-api.d.ts:251

+

packages/extension-api/src/extension-api.d.ts:251


start()?​

@@ -54,7 +54,7 @@

Returns​

Promise< void >

Source​

-

packages/extension-api/src/extension-api.d.ts:248

+

packages/extension-api/src/extension-api.d.ts:248


stop()?​

@@ -66,6 +66,6 @@

Returns​

Promise< void >

Source​

-

packages/extension-api/src/extension-api.d.ts:249

+

packages/extension-api/src/extension-api.d.ts:249

\ No newline at end of file diff --git a/api/interfaces/ProviderContainerConnection.html b/api/interfaces/ProviderContainerConnection.html index 737e0bdc1bc..ace81a12f12 100644 --- a/api/interfaces/ProviderContainerConnection.html +++ b/api/interfaces/ProviderContainerConnection.html @@ -13,7 +13,7 @@ - + @@ -24,13 +24,13 @@

connection: ContainerProviderConnection

Source​

-

packages/extension-api/src/extension-api.d.ts:541

+

packages/extension-api/src/extension-api.d.ts:541


providerId​

providerId: string

Source​

-

packages/extension-api/src/extension-api.d.ts:540

+

packages/extension-api/src/extension-api.d.ts:540

\ No newline at end of file diff --git a/api/interfaces/ProviderDetectionCheck.html b/api/interfaces/ProviderDetectionCheck.html index b1284c7ba2d..e3b60d58006 100644 --- a/api/interfaces/ProviderDetectionCheck.html +++ b/api/interfaces/ProviderDetectionCheck.html @@ -13,7 +13,7 @@ - + @@ -24,20 +24,20 @@

optional details: string

Source​

-

packages/extension-api/src/extension-api.d.ts:212

+

packages/extension-api/src/extension-api.d.ts:212


name​

name: string

Source​

-

packages/extension-api/src/extension-api.d.ts:211

+

packages/extension-api/src/extension-api.d.ts:211


status​

status: boolean

Source​

-

packages/extension-api/src/extension-api.d.ts:213

+

packages/extension-api/src/extension-api.d.ts:213

\ No newline at end of file diff --git a/api/interfaces/ProviderEvent.html b/api/interfaces/ProviderEvent.html index 969a8acee44..b55cc2ee988 100644 --- a/api/interfaces/ProviderEvent.html +++ b/api/interfaces/ProviderEvent.html @@ -13,7 +13,7 @@ - + @@ -24,20 +24,20 @@

id: string

Source​

-

packages/extension-api/src/extension-api.d.ts:509

+

packages/extension-api/src/extension-api.d.ts:509


name​

name: string

Source​

-

packages/extension-api/src/extension-api.d.ts:510

+

packages/extension-api/src/extension-api.d.ts:510


status​

status: ProviderStatus

Source​

-

packages/extension-api/src/extension-api.d.ts:511

+

packages/extension-api/src/extension-api.d.ts:511

\ No newline at end of file diff --git a/api/interfaces/ProviderImages.html b/api/interfaces/ProviderImages.html index c7112436ded..c86e620ac0c 100644 --- a/api/interfaces/ProviderImages.html +++ b/api/interfaces/ProviderImages.html @@ -13,7 +13,7 @@ - + @@ -24,13 +24,13 @@

optional icon: string | object

Source​

-

packages/extension-api/src/extension-api.d.ts:422

+

packages/extension-api/src/extension-api.d.ts:422


optional logo: string | object

Source​

-

packages/extension-api/src/extension-api.d.ts:423

+

packages/extension-api/src/extension-api.d.ts:423

\ No newline at end of file diff --git a/api/interfaces/ProviderInformation.html b/api/interfaces/ProviderInformation.html index 3fcdaac1250..b73d074fe24 100644 --- a/api/interfaces/ProviderInformation.html +++ b/api/interfaces/ProviderInformation.html @@ -13,7 +13,7 @@ - + @@ -24,13 +24,13 @@

optional details: string

Source​

-

packages/extension-api/src/extension-api.d.ts:207

+

packages/extension-api/src/extension-api.d.ts:207


name​

name: string

Source​

-

packages/extension-api/src/extension-api.d.ts:206

+

packages/extension-api/src/extension-api.d.ts:206

\ No newline at end of file diff --git a/api/interfaces/ProviderInstallation.html b/api/interfaces/ProviderInstallation.html index 9b34a9f84bf..dae124f80ba 100644 --- a/api/interfaces/ProviderInstallation.html +++ b/api/interfaces/ProviderInstallation.html @@ -13,7 +13,7 @@ - + @@ -28,7 +28,7 @@

Returns​

Promise< void >

Source​

-

packages/extension-api/src/extension-api.d.ts:379

+

packages/extension-api/src/extension-api.d.ts:379


preflightChecks()?​

@@ -37,6 +37,6 @@

Returns​

InstallCheck[]

Source​

-

packages/extension-api/src/extension-api.d.ts:377

+

packages/extension-api/src/extension-api.d.ts:377

\ No newline at end of file diff --git a/api/interfaces/ProviderLifecycle.html b/api/interfaces/ProviderLifecycle.html index c052dc5e307..14e96d94b06 100644 --- a/api/interfaces/ProviderLifecycle.html +++ b/api/interfaces/ProviderLifecycle.html @@ -13,7 +13,7 @@ - + @@ -28,7 +28,7 @@

Returns​

Promise< void >

Source​

-

packages/extension-api/src/extension-api.d.ts:197

+

packages/extension-api/src/extension-api.d.ts:197


start()​

@@ -39,7 +39,7 @@

Returns​

Promise< void >

Source​

-

packages/extension-api/src/extension-api.d.ts:198

+

packages/extension-api/src/extension-api.d.ts:198


status()​

@@ -48,7 +48,7 @@

Returns​

ProviderStatus

Source​

-

packages/extension-api/src/extension-api.d.ts:200

+

packages/extension-api/src/extension-api.d.ts:200


stop()​

@@ -59,6 +59,6 @@

Returns​

Promise< void >

Source​

-

packages/extension-api/src/extension-api.d.ts:199

+

packages/extension-api/src/extension-api.d.ts:199

\ No newline at end of file diff --git a/api/interfaces/ProviderOptions.html b/api/interfaces/ProviderOptions.html index 7347470f59b..2fa4020a283 100644 --- a/api/interfaces/ProviderOptions.html +++ b/api/interfaces/ProviderOptions.html @@ -13,7 +13,7 @@ - + @@ -24,62 +24,62 @@

optional detectionChecks: ProviderDetectionCheck[]

Source​

-

packages/extension-api/src/extension-api.d.ts:223

+

packages/extension-api/src/extension-api.d.ts:223


emptyConnectionMarkdownDescription?​

optional emptyConnectionMarkdownDescription: string

Source​

-

packages/extension-api/src/extension-api.d.ts:229

+

packages/extension-api/src/extension-api.d.ts:229


id​

id: string

Source​

-

packages/extension-api/src/extension-api.d.ts:217

+

packages/extension-api/src/extension-api.d.ts:217


images?​

optional images: ProviderImages

Source​

-

packages/extension-api/src/extension-api.d.ts:221

+

packages/extension-api/src/extension-api.d.ts:221


optional links: Link[]

Source​

-

packages/extension-api/src/extension-api.d.ts:222

+

packages/extension-api/src/extension-api.d.ts:222


name​

name: string

Source​

-

packages/extension-api/src/extension-api.d.ts:218

+

packages/extension-api/src/extension-api.d.ts:218


status​

status: ProviderStatus

Source​

-

packages/extension-api/src/extension-api.d.ts:219

+

packages/extension-api/src/extension-api.d.ts:219


version?​

optional version: string

Source​

-

packages/extension-api/src/extension-api.d.ts:220

+

packages/extension-api/src/extension-api.d.ts:220


warnings?​

optional warnings: ProviderInformation[]

Source​

-

packages/extension-api/src/extension-api.d.ts:226

+

packages/extension-api/src/extension-api.d.ts:226

\ No newline at end of file diff --git a/api/interfaces/ProviderUpdate.html b/api/interfaces/ProviderUpdate.html index ae0bc06a2ed..dfad0115c48 100644 --- a/api/interfaces/ProviderUpdate.html +++ b/api/interfaces/ProviderUpdate.html @@ -13,7 +13,7 @@ - + @@ -24,7 +24,7 @@

version: string

Source​

-

packages/extension-api/src/extension-api.d.ts:383

+

packages/extension-api/src/extension-api.d.ts:383

Methods​

preflightChecks()?​

@@ -33,7 +33,7 @@

Returns​

InstallCheck[]

Source​

-

packages/extension-api/src/extension-api.d.ts:387

+

packages/extension-api/src/extension-api.d.ts:387


update()​

@@ -44,6 +44,6 @@

Returns​

Promise< void >

Source​

-

packages/extension-api/src/extension-api.d.ts:385

+

packages/extension-api/src/extension-api.d.ts:385

\ No newline at end of file diff --git a/api/interfaces/ProxySettings.html b/api/interfaces/ProxySettings.html index cb3480137c8..21b3f011ee2 100644 --- a/api/interfaces/ProxySettings.html +++ b/api/interfaces/ProxySettings.html @@ -13,7 +13,7 @@ - + @@ -24,20 +24,20 @@

httpProxy: undefined | string

Source​

-

packages/extension-api/src/extension-api.d.ts:568

+

packages/extension-api/src/extension-api.d.ts:568


httpsProxy​

httpsProxy: undefined | string

Source​

-

packages/extension-api/src/extension-api.d.ts:569

+

packages/extension-api/src/extension-api.d.ts:569


noProxy​

noProxy: undefined | string

Source​

-

packages/extension-api/src/extension-api.d.ts:570

+

packages/extension-api/src/extension-api.d.ts:570

\ No newline at end of file diff --git a/api/interfaces/PullEvent.html b/api/interfaces/PullEvent.html index da1848ff657..ea452957022 100644 --- a/api/interfaces/PullEvent.html +++ b/api/interfaces/PullEvent.html @@ -13,7 +13,7 @@ - + @@ -24,7 +24,7 @@

optional error: string

Source​

-

packages/extension-api/src/extension-api.d.ts:2389

+

packages/extension-api/src/extension-api.d.ts:2389


errorDetails?​

@@ -35,21 +35,21 @@

optional message: string

Source​

-

packages/extension-api/src/extension-api.d.ts:2390

+

packages/extension-api/src/extension-api.d.ts:2390


id?​

optional id: string

Source​

-

packages/extension-api/src/extension-api.d.ts:2382

+

packages/extension-api/src/extension-api.d.ts:2382


progress?​

optional progress: string

Source​

-

packages/extension-api/src/extension-api.d.ts:2384

+

packages/extension-api/src/extension-api.d.ts:2384


progressDetail?​

@@ -64,20 +64,20 @@

optional total: number

Source​

-

packages/extension-api/src/extension-api.d.ts:2385

+

packages/extension-api/src/extension-api.d.ts:2385


status?​

optional status: string

Source​

-

packages/extension-api/src/extension-api.d.ts:2383

+

packages/extension-api/src/extension-api.d.ts:2383


stream?​

optional stream: string

Source​

-

packages/extension-api/src/extension-api.d.ts:2381

+

packages/extension-api/src/extension-api.d.ts:2381

\ No newline at end of file diff --git a/api/interfaces/QuickInputButton.html b/api/interfaces/QuickInputButton.html index ea53f521f94..9c66d10a087 100644 --- a/api/interfaces/QuickInputButton.html +++ b/api/interfaces/QuickInputButton.html @@ -13,7 +13,7 @@ - + @@ -26,7 +26,7 @@

Icon for the button.

Source​

-

packages/extension-api/src/extension-api.d.ts:927

+

packages/extension-api/src/extension-api.d.ts:927


tooltip?​

@@ -34,6 +34,6 @@

An optional tooltip.

Source​

-

packages/extension-api/src/extension-api.d.ts:932

+

packages/extension-api/src/extension-api.d.ts:932

\ No newline at end of file diff --git a/api/interfaces/QuickPickItem.html b/api/interfaces/QuickPickItem.html index 1ffd7eb9ae1..96fbb485963 100644 --- a/api/interfaces/QuickPickItem.html +++ b/api/interfaces/QuickPickItem.html @@ -13,7 +13,7 @@ - + @@ -28,7 +28,7 @@ a list of items.

Always show this item.

Note: this property is ignored when kind is set to QuickPickItemKind.Separator

Source​

-

packages/extension-api/src/extension-api.d.ts:1028

+

packages/extension-api/src/extension-api.d.ts:1028


buttons?​

@@ -40,7 +40,7 @@ created by the window.createQuickPick createQuickPick() API. Buttons are not ren the showQuickPick() API.

Note: this property is ignored when kind is set to QuickPickItemKind.Separator

Source​

-

packages/extension-api/src/extension-api.d.ts:1038

+

packages/extension-api/src/extension-api.d.ts:1038


description?​

@@ -50,7 +50,7 @@ the showQuickPick() ThemeIcon theme icons via the $(<name>)-syntax.

Note: this property is ignored when kind is set to QuickPickItemKind.Separator

Source​

-

packages/extension-api/src/extension-api.d.ts:1000

+

packages/extension-api/src/extension-api.d.ts:1000


detail?​

@@ -60,7 +60,7 @@ ThemeIcon theme icons via the $(<name>)-syntax.

ThemeIcon theme icons via the $(<name>)-syntax.

Note: this property is ignored when kind is set to QuickPickItemKind.Separator

Source​

-

packages/extension-api/src/extension-api.d.ts:1008

+

packages/extension-api/src/extension-api.d.ts:1008


kind?​

@@ -69,7 +69,7 @@ ThemeIcon theme icons via the $(<name>)-syntax.

The kind of QuickPickItem that will determine how this item is rendered in the quick pick. When not specified, the default is QuickPickItemKind.Default.

Source​

-

packages/extension-api/src/extension-api.d.ts:992

+

packages/extension-api/src/extension-api.d.ts:992


label​

@@ -78,7 +78,7 @@ the default is QuickPickIt

A human-readable string which is rendered prominent. Supports rendering of ThemeIcon theme icons via the $(<name>)-syntax.

Source​

-

packages/extension-api/src/extension-api.d.ts:986

+

packages/extension-api/src/extension-api.d.ts:986


picked?​

@@ -93,6 +93,6 @@ to the items you want picked initially.

QuickPickOptions.canPickMany

Note: this property is ignored when kind is set to QuickPickItemKind.Separator

Source​

-

packages/extension-api/src/extension-api.d.ts:1021

+

packages/extension-api/src/extension-api.d.ts:1021

\ No newline at end of file diff --git a/api/interfaces/QuickPickOptions.html b/api/interfaces/QuickPickOptions.html index cbb8fda3f92..991c1e4f11a 100644 --- a/api/interfaces/QuickPickOptions.html +++ b/api/interfaces/QuickPickOptions.html @@ -13,7 +13,7 @@ - + @@ -26,7 +26,7 @@

An optional flag to make the picker accept multiple selections, if true the result is an array of picks.

Source​

-

packages/extension-api/src/extension-api.d.ts:968

+

packages/extension-api/src/extension-api.d.ts:968


ignoreFocusOut?​

@@ -35,7 +35,7 @@

Set to true to keep the picker open when focus moves to another part of the editor or to another window. This setting is ignored on iPad and is always false.

Source​

-

packages/extension-api/src/extension-api.d.ts:963

+

packages/extension-api/src/extension-api.d.ts:963


matchOnDescription?​

@@ -43,7 +43,7 @@ This setting is ignored on iPad and is always false.

An optional flag to include the description when filtering the picks.

Source​

-

packages/extension-api/src/extension-api.d.ts:947

+

packages/extension-api/src/extension-api.d.ts:947


matchOnDetail?​

@@ -51,7 +51,7 @@ This setting is ignored on iPad and is always false.

An optional flag to include the detail when filtering the picks.

Source​

-

packages/extension-api/src/extension-api.d.ts:952

+

packages/extension-api/src/extension-api.d.ts:952


placeHolder?​

@@ -59,7 +59,7 @@ This setting is ignored on iPad and is always false.

An optional string to show as placeholder in the input box to guide the user what to pick on.

Source​

-

packages/extension-api/src/extension-api.d.ts:957

+

packages/extension-api/src/extension-api.d.ts:957


title?​

@@ -67,7 +67,7 @@ This setting is ignored on iPad and is always false.

An optional string that represents the title of the quick pick.

Source​

-

packages/extension-api/src/extension-api.d.ts:942

+

packages/extension-api/src/extension-api.d.ts:942

Methods​

onDidSelectItem()?​

@@ -79,6 +79,6 @@ This setting is ignored on iPad and is always false.

Returns​

any

Source​

-

packages/extension-api/src/extension-api.d.ts:974

+

packages/extension-api/src/extension-api.d.ts:974

\ No newline at end of file diff --git a/api/interfaces/RegisterContainerConnectionEvent.html b/api/interfaces/RegisterContainerConnectionEvent.html index 88a92d3613c..0c936e3cdcf 100644 --- a/api/interfaces/RegisterContainerConnectionEvent.html +++ b/api/interfaces/RegisterContainerConnectionEvent.html @@ -13,7 +13,7 @@ - + @@ -24,13 +24,13 @@

connection: ContainerProviderConnection

Source​

-

packages/extension-api/src/extension-api.d.ts:537

+

packages/extension-api/src/extension-api.d.ts:537


providerId​

providerId: string

Source​

-

packages/extension-api/src/extension-api.d.ts:536

+

packages/extension-api/src/extension-api.d.ts:536

\ No newline at end of file diff --git a/api/interfaces/RegisterKubernetesConnectionEvent.html b/api/interfaces/RegisterKubernetesConnectionEvent.html index a0017e1f01c..3127d66cb04 100644 --- a/api/interfaces/RegisterKubernetesConnectionEvent.html +++ b/api/interfaces/RegisterKubernetesConnectionEvent.html @@ -13,7 +13,7 @@ - + @@ -24,6 +24,6 @@

providerId: string

Source​

-

packages/extension-api/src/extension-api.d.ts:533

+

packages/extension-api/src/extension-api.d.ts:533

\ No newline at end of file diff --git a/api/interfaces/Registry.html b/api/interfaces/Registry.html index b7e5aee974a..74a214985d7 100644 --- a/api/interfaces/Registry.html +++ b/api/interfaces/Registry.html @@ -13,7 +13,7 @@ - + @@ -28,7 +28,7 @@

optional icon: string

Source​

-

packages/extension-api/src/extension-api.d.ts:600

+

packages/extension-api/src/extension-api.d.ts:600


insecure?​

@@ -37,14 +37,14 @@

Inherited from​

RegistryCreateOptions.insecure

Source​

-

packages/extension-api/src/extension-api.d.ts:607

+

packages/extension-api/src/extension-api.d.ts:607


name?​

optional name: string

Source​

-

packages/extension-api/src/extension-api.d.ts:599

+

packages/extension-api/src/extension-api.d.ts:599


secret​

@@ -53,7 +53,7 @@

Inherited from​

RegistryCreateOptions.secret

Source​

-

packages/extension-api/src/extension-api.d.ts:606

+

packages/extension-api/src/extension-api.d.ts:606


serverUrl​

@@ -62,14 +62,14 @@

Inherited from​

RegistryCreateOptions.serverUrl

Source​

-

packages/extension-api/src/extension-api.d.ts:604

+

packages/extension-api/src/extension-api.d.ts:604


source​

source: string

Source​

-

packages/extension-api/src/extension-api.d.ts:596

+

packages/extension-api/src/extension-api.d.ts:596


username​

@@ -78,6 +78,6 @@

Inherited from​

RegistryCreateOptions.username

Source​

-

packages/extension-api/src/extension-api.d.ts:605

+

packages/extension-api/src/extension-api.d.ts:605

\ No newline at end of file diff --git a/api/interfaces/RegistryConfig.html b/api/interfaces/RegistryConfig.html index 8c1729295cd..26ca59b13dc 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 b9e02d2eac6..66683c17670 100644 --- a/api/interfaces/RegistryCreateOptions.html +++ b/api/interfaces/RegistryCreateOptions.html @@ -13,7 +13,7 @@ - + @@ -28,27 +28,27 @@

optional insecure: boolean

Source​

-

packages/extension-api/src/extension-api.d.ts:607

+

packages/extension-api/src/extension-api.d.ts:607


secret​

secret: string

Source​

-

packages/extension-api/src/extension-api.d.ts:606

+

packages/extension-api/src/extension-api.d.ts:606


serverUrl​

serverUrl: string

Source​

-

packages/extension-api/src/extension-api.d.ts:604

+

packages/extension-api/src/extension-api.d.ts:604


username​

username: string

Source​

-

packages/extension-api/src/extension-api.d.ts:605

+

packages/extension-api/src/extension-api.d.ts:605

\ No newline at end of file diff --git a/api/interfaces/RegistryProvider.html b/api/interfaces/RegistryProvider.html index db3c468f0b1..ea6ebc05d6c 100644 --- a/api/interfaces/RegistryProvider.html +++ b/api/interfaces/RegistryProvider.html @@ -13,7 +13,7 @@ - + @@ -24,7 +24,7 @@

readonly name: string

Source​

-

packages/extension-api/src/extension-api.d.ts:611

+

packages/extension-api/src/extension-api.d.ts:611

Methods​

create()​

@@ -35,6 +35,6 @@

Returns​

Registry

Source​

-

packages/extension-api/src/extension-api.d.ts:612

+

packages/extension-api/src/extension-api.d.ts:612

\ No newline at end of file diff --git a/api/interfaces/RegistrySuggestedProvider.html b/api/interfaces/RegistrySuggestedProvider.html index cb1d7386ed8..85f01439004 100644 --- a/api/interfaces/RegistrySuggestedProvider.html +++ b/api/interfaces/RegistrySuggestedProvider.html @@ -13,7 +13,7 @@ - + @@ -24,20 +24,20 @@

optional icon: string

Source​

-

packages/extension-api/src/extension-api.d.ts:592

+

packages/extension-api/src/extension-api.d.ts:592


name​

name: string

Source​

-

packages/extension-api/src/extension-api.d.ts:588

+

packages/extension-api/src/extension-api.d.ts:588


url​

url: string

Source​

-

packages/extension-api/src/extension-api.d.ts:589

+

packages/extension-api/src/extension-api.d.ts:589

\ No newline at end of file diff --git a/api/interfaces/RunError.html b/api/interfaces/RunError.html index 3f35b47260b..4bece000dde 100644 --- a/api/interfaces/RunError.html +++ b/api/interfaces/RunError.html @@ -13,7 +13,7 @@ - + @@ -30,7 +30,7 @@

Indicates whether the execution was cancelled.

Source​

-

packages/extension-api/src/extension-api.d.ts:3807

+

packages/extension-api/src/extension-api.d.ts:3807


cause?​

@@ -47,7 +47,7 @@

The command that was executed.

Source​

-

packages/extension-api/src/extension-api.d.ts:3792

+

packages/extension-api/src/extension-api.d.ts:3792


exitCode​

@@ -55,7 +55,7 @@

The exit code of the command.

Source​

-

packages/extension-api/src/extension-api.d.ts:3787

+

packages/extension-api/src/extension-api.d.ts:3787


killed​

@@ -63,7 +63,7 @@

Indicates whether the process was forcefully killed.

Source​

-

packages/extension-api/src/extension-api.d.ts:3812

+

packages/extension-api/src/extension-api.d.ts:3812


message​

@@ -73,7 +73,7 @@

Overrides​

Error.message

Source​

-

packages/extension-api/src/extension-api.d.ts:3782

+

packages/extension-api/src/extension-api.d.ts:3782


name​

@@ -99,7 +99,7 @@

The standard error (stderr) content of the command.

Source​

-

packages/extension-api/src/extension-api.d.ts:3802

+

packages/extension-api/src/extension-api.d.ts:3802


stdout​

@@ -107,6 +107,6 @@

The standard output (stdout) content of the command.

Source​

-

packages/extension-api/src/extension-api.d.ts:3797

+

packages/extension-api/src/extension-api.d.ts:3797

\ No newline at end of file diff --git a/api/interfaces/RunOptions.html b/api/interfaces/RunOptions.html index 047953672d8..5fad21514f1 100644 --- a/api/interfaces/RunOptions.html +++ b/api/interfaces/RunOptions.html @@ -13,7 +13,7 @@ - + @@ -26,7 +26,7 @@

custom directory

Source​

-

packages/extension-api/src/extension-api.d.ts:3742

+

packages/extension-api/src/extension-api.d.ts:3742


encoding?​

@@ -34,7 +34,7 @@

The encoding to use. Default utf8

Source​

-

packages/extension-api/src/extension-api.d.ts:3752

+

packages/extension-api/src/extension-api.d.ts:3752


env?​

@@ -44,7 +44,7 @@

Index signature​

[key: string]: string

Source​

-

packages/extension-api/src/extension-api.d.ts:3727

+

packages/extension-api/src/extension-api.d.ts:3727


isAdmin?​

@@ -52,7 +52,7 @@

admin privileges required

Source​

-

packages/extension-api/src/extension-api.d.ts:3747

+

packages/extension-api/src/extension-api.d.ts:3747


logger?​

@@ -60,7 +60,7 @@

A logger used to track execution events.

Source​

-

packages/extension-api/src/extension-api.d.ts:3737

+

packages/extension-api/src/extension-api.d.ts:3737


token?​

@@ -68,6 +68,6 @@

A cancellation token used to request cancellation.

Source​

-

packages/extension-api/src/extension-api.d.ts:3732

+

packages/extension-api/src/extension-api.d.ts:3732

\ No newline at end of file diff --git a/api/interfaces/RunResult.html b/api/interfaces/RunResult.html index 76b5546bea2..a402f5e918b 100644 --- a/api/interfaces/RunResult.html +++ b/api/interfaces/RunResult.html @@ -13,7 +13,7 @@ - + @@ -26,7 +26,7 @@

The command that was executed.

Source​

-

packages/extension-api/src/extension-api.d.ts:3762

+

packages/extension-api/src/extension-api.d.ts:3762


stderr​

@@ -34,7 +34,7 @@

The standard error (stderr) content of the command.

Source​

-

packages/extension-api/src/extension-api.d.ts:3772

+

packages/extension-api/src/extension-api.d.ts:3772


stdout​

@@ -42,6 +42,6 @@

The standard output (stdout) content of the command.

Source​

-

packages/extension-api/src/extension-api.d.ts:3767

+

packages/extension-api/src/extension-api.d.ts:3767

\ No newline at end of file diff --git a/api/interfaces/SaveDialogOptions.html b/api/interfaces/SaveDialogOptions.html index cefc88a5f46..cc23a36cfe0 100644 --- a/api/interfaces/SaveDialogOptions.html +++ b/api/interfaces/SaveDialogOptions.html @@ -13,7 +13,7 @@ - + @@ -26,7 +26,7 @@

The resource the dialog shows when opened.

Source​

-

packages/extension-api/src/extension-api.d.ts:1552

+

packages/extension-api/src/extension-api.d.ts:1552


filters?​

@@ -34,7 +34,7 @@

A set of file filters that are used by the dialog.

Source​

-

packages/extension-api/src/extension-api.d.ts:1562

+

packages/extension-api/src/extension-api.d.ts:1562


saveLabel?​

@@ -42,7 +42,7 @@

A human-readable string for the save button.

Source​

-

packages/extension-api/src/extension-api.d.ts:1557

+

packages/extension-api/src/extension-api.d.ts:1557


title?​

@@ -50,6 +50,6 @@

Dialog title.

Source​

-

packages/extension-api/src/extension-api.d.ts:1570

+

packages/extension-api/src/extension-api.d.ts:1570

\ No newline at end of file diff --git a/api/interfaces/SecretStorage.html b/api/interfaces/SecretStorage.html index 2eb8c833e1f..c1b988464e1 100644 --- a/api/interfaces/SecretStorage.html +++ b/api/interfaces/SecretStorage.html @@ -13,7 +13,7 @@ - + @@ -27,7 +27,7 @@ sensitive.

Fires when a secret is stored or deleted.

Source​

-

packages/extension-api/src/extension-api.d.ts:4232

+

packages/extension-api/src/extension-api.d.ts:4232

Methods​

delete()​

@@ -40,7 +40,7 @@ sensitive.

Returns​

Promise< void >

Source​

-

packages/extension-api/src/extension-api.d.ts:4227

+

packages/extension-api/src/extension-api.d.ts:4227


get()​

@@ -55,7 +55,7 @@ is no secret matching that key.

Promise< undefined | string >

The stored value or undefined.

Source​

-

packages/extension-api/src/extension-api.d.ts:4214

+

packages/extension-api/src/extension-api.d.ts:4214


store()​

@@ -70,6 +70,6 @@ is no secret matching that key.

Returns​

Promise< void >

Source​

-

packages/extension-api/src/extension-api.d.ts:4221

+

packages/extension-api/src/extension-api.d.ts:4221

\ No newline at end of file diff --git a/api/interfaces/SecretStorageChangeEvent.html b/api/interfaces/SecretStorageChangeEvent.html index 05f7760a126..2e076f2a1af 100644 --- a/api/interfaces/SecretStorageChangeEvent.html +++ b/api/interfaces/SecretStorageChangeEvent.html @@ -13,7 +13,7 @@ - + @@ -26,6 +26,6 @@

The key of the secret that has changed.

Source​

-

packages/extension-api/src/extension-api.d.ts:4200

+

packages/extension-api/src/extension-api.d.ts:4200

\ No newline at end of file diff --git a/api/interfaces/StatusBarItem.html b/api/interfaces/StatusBarItem.html index f7953b0825e..bae431751f9 100644 --- a/api/interfaces/StatusBarItem.html +++ b/api/interfaces/StatusBarItem.html @@ -13,7 +13,7 @@ - + @@ -27,7 +27,7 @@ show text and icons and run a command on click.

The alignment of this item.

Source​

-

packages/extension-api/src/extension-api.d.ts:1205

+

packages/extension-api/src/extension-api.d.ts:1205


command?​

@@ -35,7 +35,7 @@ show text and icons and run a command on click.

The identifier of a command, previously registered with commands.registerCommand, to run on click.

Source​

-

packages/extension-api/src/extension-api.d.ts:1233

+

packages/extension-api/src/extension-api.d.ts:1233


commandArgs?​

@@ -43,7 +43,7 @@ show text and icons and run a command on click.

Arguments that the command handler should be invoked with.

Source​

-

packages/extension-api/src/extension-api.d.ts:1238

+

packages/extension-api/src/extension-api.d.ts:1238


enabled​

@@ -52,7 +52,7 @@ show text and icons and run a command on click.

Marks an item as disabled. When property is set to true, then icon will be changed to inactive and there won't be possible to execute a command if it is provided in the following configuration.

Source​

-

packages/extension-api/src/extension-api.d.ts:1229

+

packages/extension-api/src/extension-api.d.ts:1229


iconClass?​

@@ -62,7 +62,7 @@ and there won't be possible to execute a command if it is provided in the f Icon class should be in format e.g. 'fa fa-toggle-on'. It is possible to provide an icons for state which can be enabled or disabled.

Source​

-

packages/extension-api/src/extension-api.d.ts:1224

+

packages/extension-api/src/extension-api.d.ts:1224


priority​

@@ -71,7 +71,7 @@ for state which can be enabled or disabled.

The priority of this item. Higher value means the item should be shown more to the left or more to the right.

Source​

-

packages/extension-api/src/extension-api.d.ts:1210

+

packages/extension-api/src/extension-api.d.ts:1210


text?​

@@ -79,7 +79,7 @@ or more to the right.

The text to show for the entry.

Source​

-

packages/extension-api/src/extension-api.d.ts:1214

+

packages/extension-api/src/extension-api.d.ts:1214


tooltip?​

@@ -87,7 +87,7 @@ or more to the right.

The tooltip text when you hover over this entry.

Source​

-

packages/extension-api/src/extension-api.d.ts:1218

+

packages/extension-api/src/extension-api.d.ts:1218

Methods​

dispose()​

@@ -98,7 +98,7 @@ or more to the right.

Returns​

void

Source​

-

packages/extension-api/src/extension-api.d.ts:1252

+

packages/extension-api/src/extension-api.d.ts:1252


hide()​

@@ -108,7 +108,7 @@ or more to the right.

Returns​

void

Source​

-

packages/extension-api/src/extension-api.d.ts:1246

+

packages/extension-api/src/extension-api.d.ts:1246


show()​

@@ -118,6 +118,6 @@ or more to the right.

Returns​

void

Source​

-

packages/extension-api/src/extension-api.d.ts:1242

+

packages/extension-api/src/extension-api.d.ts:1242

\ No newline at end of file diff --git a/api/interfaces/StorageStats.html b/api/interfaces/StorageStats.html index ddb2645754b..d121226b0c1 100644 --- a/api/interfaces/StorageStats.html +++ b/api/interfaces/StorageStats.html @@ -13,7 +13,7 @@ - + @@ -24,27 +24,27 @@

optional read_count_normalized: number

Source​

-

packages/extension-api/src/extension-api.d.ts:2782

+

packages/extension-api/src/extension-api.d.ts:2782


read_size_bytes?​

optional read_size_bytes: number

Source​

-

packages/extension-api/src/extension-api.d.ts:2783

+

packages/extension-api/src/extension-api.d.ts:2783


write_count_normalized?​

optional write_count_normalized: number

Source​

-

packages/extension-api/src/extension-api.d.ts:2784

+

packages/extension-api/src/extension-api.d.ts:2784


write_size_bytes?​

optional write_size_bytes: number

Source​

-

packages/extension-api/src/extension-api.d.ts:2785

+

packages/extension-api/src/extension-api.d.ts:2785

\ No newline at end of file diff --git a/api/interfaces/TelemetryLogger.html b/api/interfaces/TelemetryLogger.html index 29cd4be8f2c..4a682efdf60 100644 --- a/api/interfaces/TelemetryLogger.html +++ b/api/interfaces/TelemetryLogger.html @@ -13,7 +13,7 @@ - + @@ -35,7 +35,7 @@ to forward unhandled errors to the respective extensions.

Whether or not error telemetry is enabled for this logger.

Source​

-

packages/extension-api/src/extension-api.d.ts:3869

+

packages/extension-api/src/extension-api.d.ts:3869


isUsageEnabled​

@@ -43,7 +43,7 @@ to forward unhandled errors to the respective extensions.

Whether or not usage telemetry is enabled for this logger.

Source​

-

packages/extension-api/src/extension-api.d.ts:3864

+

packages/extension-api/src/extension-api.d.ts:3864


onDidChangeEnableStates​

@@ -51,7 +51,7 @@ to forward unhandled errors to the respective extensions.

An Event which fires when the enablement state of usage or error telemetry changes.

Source​

-

packages/extension-api/src/extension-api.d.ts:3859

+

packages/extension-api/src/extension-api.d.ts:3859

Methods​

dispose()​

@@ -61,7 +61,7 @@ to forward unhandled errors to the respective extensions.

Returns​

void

Source​

-

packages/extension-api/src/extension-api.d.ts:3904

+

packages/extension-api/src/extension-api.d.ts:3904


logError()​

logError(eventName, data)​

@@ -79,7 +79,7 @@ Automatically supports echoing to extension telemetry output channel.

Returns​

void

Source​
-

packages/extension-api/src/extension-api.d.ts:3891

+

packages/extension-api/src/extension-api.d.ts:3891

logError(error, data)​

logError(error, data?): void

@@ -93,7 +93,7 @@ Automatically supports echoing to extension telemetry output channel.

Returns​

void

Source​
-

packages/extension-api/src/extension-api.d.ts:3899

+

packages/extension-api/src/extension-api.d.ts:3899


logUsage()​

@@ -110,6 +110,6 @@ Automatically supports echoing to extension telemetry output channel.

Returns​

void

Source​

-

packages/extension-api/src/extension-api.d.ts:3880

+

packages/extension-api/src/extension-api.d.ts:3880

\ No newline at end of file diff --git a/api/interfaces/TelemetryLoggerOptions.html b/api/interfaces/TelemetryLoggerOptions.html index 6967f4fb564..116322dad7c 100644 --- a/api/interfaces/TelemetryLoggerOptions.html +++ b/api/interfaces/TelemetryLoggerOptions.html @@ -13,7 +13,7 @@ - + @@ -26,7 +26,7 @@

Any additional common properties which should be injected into the data object.

Source​

-

packages/extension-api/src/extension-api.d.ts:3957

+

packages/extension-api/src/extension-api.d.ts:3957


ignoreBuiltInCommonProperties?​

@@ -35,7 +35,7 @@

Whether or not you want to avoid having the built-in common properties such as os, extension name, etc injected into the data object. Defaults to false if not defined.

Source​

-

packages/extension-api/src/extension-api.d.ts:3945

+

packages/extension-api/src/extension-api.d.ts:3945


ignoreUnhandledErrors?​

@@ -44,6 +44,6 @@ Defaults to false if not defined.

Whether or not unhandled errors on the extension host caused by your extension should be logged to your sender. Defaults to false if not defined.

Source​

-

packages/extension-api/src/extension-api.d.ts:3951

+

packages/extension-api/src/extension-api.d.ts:3951

\ No newline at end of file diff --git a/api/interfaces/TelemetrySender.html b/api/interfaces/TelemetrySender.html index ecd2a761be6..0421c4f34ee 100644 --- a/api/interfaces/TelemetrySender.html +++ b/api/interfaces/TelemetrySender.html @@ -13,7 +13,7 @@ - + @@ -30,7 +30,7 @@ as its TelemetryLogger is being di

Returns​

void | Promise< void >

Source​

-

packages/extension-api/src/extension-api.d.ts:3934

+

packages/extension-api/src/extension-api.d.ts:3934


sendErrorData()​

@@ -45,7 +45,7 @@ as its TelemetryLogger is being di

Returns​

void

Source​

-

packages/extension-api/src/extension-api.d.ts:3928

+

packages/extension-api/src/extension-api.d.ts:3928


sendEventData()​

@@ -60,6 +60,6 @@ as its TelemetryLogger is being di

Returns​

void

Source​

-

packages/extension-api/src/extension-api.d.ts:3919

+

packages/extension-api/src/extension-api.d.ts:3919

\ No newline at end of file diff --git a/api/interfaces/ThrottlingData.html b/api/interfaces/ThrottlingData.html index 26aa520de16..b2a73b9a5f4 100644 --- a/api/interfaces/ThrottlingData.html +++ b/api/interfaces/ThrottlingData.html @@ -13,7 +13,7 @@ - + @@ -24,20 +24,20 @@

periods: number

Source​

-

packages/extension-api/src/extension-api.d.ts:2855

+

packages/extension-api/src/extension-api.d.ts:2855


throttled_periods​

throttled_periods: number

Source​

-

packages/extension-api/src/extension-api.d.ts:2856

+

packages/extension-api/src/extension-api.d.ts:2856


throttled_time​

throttled_time: number

Source​

-

packages/extension-api/src/extension-api.d.ts:2857

+

packages/extension-api/src/extension-api.d.ts:2857

\ No newline at end of file diff --git a/api/interfaces/UnregisterContainerConnectionEvent.html b/api/interfaces/UnregisterContainerConnectionEvent.html index 06dd3a6e97f..3c1aa596f5d 100644 --- a/api/interfaces/UnregisterContainerConnectionEvent.html +++ b/api/interfaces/UnregisterContainerConnectionEvent.html @@ -13,7 +13,7 @@ - + @@ -24,6 +24,6 @@

providerId: string

Source​

-

packages/extension-api/src/extension-api.d.ts:527

+

packages/extension-api/src/extension-api.d.ts:527

\ No newline at end of file diff --git a/api/interfaces/UnregisterKubernetesConnectionEvent.html b/api/interfaces/UnregisterKubernetesConnectionEvent.html index 6ce9ab3d2b1..eaa10429e1f 100644 --- a/api/interfaces/UnregisterKubernetesConnectionEvent.html +++ b/api/interfaces/UnregisterKubernetesConnectionEvent.html @@ -13,7 +13,7 @@ - + @@ -24,6 +24,6 @@

providerId: string

Source​

-

packages/extension-api/src/extension-api.d.ts:530

+

packages/extension-api/src/extension-api.d.ts:530

\ No newline at end of file diff --git a/api/interfaces/UpdateContainerConnectionEvent.html b/api/interfaces/UpdateContainerConnectionEvent.html index 2f8c2de9aa0..4f2929a8069 100644 --- a/api/interfaces/UpdateContainerConnectionEvent.html +++ b/api/interfaces/UpdateContainerConnectionEvent.html @@ -13,7 +13,7 @@ - + @@ -24,20 +24,20 @@

connection: ContainerProviderConnection

Source​

-

packages/extension-api/src/extension-api.d.ts:516

+

packages/extension-api/src/extension-api.d.ts:516


providerId​

providerId: string

Source​

-

packages/extension-api/src/extension-api.d.ts:515

+

packages/extension-api/src/extension-api.d.ts:515


status​

status: ProviderConnectionStatus

Source​

-

packages/extension-api/src/extension-api.d.ts:517

+

packages/extension-api/src/extension-api.d.ts:517

\ No newline at end of file diff --git a/api/interfaces/UpdateKubernetesConnectionEvent.html b/api/interfaces/UpdateKubernetesConnectionEvent.html index b07f592a000..4309d216fd0 100644 --- a/api/interfaces/UpdateKubernetesConnectionEvent.html +++ b/api/interfaces/UpdateKubernetesConnectionEvent.html @@ -13,7 +13,7 @@ - + @@ -24,20 +24,20 @@

connection: KubernetesProviderConnection

Source​

-

packages/extension-api/src/extension-api.d.ts:522

+

packages/extension-api/src/extension-api.d.ts:522


providerId​

providerId: string

Source​

-

packages/extension-api/src/extension-api.d.ts:521

+

packages/extension-api/src/extension-api.d.ts:521


status​

status: ProviderConnectionStatus

Source​

-

packages/extension-api/src/extension-api.d.ts:523

+

packages/extension-api/src/extension-api.d.ts:523

\ No newline at end of file diff --git a/api/interfaces/VolumeCreateOptions.html b/api/interfaces/VolumeCreateOptions.html index af4468706b2..f68b1e7e231 100644 --- a/api/interfaces/VolumeCreateOptions.html +++ b/api/interfaces/VolumeCreateOptions.html @@ -13,7 +13,7 @@ - + @@ -24,13 +24,13 @@

Name: string

Source​

-

packages/extension-api/src/extension-api.d.ts:3120

+

packages/extension-api/src/extension-api.d.ts:3120


provider?​

optional provider: ContainerProviderConnection

Source​

-

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/VolumeCreateResponseInfo.html b/api/interfaces/VolumeCreateResponseInfo.html index 96b8b34a140..f08296256f6 100644 --- a/api/interfaces/VolumeCreateResponseInfo.html +++ b/api/interfaces/VolumeCreateResponseInfo.html @@ -13,7 +13,7 @@ - + @@ -24,14 +24,14 @@

optional CreatedAt: string

Source​

-

packages/extension-api/src/extension-api.d.ts:3134

+

packages/extension-api/src/extension-api.d.ts:3134


Driver​

Driver: string

Source​

-

packages/extension-api/src/extension-api.d.ts:3132

+

packages/extension-api/src/extension-api.d.ts:3132


Labels​

@@ -40,28 +40,28 @@

Index signature​

[label: string]: string

Source​

-

packages/extension-api/src/extension-api.d.ts:3136

+

packages/extension-api/src/extension-api.d.ts:3136


Mountpoint​

Mountpoint: string

Source​

-

packages/extension-api/src/extension-api.d.ts:3133

+

packages/extension-api/src/extension-api.d.ts:3133


Name​

Name: string

Source​

-

packages/extension-api/src/extension-api.d.ts:3131

+

packages/extension-api/src/extension-api.d.ts:3131


Scope​

Scope: string

Source​

-

packages/extension-api/src/extension-api.d.ts:3137

+

packages/extension-api/src/extension-api.d.ts:3137


Status?​

@@ -70,6 +70,6 @@

Index signature​

[key: string]: string

Source​

-

packages/extension-api/src/extension-api.d.ts:3135

+

packages/extension-api/src/extension-api.d.ts:3135

\ No newline at end of file diff --git a/api/interfaces/VolumeDeleteOptions.html b/api/interfaces/VolumeDeleteOptions.html index ec47d7c9285..6acb62dead9 100644 --- a/api/interfaces/VolumeDeleteOptions.html +++ b/api/interfaces/VolumeDeleteOptions.html @@ -13,7 +13,7 @@ - + @@ -24,6 +24,6 @@

optional provider: ContainerProviderConnection

Source​

-

packages/extension-api/src/extension-api.d.ts:3127

+

packages/extension-api/src/extension-api.d.ts:3127

\ No newline at end of file diff --git a/api/interfaces/VolumeInfo.html b/api/interfaces/VolumeInfo.html index 041837a725b..674363d20bf 100644 --- a/api/interfaces/VolumeInfo.html +++ b/api/interfaces/VolumeInfo.html @@ -13,7 +13,7 @@ - + @@ -24,14 +24,14 @@

CreatedAt: string

Source​

-

packages/extension-api/src/extension-api.d.ts:3098

+

packages/extension-api/src/extension-api.d.ts:3098


Driver​

Driver: string

Source​

-

packages/extension-api/src/extension-api.d.ts:3101

+

packages/extension-api/src/extension-api.d.ts:3101


Labels​

@@ -40,35 +40,35 @@

Index signature​

[key: string]: string

Source​

-

packages/extension-api/src/extension-api.d.ts:3104

+

packages/extension-api/src/extension-api.d.ts:3104


Mountpoint​

Mountpoint: string

Source​

-

packages/extension-api/src/extension-api.d.ts:3102

+

packages/extension-api/src/extension-api.d.ts:3102


Name​

Name: string

Source​

-

packages/extension-api/src/extension-api.d.ts:3100

+

packages/extension-api/src/extension-api.d.ts:3100


Options?​

optional Options: null | object

Source​

-

packages/extension-api/src/extension-api.d.ts:3106

+

packages/extension-api/src/extension-api.d.ts:3106


Scope​

Scope: "global" | "local"

Source​

-

packages/extension-api/src/extension-api.d.ts:3105

+

packages/extension-api/src/extension-api.d.ts:3105


Status?​

@@ -77,34 +77,34 @@

Index signature​

[key: string]: string

Source​

-

packages/extension-api/src/extension-api.d.ts:3103

+

packages/extension-api/src/extension-api.d.ts:3103


UsageData?​

optional UsageData: null | object

Source​

-

packages/extension-api/src/extension-api.d.ts:3107

+

packages/extension-api/src/extension-api.d.ts:3107


containersUsage​

containersUsage: object[]

Source​

-

packages/extension-api/src/extension-api.d.ts:3099

+

packages/extension-api/src/extension-api.d.ts:3099


engineId​

engineId: string

Source​

-

packages/extension-api/src/extension-api.d.ts:3096

+

packages/extension-api/src/extension-api.d.ts:3096


engineName​

engineName: string

Source​

-

packages/extension-api/src/extension-api.d.ts:3097

+

packages/extension-api/src/extension-api.d.ts:3097

\ No newline at end of file diff --git a/api/interfaces/VolumeListInfo.html b/api/interfaces/VolumeListInfo.html index 171ab8354d1..4ad255808c6 100644 --- a/api/interfaces/VolumeListInfo.html +++ b/api/interfaces/VolumeListInfo.html @@ -13,7 +13,7 @@ - + @@ -24,27 +24,27 @@

Volumes: VolumeInfo[]

Source​

-

packages/extension-api/src/extension-api.d.ts:3113

+

packages/extension-api/src/extension-api.d.ts:3113


Warnings​

Warnings: string[]

Source​

-

packages/extension-api/src/extension-api.d.ts:3114

+

packages/extension-api/src/extension-api.d.ts:3114


engineId​

engineId: string

Source​

-

packages/extension-api/src/extension-api.d.ts:3115

+

packages/extension-api/src/extension-api.d.ts:3115


engineName​

engineName: string

Source​

-

packages/extension-api/src/extension-api.d.ts:3116

+

packages/extension-api/src/extension-api.d.ts:3116

\ No newline at end of file diff --git a/api/interfaces/Webview.html b/api/interfaces/Webview.html index 43d0e5e3d71..9ed9d48130c 100644 --- a/api/interfaces/Webview.html +++ b/api/interfaces/Webview.html @@ -13,7 +13,7 @@ - + @@ -26,7 +26,7 @@

Content security policy source for webview resources.

Source​

-

packages/extension-api/src/extension-api.d.ts:1432

+

packages/extension-api/src/extension-api.d.ts:1432


html​

@@ -35,7 +35,7 @@

HTML contents of the webview.

This should be a complete, valid html document. Changing this property causes the webview to be reloaded.

Source​

-

packages/extension-api/src/extension-api.d.ts:1409

+

packages/extension-api/src/extension-api.d.ts:1409


onDidReceiveMessage​

@@ -44,7 +44,7 @@

Fired when the webview content posts a message.

Webview content can post strings or json serializable objects back to an extension.

Source​

-

packages/extension-api/src/extension-api.d.ts:1416

+

packages/extension-api/src/extension-api.d.ts:1416


options​

@@ -52,7 +52,7 @@

Content settings for the webview.

Source​

-

packages/extension-api/src/extension-api.d.ts:1401

+

packages/extension-api/src/extension-api.d.ts:1401

Methods​

asWebviewUri()​

@@ -64,7 +64,7 @@

Returns​

Uri

Source​

-

packages/extension-api/src/extension-api.d.ts:1426

+

packages/extension-api/src/extension-api.d.ts:1426


postMessage()​

@@ -76,6 +76,6 @@

Returns​

Promise< boolean >

Source​

-

packages/extension-api/src/extension-api.d.ts:1421

+

packages/extension-api/src/extension-api.d.ts:1421

\ No newline at end of file diff --git a/api/interfaces/WebviewInfo.html b/api/interfaces/WebviewInfo.html index 48e35db147f..637f9e54645 100644 --- a/api/interfaces/WebviewInfo.html +++ b/api/interfaces/WebviewInfo.html @@ -13,7 +13,7 @@ - + @@ -24,20 +24,20 @@

id: string

Source​

-

packages/extension-api/src/extension-api.d.ts:2753

+

packages/extension-api/src/extension-api.d.ts:2753


title​

title: string

Source​

-

packages/extension-api/src/extension-api.d.ts:2755

+

packages/extension-api/src/extension-api.d.ts:2755


viewType​

viewType: string

Source​

-

packages/extension-api/src/extension-api.d.ts:2754

+

packages/extension-api/src/extension-api.d.ts:2754

\ No newline at end of file diff --git a/api/interfaces/WebviewOptions.html b/api/interfaces/WebviewOptions.html index 273910b158a..363f9ed0c16 100644 --- a/api/interfaces/WebviewOptions.html +++ b/api/interfaces/WebviewOptions.html @@ -13,7 +13,7 @@ - + @@ -28,6 +28,6 @@

Default to the root folders of the current workspace plus the extension's install directory.

Pass in an empty array to disallow access to any local resources.

Source​

-

packages/extension-api/src/extension-api.d.ts:1391

+

packages/extension-api/src/extension-api.d.ts:1391

\ No newline at end of file diff --git a/api/interfaces/WebviewPanel.html b/api/interfaces/WebviewPanel.html index 741473ad2e5..702504509db 100644 --- a/api/interfaces/WebviewPanel.html +++ b/api/interfaces/WebviewPanel.html @@ -13,7 +13,7 @@ - + @@ -26,7 +26,7 @@

Whether the panel is active (focused by the user).

Source​

-

packages/extension-api/src/extension-api.d.ts:1473

+

packages/extension-api/src/extension-api.d.ts:1473


iconPath?​

@@ -34,7 +34,7 @@

Icon for the panel shown in UI.

Source​

-

packages/extension-api/src/extension-api.d.ts:1452

+

packages/extension-api/src/extension-api.d.ts:1452


onDidChangeViewState​

@@ -42,7 +42,7 @@

Fired when the panel's view state changes.

Source​

-

packages/extension-api/src/extension-api.d.ts:1483

+

packages/extension-api/src/extension-api.d.ts:1483


onDidDispose​

@@ -53,7 +53,7 @@ called on it.

Trying to use the panel after it has been disposed throws an exception.

Source​

-

packages/extension-api/src/extension-api.d.ts:1493

+

packages/extension-api/src/extension-api.d.ts:1493


title​

@@ -61,7 +61,7 @@ called on it.

Title of the panel shown in UI.

Source​

-

packages/extension-api/src/extension-api.d.ts:1447

+

packages/extension-api/src/extension-api.d.ts:1447


viewType​

@@ -69,7 +69,7 @@ called on it.

Identifies the type of the webview panel.

Source​

-

packages/extension-api/src/extension-api.d.ts:1442

+

packages/extension-api/src/extension-api.d.ts:1442


visible​

@@ -77,7 +77,7 @@ called on it.

Whether the panel is visible.

Source​

-

packages/extension-api/src/extension-api.d.ts:1478

+

packages/extension-api/src/extension-api.d.ts:1478


webview​

@@ -85,7 +85,7 @@ called on it.

Webview belonging to the panel.

Source​

-

packages/extension-api/src/extension-api.d.ts:1468

+

packages/extension-api/src/extension-api.d.ts:1468

Methods​

dispose()​

@@ -98,7 +98,7 @@ fire the onDispose event.

Returns​

void

Source​

-

packages/extension-api/src/extension-api.d.ts:1508

+

packages/extension-api/src/extension-api.d.ts:1508


reveal()​

@@ -111,6 +111,6 @@ fire the onDispose event.

Returns​

void

Source​

-

packages/extension-api/src/extension-api.d.ts:1499

+

packages/extension-api/src/extension-api.d.ts:1499

\ No newline at end of file diff --git a/api/interfaces/WebviewPanelOnDidChangeViewStateEvent.html b/api/interfaces/WebviewPanelOnDidChangeViewStateEvent.html index c64948aaa0b..9c542982a4e 100644 --- a/api/interfaces/WebviewPanelOnDidChangeViewStateEvent.html +++ b/api/interfaces/WebviewPanelOnDidChangeViewStateEvent.html @@ -13,7 +13,7 @@ - + @@ -26,6 +26,6 @@

Webview panel whose view state changed.

Source​

-

packages/extension-api/src/extension-api.d.ts:1580

+

packages/extension-api/src/extension-api.d.ts:1580

\ No newline at end of file diff --git a/api/namespaces/authentication.html b/api/namespaces/authentication.html index 0f5a57801d7..7cc2ba203a2 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 71034300652..ec56710a666 100644 --- a/api/namespaces/authentication/functions/getSession.html +++ b/api/namespaces/authentication/functions/getSession.html @@ -13,7 +13,7 @@ - + @@ -39,7 +39,7 @@ to VS Code that implement GitHub and Microsoft authentication: their providerId&

Promise< AuthenticationSession | undefined >

A promise that resolves to an authentication session

Source​

-

packages/extension-api/src/extension-api.d.ts:3606

+

packages/extension-api/src/extension-api.d.ts:3606

getSession(providerId, scopes, options)​

getSession(providerId, scopes, options?): Promise< AuthenticationSession | undefined >

@@ -61,6 +61,6 @@ to VS Code that implement GitHub and Microsoft authentication: their providerId&

Promise< AuthenticationSession | undefined >

A promise that resolves to an authentication session if available, or undefined if there are no sessions

Source​

-

packages/extension-api/src/extension-api.d.ts:3625

+

packages/extension-api/src/extension-api.d.ts:3625

\ No newline at end of file diff --git a/api/namespaces/authentication/functions/onDidChangeSessions.html b/api/namespaces/authentication/functions/onDidChangeSessions.html index 7ae1d3f4dcf..7590261f1c6 100644 --- a/api/namespaces/authentication/functions/onDidChangeSessions.html +++ b/api/namespaces/authentication/functions/onDidChangeSessions.html @@ -13,7 +13,7 @@ - + @@ -30,6 +30,6 @@ been added, removed, or changed.

Returns​

Disposable

Source​

-

packages/extension-api/src/extension-api.d.ts:3635

+

packages/extension-api/src/extension-api.d.ts:3635

\ No newline at end of file diff --git a/api/namespaces/authentication/functions/registerAuthenticationProvider.html b/api/namespaces/authentication/functions/registerAuthenticationProvider.html index 0296278ed05..fff1b882c06 100644 --- a/api/namespaces/authentication/functions/registerAuthenticationProvider.html +++ b/api/namespaces/authentication/functions/registerAuthenticationProvider.html @@ -13,7 +13,7 @@ - + @@ -38,6 +38,6 @@ has already been used by another provider. Ids are case-sensitive.

Params​

options Additional options for the provider.

Source​

-

packages/extension-api/src/extension-api.d.ts:3649

+

packages/extension-api/src/extension-api.d.ts:3649

\ No newline at end of file diff --git a/api/namespaces/cli.html b/api/namespaces/cli.html index 082ec4944c7..8ffa6f1e6eb 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 c3f85dc64bf..6c2737ee9b7 100644 --- a/api/namespaces/cli/functions/createCliTool.html +++ b/api/namespaces/cli/functions/createCliTool.html @@ -13,7 +13,7 @@ - + @@ -29,6 +29,6 @@

CliTool

CliTool instance

Source​

-

packages/extension-api/src/extension-api.d.ts:4064

+

packages/extension-api/src/extension-api.d.ts:4064

\ No newline at end of file diff --git a/api/namespaces/commands.html b/api/namespaces/commands.html index cd3b4b0da4f..3e8f812b9d5 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 e28d37a6010..6688a17b230 100644 --- a/api/namespaces/commands/functions/executeCommand.html +++ b/api/namespaces/commands/functions/executeCommand.html @@ -13,7 +13,7 @@ - + @@ -38,6 +38,6 @@

Throws​

if the command throws an exception

Source​

-

packages/extension-api/src/extension-api.d.ts:505

+

packages/extension-api/src/extension-api.d.ts:505

\ No newline at end of file diff --git a/api/namespaces/commands/functions/registerCommand.html b/api/namespaces/commands/functions/registerCommand.html index ed92fba80e9..a72518c3cd3 100644 --- a/api/namespaces/commands/functions/registerCommand.html +++ b/api/namespaces/commands/functions/registerCommand.html @@ -13,7 +13,7 @@ - + @@ -35,6 +35,6 @@

Throws​

if a command with the same name is already registered.

Source​

-

packages/extension-api/src/extension-api.d.ts:493

+

packages/extension-api/src/extension-api.d.ts:493

\ No newline at end of file diff --git a/api/namespaces/configuration.html b/api/namespaces/configuration.html index 7d104cea0e8..09bd6361d97 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 1100344a924..ebf4d913927 100644 --- a/api/namespaces/configuration/functions/getConfiguration.html +++ b/api/namespaces/configuration/functions/getConfiguration.html @@ -13,7 +13,7 @@ - + @@ -27,6 +27,6 @@

Returns​

Configuration

Source​

-

packages/extension-api/src/extension-api.d.ts:651

+

packages/extension-api/src/extension-api.d.ts:651

\ No newline at end of file diff --git a/api/namespaces/configuration/functions/onDidChangeConfiguration.html b/api/namespaces/configuration/functions/onDidChangeConfiguration.html index fccaf0b2ea4..befd13bade4 100644 --- a/api/namespaces/configuration/functions/onDidChangeConfiguration.html +++ b/api/namespaces/configuration/functions/onDidChangeConfiguration.html @@ -13,7 +13,7 @@ - + @@ -29,6 +29,6 @@

Returns​

Disposable

Source​

-

packages/extension-api/src/extension-api.d.ts:656

+

packages/extension-api/src/extension-api.d.ts:656

\ No newline at end of file diff --git a/api/namespaces/containerEngine.html b/api/namespaces/containerEngine.html index e9b6e03befd..d92ba8027ae 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 3b75b01e95b..e713d1fcc62 100644 --- a/api/namespaces/containerEngine/functions/buildImage.html +++ b/api/namespaces/containerEngine/functions/buildImage.html @@ -13,7 +13,7 @@ - + @@ -32,6 +32,6 @@

Returns​

Promise< unknown >

Source​

-

packages/extension-api/src/extension-api.d.ts:3251

+

packages/extension-api/src/extension-api.d.ts:3251

\ No newline at end of file diff --git a/api/namespaces/containerEngine/functions/createContainer.html b/api/namespaces/containerEngine/functions/createContainer.html index c6ceeb2b04b..15b3406e525 100644 --- a/api/namespaces/containerEngine/functions/createContainer.html +++ b/api/namespaces/containerEngine/functions/createContainer.html @@ -13,7 +13,7 @@ - + @@ -31,6 +31,6 @@

Promise< ContainerCreateResult >

A promise resolving to the information on the created container

Source​

-

packages/extension-api/src/extension-api.d.ts:3176

+

packages/extension-api/src/extension-api.d.ts:3176

\ No newline at end of file diff --git a/api/namespaces/containerEngine/functions/createManifest.html b/api/namespaces/containerEngine/functions/createManifest.html index 38dd8da58a3..ae5ad65da36 100644 --- a/api/namespaces/containerEngine/functions/createManifest.html +++ b/api/namespaces/containerEngine/functions/createManifest.html @@ -13,7 +13,7 @@ - + @@ -36,6 +36,6 @@

Source​

-

packages/extension-api/src/extension-api.d.ts:3386

+

packages/extension-api/src/extension-api.d.ts:3386

\ No newline at end of file diff --git a/api/namespaces/containerEngine/functions/createNetwork.html b/api/namespaces/containerEngine/functions/createNetwork.html index feb284e3d8d..d48faf544f5 100644 --- a/api/namespaces/containerEngine/functions/createNetwork.html +++ b/api/namespaces/containerEngine/functions/createNetwork.html @@ -13,7 +13,7 @@ - + @@ -27,6 +27,6 @@

Returns​

Promise< NetworkCreateResult >

Source​

-

packages/extension-api/src/extension-api.d.ts:3365

+

packages/extension-api/src/extension-api.d.ts:3365

\ No newline at end of file diff --git a/api/namespaces/containerEngine/functions/createPod.html b/api/namespaces/containerEngine/functions/createPod.html index fdb7a2795e8..7821dbf0add 100644 --- a/api/namespaces/containerEngine/functions/createPod.html +++ b/api/namespaces/containerEngine/functions/createPod.html @@ -13,7 +13,7 @@ - + @@ -36,6 +36,6 @@

Source​

-

packages/extension-api/src/extension-api.d.ts:3374

+

packages/extension-api/src/extension-api.d.ts:3374

\ No newline at end of file diff --git a/api/namespaces/containerEngine/functions/createVolume.html b/api/namespaces/containerEngine/functions/createVolume.html index fc9cb487d7f..ffcbcbf2db6 100644 --- a/api/namespaces/containerEngine/functions/createVolume.html +++ b/api/namespaces/containerEngine/functions/createVolume.html @@ -13,7 +13,7 @@ - + @@ -26,6 +26,6 @@

Returns​

Promise< VolumeCreateResponseInfo >

Source​

-

packages/extension-api/src/extension-api.d.ts:3371

+

packages/extension-api/src/extension-api.d.ts:3371

\ No newline at end of file diff --git a/api/namespaces/containerEngine/functions/deleteContainer.html b/api/namespaces/containerEngine/functions/deleteContainer.html index 907312e5fc4..3a8d0d0d290 100644 --- a/api/namespaces/containerEngine/functions/deleteContainer.html +++ b/api/namespaces/containerEngine/functions/deleteContainer.html @@ -13,7 +13,7 @@ - + @@ -30,6 +30,6 @@

Returns​

Promise< void >

Source​

-

packages/extension-api/src/extension-api.d.ts:3243

+

packages/extension-api/src/extension-api.d.ts:3243

\ No newline at end of file diff --git a/api/namespaces/containerEngine/functions/deleteImage.html b/api/namespaces/containerEngine/functions/deleteImage.html index ad66f978da5..faffa281dba 100644 --- a/api/namespaces/containerEngine/functions/deleteImage.html +++ b/api/namespaces/containerEngine/functions/deleteImage.html @@ -13,7 +13,7 @@ - + @@ -30,6 +30,6 @@

Returns​

Promise< void >

Source​

-

packages/extension-api/src/extension-api.d.ts:3331

+

packages/extension-api/src/extension-api.d.ts:3331

\ No newline at end of file diff --git a/api/namespaces/containerEngine/functions/deleteVolume.html b/api/namespaces/containerEngine/functions/deleteVolume.html index 8d0368a1091..1933122d36c 100644 --- a/api/namespaces/containerEngine/functions/deleteVolume.html +++ b/api/namespaces/containerEngine/functions/deleteVolume.html @@ -13,7 +13,7 @@ - + @@ -27,6 +27,6 @@

Returns​

Promise< void >

Source​

-

packages/extension-api/src/extension-api.d.ts:3372

+

packages/extension-api/src/extension-api.d.ts:3372

\ No newline at end of file diff --git a/api/namespaces/containerEngine/functions/getImageInspect.html b/api/namespaces/containerEngine/functions/getImageInspect.html index 5824b019f61..bb23be0f737 100644 --- a/api/namespaces/containerEngine/functions/getImageInspect.html +++ b/api/namespaces/containerEngine/functions/getImageInspect.html @@ -13,7 +13,7 @@ - + @@ -31,6 +31,6 @@

Promise< ImageInspectInfo >

A promise resolving to a structure containing the image information

Source​

-

packages/extension-api/src/extension-api.d.ts:3340

+

packages/extension-api/src/extension-api.d.ts:3340

\ No newline at end of file diff --git a/api/namespaces/containerEngine/functions/info.html b/api/namespaces/containerEngine/functions/info.html index 36369194bbb..45fdaf378d0 100644 --- a/api/namespaces/containerEngine/functions/info.html +++ b/api/namespaces/containerEngine/functions/info.html @@ -13,7 +13,7 @@ - + @@ -26,6 +26,6 @@

Returns​

Promise< ContainerEngineInfo >

Source​

-

packages/extension-api/src/extension-api.d.ts:3342

+

packages/extension-api/src/extension-api.d.ts:3342

\ No newline at end of file diff --git a/api/namespaces/containerEngine/functions/inspectContainer.html b/api/namespaces/containerEngine/functions/inspectContainer.html index 813542bc2f4..59bbac9e281 100644 --- a/api/namespaces/containerEngine/functions/inspectContainer.html +++ b/api/namespaces/containerEngine/functions/inspectContainer.html @@ -13,7 +13,7 @@ - + @@ -31,6 +31,6 @@

Promise< ContainerInspectInfo >

A promise resolving to a structure containing the container information

Source​

-

packages/extension-api/src/extension-api.d.ts:3167

+

packages/extension-api/src/extension-api.d.ts:3167

\ No newline at end of file diff --git a/api/namespaces/containerEngine/functions/listContainers.html b/api/namespaces/containerEngine/functions/listContainers.html index bf8b454170f..ccbf6612b86 100644 --- a/api/namespaces/containerEngine/functions/listContainers.html +++ b/api/namespaces/containerEngine/functions/listContainers.html @@ -13,7 +13,7 @@ - + @@ -26,6 +26,6 @@

Promise< ContainerInfo[] >

A promise resolving to an array of containers information. This method returns a subset of the available information for containers. To get the complete description of a specific container, you can use the containerEngine.inspectContainer method.

Source​

-

packages/extension-api/src/extension-api.d.ts:3158

+

packages/extension-api/src/extension-api.d.ts:3158

\ No newline at end of file diff --git a/api/namespaces/containerEngine/functions/listImages.html b/api/namespaces/containerEngine/functions/listImages.html index 6bebf00dc4f..4f352ad5014 100644 --- a/api/namespaces/containerEngine/functions/listImages.html +++ b/api/namespaces/containerEngine/functions/listImages.html @@ -13,7 +13,7 @@ - + @@ -33,6 +33,6 @@

Example​

// Example 2: List container images for a specific provider.
const provider = provider.getContainerConnections().find(connection => connection.connection.status() === 'started');
const images = await listImages({ provider: provider.connection });
console.log(images);

Source​

-

packages/extension-api/src/extension-api.d.ts:3283

+

packages/extension-api/src/extension-api.d.ts:3283

\ No newline at end of file diff --git a/api/namespaces/containerEngine/functions/listInfos.html b/api/namespaces/containerEngine/functions/listInfos.html index e550f320257..0ed31b5f993 100644 --- a/api/namespaces/containerEngine/functions/listInfos.html +++ b/api/namespaces/containerEngine/functions/listInfos.html @@ -13,7 +13,7 @@ - + @@ -33,6 +33,6 @@

Example​

// Example 2: List information for a specific provider.
const provider = provider.getContainerConnections().find(connection => connection.connection.status() === 'started');
const info = await listInfos({ provider: provider.connection });
console.log(info);

Source​

-

packages/extension-api/src/extension-api.d.ts:3361

+

packages/extension-api/src/extension-api.d.ts:3361

\ No newline at end of file diff --git a/api/namespaces/containerEngine/functions/listNetworks.html b/api/namespaces/containerEngine/functions/listNetworks.html index 421a64c8c05..836a442316c 100644 --- a/api/namespaces/containerEngine/functions/listNetworks.html +++ b/api/namespaces/containerEngine/functions/listNetworks.html @@ -13,7 +13,7 @@ - + @@ -24,6 +24,6 @@

Returns​

Promise< NetworkInspectInfo[] >

Source​

-

packages/extension-api/src/extension-api.d.ts:3364

+

packages/extension-api/src/extension-api.d.ts:3364

\ No newline at end of file diff --git a/api/namespaces/containerEngine/functions/listPods.html b/api/namespaces/containerEngine/functions/listPods.html index 159634b56ba..56852328abb 100644 --- a/api/namespaces/containerEngine/functions/listPods.html +++ b/api/namespaces/containerEngine/functions/listPods.html @@ -13,7 +13,7 @@ - + @@ -24,6 +24,6 @@

Returns​

Promise< PodInfo[] >

Source​

-

packages/extension-api/src/extension-api.d.ts:3381

+

packages/extension-api/src/extension-api.d.ts:3381

\ No newline at end of file diff --git a/api/namespaces/containerEngine/functions/listVolumes.html b/api/namespaces/containerEngine/functions/listVolumes.html index 6c39e6896a6..01b732bd793 100644 --- a/api/namespaces/containerEngine/functions/listVolumes.html +++ b/api/namespaces/containerEngine/functions/listVolumes.html @@ -13,7 +13,7 @@ - + @@ -24,6 +24,6 @@

Returns​

Promise< VolumeListInfo[] >

Source​

-

packages/extension-api/src/extension-api.d.ts:3370

+

packages/extension-api/src/extension-api.d.ts:3370

\ No newline at end of file diff --git a/api/namespaces/containerEngine/functions/logsContainer.html b/api/namespaces/containerEngine/functions/logsContainer.html index e9b17820aa4..e95b4193d89 100644 --- a/api/namespaces/containerEngine/functions/logsContainer.html +++ b/api/namespaces/containerEngine/functions/logsContainer.html @@ -13,7 +13,7 @@ - + @@ -32,6 +32,6 @@

Returns​

Promise< void >

Source​

-

packages/extension-api/src/extension-api.d.ts:3196

+

packages/extension-api/src/extension-api.d.ts:3196

\ No newline at end of file diff --git a/api/namespaces/containerEngine/functions/onEvent.html b/api/namespaces/containerEngine/functions/onEvent.html index bf5a4c20dda..cef699fb089 100644 --- a/api/namespaces/containerEngine/functions/onEvent.html +++ b/api/namespaces/containerEngine/functions/onEvent.html @@ -13,7 +13,7 @@ - + @@ -32,6 +32,6 @@

Disposable

A disposable which unsubscribes the event listener.

Source​

-

packages/extension-api/src/extension-api.d.ts:3362

+

packages/extension-api/src/extension-api.d.ts:3362

\ No newline at end of file diff --git a/api/namespaces/containerEngine/functions/pullImage.html b/api/namespaces/containerEngine/functions/pullImage.html index 7f0581d8db9..1c6205a04b5 100644 --- a/api/namespaces/containerEngine/functions/pullImage.html +++ b/api/namespaces/containerEngine/functions/pullImage.html @@ -13,7 +13,7 @@ - + @@ -32,6 +32,6 @@

Returns​

Promise< void >

Source​

-

packages/extension-api/src/extension-api.d.ts:3319

+

packages/extension-api/src/extension-api.d.ts:3319

\ No newline at end of file diff --git a/api/namespaces/containerEngine/functions/pushImage.html b/api/namespaces/containerEngine/functions/pushImage.html index 08651682a2d..a3fbef0f233 100644 --- a/api/namespaces/containerEngine/functions/pushImage.html +++ b/api/namespaces/containerEngine/functions/pushImage.html @@ -13,7 +13,7 @@ - + @@ -35,6 +35,6 @@

Returns​

Promise< void >

Source​

-

packages/extension-api/src/extension-api.d.ts:3305

+

packages/extension-api/src/extension-api.d.ts:3305

\ No newline at end of file diff --git a/api/namespaces/containerEngine/functions/removePod.html b/api/namespaces/containerEngine/functions/removePod.html index 8430f017883..eb751bf1676 100644 --- a/api/namespaces/containerEngine/functions/removePod.html +++ b/api/namespaces/containerEngine/functions/removePod.html @@ -13,7 +13,7 @@ - + @@ -27,6 +27,6 @@

Returns​

Promise< void >

Source​

-

packages/extension-api/src/extension-api.d.ts:3383

+

packages/extension-api/src/extension-api.d.ts:3383

\ No newline at end of file diff --git a/api/namespaces/containerEngine/functions/replicatePodmanContainer.html b/api/namespaces/containerEngine/functions/replicatePodmanContainer.html index 2e05320cb87..47860719a08 100644 --- a/api/namespaces/containerEngine/functions/replicatePodmanContainer.html +++ b/api/namespaces/containerEngine/functions/replicatePodmanContainer.html @@ -13,7 +13,7 @@ - + @@ -41,6 +41,6 @@

Source​

-

packages/extension-api/src/extension-api.d.ts:3375

+

packages/extension-api/src/extension-api.d.ts:3375

\ No newline at end of file diff --git a/api/namespaces/containerEngine/functions/saveImage.html b/api/namespaces/containerEngine/functions/saveImage.html index 2c7a12b2fcb..fa3d028bca0 100644 --- a/api/namespaces/containerEngine/functions/saveImage.html +++ b/api/namespaces/containerEngine/functions/saveImage.html @@ -13,7 +13,7 @@ - + @@ -32,6 +32,6 @@

Returns​

Promise< void >

Source​

-

packages/extension-api/src/extension-api.d.ts:3264

+

packages/extension-api/src/extension-api.d.ts:3264

\ No newline at end of file diff --git a/api/namespaces/containerEngine/functions/startContainer.html b/api/namespaces/containerEngine/functions/startContainer.html index 0e5e803f29d..e4c4c8bccc3 100644 --- a/api/namespaces/containerEngine/functions/startContainer.html +++ b/api/namespaces/containerEngine/functions/startContainer.html @@ -13,7 +13,7 @@ - + @@ -30,6 +30,6 @@

Returns​

Promise< void >

Source​

-

packages/extension-api/src/extension-api.d.ts:3187

+

packages/extension-api/src/extension-api.d.ts:3187

\ No newline at end of file diff --git a/api/namespaces/containerEngine/functions/startPod.html b/api/namespaces/containerEngine/functions/startPod.html index f345b03583c..6df303f0b0d 100644 --- a/api/namespaces/containerEngine/functions/startPod.html +++ b/api/namespaces/containerEngine/functions/startPod.html @@ -13,7 +13,7 @@ - + @@ -27,6 +27,6 @@

Returns​

Promise< void >

Source​

-

packages/extension-api/src/extension-api.d.ts:3380

+

packages/extension-api/src/extension-api.d.ts:3380

\ No newline at end of file diff --git a/api/namespaces/containerEngine/functions/statsContainer.html b/api/namespaces/containerEngine/functions/statsContainer.html index b10a4e138a0..53679e41aef 100644 --- a/api/namespaces/containerEngine/functions/statsContainer.html +++ b/api/namespaces/containerEngine/functions/statsContainer.html @@ -13,7 +13,7 @@ - + @@ -36,6 +36,6 @@

Here is a usage example

const disposable = await statsContainer('engineId', 'containerId', (stats: ContainerStatsInfo): void => {
console.log('CPU Usage', stats.cpu_stats.cpu_usage.total_usage);
});

// When no longer needed
disposable.dispose();

Source​

-

packages/extension-api/src/extension-api.d.ts:3222

+

packages/extension-api/src/extension-api.d.ts:3222

\ No newline at end of file diff --git a/api/namespaces/containerEngine/functions/stopContainer.html b/api/namespaces/containerEngine/functions/stopContainer.html index d4018542a79..fbc6bb2432b 100644 --- a/api/namespaces/containerEngine/functions/stopContainer.html +++ b/api/namespaces/containerEngine/functions/stopContainer.html @@ -13,7 +13,7 @@ - + @@ -30,6 +30,6 @@

Returns​

Promise< void >

Source​

-

packages/extension-api/src/extension-api.d.ts:3234

+

packages/extension-api/src/extension-api.d.ts:3234

\ No newline at end of file diff --git a/api/namespaces/containerEngine/functions/stopPod.html b/api/namespaces/containerEngine/functions/stopPod.html index 1dbd1019a0f..dc1935cf38c 100644 --- a/api/namespaces/containerEngine/functions/stopPod.html +++ b/api/namespaces/containerEngine/functions/stopPod.html @@ -13,7 +13,7 @@ - + @@ -27,6 +27,6 @@

Returns​

Promise< void >

Source​

-

packages/extension-api/src/extension-api.d.ts:3382

+

packages/extension-api/src/extension-api.d.ts:3382

\ No newline at end of file diff --git a/api/namespaces/containerEngine/functions/tagImage.html b/api/namespaces/containerEngine/functions/tagImage.html index d4b3df1b6aa..2071d2749bd 100644 --- a/api/namespaces/containerEngine/functions/tagImage.html +++ b/api/namespaces/containerEngine/functions/tagImage.html @@ -13,7 +13,7 @@ - + @@ -34,6 +34,6 @@

Returns​

Promise< void >

Source​

-

packages/extension-api/src/extension-api.d.ts:3293

+

packages/extension-api/src/extension-api.d.ts:3293

\ No newline at end of file diff --git a/api/namespaces/context.html b/api/namespaces/context.html index 8e42a7d6f92..00707b9c575 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 10ac722f300..f4326c37fe8 100644 --- a/api/namespaces/context/functions/setValue.html +++ b/api/namespaces/context/functions/setValue.html @@ -13,7 +13,7 @@ - + @@ -34,6 +34,6 @@ The key should consists of '"extension-id"."actual-key"

Returns​

void

Source​

-

packages/extension-api/src/extension-api.d.ts:3991

+

packages/extension-api/src/extension-api.d.ts:3991

\ No newline at end of file diff --git a/api/namespaces/env.html b/api/namespaces/env.html index 1c332abb9cc..f80694a5165 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 0ee0aeae71c..dba317e29ec 100644 --- a/api/namespaces/env/functions/createTelemetryLogger.html +++ b/api/namespaces/env/functions/createTelemetryLogger.html @@ -13,7 +13,7 @@ - + @@ -31,6 +31,6 @@

TelemetryLogger

A new telemetry logger

Source​

-

packages/extension-api/src/extension-api.d.ts:3712

+

packages/extension-api/src/extension-api.d.ts:3712

\ No newline at end of file diff --git a/api/namespaces/env/functions/onDidChangeTelemetryEnabled.html b/api/namespaces/env/functions/onDidChangeTelemetryEnabled.html index 0d3ce77e4a8..ba0d183b58b 100644 --- a/api/namespaces/env/functions/onDidChangeTelemetryEnabled.html +++ b/api/namespaces/env/functions/onDidChangeTelemetryEnabled.html @@ -13,7 +13,7 @@ - + @@ -30,6 +30,6 @@

Returns​

Disposable

Source​

-

packages/extension-api/src/extension-api.d.ts:3695

+

packages/extension-api/src/extension-api.d.ts:3695

\ No newline at end of file diff --git a/api/namespaces/env/functions/openExternal.html b/api/namespaces/env/functions/openExternal.html index dc6f0657627..0995ab46a73 100644 --- a/api/namespaces/env/functions/openExternal.html +++ b/api/namespaces/env/functions/openExternal.html @@ -13,7 +13,7 @@ - + @@ -28,6 +28,6 @@

Promise< boolean >

A promise indicating if open was successful.

Source​

-

packages/extension-api/src/extension-api.d.ts:3703

+

packages/extension-api/src/extension-api.d.ts:3703

\ No newline at end of file diff --git a/api/namespaces/env/variables/clipboard.html b/api/namespaces/env/variables/clipboard.html index 7e1d0fe108b..78d1a0bc580 100644 --- a/api/namespaces/env/variables/clipboard.html +++ b/api/namespaces/env/variables/clipboard.html @@ -13,7 +13,7 @@ - + @@ -23,6 +23,6 @@

The system clipboard.

Source​

-

packages/extension-api/src/extension-api.d.ts:3717

+

packages/extension-api/src/extension-api.d.ts:3717

\ No newline at end of file diff --git a/api/namespaces/env/variables/isLinux.html b/api/namespaces/env/variables/isLinux.html index 2e367a107e4..f3775263872 100644 --- a/api/namespaces/env/variables/isLinux.html +++ b/api/namespaces/env/variables/isLinux.html @@ -13,7 +13,7 @@ - + @@ -25,6 +25,6 @@

If the value of this flag is true, it means the current system is Linux. If the value is false, it means the current system is not Linux.

Source​

-

packages/extension-api/src/extension-api.d.ts:3683

+

packages/extension-api/src/extension-api.d.ts:3683

\ No newline at end of file diff --git a/api/namespaces/env/variables/isMac.html b/api/namespaces/env/variables/isMac.html index 9e811eb1cb7..e8e8c36c0a7 100644 --- a/api/namespaces/env/variables/isMac.html +++ b/api/namespaces/env/variables/isMac.html @@ -13,7 +13,7 @@ - + @@ -25,6 +25,6 @@

If the value of this flag is true, it means the current system is macOS. If the value is false, it means the current system is not macOS.

Source​

-

packages/extension-api/src/extension-api.d.ts:3667

+

packages/extension-api/src/extension-api.d.ts:3667

\ No newline at end of file diff --git a/api/namespaces/env/variables/isTelemetryEnabled.html b/api/namespaces/env/variables/isTelemetryEnabled.html index 3d9fab01e11..2d96c1f91c8 100644 --- a/api/namespaces/env/variables/isTelemetryEnabled.html +++ b/api/namespaces/env/variables/isTelemetryEnabled.html @@ -13,7 +13,7 @@ - + @@ -24,6 +24,6 @@

Indicates whether the users has telemetry enabled. Can be observed to determine if the extension should send telemetry.

Source​

-

packages/extension-api/src/extension-api.d.ts:3689

+

packages/extension-api/src/extension-api.d.ts:3689

\ No newline at end of file diff --git a/api/namespaces/env/variables/isWindows.html b/api/namespaces/env/variables/isWindows.html index df06ff0fdbd..df99dbccd55 100644 --- a/api/namespaces/env/variables/isWindows.html +++ b/api/namespaces/env/variables/isWindows.html @@ -13,7 +13,7 @@ - + @@ -25,6 +25,6 @@

If the value of this flag is true, it means the current system is Windows. If the value is false, it means the current system is not Windows.

Source​

-

packages/extension-api/src/extension-api.d.ts:3675

+

packages/extension-api/src/extension-api.d.ts:3675

\ No newline at end of file diff --git a/api/namespaces/fs.html b/api/namespaces/fs.html index 9059e8e6fb2..912209ba8ea 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 1c9b26764fe..bf8ec6fd04f 100644 --- a/api/namespaces/fs/functions/createFileSystemWatcher.html +++ b/api/namespaces/fs/functions/createFileSystemWatcher.html @@ -13,7 +13,7 @@ - + @@ -26,6 +26,6 @@

Returns​

FileSystemWatcher

Source​

-

packages/extension-api/src/extension-api.d.ts:1377

+

packages/extension-api/src/extension-api.d.ts:1377

\ No newline at end of file diff --git a/api/namespaces/imageChecker.html b/api/namespaces/imageChecker.html index 5e6f8c1498e..4d9856f5974 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 3218153107c..bac7cc02fdb 100644 --- a/api/namespaces/imageChecker/functions/registerImageCheckerProvider.html +++ b/api/namespaces/imageChecker/functions/registerImageCheckerProvider.html @@ -13,7 +13,7 @@ - + @@ -33,6 +33,6 @@ application can call the provider with specific tasks when necessary.

Disposable

A disposable that unregisters this provider when being disposed

Source​

-

packages/extension-api/src/extension-api.d.ts:4134

+

packages/extension-api/src/extension-api.d.ts:4134

\ No newline at end of file diff --git a/api/namespaces/kubernetes.html b/api/namespaces/kubernetes.html index 9d0681d9455..4b306cc6bd9 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 aeef467f72e..c79fe754a59 100644 --- a/api/namespaces/kubernetes/functions/createResources.html +++ b/api/namespaces/kubernetes/functions/createResources.html @@ -13,7 +13,7 @@ - + @@ -30,6 +30,6 @@

Returns​

Promise< void >

Source​

-

packages/extension-api/src/extension-api.d.ts:1812

+

packages/extension-api/src/extension-api.d.ts:1812

\ No newline at end of file diff --git a/api/namespaces/kubernetes/functions/getKubeconfig.html b/api/namespaces/kubernetes/functions/getKubeconfig.html index a046cbcc8aa..4cc154932fd 100644 --- a/api/namespaces/kubernetes/functions/getKubeconfig.html +++ b/api/namespaces/kubernetes/functions/getKubeconfig.html @@ -13,7 +13,7 @@ - + @@ -24,6 +24,6 @@

Returns​

Uri

Source​

-

packages/extension-api/src/extension-api.d.ts:1802

+

packages/extension-api/src/extension-api.d.ts:1802

\ No newline at end of file diff --git a/api/namespaces/kubernetes/functions/onDidUpdateKubeconfig.html b/api/namespaces/kubernetes/functions/onDidUpdateKubeconfig.html index ff7a89957fb..eb4c0fc181e 100644 --- a/api/namespaces/kubernetes/functions/onDidUpdateKubeconfig.html +++ b/api/namespaces/kubernetes/functions/onDidUpdateKubeconfig.html @@ -13,7 +13,7 @@ - + @@ -32,6 +32,6 @@

Disposable

A disposable which unsubscribes the event listener.

Source​

-

packages/extension-api/src/extension-api.d.ts:1803

+

packages/extension-api/src/extension-api.d.ts:1803

\ No newline at end of file diff --git a/api/namespaces/kubernetes/functions/registerKubernetesGenerator.html b/api/namespaces/kubernetes/functions/registerKubernetesGenerator.html index 20aee96ad8c..ee916835f60 100644 --- a/api/namespaces/kubernetes/functions/registerKubernetesGenerator.html +++ b/api/namespaces/kubernetes/functions/registerKubernetesGenerator.html @@ -13,7 +13,7 @@ - + @@ -28,6 +28,6 @@

Returns​

Disposable

Source​

-

packages/extension-api/src/extension-api.d.ts:1819

+

packages/extension-api/src/extension-api.d.ts:1819

\ No newline at end of file diff --git a/api/namespaces/kubernetes/functions/setKubeconfig.html b/api/namespaces/kubernetes/functions/setKubeconfig.html index 1037cdd370e..608e8b1433f 100644 --- a/api/namespaces/kubernetes/functions/setKubeconfig.html +++ b/api/namespaces/kubernetes/functions/setKubeconfig.html @@ -13,7 +13,7 @@ - + @@ -26,6 +26,6 @@

Returns​

Promise< void >

Source​

-

packages/extension-api/src/extension-api.d.ts:1804

+

packages/extension-api/src/extension-api.d.ts:1804

\ No newline at end of file diff --git a/api/namespaces/navigation.html b/api/namespaces/navigation.html index 6a198c17634..d48fb53edae 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 ebc3ff0e5c5..9334735ae52 100644 --- a/api/namespaces/navigation/functions/navigateToAuthentication.html +++ b/api/namespaces/navigation/functions/navigateToAuthentication.html @@ -13,7 +13,7 @@ - + @@ -25,6 +25,6 @@

Returns​

Promise< void >

Source​

-

packages/extension-api/src/extension-api.d.ts:4181

+

packages/extension-api/src/extension-api.d.ts:4181

\ No newline at end of file diff --git a/api/namespaces/navigation/functions/navigateToContainer.html b/api/namespaces/navigation/functions/navigateToContainer.html index af81e9fcdb9..3fc26f7c3a2 100644 --- a/api/namespaces/navigation/functions/navigateToContainer.html +++ b/api/namespaces/navigation/functions/navigateToContainer.html @@ -13,7 +13,7 @@ - + @@ -26,6 +26,6 @@

Returns​

Promise< void >

Source​

-

packages/extension-api/src/extension-api.d.ts:4144

+

packages/extension-api/src/extension-api.d.ts:4144

\ No newline at end of file diff --git a/api/namespaces/navigation/functions/navigateToContainerInspect.html b/api/namespaces/navigation/functions/navigateToContainerInspect.html index 320ff733cab..e0a1f9e03f0 100644 --- a/api/namespaces/navigation/functions/navigateToContainerInspect.html +++ b/api/namespaces/navigation/functions/navigateToContainerInspect.html @@ -13,7 +13,7 @@ - + @@ -26,6 +26,6 @@

Returns​

Promise< void >

Source​

-

packages/extension-api/src/extension-api.d.ts:4148

+

packages/extension-api/src/extension-api.d.ts:4148

\ No newline at end of file diff --git a/api/namespaces/navigation/functions/navigateToContainerLogs.html b/api/namespaces/navigation/functions/navigateToContainerLogs.html index bdb88cc8f26..4b3fb752480 100644 --- a/api/namespaces/navigation/functions/navigateToContainerLogs.html +++ b/api/namespaces/navigation/functions/navigateToContainerLogs.html @@ -13,7 +13,7 @@ - + @@ -26,6 +26,6 @@

Returns​

Promise< void >

Source​

-

packages/extension-api/src/extension-api.d.ts:4146

+

packages/extension-api/src/extension-api.d.ts:4146

\ No newline at end of file diff --git a/api/namespaces/navigation/functions/navigateToContainerTerminal.html b/api/namespaces/navigation/functions/navigateToContainerTerminal.html index 0268be35fb8..07b5cdb35bd 100644 --- a/api/namespaces/navigation/functions/navigateToContainerTerminal.html +++ b/api/namespaces/navigation/functions/navigateToContainerTerminal.html @@ -13,7 +13,7 @@ - + @@ -26,6 +26,6 @@

Returns​

Promise< void >

Source​

-

packages/extension-api/src/extension-api.d.ts:4150

+

packages/extension-api/src/extension-api.d.ts:4150

\ No newline at end of file diff --git a/api/namespaces/navigation/functions/navigateToContainers.html b/api/namespaces/navigation/functions/navigateToContainers.html index f688a8162c0..61cab13e992 100644 --- a/api/namespaces/navigation/functions/navigateToContainers.html +++ b/api/namespaces/navigation/functions/navigateToContainers.html @@ -13,7 +13,7 @@ - + @@ -24,6 +24,6 @@

Returns​

Promise< void >

Source​

-

packages/extension-api/src/extension-api.d.ts:4142

+

packages/extension-api/src/extension-api.d.ts:4142

\ No newline at end of file diff --git a/api/namespaces/navigation/functions/navigateToContribution.html b/api/namespaces/navigation/functions/navigateToContribution.html index 808bca5b4b3..575ad1d33e9 100644 --- a/api/namespaces/navigation/functions/navigateToContribution.html +++ b/api/namespaces/navigation/functions/navigateToContribution.html @@ -13,7 +13,7 @@ - + @@ -26,6 +26,6 @@

Returns​

Promise< void >

Source​

-

packages/extension-api/src/extension-api.d.ts:4168

+

packages/extension-api/src/extension-api.d.ts:4168

\ No newline at end of file diff --git a/api/namespaces/navigation/functions/navigateToEditProviderContainerConnection.html b/api/namespaces/navigation/functions/navigateToEditProviderContainerConnection.html index 237e7ea2099..97bbc24a8f9 100644 --- a/api/namespaces/navigation/functions/navigateToEditProviderContainerConnection.html +++ b/api/namespaces/navigation/functions/navigateToEditProviderContainerConnection.html @@ -13,7 +13,7 @@ - + @@ -27,6 +27,6 @@

Returns​

Promise< void >

Source​

-

packages/extension-api/src/extension-api.d.ts:4190

+

packages/extension-api/src/extension-api.d.ts:4190

\ No newline at end of file diff --git a/api/namespaces/navigation/functions/navigateToImage.html b/api/namespaces/navigation/functions/navigateToImage.html index 87feb220c34..6e31d1538c3 100644 --- a/api/namespaces/navigation/functions/navigateToImage.html +++ b/api/namespaces/navigation/functions/navigateToImage.html @@ -13,7 +13,7 @@ - + @@ -28,6 +28,6 @@

Returns​

Promise< void >

Source​

-

packages/extension-api/src/extension-api.d.ts:4155

+

packages/extension-api/src/extension-api.d.ts:4155

\ No newline at end of file diff --git a/api/namespaces/navigation/functions/navigateToImages.html b/api/namespaces/navigation/functions/navigateToImages.html index 5ca5aae187f..14aa4386fa4 100644 --- a/api/namespaces/navigation/functions/navigateToImages.html +++ b/api/namespaces/navigation/functions/navigateToImages.html @@ -13,7 +13,7 @@ - + @@ -24,6 +24,6 @@

Returns​

Promise< void >

Source​

-

packages/extension-api/src/extension-api.d.ts:4153

+

packages/extension-api/src/extension-api.d.ts:4153

\ No newline at end of file diff --git a/api/namespaces/navigation/functions/navigateToPod.html b/api/namespaces/navigation/functions/navigateToPod.html index f4ebbc3c90d..718db1a75b4 100644 --- a/api/namespaces/navigation/functions/navigateToPod.html +++ b/api/namespaces/navigation/functions/navigateToPod.html @@ -13,7 +13,7 @@ - + @@ -28,6 +28,6 @@

Returns​

Promise< void >

Source​

-

packages/extension-api/src/extension-api.d.ts:4165

+

packages/extension-api/src/extension-api.d.ts:4165

\ No newline at end of file diff --git a/api/namespaces/navigation/functions/navigateToPods.html b/api/namespaces/navigation/functions/navigateToPods.html index f1613e51aea..a04c7c0a873 100644 --- a/api/namespaces/navigation/functions/navigateToPods.html +++ b/api/namespaces/navigation/functions/navigateToPods.html @@ -13,7 +13,7 @@ - + @@ -24,6 +24,6 @@

Returns​

Promise< void >

Source​

-

packages/extension-api/src/extension-api.d.ts:4163

+

packages/extension-api/src/extension-api.d.ts:4163

\ No newline at end of file diff --git a/api/namespaces/navigation/functions/navigateToResources.html b/api/namespaces/navigation/functions/navigateToResources.html index 21d904e6c60..32249927086 100644 --- a/api/namespaces/navigation/functions/navigateToResources.html +++ b/api/namespaces/navigation/functions/navigateToResources.html @@ -13,7 +13,7 @@ - + @@ -25,6 +25,6 @@

Returns​

Promise< void >

Source​

-

packages/extension-api/src/extension-api.d.ts:4186

+

packages/extension-api/src/extension-api.d.ts:4186

\ No newline at end of file diff --git a/api/namespaces/navigation/functions/navigateToVolume.html b/api/namespaces/navigation/functions/navigateToVolume.html index ee788ff42bb..750e2a0ec31 100644 --- a/api/namespaces/navigation/functions/navigateToVolume.html +++ b/api/namespaces/navigation/functions/navigateToVolume.html @@ -13,7 +13,7 @@ - + @@ -27,6 +27,6 @@

Returns​

Promise< void >

Source​

-

packages/extension-api/src/extension-api.d.ts:4160

+

packages/extension-api/src/extension-api.d.ts:4160

\ No newline at end of file diff --git a/api/namespaces/navigation/functions/navigateToVolumes.html b/api/namespaces/navigation/functions/navigateToVolumes.html index 5f7d1f4aa2e..f3768ae83b9 100644 --- a/api/namespaces/navigation/functions/navigateToVolumes.html +++ b/api/namespaces/navigation/functions/navigateToVolumes.html @@ -13,7 +13,7 @@ - + @@ -24,6 +24,6 @@

Returns​

Promise< void >

Source​

-

packages/extension-api/src/extension-api.d.ts:4158

+

packages/extension-api/src/extension-api.d.ts:4158

\ No newline at end of file diff --git a/api/namespaces/navigation/functions/navigateToWebview.html b/api/namespaces/navigation/functions/navigateToWebview.html index 61252f03a84..3cb970821e9 100644 --- a/api/namespaces/navigation/functions/navigateToWebview.html +++ b/api/namespaces/navigation/functions/navigateToWebview.html @@ -13,7 +13,7 @@ - + @@ -33,6 +33,6 @@
  • createWebviewPanel for creating a Webview
  • Source​

    -

    packages/extension-api/src/extension-api.d.ts:4176

    +

    packages/extension-api/src/extension-api.d.ts:4176

    \ No newline at end of file diff --git a/api/namespaces/process.html b/api/namespaces/process.html index 0892c82e79a..59e59bbe9ef 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 2d907e0e20d..5f4325999b9 100644 --- a/api/namespaces/process/functions/exec.html +++ b/api/namespaces/process/functions/exec.html @@ -13,7 +13,7 @@ - + @@ -36,6 +36,6 @@ stdout, and stderr content.

    Throws​

    RunError if provided command can not be executed.

    Source​

    -

    packages/extension-api/src/extension-api.d.ts:3828

    +

    packages/extension-api/src/extension-api.d.ts:3828

    \ No newline at end of file diff --git a/api/namespaces/provider.html b/api/namespaces/provider.html index 4849d857ff0..432a18e6d0a 100644 --- a/api/namespaces/provider.html +++ b/api/namespaces/provider.html @@ -13,7 +13,7 @@ - + diff --git a/api/namespaces/provider/functions/createProvider.html b/api/namespaces/provider/functions/createProvider.html index d3e3b1acef3..bdd9ec20220 100644 --- a/api/namespaces/provider/functions/createProvider.html +++ b/api/namespaces/provider/functions/createProvider.html @@ -13,7 +13,7 @@ - + @@ -26,6 +26,6 @@

    Returns​

    Provider

    Source​

    -

    packages/extension-api/src/extension-api.d.ts:545

    +

    packages/extension-api/src/extension-api.d.ts:545

    \ No newline at end of file diff --git a/api/namespaces/provider/functions/getContainerConnections.html b/api/namespaces/provider/functions/getContainerConnections.html index 9940e6e5051..0c6ef48dbb4 100644 --- a/api/namespaces/provider/functions/getContainerConnections.html +++ b/api/namespaces/provider/functions/getContainerConnections.html @@ -13,7 +13,7 @@ - + @@ -24,6 +24,6 @@

    Returns​

    ProviderContainerConnection[]

    Source​

    -

    packages/extension-api/src/extension-api.d.ts:551

    +

    packages/extension-api/src/extension-api.d.ts:551

    \ No newline at end of file diff --git a/api/namespaces/provider/functions/getProviderLifecycleContext.html b/api/namespaces/provider/functions/getProviderLifecycleContext.html index e78bdc9433c..57c11ab8530 100644 --- a/api/namespaces/provider/functions/getProviderLifecycleContext.html +++ b/api/namespaces/provider/functions/getProviderLifecycleContext.html @@ -13,7 +13,7 @@ - + @@ -34,6 +34,6 @@ If no context is found it throws an error

    Throws​

    if no provider with the id has been found or there is no context associate to it.

    Source​

    -

    packages/extension-api/src/extension-api.d.ts:561

    +

    packages/extension-api/src/extension-api.d.ts:561

    \ No newline at end of file diff --git a/api/namespaces/provider/functions/onDidRegisterContainerConnection.html b/api/namespaces/provider/functions/onDidRegisterContainerConnection.html index 8b055f9dbf7..a2070a86e09 100644 --- a/api/namespaces/provider/functions/onDidRegisterContainerConnection.html +++ b/api/namespaces/provider/functions/onDidRegisterContainerConnection.html @@ -13,7 +13,7 @@ - + @@ -32,6 +32,6 @@

    Disposable

    A disposable which unsubscribes the event listener.

    Source​

    -

    packages/extension-api/src/extension-api.d.ts:550

    +

    packages/extension-api/src/extension-api.d.ts:550

    \ No newline at end of file diff --git a/api/namespaces/provider/functions/onDidUnregisterContainerConnection.html b/api/namespaces/provider/functions/onDidUnregisterContainerConnection.html index 15f152c9af1..cfa5c8f4a9b 100644 --- a/api/namespaces/provider/functions/onDidUnregisterContainerConnection.html +++ b/api/namespaces/provider/functions/onDidUnregisterContainerConnection.html @@ -13,7 +13,7 @@ - + @@ -32,6 +32,6 @@

    Disposable

    A disposable which unsubscribes the event listener.

    Source​

    -

    packages/extension-api/src/extension-api.d.ts:549

    +

    packages/extension-api/src/extension-api.d.ts:549

    \ No newline at end of file diff --git a/api/namespaces/provider/functions/onDidUpdateContainerConnection.html b/api/namespaces/provider/functions/onDidUpdateContainerConnection.html index ebe3e735191..719223726aa 100644 --- a/api/namespaces/provider/functions/onDidUpdateContainerConnection.html +++ b/api/namespaces/provider/functions/onDidUpdateContainerConnection.html @@ -13,7 +13,7 @@ - + @@ -32,6 +32,6 @@

    Disposable

    A disposable which unsubscribes the event listener.

    Source​

    -

    packages/extension-api/src/extension-api.d.ts:547

    +

    packages/extension-api/src/extension-api.d.ts:547

    \ No newline at end of file diff --git a/api/namespaces/provider/functions/onDidUpdateKubernetesConnection.html b/api/namespaces/provider/functions/onDidUpdateKubernetesConnection.html index f2f03d38b69..1189e1d6ffb 100644 --- a/api/namespaces/provider/functions/onDidUpdateKubernetesConnection.html +++ b/api/namespaces/provider/functions/onDidUpdateKubernetesConnection.html @@ -13,7 +13,7 @@ - + @@ -32,6 +32,6 @@

    Disposable

    A disposable which unsubscribes the event listener.

    Source​

    -

    packages/extension-api/src/extension-api.d.ts:548

    +

    packages/extension-api/src/extension-api.d.ts:548

    \ No newline at end of file diff --git a/api/namespaces/provider/functions/onDidUpdateProvider.html b/api/namespaces/provider/functions/onDidUpdateProvider.html index 230e1fed2e7..b43b0a4a41e 100644 --- a/api/namespaces/provider/functions/onDidUpdateProvider.html +++ b/api/namespaces/provider/functions/onDidUpdateProvider.html @@ -13,7 +13,7 @@ - + @@ -32,6 +32,6 @@

    Disposable

    A disposable which unsubscribes the event listener.

    Source​

    -

    packages/extension-api/src/extension-api.d.ts:546

    +

    packages/extension-api/src/extension-api.d.ts:546

    \ No newline at end of file diff --git a/api/namespaces/proxy.html b/api/namespaces/proxy.html index a5e98f9e447..019c1448382 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 9b2c9c5c3a3..5bf7506d813 100644 --- a/api/namespaces/proxy/functions/getProxySettings.html +++ b/api/namespaces/proxy/functions/getProxySettings.html @@ -13,7 +13,7 @@ - + @@ -24,6 +24,6 @@

    Returns​

    ProxySettings | undefined

    Source​

    -

    packages/extension-api/src/extension-api.d.ts:574

    +

    packages/extension-api/src/extension-api.d.ts:574

    \ No newline at end of file diff --git a/api/namespaces/proxy/functions/isEnabled.html b/api/namespaces/proxy/functions/isEnabled.html index de9a63defb1..bee29701f77 100644 --- a/api/namespaces/proxy/functions/isEnabled.html +++ b/api/namespaces/proxy/functions/isEnabled.html @@ -13,7 +13,7 @@ - + @@ -24,6 +24,6 @@

    Returns​

    boolean

    Source​

    -

    packages/extension-api/src/extension-api.d.ts:580

    +

    packages/extension-api/src/extension-api.d.ts:580

    \ No newline at end of file diff --git a/api/namespaces/proxy/functions/onDidStateChange.html b/api/namespaces/proxy/functions/onDidStateChange.html index fa101ecec7e..97c40b243f2 100644 --- a/api/namespaces/proxy/functions/onDidStateChange.html +++ b/api/namespaces/proxy/functions/onDidStateChange.html @@ -13,7 +13,7 @@ - + @@ -32,6 +32,6 @@

    Disposable

    A disposable which unsubscribes the event listener.

    Source​

    -

    packages/extension-api/src/extension-api.d.ts:581

    +

    packages/extension-api/src/extension-api.d.ts:581

    \ No newline at end of file diff --git a/api/namespaces/proxy/functions/onDidUpdateProxy.html b/api/namespaces/proxy/functions/onDidUpdateProxy.html index a5552c50fac..98cf700c773 100644 --- a/api/namespaces/proxy/functions/onDidUpdateProxy.html +++ b/api/namespaces/proxy/functions/onDidUpdateProxy.html @@ -13,7 +13,7 @@ - + @@ -32,6 +32,6 @@

    Disposable

    A disposable which unsubscribes the event listener.

    Source​

    -

    packages/extension-api/src/extension-api.d.ts:577

    +

    packages/extension-api/src/extension-api.d.ts:577

    \ No newline at end of file diff --git a/api/namespaces/proxy/functions/setProxy.html b/api/namespaces/proxy/functions/setProxy.html index 1043ec75ad9..b3094033a3c 100644 --- a/api/namespaces/proxy/functions/setProxy.html +++ b/api/namespaces/proxy/functions/setProxy.html @@ -13,7 +13,7 @@ - + @@ -26,6 +26,6 @@

    Returns​

    Promise< void >

    Source​

    -

    packages/extension-api/src/extension-api.d.ts:575

    +

    packages/extension-api/src/extension-api.d.ts:575

    \ No newline at end of file diff --git a/api/namespaces/registry.html b/api/namespaces/registry.html index d9585e91843..c90e2e7c577 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 84b840a652e..979045606ee 100644 --- a/api/namespaces/registry/functions/onDidRegisterRegistry.html +++ b/api/namespaces/registry/functions/onDidRegisterRegistry.html @@ -13,7 +13,7 @@ - + @@ -32,6 +32,6 @@

    Disposable

    A disposable which unsubscribes the event listener.

    Source​

    -

    packages/extension-api/src/extension-api.d.ts:630

    +

    packages/extension-api/src/extension-api.d.ts:630

    \ No newline at end of file diff --git a/api/namespaces/registry/functions/onDidUnregisterRegistry.html b/api/namespaces/registry/functions/onDidUnregisterRegistry.html index 3021b9755de..1473a5bb4f9 100644 --- a/api/namespaces/registry/functions/onDidUnregisterRegistry.html +++ b/api/namespaces/registry/functions/onDidUnregisterRegistry.html @@ -13,7 +13,7 @@ - + @@ -32,6 +32,6 @@

    Disposable

    A disposable which unsubscribes the event listener.

    Source​

    -

    packages/extension-api/src/extension-api.d.ts:632

    +

    packages/extension-api/src/extension-api.d.ts:632

    \ No newline at end of file diff --git a/api/namespaces/registry/functions/onDidUpdateRegistry.html b/api/namespaces/registry/functions/onDidUpdateRegistry.html index f6eb76e98fe..af297d7e9e7 100644 --- a/api/namespaces/registry/functions/onDidUpdateRegistry.html +++ b/api/namespaces/registry/functions/onDidUpdateRegistry.html @@ -13,7 +13,7 @@ - + @@ -32,6 +32,6 @@

    Disposable

    A disposable which unsubscribes the event listener.

    Source​

    -

    packages/extension-api/src/extension-api.d.ts:631

    +

    packages/extension-api/src/extension-api.d.ts:631

    \ No newline at end of file diff --git a/api/namespaces/registry/functions/registerRegistry.html b/api/namespaces/registry/functions/registerRegistry.html index 29c4d62da5a..fbc214bc9d7 100644 --- a/api/namespaces/registry/functions/registerRegistry.html +++ b/api/namespaces/registry/functions/registerRegistry.html @@ -13,7 +13,7 @@ - + @@ -26,6 +26,6 @@

    Returns​

    Disposable

    Source​

    -

    packages/extension-api/src/extension-api.d.ts:622

    +

    packages/extension-api/src/extension-api.d.ts:622

    \ No newline at end of file diff --git a/api/namespaces/registry/functions/registerRegistryProvider.html b/api/namespaces/registry/functions/registerRegistryProvider.html index ac03069ba57..ed391acf131 100644 --- a/api/namespaces/registry/functions/registerRegistryProvider.html +++ b/api/namespaces/registry/functions/registerRegistryProvider.html @@ -13,7 +13,7 @@ - + @@ -26,6 +26,6 @@

    Returns​

    Disposable

    Source​

    -

    packages/extension-api/src/extension-api.d.ts:619

    +

    packages/extension-api/src/extension-api.d.ts:619

    \ No newline at end of file diff --git a/api/namespaces/registry/functions/suggestRegistry.html b/api/namespaces/registry/functions/suggestRegistry.html index cffe5823ae1..926e68636df 100644 --- a/api/namespaces/registry/functions/suggestRegistry.html +++ b/api/namespaces/registry/functions/suggestRegistry.html @@ -13,7 +13,7 @@ - + @@ -26,6 +26,6 @@

    Returns​

    Disposable

    Source​

    -

    packages/extension-api/src/extension-api.d.ts:628

    +

    packages/extension-api/src/extension-api.d.ts:628

    \ No newline at end of file diff --git a/api/namespaces/registry/functions/unregisterRegistry.html b/api/namespaces/registry/functions/unregisterRegistry.html index 99173f4514b..77cb402a885 100644 --- a/api/namespaces/registry/functions/unregisterRegistry.html +++ b/api/namespaces/registry/functions/unregisterRegistry.html @@ -13,7 +13,7 @@ - + @@ -26,6 +26,6 @@

    Returns​

    void

    Source​

    -

    packages/extension-api/src/extension-api.d.ts:625

    +

    packages/extension-api/src/extension-api.d.ts:625

    \ No newline at end of file diff --git a/api/namespaces/tray.html b/api/namespaces/tray.html index 0515392abf8..b8516e8514a 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 443a04a5d30..385f55cc75c 100644 --- a/api/namespaces/tray/functions/registerMenuItem.html +++ b/api/namespaces/tray/functions/registerMenuItem.html @@ -13,7 +13,7 @@ - + @@ -28,6 +28,6 @@

    Returns​

    Disposable

    Source​

    -

    packages/extension-api/src/extension-api.d.ts:640

    +

    packages/extension-api/src/extension-api.d.ts:640

    \ No newline at end of file diff --git a/api/namespaces/tray/functions/registerProviderMenuItem.html b/api/namespaces/tray/functions/registerProviderMenuItem.html index 5567112e44d..6f96314cdef 100644 --- a/api/namespaces/tray/functions/registerProviderMenuItem.html +++ b/api/namespaces/tray/functions/registerProviderMenuItem.html @@ -13,7 +13,7 @@ - + @@ -29,6 +29,6 @@

    Returns​

    Disposable

    Source​

    -

    packages/extension-api/src/extension-api.d.ts:647

    +

    packages/extension-api/src/extension-api.d.ts:647

    \ No newline at end of file diff --git a/api/namespaces/window.html b/api/namespaces/window.html index 2d0013731bd..85c5c25dffb 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 c097281550a..caedce07778 100644 --- a/api/namespaces/window/functions/createCustomPick.html +++ b/api/namespaces/window/functions/createCustomPick.html @@ -13,7 +13,7 @@ - + @@ -28,6 +28,6 @@

    CustomPick< T >

    A new CustomPick

    Source​

    -

    packages/extension-api/src/extension-api.d.ts:1784

    +

    packages/extension-api/src/extension-api.d.ts:1784

    \ No newline at end of file diff --git a/api/namespaces/window/functions/createStatusBarItem.html b/api/namespaces/window/functions/createStatusBarItem.html index 2cbb7f50b97..6d797a769f9 100644 --- a/api/namespaces/window/functions/createStatusBarItem.html +++ b/api/namespaces/window/functions/createStatusBarItem.html @@ -13,7 +13,7 @@ - + @@ -31,6 +31,6 @@

    StatusBarItem

    A new status bar item.

    Source​

    -

    packages/extension-api/src/extension-api.d.ts:1691

    +

    packages/extension-api/src/extension-api.d.ts:1691

    \ No newline at end of file diff --git a/api/namespaces/window/functions/createWebviewPanel.html b/api/namespaces/window/functions/createWebviewPanel.html index b9f7104b632..f055aa59e58 100644 --- a/api/namespaces/window/functions/createWebviewPanel.html +++ b/api/namespaces/window/functions/createWebviewPanel.html @@ -13,7 +13,7 @@ - + @@ -33,6 +33,6 @@

    WebviewPanel

    New webview panel.

    Source​

    -

    packages/extension-api/src/extension-api.d.ts:1795

    +

    packages/extension-api/src/extension-api.d.ts:1795

    \ No newline at end of file diff --git a/api/namespaces/window/functions/listWebviews.html b/api/namespaces/window/functions/listWebviews.html index b22fee09094..64364241b57 100644 --- a/api/namespaces/window/functions/listWebviews.html +++ b/api/namespaces/window/functions/listWebviews.html @@ -13,7 +13,7 @@ - + @@ -24,6 +24,6 @@

    Returns​

    Promise< WebviewInfo[] >

    Source​

    -

    packages/extension-api/src/extension-api.d.ts:1797

    +

    packages/extension-api/src/extension-api.d.ts:1797

    \ No newline at end of file diff --git a/api/namespaces/window/functions/showErrorMessage.html b/api/namespaces/window/functions/showErrorMessage.html index 78dd95819ef..d31f93249d2 100644 --- a/api/namespaces/window/functions/showErrorMessage.html +++ b/api/namespaces/window/functions/showErrorMessage.html @@ -13,7 +13,7 @@ - + @@ -32,6 +32,6 @@ clickable buttons.

    Promise< string | undefined >

    A promise that resolves to the selected item or undefined when being dismissed.

    Source​

    -

    packages/extension-api/src/extension-api.d.ts:1612

    +

    packages/extension-api/src/extension-api.d.ts:1612

    \ No newline at end of file diff --git a/api/namespaces/window/functions/showInformationMessage.html b/api/namespaces/window/functions/showInformationMessage.html index f092f94f6bf..a0ea54e48bb 100644 --- a/api/namespaces/window/functions/showInformationMessage.html +++ b/api/namespaces/window/functions/showInformationMessage.html @@ -13,7 +13,7 @@ - + @@ -32,6 +32,6 @@ clickable buttons.

    Promise< string | undefined >

    A promise that resolves to the selected item or undefined when being dismissed.

    Source​

    -

    packages/extension-api/src/extension-api.d.ts:1592

    +

    packages/extension-api/src/extension-api.d.ts:1592

    \ No newline at end of file diff --git a/api/namespaces/window/functions/showInputBox.html b/api/namespaces/window/functions/showInputBox.html index bdd5c2c4c08..8567250e191 100644 --- a/api/namespaces/window/functions/showInputBox.html +++ b/api/namespaces/window/functions/showInputBox.html @@ -13,7 +13,7 @@ - + @@ -34,6 +34,6 @@ anything but dismissed the input box with OK.

    Promise< string | undefined >

    A promise that resolves to a string the user provided or to undefined in case of dismissal.

    Source​

    -

    packages/extension-api/src/extension-api.d.ts:1704

    +

    packages/extension-api/src/extension-api.d.ts:1704

    \ No newline at end of file diff --git a/api/namespaces/window/functions/showNotification.html b/api/namespaces/window/functions/showNotification.html index 789ee827c32..b445f7fd516 100644 --- a/api/namespaces/window/functions/showNotification.html +++ b/api/namespaces/window/functions/showNotification.html @@ -13,7 +13,7 @@ - + @@ -28,6 +28,6 @@

    Returns​

    Disposable

    Source​

    -

    packages/extension-api/src/extension-api.d.ts:1682

    +

    packages/extension-api/src/extension-api.d.ts:1682

    \ No newline at end of file diff --git a/api/namespaces/window/functions/showOpenDialog.html b/api/namespaces/window/functions/showOpenDialog.html index a7c939c2d41..663822b246a 100644 --- a/api/namespaces/window/functions/showOpenDialog.html +++ b/api/namespaces/window/functions/showOpenDialog.html @@ -13,7 +13,7 @@ - + @@ -30,6 +30,6 @@ for opening-purposes.

    Promise< Uri[] | undefined >

    A promise that resolves to the selected resources or undefined.

    Source​

    -

    packages/extension-api/src/extension-api.d.ts:1713

    +

    packages/extension-api/src/extension-api.d.ts:1713

    \ No newline at end of file diff --git a/api/namespaces/window/functions/showQuickPick.html b/api/namespaces/window/functions/showQuickPick.html index 899420f7778..0722add4bed 100644 --- a/api/namespaces/window/functions/showQuickPick.html +++ b/api/namespaces/window/functions/showQuickPick.html @@ -13,7 +13,7 @@ - + @@ -34,7 +34,7 @@

    Promise< string[] | undefined >

    A promise that resolves to the selected items or undefined.

    Source​

    -

    packages/extension-api/src/extension-api.d.ts:1732

    +

    packages/extension-api/src/extension-api.d.ts:1732

    showQuickPick(items, options, token)​

    showQuickPick(items, options?, token?): Promise< string | undefined >

    @@ -51,7 +51,7 @@

    Promise< string | undefined >

    A promise that resolves to the selection or undefined.

    Source​

    -

    packages/extension-api/src/extension-api.d.ts:1746

    +

    packages/extension-api/src/extension-api.d.ts:1746

    showQuickPick(items, options, token)​

    showQuickPick<T>(items, options, token?): Promise< T[] | undefined >

    @@ -70,7 +70,7 @@

    Promise< T[] | undefined >

    A promise that resolves to the selected items or undefined.

    Source​

    -

    packages/extension-api/src/extension-api.d.ts:1760

    +

    packages/extension-api/src/extension-api.d.ts:1760

    showQuickPick(items, options, token)​

    showQuickPick<T>(items, options?, token?): Promise< T | undefined >

    @@ -89,6 +89,6 @@

    Promise< T | undefined >

    A promise that resolves to the selected item or undefined.

    Source​

    -

    packages/extension-api/src/extension-api.d.ts:1774

    +

    packages/extension-api/src/extension-api.d.ts:1774

    \ No newline at end of file diff --git a/api/namespaces/window/functions/showSaveDialog.html b/api/namespaces/window/functions/showSaveDialog.html index ef7b289e309..7171b7c3882 100644 --- a/api/namespaces/window/functions/showSaveDialog.html +++ b/api/namespaces/window/functions/showSaveDialog.html @@ -13,7 +13,7 @@ - + @@ -30,6 +30,6 @@ for saving-purposes.

    Promise< Uri | undefined >

    A promise that resolves to the selected resource or undefined.

    Source​

    -

    packages/extension-api/src/extension-api.d.ts:1722

    +

    packages/extension-api/src/extension-api.d.ts:1722

    \ No newline at end of file diff --git a/api/namespaces/window/functions/showWarningMessage.html b/api/namespaces/window/functions/showWarningMessage.html index 8011284269b..eb8d695ceb3 100644 --- a/api/namespaces/window/functions/showWarningMessage.html +++ b/api/namespaces/window/functions/showWarningMessage.html @@ -13,7 +13,7 @@ - + @@ -32,6 +32,6 @@ clickable buttons.

    Promise< string | undefined >

    A promise that resolves to the selected item or undefined when being dismissed.

    Source​

    -

    packages/extension-api/src/extension-api.d.ts:1602

    +

    packages/extension-api/src/extension-api.d.ts:1602

    \ No newline at end of file diff --git a/api/namespaces/window/functions/withProgress.html b/api/namespaces/window/functions/withProgress.html index 86589f4c9c6..0fe80f5ac5b 100644 --- a/api/namespaces/window/functions/withProgress.html +++ b/api/namespaces/window/functions/withProgress.html @@ -13,7 +13,7 @@ - + @@ -52,6 +52,6 @@ long-running operation.

    You can return a value from the task callback

    const result: number = await window.withProgress<number>(
    { location: ProgressLocation.TASK_WIDGET, title: `Running task` },
    async progress => {
    // compute something
    return 55;
    },
    );

    Source​

    -

    packages/extension-api/src/extension-api.d.ts:1673

    +

    packages/extension-api/src/extension-api.d.ts:1673

    \ No newline at end of file diff --git a/api/type-aliases/CheckResultLink.html b/api/type-aliases/CheckResultLink.html index 7765f98fdd0..5f2e5345b9e 100644 --- a/api/type-aliases/CheckResultLink.html +++ b/api/type-aliases/CheckResultLink.html @@ -13,7 +13,7 @@ - + @@ -22,6 +22,6 @@

    CheckResultLink: Link

    Source​

    -

    packages/extension-api/src/extension-api.d.ts:355

    +

    packages/extension-api/src/extension-api.d.ts:355

    \ No newline at end of file diff --git a/api/type-aliases/CliToolState.html b/api/type-aliases/CliToolState.html index 115e381106c..9df72547a15 100644 --- a/api/type-aliases/CliToolState.html +++ b/api/type-aliases/CliToolState.html @@ -13,7 +13,7 @@ - + @@ -22,6 +22,6 @@

    CliToolState: "registered"

    Source​

    -

    packages/extension-api/src/extension-api.d.ts:4031

    +

    packages/extension-api/src/extension-api.d.ts:4031

    \ No newline at end of file diff --git a/api/type-aliases/ConfigurationScope.html b/api/type-aliases/ConfigurationScope.html index dc6aaaa0d52..512cb109717 100644 --- a/api/type-aliases/ConfigurationScope.html +++ b/api/type-aliases/ConfigurationScope.html @@ -13,7 +13,7 @@ - + @@ -23,6 +23,6 @@

    The configuration scope

    Source​

    -

    packages/extension-api/src/extension-api.d.ts:662

    +

    packages/extension-api/src/extension-api.d.ts:662

    \ No newline at end of file diff --git a/api/type-aliases/KubernetesGeneratorArgument.html b/api/type-aliases/KubernetesGeneratorArgument.html index 8c34b4fc16d..f90ef216c72 100644 --- a/api/type-aliases/KubernetesGeneratorArgument.html +++ b/api/type-aliases/KubernetesGeneratorArgument.html @@ -13,7 +13,7 @@ - + @@ -39,6 +39,6 @@

    optional pods: string[]

    Source​

    -

    packages/extension-api/src/extension-api.d.ts:1840

    +

    packages/extension-api/src/extension-api.d.ts:1840

    \ No newline at end of file diff --git a/api/type-aliases/KubernetesGeneratorSelector.html b/api/type-aliases/KubernetesGeneratorSelector.html index 443da463a13..c43eafd25a6 100644 --- a/api/type-aliases/KubernetesGeneratorSelector.html +++ b/api/type-aliases/KubernetesGeneratorSelector.html @@ -13,7 +13,7 @@ - + @@ -22,6 +22,6 @@

    KubernetesGeneratorSelector: KubernetesGeneratorType | ReadonlyArray< KubernetesGeneratorType >

    Source​

    -

    packages/extension-api/src/extension-api.d.ts:1829

    +

    packages/extension-api/src/extension-api.d.ts:1829

    \ No newline at end of file diff --git a/api/type-aliases/KubernetesGeneratorType.html b/api/type-aliases/KubernetesGeneratorType.html index 8ac8907aba2..f9547b86038 100644 --- a/api/type-aliases/KubernetesGeneratorType.html +++ b/api/type-aliases/KubernetesGeneratorType.html @@ -13,7 +13,7 @@ - + @@ -22,6 +22,6 @@

    KubernetesGeneratorType: "Compose" | "Pod" | "Container"

    Source​

    -

    packages/extension-api/src/extension-api.d.ts:1831

    +

    packages/extension-api/src/extension-api.d.ts:1831

    \ No newline at end of file diff --git a/api/type-aliases/MountConfig.html b/api/type-aliases/MountConfig.html index a8caf0f2b6c..dabdcb5e343 100644 --- a/api/type-aliases/MountConfig.html +++ b/api/type-aliases/MountConfig.html @@ -13,7 +13,7 @@ - + @@ -22,6 +22,6 @@

    MountConfig: MountSettings[]

    Source​

    -

    packages/extension-api/src/extension-api.d.ts:2118

    +

    packages/extension-api/src/extension-api.d.ts:2118

    \ No newline at end of file diff --git a/api/type-aliases/MountConsistency.html b/api/type-aliases/MountConsistency.html index c84861dc834..33c89eae006 100644 --- a/api/type-aliases/MountConsistency.html +++ b/api/type-aliases/MountConsistency.html @@ -13,7 +13,7 @@ - + @@ -22,6 +22,6 @@

    MountConsistency: "default" | "consistent" | "cached" | "delegated"

    Source​

    -

    packages/extension-api/src/extension-api.d.ts:2090

    +

    packages/extension-api/src/extension-api.d.ts:2090

    \ No newline at end of file diff --git a/api/type-aliases/MountPropagation.html b/api/type-aliases/MountPropagation.html index f15e041f35f..117c5836761 100644 --- a/api/type-aliases/MountPropagation.html +++ b/api/type-aliases/MountPropagation.html @@ -13,7 +13,7 @@ - + @@ -22,6 +22,6 @@

    MountPropagation: "private" | "rprivate" | "shared" | "rshared" | "slave" | "rslave"

    Source​

    -

    packages/extension-api/src/extension-api.d.ts:2092

    +

    packages/extension-api/src/extension-api.d.ts:2092

    \ No newline at end of file diff --git a/api/type-aliases/MountType.html b/api/type-aliases/MountType.html index 21cfad6ea19..c793b406bd6 100644 --- a/api/type-aliases/MountType.html +++ b/api/type-aliases/MountType.html @@ -13,7 +13,7 @@ - + @@ -22,6 +22,6 @@

    MountType: "bind" | "volume" | "tmpfs"

    Source​

    -

    packages/extension-api/src/extension-api.d.ts:2088

    +

    packages/extension-api/src/extension-api.d.ts:2088

    \ No newline at end of file diff --git a/api/type-aliases/NotificationType.html b/api/type-aliases/NotificationType.html index d7de6706e20..2b68207654a 100644 --- a/api/type-aliases/NotificationType.html +++ b/api/type-aliases/NotificationType.html @@ -13,7 +13,7 @@ - + @@ -22,6 +22,6 @@

    NotificationType: "info" | "warn" | "error"

    Source​

    -

    packages/extension-api/src/extension-api.d.ts:1150

    +

    packages/extension-api/src/extension-api.d.ts:1150

    \ No newline at end of file diff --git a/api/type-aliases/ProviderConnectionStatus.html b/api/type-aliases/ProviderConnectionStatus.html index 5b2c6456a31..ba8d1042e51 100644 --- a/api/type-aliases/ProviderConnectionStatus.html +++ b/api/type-aliases/ProviderConnectionStatus.html @@ -13,7 +13,7 @@ - + @@ -22,6 +22,6 @@

    ProviderConnectionStatus: "started" | "stopped" | "starting" | "stopping" | "unknown"

    Source​

    -

    packages/extension-api/src/extension-api.d.ts:232

    +

    packages/extension-api/src/extension-api.d.ts:232

    \ No newline at end of file diff --git a/api/type-aliases/ProviderLinks.html b/api/type-aliases/ProviderLinks.html index 0be08e3cfe7..f89dcf71549 100644 --- a/api/type-aliases/ProviderLinks.html +++ b/api/type-aliases/ProviderLinks.html @@ -13,7 +13,7 @@ - + @@ -22,6 +22,6 @@

    ProviderLinks: Link

    Source​

    -

    packages/extension-api/src/extension-api.d.ts:419

    +

    packages/extension-api/src/extension-api.d.ts:419

    \ No newline at end of file diff --git a/api/type-aliases/ProviderResult.html b/api/type-aliases/ProviderResult.html index 0e457bd56a2..ee9bcbbcaf5 100644 --- a/api/type-aliases/ProviderResult.html +++ b/api/type-aliases/ProviderResult.html @@ -13,7 +13,7 @@ - + @@ -30,6 +30,6 @@ Promise.

    Type parameters​

    • T

    Source​

    -

    packages/extension-api/src/extension-api.d.ts:181

    +

    packages/extension-api/src/extension-api.d.ts:181

    \ No newline at end of file diff --git a/api/type-aliases/ProviderStatus.html b/api/type-aliases/ProviderStatus.html index 2c6c97f8a70..53359e6b6ad 100644 --- a/api/type-aliases/ProviderStatus.html +++ b/api/type-aliases/ProviderStatus.html @@ -13,7 +13,7 @@ - + @@ -22,6 +22,6 @@

    ProviderStatus: "not-installed" | "installed" | "configuring" | "configured" | "ready" | "started" | "stopped" | "starting" | "stopping" | "error" | "unknown"

    Source​

    -

    packages/extension-api/src/extension-api.d.ts:183

    +

    packages/extension-api/src/extension-api.d.ts:183

    \ No newline at end of file diff --git a/api/type-aliases/StatusBarAlignment.html b/api/type-aliases/StatusBarAlignment.html index 3d30b6606e3..cf3d99efff7 100644 --- a/api/type-aliases/StatusBarAlignment.html +++ b/api/type-aliases/StatusBarAlignment.html @@ -13,7 +13,7 @@ - + @@ -23,6 +23,6 @@

    Represents the alignment of status bar items.

    Source​

    -

    packages/extension-api/src/extension-api.d.ts:1190

    +

    packages/extension-api/src/extension-api.d.ts:1190

    \ No newline at end of file diff --git a/api/variables/StatusBarAlignLeft.html b/api/variables/StatusBarAlignLeft.html index 05d015bca4b..e05e2c3391b 100644 --- a/api/variables/StatusBarAlignLeft.html +++ b/api/variables/StatusBarAlignLeft.html @@ -13,7 +13,7 @@ - + @@ -23,6 +23,6 @@

    Aligned to the left side.

    Source​

    -

    packages/extension-api/src/extension-api.d.ts:1182

    +

    packages/extension-api/src/extension-api.d.ts:1182

    \ No newline at end of file diff --git a/api/variables/StatusBarAlignRight.html b/api/variables/StatusBarAlignRight.html index b5bbbfa9efd..8ab06564a2e 100644 --- a/api/variables/StatusBarAlignRight.html +++ b/api/variables/StatusBarAlignRight.html @@ -13,7 +13,7 @@ - + @@ -23,6 +23,6 @@

    Aligned to the right side.

    Source​

    -

    packages/extension-api/src/extension-api.d.ts:1186

    +

    packages/extension-api/src/extension-api.d.ts:1186

    \ No newline at end of file diff --git a/api/variables/StatusBarItemDefaultPriority.html b/api/variables/StatusBarItemDefaultPriority.html index 0ced9b13359..01c4485d6ba 100644 --- a/api/variables/StatusBarItemDefaultPriority.html +++ b/api/variables/StatusBarItemDefaultPriority.html @@ -13,7 +13,7 @@ - + @@ -23,6 +23,6 @@

    Default priority for the status bar items.

    Source​

    -

    packages/extension-api/src/extension-api.d.ts:1195

    +

    packages/extension-api/src/extension-api.d.ts:1195

    \ No newline at end of file diff --git a/api/variables/version.html b/api/variables/version.html index f4565fec33a..8f4a70c3aa5 100644 --- a/api/variables/version.html +++ b/api/variables/version.html @@ -13,7 +13,7 @@ - + @@ -23,6 +23,6 @@

    The version of Podman Desktop.

    Source​

    -

    packages/extension-api/src/extension-api.d.ts:23

    +

    packages/extension-api/src/extension-api.d.ts:23

    \ No newline at end of file diff --git a/assets/js/0029a336.92f134a4.js b/assets/js/0029a336.b6586be4.js similarity index 99% rename from assets/js/0029a336.92f134a4.js rename to assets/js/0029a336.b6586be4.js index 518c63e284a..59cdf051347 100644 --- a/assets/js/0029a336.92f134a4.js +++ b/assets/js/0029a336.b6586be4.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[19093],{54168:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>c,contentTitle:()=>i,default:()=>h,frontMatter:()=>o,metadata:()=>a,toc:()=>l});var r=s(24246),t=s(71670);const o={},i="Function: withProgress()",a={id:"namespaces/window/functions/withProgress",title:"Function: withProgress()",description:"withProgress\\(options, task): Promise\\",source:"@site/api/namespaces/window/functions/withProgress.md",sourceDirName:"namespaces/window/functions",slug:"/namespaces/window/functions/withProgress",permalink:"/api/namespaces/window/functions/withProgress",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Function: showWarningMessage()",permalink:"/api/namespaces/window/functions/showWarningMessage"},next:{title:"Enumeration: InputBoxValidationSeverity",permalink:"/api/enumerations/InputBoxValidationSeverity"}},c={},l=[{value:"Type parameters",id:"type-parameters",level:2},{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Example",id:"example",level:2},{value:"Example",id:"example-1",level:2},{value:"Example",id:"example-2",level:2},{value:"Source",id:"source",level:2}];function d(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",pre:"pre",strong:"strong",...(0,t.a)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.h1,{id:"function-withprogress",children:"Function: withProgress()"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"withProgress"}),"<",(0,r.jsx)(n.code,{children:"R"}),">(",(0,r.jsx)(n.code,{children:"options"}),", ",(0,r.jsx)(n.code,{children:"task"}),"): ",(0,r.jsx)(n.code,{children:"Promise"}),"< ",(0,r.jsx)(n.code,{children:"R"})," >"]}),"\n"]}),"\n",(0,r.jsxs)(n.p,{children:["Show progress in Podman Desktop. Progress is shown while running the given callback\nand while the promise it returned isn't resolved nor rejected. The location at which\nprogress should show (and other details) is defined via the passed ",(0,r.jsx)(n.a,{href:"/api/interfaces/ProgressOptions",children:(0,r.jsx)(n.code,{children:"ProgressOptions"})}),"."]}),"\n",(0,r.jsx)(n.h2,{id:"type-parameters",children:"Type parameters"}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"R"})]}),"\n",(0,r.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"options"}),": ",(0,r.jsx)(n.a,{href:"/api/interfaces/ProgressOptions",children:(0,r.jsx)(n.code,{children:"ProgressOptions"})})]}),"\n",(0,r.jsx)(n.p,{children:"the options for the task's details"}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"task"})]}),"\n",(0,r.jsxs)(n.p,{children:["A callback returning a promise. Progress state can be reported with\nthe provided ",(0,r.jsx)(n.a,{href:"/api/interfaces/Progress",children:"Progress"}),"-object."]}),"\n",(0,r.jsxs)(n.p,{children:["To report discrete progress, use ",(0,r.jsx)(n.code,{children:"increment"})," to indicate how much work has been completed. Each call with\na ",(0,r.jsx)(n.code,{children:"increment"})," value will be summed up and reflected as overall progress until 100% is reached (a value of\ne.g. ",(0,r.jsx)(n.code,{children:"10"})," accounts for ",(0,r.jsx)(n.code,{children:"10%"})," of work done).\nNote that currently only ",(0,r.jsx)(n.code,{children:"ProgressLocation.Notification"})," is capable of showing discrete progress."]}),"\n",(0,r.jsxs)(n.p,{children:["To monitor if the operation has been cancelled by the user, use the provided ",(0,r.jsx)(n.a,{href:"/api/interfaces/CancellationToken",children:(0,r.jsx)(n.code,{children:"CancellationToken"})}),".\nNote that currently only ",(0,r.jsx)(n.code,{children:"ProgressLocation.Notification"})," is supporting to show a cancel button to cancel the\nlong-running operation."]}),"\n",(0,r.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"Promise"}),"< ",(0,r.jsx)(n.code,{children:"R"})," >"]}),"\n",(0,r.jsx)(n.p,{children:"The promise the task-callback returned."}),"\n",(0,r.jsx)(n.h2,{id:"example",children:"Example"}),"\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.h2,{id:"example-1",children:"Example"}),"\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.h2,{id:"example-2",children:"Example"}),"\n",(0,r.jsx)(n.p,{children:"You can return a value from the task callback"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:"const result: number = await window.withProgress(\n { location: ProgressLocation.TASK_WIDGET, title: `Running task` },\n async progress => {\n // compute something\n return 55;\n },\n);\n"})}),"\n",(0,r.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L1673",children:"packages/extension-api/src/extension-api.d.ts:1673"})})]})}function h(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(d,{...e})}):d(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>a,a:()=>i});var r=s(27378);const t={},o=r.createContext(t);function i(e){const n=r.useContext(o);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function a(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:i(e.components),r.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[19093],{54168:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>c,contentTitle:()=>i,default:()=>h,frontMatter:()=>o,metadata:()=>a,toc:()=>l});var r=s(24246),t=s(71670);const o={},i="Function: withProgress()",a={id:"namespaces/window/functions/withProgress",title:"Function: withProgress()",description:"withProgress\\(options, task): Promise\\",source:"@site/api/namespaces/window/functions/withProgress.md",sourceDirName:"namespaces/window/functions",slug:"/namespaces/window/functions/withProgress",permalink:"/api/namespaces/window/functions/withProgress",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Function: showWarningMessage()",permalink:"/api/namespaces/window/functions/showWarningMessage"},next:{title:"Enumeration: InputBoxValidationSeverity",permalink:"/api/enumerations/InputBoxValidationSeverity"}},c={},l=[{value:"Type parameters",id:"type-parameters",level:2},{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Example",id:"example",level:2},{value:"Example",id:"example-1",level:2},{value:"Example",id:"example-2",level:2},{value:"Source",id:"source",level:2}];function d(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",pre:"pre",strong:"strong",...(0,t.a)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.h1,{id:"function-withprogress",children:"Function: withProgress()"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"withProgress"}),"<",(0,r.jsx)(n.code,{children:"R"}),">(",(0,r.jsx)(n.code,{children:"options"}),", ",(0,r.jsx)(n.code,{children:"task"}),"): ",(0,r.jsx)(n.code,{children:"Promise"}),"< ",(0,r.jsx)(n.code,{children:"R"})," >"]}),"\n"]}),"\n",(0,r.jsxs)(n.p,{children:["Show progress in Podman Desktop. Progress is shown while running the given callback\nand while the promise it returned isn't resolved nor rejected. The location at which\nprogress should show (and other details) is defined via the passed ",(0,r.jsx)(n.a,{href:"/api/interfaces/ProgressOptions",children:(0,r.jsx)(n.code,{children:"ProgressOptions"})}),"."]}),"\n",(0,r.jsx)(n.h2,{id:"type-parameters",children:"Type parameters"}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"R"})]}),"\n",(0,r.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"options"}),": ",(0,r.jsx)(n.a,{href:"/api/interfaces/ProgressOptions",children:(0,r.jsx)(n.code,{children:"ProgressOptions"})})]}),"\n",(0,r.jsx)(n.p,{children:"the options for the task's details"}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"task"})]}),"\n",(0,r.jsxs)(n.p,{children:["A callback returning a promise. Progress state can be reported with\nthe provided ",(0,r.jsx)(n.a,{href:"/api/interfaces/Progress",children:"Progress"}),"-object."]}),"\n",(0,r.jsxs)(n.p,{children:["To report discrete progress, use ",(0,r.jsx)(n.code,{children:"increment"})," to indicate how much work has been completed. Each call with\na ",(0,r.jsx)(n.code,{children:"increment"})," value will be summed up and reflected as overall progress until 100% is reached (a value of\ne.g. ",(0,r.jsx)(n.code,{children:"10"})," accounts for ",(0,r.jsx)(n.code,{children:"10%"})," of work done).\nNote that currently only ",(0,r.jsx)(n.code,{children:"ProgressLocation.Notification"})," is capable of showing discrete progress."]}),"\n",(0,r.jsxs)(n.p,{children:["To monitor if the operation has been cancelled by the user, use the provided ",(0,r.jsx)(n.a,{href:"/api/interfaces/CancellationToken",children:(0,r.jsx)(n.code,{children:"CancellationToken"})}),".\nNote that currently only ",(0,r.jsx)(n.code,{children:"ProgressLocation.Notification"})," is supporting to show a cancel button to cancel the\nlong-running operation."]}),"\n",(0,r.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"Promise"}),"< ",(0,r.jsx)(n.code,{children:"R"})," >"]}),"\n",(0,r.jsx)(n.p,{children:"The promise the task-callback returned."}),"\n",(0,r.jsx)(n.h2,{id:"example",children:"Example"}),"\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.h2,{id:"example-1",children:"Example"}),"\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.h2,{id:"example-2",children:"Example"}),"\n",(0,r.jsx)(n.p,{children:"You can return a value from the task callback"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:"const result: number = await window.withProgress(\n { location: ProgressLocation.TASK_WIDGET, title: `Running task` },\n async progress => {\n // compute something\n return 55;\n },\n);\n"})}),"\n",(0,r.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L1673",children:"packages/extension-api/src/extension-api.d.ts:1673"})})]})}function h(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(d,{...e})}):d(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>a,a:()=>i});var r=s(27378);const t={},o=r.createContext(t);function i(e){const n=r.useContext(o);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function a(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:i(e.components),r.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/0102eb3e.570ca7d7.js b/assets/js/0102eb3e.ec2383d1.js similarity index 87% rename from assets/js/0102eb3e.570ca7d7.js rename to assets/js/0102eb3e.ec2383d1.js index fbc3d5d3b7c..8a412261a29 100644 --- a/assets/js/0102eb3e.570ca7d7.js +++ b/assets/js/0102eb3e.ec2383d1.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[75542],{75013:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>a,contentTitle:()=>c,default:()=>p,frontMatter:()=>r,metadata:()=>o,toc:()=>d});var t=i(24246),s=i(71670);const r={},c="Interface: WebviewInfo",o={id:"interfaces/WebviewInfo",title:"Interface: WebviewInfo",description:"Properties",source:"@site/api/interfaces/WebviewInfo.md",sourceDirName:"interfaces",slug:"/interfaces/WebviewInfo",permalink:"/api/interfaces/WebviewInfo",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: Webview",permalink:"/api/interfaces/Webview"},next:{title:"Interface: WebviewOptions",permalink:"/api/interfaces/WebviewOptions"}},a={},d=[{value:"Properties",id:"properties",level:2},{value:"id",id:"id",level:3},{value:"Source",id:"source",level:4},{value:"title",id:"title",level:3},{value:"Source",id:"source-1",level:4},{value:"viewType",id:"viewtype",level:3},{value:"Source",id:"source-2",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"interface-webviewinfo",children:"Interface: WebviewInfo"}),"\n",(0,t.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,t.jsx)(n.h3,{id:"id",children:"id"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"id"}),": ",(0,t.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2753",children:"packages/extension-api/src/extension-api.d.ts:2753"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"title",children:"title"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"title"}),": ",(0,t.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2755",children:"packages/extension-api/src/extension-api.d.ts:2755"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"viewtype",children:"viewType"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"viewType"}),": ",(0,t.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2754",children:"packages/extension-api/src/extension-api.d.ts:2754"})})]})}function p(e={}){const{wrapper:n}={...(0,s.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>o,a:()=>c});var t=i(27378);const s={},r=t.createContext(s);function c(e){const n=t.useContext(r);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:c(e.components),t.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[75542],{75013:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>d,contentTitle:()=>c,default:()=>p,frontMatter:()=>r,metadata:()=>o,toc:()=>a});var t=i(24246),s=i(71670);const r={},c="Interface: WebviewInfo",o={id:"interfaces/WebviewInfo",title:"Interface: WebviewInfo",description:"Properties",source:"@site/api/interfaces/WebviewInfo.md",sourceDirName:"interfaces",slug:"/interfaces/WebviewInfo",permalink:"/api/interfaces/WebviewInfo",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: Webview",permalink:"/api/interfaces/Webview"},next:{title:"Interface: WebviewOptions",permalink:"/api/interfaces/WebviewOptions"}},d={},a=[{value:"Properties",id:"properties",level:2},{value:"id",id:"id",level:3},{value:"Source",id:"source",level:4},{value:"title",id:"title",level:3},{value:"Source",id:"source-1",level:4},{value:"viewType",id:"viewtype",level:3},{value:"Source",id:"source-2",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"interface-webviewinfo",children:"Interface: WebviewInfo"}),"\n",(0,t.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,t.jsx)(n.h3,{id:"id",children:"id"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"id"}),": ",(0,t.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2753",children:"packages/extension-api/src/extension-api.d.ts:2753"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"title",children:"title"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"title"}),": ",(0,t.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2755",children:"packages/extension-api/src/extension-api.d.ts:2755"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"viewtype",children:"viewType"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"viewType"}),": ",(0,t.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2754",children:"packages/extension-api/src/extension-api.d.ts:2754"})})]})}function p(e={}){const{wrapper:n}={...(0,s.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>o,a:()=>c});var t=i(27378);const s={},r=t.createContext(s);function c(e){const n=t.useContext(r);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:c(e.components),t.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/01821883.a60e5b32.js b/assets/js/01821883.af5c3e62.js similarity index 89% rename from assets/js/01821883.a60e5b32.js rename to assets/js/01821883.af5c3e62.js index fbd5e6cd7df..dae4a93eea8 100644 --- a/assets/js/01821883.a60e5b32.js +++ b/assets/js/01821883.af5c3e62.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[77683],{94309:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>d,contentTitle:()=>r,default:()=>h,frontMatter:()=>t,metadata:()=>o,toc:()=>a});var s=i(24246),c=i(71670);const t={},r="Interface: DeviceRequest",o={id:"interfaces/DeviceRequest",title:"Interface: DeviceRequest",description:"Properties",source:"@site/api/interfaces/DeviceRequest.md",sourceDirName:"interfaces",slug:"/interfaces/DeviceRequest",permalink:"/api/interfaces/DeviceRequest",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: CustomPickSectionItem",permalink:"/api/interfaces/CustomPickSectionItem"},next:{title:"Interface: EndpointIPAMConfig",permalink:"/api/interfaces/EndpointIPAMConfig"}},d={},a=[{value:"Properties",id:"properties",level:2},{value:"Capabilities?",id:"capabilities",level:3},{value:"Source",id:"source",level:4},{value:"Count?",id:"count",level:3},{value:"Source",id:"source-1",level:4},{value:"DeviceIDs?",id:"deviceids",level:3},{value:"Source",id:"source-2",level:4},{value:"Driver?",id:"driver",level:3},{value:"Source",id:"source-3",level:4},{value:"Options?",id:"options",level:3},{value:"Index signature",id:"index-signature",level:4},{value:"Source",id:"source-4",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,c.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"interface-devicerequest",children:"Interface: DeviceRequest"}),"\n",(0,s.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,s.jsx)(n.h3,{id:"capabilities",children:"Capabilities?"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:(0,s.jsx)(n.code,{children:"optional"})})," ",(0,s.jsx)(n.strong,{children:"Capabilities"}),": ",(0,s.jsx)(n.code,{children:"string"}),"[][]"]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2124",children:"packages/extension-api/src/extension-api.d.ts:2124"})}),"\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.strong,{children:(0,s.jsx)(n.code,{children:"optional"})})," ",(0,s.jsx)(n.strong,{children:"Count"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2122",children:"packages/extension-api/src/extension-api.d.ts:2122"})}),"\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.strong,{children:(0,s.jsx)(n.code,{children:"optional"})})," ",(0,s.jsx)(n.strong,{children:"DeviceIDs"}),": ",(0,s.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2123",children:"packages/extension-api/src/extension-api.d.ts:2123"})}),"\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:(0,s.jsx)(n.code,{children:"optional"})})," ",(0,s.jsx)(n.strong,{children:"Driver"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2121",children:"packages/extension-api/src/extension-api.d.ts:2121"})}),"\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:(0,s.jsx)(n.code,{children:"optional"})})," ",(0,s.jsx)(n.strong,{children:"Options"}),": ",(0,s.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"index-signature",children:"Index signature"}),"\n",(0,s.jsxs)(n.p,{children:["[",(0,s.jsx)(n.code,{children:"key"}),": ",(0,s.jsx)(n.code,{children:"string"}),"]: ",(0,s.jsx)(n.code,{children:"string"})]}),"\n",(0,s.jsx)(n.h4,{id:"source-4",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2125",children:"packages/extension-api/src/extension-api.d.ts:2125"})})]})}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:()=>r});var s=i(27378);const c={},t=s.createContext(c);function r(e){const n=s.useContext(t);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(c):e.components||c:r(e.components),s.createElement(t.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[77683],{94309:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>d,contentTitle:()=>r,default:()=>h,frontMatter:()=>t,metadata:()=>o,toc:()=>a});var s=i(24246),c=i(71670);const t={},r="Interface: DeviceRequest",o={id:"interfaces/DeviceRequest",title:"Interface: DeviceRequest",description:"Properties",source:"@site/api/interfaces/DeviceRequest.md",sourceDirName:"interfaces",slug:"/interfaces/DeviceRequest",permalink:"/api/interfaces/DeviceRequest",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: CustomPickSectionItem",permalink:"/api/interfaces/CustomPickSectionItem"},next:{title:"Interface: EndpointIPAMConfig",permalink:"/api/interfaces/EndpointIPAMConfig"}},d={},a=[{value:"Properties",id:"properties",level:2},{value:"Capabilities?",id:"capabilities",level:3},{value:"Source",id:"source",level:4},{value:"Count?",id:"count",level:3},{value:"Source",id:"source-1",level:4},{value:"DeviceIDs?",id:"deviceids",level:3},{value:"Source",id:"source-2",level:4},{value:"Driver?",id:"driver",level:3},{value:"Source",id:"source-3",level:4},{value:"Options?",id:"options",level:3},{value:"Index signature",id:"index-signature",level:4},{value:"Source",id:"source-4",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,c.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"interface-devicerequest",children:"Interface: DeviceRequest"}),"\n",(0,s.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,s.jsx)(n.h3,{id:"capabilities",children:"Capabilities?"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:(0,s.jsx)(n.code,{children:"optional"})})," ",(0,s.jsx)(n.strong,{children:"Capabilities"}),": ",(0,s.jsx)(n.code,{children:"string"}),"[][]"]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2124",children:"packages/extension-api/src/extension-api.d.ts:2124"})}),"\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.strong,{children:(0,s.jsx)(n.code,{children:"optional"})})," ",(0,s.jsx)(n.strong,{children:"Count"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2122",children:"packages/extension-api/src/extension-api.d.ts:2122"})}),"\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.strong,{children:(0,s.jsx)(n.code,{children:"optional"})})," ",(0,s.jsx)(n.strong,{children:"DeviceIDs"}),": ",(0,s.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2123",children:"packages/extension-api/src/extension-api.d.ts:2123"})}),"\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:(0,s.jsx)(n.code,{children:"optional"})})," ",(0,s.jsx)(n.strong,{children:"Driver"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2121",children:"packages/extension-api/src/extension-api.d.ts:2121"})}),"\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:(0,s.jsx)(n.code,{children:"optional"})})," ",(0,s.jsx)(n.strong,{children:"Options"}),": ",(0,s.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"index-signature",children:"Index signature"}),"\n",(0,s.jsxs)(n.p,{children:["[",(0,s.jsx)(n.code,{children:"key"}),": ",(0,s.jsx)(n.code,{children:"string"}),"]: ",(0,s.jsx)(n.code,{children:"string"})]}),"\n",(0,s.jsx)(n.h4,{id:"source-4",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2125",children:"packages/extension-api/src/extension-api.d.ts:2125"})})]})}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:()=>r});var s=i(27378);const c={},t=s.createContext(c);function r(e){const n=s.useContext(t);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(c):e.components||c:r(e.components),s.createElement(t.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/01a1d0f4.ba9ae5ce.js b/assets/js/01a1d0f4.cfacb70c.js similarity index 98% rename from assets/js/01a1d0f4.ba9ae5ce.js rename to assets/js/01a1d0f4.cfacb70c.js index 3bd22e5b111..4bcd02706bb 100644 --- a/assets/js/01a1d0f4.ba9ae5ce.js +++ b/assets/js/01a1d0f4.cfacb70c.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[13826],{75055:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>a,contentTitle:()=>t,default:()=>p,frontMatter:()=>o,metadata:()=>c,toc:()=>d});var i=s(24246),r=s(71670);const o={},t="Function: onDidUnregisterContainerConnection()",c={id:"namespaces/provider/functions/onDidUnregisterContainerConnection",title:"Function: onDidUnregisterContainerConnection()",description:"onDidUnregisterContainerConnection(listener, thisArgs?, disposables?): Disposable",source:"@site/api/namespaces/provider/functions/onDidUnregisterContainerConnection.md",sourceDirName:"namespaces/provider/functions",slug:"/namespaces/provider/functions/onDidUnregisterContainerConnection",permalink:"/api/namespaces/provider/functions/onDidUnregisterContainerConnection",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Function: onDidRegisterContainerConnection()",permalink:"/api/namespaces/provider/functions/onDidRegisterContainerConnection"},next:{title:"Function: onDidUpdateContainerConnection()",permalink:"/api/namespaces/provider/functions/onDidUpdateContainerConnection"}},a={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,r.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"function-ondidunregistercontainerconnection",children:"Function: onDidUnregisterContainerConnection()"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"onDidUnregisterContainerConnection"}),"(",(0,i.jsx)(n.code,{children:"listener"}),", ",(0,i.jsx)(n.code,{children:"thisArgs"}),"?, ",(0,i.jsx)(n.code,{children:"disposables"}),"?): ",(0,i.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(n.code,{children:"Disposable"})})]}),"\n"]}),"\n",(0,i.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"listener"})]}),"\n",(0,i.jsx)(n.p,{children:"The listener function will be called when the event happens."}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"thisArgs?"}),": ",(0,i.jsx)(n.code,{children:"any"})]}),"\n",(0,i.jsxs)(n.p,{children:["The ",(0,i.jsx)(n.code,{children:"this"}),"-argument which will be used when calling the event listener."]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"disposables?"}),": ",(0,i.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(n.code,{children:"Disposable"})}),"[]"]}),"\n",(0,i.jsxs)(n.p,{children:["An array to which a ",(0,i.jsx)(n.a,{href:"/api/classes/Disposable",children:"Disposable"})," will be added."]}),"\n",(0,i.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(n.code,{children:"Disposable"})})}),"\n",(0,i.jsx)(n.p,{children:"A disposable which unsubscribes the event listener."}),"\n",(0,i.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L549",children:"packages/extension-api/src/extension-api.d.ts:549"})})]})}function p(e={}){const{wrapper:n}={...(0,r.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>c,a:()=>t});var i=s(27378);const r={},o=i.createContext(r);function t(e){const n=i.useContext(o);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:t(e.components),i.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[13826],{75055:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>a,contentTitle:()=>t,default:()=>p,frontMatter:()=>o,metadata:()=>c,toc:()=>d});var i=s(24246),r=s(71670);const o={},t="Function: onDidUnregisterContainerConnection()",c={id:"namespaces/provider/functions/onDidUnregisterContainerConnection",title:"Function: onDidUnregisterContainerConnection()",description:"onDidUnregisterContainerConnection(listener, thisArgs?, disposables?): Disposable",source:"@site/api/namespaces/provider/functions/onDidUnregisterContainerConnection.md",sourceDirName:"namespaces/provider/functions",slug:"/namespaces/provider/functions/onDidUnregisterContainerConnection",permalink:"/api/namespaces/provider/functions/onDidUnregisterContainerConnection",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Function: onDidRegisterContainerConnection()",permalink:"/api/namespaces/provider/functions/onDidRegisterContainerConnection"},next:{title:"Function: onDidUpdateContainerConnection()",permalink:"/api/namespaces/provider/functions/onDidUpdateContainerConnection"}},a={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,r.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"function-ondidunregistercontainerconnection",children:"Function: onDidUnregisterContainerConnection()"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"onDidUnregisterContainerConnection"}),"(",(0,i.jsx)(n.code,{children:"listener"}),", ",(0,i.jsx)(n.code,{children:"thisArgs"}),"?, ",(0,i.jsx)(n.code,{children:"disposables"}),"?): ",(0,i.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(n.code,{children:"Disposable"})})]}),"\n"]}),"\n",(0,i.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"listener"})]}),"\n",(0,i.jsx)(n.p,{children:"The listener function will be called when the event happens."}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"thisArgs?"}),": ",(0,i.jsx)(n.code,{children:"any"})]}),"\n",(0,i.jsxs)(n.p,{children:["The ",(0,i.jsx)(n.code,{children:"this"}),"-argument which will be used when calling the event listener."]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"disposables?"}),": ",(0,i.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(n.code,{children:"Disposable"})}),"[]"]}),"\n",(0,i.jsxs)(n.p,{children:["An array to which a ",(0,i.jsx)(n.a,{href:"/api/classes/Disposable",children:"Disposable"})," will be added."]}),"\n",(0,i.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(n.code,{children:"Disposable"})})}),"\n",(0,i.jsx)(n.p,{children:"A disposable which unsubscribes the event listener."}),"\n",(0,i.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L549",children:"packages/extension-api/src/extension-api.d.ts:549"})})]})}function p(e={}){const{wrapper:n}={...(0,r.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>c,a:()=>t});var i=s(27378);const r={},o=i.createContext(r);function t(e){const n=i.useContext(o);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:t(e.components),i.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/030ccfd9.6af5542e.js b/assets/js/030ccfd9.6701e3f5.js similarity index 94% rename from assets/js/030ccfd9.6af5542e.js rename to assets/js/030ccfd9.6701e3f5.js index 94fa866fe75..ca2206b0e25 100644 --- a/assets/js/030ccfd9.6af5542e.js +++ b/assets/js/030ccfd9.6701e3f5.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[67690],{48300:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>u,contentTitle:()=>i,default:()=>p,frontMatter:()=>o,metadata:()=>r,toc:()=>a});var s=t(24246),c=t(71670);const o={},i="Function: getKubeconfig()",r={id:"namespaces/kubernetes/functions/getKubeconfig",title:"Function: getKubeconfig()",description:"getKubeconfig(): Uri",source:"@site/api/namespaces/kubernetes/functions/getKubeconfig.md",sourceDirName:"namespaces/kubernetes/functions",slug:"/namespaces/kubernetes/functions/getKubeconfig",permalink:"/api/namespaces/kubernetes/functions/getKubeconfig",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Function: createResources()",permalink:"/api/namespaces/kubernetes/functions/createResources"},next:{title:"Function: onDidUpdateKubeconfig()",permalink:"/api/namespaces/kubernetes/functions/onDidUpdateKubeconfig"}},u={},a=[{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function d(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,c.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"function-getkubeconfig",children:"Function: getKubeconfig()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"getKubeconfig"}),"(): ",(0,s.jsx)(n.a,{href:"/api/classes/Uri",children:(0,s.jsx)(n.code,{children:"Uri"})})]}),"\n"]}),"\n",(0,s.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"/api/classes/Uri",children:(0,s.jsx)(n.code,{children:"Uri"})})}),"\n",(0,s.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L1802",children:"packages/extension-api/src/extension-api.d.ts:1802"})})]})}function p(e={}){const{wrapper:n}={...(0,c.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(d,{...e})}):d(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>r,a:()=>i});var s=t(27378);const c={},o=s.createContext(c);function i(e){const n=s.useContext(o);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function r(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(c):e.components||c:i(e.components),s.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[67690],{48300:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>u,contentTitle:()=>i,default:()=>p,frontMatter:()=>o,metadata:()=>r,toc:()=>a});var s=t(24246),c=t(71670);const o={},i="Function: getKubeconfig()",r={id:"namespaces/kubernetes/functions/getKubeconfig",title:"Function: getKubeconfig()",description:"getKubeconfig(): Uri",source:"@site/api/namespaces/kubernetes/functions/getKubeconfig.md",sourceDirName:"namespaces/kubernetes/functions",slug:"/namespaces/kubernetes/functions/getKubeconfig",permalink:"/api/namespaces/kubernetes/functions/getKubeconfig",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Function: createResources()",permalink:"/api/namespaces/kubernetes/functions/createResources"},next:{title:"Function: onDidUpdateKubeconfig()",permalink:"/api/namespaces/kubernetes/functions/onDidUpdateKubeconfig"}},u={},a=[{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function d(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,c.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"function-getkubeconfig",children:"Function: getKubeconfig()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"getKubeconfig"}),"(): ",(0,s.jsx)(n.a,{href:"/api/classes/Uri",children:(0,s.jsx)(n.code,{children:"Uri"})})]}),"\n"]}),"\n",(0,s.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"/api/classes/Uri",children:(0,s.jsx)(n.code,{children:"Uri"})})}),"\n",(0,s.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L1802",children:"packages/extension-api/src/extension-api.d.ts:1802"})})]})}function p(e={}){const{wrapper:n}={...(0,c.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(d,{...e})}):d(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>r,a:()=>i});var s=t(27378);const c={},o=s.createContext(c);function i(e){const n=s.useContext(o);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function r(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(c):e.components||c:i(e.components),s.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/04a546a4.9cbb3615.js b/assets/js/04a546a4.cc60c712.js similarity index 86% rename from assets/js/04a546a4.9cbb3615.js rename to assets/js/04a546a4.cc60c712.js index 3f5dbcf2b52..964cc1470bc 100644 --- a/assets/js/04a546a4.9cbb3615.js +++ b/assets/js/04a546a4.cc60c712.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[17329],{27848:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>d,contentTitle:()=>c,default:()=>h,frontMatter:()=>i,metadata:()=>o,toc:()=>a});var t=r(24246),s=r(71670);const i={},c="Interface: Clipboard",o={id:"interfaces/Clipboard",title:"Interface: Clipboard",description:"The clipboard provides read and write access to the system's clipboard.",source:"@site/api/interfaces/Clipboard.md",sourceDirName:"interfaces",slug:"/interfaces/Clipboard",permalink:"/api/interfaces/Clipboard",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: CliToolUpdateOptions",permalink:"/api/interfaces/CliToolUpdateOptions"},next:{title:"Interface: Command",permalink:"/api/interfaces/Command"}},d={},a=[{value:"Methods",id:"methods",level:2},{value:"readText()",id:"readtext",level:3},{value:"Returns",id:"returns",level:4},{value:"Source",id:"source",level:4},{value:"writeText()",id:"writetext",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Source",id:"source-1",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"interface-clipboard",children:"Interface: Clipboard"}),"\n",(0,t.jsx)(n.p,{children:"The clipboard provides read and write access to the system's clipboard."}),"\n",(0,t.jsx)(n.h2,{id:"methods",children:"Methods"}),"\n",(0,t.jsx)(n.h3,{id:"readtext",children:"readText()"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"readText"}),"(): ",(0,t.jsx)(n.code,{children:"Promise"}),"< ",(0,t.jsx)(n.code,{children:"string"})," >"]}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"Read the current clipboard contents as text."}),"\n",(0,t.jsx)(n.h4,{id:"returns",children:"Returns"}),"\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"Promise"}),"< ",(0,t.jsx)(n.code,{children:"string"})," >"]}),"\n",(0,t.jsx)(n.p,{children:"A Promise that resolves to a string."}),"\n",(0,t.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L3968",children:"packages/extension-api/src/extension-api.d.ts:3968"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"writetext",children:"writeText()"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"writeText"}),"(",(0,t.jsx)(n.code,{children:"value"}),"): ",(0,t.jsx)(n.code,{children:"Promise"}),"< ",(0,t.jsx)(n.code,{children:"void"})," >"]}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"Writes text into the clipboard."}),"\n",(0,t.jsx)(n.h4,{id:"parameters",children:"Parameters"}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"value"}),": ",(0,t.jsx)(n.code,{children:"string"})]}),"\n",(0,t.jsx)(n.h4,{id:"returns-1",children:"Returns"}),"\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"Promise"}),"< ",(0,t.jsx)(n.code,{children:"void"})," >"]}),"\n",(0,t.jsx)(n.p,{children:"A Promise that resolves when writing happened."}),"\n",(0,t.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L3974",children:"packages/extension-api/src/extension-api.d.ts:3974"})})]})}function h(e={}){const{wrapper:n}={...(0,s.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},71670:(e,n,r)=>{r.d(n,{Z:()=>o,a:()=>c});var t=r(27378);const s={},i=t.createContext(s);function c(e){const n=t.useContext(i);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:c(e.components),t.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[17329],{27848:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>o,contentTitle:()=>c,default:()=>h,frontMatter:()=>i,metadata:()=>d,toc:()=>a});var t=r(24246),s=r(71670);const i={},c="Interface: Clipboard",d={id:"interfaces/Clipboard",title:"Interface: Clipboard",description:"The clipboard provides read and write access to the system's clipboard.",source:"@site/api/interfaces/Clipboard.md",sourceDirName:"interfaces",slug:"/interfaces/Clipboard",permalink:"/api/interfaces/Clipboard",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: CliToolUpdateOptions",permalink:"/api/interfaces/CliToolUpdateOptions"},next:{title:"Interface: Command",permalink:"/api/interfaces/Command"}},o={},a=[{value:"Methods",id:"methods",level:2},{value:"readText()",id:"readtext",level:3},{value:"Returns",id:"returns",level:4},{value:"Source",id:"source",level:4},{value:"writeText()",id:"writetext",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Source",id:"source-1",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"interface-clipboard",children:"Interface: Clipboard"}),"\n",(0,t.jsx)(n.p,{children:"The clipboard provides read and write access to the system's clipboard."}),"\n",(0,t.jsx)(n.h2,{id:"methods",children:"Methods"}),"\n",(0,t.jsx)(n.h3,{id:"readtext",children:"readText()"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"readText"}),"(): ",(0,t.jsx)(n.code,{children:"Promise"}),"< ",(0,t.jsx)(n.code,{children:"string"})," >"]}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"Read the current clipboard contents as text."}),"\n",(0,t.jsx)(n.h4,{id:"returns",children:"Returns"}),"\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"Promise"}),"< ",(0,t.jsx)(n.code,{children:"string"})," >"]}),"\n",(0,t.jsx)(n.p,{children:"A Promise that resolves to a string."}),"\n",(0,t.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L3968",children:"packages/extension-api/src/extension-api.d.ts:3968"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"writetext",children:"writeText()"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"writeText"}),"(",(0,t.jsx)(n.code,{children:"value"}),"): ",(0,t.jsx)(n.code,{children:"Promise"}),"< ",(0,t.jsx)(n.code,{children:"void"})," >"]}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"Writes text into the clipboard."}),"\n",(0,t.jsx)(n.h4,{id:"parameters",children:"Parameters"}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"value"}),": ",(0,t.jsx)(n.code,{children:"string"})]}),"\n",(0,t.jsx)(n.h4,{id:"returns-1",children:"Returns"}),"\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"Promise"}),"< ",(0,t.jsx)(n.code,{children:"void"})," >"]}),"\n",(0,t.jsx)(n.p,{children:"A Promise that resolves when writing happened."}),"\n",(0,t.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L3974",children:"packages/extension-api/src/extension-api.d.ts:3974"})})]})}function h(e={}){const{wrapper:n}={...(0,s.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},71670:(e,n,r)=>{r.d(n,{Z:()=>d,a:()=>c});var t=r(27378);const s={},i=t.createContext(s);function c(e){const n=t.useContext(i);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function d(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:c(e.components),t.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/0547cb65.c85f6a89.js b/assets/js/0547cb65.9966a371.js similarity index 90% rename from assets/js/0547cb65.c85f6a89.js rename to assets/js/0547cb65.9966a371.js index 066764526e0..8fa13cb7c0e 100644 --- a/assets/js/0547cb65.c85f6a89.js +++ b/assets/js/0547cb65.9966a371.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[30060],{41694:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>o,contentTitle:()=>s,default:()=>u,frontMatter:()=>c,metadata:()=>a,toc:()=>l});var t=i(24246),r=i(71670);const c={},s="Enumeration: QuickPickItemKind",a={id:"enumerations/QuickPickItemKind",title:"Enumeration: QuickPickItemKind",description:"The kind of quick pick item.",source:"@site/api/enumerations/QuickPickItemKind.md",sourceDirName:"enumerations",slug:"/enumerations/QuickPickItemKind",permalink:"/api/enumerations/QuickPickItemKind",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Enumeration: ProgressLocation",permalink:"/api/enumerations/ProgressLocation"},next:{title:"Class: CancellationTokenSource",permalink:"/api/classes/CancellationTokenSource"}},o={},l=[{value:"Enumeration Members",id:"enumeration-members",level:2},{value:"Default",id:"default",level:3},{value:"Source",id:"source",level:4},{value:"Separator",id:"separator",level:3},{value:"Source",id:"source-1",level:4}];function d(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,r.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"enumeration-quickpickitemkind",children:"Enumeration: QuickPickItemKind"}),"\n",(0,t.jsxs)(n.p,{children:["The kind of ",(0,t.jsx)(n.a,{href:"/api/interfaces/QuickPickItem",children:"quick pick item"}),"."]}),"\n",(0,t.jsx)(n.h2,{id:"enumeration-members",children:"Enumeration Members"}),"\n",(0,t.jsx)(n.h3,{id:"default",children:"Default"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"Default"}),": ",(0,t.jsx)(n.code,{children:"0"})]}),"\n"]}),"\n",(0,t.jsxs)(n.p,{children:["The default ",(0,t.jsx)(n.a,{href:"/api/interfaces/QuickPickItem#kind",children:"QuickPickItem.kind"})," is an item that can be selected in the quick pick."]}),"\n",(0,t.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L917",children:"packages/extension-api/src/extension-api.d.ts:917"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"separator",children:"Separator"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"Separator"}),": ",(0,t.jsx)(n.code,{children:"-1"})]}),"\n"]}),"\n",(0,t.jsxs)(n.p,{children:["When a ",(0,t.jsx)(n.a,{href:"/api/interfaces/QuickPickItem",children:"QuickPickItem"})," has a kind of ",(0,t.jsx)(n.a,{href:"/api/enumerations/QuickPickItemKind#separator",children:"Separator"}),", the item is just a visual separator and does not represent a real item.\nThe only property that applies is ",(0,t.jsx)(n.a,{href:"/api/interfaces/QuickPickItem#label",children:"label "}),". All other properties on ",(0,t.jsx)(n.a,{href:"/api/interfaces/QuickPickItem",children:"QuickPickItem"})," will be ignored and have no effect."]}),"\n",(0,t.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L913",children:"packages/extension-api/src/extension-api.d.ts:913"})})]})}function u(e={}){const{wrapper:n}={...(0,r.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(d,{...e})}):d(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>a,a:()=>s});var t=i(27378);const r={},c=t.createContext(r);function s(e){const n=t.useContext(c);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function a(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:s(e.components),t.createElement(c.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[30060],{41694:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>o,contentTitle:()=>s,default:()=>u,frontMatter:()=>c,metadata:()=>a,toc:()=>d});var t=i(24246),r=i(71670);const c={},s="Enumeration: QuickPickItemKind",a={id:"enumerations/QuickPickItemKind",title:"Enumeration: QuickPickItemKind",description:"The kind of quick pick item.",source:"@site/api/enumerations/QuickPickItemKind.md",sourceDirName:"enumerations",slug:"/enumerations/QuickPickItemKind",permalink:"/api/enumerations/QuickPickItemKind",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Enumeration: ProgressLocation",permalink:"/api/enumerations/ProgressLocation"},next:{title:"Class: CancellationTokenSource",permalink:"/api/classes/CancellationTokenSource"}},o={},d=[{value:"Enumeration Members",id:"enumeration-members",level:2},{value:"Default",id:"default",level:3},{value:"Source",id:"source",level:4},{value:"Separator",id:"separator",level:3},{value:"Source",id:"source-1",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,r.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"enumeration-quickpickitemkind",children:"Enumeration: QuickPickItemKind"}),"\n",(0,t.jsxs)(n.p,{children:["The kind of ",(0,t.jsx)(n.a,{href:"/api/interfaces/QuickPickItem",children:"quick pick item"}),"."]}),"\n",(0,t.jsx)(n.h2,{id:"enumeration-members",children:"Enumeration Members"}),"\n",(0,t.jsx)(n.h3,{id:"default",children:"Default"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"Default"}),": ",(0,t.jsx)(n.code,{children:"0"})]}),"\n"]}),"\n",(0,t.jsxs)(n.p,{children:["The default ",(0,t.jsx)(n.a,{href:"/api/interfaces/QuickPickItem#kind",children:"QuickPickItem.kind"})," is an item that can be selected in the quick pick."]}),"\n",(0,t.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L917",children:"packages/extension-api/src/extension-api.d.ts:917"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"separator",children:"Separator"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"Separator"}),": ",(0,t.jsx)(n.code,{children:"-1"})]}),"\n"]}),"\n",(0,t.jsxs)(n.p,{children:["When a ",(0,t.jsx)(n.a,{href:"/api/interfaces/QuickPickItem",children:"QuickPickItem"})," has a kind of ",(0,t.jsx)(n.a,{href:"/api/enumerations/QuickPickItemKind#separator",children:"Separator"}),", the item is just a visual separator and does not represent a real item.\nThe only property that applies is ",(0,t.jsx)(n.a,{href:"/api/interfaces/QuickPickItem#label",children:"label "}),". All other properties on ",(0,t.jsx)(n.a,{href:"/api/interfaces/QuickPickItem",children:"QuickPickItem"})," will be ignored and have no effect."]}),"\n",(0,t.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L913",children:"packages/extension-api/src/extension-api.d.ts:913"})})]})}function u(e={}){const{wrapper:n}={...(0,r.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>a,a:()=>s});var t=i(27378);const r={},c=t.createContext(r);function s(e){const n=t.useContext(c);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function a(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:s(e.components),t.createElement(c.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/065365b3.f497ef4d.js b/assets/js/065365b3.17d68896.js similarity index 97% rename from assets/js/065365b3.f497ef4d.js rename to assets/js/065365b3.17d68896.js index 656ffa81f32..b947c193641 100644 --- a/assets/js/065365b3.f497ef4d.js +++ b/assets/js/065365b3.17d68896.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[43871],{62480:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>o,contentTitle:()=>a,default:()=>l,frontMatter:()=>s,metadata:()=>i,toc:()=>h});var c=t(24246),r=t(71670);const s={},a="Interface: ImageChecks",i={id:"interfaces/ImageChecks",title:"Interface: ImageChecks",description:"the complete result of an image check",source:"@site/api/interfaces/ImageChecks.md",sourceDirName:"interfaces",slug:"/interfaces/ImageChecks",permalink:"/api/interfaces/ImageChecks",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: ImageCheckerProviderMetadata",permalink:"/api/interfaces/ImageCheckerProviderMetadata"},next:{title:"Interface: ImageInfo",permalink:"/api/interfaces/ImageInfo"}},o={},h=[{value:"Properties",id:"properties",level:2},{value:"checks",id:"checks",level:3},{value:"Source",id:"source",level:4}];function d(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",p:"p",strong:"strong",...(0,r.a)(),...e.components};return(0,c.jsxs)(c.Fragment,{children:[(0,c.jsx)(n.h1,{id:"interface-imagechecks",children:"Interface: ImageChecks"}),"\n",(0,c.jsx)(n.p,{children:"the complete result of an image check"}),"\n",(0,c.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,c.jsx)(n.h3,{id:"checks",children:"checks"}),"\n",(0,c.jsxs)(n.blockquote,{children:["\n",(0,c.jsxs)(n.p,{children:[(0,c.jsx)(n.strong,{children:"checks"}),": ",(0,c.jsx)(n.a,{href:"/api/interfaces/ImageCheck",children:(0,c.jsx)(n.code,{children:"ImageCheck"})}),"[]"]}),"\n"]}),"\n",(0,c.jsx)(n.p,{children:"the list of errors/recommendations found during the image check"}),"\n",(0,c.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,c.jsx)(n.p,{children:(0,c.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L4096",children:"packages/extension-api/src/extension-api.d.ts:4096"})})]})}function l(e={}){const{wrapper:n}={...(0,r.a)(),...e.components};return n?(0,c.jsx)(n,{...e,children:(0,c.jsx)(d,{...e})}):d(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>i,a:()=>a});var c=t(27378);const r={},s=c.createContext(r);function a(e){const n=c.useContext(s);return c.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function i(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:a(e.components),c.createElement(s.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[43871],{62480:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>o,contentTitle:()=>a,default:()=>l,frontMatter:()=>s,metadata:()=>i,toc:()=>h});var c=t(24246),r=t(71670);const s={},a="Interface: ImageChecks",i={id:"interfaces/ImageChecks",title:"Interface: ImageChecks",description:"the complete result of an image check",source:"@site/api/interfaces/ImageChecks.md",sourceDirName:"interfaces",slug:"/interfaces/ImageChecks",permalink:"/api/interfaces/ImageChecks",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: ImageCheckerProviderMetadata",permalink:"/api/interfaces/ImageCheckerProviderMetadata"},next:{title:"Interface: ImageInfo",permalink:"/api/interfaces/ImageInfo"}},o={},h=[{value:"Properties",id:"properties",level:2},{value:"checks",id:"checks",level:3},{value:"Source",id:"source",level:4}];function d(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",p:"p",strong:"strong",...(0,r.a)(),...e.components};return(0,c.jsxs)(c.Fragment,{children:[(0,c.jsx)(n.h1,{id:"interface-imagechecks",children:"Interface: ImageChecks"}),"\n",(0,c.jsx)(n.p,{children:"the complete result of an image check"}),"\n",(0,c.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,c.jsx)(n.h3,{id:"checks",children:"checks"}),"\n",(0,c.jsxs)(n.blockquote,{children:["\n",(0,c.jsxs)(n.p,{children:[(0,c.jsx)(n.strong,{children:"checks"}),": ",(0,c.jsx)(n.a,{href:"/api/interfaces/ImageCheck",children:(0,c.jsx)(n.code,{children:"ImageCheck"})}),"[]"]}),"\n"]}),"\n",(0,c.jsx)(n.p,{children:"the list of errors/recommendations found during the image check"}),"\n",(0,c.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,c.jsx)(n.p,{children:(0,c.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L4096",children:"packages/extension-api/src/extension-api.d.ts:4096"})})]})}function l(e={}){const{wrapper:n}={...(0,r.a)(),...e.components};return n?(0,c.jsx)(n,{...e,children:(0,c.jsx)(d,{...e})}):d(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>i,a:()=>a});var c=t(27378);const r={},s=c.createContext(r);function a(e){const n=c.useContext(s);return c.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function i(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:a(e.components),c.createElement(s.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/06a27da2.d66ed147.js b/assets/js/06a27da2.d6352c85.js similarity index 81% rename from assets/js/06a27da2.d66ed147.js rename to assets/js/06a27da2.d6352c85.js index 2a995fae265..7870f3e76d1 100644 --- a/assets/js/06a27da2.d66ed147.js +++ b/assets/js/06a27da2.d6352c85.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[14824],{44400:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>d,contentTitle:()=>o,default:()=>h,frontMatter:()=>r,metadata:()=>t,toc:()=>a});var i=s(24246),c=s(71670);const r={},o="Interface: PodInfo",t={id:"interfaces/PodInfo",title:"Interface: PodInfo",description:"Properties",source:"@site/api/interfaces/PodInfo.md",sourceDirName:"interfaces",slug:"/interfaces/PodInfo",permalink:"/api/interfaces/PodInfo",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: PodCreatePortOptions",permalink:"/api/interfaces/PodCreatePortOptions"},next:{title:"Interface: PodmanContainerCreateOptions",permalink:"/api/interfaces/PodmanContainerCreateOptions"}},d={},a=[{value:"Properties",id:"properties",level:2},{value:"Cgroup",id:"cgroup",level:3},{value:"Source",id:"source",level:4},{value:"Containers",id:"containers",level:3},{value:"Source",id:"source-1",level:4},{value:"Created",id:"created",level:3},{value:"Source",id:"source-2",level:4},{value:"Id",id:"id",level:3},{value:"Source",id:"source-3",level:4},{value:"InfraId",id:"infraid",level:3},{value:"Source",id:"source-4",level:4},{value:"Labels",id:"labels",level:3},{value:"Index signature",id:"index-signature",level:4},{value:"Source",id:"source-5",level:4},{value:"Name",id:"name",level:3},{value:"Source",id:"source-6",level:4},{value:"Namespace",id:"namespace",level:3},{value:"Source",id:"source-7",level:4},{value:"Networks",id:"networks",level:3},{value:"Source",id:"source-8",level:4},{value:"Status",id:"status",level:3},{value:"Source",id:"source-9",level:4},{value:"engineId",id:"engineid",level:3},{value:"Source",id:"source-10",level:4},{value:"engineName",id:"enginename",level:3},{value:"Source",id:"source-11",level:4},{value:"kind",id:"kind",level:3},{value:"Source",id:"source-12",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,c.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"interface-podinfo",children:"Interface: PodInfo"}),"\n",(0,i.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(n.h3,{id:"cgroup",children:"Cgroup"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Cgroup"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2048",children:"packages/extension-api/src/extension-api.d.ts:2048"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"containers",children:"Containers"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Containers"}),": ",(0,i.jsx)(n.a,{href:"/api/interfaces/PodContainerInfo",children:(0,i.jsx)(n.code,{children:"PodContainerInfo"})}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2049",children:"packages/extension-api/src/extension-api.d.ts:2049"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"created",children:"Created"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Created"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2050",children:"packages/extension-api/src/extension-api.d.ts:2050"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"id",children:"Id"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Id"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2051",children:"packages/extension-api/src/extension-api.d.ts:2051"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"infraid",children:"InfraId"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"InfraId"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-4",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2052",children:"packages/extension-api/src/extension-api.d.ts:2052"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"labels",children:"Labels"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Labels"}),": ",(0,i.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"index-signature",children:"Index signature"}),"\n",(0,i.jsxs)(n.p,{children:["[",(0,i.jsx)(n.code,{children:"key"}),": ",(0,i.jsx)(n.code,{children:"string"}),"]: ",(0,i.jsx)(n.code,{children:"string"})]}),"\n",(0,i.jsx)(n.h4,{id:"source-5",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2053",children:"packages/extension-api/src/extension-api.d.ts:2053"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"name",children:"Name"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Name"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-6",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2054",children:"packages/extension-api/src/extension-api.d.ts:2054"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"namespace",children:"Namespace"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Namespace"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-7",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2055",children:"packages/extension-api/src/extension-api.d.ts:2055"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"networks",children:"Networks"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Networks"}),": ",(0,i.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-8",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2056",children:"packages/extension-api/src/extension-api.d.ts:2056"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"status",children:"Status"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Status"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-9",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2057",children:"packages/extension-api/src/extension-api.d.ts:2057"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"engineid",children:"engineId"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"engineId"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-10",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2045",children:"packages/extension-api/src/extension-api.d.ts:2045"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"enginename",children:"engineName"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"engineName"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-11",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2046",children:"packages/extension-api/src/extension-api.d.ts:2046"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"kind",children:"kind"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"kind"}),": ",(0,i.jsx)(n.code,{children:'"podman"'})," | ",(0,i.jsx)(n.code,{children:'"kubernetes"'})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-12",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2047",children:"packages/extension-api/src/extension-api.d.ts:2047"})})]})}function h(e={}){const{wrapper:n}={...(0,c.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>t,a:()=>o});var i=s(27378);const c={},r=i.createContext(c);function o(e){const n=i.useContext(r);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function t(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(c):e.components||c:o(e.components),i.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[14824],{44400:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>t,contentTitle:()=>d,default:()=>h,frontMatter:()=>r,metadata:()=>o,toc:()=>a});var i=s(24246),c=s(71670);const r={},d="Interface: PodInfo",o={id:"interfaces/PodInfo",title:"Interface: PodInfo",description:"Properties",source:"@site/api/interfaces/PodInfo.md",sourceDirName:"interfaces",slug:"/interfaces/PodInfo",permalink:"/api/interfaces/PodInfo",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: PodCreatePortOptions",permalink:"/api/interfaces/PodCreatePortOptions"},next:{title:"Interface: PodmanContainerCreateOptions",permalink:"/api/interfaces/PodmanContainerCreateOptions"}},t={},a=[{value:"Properties",id:"properties",level:2},{value:"Cgroup",id:"cgroup",level:3},{value:"Source",id:"source",level:4},{value:"Containers",id:"containers",level:3},{value:"Source",id:"source-1",level:4},{value:"Created",id:"created",level:3},{value:"Source",id:"source-2",level:4},{value:"Id",id:"id",level:3},{value:"Source",id:"source-3",level:4},{value:"InfraId",id:"infraid",level:3},{value:"Source",id:"source-4",level:4},{value:"Labels",id:"labels",level:3},{value:"Index signature",id:"index-signature",level:4},{value:"Source",id:"source-5",level:4},{value:"Name",id:"name",level:3},{value:"Source",id:"source-6",level:4},{value:"Namespace",id:"namespace",level:3},{value:"Source",id:"source-7",level:4},{value:"Networks",id:"networks",level:3},{value:"Source",id:"source-8",level:4},{value:"Status",id:"status",level:3},{value:"Source",id:"source-9",level:4},{value:"engineId",id:"engineid",level:3},{value:"Source",id:"source-10",level:4},{value:"engineName",id:"enginename",level:3},{value:"Source",id:"source-11",level:4},{value:"kind",id:"kind",level:3},{value:"Source",id:"source-12",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,c.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"interface-podinfo",children:"Interface: PodInfo"}),"\n",(0,i.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(n.h3,{id:"cgroup",children:"Cgroup"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Cgroup"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2048",children:"packages/extension-api/src/extension-api.d.ts:2048"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"containers",children:"Containers"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Containers"}),": ",(0,i.jsx)(n.a,{href:"/api/interfaces/PodContainerInfo",children:(0,i.jsx)(n.code,{children:"PodContainerInfo"})}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2049",children:"packages/extension-api/src/extension-api.d.ts:2049"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"created",children:"Created"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Created"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2050",children:"packages/extension-api/src/extension-api.d.ts:2050"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"id",children:"Id"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Id"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2051",children:"packages/extension-api/src/extension-api.d.ts:2051"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"infraid",children:"InfraId"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"InfraId"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-4",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2052",children:"packages/extension-api/src/extension-api.d.ts:2052"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"labels",children:"Labels"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Labels"}),": ",(0,i.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"index-signature",children:"Index signature"}),"\n",(0,i.jsxs)(n.p,{children:["[",(0,i.jsx)(n.code,{children:"key"}),": ",(0,i.jsx)(n.code,{children:"string"}),"]: ",(0,i.jsx)(n.code,{children:"string"})]}),"\n",(0,i.jsx)(n.h4,{id:"source-5",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2053",children:"packages/extension-api/src/extension-api.d.ts:2053"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"name",children:"Name"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Name"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-6",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2054",children:"packages/extension-api/src/extension-api.d.ts:2054"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"namespace",children:"Namespace"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Namespace"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-7",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2055",children:"packages/extension-api/src/extension-api.d.ts:2055"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"networks",children:"Networks"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Networks"}),": ",(0,i.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-8",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2056",children:"packages/extension-api/src/extension-api.d.ts:2056"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"status",children:"Status"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Status"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-9",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2057",children:"packages/extension-api/src/extension-api.d.ts:2057"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"engineid",children:"engineId"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"engineId"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-10",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2045",children:"packages/extension-api/src/extension-api.d.ts:2045"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"enginename",children:"engineName"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"engineName"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-11",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2046",children:"packages/extension-api/src/extension-api.d.ts:2046"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"kind",children:"kind"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"kind"}),": ",(0,i.jsx)(n.code,{children:'"podman"'})," | ",(0,i.jsx)(n.code,{children:'"kubernetes"'})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-12",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2047",children:"packages/extension-api/src/extension-api.d.ts:2047"})})]})}function h(e={}){const{wrapper:n}={...(0,c.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>o,a:()=>d});var i=s(27378);const c={},r=i.createContext(c);function d(e){const n=i.useContext(r);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(c):e.components||c:d(e.components),i.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/0877aebd.678da894.js b/assets/js/0877aebd.3d19e135.js similarity index 95% rename from assets/js/0877aebd.678da894.js rename to assets/js/0877aebd.3d19e135.js index ad61ccf0aab..e37ede462a1 100644 --- a/assets/js/0877aebd.678da894.js +++ b/assets/js/0877aebd.3d19e135.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[87213],{87044:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>s,default:()=>p,frontMatter:()=>r,metadata:()=>c,toc:()=>d});var i=t(24246),o=t(71670);const r={},s="Interface: AuthenticationProviderOptions",c={id:"interfaces/AuthenticationProviderOptions",title:"Interface: AuthenticationProviderOptions",description:"Options for creating an AuthenticationProvider.",source:"@site/api/interfaces/AuthenticationProviderOptions.md",sourceDirName:"interfaces",slug:"/interfaces/AuthenticationProviderOptions",permalink:"/api/interfaces/AuthenticationProviderOptions",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: AuthenticationProviderInformation",permalink:"/api/interfaces/AuthenticationProviderInformation"},next:{title:"Interface: AuthenticationSession",permalink:"/api/interfaces/AuthenticationSession"}},a={},d=[{value:"Properties",id:"properties",level:2},{value:"images?",id:"images",level:3},{value:"Source",id:"source",level:4},{value:"supportsMultipleAccounts?",id:"supportsmultipleaccounts",level:3},{value:"Source",id:"source-1",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,o.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"interface-authenticationprovideroptions",children:"Interface: AuthenticationProviderOptions"}),"\n",(0,i.jsxs)(n.p,{children:["Options for creating an ",(0,i.jsx)(n.a,{href:"#AuthenticationProvider",children:"AuthenticationProvider"}),"."]}),"\n",(0,i.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(n.h3,{id:"images",children:"images?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"readonly"})})," ",(0,i.jsx)(n.strong,{children:"images"}),": ",(0,i.jsx)(n.a,{href:"/api/interfaces/ProviderImages",children:(0,i.jsx)(n.code,{children:"ProviderImages"})})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L3520",children:"packages/extension-api/src/extension-api.d.ts:3520"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"supportsmultipleaccounts",children:"supportsMultipleAccounts?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"readonly"})})," ",(0,i.jsx)(n.strong,{children:"supportsMultipleAccounts"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Whether it is possible to be signed into multiple accounts at once with this provider.\nIf not specified, will default to false."}),"\n",(0,i.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L3518",children:"packages/extension-api/src/extension-api.d.ts:3518"})})]})}function p(e={}){const{wrapper:n}={...(0,o.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>c,a:()=>s});var i=t(27378);const o={},r=i.createContext(o);function s(e){const n=i.useContext(r);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:s(e.components),i.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[87213],{87044:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>s,default:()=>p,frontMatter:()=>r,metadata:()=>c,toc:()=>d});var i=t(24246),o=t(71670);const r={},s="Interface: AuthenticationProviderOptions",c={id:"interfaces/AuthenticationProviderOptions",title:"Interface: AuthenticationProviderOptions",description:"Options for creating an AuthenticationProvider.",source:"@site/api/interfaces/AuthenticationProviderOptions.md",sourceDirName:"interfaces",slug:"/interfaces/AuthenticationProviderOptions",permalink:"/api/interfaces/AuthenticationProviderOptions",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: AuthenticationProviderInformation",permalink:"/api/interfaces/AuthenticationProviderInformation"},next:{title:"Interface: AuthenticationSession",permalink:"/api/interfaces/AuthenticationSession"}},a={},d=[{value:"Properties",id:"properties",level:2},{value:"images?",id:"images",level:3},{value:"Source",id:"source",level:4},{value:"supportsMultipleAccounts?",id:"supportsmultipleaccounts",level:3},{value:"Source",id:"source-1",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,o.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"interface-authenticationprovideroptions",children:"Interface: AuthenticationProviderOptions"}),"\n",(0,i.jsxs)(n.p,{children:["Options for creating an ",(0,i.jsx)(n.a,{href:"#AuthenticationProvider",children:"AuthenticationProvider"}),"."]}),"\n",(0,i.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(n.h3,{id:"images",children:"images?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"readonly"})})," ",(0,i.jsx)(n.strong,{children:"images"}),": ",(0,i.jsx)(n.a,{href:"/api/interfaces/ProviderImages",children:(0,i.jsx)(n.code,{children:"ProviderImages"})})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L3520",children:"packages/extension-api/src/extension-api.d.ts:3520"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"supportsmultipleaccounts",children:"supportsMultipleAccounts?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"readonly"})})," ",(0,i.jsx)(n.strong,{children:"supportsMultipleAccounts"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Whether it is possible to be signed into multiple accounts at once with this provider.\nIf not specified, will default to false."}),"\n",(0,i.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L3518",children:"packages/extension-api/src/extension-api.d.ts:3518"})})]})}function p(e={}){const{wrapper:n}={...(0,o.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>c,a:()=>s});var i=t(27378);const o={},r=i.createContext(o);function s(e){const n=i.useContext(r);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:s(e.components),i.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/0c14b239.81af500f.js b/assets/js/0c14b239.43bce9c3.js similarity index 96% rename from assets/js/0c14b239.81af500f.js rename to assets/js/0c14b239.43bce9c3.js index 74d216a35b1..d305fdfff7e 100644 --- a/assets/js/0c14b239.81af500f.js +++ b/assets/js/0c14b239.43bce9c3.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[34479],{22902:(n,e,i)=>{i.r(e),i.d(e,{assets:()=>c,contentTitle:()=>r,default:()=>u,frontMatter:()=>t,metadata:()=>a,toc:()=>d});var s=i(24246),o=i(71670);const t={},r="Function: onDidChangeConfiguration()",a={id:"namespaces/configuration/functions/onDidChangeConfiguration",title:"Function: onDidChangeConfiguration()",description:"onDidChangeConfiguration(listener, thisArgs?, disposables?): Disposable",source:"@site/api/namespaces/configuration/functions/onDidChangeConfiguration.md",sourceDirName:"namespaces/configuration/functions",slug:"/namespaces/configuration/functions/onDidChangeConfiguration",permalink:"/api/namespaces/configuration/functions/onDidChangeConfiguration",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Function: getConfiguration()",permalink:"/api/namespaces/configuration/functions/getConfiguration"},next:{title:"Namespace: containerEngine",permalink:"/api/namespaces/containerEngine/"}},c={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function l(n){const e={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,o.a)(),...n.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(e.h1,{id:"function-ondidchangeconfiguration",children:"Function: onDidChangeConfiguration()"}),"\n",(0,s.jsxs)(e.blockquote,{children:["\n",(0,s.jsxs)(e.p,{children:[(0,s.jsx)(e.strong,{children:"onDidChangeConfiguration"}),"(",(0,s.jsx)(e.code,{children:"listener"}),", ",(0,s.jsx)(e.code,{children:"thisArgs"}),"?, ",(0,s.jsx)(e.code,{children:"disposables"}),"?): ",(0,s.jsx)(e.a,{href:"/api/classes/Disposable",children:(0,s.jsx)(e.code,{children:"Disposable"})})]}),"\n"]}),"\n",(0,s.jsxs)(e.p,{children:["An event that is emitted when the ",(0,s.jsx)(e.a,{href:"/api/interfaces/Configuration",children:"configuration"})," changed."]}),"\n",(0,s.jsx)(e.h2,{id:"parameters",children:"Parameters"}),"\n",(0,s.jsxs)(e.p,{children:["\u2022 ",(0,s.jsx)(e.strong,{children:"listener"})]}),"\n",(0,s.jsxs)(e.p,{children:["\u2022 ",(0,s.jsx)(e.strong,{children:"thisArgs?"}),": ",(0,s.jsx)(e.code,{children:"any"})]}),"\n",(0,s.jsxs)(e.p,{children:["\u2022 ",(0,s.jsx)(e.strong,{children:"disposables?"}),": ",(0,s.jsx)(e.a,{href:"/api/classes/Disposable",children:(0,s.jsx)(e.code,{children:"Disposable"})}),"[]"]}),"\n",(0,s.jsx)(e.h2,{id:"returns",children:"Returns"}),"\n",(0,s.jsx)(e.p,{children:(0,s.jsx)(e.a,{href:"/api/classes/Disposable",children:(0,s.jsx)(e.code,{children:"Disposable"})})}),"\n",(0,s.jsx)(e.h2,{id:"source",children:"Source"}),"\n",(0,s.jsx)(e.p,{children:(0,s.jsx)(e.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L656",children:"packages/extension-api/src/extension-api.d.ts:656"})})]})}function u(n={}){const{wrapper:e}={...(0,o.a)(),...n.components};return e?(0,s.jsx)(e,{...n,children:(0,s.jsx)(l,{...n})}):l(n)}},71670:(n,e,i)=>{i.d(e,{Z:()=>a,a:()=>r});var s=i(27378);const o={},t=s.createContext(o);function r(n){const e=s.useContext(t);return s.useMemo((function(){return"function"==typeof n?n(e):{...e,...n}}),[e,n])}function a(n){let e;return e=n.disableParentContext?"function"==typeof n.components?n.components(o):n.components||o:r(n.components),s.createElement(t.Provider,{value:e},n.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[34479],{22902:(n,e,i)=>{i.r(e),i.d(e,{assets:()=>c,contentTitle:()=>r,default:()=>u,frontMatter:()=>t,metadata:()=>a,toc:()=>d});var s=i(24246),o=i(71670);const t={},r="Function: onDidChangeConfiguration()",a={id:"namespaces/configuration/functions/onDidChangeConfiguration",title:"Function: onDidChangeConfiguration()",description:"onDidChangeConfiguration(listener, thisArgs?, disposables?): Disposable",source:"@site/api/namespaces/configuration/functions/onDidChangeConfiguration.md",sourceDirName:"namespaces/configuration/functions",slug:"/namespaces/configuration/functions/onDidChangeConfiguration",permalink:"/api/namespaces/configuration/functions/onDidChangeConfiguration",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Function: getConfiguration()",permalink:"/api/namespaces/configuration/functions/getConfiguration"},next:{title:"Namespace: containerEngine",permalink:"/api/namespaces/containerEngine/"}},c={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function l(n){const e={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,o.a)(),...n.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(e.h1,{id:"function-ondidchangeconfiguration",children:"Function: onDidChangeConfiguration()"}),"\n",(0,s.jsxs)(e.blockquote,{children:["\n",(0,s.jsxs)(e.p,{children:[(0,s.jsx)(e.strong,{children:"onDidChangeConfiguration"}),"(",(0,s.jsx)(e.code,{children:"listener"}),", ",(0,s.jsx)(e.code,{children:"thisArgs"}),"?, ",(0,s.jsx)(e.code,{children:"disposables"}),"?): ",(0,s.jsx)(e.a,{href:"/api/classes/Disposable",children:(0,s.jsx)(e.code,{children:"Disposable"})})]}),"\n"]}),"\n",(0,s.jsxs)(e.p,{children:["An event that is emitted when the ",(0,s.jsx)(e.a,{href:"/api/interfaces/Configuration",children:"configuration"})," changed."]}),"\n",(0,s.jsx)(e.h2,{id:"parameters",children:"Parameters"}),"\n",(0,s.jsxs)(e.p,{children:["\u2022 ",(0,s.jsx)(e.strong,{children:"listener"})]}),"\n",(0,s.jsxs)(e.p,{children:["\u2022 ",(0,s.jsx)(e.strong,{children:"thisArgs?"}),": ",(0,s.jsx)(e.code,{children:"any"})]}),"\n",(0,s.jsxs)(e.p,{children:["\u2022 ",(0,s.jsx)(e.strong,{children:"disposables?"}),": ",(0,s.jsx)(e.a,{href:"/api/classes/Disposable",children:(0,s.jsx)(e.code,{children:"Disposable"})}),"[]"]}),"\n",(0,s.jsx)(e.h2,{id:"returns",children:"Returns"}),"\n",(0,s.jsx)(e.p,{children:(0,s.jsx)(e.a,{href:"/api/classes/Disposable",children:(0,s.jsx)(e.code,{children:"Disposable"})})}),"\n",(0,s.jsx)(e.h2,{id:"source",children:"Source"}),"\n",(0,s.jsx)(e.p,{children:(0,s.jsx)(e.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L656",children:"packages/extension-api/src/extension-api.d.ts:656"})})]})}function u(n={}){const{wrapper:e}={...(0,o.a)(),...n.components};return e?(0,s.jsx)(e,{...n,children:(0,s.jsx)(l,{...n})}):l(n)}},71670:(n,e,i)=>{i.d(e,{Z:()=>a,a:()=>r});var s=i(27378);const o={},t=s.createContext(o);function r(n){const e=s.useContext(t);return s.useMemo((function(){return"function"==typeof n?n(e):{...e,...n}}),[e,n])}function a(n){let e;return e=n.disableParentContext?"function"==typeof n.components?n.components(o):n.components||o:r(n.components),s.createElement(t.Provider,{value:e},n.children)}}}]); \ No newline at end of file diff --git a/assets/js/0c4fad6b.d4930aaf.js b/assets/js/0c4fad6b.a3c675d8.js similarity index 97% rename from assets/js/0c4fad6b.d4930aaf.js rename to assets/js/0c4fad6b.a3c675d8.js index 10adee8ae22..41ca448f6b3 100644 --- a/assets/js/0c4fad6b.d4930aaf.js +++ b/assets/js/0c4fad6b.a3c675d8.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[41976],{14649:(n,e,t)=>{t.r(e),t.d(e,{assets:()=>r,contentTitle:()=>s,default:()=>p,frontMatter:()=>o,metadata:()=>c,toc:()=>u});var i=t(24246),a=t(71670);const o={},s="Function: navigateToAuthentication()",c={id:"namespaces/navigation/functions/navigateToAuthentication",title:"Function: navigateToAuthentication()",description:"navigateToAuthentication(): Promise\\",source:"@site/api/namespaces/navigation/functions/navigateToAuthentication.md",sourceDirName:"namespaces/navigation/functions",slug:"/namespaces/navigation/functions/navigateToAuthentication",permalink:"/api/namespaces/navigation/functions/navigateToAuthentication",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Namespace: navigation",permalink:"/api/namespaces/navigation/"},next:{title:"Function: navigateToContainer()",permalink:"/api/namespaces/navigation/functions/navigateToContainer"}},r={},u=[{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function d(n){const e={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,a.a)(),...n.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(e.h1,{id:"function-navigatetoauthentication",children:"Function: navigateToAuthentication()"}),"\n",(0,i.jsxs)(e.blockquote,{children:["\n",(0,i.jsxs)(e.p,{children:[(0,i.jsx)(e.strong,{children:"navigateToAuthentication"}),"(): ",(0,i.jsx)(e.code,{children:"Promise"}),"< ",(0,i.jsx)(e.code,{children:"void"})," >"]}),"\n"]}),"\n",(0,i.jsx)(e.p,{children:"Navigate to Authentication settings page"}),"\n",(0,i.jsx)(e.h2,{id:"returns",children:"Returns"}),"\n",(0,i.jsxs)(e.p,{children:[(0,i.jsx)(e.code,{children:"Promise"}),"< ",(0,i.jsx)(e.code,{children:"void"})," >"]}),"\n",(0,i.jsx)(e.h2,{id:"source",children:"Source"}),"\n",(0,i.jsx)(e.p,{children:(0,i.jsx)(e.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L4181",children:"packages/extension-api/src/extension-api.d.ts:4181"})})]})}function p(n={}){const{wrapper:e}={...(0,a.a)(),...n.components};return e?(0,i.jsx)(e,{...n,children:(0,i.jsx)(d,{...n})}):d(n)}},71670:(n,e,t)=>{t.d(e,{Z:()=>c,a:()=>s});var i=t(27378);const a={},o=i.createContext(a);function s(n){const e=i.useContext(o);return i.useMemo((function(){return"function"==typeof n?n(e):{...e,...n}}),[e,n])}function c(n){let e;return e=n.disableParentContext?"function"==typeof n.components?n.components(a):n.components||a:s(n.components),i.createElement(o.Provider,{value:e},n.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[41976],{14649:(n,e,t)=>{t.r(e),t.d(e,{assets:()=>r,contentTitle:()=>s,default:()=>p,frontMatter:()=>o,metadata:()=>c,toc:()=>u});var i=t(24246),a=t(71670);const o={},s="Function: navigateToAuthentication()",c={id:"namespaces/navigation/functions/navigateToAuthentication",title:"Function: navigateToAuthentication()",description:"navigateToAuthentication(): Promise\\",source:"@site/api/namespaces/navigation/functions/navigateToAuthentication.md",sourceDirName:"namespaces/navigation/functions",slug:"/namespaces/navigation/functions/navigateToAuthentication",permalink:"/api/namespaces/navigation/functions/navigateToAuthentication",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Namespace: navigation",permalink:"/api/namespaces/navigation/"},next:{title:"Function: navigateToContainer()",permalink:"/api/namespaces/navigation/functions/navigateToContainer"}},r={},u=[{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function d(n){const e={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,a.a)(),...n.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(e.h1,{id:"function-navigatetoauthentication",children:"Function: navigateToAuthentication()"}),"\n",(0,i.jsxs)(e.blockquote,{children:["\n",(0,i.jsxs)(e.p,{children:[(0,i.jsx)(e.strong,{children:"navigateToAuthentication"}),"(): ",(0,i.jsx)(e.code,{children:"Promise"}),"< ",(0,i.jsx)(e.code,{children:"void"})," >"]}),"\n"]}),"\n",(0,i.jsx)(e.p,{children:"Navigate to Authentication settings page"}),"\n",(0,i.jsx)(e.h2,{id:"returns",children:"Returns"}),"\n",(0,i.jsxs)(e.p,{children:[(0,i.jsx)(e.code,{children:"Promise"}),"< ",(0,i.jsx)(e.code,{children:"void"})," >"]}),"\n",(0,i.jsx)(e.h2,{id:"source",children:"Source"}),"\n",(0,i.jsx)(e.p,{children:(0,i.jsx)(e.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L4181",children:"packages/extension-api/src/extension-api.d.ts:4181"})})]})}function p(n={}){const{wrapper:e}={...(0,a.a)(),...n.components};return e?(0,i.jsx)(e,{...n,children:(0,i.jsx)(d,{...n})}):d(n)}},71670:(n,e,t)=>{t.d(e,{Z:()=>c,a:()=>s});var i=t(27378);const a={},o=i.createContext(a);function s(n){const e=i.useContext(o);return i.useMemo((function(){return"function"==typeof n?n(e):{...e,...n}}),[e,n])}function c(n){let e;return e=n.disableParentContext?"function"==typeof n.components?n.components(a):n.components||a:s(n.components),i.createElement(o.Provider,{value:e},n.children)}}}]); \ No newline at end of file diff --git a/assets/js/0cab2b3a.d0a1f8f9.js b/assets/js/0cab2b3a.0f34acb7.js similarity index 84% rename from assets/js/0cab2b3a.d0a1f8f9.js rename to assets/js/0cab2b3a.0f34acb7.js index f727b4954ba..a25454ba1bf 100644 --- a/assets/js/0cab2b3a.d0a1f8f9.js +++ b/assets/js/0cab2b3a.0f34acb7.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[85714],{68282:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>i,contentTitle:()=>o,default:()=>l,frontMatter:()=>r,metadata:()=>a,toc:()=>d});var t=s(24246),c=s(71670);const r={},o="Function: executeCommand()",a={id:"namespaces/commands/functions/executeCommand",title:"Function: executeCommand()",description:"executeCommand\\(command, ...rest): PromiseLike\\",source:"@site/api/namespaces/commands/functions/executeCommand.md",sourceDirName:"namespaces/commands/functions",slug:"/namespaces/commands/functions/executeCommand",permalink:"/api/namespaces/commands/functions/executeCommand",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Namespace: commands",permalink:"/api/namespaces/commands/"},next:{title:"Function: registerCommand()",permalink:"/api/namespaces/commands/functions/registerCommand"}},i={},d=[{value:"Type parameters",id:"type-parameters",level:2},{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Throws",id:"throws",level:2},{value:"Throws",id:"throws-1",level:2},{value:"Source",id:"source",level:2}];function m(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,c.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"function-executecommand",children:"Function: executeCommand()"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"executeCommand"}),"<",(0,t.jsx)(n.code,{children:"T"}),">(",(0,t.jsx)(n.code,{children:"command"}),", ...",(0,t.jsx)(n.code,{children:"rest"}),"): ",(0,t.jsx)(n.code,{children:"PromiseLike"}),"< ",(0,t.jsx)(n.code,{children:"T"})," >"]}),"\n"]}),"\n",(0,t.jsxs)(n.p,{children:["Execute a command, previously registered with ",(0,t.jsx)(n.a,{href:"/api/namespaces/commands/functions/registerCommand",children:"commands.registerCommand"})]}),"\n",(0,t.jsx)(n.h2,{id:"type-parameters",children:"Type parameters"}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"T"})," = ",(0,t.jsx)(n.code,{children:"unknown"})]}),"\n",(0,t.jsx)(n.p,{children:"the type of the value returned by the command"}),"\n",(0,t.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"command"}),": ",(0,t.jsx)(n.code,{children:"string"})]}),"\n",(0,t.jsx)(n.p,{children:"the name used for registering the command"}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ...",(0,t.jsx)(n.strong,{children:"rest"}),": ",(0,t.jsx)(n.code,{children:"any"}),"[]"]}),"\n",(0,t.jsx)(n.p,{children:"the parameters to pass to the command"}),"\n",(0,t.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"PromiseLike"}),"< ",(0,t.jsx)(n.code,{children:"T"})," >"]}),"\n",(0,t.jsx)(n.p,{children:"the value returned by the command"}),"\n",(0,t.jsx)(n.h2,{id:"throws",children:"Throws"}),"\n",(0,t.jsx)(n.p,{children:"if the command is not registered"}),"\n",(0,t.jsx)(n.h2,{id:"throws-1",children:"Throws"}),"\n",(0,t.jsx)(n.p,{children:"if the command throws an exception"}),"\n",(0,t.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L505",children:"packages/extension-api/src/extension-api.d.ts:505"})})]})}function l(e={}){const{wrapper:n}={...(0,c.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(m,{...e})}):m(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>a,a:()=>o});var t=s(27378);const c={},r=t.createContext(c);function o(e){const n=t.useContext(r);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function a(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(c):e.components||c:o(e.components),t.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[85714],{68282:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>i,contentTitle:()=>o,default:()=>l,frontMatter:()=>c,metadata:()=>a,toc:()=>d});var t=s(24246),r=s(71670);const c={},o="Function: executeCommand()",a={id:"namespaces/commands/functions/executeCommand",title:"Function: executeCommand()",description:"executeCommand\\(command, ...rest): PromiseLike\\",source:"@site/api/namespaces/commands/functions/executeCommand.md",sourceDirName:"namespaces/commands/functions",slug:"/namespaces/commands/functions/executeCommand",permalink:"/api/namespaces/commands/functions/executeCommand",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Namespace: commands",permalink:"/api/namespaces/commands/"},next:{title:"Function: registerCommand()",permalink:"/api/namespaces/commands/functions/registerCommand"}},i={},d=[{value:"Type parameters",id:"type-parameters",level:2},{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Throws",id:"throws",level:2},{value:"Throws",id:"throws-1",level:2},{value:"Source",id:"source",level:2}];function m(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,r.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"function-executecommand",children:"Function: executeCommand()"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"executeCommand"}),"<",(0,t.jsx)(n.code,{children:"T"}),">(",(0,t.jsx)(n.code,{children:"command"}),", ...",(0,t.jsx)(n.code,{children:"rest"}),"): ",(0,t.jsx)(n.code,{children:"PromiseLike"}),"< ",(0,t.jsx)(n.code,{children:"T"})," >"]}),"\n"]}),"\n",(0,t.jsxs)(n.p,{children:["Execute a command, previously registered with ",(0,t.jsx)(n.a,{href:"/api/namespaces/commands/functions/registerCommand",children:"commands.registerCommand"})]}),"\n",(0,t.jsx)(n.h2,{id:"type-parameters",children:"Type parameters"}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"T"})," = ",(0,t.jsx)(n.code,{children:"unknown"})]}),"\n",(0,t.jsx)(n.p,{children:"the type of the value returned by the command"}),"\n",(0,t.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"command"}),": ",(0,t.jsx)(n.code,{children:"string"})]}),"\n",(0,t.jsx)(n.p,{children:"the name used for registering the command"}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ...",(0,t.jsx)(n.strong,{children:"rest"}),": ",(0,t.jsx)(n.code,{children:"any"}),"[]"]}),"\n",(0,t.jsx)(n.p,{children:"the parameters to pass to the command"}),"\n",(0,t.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"PromiseLike"}),"< ",(0,t.jsx)(n.code,{children:"T"})," >"]}),"\n",(0,t.jsx)(n.p,{children:"the value returned by the command"}),"\n",(0,t.jsx)(n.h2,{id:"throws",children:"Throws"}),"\n",(0,t.jsx)(n.p,{children:"if the command is not registered"}),"\n",(0,t.jsx)(n.h2,{id:"throws-1",children:"Throws"}),"\n",(0,t.jsx)(n.p,{children:"if the command throws an exception"}),"\n",(0,t.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L505",children:"packages/extension-api/src/extension-api.d.ts:505"})})]})}function l(e={}){const{wrapper:n}={...(0,r.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(m,{...e})}):m(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>a,a:()=>o});var t=s(27378);const r={},c=t.createContext(r);function o(e){const n=t.useContext(c);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function a(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:o(e.components),t.createElement(c.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/0e3a398f.41910b52.js b/assets/js/0e3a398f.983c8ec6.js similarity index 77% rename from assets/js/0e3a398f.41910b52.js rename to assets/js/0e3a398f.983c8ec6.js index fb636f0799d..7ecc21456d8 100644 --- a/assets/js/0e3a398f.41910b52.js +++ b/assets/js/0e3a398f.983c8ec6.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[30466],{78814:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>c,default:()=>u,frontMatter:()=>i,metadata:()=>s,toc:()=>d});var r=t(24246),o=t(71670);const i={},c="Interface: KubernetesProviderConnectionEndpoint",s={id:"interfaces/KubernetesProviderConnectionEndpoint",title:"Interface: KubernetesProviderConnectionEndpoint",description:"Properties",source:"@site/api/interfaces/KubernetesProviderConnectionEndpoint.md",sourceDirName:"interfaces",slug:"/interfaces/KubernetesProviderConnectionEndpoint",permalink:"/api/interfaces/KubernetesProviderConnectionEndpoint",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: KubernetesProviderConnection",permalink:"/api/interfaces/KubernetesProviderConnection"},next:{title:"Interface: KubernetesProviderConnectionFactory",permalink:"/api/interfaces/KubernetesProviderConnectionFactory"}},a={},d=[{value:"Properties",id:"properties",level:2},{value:"apiURL",id:"apiurl",level:3},{value:"Source",id:"source",level:4}];function p(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",p:"p",strong:"strong",...(0,o.a)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.h1,{id:"interface-kubernetesproviderconnectionendpoint",children:"Interface: KubernetesProviderConnectionEndpoint"}),"\n",(0,r.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,r.jsx)(n.h3,{id:"apiurl",children:"apiURL"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"apiURL"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L299",children:"packages/extension-api/src/extension-api.d.ts:299"})})]})}function u(e={}){const{wrapper:n}={...(0,o.a)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(p,{...e})}):p(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>s,a:()=>c});var r=t(27378);const o={},i=r.createContext(o);function c(e){const n=r.useContext(i);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function s(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:c(e.components),r.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[30466],{78814:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>s,default:()=>u,frontMatter:()=>i,metadata:()=>c,toc:()=>d});var r=t(24246),o=t(71670);const i={},s="Interface: KubernetesProviderConnectionEndpoint",c={id:"interfaces/KubernetesProviderConnectionEndpoint",title:"Interface: KubernetesProviderConnectionEndpoint",description:"Properties",source:"@site/api/interfaces/KubernetesProviderConnectionEndpoint.md",sourceDirName:"interfaces",slug:"/interfaces/KubernetesProviderConnectionEndpoint",permalink:"/api/interfaces/KubernetesProviderConnectionEndpoint",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: KubernetesProviderConnection",permalink:"/api/interfaces/KubernetesProviderConnection"},next:{title:"Interface: KubernetesProviderConnectionFactory",permalink:"/api/interfaces/KubernetesProviderConnectionFactory"}},a={},d=[{value:"Properties",id:"properties",level:2},{value:"apiURL",id:"apiurl",level:3},{value:"Source",id:"source",level:4}];function p(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",p:"p",strong:"strong",...(0,o.a)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.h1,{id:"interface-kubernetesproviderconnectionendpoint",children:"Interface: KubernetesProviderConnectionEndpoint"}),"\n",(0,r.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,r.jsx)(n.h3,{id:"apiurl",children:"apiURL"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"apiURL"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L299",children:"packages/extension-api/src/extension-api.d.ts:299"})})]})}function u(e={}){const{wrapper:n}={...(0,o.a)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(p,{...e})}):p(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>c,a:()=>s});var r=t(27378);const o={},i=r.createContext(o);function s(e){const n=r.useContext(i);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:s(e.components),r.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/0e72c11a.40b87b3a.js b/assets/js/0e72c11a.d764a4f4.js similarity index 97% rename from assets/js/0e72c11a.40b87b3a.js rename to assets/js/0e72c11a.d764a4f4.js index 6db66ae8954..8de4ef9fd12 100644 --- a/assets/js/0e72c11a.40b87b3a.js +++ b/assets/js/0e72c11a.d764a4f4.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[19536],{51215:(e,n,o)=>{o.r(n),o.d(n,{assets:()=>r,contentTitle:()=>a,default:()=>p,frontMatter:()=>i,metadata:()=>c,toc:()=>u});var s=o(24246),t=o(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:"Function: navigateToPods()",permalink:"/api/namespaces/navigation/functions/navigateToPods"},next:{title:"Function: navigateToVolume()",permalink:"/api/namespaces/navigation/functions/navigateToVolume"}},r={},u=[{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function d(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,t.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"function-navigatetoresources",children:"Function: navigateToResources()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"navigateToResources"}),"(): ",(0,s.jsx)(n.code,{children:"Promise"}),"< ",(0,s.jsx)(n.code,{children:"void"})," >"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Navigate to Resources page"}),"\n",(0,s.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"Promise"}),"< ",(0,s.jsx)(n.code,{children:"void"})," >"]}),"\n",(0,s.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L4186",children:"packages/extension-api/src/extension-api.d.ts:4186"})})]})}function p(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(d,{...e})}):d(e)}},71670:(e,n,o)=>{o.d(n,{Z:()=>c,a:()=>a});var s=o(27378);const t={},i=s.createContext(t);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(t):e.components||t:a(e.components),s.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[19536],{51215:(e,n,o)=>{o.r(n),o.d(n,{assets:()=>r,contentTitle:()=>a,default:()=>p,frontMatter:()=>i,metadata:()=>c,toc:()=>u});var s=o(24246),t=o(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:"Function: navigateToPods()",permalink:"/api/namespaces/navigation/functions/navigateToPods"},next:{title:"Function: navigateToVolume()",permalink:"/api/namespaces/navigation/functions/navigateToVolume"}},r={},u=[{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function d(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,t.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"function-navigatetoresources",children:"Function: navigateToResources()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"navigateToResources"}),"(): ",(0,s.jsx)(n.code,{children:"Promise"}),"< ",(0,s.jsx)(n.code,{children:"void"})," >"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Navigate to Resources page"}),"\n",(0,s.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"Promise"}),"< ",(0,s.jsx)(n.code,{children:"void"})," >"]}),"\n",(0,s.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L4186",children:"packages/extension-api/src/extension-api.d.ts:4186"})})]})}function p(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(d,{...e})}):d(e)}},71670:(e,n,o)=>{o.d(n,{Z:()=>c,a:()=>a});var s=o(27378);const t={},i=s.createContext(t);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(t):e.components||t:a(e.components),s.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/0f54081d.93573599.js b/assets/js/0f54081d.789a7dd1.js similarity index 96% rename from assets/js/0f54081d.93573599.js rename to assets/js/0f54081d.789a7dd1.js index 5c1d72a4138..efe66226163 100644 --- a/assets/js/0f54081d.93573599.js +++ b/assets/js/0f54081d.789a7dd1.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[37073],{25361:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>d,contentTitle:()=>c,default:()=>p,frontMatter:()=>i,metadata:()=>s,toc:()=>a});var r=t(24246),o=t(71670);const i={},c="Function: getProviderLifecycleContext()",s={id:"namespaces/provider/functions/getProviderLifecycleContext",title:"Function: getProviderLifecycleContext()",description:"getProviderLifecycleContext(providerId, containerProviderConnection): LifecycleContext",source:"@site/api/namespaces/provider/functions/getProviderLifecycleContext.md",sourceDirName:"namespaces/provider/functions",slug:"/namespaces/provider/functions/getProviderLifecycleContext",permalink:"/api/namespaces/provider/functions/getProviderLifecycleContext",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Function: getContainerConnections()",permalink:"/api/namespaces/provider/functions/getContainerConnections"},next:{title:"Function: onDidRegisterContainerConnection()",permalink:"/api/namespaces/provider/functions/onDidRegisterContainerConnection"}},d={},a=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Throws",id:"throws",level:2},{value:"Source",id:"source",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,o.a)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.h1,{id:"function-getproviderlifecyclecontext",children:"Function: getProviderLifecycleContext()"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"getProviderLifecycleContext"}),"(",(0,r.jsx)(n.code,{children:"providerId"}),", ",(0,r.jsx)(n.code,{children:"containerProviderConnection"}),"): ",(0,r.jsx)(n.a,{href:"/api/interfaces/LifecycleContext",children:(0,r.jsx)(n.code,{children:"LifecycleContext"})})]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"It returns the lifecycle context for the provider connection.\nIf no context is found it throws an error"}),"\n",(0,r.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"providerId"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n",(0,r.jsx)(n.p,{children:"the provider id"}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"containerProviderConnection"}),": ",(0,r.jsx)(n.a,{href:"/api/interfaces/ContainerProviderConnection",children:(0,r.jsx)(n.code,{children:"ContainerProviderConnection"})})]}),"\n",(0,r.jsx)(n.p,{children:"the connection to retrieve the lifecycle context for"}),"\n",(0,r.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"/api/interfaces/LifecycleContext",children:(0,r.jsx)(n.code,{children:"LifecycleContext"})})}),"\n",(0,r.jsx)(n.p,{children:"the lifecycle context"}),"\n",(0,r.jsx)(n.h2,{id:"throws",children:"Throws"}),"\n",(0,r.jsx)(n.p,{children:"if no provider with the id has been found or there is no context associate to it."}),"\n",(0,r.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L561",children:"packages/extension-api/src/extension-api.d.ts:561"})})]})}function p(e={}){const{wrapper:n}={...(0,o.a)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(l,{...e})}):l(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>s,a:()=>c});var r=t(27378);const o={},i=r.createContext(o);function c(e){const n=r.useContext(i);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function s(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:c(e.components),r.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[37073],{25361:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>d,contentTitle:()=>c,default:()=>p,frontMatter:()=>i,metadata:()=>s,toc:()=>a});var r=t(24246),o=t(71670);const i={},c="Function: getProviderLifecycleContext()",s={id:"namespaces/provider/functions/getProviderLifecycleContext",title:"Function: getProviderLifecycleContext()",description:"getProviderLifecycleContext(providerId, containerProviderConnection): LifecycleContext",source:"@site/api/namespaces/provider/functions/getProviderLifecycleContext.md",sourceDirName:"namespaces/provider/functions",slug:"/namespaces/provider/functions/getProviderLifecycleContext",permalink:"/api/namespaces/provider/functions/getProviderLifecycleContext",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Function: getContainerConnections()",permalink:"/api/namespaces/provider/functions/getContainerConnections"},next:{title:"Function: onDidRegisterContainerConnection()",permalink:"/api/namespaces/provider/functions/onDidRegisterContainerConnection"}},d={},a=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Throws",id:"throws",level:2},{value:"Source",id:"source",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,o.a)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.h1,{id:"function-getproviderlifecyclecontext",children:"Function: getProviderLifecycleContext()"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"getProviderLifecycleContext"}),"(",(0,r.jsx)(n.code,{children:"providerId"}),", ",(0,r.jsx)(n.code,{children:"containerProviderConnection"}),"): ",(0,r.jsx)(n.a,{href:"/api/interfaces/LifecycleContext",children:(0,r.jsx)(n.code,{children:"LifecycleContext"})})]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"It returns the lifecycle context for the provider connection.\nIf no context is found it throws an error"}),"\n",(0,r.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"providerId"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n",(0,r.jsx)(n.p,{children:"the provider id"}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"containerProviderConnection"}),": ",(0,r.jsx)(n.a,{href:"/api/interfaces/ContainerProviderConnection",children:(0,r.jsx)(n.code,{children:"ContainerProviderConnection"})})]}),"\n",(0,r.jsx)(n.p,{children:"the connection to retrieve the lifecycle context for"}),"\n",(0,r.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"/api/interfaces/LifecycleContext",children:(0,r.jsx)(n.code,{children:"LifecycleContext"})})}),"\n",(0,r.jsx)(n.p,{children:"the lifecycle context"}),"\n",(0,r.jsx)(n.h2,{id:"throws",children:"Throws"}),"\n",(0,r.jsx)(n.p,{children:"if no provider with the id has been found or there is no context associate to it."}),"\n",(0,r.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L561",children:"packages/extension-api/src/extension-api.d.ts:561"})})]})}function p(e={}){const{wrapper:n}={...(0,o.a)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(l,{...e})}):l(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>s,a:()=>c});var r=t(27378);const o={},i=r.createContext(o);function c(e){const n=r.useContext(i);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function s(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:c(e.components),r.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/0fa6e9bf.8176967b.js b/assets/js/0fa6e9bf.e677d805.js similarity index 89% rename from assets/js/0fa6e9bf.8176967b.js rename to assets/js/0fa6e9bf.e677d805.js index 3cb30167c2a..0265500f15e 100644 --- a/assets/js/0fa6e9bf.8176967b.js +++ b/assets/js/0fa6e9bf.e677d805.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[54063],{7735:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>a,contentTitle:()=>c,default:()=>d,frontMatter:()=>o,metadata:()=>i,toc:()=>l});var t=s(24246),r=s(71670);const o={},c="Function: openExternal()",i={id:"namespaces/env/functions/openExternal",title:"Function: openExternal()",description:"openExternal(uri): Promise\\",source:"@site/api/namespaces/env/functions/openExternal.md",sourceDirName:"namespaces/env/functions",slug:"/namespaces/env/functions/openExternal",permalink:"/api/namespaces/env/functions/openExternal",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Function: onDidChangeTelemetryEnabled()",permalink:"/api/namespaces/env/functions/onDidChangeTelemetryEnabled"},next:{title:"Namespace: fs",permalink:"/api/namespaces/fs/"}},a={},l=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function p(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,r.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"function-openexternal",children:"Function: openExternal()"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"openExternal"}),"(",(0,t.jsx)(n.code,{children:"uri"}),"): ",(0,t.jsx)(n.code,{children:"Promise"}),"< ",(0,t.jsx)(n.code,{children:"boolean"})," >"]}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"Opens a link externally using the default application. Depending on the"}),"\n",(0,t.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"uri"}),": ",(0,t.jsx)(n.a,{href:"/api/classes/Uri",children:(0,t.jsx)(n.code,{children:"Uri"})})]}),"\n",(0,t.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"Promise"}),"< ",(0,t.jsx)(n.code,{children:"boolean"})," >"]}),"\n",(0,t.jsx)(n.p,{children:"A promise indicating if open was successful."}),"\n",(0,t.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L3703",children:"packages/extension-api/src/extension-api.d.ts:3703"})})]})}function d(e={}){const{wrapper:n}={...(0,r.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(p,{...e})}):p(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>i,a:()=>c});var t=s(27378);const r={},o=t.createContext(r);function c(e){const n=t.useContext(o);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function i(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:c(e.components),t.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[54063],{7735:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>a,contentTitle:()=>c,default:()=>p,frontMatter:()=>o,metadata:()=>i,toc:()=>l});var t=s(24246),r=s(71670);const o={},c="Function: openExternal()",i={id:"namespaces/env/functions/openExternal",title:"Function: openExternal()",description:"openExternal(uri): Promise\\",source:"@site/api/namespaces/env/functions/openExternal.md",sourceDirName:"namespaces/env/functions",slug:"/namespaces/env/functions/openExternal",permalink:"/api/namespaces/env/functions/openExternal",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Function: onDidChangeTelemetryEnabled()",permalink:"/api/namespaces/env/functions/onDidChangeTelemetryEnabled"},next:{title:"Namespace: fs",permalink:"/api/namespaces/fs/"}},a={},l=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function d(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,r.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"function-openexternal",children:"Function: openExternal()"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"openExternal"}),"(",(0,t.jsx)(n.code,{children:"uri"}),"): ",(0,t.jsx)(n.code,{children:"Promise"}),"< ",(0,t.jsx)(n.code,{children:"boolean"})," >"]}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"Opens a link externally using the default application. Depending on the"}),"\n",(0,t.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"uri"}),": ",(0,t.jsx)(n.a,{href:"/api/classes/Uri",children:(0,t.jsx)(n.code,{children:"Uri"})})]}),"\n",(0,t.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"Promise"}),"< ",(0,t.jsx)(n.code,{children:"boolean"})," >"]}),"\n",(0,t.jsx)(n.p,{children:"A promise indicating if open was successful."}),"\n",(0,t.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L3703",children:"packages/extension-api/src/extension-api.d.ts:3703"})})]})}function p(e={}){const{wrapper:n}={...(0,r.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(d,{...e})}):d(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>i,a:()=>c});var t=s(27378);const r={},o=t.createContext(r);function c(e){const n=t.useContext(o);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function i(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:c(e.components),t.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/107d77e6.4c4887bd.js b/assets/js/107d77e6.e3726056.js similarity index 84% rename from assets/js/107d77e6.4c4887bd.js rename to assets/js/107d77e6.e3726056.js index d31445222c1..d4d2976adf5 100644 --- a/assets/js/107d77e6.4c4887bd.js +++ b/assets/js/107d77e6.e3726056.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[51051],{12585:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>o,default:()=>p,frontMatter:()=>r,metadata:()=>c,toc:()=>l});var i=t(24246),s=t(71670);const r={},o="Interface: ListInfosOptions",c={id:"interfaces/ListInfosOptions",title:"Interface: ListInfosOptions",description:"Properties",source:"@site/api/interfaces/ListInfosOptions.md",sourceDirName:"interfaces",slug:"/interfaces/ListInfosOptions",permalink:"/api/interfaces/ListInfosOptions",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: ListImagesOptions",permalink:"/api/interfaces/ListImagesOptions"},next:{title:"Interface: Logger",permalink:"/api/interfaces/Logger"}},a={},l=[{value:"Properties",id:"properties",level:2},{value:"provider?",id:"provider",level:3},{value:"Default Value",id:"default-value",level:4},{value:"Source",id:"source",level:4}];function d(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",p:"p",pre:"pre",strong:"strong",...(0,s.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"interface-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.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"provider"}),": ",(0,i.jsx)(n.a,{href:"/api/interfaces/ContainerProviderConnection",children:(0,i.jsx)(n.code,{children:"ContainerProviderConnection"})})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"The provider we want to list the infos. If not provided, will return info for all engines."}),"\n",(0,i.jsx)(n.h4,{id:"default-value",children:"Default Value"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-ts",children:"undefined\n"})}),"\n",(0,i.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L3146",children:"packages/extension-api/src/extension-api.d.ts:3146"})})]})}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:()=>c,a:()=>o});var i=t(27378);const s={},r=i.createContext(s);function o(e){const n=i.useContext(r);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:o(e.components),i.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[51051],{12585:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>o,default:()=>p,frontMatter:()=>r,metadata:()=>c,toc:()=>d});var i=t(24246),s=t(71670);const r={},o="Interface: ListInfosOptions",c={id:"interfaces/ListInfosOptions",title:"Interface: ListInfosOptions",description:"Properties",source:"@site/api/interfaces/ListInfosOptions.md",sourceDirName:"interfaces",slug:"/interfaces/ListInfosOptions",permalink:"/api/interfaces/ListInfosOptions",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: ListImagesOptions",permalink:"/api/interfaces/ListImagesOptions"},next:{title:"Interface: Logger",permalink:"/api/interfaces/Logger"}},a={},d=[{value:"Properties",id:"properties",level:2},{value:"provider?",id:"provider",level:3},{value:"Default Value",id:"default-value",level:4},{value:"Source",id:"source",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",p:"p",pre:"pre",strong:"strong",...(0,s.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"interface-listinfosoptions",children:"Interface: ListInfosOptions"}),"\n",(0,i.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(n.h3,{id:"provider",children:"provider?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"provider"}),": ",(0,i.jsx)(n.a,{href:"/api/interfaces/ContainerProviderConnection",children:(0,i.jsx)(n.code,{children:"ContainerProviderConnection"})})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"The provider we want to list the infos. If not provided, will return info for all engines."}),"\n",(0,i.jsx)(n.h4,{id:"default-value",children:"Default Value"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-ts",children:"undefined\n"})}),"\n",(0,i.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L3146",children:"packages/extension-api/src/extension-api.d.ts:3146"})})]})}function p(e={}){const{wrapper:n}={...(0,s.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>c,a:()=>o});var i=t(27378);const s={},r=i.createContext(s);function o(e){const n=i.useContext(r);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:o(e.components),i.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/123a454a.c7fc15b7.js b/assets/js/123a454a.18a2679b.js similarity index 85% rename from assets/js/123a454a.c7fc15b7.js rename to assets/js/123a454a.18a2679b.js index d91a4d1c311..04474a8851d 100644 --- a/assets/js/123a454a.c7fc15b7.js +++ b/assets/js/123a454a.18a2679b.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[29693],{16241:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>o,default:()=>u,frontMatter:()=>c,metadata:()=>i,toc:()=>d});var s=t(24246),r=t(71670);const c={},o="Interface: RunResult",i={id:"interfaces/RunResult",title:"Interface: RunResult",description:"Represents the result of running a command.",source:"@site/api/interfaces/RunResult.md",sourceDirName:"interfaces",slug:"/interfaces/RunResult",permalink:"/api/interfaces/RunResult",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: RunOptions",permalink:"/api/interfaces/RunOptions"},next:{title:"Interface: SaveDialogOptions",permalink:"/api/interfaces/SaveDialogOptions"}},a={},d=[{value:"Properties",id:"properties",level:2},{value:"command",id:"command",level:3},{value:"Source",id:"source",level:4},{value:"stderr",id:"stderr",level:3},{value:"Source",id:"source-1",level:4},{value:"stdout",id:"stdout",level:3},{value:"Source",id:"source-2",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,r.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"interface-runresult",children:"Interface: RunResult"}),"\n",(0,s.jsx)(n.p,{children:"Represents the result of running a command."}),"\n",(0,s.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,s.jsx)(n.h3,{id:"command",children:"command"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"command"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The command that was executed."}),"\n",(0,s.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L3762",children:"packages/extension-api/src/extension-api.d.ts:3762"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"stderr",children:"stderr"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"stderr"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The standard error (stderr) content of the command."}),"\n",(0,s.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L3772",children:"packages/extension-api/src/extension-api.d.ts:3772"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"stdout",children:"stdout"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"stdout"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The standard output (stdout) content of the command."}),"\n",(0,s.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L3767",children:"packages/extension-api/src/extension-api.d.ts:3767"})})]})}function u(e={}){const{wrapper:n}={...(0,r.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>i,a:()=>o});var s=t(27378);const r={},c=s.createContext(r);function o(e){const n=s.useContext(c);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function i(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:o(e.components),s.createElement(c.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[29693],{16241:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>d,contentTitle:()=>o,default:()=>u,frontMatter:()=>c,metadata:()=>i,toc:()=>a});var s=t(24246),r=t(71670);const c={},o="Interface: RunResult",i={id:"interfaces/RunResult",title:"Interface: RunResult",description:"Represents the result of running a command.",source:"@site/api/interfaces/RunResult.md",sourceDirName:"interfaces",slug:"/interfaces/RunResult",permalink:"/api/interfaces/RunResult",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: RunOptions",permalink:"/api/interfaces/RunOptions"},next:{title:"Interface: SaveDialogOptions",permalink:"/api/interfaces/SaveDialogOptions"}},d={},a=[{value:"Properties",id:"properties",level:2},{value:"command",id:"command",level:3},{value:"Source",id:"source",level:4},{value:"stderr",id:"stderr",level:3},{value:"Source",id:"source-1",level:4},{value:"stdout",id:"stdout",level:3},{value:"Source",id:"source-2",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,r.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"interface-runresult",children:"Interface: RunResult"}),"\n",(0,s.jsx)(n.p,{children:"Represents the result of running a command."}),"\n",(0,s.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,s.jsx)(n.h3,{id:"command",children:"command"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"command"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The command that was executed."}),"\n",(0,s.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L3762",children:"packages/extension-api/src/extension-api.d.ts:3762"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"stderr",children:"stderr"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"stderr"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The standard error (stderr) content of the command."}),"\n",(0,s.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L3772",children:"packages/extension-api/src/extension-api.d.ts:3772"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"stdout",children:"stdout"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"stdout"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The standard output (stdout) content of the command."}),"\n",(0,s.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L3767",children:"packages/extension-api/src/extension-api.d.ts:3767"})})]})}function u(e={}){const{wrapper:n}={...(0,r.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>i,a:()=>o});var s=t(27378);const r={},c=s.createContext(r);function o(e){const n=s.useContext(c);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function i(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:o(e.components),s.createElement(c.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/125d93c1.a5a33191.js b/assets/js/125d93c1.62423075.js similarity index 94% rename from assets/js/125d93c1.a5a33191.js rename to assets/js/125d93c1.62423075.js index 60600572f85..dbfbc29a2c0 100644 --- a/assets/js/125d93c1.a5a33191.js +++ b/assets/js/125d93c1.62423075.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[22228],{20333:(n,e,o)=>{o.r(e),o.d(e,{assets:()=>r,contentTitle:()=>a,default:()=>p,frontMatter:()=>i,metadata:()=>c,toc:()=>d});var t=o(24246),s=o(71670);const i={},a="Function: navigateToPods()",c={id:"namespaces/navigation/functions/navigateToPods",title:"Function: navigateToPods()",description:"navigateToPods(): Promise\\",source:"@site/api/namespaces/navigation/functions/navigateToPods.md",sourceDirName:"namespaces/navigation/functions",slug:"/namespaces/navigation/functions/navigateToPods",permalink:"/api/namespaces/navigation/functions/navigateToPods",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Function: navigateToPod()",permalink:"/api/namespaces/navigation/functions/navigateToPod"},next:{title:"Function: navigateToResources()",permalink:"/api/namespaces/navigation/functions/navigateToResources"}},r={},d=[{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function u(n){const e={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,s.a)(),...n.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(e.h1,{id:"function-navigatetopods",children:"Function: navigateToPods()"}),"\n",(0,t.jsxs)(e.blockquote,{children:["\n",(0,t.jsxs)(e.p,{children:[(0,t.jsx)(e.strong,{children:"navigateToPods"}),"(): ",(0,t.jsx)(e.code,{children:"Promise"}),"< ",(0,t.jsx)(e.code,{children:"void"})," >"]}),"\n"]}),"\n",(0,t.jsx)(e.h2,{id:"returns",children:"Returns"}),"\n",(0,t.jsxs)(e.p,{children:[(0,t.jsx)(e.code,{children:"Promise"}),"< ",(0,t.jsx)(e.code,{children:"void"})," >"]}),"\n",(0,t.jsx)(e.h2,{id:"source",children:"Source"}),"\n",(0,t.jsx)(e.p,{children:(0,t.jsx)(e.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L4163",children:"packages/extension-api/src/extension-api.d.ts:4163"})})]})}function p(n={}){const{wrapper:e}={...(0,s.a)(),...n.components};return e?(0,t.jsx)(e,{...n,children:(0,t.jsx)(u,{...n})}):u(n)}},71670:(n,e,o)=>{o.d(e,{Z:()=>c,a:()=>a});var t=o(27378);const s={},i=t.createContext(s);function a(n){const e=t.useContext(i);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(i.Provider,{value:e},n.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[22228],{20333:(n,e,o)=>{o.r(e),o.d(e,{assets:()=>r,contentTitle:()=>a,default:()=>p,frontMatter:()=>i,metadata:()=>c,toc:()=>d});var t=o(24246),s=o(71670);const i={},a="Function: navigateToPods()",c={id:"namespaces/navigation/functions/navigateToPods",title:"Function: navigateToPods()",description:"navigateToPods(): Promise\\",source:"@site/api/namespaces/navigation/functions/navigateToPods.md",sourceDirName:"namespaces/navigation/functions",slug:"/namespaces/navigation/functions/navigateToPods",permalink:"/api/namespaces/navigation/functions/navigateToPods",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Function: navigateToPod()",permalink:"/api/namespaces/navigation/functions/navigateToPod"},next:{title:"Function: navigateToResources()",permalink:"/api/namespaces/navigation/functions/navigateToResources"}},r={},d=[{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function u(n){const e={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,s.a)(),...n.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(e.h1,{id:"function-navigatetopods",children:"Function: navigateToPods()"}),"\n",(0,t.jsxs)(e.blockquote,{children:["\n",(0,t.jsxs)(e.p,{children:[(0,t.jsx)(e.strong,{children:"navigateToPods"}),"(): ",(0,t.jsx)(e.code,{children:"Promise"}),"< ",(0,t.jsx)(e.code,{children:"void"})," >"]}),"\n"]}),"\n",(0,t.jsx)(e.h2,{id:"returns",children:"Returns"}),"\n",(0,t.jsxs)(e.p,{children:[(0,t.jsx)(e.code,{children:"Promise"}),"< ",(0,t.jsx)(e.code,{children:"void"})," >"]}),"\n",(0,t.jsx)(e.h2,{id:"source",children:"Source"}),"\n",(0,t.jsx)(e.p,{children:(0,t.jsx)(e.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L4163",children:"packages/extension-api/src/extension-api.d.ts:4163"})})]})}function p(n={}){const{wrapper:e}={...(0,s.a)(),...n.components};return e?(0,t.jsx)(e,{...n,children:(0,t.jsx)(u,{...n})}):u(n)}},71670:(n,e,o)=>{o.d(e,{Z:()=>c,a:()=>a});var t=o(27378);const s={},i=t.createContext(s);function a(n){const e=t.useContext(i);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(i.Provider,{value:e},n.children)}}}]); \ No newline at end of file diff --git a/assets/js/12eb386e.987442d4.js b/assets/js/12eb386e.8cd4f506.js similarity index 87% rename from assets/js/12eb386e.987442d4.js rename to assets/js/12eb386e.8cd4f506.js index 9930c973072..e393e0b7e35 100644 --- a/assets/js/12eb386e.987442d4.js +++ b/assets/js/12eb386e.8cd4f506.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[89950],{60804:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>a,contentTitle:()=>r,default:()=>p,frontMatter:()=>t,metadata:()=>c,toc:()=>l});var i=s(24246),o=s(71670);const t={},r="Interface: CliToolOptions",c={id:"interfaces/CliToolOptions",title:"Interface: CliToolOptions",description:"Options to create new CliTool instance and register it in podman desktop",source:"@site/api/interfaces/CliToolOptions.md",sourceDirName:"interfaces",slug:"/interfaces/CliToolOptions",permalink:"/api/interfaces/CliToolOptions",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: CliTool",permalink:"/api/interfaces/CliTool"},next:{title:"Interface: CliToolUpdate",permalink:"/api/interfaces/CliToolUpdate"}},a={},l=[{value:"Properties",id:"properties",level:2},{value:"displayName",id:"displayname",level:3},{value:"Source",id:"source",level:4},{value:"images",id:"images",level:3},{value:"Source",id:"source-1",level:4},{value:"markdownDescription",id:"markdowndescription",level:3},{value:"Source",id:"source-2",level:4},{value:"name",id:"name",level:3},{value:"Source",id:"source-3",level:4},{value:"path",id:"path",level:3},{value:"Source",id:"source-4",level:4},{value:"version",id:"version",level:3},{value:"Source",id:"source-5",level:4}];function d(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,o.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"interface-clitooloptions",children:"Interface: CliToolOptions"}),"\n",(0,i.jsx)(n.p,{children:"Options to create new CliTool instance and register it in podman desktop"}),"\n",(0,i.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(n.h3,{id:"displayname",children:"displayName"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"displayName"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L4000",children:"packages/extension-api/src/extension-api.d.ts:4000"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"images",children:"images"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"images"}),": ",(0,i.jsx)(n.a,{href:"/api/interfaces/ProviderImages",children:(0,i.jsx)(n.code,{children:"ProviderImages"})})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L4002",children:"packages/extension-api/src/extension-api.d.ts:4002"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"markdowndescription",children:"markdownDescription"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"markdownDescription"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L4001",children:"packages/extension-api/src/extension-api.d.ts:4001"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"name",children:"name"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"name"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L3999",children:"packages/extension-api/src/extension-api.d.ts:3999"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"path",children:"path"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"path"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-4",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L4012",children:"packages/extension-api/src/extension-api.d.ts:4012"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"version",children:"version"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"version"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Within your extension, it is reccommended to implement your own functionality to check the current\nversion number of the CLI tool. For example, parsing the information from the CLI tool's ",(0,i.jsx)(n.code,{children:"--version"})," flag.\nPassing in path will also help to show where the CLI tool is expected to be installed.\nThis is usually the ~/.local/share/containers/podman-desktop/extensions-storage directory.\nNote: The expected value should not include 'v'."]}),"\n",(0,i.jsx)(n.h4,{id:"source-5",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L4011",children:"packages/extension-api/src/extension-api.d.ts:4011"})})]})}function p(e={}){const{wrapper:n}={...(0,o.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(d,{...e})}):d(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>c,a:()=>r});var i=s(27378);const o={},t=i.createContext(o);function r(e){const n=i.useContext(t);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:r(e.components),i.createElement(t.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[89950],{60804:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>a,contentTitle:()=>r,default:()=>p,frontMatter:()=>t,metadata:()=>c,toc:()=>d});var i=s(24246),o=s(71670);const t={},r="Interface: CliToolOptions",c={id:"interfaces/CliToolOptions",title:"Interface: CliToolOptions",description:"Options to create new CliTool instance and register it in podman desktop",source:"@site/api/interfaces/CliToolOptions.md",sourceDirName:"interfaces",slug:"/interfaces/CliToolOptions",permalink:"/api/interfaces/CliToolOptions",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: CliTool",permalink:"/api/interfaces/CliTool"},next:{title:"Interface: CliToolUpdate",permalink:"/api/interfaces/CliToolUpdate"}},a={},d=[{value:"Properties",id:"properties",level:2},{value:"displayName",id:"displayname",level:3},{value:"Source",id:"source",level:4},{value:"images",id:"images",level:3},{value:"Source",id:"source-1",level:4},{value:"markdownDescription",id:"markdowndescription",level:3},{value:"Source",id:"source-2",level:4},{value:"name",id:"name",level:3},{value:"Source",id:"source-3",level:4},{value:"path",id:"path",level:3},{value:"Source",id:"source-4",level:4},{value:"version",id:"version",level:3},{value:"Source",id:"source-5",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,o.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"interface-clitooloptions",children:"Interface: CliToolOptions"}),"\n",(0,i.jsx)(n.p,{children:"Options to create new CliTool instance and register it in podman desktop"}),"\n",(0,i.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(n.h3,{id:"displayname",children:"displayName"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"displayName"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L4000",children:"packages/extension-api/src/extension-api.d.ts:4000"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"images",children:"images"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"images"}),": ",(0,i.jsx)(n.a,{href:"/api/interfaces/ProviderImages",children:(0,i.jsx)(n.code,{children:"ProviderImages"})})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L4002",children:"packages/extension-api/src/extension-api.d.ts:4002"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"markdowndescription",children:"markdownDescription"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"markdownDescription"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L4001",children:"packages/extension-api/src/extension-api.d.ts:4001"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"name",children:"name"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"name"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L3999",children:"packages/extension-api/src/extension-api.d.ts:3999"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"path",children:"path"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"path"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-4",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L4012",children:"packages/extension-api/src/extension-api.d.ts:4012"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"version",children:"version"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"version"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Within your extension, it is reccommended to implement your own functionality to check the current\nversion number of the CLI tool. For example, parsing the information from the CLI tool's ",(0,i.jsx)(n.code,{children:"--version"})," flag.\nPassing in path will also help to show where the CLI tool is expected to be installed.\nThis is usually the ~/.local/share/containers/podman-desktop/extensions-storage directory.\nNote: The expected value should not include 'v'."]}),"\n",(0,i.jsx)(n.h4,{id:"source-5",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L4011",children:"packages/extension-api/src/extension-api.d.ts:4011"})})]})}function p(e={}){const{wrapper:n}={...(0,o.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>c,a:()=>r});var i=s(27378);const o={},t=i.createContext(o);function r(e){const n=i.useContext(t);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:r(e.components),i.createElement(t.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/148448cb.1c3ea32f.js b/assets/js/148448cb.cd99b6a9.js similarity index 87% rename from assets/js/148448cb.1c3ea32f.js rename to assets/js/148448cb.cd99b6a9.js index 43db05589a2..aec22192347 100644 --- a/assets/js/148448cb.1c3ea32f.js +++ b/assets/js/148448cb.cd99b6a9.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[72092],{36129:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>d,contentTitle:()=>o,default:()=>h,frontMatter:()=>r,metadata:()=>t,toc:()=>a});var i=s(24246),c=s(71670);const r={},o="Interface: ContainerCreateOptions",t={id:"interfaces/ContainerCreateOptions",title:"Interface: ContainerCreateOptions",description:"Properties",source:"@site/api/interfaces/ContainerCreateOptions.md",sourceDirName:"interfaces",slug:"/interfaces/ContainerCreateOptions",permalink:"/api/interfaces/ContainerCreateOptions",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: ContainerAuthInfo",permalink:"/api/interfaces/ContainerAuthInfo"},next:{title:"Interface: ContainerCreateResult",permalink:"/api/interfaces/ContainerCreateResult"}},d={},a=[{value:"Properties",id:"properties",level:2},{value:"ArgsEscaped?",id:"argsescaped",level:3},{value:"Source",id:"source",level:4},{value:"AttachStderr?",id:"attachstderr",level:3},{value:"Source",id:"source-1",level:4},{value:"AttachStdin?",id:"attachstdin",level:3},{value:"Source",id:"source-2",level:4},{value:"AttachStdout?",id:"attachstdout",level:3},{value:"Source",id:"source-3",level:4},{value:"Cmd?",id:"cmd",level:3},{value:"Source",id:"source-4",level:4},{value:"Detach?",id:"detach",level:3},{value:"Source",id:"source-5",level:4},{value:"Domainname?",id:"domainname",level:3},{value:"Source",id:"source-6",level:4},{value:"Entrypoint?",id:"entrypoint",level:3},{value:"Source",id:"source-7",level:4},{value:"Env?",id:"env",level:3},{value:"Source",id:"source-8",level:4},{value:"EnvFiles?",id:"envfiles",level:3},{value:"Source",id:"source-9",level:4},{value:"ExposedPorts?",id:"exposedports",level:3},{value:"Index signature",id:"index-signature",level:4},{value:"Source",id:"source-10",level:4},{value:"HealthCheck?",id:"healthcheck",level:3},{value:"Source",id:"source-11",level:4},{value:"HostConfig?",id:"hostconfig",level:3},{value:"Source",id:"source-12",level:4},{value:"Hostname?",id:"hostname",level:3},{value:"Source",id:"source-13",level:4},{value:"Image?",id:"image",level:3},{value:"Source",id:"source-14",level:4},{value:"Labels?",id:"labels",level:3},{value:"Index signature",id:"index-signature-1",level:4},{value:"Source",id:"source-15",level:4},{value:"MacAddress?",id:"macaddress",level:3},{value:"Source",id:"source-16",level:4},{value:"NetworkConfig?",id:"networkconfig",level:3},{value:"Source",id:"source-17",level:4},{value:"NetworkDisabled?",id:"networkdisabled",level:3},{value:"Source",id:"source-18",level:4},{value:"OnBuild?",id:"onbuild",level:3},{value:"Source",id:"source-19",level:4},{value:"OpenStdin?",id:"openstdin",level:3},{value:"Source",id:"source-20",level:4},{value:"Shell?",id:"shell",level:3},{value:"Source",id:"source-21",level:4},{value:"StdinOnce?",id:"stdinonce",level:3},{value:"Source",id:"source-22",level:4},{value:"StopSignal?",id:"stopsignal",level:3},{value:"Source",id:"source-23",level:4},{value:"StopTimeout?",id:"stoptimeout",level:3},{value:"Source",id:"source-24",level:4},{value:"Tty?",id:"tty",level:3},{value:"Source",id:"source-25",level:4},{value:"User?",id:"user",level:3},{value:"Source",id:"source-26",level:4},{value:"Volumes?",id:"volumes",level:3},{value:"Index signature",id:"index-signature-2",level:4},{value:"Source",id:"source-27",level:4},{value:"WorkingDir?",id:"workingdir",level:3},{value:"Source",id:"source-28",level:4},{value:"name?",id:"name",level:3},{value:"Source",id:"source-29",level:4},{value:"platform?",id:"platform",level:3},{value:"Source",id:"source-30",level:4},{value:"pod?",id:"pod",level:3},{value:"Source",id:"source-31",level:4},{value:"start?",id:"start",level:3},{value:"Source",id:"source-32",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",pre:"pre",strong:"strong",...(0,c.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"interface-containercreateoptions",children:"Interface: ContainerCreateOptions"}),"\n",(0,i.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(n.h3,{id:"argsescaped",children:"ArgsEscaped?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"ArgsEscaped"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Default: ",(0,i.jsx)(n.code,{children:"false"})]}),"\n",(0,i.jsx)(n.p,{children:"Command is already escaped (Windows only)"}),"\n",(0,i.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2690",children:"packages/extension-api/src/extension-api.d.ts:2690"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"attachstderr",children:"AttachStderr?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"AttachStderr"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Whether to attach to ",(0,i.jsx)(n.code,{children:"stderr"})," (default false)"]}),"\n",(0,i.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2658",children:"packages/extension-api/src/extension-api.d.ts:2658"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"attachstdin",children:"AttachStdin?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"AttachStdin"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Whether to attach to ",(0,i.jsx)(n.code,{children:"stdin"})," (default false)"]}),"\n",(0,i.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2648",children:"packages/extension-api/src/extension-api.d.ts:2648"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"attachstdout",children:"AttachStdout?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"AttachStdout"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Whether to attach to ",(0,i.jsx)(n.code,{children:"stdout"}),"(default false)"]}),"\n",(0,i.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2653",children:"packages/extension-api/src/extension-api.d.ts:2653"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"cmd",children:"Cmd?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"Cmd"}),": ",(0,i.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Command to run specified as an array of strings"}),"\n",(0,i.jsx)(n.h4,{id:"source-4",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2636",children:"packages/extension-api/src/extension-api.d.ts:2636"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"detach",children:"Detach?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"Detach"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Run the container in the background"}),"\n",(0,i.jsx)(n.h4,{id:"source-5",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2673",children:"packages/extension-api/src/extension-api.d.ts:2673"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"domainname",children:"Domainname?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"Domainname"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"The domain name to use for the container."}),"\n",(0,i.jsx)(n.h4,{id:"source-6",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2590",children:"packages/extension-api/src/extension-api.d.ts:2590"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"entrypoint",children:"Entrypoint?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"Entrypoint"}),": ",(0,i.jsx)(n.code,{children:"string"})," | ",(0,i.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"The entry point for the container as a string or an array of strings."}),"\n",(0,i.jsxs)(n.p,{children:["If the array consists of exactly one empty string (",(0,i.jsx)(n.code,{children:'[""]'}),") then the entry point is reset to system default (i.e., the entry point used by docker when there is no ENTRYPOINT instruction in the Containerfile)."]}),"\n",(0,i.jsx)(n.h4,{id:"source-7",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2643",children:"packages/extension-api/src/extension-api.d.ts:2643"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"env",children:"Env?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"Env"}),": ",(0,i.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["A list of environment variables to set inside the container in the form ",(0,i.jsx)(n.code,{children:'["VAR=value", ...]'}),". A variable without ",(0,i.jsx)(n.code,{children:"="})," is removed from the environment, rather than to have an empty value"]}),"\n",(0,i.jsx)(n.h4,{id:"source-8",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2600",children:"packages/extension-api/src/extension-api.d.ts:2600"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"envfiles",children:"EnvFiles?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"EnvFiles"}),": ",(0,i.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Environment files to use"}),"\n",(0,i.jsx)(n.h4,{id:"source-9",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2605",children:"packages/extension-api/src/extension-api.d.ts:2605"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"exposedports",children:"ExposedPorts?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"ExposedPorts"}),": ",(0,i.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["An object mapping ports to an empty object in the form: ",(0,i.jsx)(n.code,{children:'{"/": {}}'})]}),"\n",(0,i.jsx)(n.h4,{id:"index-signature",children:"Index signature"}),"\n",(0,i.jsxs)(n.p,{children:["[",(0,i.jsx)(n.code,{children:"port"}),": ",(0,i.jsx)(n.code,{children:"string"}),"]: ",(0,i.jsx)(n.code,{children:"object"})]}),"\n",(0,i.jsx)(n.h4,{id:"source-10",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2616",children:"packages/extension-api/src/extension-api.d.ts:2616"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"healthcheck",children:"HealthCheck?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"HealthCheck"}),": ",(0,i.jsx)(n.a,{href:"/api/interfaces/HealthConfig",children:(0,i.jsx)(n.code,{children:"HealthConfig"})})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["A test to perform to check that the container is healthy. See ",(0,i.jsx)(n.a,{href:"/api/interfaces/HealthConfig",children:"HealthConfig"})," for usage details"]}),"\n",(0,i.jsx)(n.h4,{id:"source-11",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2683",children:"packages/extension-api/src/extension-api.d.ts:2683"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"hostconfig",children:"HostConfig?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"HostConfig"}),": ",(0,i.jsx)(n.a,{href:"/api/interfaces/HostConfig",children:(0,i.jsx)(n.code,{children:"HostConfig"})})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Container configuration that depends on the host we are running on"}),"\n",(0,i.jsx)(n.h4,{id:"source-12",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2621",children:"packages/extension-api/src/extension-api.d.ts:2621"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"hostname",children:"Hostname?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"Hostname"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"The hostname to use for the container, as a valid RFC 1123 hostname"}),"\n",(0,i.jsx)(n.h4,{id:"source-13",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2585",children:"packages/extension-api/src/extension-api.d.ts:2585"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"image",children:"Image?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"Image"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"The name (or reference) of the image to use when creating the container"}),"\n",(0,i.jsx)(n.h4,{id:"source-14",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2626",children:"packages/extension-api/src/extension-api.d.ts:2626"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"labels",children:"Labels?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"Labels"}),": ",(0,i.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"User-defined key/value metadata"}),"\n",(0,i.jsx)(n.h4,{id:"index-signature-1",children:"Index signature"}),"\n",(0,i.jsxs)(n.p,{children:["[",(0,i.jsx)(n.code,{children:"label"}),": ",(0,i.jsx)(n.code,{children:"string"}),"]: ",(0,i.jsx)(n.code,{children:"string"})]}),"\n",(0,i.jsx)(n.h4,{id:"source-15",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2610",children:"packages/extension-api/src/extension-api.d.ts:2610"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"macaddress",children:"MacAddress?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"MacAddress"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"MAC address of the container."}),"\n",(0,i.jsx)(n.h4,{id:"source-16",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2710",children:"packages/extension-api/src/extension-api.d.ts:2710"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"networkconfig",children:"NetworkConfig?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"NetworkConfig"}),": ",(0,i.jsx)(n.a,{href:"/api/interfaces/NetworkingConfig",children:(0,i.jsx)(n.code,{children:"NetworkingConfig"})})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-17",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2734",children:"packages/extension-api/src/extension-api.d.ts:2734"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"networkdisabled",children:"NetworkDisabled?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"NetworkDisabled"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Disable networking for the container."}),"\n",(0,i.jsx)(n.h4,{id:"source-18",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2705",children:"packages/extension-api/src/extension-api.d.ts:2705"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"onbuild",children:"OnBuild?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"OnBuild"}),": ",(0,i.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"ONBUILD"})," metadata that were defined in the image's ",(0,i.jsx)(n.code,{children:"Dockerfile"}),"."]}),"\n",(0,i.jsx)(n.h4,{id:"source-19",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2715",children:"packages/extension-api/src/extension-api.d.ts:2715"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"openstdin",children:"OpenStdin?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"OpenStdin"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Whether to open ",(0,i.jsx)(n.code,{children:"stdin"})," (default false)"]}),"\n",(0,i.jsx)(n.h4,{id:"source-20",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2663",children:"packages/extension-api/src/extension-api.d.ts:2663"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"shell",children:"Shell?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"Shell"}),": ",(0,i.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Shell for when ",(0,i.jsx)(n.code,{children:"RUN"}),", ",(0,i.jsx)(n.code,{children:"CMD"}),", and ",(0,i.jsx)(n.code,{children:"ENTRYPOINT"})," uses a shell."]}),"\n",(0,i.jsx)(n.h4,{id:"source-21",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2732",children:"packages/extension-api/src/extension-api.d.ts:2732"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"stdinonce",children:"StdinOnce?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"StdinOnce"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Close ",(0,i.jsx)(n.code,{children:"stdin"})," after one attached client disconnects (deafult false)"]}),"\n",(0,i.jsx)(n.h4,{id:"source-22",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2668",children:"packages/extension-api/src/extension-api.d.ts:2668"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"stopsignal",children:"StopSignal?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"StopSignal"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Signal to stop a container as a string or unsigned integer."}),"\n",(0,i.jsx)(n.h4,{id:"source-23",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2720",children:"packages/extension-api/src/extension-api.d.ts:2720"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"stoptimeout",children:"StopTimeout?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"StopTimeout"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Default: ",(0,i.jsx)(n.code,{children:"10"})]}),"\n",(0,i.jsx)(n.p,{children:"Timeout to stop a container in seconds."}),"\n",(0,i.jsx)(n.h4,{id:"source-24",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2727",children:"packages/extension-api/src/extension-api.d.ts:2727"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"tty",children:"Tty?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"Tty"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Attach standard streams to a TTY, including stdin if it is not closed (default false)"}),"\n",(0,i.jsx)(n.h4,{id:"source-25",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2631",children:"packages/extension-api/src/extension-api.d.ts:2631"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"user",children:"User?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"User"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"The user that commands are run as inside the container"}),"\n",(0,i.jsx)(n.h4,{id:"source-26",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2595",children:"packages/extension-api/src/extension-api.d.ts:2595"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"volumes",children:"Volumes?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"Volumes"}),": ",(0,i.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"An object mapping mount point paths inside the container to empty objects."}),"\n",(0,i.jsx)(n.h4,{id:"index-signature-2",children:"Index signature"}),"\n",(0,i.jsxs)(n.p,{children:["[",(0,i.jsx)(n.code,{children:"volume"}),": ",(0,i.jsx)(n.code,{children:"string"}),"]: ",(0,i.jsx)(n.code,{children:"object"})]}),"\n",(0,i.jsx)(n.h4,{id:"source-27",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2695",children:"packages/extension-api/src/extension-api.d.ts:2695"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"workingdir",children:"WorkingDir?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"WorkingDir"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"The working directory for commands to run in."}),"\n",(0,i.jsx)(n.h4,{id:"source-28",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2700",children:"packages/extension-api/src/extension-api.d.ts:2700"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"name",children:"name?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"name"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Assign the specified name to the container. Must match the regular expression",(0,i.jsx)(n.code,{children:"/?[a-zA-Z0-9][a-zA-Z0-9_.-]+"}),". If not speficied, the platform assigns a unique name to the container"]}),"\n",(0,i.jsx)(n.h4,{id:"source-29",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2563",children:"packages/extension-api/src/extension-api.d.ts:2563"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"platform",children:"platform?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"platform"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:'Default: ""'}),"\n",(0,i.jsxs)(n.p,{children:["Platform in the format ",(0,i.jsx)(n.code,{children:"os[/arch[/variant]]"})," used for image lookup."]}),"\n",(0,i.jsxs)(n.p,{children:["When specified, the daemon checks if the requested image is present in the local image cache with the given OS and Architecture, and otherwise returns a ",(0,i.jsx)(n.code,{children:"404"})," status."]}),"\n",(0,i.jsxs)(n.p,{children:["If the option is not set, the host's native OS and Architecture are used to look up the image in the image cache. However, if no platform is passed and the given image does exist in the local image cache, but its OS or architecture does not match, the container is created with the available image, and a warning is added to the ",(0,i.jsx)(n.code,{children:"Warnings"})," field in the response, for example;"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:"WARNING: The requested image's platform (linux/arm64/v8) does not\n match the detected host platform (linux/amd64) and no\n specific platform was requested\n"})}),"\n",(0,i.jsx)(n.h4,{id:"source-30",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2580",children:"packages/extension-api/src/extension-api.d.ts:2580"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"pod",children:"pod?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"pod"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Pod where to create the container in"}),"\n",(0,i.jsx)(n.h4,{id:"source-31",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2739",children:"packages/extension-api/src/extension-api.d.ts:2739"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"start",children:"start?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"start"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Start the container immediately (default true)"}),"\n",(0,i.jsx)(n.h4,{id:"source-32",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2678",children:"packages/extension-api/src/extension-api.d.ts:2678"})})]})}function h(e={}){const{wrapper:n}={...(0,c.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>t,a:()=>o});var i=s(27378);const c={},r=i.createContext(c);function o(e){const n=i.useContext(r);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function t(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(c):e.components||c:o(e.components),i.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[72092],{36129:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>t,contentTitle:()=>o,default:()=>h,frontMatter:()=>r,metadata:()=>d,toc:()=>l});var i=s(24246),c=s(71670);const r={},o="Interface: ContainerCreateOptions",d={id:"interfaces/ContainerCreateOptions",title:"Interface: ContainerCreateOptions",description:"Properties",source:"@site/api/interfaces/ContainerCreateOptions.md",sourceDirName:"interfaces",slug:"/interfaces/ContainerCreateOptions",permalink:"/api/interfaces/ContainerCreateOptions",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: ContainerAuthInfo",permalink:"/api/interfaces/ContainerAuthInfo"},next:{title:"Interface: ContainerCreateResult",permalink:"/api/interfaces/ContainerCreateResult"}},t={},l=[{value:"Properties",id:"properties",level:2},{value:"ArgsEscaped?",id:"argsescaped",level:3},{value:"Source",id:"source",level:4},{value:"AttachStderr?",id:"attachstderr",level:3},{value:"Source",id:"source-1",level:4},{value:"AttachStdin?",id:"attachstdin",level:3},{value:"Source",id:"source-2",level:4},{value:"AttachStdout?",id:"attachstdout",level:3},{value:"Source",id:"source-3",level:4},{value:"Cmd?",id:"cmd",level:3},{value:"Source",id:"source-4",level:4},{value:"Detach?",id:"detach",level:3},{value:"Source",id:"source-5",level:4},{value:"Domainname?",id:"domainname",level:3},{value:"Source",id:"source-6",level:4},{value:"Entrypoint?",id:"entrypoint",level:3},{value:"Source",id:"source-7",level:4},{value:"Env?",id:"env",level:3},{value:"Source",id:"source-8",level:4},{value:"EnvFiles?",id:"envfiles",level:3},{value:"Source",id:"source-9",level:4},{value:"ExposedPorts?",id:"exposedports",level:3},{value:"Index signature",id:"index-signature",level:4},{value:"Source",id:"source-10",level:4},{value:"HealthCheck?",id:"healthcheck",level:3},{value:"Source",id:"source-11",level:4},{value:"HostConfig?",id:"hostconfig",level:3},{value:"Source",id:"source-12",level:4},{value:"Hostname?",id:"hostname",level:3},{value:"Source",id:"source-13",level:4},{value:"Image?",id:"image",level:3},{value:"Source",id:"source-14",level:4},{value:"Labels?",id:"labels",level:3},{value:"Index signature",id:"index-signature-1",level:4},{value:"Source",id:"source-15",level:4},{value:"MacAddress?",id:"macaddress",level:3},{value:"Source",id:"source-16",level:4},{value:"NetworkConfig?",id:"networkconfig",level:3},{value:"Source",id:"source-17",level:4},{value:"NetworkDisabled?",id:"networkdisabled",level:3},{value:"Source",id:"source-18",level:4},{value:"OnBuild?",id:"onbuild",level:3},{value:"Source",id:"source-19",level:4},{value:"OpenStdin?",id:"openstdin",level:3},{value:"Source",id:"source-20",level:4},{value:"Shell?",id:"shell",level:3},{value:"Source",id:"source-21",level:4},{value:"StdinOnce?",id:"stdinonce",level:3},{value:"Source",id:"source-22",level:4},{value:"StopSignal?",id:"stopsignal",level:3},{value:"Source",id:"source-23",level:4},{value:"StopTimeout?",id:"stoptimeout",level:3},{value:"Source",id:"source-24",level:4},{value:"Tty?",id:"tty",level:3},{value:"Source",id:"source-25",level:4},{value:"User?",id:"user",level:3},{value:"Source",id:"source-26",level:4},{value:"Volumes?",id:"volumes",level:3},{value:"Index signature",id:"index-signature-2",level:4},{value:"Source",id:"source-27",level:4},{value:"WorkingDir?",id:"workingdir",level:3},{value:"Source",id:"source-28",level:4},{value:"name?",id:"name",level:3},{value:"Source",id:"source-29",level:4},{value:"platform?",id:"platform",level:3},{value:"Source",id:"source-30",level:4},{value:"pod?",id:"pod",level:3},{value:"Source",id:"source-31",level:4},{value:"start?",id:"start",level:3},{value:"Source",id:"source-32",level:4}];function a(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",pre:"pre",strong:"strong",...(0,c.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"interface-containercreateoptions",children:"Interface: ContainerCreateOptions"}),"\n",(0,i.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(n.h3,{id:"argsescaped",children:"ArgsEscaped?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"ArgsEscaped"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Default: ",(0,i.jsx)(n.code,{children:"false"})]}),"\n",(0,i.jsx)(n.p,{children:"Command is already escaped (Windows only)"}),"\n",(0,i.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2690",children:"packages/extension-api/src/extension-api.d.ts:2690"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"attachstderr",children:"AttachStderr?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"AttachStderr"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Whether to attach to ",(0,i.jsx)(n.code,{children:"stderr"})," (default false)"]}),"\n",(0,i.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2658",children:"packages/extension-api/src/extension-api.d.ts:2658"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"attachstdin",children:"AttachStdin?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"AttachStdin"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Whether to attach to ",(0,i.jsx)(n.code,{children:"stdin"})," (default false)"]}),"\n",(0,i.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2648",children:"packages/extension-api/src/extension-api.d.ts:2648"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"attachstdout",children:"AttachStdout?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"AttachStdout"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Whether to attach to ",(0,i.jsx)(n.code,{children:"stdout"}),"(default false)"]}),"\n",(0,i.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2653",children:"packages/extension-api/src/extension-api.d.ts:2653"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"cmd",children:"Cmd?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"Cmd"}),": ",(0,i.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Command to run specified as an array of strings"}),"\n",(0,i.jsx)(n.h4,{id:"source-4",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2636",children:"packages/extension-api/src/extension-api.d.ts:2636"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"detach",children:"Detach?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"Detach"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Run the container in the background"}),"\n",(0,i.jsx)(n.h4,{id:"source-5",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2673",children:"packages/extension-api/src/extension-api.d.ts:2673"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"domainname",children:"Domainname?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"Domainname"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"The domain name to use for the container."}),"\n",(0,i.jsx)(n.h4,{id:"source-6",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2590",children:"packages/extension-api/src/extension-api.d.ts:2590"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"entrypoint",children:"Entrypoint?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"Entrypoint"}),": ",(0,i.jsx)(n.code,{children:"string"})," | ",(0,i.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"The entry point for the container as a string or an array of strings."}),"\n",(0,i.jsxs)(n.p,{children:["If the array consists of exactly one empty string (",(0,i.jsx)(n.code,{children:'[""]'}),") then the entry point is reset to system default (i.e., the entry point used by docker when there is no ENTRYPOINT instruction in the Containerfile)."]}),"\n",(0,i.jsx)(n.h4,{id:"source-7",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2643",children:"packages/extension-api/src/extension-api.d.ts:2643"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"env",children:"Env?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"Env"}),": ",(0,i.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["A list of environment variables to set inside the container in the form ",(0,i.jsx)(n.code,{children:'["VAR=value", ...]'}),". A variable without ",(0,i.jsx)(n.code,{children:"="})," is removed from the environment, rather than to have an empty value"]}),"\n",(0,i.jsx)(n.h4,{id:"source-8",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2600",children:"packages/extension-api/src/extension-api.d.ts:2600"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"envfiles",children:"EnvFiles?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"EnvFiles"}),": ",(0,i.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Environment files to use"}),"\n",(0,i.jsx)(n.h4,{id:"source-9",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2605",children:"packages/extension-api/src/extension-api.d.ts:2605"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"exposedports",children:"ExposedPorts?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"ExposedPorts"}),": ",(0,i.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["An object mapping ports to an empty object in the form: ",(0,i.jsx)(n.code,{children:'{"/": {}}'})]}),"\n",(0,i.jsx)(n.h4,{id:"index-signature",children:"Index signature"}),"\n",(0,i.jsxs)(n.p,{children:["[",(0,i.jsx)(n.code,{children:"port"}),": ",(0,i.jsx)(n.code,{children:"string"}),"]: ",(0,i.jsx)(n.code,{children:"object"})]}),"\n",(0,i.jsx)(n.h4,{id:"source-10",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2616",children:"packages/extension-api/src/extension-api.d.ts:2616"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"healthcheck",children:"HealthCheck?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"HealthCheck"}),": ",(0,i.jsx)(n.a,{href:"/api/interfaces/HealthConfig",children:(0,i.jsx)(n.code,{children:"HealthConfig"})})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["A test to perform to check that the container is healthy. See ",(0,i.jsx)(n.a,{href:"/api/interfaces/HealthConfig",children:"HealthConfig"})," for usage details"]}),"\n",(0,i.jsx)(n.h4,{id:"source-11",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2683",children:"packages/extension-api/src/extension-api.d.ts:2683"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"hostconfig",children:"HostConfig?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"HostConfig"}),": ",(0,i.jsx)(n.a,{href:"/api/interfaces/HostConfig",children:(0,i.jsx)(n.code,{children:"HostConfig"})})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Container configuration that depends on the host we are running on"}),"\n",(0,i.jsx)(n.h4,{id:"source-12",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2621",children:"packages/extension-api/src/extension-api.d.ts:2621"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"hostname",children:"Hostname?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"Hostname"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"The hostname to use for the container, as a valid RFC 1123 hostname"}),"\n",(0,i.jsx)(n.h4,{id:"source-13",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2585",children:"packages/extension-api/src/extension-api.d.ts:2585"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"image",children:"Image?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"Image"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"The name (or reference) of the image to use when creating the container"}),"\n",(0,i.jsx)(n.h4,{id:"source-14",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2626",children:"packages/extension-api/src/extension-api.d.ts:2626"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"labels",children:"Labels?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"Labels"}),": ",(0,i.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"User-defined key/value metadata"}),"\n",(0,i.jsx)(n.h4,{id:"index-signature-1",children:"Index signature"}),"\n",(0,i.jsxs)(n.p,{children:["[",(0,i.jsx)(n.code,{children:"label"}),": ",(0,i.jsx)(n.code,{children:"string"}),"]: ",(0,i.jsx)(n.code,{children:"string"})]}),"\n",(0,i.jsx)(n.h4,{id:"source-15",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2610",children:"packages/extension-api/src/extension-api.d.ts:2610"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"macaddress",children:"MacAddress?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"MacAddress"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"MAC address of the container."}),"\n",(0,i.jsx)(n.h4,{id:"source-16",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2710",children:"packages/extension-api/src/extension-api.d.ts:2710"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"networkconfig",children:"NetworkConfig?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"NetworkConfig"}),": ",(0,i.jsx)(n.a,{href:"/api/interfaces/NetworkingConfig",children:(0,i.jsx)(n.code,{children:"NetworkingConfig"})})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-17",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2734",children:"packages/extension-api/src/extension-api.d.ts:2734"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"networkdisabled",children:"NetworkDisabled?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"NetworkDisabled"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Disable networking for the container."}),"\n",(0,i.jsx)(n.h4,{id:"source-18",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2705",children:"packages/extension-api/src/extension-api.d.ts:2705"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"onbuild",children:"OnBuild?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"OnBuild"}),": ",(0,i.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"ONBUILD"})," metadata that were defined in the image's ",(0,i.jsx)(n.code,{children:"Dockerfile"}),"."]}),"\n",(0,i.jsx)(n.h4,{id:"source-19",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2715",children:"packages/extension-api/src/extension-api.d.ts:2715"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"openstdin",children:"OpenStdin?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"OpenStdin"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Whether to open ",(0,i.jsx)(n.code,{children:"stdin"})," (default false)"]}),"\n",(0,i.jsx)(n.h4,{id:"source-20",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2663",children:"packages/extension-api/src/extension-api.d.ts:2663"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"shell",children:"Shell?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"Shell"}),": ",(0,i.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Shell for when ",(0,i.jsx)(n.code,{children:"RUN"}),", ",(0,i.jsx)(n.code,{children:"CMD"}),", and ",(0,i.jsx)(n.code,{children:"ENTRYPOINT"})," uses a shell."]}),"\n",(0,i.jsx)(n.h4,{id:"source-21",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2732",children:"packages/extension-api/src/extension-api.d.ts:2732"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"stdinonce",children:"StdinOnce?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"StdinOnce"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Close ",(0,i.jsx)(n.code,{children:"stdin"})," after one attached client disconnects (deafult false)"]}),"\n",(0,i.jsx)(n.h4,{id:"source-22",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2668",children:"packages/extension-api/src/extension-api.d.ts:2668"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"stopsignal",children:"StopSignal?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"StopSignal"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Signal to stop a container as a string or unsigned integer."}),"\n",(0,i.jsx)(n.h4,{id:"source-23",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2720",children:"packages/extension-api/src/extension-api.d.ts:2720"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"stoptimeout",children:"StopTimeout?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"StopTimeout"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Default: ",(0,i.jsx)(n.code,{children:"10"})]}),"\n",(0,i.jsx)(n.p,{children:"Timeout to stop a container in seconds."}),"\n",(0,i.jsx)(n.h4,{id:"source-24",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2727",children:"packages/extension-api/src/extension-api.d.ts:2727"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"tty",children:"Tty?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"Tty"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Attach standard streams to a TTY, including stdin if it is not closed (default false)"}),"\n",(0,i.jsx)(n.h4,{id:"source-25",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2631",children:"packages/extension-api/src/extension-api.d.ts:2631"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"user",children:"User?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"User"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"The user that commands are run as inside the container"}),"\n",(0,i.jsx)(n.h4,{id:"source-26",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2595",children:"packages/extension-api/src/extension-api.d.ts:2595"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"volumes",children:"Volumes?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"Volumes"}),": ",(0,i.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"An object mapping mount point paths inside the container to empty objects."}),"\n",(0,i.jsx)(n.h4,{id:"index-signature-2",children:"Index signature"}),"\n",(0,i.jsxs)(n.p,{children:["[",(0,i.jsx)(n.code,{children:"volume"}),": ",(0,i.jsx)(n.code,{children:"string"}),"]: ",(0,i.jsx)(n.code,{children:"object"})]}),"\n",(0,i.jsx)(n.h4,{id:"source-27",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2695",children:"packages/extension-api/src/extension-api.d.ts:2695"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"workingdir",children:"WorkingDir?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"WorkingDir"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"The working directory for commands to run in."}),"\n",(0,i.jsx)(n.h4,{id:"source-28",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2700",children:"packages/extension-api/src/extension-api.d.ts:2700"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"name",children:"name?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"name"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Assign the specified name to the container. Must match the regular expression",(0,i.jsx)(n.code,{children:"/?[a-zA-Z0-9][a-zA-Z0-9_.-]+"}),". If not speficied, the platform assigns a unique name to the container"]}),"\n",(0,i.jsx)(n.h4,{id:"source-29",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2563",children:"packages/extension-api/src/extension-api.d.ts:2563"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"platform",children:"platform?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"platform"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:'Default: ""'}),"\n",(0,i.jsxs)(n.p,{children:["Platform in the format ",(0,i.jsx)(n.code,{children:"os[/arch[/variant]]"})," used for image lookup."]}),"\n",(0,i.jsxs)(n.p,{children:["When specified, the daemon checks if the requested image is present in the local image cache with the given OS and Architecture, and otherwise returns a ",(0,i.jsx)(n.code,{children:"404"})," status."]}),"\n",(0,i.jsxs)(n.p,{children:["If the option is not set, the host's native OS and Architecture are used to look up the image in the image cache. However, if no platform is passed and the given image does exist in the local image cache, but its OS or architecture does not match, the container is created with the available image, and a warning is added to the ",(0,i.jsx)(n.code,{children:"Warnings"})," field in the response, for example;"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:"WARNING: The requested image's platform (linux/arm64/v8) does not\n match the detected host platform (linux/amd64) and no\n specific platform was requested\n"})}),"\n",(0,i.jsx)(n.h4,{id:"source-30",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2580",children:"packages/extension-api/src/extension-api.d.ts:2580"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"pod",children:"pod?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"pod"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Pod where to create the container in"}),"\n",(0,i.jsx)(n.h4,{id:"source-31",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2739",children:"packages/extension-api/src/extension-api.d.ts:2739"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"start",children:"start?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"start"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Start the container immediately (default true)"}),"\n",(0,i.jsx)(n.h4,{id:"source-32",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2678",children:"packages/extension-api/src/extension-api.d.ts:2678"})})]})}function h(e={}){const{wrapper:n}={...(0,c.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(a,{...e})}):a(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>d,a:()=>o});var i=s(27378);const c={},r=i.createContext(c);function o(e){const n=i.useContext(r);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function d(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(c):e.components||c:o(e.components),i.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/14ae68e7.8e966750.js b/assets/js/14ae68e7.563eb837.js similarity index 82% rename from assets/js/14ae68e7.8e966750.js rename to assets/js/14ae68e7.563eb837.js index 87eedc0c515..30ec2f147ff 100644 --- a/assets/js/14ae68e7.8e966750.js +++ b/assets/js/14ae68e7.563eb837.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[60574],{41698:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>d,contentTitle:()=>c,default:()=>p,frontMatter:()=>r,metadata:()=>o,toc:()=>a});var i=s(24246),t=s(71670);const r={},c="Interface: EndpointIPAMConfig",o={id:"interfaces/EndpointIPAMConfig",title:"Interface: EndpointIPAMConfig",description:"Properties",source:"@site/api/interfaces/EndpointIPAMConfig.md",sourceDirName:"interfaces",slug:"/interfaces/EndpointIPAMConfig",permalink:"/api/interfaces/EndpointIPAMConfig",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: DeviceRequest",permalink:"/api/interfaces/DeviceRequest"},next:{title:"Interface: EndpointSettings",permalink:"/api/interfaces/EndpointSettings"}},d={},a=[{value:"Properties",id:"properties",level:2},{value:"IPv4Address?",id:"ipv4address",level:3},{value:"Source",id:"source",level:4},{value:"IPv6Address?",id:"ipv6address",level:3},{value:"Source",id:"source-1",level:4},{value:"LinkLocalIPs?",id:"linklocalips",level:3},{value:"Source",id:"source-2",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,t.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"interface-endpointipamconfig",children:"Interface: EndpointIPAMConfig"}),"\n",(0,i.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(n.h3,{id:"ipv4address",children:"IPv4Address?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"IPv4Address"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2458",children:"packages/extension-api/src/extension-api.d.ts:2458"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"ipv6address",children:"IPv6Address?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"IPv6Address"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2459",children:"packages/extension-api/src/extension-api.d.ts:2459"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"linklocalips",children:"LinkLocalIPs?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"LinkLocalIPs"}),": ",(0,i.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2460",children:"packages/extension-api/src/extension-api.d.ts:2460"})})]})}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([[60574],{41698:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>d,contentTitle:()=>o,default:()=>p,frontMatter:()=>r,metadata:()=>c,toc:()=>a});var i=s(24246),t=s(71670);const r={},o="Interface: EndpointIPAMConfig",c={id:"interfaces/EndpointIPAMConfig",title:"Interface: EndpointIPAMConfig",description:"Properties",source:"@site/api/interfaces/EndpointIPAMConfig.md",sourceDirName:"interfaces",slug:"/interfaces/EndpointIPAMConfig",permalink:"/api/interfaces/EndpointIPAMConfig",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: DeviceRequest",permalink:"/api/interfaces/DeviceRequest"},next:{title:"Interface: EndpointSettings",permalink:"/api/interfaces/EndpointSettings"}},d={},a=[{value:"Properties",id:"properties",level:2},{value:"IPv4Address?",id:"ipv4address",level:3},{value:"Source",id:"source",level:4},{value:"IPv6Address?",id:"ipv6address",level:3},{value:"Source",id:"source-1",level:4},{value:"LinkLocalIPs?",id:"linklocalips",level:3},{value:"Source",id:"source-2",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,t.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"interface-endpointipamconfig",children:"Interface: EndpointIPAMConfig"}),"\n",(0,i.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(n.h3,{id:"ipv4address",children:"IPv4Address?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"IPv4Address"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2458",children:"packages/extension-api/src/extension-api.d.ts:2458"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"ipv6address",children:"IPv6Address?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"IPv6Address"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2459",children:"packages/extension-api/src/extension-api.d.ts:2459"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"linklocalips",children:"LinkLocalIPs?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"LinkLocalIPs"}),": ",(0,i.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2460",children:"packages/extension-api/src/extension-api.d.ts:2460"})})]})}function p(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>c,a:()=>o});var i=s(27378);const t={},r=i.createContext(t);function o(e){const n=i.useContext(r);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:o(e.components),i.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/1515c895.b4fc0e7a.js b/assets/js/1515c895.6929d8ee.js similarity index 98% rename from assets/js/1515c895.b4fc0e7a.js rename to assets/js/1515c895.6929d8ee.js index aabed5d854f..80a34142e11 100644 --- a/assets/js/1515c895.b4fc0e7a.js +++ b/assets/js/1515c895.6929d8ee.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[38134],{16742:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>r,contentTitle:()=>o,default:()=>g,frontMatter:()=>s,metadata:()=>c,toc:()=>d});var i=t(24246),a=t(71670);const s={},o="Function: navigateToImage()",c={id:"namespaces/navigation/functions/navigateToImage",title:"Function: navigateToImage()",description:"navigateToImage(id, engineId, tag): Promise\\",source:"@site/api/namespaces/navigation/functions/navigateToImage.md",sourceDirName:"namespaces/navigation/functions",slug:"/namespaces/navigation/functions/navigateToImage",permalink:"/api/namespaces/navigation/functions/navigateToImage",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Function: navigateToEditProviderContainerConnection()",permalink:"/api/namespaces/navigation/functions/navigateToEditProviderContainerConnection"},next:{title:"Function: navigateToImages()",permalink:"/api/namespaces/navigation/functions/navigateToImages"}},r={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,a.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"function-navigatetoimage",children:"Function: navigateToImage()"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"navigateToImage"}),"(",(0,i.jsx)(n.code,{children:"id"}),", ",(0,i.jsx)(n.code,{children:"engineId"}),", ",(0,i.jsx)(n.code,{children:"tag"}),"): ",(0,i.jsx)(n.code,{children:"Promise"}),"< ",(0,i.jsx)(n.code,{children:"void"})," >"]}),"\n"]}),"\n",(0,i.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"id"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"engineId"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"tag"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n",(0,i.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"Promise"}),"< ",(0,i.jsx)(n.code,{children:"void"})," >"]}),"\n",(0,i.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L4155",children:"packages/extension-api/src/extension-api.d.ts:4155"})})]})}function g(e={}){const{wrapper:n}={...(0,a.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>c,a:()=>o});var i=t(27378);const a={},s=i.createContext(a);function o(e){const n=i.useContext(s);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(a):e.components||a:o(e.components),i.createElement(s.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[38134],{16742:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>r,contentTitle:()=>o,default:()=>g,frontMatter:()=>s,metadata:()=>c,toc:()=>d});var i=t(24246),a=t(71670);const s={},o="Function: navigateToImage()",c={id:"namespaces/navigation/functions/navigateToImage",title:"Function: navigateToImage()",description:"navigateToImage(id, engineId, tag): Promise\\",source:"@site/api/namespaces/navigation/functions/navigateToImage.md",sourceDirName:"namespaces/navigation/functions",slug:"/namespaces/navigation/functions/navigateToImage",permalink:"/api/namespaces/navigation/functions/navigateToImage",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Function: navigateToEditProviderContainerConnection()",permalink:"/api/namespaces/navigation/functions/navigateToEditProviderContainerConnection"},next:{title:"Function: navigateToImages()",permalink:"/api/namespaces/navigation/functions/navigateToImages"}},r={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,a.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"function-navigatetoimage",children:"Function: navigateToImage()"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"navigateToImage"}),"(",(0,i.jsx)(n.code,{children:"id"}),", ",(0,i.jsx)(n.code,{children:"engineId"}),", ",(0,i.jsx)(n.code,{children:"tag"}),"): ",(0,i.jsx)(n.code,{children:"Promise"}),"< ",(0,i.jsx)(n.code,{children:"void"})," >"]}),"\n"]}),"\n",(0,i.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"id"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"engineId"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"tag"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n",(0,i.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"Promise"}),"< ",(0,i.jsx)(n.code,{children:"void"})," >"]}),"\n",(0,i.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L4155",children:"packages/extension-api/src/extension-api.d.ts:4155"})})]})}function g(e={}){const{wrapper:n}={...(0,a.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>c,a:()=>o});var i=t(27378);const a={},s=i.createContext(a);function o(e){const n=i.useContext(s);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(a):e.components||a:o(e.components),i.createElement(s.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/160cb329.b697a9ed.js b/assets/js/160cb329.e6d0fc05.js similarity index 91% rename from assets/js/160cb329.b697a9ed.js rename to assets/js/160cb329.e6d0fc05.js index 2ced9be045c..180b2548eca 100644 --- a/assets/js/160cb329.b697a9ed.js +++ b/assets/js/160cb329.e6d0fc05.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[3984],{43996:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>c,default:()=>h,frontMatter:()=>i,metadata:()=>o,toc:()=>d});var r=t(24246),s=t(71670);const i={},c="Interface: ProviderDetectionCheck",o={id:"interfaces/ProviderDetectionCheck",title:"Interface: ProviderDetectionCheck",description:"Properties",source:"@site/api/interfaces/ProviderDetectionCheck.md",sourceDirName:"interfaces",slug:"/interfaces/ProviderDetectionCheck",permalink:"/api/interfaces/ProviderDetectionCheck",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: ProviderContainerConnection",permalink:"/api/interfaces/ProviderContainerConnection"},next:{title:"Interface: ProviderEvent",permalink:"/api/interfaces/ProviderEvent"}},a={},d=[{value:"Properties",id:"properties",level:2},{value:"details?",id:"details",level:3},{value:"Source",id:"source",level:4},{value:"name",id:"name",level:3},{value:"Source",id:"source-1",level:4},{value:"status",id:"status",level:3},{value:"Source",id:"source-2",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.h1,{id:"interface-providerdetectioncheck",children:"Interface: ProviderDetectionCheck"}),"\n",(0,r.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,r.jsx)(n.h3,{id:"details",children:"details?"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"optional"})})," ",(0,r.jsx)(n.strong,{children:"details"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L212",children:"packages/extension-api/src/extension-api.d.ts:212"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"name",children:"name"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"name"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L211",children:"packages/extension-api/src/extension-api.d.ts:211"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"status",children:"status"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"status"}),": ",(0,r.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L213",children:"packages/extension-api/src/extension-api.d.ts:213"})})]})}function h(e={}){const{wrapper:n}={...(0,s.a)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(l,{...e})}):l(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>o,a:()=>c});var r=t(27378);const s={},i=r.createContext(s);function c(e){const n=r.useContext(i);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:c(e.components),r.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[3984],{43996:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>c,default:()=>h,frontMatter:()=>i,metadata:()=>o,toc:()=>d});var r=t(24246),s=t(71670);const i={},c="Interface: ProviderDetectionCheck",o={id:"interfaces/ProviderDetectionCheck",title:"Interface: ProviderDetectionCheck",description:"Properties",source:"@site/api/interfaces/ProviderDetectionCheck.md",sourceDirName:"interfaces",slug:"/interfaces/ProviderDetectionCheck",permalink:"/api/interfaces/ProviderDetectionCheck",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: ProviderContainerConnection",permalink:"/api/interfaces/ProviderContainerConnection"},next:{title:"Interface: ProviderEvent",permalink:"/api/interfaces/ProviderEvent"}},a={},d=[{value:"Properties",id:"properties",level:2},{value:"details?",id:"details",level:3},{value:"Source",id:"source",level:4},{value:"name",id:"name",level:3},{value:"Source",id:"source-1",level:4},{value:"status",id:"status",level:3},{value:"Source",id:"source-2",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.h1,{id:"interface-providerdetectioncheck",children:"Interface: ProviderDetectionCheck"}),"\n",(0,r.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,r.jsx)(n.h3,{id:"details",children:"details?"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"optional"})})," ",(0,r.jsx)(n.strong,{children:"details"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L212",children:"packages/extension-api/src/extension-api.d.ts:212"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"name",children:"name"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"name"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L211",children:"packages/extension-api/src/extension-api.d.ts:211"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"status",children:"status"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"status"}),": ",(0,r.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L213",children:"packages/extension-api/src/extension-api.d.ts:213"})})]})}function h(e={}){const{wrapper:n}={...(0,s.a)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(l,{...e})}):l(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>o,a:()=>c});var r=t(27378);const s={},i=r.createContext(s);function c(e){const n=r.useContext(i);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:c(e.components),r.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/164937d2.b8ed4032.js b/assets/js/164937d2.5328b998.js similarity index 93% rename from assets/js/164937d2.b8ed4032.js rename to assets/js/164937d2.5328b998.js index f590128b168..c9a42a0013b 100644 --- a/assets/js/164937d2.b8ed4032.js +++ b/assets/js/164937d2.5328b998.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[5477],{1499:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>o,contentTitle:()=>c,default:()=>h,frontMatter:()=>i,metadata:()=>d,toc:()=>a});var s=r(24246),t=r(71670);const i={},c="Interface: SecretStorage",d={id:"interfaces/SecretStorage",title:"Interface: SecretStorage",description:"Represents a storage utility for secrets, information that is",source:"@site/api/interfaces/SecretStorage.md",sourceDirName:"interfaces",slug:"/interfaces/SecretStorage",permalink:"/api/interfaces/SecretStorage",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: SaveDialogOptions",permalink:"/api/interfaces/SaveDialogOptions"},next:{title:"Interface: SecretStorageChangeEvent",permalink:"/api/interfaces/SecretStorageChangeEvent"}},o={},a=[{value:"Properties",id:"properties",level:2},{value:"onDidChange",id:"ondidchange",level:3},{value:"Source",id:"source",level:4},{value:"Methods",id:"methods",level:2},{value:"delete()",id:"delete",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Source",id:"source-1",level:4},{value:"get()",id:"get",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Source",id:"source-2",level:4},{value:"store()",id:"store",level:3},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-2",level:4},{value:"Source",id:"source-3",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,t.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"interface-secretstorage",children:"Interface: SecretStorage"}),"\n",(0,s.jsx)(n.p,{children:"Represents a storage utility for secrets, information that is\nsensitive."}),"\n",(0,s.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,s.jsx)(n.h3,{id:"ondidchange",children:"onDidChange"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"onDidChange"}),": ",(0,s.jsx)(n.a,{href:"/api/interfaces/Event",children:(0,s.jsx)(n.code,{children:"Event"})}),"< ",(0,s.jsx)(n.a,{href:"/api/interfaces/SecretStorageChangeEvent",children:(0,s.jsx)(n.code,{children:"SecretStorageChangeEvent"})})," >"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Fires when a secret is stored or deleted."}),"\n",(0,s.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L4232",children:"packages/extension-api/src/extension-api.d.ts:4232"})}),"\n",(0,s.jsx)(n.h2,{id:"methods",children:"Methods"}),"\n",(0,s.jsx)(n.h3,{id:"delete",children:"delete()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"delete"}),"(",(0,s.jsx)(n.code,{children:"key"}),"): ",(0,s.jsx)(n.code,{children:"Promise"}),"< ",(0,s.jsx)(n.code,{children:"void"})," >"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Remove a secret from storage."}),"\n",(0,s.jsx)(n.h4,{id:"parameters",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"key"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n",(0,s.jsx)(n.p,{children:"The key the secret was stored under."}),"\n",(0,s.jsx)(n.h4,{id:"returns",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"Promise"}),"< ",(0,s.jsx)(n.code,{children:"void"})," >"]}),"\n",(0,s.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L4227",children:"packages/extension-api/src/extension-api.d.ts:4227"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"get",children:"get()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"get"}),"(",(0,s.jsx)(n.code,{children:"key"}),"): ",(0,s.jsx)(n.code,{children:"Promise"}),"< ",(0,s.jsx)(n.code,{children:"undefined"})," | ",(0,s.jsx)(n.code,{children:"string"})," >"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Retrieve a secret that was stored with key. Returns undefined if there\nis no secret matching that key."}),"\n",(0,s.jsx)(n.h4,{id:"parameters-1",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"key"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n",(0,s.jsx)(n.p,{children:"The key the secret was stored under."}),"\n",(0,s.jsx)(n.h4,{id:"returns-1",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"Promise"}),"< ",(0,s.jsx)(n.code,{children:"undefined"})," | ",(0,s.jsx)(n.code,{children:"string"})," >"]}),"\n",(0,s.jsxs)(n.p,{children:["The stored value or ",(0,s.jsx)(n.code,{children:"undefined"}),"."]}),"\n",(0,s.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/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:"store",children:"store()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"store"}),"(",(0,s.jsx)(n.code,{children:"key"}),", ",(0,s.jsx)(n.code,{children:"value"}),"): ",(0,s.jsx)(n.code,{children:"Promise"}),"< ",(0,s.jsx)(n.code,{children:"void"})," >"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Store a secret under a given key."}),"\n",(0,s.jsx)(n.h4,{id:"parameters-2",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"key"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n",(0,s.jsx)(n.p,{children:"The key to store the secret under."}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"value"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n",(0,s.jsx)(n.p,{children:"The secret."}),"\n",(0,s.jsx)(n.h4,{id:"returns-2",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"Promise"}),"< ",(0,s.jsx)(n.code,{children:"void"})," >"]}),"\n",(0,s.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L4221",children:"packages/extension-api/src/extension-api.d.ts:4221"})})]})}function h(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},71670:(e,n,r)=>{r.d(n,{Z:()=>d,a:()=>c});var s=r(27378);const t={},i=s.createContext(t);function c(e){const n=s.useContext(i);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function d(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:c(e.components),s.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[5477],{1499:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>o,contentTitle:()=>c,default:()=>h,frontMatter:()=>i,metadata:()=>d,toc:()=>a});var s=r(24246),t=r(71670);const i={},c="Interface: SecretStorage",d={id:"interfaces/SecretStorage",title:"Interface: SecretStorage",description:"Represents a storage utility for secrets, information that is",source:"@site/api/interfaces/SecretStorage.md",sourceDirName:"interfaces",slug:"/interfaces/SecretStorage",permalink:"/api/interfaces/SecretStorage",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: SaveDialogOptions",permalink:"/api/interfaces/SaveDialogOptions"},next:{title:"Interface: SecretStorageChangeEvent",permalink:"/api/interfaces/SecretStorageChangeEvent"}},o={},a=[{value:"Properties",id:"properties",level:2},{value:"onDidChange",id:"ondidchange",level:3},{value:"Source",id:"source",level:4},{value:"Methods",id:"methods",level:2},{value:"delete()",id:"delete",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Source",id:"source-1",level:4},{value:"get()",id:"get",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Source",id:"source-2",level:4},{value:"store()",id:"store",level:3},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-2",level:4},{value:"Source",id:"source-3",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,t.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"interface-secretstorage",children:"Interface: SecretStorage"}),"\n",(0,s.jsx)(n.p,{children:"Represents a storage utility for secrets, information that is\nsensitive."}),"\n",(0,s.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,s.jsx)(n.h3,{id:"ondidchange",children:"onDidChange"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"onDidChange"}),": ",(0,s.jsx)(n.a,{href:"/api/interfaces/Event",children:(0,s.jsx)(n.code,{children:"Event"})}),"< ",(0,s.jsx)(n.a,{href:"/api/interfaces/SecretStorageChangeEvent",children:(0,s.jsx)(n.code,{children:"SecretStorageChangeEvent"})})," >"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Fires when a secret is stored or deleted."}),"\n",(0,s.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L4232",children:"packages/extension-api/src/extension-api.d.ts:4232"})}),"\n",(0,s.jsx)(n.h2,{id:"methods",children:"Methods"}),"\n",(0,s.jsx)(n.h3,{id:"delete",children:"delete()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"delete"}),"(",(0,s.jsx)(n.code,{children:"key"}),"): ",(0,s.jsx)(n.code,{children:"Promise"}),"< ",(0,s.jsx)(n.code,{children:"void"})," >"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Remove a secret from storage."}),"\n",(0,s.jsx)(n.h4,{id:"parameters",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"key"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n",(0,s.jsx)(n.p,{children:"The key the secret was stored under."}),"\n",(0,s.jsx)(n.h4,{id:"returns",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"Promise"}),"< ",(0,s.jsx)(n.code,{children:"void"})," >"]}),"\n",(0,s.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L4227",children:"packages/extension-api/src/extension-api.d.ts:4227"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"get",children:"get()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"get"}),"(",(0,s.jsx)(n.code,{children:"key"}),"): ",(0,s.jsx)(n.code,{children:"Promise"}),"< ",(0,s.jsx)(n.code,{children:"undefined"})," | ",(0,s.jsx)(n.code,{children:"string"})," >"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Retrieve a secret that was stored with key. Returns undefined if there\nis no secret matching that key."}),"\n",(0,s.jsx)(n.h4,{id:"parameters-1",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"key"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n",(0,s.jsx)(n.p,{children:"The key the secret was stored under."}),"\n",(0,s.jsx)(n.h4,{id:"returns-1",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"Promise"}),"< ",(0,s.jsx)(n.code,{children:"undefined"})," | ",(0,s.jsx)(n.code,{children:"string"})," >"]}),"\n",(0,s.jsxs)(n.p,{children:["The stored value or ",(0,s.jsx)(n.code,{children:"undefined"}),"."]}),"\n",(0,s.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/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:"store",children:"store()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"store"}),"(",(0,s.jsx)(n.code,{children:"key"}),", ",(0,s.jsx)(n.code,{children:"value"}),"): ",(0,s.jsx)(n.code,{children:"Promise"}),"< ",(0,s.jsx)(n.code,{children:"void"})," >"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Store a secret under a given key."}),"\n",(0,s.jsx)(n.h4,{id:"parameters-2",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"key"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n",(0,s.jsx)(n.p,{children:"The key to store the secret under."}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"value"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n",(0,s.jsx)(n.p,{children:"The secret."}),"\n",(0,s.jsx)(n.h4,{id:"returns-2",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"Promise"}),"< ",(0,s.jsx)(n.code,{children:"void"})," >"]}),"\n",(0,s.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L4221",children:"packages/extension-api/src/extension-api.d.ts:4221"})})]})}function h(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},71670:(e,n,r)=>{r.d(n,{Z:()=>d,a:()=>c});var s=r(27378);const t={},i=s.createContext(t);function c(e){const n=s.useContext(i);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function d(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:c(e.components),s.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/16914cba.9101c7ce.js b/assets/js/16914cba.22f20107.js similarity index 96% rename from assets/js/16914cba.9101c7ce.js rename to assets/js/16914cba.22f20107.js index 66d29a5373d..299b7980728 100644 --- a/assets/js/16914cba.9101c7ce.js +++ b/assets/js/16914cba.22f20107.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[64315],{26293:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>o,default:()=>u,frontMatter:()=>r,metadata:()=>c,toc:()=>d});var i=t(24246),s=t(71670);const r={},o="Function: deleteContainer()",c={id:"namespaces/containerEngine/functions/deleteContainer",title:"Function: deleteContainer()",description:"deleteContainer(engineId, id): Promise\\",source:"@site/api/namespaces/containerEngine/functions/deleteContainer.md",sourceDirName:"namespaces/containerEngine/functions",slug:"/namespaces/containerEngine/functions/deleteContainer",permalink:"/api/namespaces/containerEngine/functions/deleteContainer",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Function: createVolume()",permalink:"/api/namespaces/containerEngine/functions/createVolume"},next:{title:"Function: deleteImage()",permalink:"/api/namespaces/containerEngine/functions/deleteImage"}},a={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"function-deletecontainer",children:"Function: deleteContainer()"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"deleteContainer"}),"(",(0,i.jsx)(n.code,{children:"engineId"}),", ",(0,i.jsx)(n.code,{children:"id"}),"): ",(0,i.jsx)(n.code,{children:"Promise"}),"< ",(0,i.jsx)(n.code,{children:"void"})," >"]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Delete an existing container"}),"\n",(0,i.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"engineId"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n",(0,i.jsxs)(n.p,{children:["the id of the engine managing the container, obtained from the result of ",(0,i.jsx)(n.a,{href:"/api/namespaces/containerEngine/functions/listContainers",children:"containerEngine.listContainers"})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"id"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n",(0,i.jsxs)(n.p,{children:["the id of the container on this engine, obtained from the result of ",(0,i.jsx)(n.a,{href:"/api/namespaces/containerEngine/functions/listContainers",children:"containerEngine.listContainers"})," or as the result of ",(0,i.jsx)(n.a,{href:"/api/namespaces/containerEngine/functions/createContainer",children:"containerEngine.createContainer"})]}),"\n",(0,i.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"Promise"}),"< ",(0,i.jsx)(n.code,{children:"void"})," >"]}),"\n",(0,i.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L3243",children:"packages/extension-api/src/extension-api.d.ts:3243"})})]})}function u(e={}){const{wrapper:n}={...(0,s.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>c,a:()=>o});var i=t(27378);const s={},r=i.createContext(s);function o(e){const n=i.useContext(r);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:o(e.components),i.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[64315],{26293:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>o,default:()=>u,frontMatter:()=>r,metadata:()=>c,toc:()=>d});var i=t(24246),s=t(71670);const r={},o="Function: deleteContainer()",c={id:"namespaces/containerEngine/functions/deleteContainer",title:"Function: deleteContainer()",description:"deleteContainer(engineId, id): Promise\\",source:"@site/api/namespaces/containerEngine/functions/deleteContainer.md",sourceDirName:"namespaces/containerEngine/functions",slug:"/namespaces/containerEngine/functions/deleteContainer",permalink:"/api/namespaces/containerEngine/functions/deleteContainer",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Function: createVolume()",permalink:"/api/namespaces/containerEngine/functions/createVolume"},next:{title:"Function: deleteImage()",permalink:"/api/namespaces/containerEngine/functions/deleteImage"}},a={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"function-deletecontainer",children:"Function: deleteContainer()"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"deleteContainer"}),"(",(0,i.jsx)(n.code,{children:"engineId"}),", ",(0,i.jsx)(n.code,{children:"id"}),"): ",(0,i.jsx)(n.code,{children:"Promise"}),"< ",(0,i.jsx)(n.code,{children:"void"})," >"]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Delete an existing container"}),"\n",(0,i.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"engineId"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n",(0,i.jsxs)(n.p,{children:["the id of the engine managing the container, obtained from the result of ",(0,i.jsx)(n.a,{href:"/api/namespaces/containerEngine/functions/listContainers",children:"containerEngine.listContainers"})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"id"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n",(0,i.jsxs)(n.p,{children:["the id of the container on this engine, obtained from the result of ",(0,i.jsx)(n.a,{href:"/api/namespaces/containerEngine/functions/listContainers",children:"containerEngine.listContainers"})," or as the result of ",(0,i.jsx)(n.a,{href:"/api/namespaces/containerEngine/functions/createContainer",children:"containerEngine.createContainer"})]}),"\n",(0,i.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"Promise"}),"< ",(0,i.jsx)(n.code,{children:"void"})," >"]}),"\n",(0,i.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L3243",children:"packages/extension-api/src/extension-api.d.ts:3243"})})]})}function u(e={}){const{wrapper:n}={...(0,s.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>c,a:()=>o});var i=t(27378);const s={},r=i.createContext(s);function o(e){const n=i.useContext(r);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:o(e.components),i.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/17612ae7.84bb1e5e.js b/assets/js/17612ae7.8a1f3e26.js similarity index 96% rename from assets/js/17612ae7.84bb1e5e.js rename to assets/js/17612ae7.8a1f3e26.js index d7688b5ca2c..d3347cd8f6b 100644 --- a/assets/js/17612ae7.84bb1e5e.js +++ b/assets/js/17612ae7.8a1f3e26.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[97767],{68278:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>o,default:()=>u,frontMatter:()=>c,metadata:()=>r,toc:()=>d});var i=t(24246),s=t(71670);const c={},o="Function: deleteImage()",r={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:"Function: deleteContainer()",permalink:"/api/namespaces/containerEngine/functions/deleteContainer"},next:{title:"Function: deleteVolume()",permalink:"/api/namespaces/containerEngine/functions/deleteVolume"}},a={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"function-deleteimage",children:"Function: deleteImage()"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"deleteImage"}),"(",(0,i.jsx)(n.code,{children:"engineId"}),", ",(0,i.jsx)(n.code,{children:"id"}),"): ",(0,i.jsx)(n.code,{children:"Promise"}),"< ",(0,i.jsx)(n.code,{children:"void"})," >"]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Delete a container image from a local engine"}),"\n",(0,i.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"engineId"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n",(0,i.jsxs)(n.p,{children:["the id of the engine managing the image, obtained from the result of ",(0,i.jsx)(n.a,{href:"/api/namespaces/containerEngine/functions/listImages",children:"containerEngine.listImages"})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"id"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n",(0,i.jsxs)(n.p,{children:["the id of the image on this engine, obtained from the result of ",(0,i.jsx)(n.a,{href:"/api/namespaces/containerEngine/functions/listImages",children:"containerEngine.listImages"})]}),"\n",(0,i.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"Promise"}),"< ",(0,i.jsx)(n.code,{children:"void"})," >"]}),"\n",(0,i.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L3331",children:"packages/extension-api/src/extension-api.d.ts:3331"})})]})}function u(e={}){const{wrapper:n}={...(0,s.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>r,a:()=>o});var i=t(27378);const s={},c=i.createContext(s);function o(e){const n=i.useContext(c);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function r(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:o(e.components),i.createElement(c.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[97767],{68278:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>o,default:()=>u,frontMatter:()=>c,metadata:()=>r,toc:()=>d});var i=t(24246),s=t(71670);const c={},o="Function: deleteImage()",r={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:"Function: deleteContainer()",permalink:"/api/namespaces/containerEngine/functions/deleteContainer"},next:{title:"Function: deleteVolume()",permalink:"/api/namespaces/containerEngine/functions/deleteVolume"}},a={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"function-deleteimage",children:"Function: deleteImage()"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"deleteImage"}),"(",(0,i.jsx)(n.code,{children:"engineId"}),", ",(0,i.jsx)(n.code,{children:"id"}),"): ",(0,i.jsx)(n.code,{children:"Promise"}),"< ",(0,i.jsx)(n.code,{children:"void"})," >"]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Delete a container image from a local engine"}),"\n",(0,i.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"engineId"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n",(0,i.jsxs)(n.p,{children:["the id of the engine managing the image, obtained from the result of ",(0,i.jsx)(n.a,{href:"/api/namespaces/containerEngine/functions/listImages",children:"containerEngine.listImages"})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"id"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n",(0,i.jsxs)(n.p,{children:["the id of the image on this engine, obtained from the result of ",(0,i.jsx)(n.a,{href:"/api/namespaces/containerEngine/functions/listImages",children:"containerEngine.listImages"})]}),"\n",(0,i.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"Promise"}),"< ",(0,i.jsx)(n.code,{children:"void"})," >"]}),"\n",(0,i.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L3331",children:"packages/extension-api/src/extension-api.d.ts:3331"})})]})}function u(e={}){const{wrapper:n}={...(0,s.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>r,a:()=>o});var i=t(27378);const s={},c=i.createContext(s);function o(e){const n=i.useContext(c);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function r(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:o(e.components),i.createElement(c.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/17d2ebc8.52d258b6.js b/assets/js/17d2ebc8.fb8007b9.js similarity index 89% rename from assets/js/17d2ebc8.52d258b6.js rename to assets/js/17d2ebc8.fb8007b9.js index 98215eeecc8..588c5a72c77 100644 --- a/assets/js/17d2ebc8.52d258b6.js +++ b/assets/js/17d2ebc8.fb8007b9.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[14142],{75450:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>c,default:()=>p,frontMatter:()=>r,metadata:()=>o,toc:()=>d});var s=t(24246),i=t(71670);const r={},c="Interface: ContainerJSONEvent",o={id:"interfaces/ContainerJSONEvent",title:"Interface: ContainerJSONEvent",description:"Properties",source:"@site/api/interfaces/ContainerJSONEvent.md",sourceDirName:"interfaces",slug:"/interfaces/ContainerJSONEvent",permalink:"/api/interfaces/ContainerJSONEvent",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: ContainerInspectInfo",permalink:"/api/interfaces/ContainerInspectInfo"},next:{title:"Interface: ContainerProviderConnection",permalink:"/api/interfaces/ContainerProviderConnection"}},a={},d=[{value:"Properties",id:"properties",level:2},{value:"Type?",id:"type",level:3},{value:"Source",id:"source",level:4},{value:"id",id:"id",level:3},{value:"Source",id:"source-1",level:4},{value:"status",id:"status",level:3},{value:"Source",id:"source-2",level:4},{value:"type",id:"type-1",level:3},{value:"Source",id:"source-3",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,i.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"interface-containerjsonevent",children:"Interface: ContainerJSONEvent"}),"\n",(0,s.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,s.jsx)(n.h3,{id:"type",children:"Type?"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:(0,s.jsx)(n.code,{children:"optional"})})," ",(0,s.jsx)(n.strong,{children:"Type"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2367",children:"packages/extension-api/src/extension-api.d.ts:2367"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"id",children:"id"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"id"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2366",children:"packages/extension-api/src/extension-api.d.ts:2366"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"status",children:"status"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"status"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2365",children:"packages/extension-api/src/extension-api.d.ts:2365"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"type-1",children:"type"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"type"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2364",children:"packages/extension-api/src/extension-api.d.ts:2364"})})]})}function p(e={}){const{wrapper:n}={...(0,i.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>o,a:()=>c});var s=t(27378);const i={},r=s.createContext(i);function c(e){const n=s.useContext(r);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:c(e.components),s.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[14142],{75450:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>c,default:()=>p,frontMatter:()=>r,metadata:()=>o,toc:()=>d});var s=t(24246),i=t(71670);const r={},c="Interface: ContainerJSONEvent",o={id:"interfaces/ContainerJSONEvent",title:"Interface: ContainerJSONEvent",description:"Properties",source:"@site/api/interfaces/ContainerJSONEvent.md",sourceDirName:"interfaces",slug:"/interfaces/ContainerJSONEvent",permalink:"/api/interfaces/ContainerJSONEvent",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: ContainerInspectInfo",permalink:"/api/interfaces/ContainerInspectInfo"},next:{title:"Interface: ContainerProviderConnection",permalink:"/api/interfaces/ContainerProviderConnection"}},a={},d=[{value:"Properties",id:"properties",level:2},{value:"Type?",id:"type",level:3},{value:"Source",id:"source",level:4},{value:"id",id:"id",level:3},{value:"Source",id:"source-1",level:4},{value:"status",id:"status",level:3},{value:"Source",id:"source-2",level:4},{value:"type",id:"type-1",level:3},{value:"Source",id:"source-3",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,i.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"interface-containerjsonevent",children:"Interface: ContainerJSONEvent"}),"\n",(0,s.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,s.jsx)(n.h3,{id:"type",children:"Type?"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:(0,s.jsx)(n.code,{children:"optional"})})," ",(0,s.jsx)(n.strong,{children:"Type"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2367",children:"packages/extension-api/src/extension-api.d.ts:2367"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"id",children:"id"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"id"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2366",children:"packages/extension-api/src/extension-api.d.ts:2366"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"status",children:"status"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"status"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2365",children:"packages/extension-api/src/extension-api.d.ts:2365"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"type-1",children:"type"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"type"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2364",children:"packages/extension-api/src/extension-api.d.ts:2364"})})]})}function p(e={}){const{wrapper:n}={...(0,i.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>o,a:()=>c});var s=t(27378);const i={},r=s.createContext(i);function c(e){const n=s.useContext(r);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:c(e.components),s.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/180d0c5f.f9a48f81.js b/assets/js/180d0c5f.472b25a6.js similarity index 95% rename from assets/js/180d0c5f.f9a48f81.js rename to assets/js/180d0c5f.472b25a6.js index 70dce352f7d..e9572f0fceb 100644 --- a/assets/js/180d0c5f.f9a48f81.js +++ b/assets/js/180d0c5f.472b25a6.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[51499],{93302:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>r,default:()=>u,frontMatter:()=>o,metadata:()=>c,toc:()=>h});var i=t(24246),s=t(71670);const o={},r="Interface: AuthenticationSessionsChangeEvent",c={id:"interfaces/AuthenticationSessionsChangeEvent",title:"Interface: AuthenticationSessionsChangeEvent",description:"An event which fires when an AuthenticationSession is added, removed, or changed.",source:"@site/api/interfaces/AuthenticationSessionsChangeEvent.md",sourceDirName:"interfaces",slug:"/interfaces/AuthenticationSessionsChangeEvent",permalink:"/api/interfaces/AuthenticationSessionsChangeEvent",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: AuthenticationSessionAccountInformation",permalink:"/api/interfaces/AuthenticationSessionAccountInformation"},next:{title:"Interface: BlkioStatEntry",permalink:"/api/interfaces/BlkioStatEntry"}},a={},h=[{value:"Properties",id:"properties",level:2},{value:"provider",id:"provider",level:3},{value:"Source",id:"source",level:4}];function d(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"interface-authenticationsessionschangeevent",children:"Interface: AuthenticationSessionsChangeEvent"}),"\n",(0,i.jsxs)(n.p,{children:["An ",(0,i.jsx)(n.a,{href:"#Event",children:"event"})," which fires when an ",(0,i.jsx)(n.a,{href:"#AuthenticationSession",children:"AuthenticationSession"})," is added, removed, or changed."]}),"\n",(0,i.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(n.h3,{id:"provider",children:"provider"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"readonly"})})," ",(0,i.jsx)(n.strong,{children:"provider"}),": ",(0,i.jsx)(n.a,{href:"/api/interfaces/AuthenticationProviderInformation",children:(0,i.jsx)(n.code,{children:"AuthenticationProviderInformation"})})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["The ",(0,i.jsx)(n.a,{href:"#AuthenticationProvider",children:"authenticationProvider"})," that has had its sessions change."]}),"\n",(0,i.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L3507",children:"packages/extension-api/src/extension-api.d.ts:3507"})})]})}function u(e={}){const{wrapper:n}={...(0,s.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(d,{...e})}):d(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>c,a:()=>r});var i=t(27378);const s={},o=i.createContext(s);function r(e){const n=i.useContext(o);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:r(e.components),i.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[51499],{93302:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>r,default:()=>u,frontMatter:()=>o,metadata:()=>c,toc:()=>h});var i=t(24246),s=t(71670);const o={},r="Interface: AuthenticationSessionsChangeEvent",c={id:"interfaces/AuthenticationSessionsChangeEvent",title:"Interface: AuthenticationSessionsChangeEvent",description:"An event which fires when an AuthenticationSession is added, removed, or changed.",source:"@site/api/interfaces/AuthenticationSessionsChangeEvent.md",sourceDirName:"interfaces",slug:"/interfaces/AuthenticationSessionsChangeEvent",permalink:"/api/interfaces/AuthenticationSessionsChangeEvent",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: AuthenticationSessionAccountInformation",permalink:"/api/interfaces/AuthenticationSessionAccountInformation"},next:{title:"Interface: BlkioStatEntry",permalink:"/api/interfaces/BlkioStatEntry"}},a={},h=[{value:"Properties",id:"properties",level:2},{value:"provider",id:"provider",level:3},{value:"Source",id:"source",level:4}];function d(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"interface-authenticationsessionschangeevent",children:"Interface: AuthenticationSessionsChangeEvent"}),"\n",(0,i.jsxs)(n.p,{children:["An ",(0,i.jsx)(n.a,{href:"#Event",children:"event"})," which fires when an ",(0,i.jsx)(n.a,{href:"#AuthenticationSession",children:"AuthenticationSession"})," is added, removed, or changed."]}),"\n",(0,i.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(n.h3,{id:"provider",children:"provider"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"readonly"})})," ",(0,i.jsx)(n.strong,{children:"provider"}),": ",(0,i.jsx)(n.a,{href:"/api/interfaces/AuthenticationProviderInformation",children:(0,i.jsx)(n.code,{children:"AuthenticationProviderInformation"})})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["The ",(0,i.jsx)(n.a,{href:"#AuthenticationProvider",children:"authenticationProvider"})," that has had its sessions change."]}),"\n",(0,i.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L3507",children:"packages/extension-api/src/extension-api.d.ts:3507"})})]})}function u(e={}){const{wrapper:n}={...(0,s.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(d,{...e})}):d(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>c,a:()=>r});var i=t(27378);const s={},o=i.createContext(s);function r(e){const n=i.useContext(o);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:r(e.components),i.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/185c52e7.872aa714.js b/assets/js/185c52e7.81fc27f9.js similarity index 84% rename from assets/js/185c52e7.872aa714.js rename to assets/js/185c52e7.81fc27f9.js index 6e08779a308..040ccc62cfd 100644 --- a/assets/js/185c52e7.872aa714.js +++ b/assets/js/185c52e7.81fc27f9.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[90051],{89425:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>a,contentTitle:()=>t,default:()=>p,frontMatter:()=>c,metadata:()=>o,toc:()=>d});var i=s(24246),r=s(71670);const c={},t="Interface: VolumeCreateResponseInfo",o={id:"interfaces/VolumeCreateResponseInfo",title:"Interface: VolumeCreateResponseInfo",description:"Properties",source:"@site/api/interfaces/VolumeCreateResponseInfo.md",sourceDirName:"interfaces",slug:"/interfaces/VolumeCreateResponseInfo",permalink:"/api/interfaces/VolumeCreateResponseInfo",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: VolumeCreateOptions",permalink:"/api/interfaces/VolumeCreateOptions"},next:{title:"Interface: VolumeDeleteOptions",permalink:"/api/interfaces/VolumeDeleteOptions"}},a={},d=[{value:"Properties",id:"properties",level:2},{value:"CreatedAt?",id:"createdat",level:3},{value:"Source",id:"source",level:4},{value:"Driver",id:"driver",level:3},{value:"Source",id:"source-1",level:4},{value:"Labels",id:"labels",level:3},{value:"Index signature",id:"index-signature",level:4},{value:"Source",id:"source-2",level:4},{value:"Mountpoint",id:"mountpoint",level:3},{value:"Source",id:"source-3",level:4},{value:"Name",id:"name",level:3},{value:"Source",id:"source-4",level:4},{value:"Scope",id:"scope",level:3},{value:"Source",id:"source-5",level:4},{value:"Status?",id:"status",level:3},{value:"Index signature",id:"index-signature-1",level:4},{value:"Source",id:"source-6",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,r.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"interface-volumecreateresponseinfo",children:"Interface: VolumeCreateResponseInfo"}),"\n",(0,i.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(n.h3,{id:"createdat",children:"CreatedAt?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"CreatedAt"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L3134",children:"packages/extension-api/src/extension-api.d.ts:3134"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"driver",children:"Driver"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Driver"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L3132",children:"packages/extension-api/src/extension-api.d.ts:3132"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"labels",children:"Labels"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Labels"}),": ",(0,i.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"index-signature",children:"Index signature"}),"\n",(0,i.jsxs)(n.p,{children:["[",(0,i.jsx)(n.code,{children:"label"}),": ",(0,i.jsx)(n.code,{children:"string"}),"]: ",(0,i.jsx)(n.code,{children:"string"})]}),"\n",(0,i.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/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:"mountpoint",children:"Mountpoint"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Mountpoint"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/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:"name",children:"Name"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Name"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-4",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L3131",children:"packages/extension-api/src/extension-api.d.ts:3131"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"scope",children:"Scope"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Scope"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-5",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L3137",children:"packages/extension-api/src/extension-api.d.ts:3137"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"status",children:"Status?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"Status"}),": ",(0,i.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"index-signature-1",children:"Index signature"}),"\n",(0,i.jsxs)(n.p,{children:["[",(0,i.jsx)(n.code,{children:"key"}),": ",(0,i.jsx)(n.code,{children:"string"}),"]: ",(0,i.jsx)(n.code,{children:"string"})]}),"\n",(0,i.jsx)(n.h4,{id:"source-6",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L3135",children:"packages/extension-api/src/extension-api.d.ts:3135"})})]})}function p(e={}){const{wrapper:n}={...(0,r.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>o,a:()=>t});var i=s(27378);const r={},c=i.createContext(r);function t(e){const n=i.useContext(c);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:t(e.components),i.createElement(c.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[90051],{89425:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>d,contentTitle:()=>c,default:()=>p,frontMatter:()=>t,metadata:()=>o,toc:()=>a});var i=s(24246),r=s(71670);const t={},c="Interface: VolumeCreateResponseInfo",o={id:"interfaces/VolumeCreateResponseInfo",title:"Interface: VolumeCreateResponseInfo",description:"Properties",source:"@site/api/interfaces/VolumeCreateResponseInfo.md",sourceDirName:"interfaces",slug:"/interfaces/VolumeCreateResponseInfo",permalink:"/api/interfaces/VolumeCreateResponseInfo",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: VolumeCreateOptions",permalink:"/api/interfaces/VolumeCreateOptions"},next:{title:"Interface: VolumeDeleteOptions",permalink:"/api/interfaces/VolumeDeleteOptions"}},d={},a=[{value:"Properties",id:"properties",level:2},{value:"CreatedAt?",id:"createdat",level:3},{value:"Source",id:"source",level:4},{value:"Driver",id:"driver",level:3},{value:"Source",id:"source-1",level:4},{value:"Labels",id:"labels",level:3},{value:"Index signature",id:"index-signature",level:4},{value:"Source",id:"source-2",level:4},{value:"Mountpoint",id:"mountpoint",level:3},{value:"Source",id:"source-3",level:4},{value:"Name",id:"name",level:3},{value:"Source",id:"source-4",level:4},{value:"Scope",id:"scope",level:3},{value:"Source",id:"source-5",level:4},{value:"Status?",id:"status",level:3},{value:"Index signature",id:"index-signature-1",level:4},{value:"Source",id:"source-6",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,r.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"interface-volumecreateresponseinfo",children:"Interface: VolumeCreateResponseInfo"}),"\n",(0,i.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(n.h3,{id:"createdat",children:"CreatedAt?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"CreatedAt"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L3134",children:"packages/extension-api/src/extension-api.d.ts:3134"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"driver",children:"Driver"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Driver"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L3132",children:"packages/extension-api/src/extension-api.d.ts:3132"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"labels",children:"Labels"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Labels"}),": ",(0,i.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"index-signature",children:"Index signature"}),"\n",(0,i.jsxs)(n.p,{children:["[",(0,i.jsx)(n.code,{children:"label"}),": ",(0,i.jsx)(n.code,{children:"string"}),"]: ",(0,i.jsx)(n.code,{children:"string"})]}),"\n",(0,i.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/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:"mountpoint",children:"Mountpoint"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Mountpoint"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/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:"name",children:"Name"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Name"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-4",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L3131",children:"packages/extension-api/src/extension-api.d.ts:3131"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"scope",children:"Scope"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Scope"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-5",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L3137",children:"packages/extension-api/src/extension-api.d.ts:3137"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"status",children:"Status?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"Status"}),": ",(0,i.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"index-signature-1",children:"Index signature"}),"\n",(0,i.jsxs)(n.p,{children:["[",(0,i.jsx)(n.code,{children:"key"}),": ",(0,i.jsx)(n.code,{children:"string"}),"]: ",(0,i.jsx)(n.code,{children:"string"})]}),"\n",(0,i.jsx)(n.h4,{id:"source-6",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L3135",children:"packages/extension-api/src/extension-api.d.ts:3135"})})]})}function p(e={}){const{wrapper:n}={...(0,r.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>o,a:()=>c});var i=s(27378);const r={},t=i.createContext(r);function c(e){const n=i.useContext(t);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:c(e.components),i.createElement(t.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/19e69ccd.d71a6bd7.js b/assets/js/19e69ccd.579209e3.js similarity index 84% rename from assets/js/19e69ccd.d71a6bd7.js rename to assets/js/19e69ccd.579209e3.js index 8d8d89acdce..8116349e984 100644 --- a/assets/js/19e69ccd.d71a6bd7.js +++ b/assets/js/19e69ccd.579209e3.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[76091],{73122:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>o,contentTitle:()=>r,default:()=>p,frontMatter:()=>i,metadata:()=>a,toc:()=>l});var t=s(24246),c=s(71670);const i={},r="Interface: CPUStats",a={id:"interfaces/CPUStats",title:"Interface: CPUStats",description:"Properties",source:"@site/api/interfaces/CPUStats.md",sourceDirName:"interfaces",slug:"/interfaces/CPUStats",permalink:"/api/interfaces/CPUStats",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: BuildImageOptions",permalink:"/api/interfaces/BuildImageOptions"},next:{title:"Interface: CPUUsage",permalink:"/api/interfaces/CPUUsage"}},o={},l=[{value:"Properties",id:"properties",level:2},{value:"cpu_usage",id:"cpu_usage",level:3},{value:"Source",id:"source",level:4},{value:"online_cpus",id:"online_cpus",level:3},{value:"Source",id:"source-1",level:4},{value:"system_cpu_usage",id:"system_cpu_usage",level:3},{value:"Source",id:"source-2",level:4},{value:"throttling_data",id:"throttling_data",level:3},{value:"Source",id:"source-3",level:4}];function d(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,c.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"interface-cpustats",children:"Interface: CPUStats"}),"\n",(0,t.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,t.jsx)(n.h3,{id:"cpu_usage",children:"cpu_usage"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"cpu_usage"}),": ",(0,t.jsx)(n.a,{href:"/api/interfaces/CPUUsage",children:(0,t.jsx)(n.code,{children:"CPUUsage"})})]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2861",children:"packages/extension-api/src/extension-api.d.ts:2861"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"online_cpus",children:"online_cpus"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"online_cpus"}),": ",(0,t.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2863",children:"packages/extension-api/src/extension-api.d.ts:2863"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"system_cpu_usage",children:"system_cpu_usage"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"system_cpu_usage"}),": ",(0,t.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2862",children:"packages/extension-api/src/extension-api.d.ts:2862"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"throttling_data",children:"throttling_data"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"throttling_data"}),": ",(0,t.jsx)(n.a,{href:"/api/interfaces/ThrottlingData",children:(0,t.jsx)(n.code,{children:"ThrottlingData"})})]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2864",children:"packages/extension-api/src/extension-api.d.ts:2864"})})]})}function p(e={}){const{wrapper:n}={...(0,c.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(d,{...e})}):d(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>a,a:()=>r});var t=s(27378);const c={},i=t.createContext(c);function r(e){const n=t.useContext(i);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function a(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(c):e.components||c:r(e.components),t.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[76091],{73122:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>o,contentTitle:()=>r,default:()=>p,frontMatter:()=>i,metadata:()=>a,toc:()=>d});var t=s(24246),c=s(71670);const i={},r="Interface: CPUStats",a={id:"interfaces/CPUStats",title:"Interface: CPUStats",description:"Properties",source:"@site/api/interfaces/CPUStats.md",sourceDirName:"interfaces",slug:"/interfaces/CPUStats",permalink:"/api/interfaces/CPUStats",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: BuildImageOptions",permalink:"/api/interfaces/BuildImageOptions"},next:{title:"Interface: CPUUsage",permalink:"/api/interfaces/CPUUsage"}},o={},d=[{value:"Properties",id:"properties",level:2},{value:"cpu_usage",id:"cpu_usage",level:3},{value:"Source",id:"source",level:4},{value:"online_cpus",id:"online_cpus",level:3},{value:"Source",id:"source-1",level:4},{value:"system_cpu_usage",id:"system_cpu_usage",level:3},{value:"Source",id:"source-2",level:4},{value:"throttling_data",id:"throttling_data",level:3},{value:"Source",id:"source-3",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,c.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"interface-cpustats",children:"Interface: CPUStats"}),"\n",(0,t.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,t.jsx)(n.h3,{id:"cpu_usage",children:"cpu_usage"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"cpu_usage"}),": ",(0,t.jsx)(n.a,{href:"/api/interfaces/CPUUsage",children:(0,t.jsx)(n.code,{children:"CPUUsage"})})]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2861",children:"packages/extension-api/src/extension-api.d.ts:2861"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"online_cpus",children:"online_cpus"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"online_cpus"}),": ",(0,t.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2863",children:"packages/extension-api/src/extension-api.d.ts:2863"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"system_cpu_usage",children:"system_cpu_usage"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"system_cpu_usage"}),": ",(0,t.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2862",children:"packages/extension-api/src/extension-api.d.ts:2862"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"throttling_data",children:"throttling_data"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"throttling_data"}),": ",(0,t.jsx)(n.a,{href:"/api/interfaces/ThrottlingData",children:(0,t.jsx)(n.code,{children:"ThrottlingData"})})]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2864",children:"packages/extension-api/src/extension-api.d.ts:2864"})})]})}function p(e={}){const{wrapper:n}={...(0,c.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>a,a:()=>r});var t=s(27378);const c={},i=t.createContext(c);function r(e){const n=t.useContext(i);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function a(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(c):e.components||c:r(e.components),t.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/1a906644.21eb35f6.js b/assets/js/1a906644.4287c938.js similarity index 96% rename from assets/js/1a906644.21eb35f6.js rename to assets/js/1a906644.4287c938.js index e9fea43c971..7ca336276ca 100644 --- a/assets/js/1a906644.21eb35f6.js +++ b/assets/js/1a906644.4287c938.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[52525],{34480:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>r,default:()=>u,frontMatter:()=>c,metadata:()=>o,toc:()=>d});var s=t(24246),i=t(71670);const c={},r="Function: createManifest()",o={id:"namespaces/containerEngine/functions/createManifest",title:"Function: createManifest()",description:"createManifest(options): Promise\\",source:"@site/api/namespaces/containerEngine/functions/createManifest.md",sourceDirName:"namespaces/containerEngine/functions",slug:"/namespaces/containerEngine/functions/createManifest",permalink:"/api/namespaces/containerEngine/functions/createManifest",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Function: createContainer()",permalink:"/api/namespaces/containerEngine/functions/createContainer"},next:{title:"Function: createNetwork()",permalink:"/api/namespaces/containerEngine/functions/createNetwork"}},a={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Id",id:"id",level:3},{value:"engineId",id:"engineid",level:3},{value:"Source",id:"source",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",p:"p",strong:"strong",...(0,i.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"function-createmanifest",children:"Function: createManifest()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"createManifest"}),"(",(0,s.jsx)(n.code,{children:"options"}),"): ",(0,s.jsx)(n.code,{children:"Promise"}),"< ",(0,s.jsx)(n.code,{children:"object"})," >"]}),"\n"]}),"\n",(0,s.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"options"}),": ",(0,s.jsx)(n.a,{href:"/api/interfaces/ManifestCreateOptions",children:(0,s.jsx)(n.code,{children:"ManifestCreateOptions"})})]}),"\n",(0,s.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"Promise"}),"< ",(0,s.jsx)(n.code,{children:"object"})," >"]}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsx)(n.h3,{id:"id",children:"Id"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Id"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h3,{id:"engineid",children:"engineId"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"engineId"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n"]}),"\n",(0,s.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L3386",children:"packages/extension-api/src/extension-api.d.ts:3386"})})]})}function u(e={}){const{wrapper:n}={...(0,i.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>o,a:()=>r});var s=t(27378);const i={},c=s.createContext(i);function r(e){const n=s.useContext(c);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:r(e.components),s.createElement(c.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[52525],{34480:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>r,default:()=>u,frontMatter:()=>c,metadata:()=>o,toc:()=>d});var s=t(24246),i=t(71670);const c={},r="Function: createManifest()",o={id:"namespaces/containerEngine/functions/createManifest",title:"Function: createManifest()",description:"createManifest(options): Promise\\",source:"@site/api/namespaces/containerEngine/functions/createManifest.md",sourceDirName:"namespaces/containerEngine/functions",slug:"/namespaces/containerEngine/functions/createManifest",permalink:"/api/namespaces/containerEngine/functions/createManifest",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Function: createContainer()",permalink:"/api/namespaces/containerEngine/functions/createContainer"},next:{title:"Function: createNetwork()",permalink:"/api/namespaces/containerEngine/functions/createNetwork"}},a={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Id",id:"id",level:3},{value:"engineId",id:"engineid",level:3},{value:"Source",id:"source",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",p:"p",strong:"strong",...(0,i.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"function-createmanifest",children:"Function: createManifest()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"createManifest"}),"(",(0,s.jsx)(n.code,{children:"options"}),"): ",(0,s.jsx)(n.code,{children:"Promise"}),"< ",(0,s.jsx)(n.code,{children:"object"})," >"]}),"\n"]}),"\n",(0,s.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"options"}),": ",(0,s.jsx)(n.a,{href:"/api/interfaces/ManifestCreateOptions",children:(0,s.jsx)(n.code,{children:"ManifestCreateOptions"})})]}),"\n",(0,s.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"Promise"}),"< ",(0,s.jsx)(n.code,{children:"object"})," >"]}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsx)(n.h3,{id:"id",children:"Id"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Id"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h3,{id:"engineid",children:"engineId"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"engineId"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n"]}),"\n",(0,s.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L3386",children:"packages/extension-api/src/extension-api.d.ts:3386"})})]})}function u(e={}){const{wrapper:n}={...(0,i.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>o,a:()=>r});var s=t(27378);const i={},c=s.createContext(i);function r(e){const n=s.useContext(c);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:r(e.components),s.createElement(c.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/1dfee34e.dfca0ffb.js b/assets/js/1dfee34e.dbcae126.js similarity index 96% rename from assets/js/1dfee34e.dfca0ffb.js rename to assets/js/1dfee34e.dbcae126.js index c070ac50411..b8c7539b8ed 100644 --- a/assets/js/1dfee34e.dfca0ffb.js +++ b/assets/js/1dfee34e.dbcae126.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[15554],{36729:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>l,contentTitle:()=>r,default:()=>u,frontMatter:()=>i,metadata:()=>t,toc:()=>a});var c=s(24246),o=s(71670);const i={},r="Class: CancellationTokenSource",t={id:"classes/CancellationTokenSource",title:"Class: CancellationTokenSource",description:"Constructors",source:"@site/api/classes/CancellationTokenSource.md",sourceDirName:"classes",slug:"/classes/CancellationTokenSource",permalink:"/api/classes/CancellationTokenSource",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Enumeration: QuickPickItemKind",permalink:"/api/enumerations/QuickPickItemKind"},next:{title:"Class: Disposable",permalink:"/api/classes/Disposable"}},l={},a=[{value:"Constructors",id:"constructors",level:2},{value:"new CancellationTokenSource()",id:"new-cancellationtokensource",level:3},{value:"Returns",id:"returns",level:4},{value:"Properties",id:"properties",level:2},{value:"token",id:"token",level:3},{value:"Source",id:"source",level:4},{value:"Methods",id:"methods",level:2},{value:"cancel()",id:"cancel",level:3},{value:"Returns",id:"returns-1",level:4},{value:"Source",id:"source-1",level:4},{value:"dispose()",id:"dispose",level:3},{value:"Returns",id:"returns-2",level:4},{value:"Source",id:"source-2",level:4}];function d(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,o.a)(),...e.components};return(0,c.jsxs)(c.Fragment,{children:[(0,c.jsx)(n.h1,{id:"class-cancellationtokensource",children:"Class: CancellationTokenSource"}),"\n",(0,c.jsx)(n.h2,{id:"constructors",children:"Constructors"}),"\n",(0,c.jsx)(n.h3,{id:"new-cancellationtokensource",children:"new CancellationTokenSource()"}),"\n",(0,c.jsxs)(n.blockquote,{children:["\n",(0,c.jsxs)(n.p,{children:[(0,c.jsx)(n.strong,{children:"new CancellationTokenSource"}),"(): ",(0,c.jsx)(n.a,{href:"/api/classes/CancellationTokenSource",children:(0,c.jsx)(n.code,{children:"CancellationTokenSource"})})]}),"\n"]}),"\n",(0,c.jsx)(n.h4,{id:"returns",children:"Returns"}),"\n",(0,c.jsx)(n.p,{children:(0,c.jsx)(n.a,{href:"/api/classes/CancellationTokenSource",children:(0,c.jsx)(n.code,{children:"CancellationTokenSource"})})}),"\n",(0,c.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,c.jsx)(n.h3,{id:"token",children:"token"}),"\n",(0,c.jsxs)(n.blockquote,{children:["\n",(0,c.jsxs)(n.p,{children:[(0,c.jsx)(n.strong,{children:"token"}),": ",(0,c.jsx)(n.a,{href:"/api/interfaces/CancellationToken",children:(0,c.jsx)(n.code,{children:"CancellationToken"})})]}),"\n"]}),"\n",(0,c.jsx)(n.p,{children:"The cancellation token of this source."}),"\n",(0,c.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,c.jsx)(n.p,{children:(0,c.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L795",children:"packages/extension-api/src/extension-api.d.ts:795"})}),"\n",(0,c.jsx)(n.h2,{id:"methods",children:"Methods"}),"\n",(0,c.jsx)(n.h3,{id:"cancel",children:"cancel()"}),"\n",(0,c.jsxs)(n.blockquote,{children:["\n",(0,c.jsxs)(n.p,{children:[(0,c.jsx)(n.strong,{children:"cancel"}),"(): ",(0,c.jsx)(n.code,{children:"void"})]}),"\n"]}),"\n",(0,c.jsx)(n.p,{children:"Signal cancellation on the token."}),"\n",(0,c.jsx)(n.h4,{id:"returns-1",children:"Returns"}),"\n",(0,c.jsx)(n.p,{children:(0,c.jsx)(n.code,{children:"void"})}),"\n",(0,c.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,c.jsx)(n.p,{children:(0,c.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L800",children:"packages/extension-api/src/extension-api.d.ts:800"})}),"\n",(0,c.jsx)(n.hr,{}),"\n",(0,c.jsx)(n.h3,{id:"dispose",children:"dispose()"}),"\n",(0,c.jsxs)(n.blockquote,{children:["\n",(0,c.jsxs)(n.p,{children:[(0,c.jsx)(n.strong,{children:"dispose"}),"(): ",(0,c.jsx)(n.code,{children:"void"})]}),"\n"]}),"\n",(0,c.jsx)(n.p,{children:"Dispose object and free resources."}),"\n",(0,c.jsx)(n.h4,{id:"returns-2",children:"Returns"}),"\n",(0,c.jsx)(n.p,{children:(0,c.jsx)(n.code,{children:"void"})}),"\n",(0,c.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,c.jsx)(n.p,{children:(0,c.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L805",children:"packages/extension-api/src/extension-api.d.ts:805"})})]})}function u(e={}){const{wrapper:n}={...(0,o.a)(),...e.components};return n?(0,c.jsx)(n,{...e,children:(0,c.jsx)(d,{...e})}):d(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>t,a:()=>r});var c=s(27378);const o={},i=c.createContext(o);function r(e){const n=c.useContext(i);return c.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function t(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:r(e.components),c.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[15554],{36729:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>l,contentTitle:()=>r,default:()=>u,frontMatter:()=>i,metadata:()=>t,toc:()=>a});var c=s(24246),o=s(71670);const i={},r="Class: CancellationTokenSource",t={id:"classes/CancellationTokenSource",title:"Class: CancellationTokenSource",description:"Constructors",source:"@site/api/classes/CancellationTokenSource.md",sourceDirName:"classes",slug:"/classes/CancellationTokenSource",permalink:"/api/classes/CancellationTokenSource",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Enumeration: QuickPickItemKind",permalink:"/api/enumerations/QuickPickItemKind"},next:{title:"Class: Disposable",permalink:"/api/classes/Disposable"}},l={},a=[{value:"Constructors",id:"constructors",level:2},{value:"new CancellationTokenSource()",id:"new-cancellationtokensource",level:3},{value:"Returns",id:"returns",level:4},{value:"Properties",id:"properties",level:2},{value:"token",id:"token",level:3},{value:"Source",id:"source",level:4},{value:"Methods",id:"methods",level:2},{value:"cancel()",id:"cancel",level:3},{value:"Returns",id:"returns-1",level:4},{value:"Source",id:"source-1",level:4},{value:"dispose()",id:"dispose",level:3},{value:"Returns",id:"returns-2",level:4},{value:"Source",id:"source-2",level:4}];function d(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,o.a)(),...e.components};return(0,c.jsxs)(c.Fragment,{children:[(0,c.jsx)(n.h1,{id:"class-cancellationtokensource",children:"Class: CancellationTokenSource"}),"\n",(0,c.jsx)(n.h2,{id:"constructors",children:"Constructors"}),"\n",(0,c.jsx)(n.h3,{id:"new-cancellationtokensource",children:"new CancellationTokenSource()"}),"\n",(0,c.jsxs)(n.blockquote,{children:["\n",(0,c.jsxs)(n.p,{children:[(0,c.jsx)(n.strong,{children:"new CancellationTokenSource"}),"(): ",(0,c.jsx)(n.a,{href:"/api/classes/CancellationTokenSource",children:(0,c.jsx)(n.code,{children:"CancellationTokenSource"})})]}),"\n"]}),"\n",(0,c.jsx)(n.h4,{id:"returns",children:"Returns"}),"\n",(0,c.jsx)(n.p,{children:(0,c.jsx)(n.a,{href:"/api/classes/CancellationTokenSource",children:(0,c.jsx)(n.code,{children:"CancellationTokenSource"})})}),"\n",(0,c.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,c.jsx)(n.h3,{id:"token",children:"token"}),"\n",(0,c.jsxs)(n.blockquote,{children:["\n",(0,c.jsxs)(n.p,{children:[(0,c.jsx)(n.strong,{children:"token"}),": ",(0,c.jsx)(n.a,{href:"/api/interfaces/CancellationToken",children:(0,c.jsx)(n.code,{children:"CancellationToken"})})]}),"\n"]}),"\n",(0,c.jsx)(n.p,{children:"The cancellation token of this source."}),"\n",(0,c.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,c.jsx)(n.p,{children:(0,c.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L795",children:"packages/extension-api/src/extension-api.d.ts:795"})}),"\n",(0,c.jsx)(n.h2,{id:"methods",children:"Methods"}),"\n",(0,c.jsx)(n.h3,{id:"cancel",children:"cancel()"}),"\n",(0,c.jsxs)(n.blockquote,{children:["\n",(0,c.jsxs)(n.p,{children:[(0,c.jsx)(n.strong,{children:"cancel"}),"(): ",(0,c.jsx)(n.code,{children:"void"})]}),"\n"]}),"\n",(0,c.jsx)(n.p,{children:"Signal cancellation on the token."}),"\n",(0,c.jsx)(n.h4,{id:"returns-1",children:"Returns"}),"\n",(0,c.jsx)(n.p,{children:(0,c.jsx)(n.code,{children:"void"})}),"\n",(0,c.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,c.jsx)(n.p,{children:(0,c.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L800",children:"packages/extension-api/src/extension-api.d.ts:800"})}),"\n",(0,c.jsx)(n.hr,{}),"\n",(0,c.jsx)(n.h3,{id:"dispose",children:"dispose()"}),"\n",(0,c.jsxs)(n.blockquote,{children:["\n",(0,c.jsxs)(n.p,{children:[(0,c.jsx)(n.strong,{children:"dispose"}),"(): ",(0,c.jsx)(n.code,{children:"void"})]}),"\n"]}),"\n",(0,c.jsx)(n.p,{children:"Dispose object and free resources."}),"\n",(0,c.jsx)(n.h4,{id:"returns-2",children:"Returns"}),"\n",(0,c.jsx)(n.p,{children:(0,c.jsx)(n.code,{children:"void"})}),"\n",(0,c.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,c.jsx)(n.p,{children:(0,c.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L805",children:"packages/extension-api/src/extension-api.d.ts:805"})})]})}function u(e={}){const{wrapper:n}={...(0,o.a)(),...e.components};return n?(0,c.jsx)(n,{...e,children:(0,c.jsx)(d,{...e})}):d(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>t,a:()=>r});var c=s(27378);const o={},i=c.createContext(o);function r(e){const n=c.useContext(i);return c.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function t(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:r(e.components),c.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/1ee92283.5647ff83.js b/assets/js/1ee92283.5ea9394d.js similarity index 90% rename from assets/js/1ee92283.5647ff83.js rename to assets/js/1ee92283.5ea9394d.js index 78d52800c03..32e67c5009e 100644 --- a/assets/js/1ee92283.5647ff83.js +++ b/assets/js/1ee92283.5ea9394d.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[65144],{83663:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>o,contentTitle:()=>d,default:()=>h,frontMatter:()=>c,metadata:()=>t,toc:()=>a});var r=s(24246),i=s(71670);const c={},d="Interface: Provider",t={id:"interfaces/Provider",title:"Interface: Provider",description:"Properties",source:"@site/api/interfaces/Provider.md",sourceDirName:"interfaces",slug:"/interfaces/Provider",permalink:"/api/interfaces/Provider",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: ProgressOptions",permalink:"/api/interfaces/ProgressOptions"},next:{title:"Interface: ProviderAutostart",permalink:"/api/interfaces/ProviderAutostart"}},o={},a=[{value:"Properties",id:"properties",level:2},{value:"detectionChecks",id:"detectionchecks",level:3},{value:"Source",id:"source",level:4},{value:"id",id:"id",level:3},{value:"Source",id:"source-1",level:4},{value:"images",id:"images",level:3},{value:"Source",id:"source-2",level:4},{value:"links",id:"links",level:3},{value:"Source",id:"source-3",level:4},{value:"name",id:"name",level:3},{value:"Source",id:"source-4",level:4},{value:"onDidUpdateDetectionChecks",id:"ondidupdatedetectionchecks",level:3},{value:"Source",id:"source-5",level:4},{value:"onDidUpdateStatus",id:"ondidupdatestatus",level:3},{value:"Source",id:"source-6",level:4},{value:"onDidUpdateVersion",id:"ondidupdateversion",level:3},{value:"Source",id:"source-7",level:4},{value:"status",id:"status",level:3},{value:"Source",id:"source-8",level:4},{value:"version",id:"version",level:3},{value:"Source",id:"source-9",level:4},{value:"warnings",id:"warnings",level:3},{value:"Source",id:"source-10",level:4},{value:"Methods",id:"methods",level:2},{value:"dispose()",id:"dispose",level:3},{value:"Returns",id:"returns",level:4},{value:"Source",id:"source-11",level:4},{value:"registerAutostart()",id:"registerautostart",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Source",id:"source-12",level:4},{value:"registerCleanup()",id:"registercleanup",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-2",level:4},{value:"Source",id:"source-13",level:4},{value:"registerContainerProviderConnection()",id:"registercontainerproviderconnection",level:3},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-3",level:4},{value:"Source",id:"source-14",level:4},{value:"registerInstallation()",id:"registerinstallation",level:3},{value:"Parameters",id:"parameters-3",level:4},{value:"Returns",id:"returns-4",level:4},{value:"Source",id:"source-15",level:4},{value:"registerKubernetesProviderConnection()",id:"registerkubernetesproviderconnection",level:3},{value:"Parameters",id:"parameters-4",level:4},{value:"Returns",id:"returns-5",level:4},{value:"Source",id:"source-16",level:4},{value:"registerLifecycle()",id:"registerlifecycle",level:3},{value:"Parameters",id:"parameters-5",level:4},{value:"Returns",id:"returns-6",level:4},{value:"Source",id:"source-17",level:4},{value:"registerUpdate()",id:"registerupdate",level:3},{value:"Parameters",id:"parameters-6",level:4},{value:"Returns",id:"returns-7",level:4},{value:"Source",id:"source-18",level:4},{value:"setContainerProviderConnectionFactory()",id:"setcontainerproviderconnectionfactory",level:3},{value:"Parameters",id:"parameters-7",level:4},{value:"Returns",id:"returns-8",level:4},{value:"Source",id:"source-19",level:4},{value:"setKubernetesProviderConnectionFactory()",id:"setkubernetesproviderconnectionfactory",level:3},{value:"Parameters",id:"parameters-8",level:4},{value:"Returns",id:"returns-9",level:4},{value:"Source",id:"source-20",level:4},{value:"updateDetectionChecks()",id:"updatedetectionchecks",level:3},{value:"Parameters",id:"parameters-9",level:4},{value:"Returns",id:"returns-10",level:4},{value:"Source",id:"source-21",level:4},{value:"updateStatus()",id:"updatestatus",level:3},{value:"Parameters",id:"parameters-10",level:4},{value:"Returns",id:"returns-11",level:4},{value:"Source",id:"source-22",level:4},{value:"updateVersion()",id:"updateversion",level:3},{value:"Parameters",id:"parameters-11",level:4},{value:"Returns",id:"returns-12",level:4},{value:"Source",id:"source-23",level:4},{value:"updateWarnings()",id:"updatewarnings",level:3},{value:"Parameters",id:"parameters-12",level:4},{value:"Returns",id:"returns-13",level:4},{value:"Source",id:"source-24",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,i.a)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.h1,{id:"interface-provider",children:"Interface: Provider"}),"\n",(0,r.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,r.jsx)(n.h3,{id:"detectionchecks",children:"detectionChecks"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"readonly"})})," ",(0,r.jsx)(n.strong,{children:"detectionChecks"}),": ",(0,r.jsx)(n.a,{href:"/api/interfaces/ProviderDetectionCheck",children:(0,r.jsx)(n.code,{children:"ProviderDetectionCheck"})}),"[]"]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L468",children:"packages/extension-api/src/extension-api.d.ts:468"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"id",children:"id"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"readonly"})})," ",(0,r.jsx)(n.strong,{children:"id"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L453",children:"packages/extension-api/src/extension-api.d.ts:453"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"images",children:"images"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"readonly"})})," ",(0,r.jsx)(n.strong,{children:"images"}),": ",(0,r.jsx)(n.a,{href:"/api/interfaces/ProviderImages",children:(0,r.jsx)(n.code,{children:"ProviderImages"})})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L463",children:"packages/extension-api/src/extension-api.d.ts:463"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"links",children:"links"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"readonly"})})," ",(0,r.jsx)(n.strong,{children:"links"}),": ",(0,r.jsx)(n.a,{href:"/api/interfaces/Link",children:(0,r.jsx)(n.code,{children:"Link"})}),"[]"]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L465",children:"packages/extension-api/src/extension-api.d.ts:465"})}),"\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:(0,r.jsx)(n.code,{children:"readonly"})})," ",(0,r.jsx)(n.strong,{children:"name"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"source-4",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L452",children:"packages/extension-api/src/extension-api.d.ts:452"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"ondidupdatedetectionchecks",children:"onDidUpdateDetectionChecks"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"onDidUpdateDetectionChecks"}),": ",(0,r.jsx)(n.a,{href:"/api/interfaces/Event",children:(0,r.jsx)(n.code,{children:"Event"})}),"< ",(0,r.jsx)(n.a,{href:"/api/interfaces/ProviderDetectionCheck",children:(0,r.jsx)(n.code,{children:"ProviderDetectionCheck"})}),"[] >"]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"source-5",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L479",children:"packages/extension-api/src/extension-api.d.ts:479"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"ondidupdatestatus",children:"onDidUpdateStatus"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"onDidUpdateStatus"}),": ",(0,r.jsx)(n.a,{href:"/api/interfaces/Event",children:(0,r.jsx)(n.code,{children:"Event"})}),"< ",(0,r.jsx)(n.a,{href:"/api/type-aliases/ProviderStatus",children:(0,r.jsx)(n.code,{children:"ProviderStatus"})})," >"]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"source-6",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L456",children:"packages/extension-api/src/extension-api.d.ts:456"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"ondidupdateversion",children:"onDidUpdateVersion"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"onDidUpdateVersion"}),": ",(0,r.jsx)(n.a,{href:"/api/interfaces/Event",children:(0,r.jsx)(n.code,{children:"Event"})}),"< ",(0,r.jsx)(n.code,{children:"string"})," >"]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"source-7",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L461",children:"packages/extension-api/src/extension-api.d.ts:461"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"status",children:"status"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"readonly"})})," ",(0,r.jsx)(n.strong,{children:"status"}),": ",(0,r.jsx)(n.a,{href:"/api/type-aliases/ProviderStatus",children:(0,r.jsx)(n.code,{children:"ProviderStatus"})})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"source-8",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L454",children:"packages/extension-api/src/extension-api.d.ts:454"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"version",children:"version"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"readonly"})})," ",(0,r.jsx)(n.strong,{children:"version"}),": ",(0,r.jsx)(n.code,{children:"undefined"})," | ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"source-9",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L459",children:"packages/extension-api/src/extension-api.d.ts:459"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"warnings",children:"warnings"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"readonly"})})," ",(0,r.jsx)(n.strong,{children:"warnings"}),": ",(0,r.jsx)(n.a,{href:"/api/interfaces/ProviderInformation",children:(0,r.jsx)(n.code,{children:"ProviderInformation"})}),"[]"]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"source-10",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/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:"dispose",children:"dispose()"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"dispose"}),"(): ",(0,r.jsx)(n.code,{children:"void"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"returns",children:"Returns"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.code,{children:"void"})}),"\n",(0,r.jsx)(n.h4,{id:"source-11",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L451",children:"packages/extension-api/src/extension-api.d.ts:451"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"registerautostart",children:"registerAutostart()"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"registerAutostart"}),"(",(0,r.jsx)(n.code,{children:"autostart"}),"): ",(0,r.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,r.jsx)(n.code,{children:"Disposable"})})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"parameters",children:"Parameters"}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"autostart"}),": ",(0,r.jsx)(n.a,{href:"/api/interfaces/ProviderAutostart",children:(0,r.jsx)(n.code,{children:"ProviderAutostart"})})]}),"\n",(0,r.jsx)(n.h4,{id:"returns-1",children:"Returns"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,r.jsx)(n.code,{children:"Disposable"})})}),"\n",(0,r.jsx)(n.h4,{id:"source-12",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L447",children:"packages/extension-api/src/extension-api.d.ts:447"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"registercleanup",children:"registerCleanup()"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"registerCleanup"}),"(",(0,r.jsx)(n.code,{children:"cleanup"}),"): ",(0,r.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,r.jsx)(n.code,{children:"Disposable"})})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"parameters-1",children:"Parameters"}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"cleanup"}),": ",(0,r.jsx)(n.a,{href:"/api/interfaces/ProviderCleanup",children:(0,r.jsx)(n.code,{children:"ProviderCleanup"})})]}),"\n",(0,r.jsx)(n.h4,{id:"returns-2",children:"Returns"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,r.jsx)(n.code,{children:"Disposable"})})}),"\n",(0,r.jsx)(n.h4,{id:"source-13",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L449",children:"packages/extension-api/src/extension-api.d.ts:449"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"registercontainerproviderconnection",children:"registerContainerProviderConnection()"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"registerContainerProviderConnection"}),"(",(0,r.jsx)(n.code,{children:"connection"}),"): ",(0,r.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,r.jsx)(n.code,{children:"Disposable"})})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"parameters-2",children:"Parameters"}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"connection"}),": ",(0,r.jsx)(n.a,{href:"/api/interfaces/ContainerProviderConnection",children:(0,r.jsx)(n.code,{children:"ContainerProviderConnection"})})]}),"\n",(0,r.jsx)(n.h4,{id:"returns-3",children:"Returns"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,r.jsx)(n.code,{children:"Disposable"})})}),"\n",(0,r.jsx)(n.h4,{id:"source-14",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L436",children:"packages/extension-api/src/extension-api.d.ts:436"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"registerinstallation",children:"registerInstallation()"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"registerInstallation"}),"(",(0,r.jsx)(n.code,{children:"installation"}),"): ",(0,r.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,r.jsx)(n.code,{children:"Disposable"})})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"parameters-3",children:"Parameters"}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"installation"}),": ",(0,r.jsx)(n.a,{href:"/api/interfaces/ProviderInstallation",children:(0,r.jsx)(n.code,{children:"ProviderInstallation"})})]}),"\n",(0,r.jsx)(n.h4,{id:"returns-4",children:"Returns"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,r.jsx)(n.code,{children:"Disposable"})})}),"\n",(0,r.jsx)(n.h4,{id:"source-15",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L441",children:"packages/extension-api/src/extension-api.d.ts:441"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"registerkubernetesproviderconnection",children:"registerKubernetesProviderConnection()"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"registerKubernetesProviderConnection"}),"(",(0,r.jsx)(n.code,{children:"connection"}),"): ",(0,r.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,r.jsx)(n.code,{children:"Disposable"})})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"parameters-4",children:"Parameters"}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"connection"}),": ",(0,r.jsx)(n.a,{href:"/api/interfaces/KubernetesProviderConnection",children:(0,r.jsx)(n.code,{children:"KubernetesProviderConnection"})})]}),"\n",(0,r.jsx)(n.h4,{id:"returns-5",children:"Returns"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,r.jsx)(n.code,{children:"Disposable"})})}),"\n",(0,r.jsx)(n.h4,{id:"source-16",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L437",children:"packages/extension-api/src/extension-api.d.ts:437"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"registerlifecycle",children:"registerLifecycle()"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"registerLifecycle"}),"(",(0,r.jsx)(n.code,{children:"lifecycle"}),"): ",(0,r.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,r.jsx)(n.code,{children:"Disposable"})})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"parameters-5",children:"Parameters"}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"lifecycle"}),": ",(0,r.jsx)(n.a,{href:"/api/interfaces/ProviderLifecycle",children:(0,r.jsx)(n.code,{children:"ProviderLifecycle"})})]}),"\n",(0,r.jsx)(n.h4,{id:"returns-6",children:"Returns"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,r.jsx)(n.code,{children:"Disposable"})})}),"\n",(0,r.jsx)(n.h4,{id:"source-17",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L438",children:"packages/extension-api/src/extension-api.d.ts:438"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"registerupdate",children:"registerUpdate()"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"registerUpdate"}),"(",(0,r.jsx)(n.code,{children:"update"}),"): ",(0,r.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,r.jsx)(n.code,{children:"Disposable"})})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"parameters-6",children:"Parameters"}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"update"}),": ",(0,r.jsx)(n.a,{href:"/api/interfaces/ProviderUpdate",children:(0,r.jsx)(n.code,{children:"ProviderUpdate"})})]}),"\n",(0,r.jsx)(n.h4,{id:"returns-7",children:"Returns"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,r.jsx)(n.code,{children:"Disposable"})})}),"\n",(0,r.jsx)(n.h4,{id:"source-18",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L444",children:"packages/extension-api/src/extension-api.d.ts:444"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"setcontainerproviderconnectionfactory",children:"setContainerProviderConnectionFactory()"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"setContainerProviderConnectionFactory"}),"(",(0,r.jsx)(n.code,{children:"containerProviderConnectionFactory"}),", ",(0,r.jsx)(n.code,{children:"connectionAuditor"}),"?): ",(0,r.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,r.jsx)(n.code,{children:"Disposable"})})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"parameters-7",children:"Parameters"}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"containerProviderConnectionFactory"}),": ",(0,r.jsx)(n.a,{href:"/api/interfaces/ContainerProviderConnectionFactory",children:(0,r.jsx)(n.code,{children:"ContainerProviderConnectionFactory"})})]}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"connectionAuditor?"}),": ",(0,r.jsx)(n.a,{href:"/api/interfaces/Auditor",children:(0,r.jsx)(n.code,{children:"Auditor"})})]}),"\n",(0,r.jsx)(n.h4,{id:"returns-8",children:"Returns"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,r.jsx)(n.code,{children:"Disposable"})})}),"\n",(0,r.jsx)(n.h4,{id:"source-19",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L427",children:"packages/extension-api/src/extension-api.d.ts:427"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"setkubernetesproviderconnectionfactory",children:"setKubernetesProviderConnectionFactory()"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"setKubernetesProviderConnectionFactory"}),"(",(0,r.jsx)(n.code,{children:"containerProviderConnectionFactory"}),", ",(0,r.jsx)(n.code,{children:"connectionAuditor"}),"?): ",(0,r.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,r.jsx)(n.code,{children:"Disposable"})})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"parameters-8",children:"Parameters"}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"containerProviderConnectionFactory"}),": ",(0,r.jsx)(n.a,{href:"/api/interfaces/KubernetesProviderConnectionFactory",children:(0,r.jsx)(n.code,{children:"KubernetesProviderConnectionFactory"})})]}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"connectionAuditor?"}),": ",(0,r.jsx)(n.a,{href:"/api/interfaces/Auditor",children:(0,r.jsx)(n.code,{children:"Auditor"})})]}),"\n",(0,r.jsx)(n.h4,{id:"returns-9",children:"Returns"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,r.jsx)(n.code,{children:"Disposable"})})}),"\n",(0,r.jsx)(n.h4,{id:"source-20",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L431",children:"packages/extension-api/src/extension-api.d.ts:431"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"updatedetectionchecks",children:"updateDetectionChecks()"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"updateDetectionChecks"}),"(",(0,r.jsx)(n.code,{children:"detectionChecks"}),"): ",(0,r.jsx)(n.code,{children:"void"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"parameters-9",children:"Parameters"}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"detectionChecks"}),": ",(0,r.jsx)(n.a,{href:"/api/interfaces/ProviderDetectionCheck",children:(0,r.jsx)(n.code,{children:"ProviderDetectionCheck"})}),"[]"]}),"\n",(0,r.jsx)(n.h4,{id:"returns-10",children:"Returns"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.code,{children:"void"})}),"\n",(0,r.jsx)(n.h4,{id:"source-21",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L472",children:"packages/extension-api/src/extension-api.d.ts:472"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"updatestatus",children:"updateStatus()"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"updateStatus"}),"(",(0,r.jsx)(n.code,{children:"status"}),"): ",(0,r.jsx)(n.code,{children:"void"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"parameters-10",children:"Parameters"}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"status"}),": ",(0,r.jsx)(n.a,{href:"/api/type-aliases/ProviderStatus",children:(0,r.jsx)(n.code,{children:"ProviderStatus"})})]}),"\n",(0,r.jsx)(n.h4,{id:"returns-11",children:"Returns"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.code,{children:"void"})}),"\n",(0,r.jsx)(n.h4,{id:"source-22",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L455",children:"packages/extension-api/src/extension-api.d.ts:455"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"updateversion",children:"updateVersion()"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"updateVersion"}),"(",(0,r.jsx)(n.code,{children:"version"}),"): ",(0,r.jsx)(n.code,{children:"void"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"parameters-11",children:"Parameters"}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"version"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n",(0,r.jsx)(n.h4,{id:"returns-12",children:"Returns"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.code,{children:"void"})}),"\n",(0,r.jsx)(n.h4,{id:"source-23",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L460",children:"packages/extension-api/src/extension-api.d.ts:460"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"updatewarnings",children:"updateWarnings()"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"updateWarnings"}),"(",(0,r.jsx)(n.code,{children:"warnings"}),"): ",(0,r.jsx)(n.code,{children:"void"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"parameters-12",children:"Parameters"}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"warnings"}),": ",(0,r.jsx)(n.a,{href:"/api/interfaces/ProviderInformation",children:(0,r.jsx)(n.code,{children:"ProviderInformation"})}),"[]"]}),"\n",(0,r.jsx)(n.h4,{id:"returns-13",children:"Returns"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.code,{children:"void"})}),"\n",(0,r.jsx)(n.h4,{id:"source-24",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L476",children:"packages/extension-api/src/extension-api.d.ts:476"})})]})}function h(e={}){const{wrapper:n}={...(0,i.a)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(l,{...e})}):l(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>t,a:()=>d});var r=s(27378);const i={},c=r.createContext(i);function d(e){const n=r.useContext(c);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function t(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:d(e.components),r.createElement(c.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[65144],{83663:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>o,contentTitle:()=>d,default:()=>h,frontMatter:()=>c,metadata:()=>t,toc:()=>a});var r=s(24246),i=s(71670);const c={},d="Interface: Provider",t={id:"interfaces/Provider",title:"Interface: Provider",description:"Properties",source:"@site/api/interfaces/Provider.md",sourceDirName:"interfaces",slug:"/interfaces/Provider",permalink:"/api/interfaces/Provider",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: ProgressOptions",permalink:"/api/interfaces/ProgressOptions"},next:{title:"Interface: ProviderAutostart",permalink:"/api/interfaces/ProviderAutostart"}},o={},a=[{value:"Properties",id:"properties",level:2},{value:"detectionChecks",id:"detectionchecks",level:3},{value:"Source",id:"source",level:4},{value:"id",id:"id",level:3},{value:"Source",id:"source-1",level:4},{value:"images",id:"images",level:3},{value:"Source",id:"source-2",level:4},{value:"links",id:"links",level:3},{value:"Source",id:"source-3",level:4},{value:"name",id:"name",level:3},{value:"Source",id:"source-4",level:4},{value:"onDidUpdateDetectionChecks",id:"ondidupdatedetectionchecks",level:3},{value:"Source",id:"source-5",level:4},{value:"onDidUpdateStatus",id:"ondidupdatestatus",level:3},{value:"Source",id:"source-6",level:4},{value:"onDidUpdateVersion",id:"ondidupdateversion",level:3},{value:"Source",id:"source-7",level:4},{value:"status",id:"status",level:3},{value:"Source",id:"source-8",level:4},{value:"version",id:"version",level:3},{value:"Source",id:"source-9",level:4},{value:"warnings",id:"warnings",level:3},{value:"Source",id:"source-10",level:4},{value:"Methods",id:"methods",level:2},{value:"dispose()",id:"dispose",level:3},{value:"Returns",id:"returns",level:4},{value:"Source",id:"source-11",level:4},{value:"registerAutostart()",id:"registerautostart",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Source",id:"source-12",level:4},{value:"registerCleanup()",id:"registercleanup",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-2",level:4},{value:"Source",id:"source-13",level:4},{value:"registerContainerProviderConnection()",id:"registercontainerproviderconnection",level:3},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-3",level:4},{value:"Source",id:"source-14",level:4},{value:"registerInstallation()",id:"registerinstallation",level:3},{value:"Parameters",id:"parameters-3",level:4},{value:"Returns",id:"returns-4",level:4},{value:"Source",id:"source-15",level:4},{value:"registerKubernetesProviderConnection()",id:"registerkubernetesproviderconnection",level:3},{value:"Parameters",id:"parameters-4",level:4},{value:"Returns",id:"returns-5",level:4},{value:"Source",id:"source-16",level:4},{value:"registerLifecycle()",id:"registerlifecycle",level:3},{value:"Parameters",id:"parameters-5",level:4},{value:"Returns",id:"returns-6",level:4},{value:"Source",id:"source-17",level:4},{value:"registerUpdate()",id:"registerupdate",level:3},{value:"Parameters",id:"parameters-6",level:4},{value:"Returns",id:"returns-7",level:4},{value:"Source",id:"source-18",level:4},{value:"setContainerProviderConnectionFactory()",id:"setcontainerproviderconnectionfactory",level:3},{value:"Parameters",id:"parameters-7",level:4},{value:"Returns",id:"returns-8",level:4},{value:"Source",id:"source-19",level:4},{value:"setKubernetesProviderConnectionFactory()",id:"setkubernetesproviderconnectionfactory",level:3},{value:"Parameters",id:"parameters-8",level:4},{value:"Returns",id:"returns-9",level:4},{value:"Source",id:"source-20",level:4},{value:"updateDetectionChecks()",id:"updatedetectionchecks",level:3},{value:"Parameters",id:"parameters-9",level:4},{value:"Returns",id:"returns-10",level:4},{value:"Source",id:"source-21",level:4},{value:"updateStatus()",id:"updatestatus",level:3},{value:"Parameters",id:"parameters-10",level:4},{value:"Returns",id:"returns-11",level:4},{value:"Source",id:"source-22",level:4},{value:"updateVersion()",id:"updateversion",level:3},{value:"Parameters",id:"parameters-11",level:4},{value:"Returns",id:"returns-12",level:4},{value:"Source",id:"source-23",level:4},{value:"updateWarnings()",id:"updatewarnings",level:3},{value:"Parameters",id:"parameters-12",level:4},{value:"Returns",id:"returns-13",level:4},{value:"Source",id:"source-24",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,i.a)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.h1,{id:"interface-provider",children:"Interface: Provider"}),"\n",(0,r.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,r.jsx)(n.h3,{id:"detectionchecks",children:"detectionChecks"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"readonly"})})," ",(0,r.jsx)(n.strong,{children:"detectionChecks"}),": ",(0,r.jsx)(n.a,{href:"/api/interfaces/ProviderDetectionCheck",children:(0,r.jsx)(n.code,{children:"ProviderDetectionCheck"})}),"[]"]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L468",children:"packages/extension-api/src/extension-api.d.ts:468"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"id",children:"id"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"readonly"})})," ",(0,r.jsx)(n.strong,{children:"id"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L453",children:"packages/extension-api/src/extension-api.d.ts:453"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"images",children:"images"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"readonly"})})," ",(0,r.jsx)(n.strong,{children:"images"}),": ",(0,r.jsx)(n.a,{href:"/api/interfaces/ProviderImages",children:(0,r.jsx)(n.code,{children:"ProviderImages"})})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L463",children:"packages/extension-api/src/extension-api.d.ts:463"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"links",children:"links"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"readonly"})})," ",(0,r.jsx)(n.strong,{children:"links"}),": ",(0,r.jsx)(n.a,{href:"/api/interfaces/Link",children:(0,r.jsx)(n.code,{children:"Link"})}),"[]"]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L465",children:"packages/extension-api/src/extension-api.d.ts:465"})}),"\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:(0,r.jsx)(n.code,{children:"readonly"})})," ",(0,r.jsx)(n.strong,{children:"name"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"source-4",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L452",children:"packages/extension-api/src/extension-api.d.ts:452"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"ondidupdatedetectionchecks",children:"onDidUpdateDetectionChecks"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"onDidUpdateDetectionChecks"}),": ",(0,r.jsx)(n.a,{href:"/api/interfaces/Event",children:(0,r.jsx)(n.code,{children:"Event"})}),"< ",(0,r.jsx)(n.a,{href:"/api/interfaces/ProviderDetectionCheck",children:(0,r.jsx)(n.code,{children:"ProviderDetectionCheck"})}),"[] >"]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"source-5",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L479",children:"packages/extension-api/src/extension-api.d.ts:479"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"ondidupdatestatus",children:"onDidUpdateStatus"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"onDidUpdateStatus"}),": ",(0,r.jsx)(n.a,{href:"/api/interfaces/Event",children:(0,r.jsx)(n.code,{children:"Event"})}),"< ",(0,r.jsx)(n.a,{href:"/api/type-aliases/ProviderStatus",children:(0,r.jsx)(n.code,{children:"ProviderStatus"})})," >"]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"source-6",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L456",children:"packages/extension-api/src/extension-api.d.ts:456"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"ondidupdateversion",children:"onDidUpdateVersion"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"onDidUpdateVersion"}),": ",(0,r.jsx)(n.a,{href:"/api/interfaces/Event",children:(0,r.jsx)(n.code,{children:"Event"})}),"< ",(0,r.jsx)(n.code,{children:"string"})," >"]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"source-7",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L461",children:"packages/extension-api/src/extension-api.d.ts:461"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"status",children:"status"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"readonly"})})," ",(0,r.jsx)(n.strong,{children:"status"}),": ",(0,r.jsx)(n.a,{href:"/api/type-aliases/ProviderStatus",children:(0,r.jsx)(n.code,{children:"ProviderStatus"})})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"source-8",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L454",children:"packages/extension-api/src/extension-api.d.ts:454"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"version",children:"version"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"readonly"})})," ",(0,r.jsx)(n.strong,{children:"version"}),": ",(0,r.jsx)(n.code,{children:"undefined"})," | ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"source-9",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L459",children:"packages/extension-api/src/extension-api.d.ts:459"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"warnings",children:"warnings"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"readonly"})})," ",(0,r.jsx)(n.strong,{children:"warnings"}),": ",(0,r.jsx)(n.a,{href:"/api/interfaces/ProviderInformation",children:(0,r.jsx)(n.code,{children:"ProviderInformation"})}),"[]"]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"source-10",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/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:"dispose",children:"dispose()"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"dispose"}),"(): ",(0,r.jsx)(n.code,{children:"void"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"returns",children:"Returns"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.code,{children:"void"})}),"\n",(0,r.jsx)(n.h4,{id:"source-11",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L451",children:"packages/extension-api/src/extension-api.d.ts:451"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"registerautostart",children:"registerAutostart()"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"registerAutostart"}),"(",(0,r.jsx)(n.code,{children:"autostart"}),"): ",(0,r.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,r.jsx)(n.code,{children:"Disposable"})})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"parameters",children:"Parameters"}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"autostart"}),": ",(0,r.jsx)(n.a,{href:"/api/interfaces/ProviderAutostart",children:(0,r.jsx)(n.code,{children:"ProviderAutostart"})})]}),"\n",(0,r.jsx)(n.h4,{id:"returns-1",children:"Returns"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,r.jsx)(n.code,{children:"Disposable"})})}),"\n",(0,r.jsx)(n.h4,{id:"source-12",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L447",children:"packages/extension-api/src/extension-api.d.ts:447"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"registercleanup",children:"registerCleanup()"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"registerCleanup"}),"(",(0,r.jsx)(n.code,{children:"cleanup"}),"): ",(0,r.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,r.jsx)(n.code,{children:"Disposable"})})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"parameters-1",children:"Parameters"}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"cleanup"}),": ",(0,r.jsx)(n.a,{href:"/api/interfaces/ProviderCleanup",children:(0,r.jsx)(n.code,{children:"ProviderCleanup"})})]}),"\n",(0,r.jsx)(n.h4,{id:"returns-2",children:"Returns"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,r.jsx)(n.code,{children:"Disposable"})})}),"\n",(0,r.jsx)(n.h4,{id:"source-13",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L449",children:"packages/extension-api/src/extension-api.d.ts:449"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"registercontainerproviderconnection",children:"registerContainerProviderConnection()"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"registerContainerProviderConnection"}),"(",(0,r.jsx)(n.code,{children:"connection"}),"): ",(0,r.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,r.jsx)(n.code,{children:"Disposable"})})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"parameters-2",children:"Parameters"}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"connection"}),": ",(0,r.jsx)(n.a,{href:"/api/interfaces/ContainerProviderConnection",children:(0,r.jsx)(n.code,{children:"ContainerProviderConnection"})})]}),"\n",(0,r.jsx)(n.h4,{id:"returns-3",children:"Returns"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,r.jsx)(n.code,{children:"Disposable"})})}),"\n",(0,r.jsx)(n.h4,{id:"source-14",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L436",children:"packages/extension-api/src/extension-api.d.ts:436"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"registerinstallation",children:"registerInstallation()"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"registerInstallation"}),"(",(0,r.jsx)(n.code,{children:"installation"}),"): ",(0,r.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,r.jsx)(n.code,{children:"Disposable"})})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"parameters-3",children:"Parameters"}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"installation"}),": ",(0,r.jsx)(n.a,{href:"/api/interfaces/ProviderInstallation",children:(0,r.jsx)(n.code,{children:"ProviderInstallation"})})]}),"\n",(0,r.jsx)(n.h4,{id:"returns-4",children:"Returns"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,r.jsx)(n.code,{children:"Disposable"})})}),"\n",(0,r.jsx)(n.h4,{id:"source-15",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L441",children:"packages/extension-api/src/extension-api.d.ts:441"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"registerkubernetesproviderconnection",children:"registerKubernetesProviderConnection()"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"registerKubernetesProviderConnection"}),"(",(0,r.jsx)(n.code,{children:"connection"}),"): ",(0,r.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,r.jsx)(n.code,{children:"Disposable"})})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"parameters-4",children:"Parameters"}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"connection"}),": ",(0,r.jsx)(n.a,{href:"/api/interfaces/KubernetesProviderConnection",children:(0,r.jsx)(n.code,{children:"KubernetesProviderConnection"})})]}),"\n",(0,r.jsx)(n.h4,{id:"returns-5",children:"Returns"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,r.jsx)(n.code,{children:"Disposable"})})}),"\n",(0,r.jsx)(n.h4,{id:"source-16",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L437",children:"packages/extension-api/src/extension-api.d.ts:437"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"registerlifecycle",children:"registerLifecycle()"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"registerLifecycle"}),"(",(0,r.jsx)(n.code,{children:"lifecycle"}),"): ",(0,r.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,r.jsx)(n.code,{children:"Disposable"})})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"parameters-5",children:"Parameters"}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"lifecycle"}),": ",(0,r.jsx)(n.a,{href:"/api/interfaces/ProviderLifecycle",children:(0,r.jsx)(n.code,{children:"ProviderLifecycle"})})]}),"\n",(0,r.jsx)(n.h4,{id:"returns-6",children:"Returns"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,r.jsx)(n.code,{children:"Disposable"})})}),"\n",(0,r.jsx)(n.h4,{id:"source-17",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L438",children:"packages/extension-api/src/extension-api.d.ts:438"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"registerupdate",children:"registerUpdate()"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"registerUpdate"}),"(",(0,r.jsx)(n.code,{children:"update"}),"): ",(0,r.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,r.jsx)(n.code,{children:"Disposable"})})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"parameters-6",children:"Parameters"}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"update"}),": ",(0,r.jsx)(n.a,{href:"/api/interfaces/ProviderUpdate",children:(0,r.jsx)(n.code,{children:"ProviderUpdate"})})]}),"\n",(0,r.jsx)(n.h4,{id:"returns-7",children:"Returns"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,r.jsx)(n.code,{children:"Disposable"})})}),"\n",(0,r.jsx)(n.h4,{id:"source-18",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L444",children:"packages/extension-api/src/extension-api.d.ts:444"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"setcontainerproviderconnectionfactory",children:"setContainerProviderConnectionFactory()"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"setContainerProviderConnectionFactory"}),"(",(0,r.jsx)(n.code,{children:"containerProviderConnectionFactory"}),", ",(0,r.jsx)(n.code,{children:"connectionAuditor"}),"?): ",(0,r.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,r.jsx)(n.code,{children:"Disposable"})})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"parameters-7",children:"Parameters"}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"containerProviderConnectionFactory"}),": ",(0,r.jsx)(n.a,{href:"/api/interfaces/ContainerProviderConnectionFactory",children:(0,r.jsx)(n.code,{children:"ContainerProviderConnectionFactory"})})]}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"connectionAuditor?"}),": ",(0,r.jsx)(n.a,{href:"/api/interfaces/Auditor",children:(0,r.jsx)(n.code,{children:"Auditor"})})]}),"\n",(0,r.jsx)(n.h4,{id:"returns-8",children:"Returns"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,r.jsx)(n.code,{children:"Disposable"})})}),"\n",(0,r.jsx)(n.h4,{id:"source-19",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L427",children:"packages/extension-api/src/extension-api.d.ts:427"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"setkubernetesproviderconnectionfactory",children:"setKubernetesProviderConnectionFactory()"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"setKubernetesProviderConnectionFactory"}),"(",(0,r.jsx)(n.code,{children:"containerProviderConnectionFactory"}),", ",(0,r.jsx)(n.code,{children:"connectionAuditor"}),"?): ",(0,r.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,r.jsx)(n.code,{children:"Disposable"})})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"parameters-8",children:"Parameters"}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"containerProviderConnectionFactory"}),": ",(0,r.jsx)(n.a,{href:"/api/interfaces/KubernetesProviderConnectionFactory",children:(0,r.jsx)(n.code,{children:"KubernetesProviderConnectionFactory"})})]}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"connectionAuditor?"}),": ",(0,r.jsx)(n.a,{href:"/api/interfaces/Auditor",children:(0,r.jsx)(n.code,{children:"Auditor"})})]}),"\n",(0,r.jsx)(n.h4,{id:"returns-9",children:"Returns"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,r.jsx)(n.code,{children:"Disposable"})})}),"\n",(0,r.jsx)(n.h4,{id:"source-20",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L431",children:"packages/extension-api/src/extension-api.d.ts:431"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"updatedetectionchecks",children:"updateDetectionChecks()"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"updateDetectionChecks"}),"(",(0,r.jsx)(n.code,{children:"detectionChecks"}),"): ",(0,r.jsx)(n.code,{children:"void"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"parameters-9",children:"Parameters"}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"detectionChecks"}),": ",(0,r.jsx)(n.a,{href:"/api/interfaces/ProviderDetectionCheck",children:(0,r.jsx)(n.code,{children:"ProviderDetectionCheck"})}),"[]"]}),"\n",(0,r.jsx)(n.h4,{id:"returns-10",children:"Returns"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.code,{children:"void"})}),"\n",(0,r.jsx)(n.h4,{id:"source-21",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L472",children:"packages/extension-api/src/extension-api.d.ts:472"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"updatestatus",children:"updateStatus()"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"updateStatus"}),"(",(0,r.jsx)(n.code,{children:"status"}),"): ",(0,r.jsx)(n.code,{children:"void"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"parameters-10",children:"Parameters"}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"status"}),": ",(0,r.jsx)(n.a,{href:"/api/type-aliases/ProviderStatus",children:(0,r.jsx)(n.code,{children:"ProviderStatus"})})]}),"\n",(0,r.jsx)(n.h4,{id:"returns-11",children:"Returns"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.code,{children:"void"})}),"\n",(0,r.jsx)(n.h4,{id:"source-22",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L455",children:"packages/extension-api/src/extension-api.d.ts:455"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"updateversion",children:"updateVersion()"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"updateVersion"}),"(",(0,r.jsx)(n.code,{children:"version"}),"): ",(0,r.jsx)(n.code,{children:"void"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"parameters-11",children:"Parameters"}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"version"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n",(0,r.jsx)(n.h4,{id:"returns-12",children:"Returns"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.code,{children:"void"})}),"\n",(0,r.jsx)(n.h4,{id:"source-23",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L460",children:"packages/extension-api/src/extension-api.d.ts:460"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"updatewarnings",children:"updateWarnings()"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"updateWarnings"}),"(",(0,r.jsx)(n.code,{children:"warnings"}),"): ",(0,r.jsx)(n.code,{children:"void"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"parameters-12",children:"Parameters"}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"warnings"}),": ",(0,r.jsx)(n.a,{href:"/api/interfaces/ProviderInformation",children:(0,r.jsx)(n.code,{children:"ProviderInformation"})}),"[]"]}),"\n",(0,r.jsx)(n.h4,{id:"returns-13",children:"Returns"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.code,{children:"void"})}),"\n",(0,r.jsx)(n.h4,{id:"source-24",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L476",children:"packages/extension-api/src/extension-api.d.ts:476"})})]})}function h(e={}){const{wrapper:n}={...(0,i.a)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(l,{...e})}):l(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>t,a:()=>d});var r=s(27378);const i={},c=r.createContext(i);function d(e){const n=r.useContext(c);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function t(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:d(e.components),r.createElement(c.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/1fbe0675.423a5b51.js b/assets/js/1fbe0675.ccd83d73.js similarity index 84% rename from assets/js/1fbe0675.423a5b51.js rename to assets/js/1fbe0675.ccd83d73.js index c1e6f56f0de..cc138d9a29f 100644 --- a/assets/js/1fbe0675.423a5b51.js +++ b/assets/js/1fbe0675.ccd83d73.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[39613],{32927:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>o,contentTitle:()=>a,default:()=>d,frontMatter:()=>r,metadata:()=>i,toc:()=>l});var s=n(24246),c=n(71670);const r={},a="Function: createFileSystemWatcher()",i={id:"namespaces/fs/functions/createFileSystemWatcher",title:"Function: createFileSystemWatcher()",description:"createFileSystemWatcher(path): FileSystemWatcher",source:"@site/api/namespaces/fs/functions/createFileSystemWatcher.md",sourceDirName:"namespaces/fs/functions",slug:"/namespaces/fs/functions/createFileSystemWatcher",permalink:"/api/namespaces/fs/functions/createFileSystemWatcher",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Namespace: fs",permalink:"/api/namespaces/fs/"},next:{title:"Namespace: imageChecker",permalink:"/api/namespaces/imageChecker/"}},o={},l=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function h(e){const t={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,c.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(t.h1,{id:"function-createfilesystemwatcher",children:"Function: createFileSystemWatcher()"}),"\n",(0,s.jsxs)(t.blockquote,{children:["\n",(0,s.jsxs)(t.p,{children:[(0,s.jsx)(t.strong,{children:"createFileSystemWatcher"}),"(",(0,s.jsx)(t.code,{children:"path"}),"): ",(0,s.jsx)(t.a,{href:"/api/interfaces/FileSystemWatcher",children:(0,s.jsx)(t.code,{children:"FileSystemWatcher"})})]}),"\n"]}),"\n",(0,s.jsx)(t.h2,{id:"parameters",children:"Parameters"}),"\n",(0,s.jsxs)(t.p,{children:["\u2022 ",(0,s.jsx)(t.strong,{children:"path"}),": ",(0,s.jsx)(t.code,{children:"string"})]}),"\n",(0,s.jsx)(t.h2,{id:"returns",children:"Returns"}),"\n",(0,s.jsx)(t.p,{children:(0,s.jsx)(t.a,{href:"/api/interfaces/FileSystemWatcher",children:(0,s.jsx)(t.code,{children:"FileSystemWatcher"})})}),"\n",(0,s.jsx)(t.h2,{id:"source",children:"Source"}),"\n",(0,s.jsx)(t.p,{children:(0,s.jsx)(t.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L1377",children:"packages/extension-api/src/extension-api.d.ts:1377"})})]})}function d(e={}){const{wrapper:t}={...(0,c.a)(),...e.components};return t?(0,s.jsx)(t,{...e,children:(0,s.jsx)(h,{...e})}):h(e)}},71670:(e,t,n)=>{n.d(t,{Z:()=>i,a:()=>a});var s=n(27378);const c={},r=s.createContext(c);function a(e){const t=s.useContext(r);return s.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function i(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(c):e.components||c:a(e.components),s.createElement(r.Provider,{value:t},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[39613],{32927:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>o,contentTitle:()=>a,default:()=>h,frontMatter:()=>r,metadata:()=>i,toc:()=>l});var s=n(24246),c=n(71670);const r={},a="Function: createFileSystemWatcher()",i={id:"namespaces/fs/functions/createFileSystemWatcher",title:"Function: createFileSystemWatcher()",description:"createFileSystemWatcher(path): FileSystemWatcher",source:"@site/api/namespaces/fs/functions/createFileSystemWatcher.md",sourceDirName:"namespaces/fs/functions",slug:"/namespaces/fs/functions/createFileSystemWatcher",permalink:"/api/namespaces/fs/functions/createFileSystemWatcher",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Namespace: fs",permalink:"/api/namespaces/fs/"},next:{title:"Namespace: imageChecker",permalink:"/api/namespaces/imageChecker/"}},o={},l=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function d(e){const t={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,c.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(t.h1,{id:"function-createfilesystemwatcher",children:"Function: createFileSystemWatcher()"}),"\n",(0,s.jsxs)(t.blockquote,{children:["\n",(0,s.jsxs)(t.p,{children:[(0,s.jsx)(t.strong,{children:"createFileSystemWatcher"}),"(",(0,s.jsx)(t.code,{children:"path"}),"): ",(0,s.jsx)(t.a,{href:"/api/interfaces/FileSystemWatcher",children:(0,s.jsx)(t.code,{children:"FileSystemWatcher"})})]}),"\n"]}),"\n",(0,s.jsx)(t.h2,{id:"parameters",children:"Parameters"}),"\n",(0,s.jsxs)(t.p,{children:["\u2022 ",(0,s.jsx)(t.strong,{children:"path"}),": ",(0,s.jsx)(t.code,{children:"string"})]}),"\n",(0,s.jsx)(t.h2,{id:"returns",children:"Returns"}),"\n",(0,s.jsx)(t.p,{children:(0,s.jsx)(t.a,{href:"/api/interfaces/FileSystemWatcher",children:(0,s.jsx)(t.code,{children:"FileSystemWatcher"})})}),"\n",(0,s.jsx)(t.h2,{id:"source",children:"Source"}),"\n",(0,s.jsx)(t.p,{children:(0,s.jsx)(t.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L1377",children:"packages/extension-api/src/extension-api.d.ts:1377"})})]})}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.d12148e2.js b/assets/js/1fc83a28.8bbe08a8.js similarity index 93% rename from assets/js/1fc83a28.d12148e2.js rename to assets/js/1fc83a28.8bbe08a8.js index f31362c90dc..cb0ddfc5a08 100644 --- a/assets/js/1fc83a28.d12148e2.js +++ b/assets/js/1fc83a28.8bbe08a8.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[70633],{54484:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>a,contentTitle:()=>o,default:()=>l,frontMatter:()=>c,metadata:()=>r,toc:()=>d});var i=s(24246),t=s(71670);const c={},o="Interface: AuthenticationSession",r={id:"interfaces/AuthenticationSession",title:"Interface: AuthenticationSession",description:"Represents a session of a currently logged in user.",source:"@site/api/interfaces/AuthenticationSession.md",sourceDirName:"interfaces",slug:"/interfaces/AuthenticationSession",permalink:"/api/interfaces/AuthenticationSession",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: AuthenticationProviderOptions",permalink:"/api/interfaces/AuthenticationProviderOptions"},next:{title:"Interface: AuthenticationSessionAccountInformation",permalink:"/api/interfaces/AuthenticationSessionAccountInformation"}},a={},d=[{value:"Properties",id:"properties",level:2},{value:"accessToken",id:"accesstoken",level:3},{value:"Source",id:"source",level:4},{value:"account",id:"account",level:3},{value:"Source",id:"source-1",level:4},{value:"id",id:"id",level:3},{value:"Source",id:"source-2",level:4},{value:"scopes",id:"scopes",level:3},{value:"Source",id:"source-3",level:4}];function h(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,t.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"interface-authenticationsession",children:"Interface: AuthenticationSession"}),"\n",(0,i.jsx)(n.p,{children:"Represents a session of a currently logged in user."}),"\n",(0,i.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(n.h3,{id:"accesstoken",children:"accessToken"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"readonly"})})," ",(0,i.jsx)(n.strong,{children:"accessToken"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"The access token."}),"\n",(0,i.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L3401",children:"packages/extension-api/src/extension-api.d.ts:3401"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"account",children:"account"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"readonly"})})," ",(0,i.jsx)(n.strong,{children:"account"}),": ",(0,i.jsx)(n.a,{href:"/api/interfaces/AuthenticationSessionAccountInformation",children:(0,i.jsx)(n.code,{children:"AuthenticationSessionAccountInformation"})})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"The account associated with the session."}),"\n",(0,i.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L3406",children:"packages/extension-api/src/extension-api.d.ts:3406"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"id",children:"id"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"readonly"})})," ",(0,i.jsx)(n.strong,{children:"id"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"The identifier of the authentication session."}),"\n",(0,i.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L3396",children:"packages/extension-api/src/extension-api.d.ts:3396"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"scopes",children:"scopes"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"readonly"})})," ",(0,i.jsx)(n.strong,{children:"scopes"}),": readonly ",(0,i.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["The permissions granted by the session's access token. Available scopes\nare defined by the ",(0,i.jsx)(n.a,{href:"#AuthenticationProvider",children:"AuthenticationProvider"}),"."]}),"\n",(0,i.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L3412",children:"packages/extension-api/src/extension-api.d.ts:3412"})})]})}function l(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(h,{...e})}):h(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>r,a:()=>o});var i=s(27378);const t={},c=i.createContext(t);function o(e){const n=i.useContext(c);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function r(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:o(e.components),i.createElement(c.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[70633],{54484:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>a,contentTitle:()=>o,default:()=>l,frontMatter:()=>c,metadata:()=>r,toc:()=>d});var i=s(24246),t=s(71670);const c={},o="Interface: AuthenticationSession",r={id:"interfaces/AuthenticationSession",title:"Interface: AuthenticationSession",description:"Represents a session of a currently logged in user.",source:"@site/api/interfaces/AuthenticationSession.md",sourceDirName:"interfaces",slug:"/interfaces/AuthenticationSession",permalink:"/api/interfaces/AuthenticationSession",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: AuthenticationProviderOptions",permalink:"/api/interfaces/AuthenticationProviderOptions"},next:{title:"Interface: AuthenticationSessionAccountInformation",permalink:"/api/interfaces/AuthenticationSessionAccountInformation"}},a={},d=[{value:"Properties",id:"properties",level:2},{value:"accessToken",id:"accesstoken",level:3},{value:"Source",id:"source",level:4},{value:"account",id:"account",level:3},{value:"Source",id:"source-1",level:4},{value:"id",id:"id",level:3},{value:"Source",id:"source-2",level:4},{value:"scopes",id:"scopes",level:3},{value:"Source",id:"source-3",level:4}];function h(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,t.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"interface-authenticationsession",children:"Interface: AuthenticationSession"}),"\n",(0,i.jsx)(n.p,{children:"Represents a session of a currently logged in user."}),"\n",(0,i.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(n.h3,{id:"accesstoken",children:"accessToken"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"readonly"})})," ",(0,i.jsx)(n.strong,{children:"accessToken"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"The access token."}),"\n",(0,i.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L3401",children:"packages/extension-api/src/extension-api.d.ts:3401"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"account",children:"account"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"readonly"})})," ",(0,i.jsx)(n.strong,{children:"account"}),": ",(0,i.jsx)(n.a,{href:"/api/interfaces/AuthenticationSessionAccountInformation",children:(0,i.jsx)(n.code,{children:"AuthenticationSessionAccountInformation"})})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"The account associated with the session."}),"\n",(0,i.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L3406",children:"packages/extension-api/src/extension-api.d.ts:3406"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"id",children:"id"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"readonly"})})," ",(0,i.jsx)(n.strong,{children:"id"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"The identifier of the authentication session."}),"\n",(0,i.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L3396",children:"packages/extension-api/src/extension-api.d.ts:3396"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"scopes",children:"scopes"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"readonly"})})," ",(0,i.jsx)(n.strong,{children:"scopes"}),": readonly ",(0,i.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["The permissions granted by the session's access token. Available scopes\nare defined by the ",(0,i.jsx)(n.a,{href:"#AuthenticationProvider",children:"AuthenticationProvider"}),"."]}),"\n",(0,i.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L3412",children:"packages/extension-api/src/extension-api.d.ts:3412"})})]})}function l(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(h,{...e})}):h(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>r,a:()=>o});var i=s(27378);const t={},c=i.createContext(t);function o(e){const n=i.useContext(c);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function r(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:o(e.components),i.createElement(c.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/22e2140b.e38943cf.js b/assets/js/22e2140b.be32d1c9.js similarity index 98% rename from assets/js/22e2140b.e38943cf.js rename to assets/js/22e2140b.be32d1c9.js index a27ddc28dd1..c3693e1227d 100644 --- a/assets/js/22e2140b.e38943cf.js +++ b/assets/js/22e2140b.be32d1c9.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[24260],{9897:(e,r,n)=>{n.r(r),n.d(r,{assets:()=>c,contentTitle:()=>a,default:()=>p,frontMatter:()=>i,metadata:()=>o,toc:()=>d});var t=n(24246),s=n(71670);const i={},a="Type alias: ProviderResult",o={id:"type-aliases/ProviderResult",title:"Type alias: ProviderResult\\",description:"ProviderResult\\: T \\| undefined \\| Promise\\",source:"@site/api/type-aliases/ProviderResult.md",sourceDirName:"type-aliases",slug:"/type-aliases/ProviderResult",permalink:"/api/type-aliases/ProviderResult",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Type alias: ProviderLinks",permalink:"/api/type-aliases/ProviderLinks"},next:{title:"Type alias: ProviderStatus",permalink:"/api/type-aliases/ProviderStatus"}},c={},d=[{value:"Type parameters",id:"type-parameters",level:2},{value:"Source",id:"source",level:2}];function l(e){const r={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",pre:"pre",strong:"strong",...(0,s.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(r.h1,{id:"type-alias-providerresultt",children:"Type alias: ProviderResult"}),"\n",(0,t.jsxs)(r.blockquote,{children:["\n",(0,t.jsxs)(r.p,{children:[(0,t.jsx)(r.strong,{children:"ProviderResult"}),"<",(0,t.jsx)(r.code,{children:"T"}),">: ",(0,t.jsx)(r.code,{children:"T"})," | ",(0,t.jsx)(r.code,{children:"undefined"})," | ",(0,t.jsx)(r.code,{children:"Promise"}),"< ",(0,t.jsx)(r.code,{children:"T"})," | ",(0,t.jsx)(r.code,{children:"undefined"})," >"]}),"\n"]}),"\n",(0,t.jsxs)(r.p,{children:["A provider result represents the values a provider, like the ",(0,t.jsx)(r.a,{href:"/api/interfaces/ImageCheckerProvider",children:(0,t.jsx)(r.code,{children:"ImageCheckerProvider"})}),",\nmay return. For once this is the actual result type ",(0,t.jsx)(r.code,{children:"T"}),", like ",(0,t.jsx)(r.code,{children:"ImageChecks"}),", or a Promise that resolves\nto that type ",(0,t.jsx)(r.code,{children:"T"}),". In addition, ",(0,t.jsx)(r.code,{children:"null"})," and ",(0,t.jsx)(r.code,{children:"undefined"})," can be returned - either directly or from a\nPromise."]}),"\n",(0,t.jsxs)(r.p,{children:["The snippets below are all valid implementations of the ",(0,t.jsx)(r.a,{href:"/api/interfaces/ImageCheckerProvider",children:(0,t.jsx)(r.code,{children:"ImageCheckerProvider"})}),":"]}),"\n",(0,t.jsx)(r.pre,{children:(0,t.jsx)(r.code,{className:"language-ts",children:"let a: ImageCheckerProvider = {\n check(image: ImageInfo, token?: CancellationToken): ProviderResult {\n return new ImageChecks();\n }\n\nlet b: ImageCheckerProvider = {\n async check(image: ImageInfo, token?: CancellationToken): ProviderResult {\n\t\treturn new ImageChecks();\n\t}\n}\n\nlet c: ImageCheckerProvider = {\n check(image: ImageInfo, token?: CancellationToken): ProviderResult {\n\t\treturn; // undefined\n\t}\n}\n"})}),"\n",(0,t.jsx)(r.h2,{id:"type-parameters",children:"Type parameters"}),"\n",(0,t.jsxs)(r.p,{children:["\u2022 ",(0,t.jsx)(r.strong,{children:"T"})]}),"\n",(0,t.jsx)(r.h2,{id:"source",children:"Source"}),"\n",(0,t.jsx)(r.p,{children:(0,t.jsx)(r.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L181",children:"packages/extension-api/src/extension-api.d.ts:181"})})]})}function p(e={}){const{wrapper:r}={...(0,s.a)(),...e.components};return r?(0,t.jsx)(r,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},71670:(e,r,n)=>{n.d(r,{Z:()=>o,a:()=>a});var t=n(27378);const s={},i=t.createContext(s);function a(e){const r=t.useContext(i);return t.useMemo((function(){return"function"==typeof e?e(r):{...r,...e}}),[r,e])}function o(e){let r;return r=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:a(e.components),t.createElement(i.Provider,{value:r},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[24260],{9897:(e,r,n)=>{n.r(r),n.d(r,{assets:()=>c,contentTitle:()=>a,default:()=>p,frontMatter:()=>i,metadata:()=>o,toc:()=>d});var t=n(24246),s=n(71670);const i={},a="Type alias: ProviderResult",o={id:"type-aliases/ProviderResult",title:"Type alias: ProviderResult\\",description:"ProviderResult\\: T \\| undefined \\| Promise\\",source:"@site/api/type-aliases/ProviderResult.md",sourceDirName:"type-aliases",slug:"/type-aliases/ProviderResult",permalink:"/api/type-aliases/ProviderResult",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Type alias: ProviderLinks",permalink:"/api/type-aliases/ProviderLinks"},next:{title:"Type alias: ProviderStatus",permalink:"/api/type-aliases/ProviderStatus"}},c={},d=[{value:"Type parameters",id:"type-parameters",level:2},{value:"Source",id:"source",level:2}];function l(e){const r={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",pre:"pre",strong:"strong",...(0,s.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(r.h1,{id:"type-alias-providerresultt",children:"Type alias: ProviderResult"}),"\n",(0,t.jsxs)(r.blockquote,{children:["\n",(0,t.jsxs)(r.p,{children:[(0,t.jsx)(r.strong,{children:"ProviderResult"}),"<",(0,t.jsx)(r.code,{children:"T"}),">: ",(0,t.jsx)(r.code,{children:"T"})," | ",(0,t.jsx)(r.code,{children:"undefined"})," | ",(0,t.jsx)(r.code,{children:"Promise"}),"< ",(0,t.jsx)(r.code,{children:"T"})," | ",(0,t.jsx)(r.code,{children:"undefined"})," >"]}),"\n"]}),"\n",(0,t.jsxs)(r.p,{children:["A provider result represents the values a provider, like the ",(0,t.jsx)(r.a,{href:"/api/interfaces/ImageCheckerProvider",children:(0,t.jsx)(r.code,{children:"ImageCheckerProvider"})}),",\nmay return. For once this is the actual result type ",(0,t.jsx)(r.code,{children:"T"}),", like ",(0,t.jsx)(r.code,{children:"ImageChecks"}),", or a Promise that resolves\nto that type ",(0,t.jsx)(r.code,{children:"T"}),". In addition, ",(0,t.jsx)(r.code,{children:"null"})," and ",(0,t.jsx)(r.code,{children:"undefined"})," can be returned - either directly or from a\nPromise."]}),"\n",(0,t.jsxs)(r.p,{children:["The snippets below are all valid implementations of the ",(0,t.jsx)(r.a,{href:"/api/interfaces/ImageCheckerProvider",children:(0,t.jsx)(r.code,{children:"ImageCheckerProvider"})}),":"]}),"\n",(0,t.jsx)(r.pre,{children:(0,t.jsx)(r.code,{className:"language-ts",children:"let a: ImageCheckerProvider = {\n check(image: ImageInfo, token?: CancellationToken): ProviderResult {\n return new ImageChecks();\n }\n\nlet b: ImageCheckerProvider = {\n async check(image: ImageInfo, token?: CancellationToken): ProviderResult {\n\t\treturn new ImageChecks();\n\t}\n}\n\nlet c: ImageCheckerProvider = {\n check(image: ImageInfo, token?: CancellationToken): ProviderResult {\n\t\treturn; // undefined\n\t}\n}\n"})}),"\n",(0,t.jsx)(r.h2,{id:"type-parameters",children:"Type parameters"}),"\n",(0,t.jsxs)(r.p,{children:["\u2022 ",(0,t.jsx)(r.strong,{children:"T"})]}),"\n",(0,t.jsx)(r.h2,{id:"source",children:"Source"}),"\n",(0,t.jsx)(r.p,{children:(0,t.jsx)(r.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L181",children:"packages/extension-api/src/extension-api.d.ts:181"})})]})}function p(e={}){const{wrapper:r}={...(0,s.a)(),...e.components};return r?(0,t.jsx)(r,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},71670:(e,r,n)=>{n.d(r,{Z:()=>o,a:()=>a});var t=n(27378);const s={},i=t.createContext(s);function a(e){const r=t.useContext(i);return t.useMemo((function(){return"function"==typeof e?e(r):{...r,...e}}),[r,e])}function o(e){let r;return r=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:a(e.components),t.createElement(i.Provider,{value:r},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/2340b3ee.25f180af.js b/assets/js/2340b3ee.bcd754dd.js similarity index 96% rename from assets/js/2340b3ee.25f180af.js rename to assets/js/2340b3ee.bcd754dd.js index 0dd4451c646..1d2f1423db3 100644 --- a/assets/js/2340b3ee.25f180af.js +++ b/assets/js/2340b3ee.bcd754dd.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[20205],{18050:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>a,contentTitle:()=>o,default:()=>p,frontMatter:()=>t,metadata:()=>i,toc:()=>d});var c=s(24246),r=s(71670);const t={},o="Function: exec()",i={id:"namespaces/process/functions/exec",title:"Function: exec()",description:"exec(command, args?, options?): Promise\\",source:"@site/api/namespaces/process/functions/exec.md",sourceDirName:"namespaces/process/functions",slug:"/namespaces/process/functions/exec",permalink:"/api/namespaces/process/functions/exec",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Namespace: process",permalink:"/api/namespaces/process/"},next:{title:"Namespace: provider",permalink:"/api/namespaces/provider/"}},a={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Throws",id:"throws",level:2},{value:"Source",id:"source",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,r.a)(),...e.components};return(0,c.jsxs)(c.Fragment,{children:[(0,c.jsx)(n.h1,{id:"function-exec",children:"Function: exec()"}),"\n",(0,c.jsxs)(n.blockquote,{children:["\n",(0,c.jsxs)(n.p,{children:[(0,c.jsx)(n.strong,{children:"exec"}),"(",(0,c.jsx)(n.code,{children:"command"}),", ",(0,c.jsx)(n.code,{children:"args"}),"?, ",(0,c.jsx)(n.code,{children:"options"}),"?): ",(0,c.jsx)(n.code,{children:"Promise"}),"< ",(0,c.jsx)(n.a,{href:"/api/interfaces/RunResult",children:(0,c.jsx)(n.code,{children:"RunResult"})})," >"]}),"\n"]}),"\n",(0,c.jsx)(n.p,{children:"Executes the provided command and returns an object containing the exit code,\nstdout, and stderr content."}),"\n",(0,c.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,c.jsxs)(n.p,{children:["\u2022 ",(0,c.jsx)(n.strong,{children:"command"}),": ",(0,c.jsx)(n.code,{children:"string"})]}),"\n",(0,c.jsx)(n.p,{children:"The command to execute."}),"\n",(0,c.jsxs)(n.p,{children:["\u2022 ",(0,c.jsx)(n.strong,{children:"args?"}),": ",(0,c.jsx)(n.code,{children:"string"}),"[]"]}),"\n",(0,c.jsx)(n.p,{children:"The command arguments."}),"\n",(0,c.jsxs)(n.p,{children:["\u2022 ",(0,c.jsx)(n.strong,{children:"options?"}),": ",(0,c.jsx)(n.a,{href:"/api/interfaces/RunOptions",children:(0,c.jsx)(n.code,{children:"RunOptions"})})]}),"\n",(0,c.jsx)(n.p,{children:"Options, such as environment variables."}),"\n",(0,c.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,c.jsxs)(n.p,{children:[(0,c.jsx)(n.code,{children:"Promise"}),"< ",(0,c.jsx)(n.a,{href:"/api/interfaces/RunResult",children:(0,c.jsx)(n.code,{children:"RunResult"})})," >"]}),"\n",(0,c.jsx)(n.p,{children:"A promise that resolves to a RunResult object."}),"\n",(0,c.jsx)(n.h2,{id:"throws",children:"Throws"}),"\n",(0,c.jsxs)(n.p,{children:[(0,c.jsx)(n.a,{href:"/api/interfaces/RunError",children:"RunError"})," if provided command can not be executed."]}),"\n",(0,c.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,c.jsx)(n.p,{children:(0,c.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L3828",children:"packages/extension-api/src/extension-api.d.ts:3828"})})]})}function p(e={}){const{wrapper:n}={...(0,r.a)(),...e.components};return n?(0,c.jsx)(n,{...e,children:(0,c.jsx)(l,{...e})}):l(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>i,a:()=>o});var c=s(27378);const r={},t=c.createContext(r);function o(e){const n=c.useContext(t);return c.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function i(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:o(e.components),c.createElement(t.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[20205],{18050:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>a,contentTitle:()=>o,default:()=>p,frontMatter:()=>t,metadata:()=>i,toc:()=>d});var c=s(24246),r=s(71670);const t={},o="Function: exec()",i={id:"namespaces/process/functions/exec",title:"Function: exec()",description:"exec(command, args?, options?): Promise\\",source:"@site/api/namespaces/process/functions/exec.md",sourceDirName:"namespaces/process/functions",slug:"/namespaces/process/functions/exec",permalink:"/api/namespaces/process/functions/exec",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Namespace: process",permalink:"/api/namespaces/process/"},next:{title:"Namespace: provider",permalink:"/api/namespaces/provider/"}},a={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Throws",id:"throws",level:2},{value:"Source",id:"source",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,r.a)(),...e.components};return(0,c.jsxs)(c.Fragment,{children:[(0,c.jsx)(n.h1,{id:"function-exec",children:"Function: exec()"}),"\n",(0,c.jsxs)(n.blockquote,{children:["\n",(0,c.jsxs)(n.p,{children:[(0,c.jsx)(n.strong,{children:"exec"}),"(",(0,c.jsx)(n.code,{children:"command"}),", ",(0,c.jsx)(n.code,{children:"args"}),"?, ",(0,c.jsx)(n.code,{children:"options"}),"?): ",(0,c.jsx)(n.code,{children:"Promise"}),"< ",(0,c.jsx)(n.a,{href:"/api/interfaces/RunResult",children:(0,c.jsx)(n.code,{children:"RunResult"})})," >"]}),"\n"]}),"\n",(0,c.jsx)(n.p,{children:"Executes the provided command and returns an object containing the exit code,\nstdout, and stderr content."}),"\n",(0,c.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,c.jsxs)(n.p,{children:["\u2022 ",(0,c.jsx)(n.strong,{children:"command"}),": ",(0,c.jsx)(n.code,{children:"string"})]}),"\n",(0,c.jsx)(n.p,{children:"The command to execute."}),"\n",(0,c.jsxs)(n.p,{children:["\u2022 ",(0,c.jsx)(n.strong,{children:"args?"}),": ",(0,c.jsx)(n.code,{children:"string"}),"[]"]}),"\n",(0,c.jsx)(n.p,{children:"The command arguments."}),"\n",(0,c.jsxs)(n.p,{children:["\u2022 ",(0,c.jsx)(n.strong,{children:"options?"}),": ",(0,c.jsx)(n.a,{href:"/api/interfaces/RunOptions",children:(0,c.jsx)(n.code,{children:"RunOptions"})})]}),"\n",(0,c.jsx)(n.p,{children:"Options, such as environment variables."}),"\n",(0,c.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,c.jsxs)(n.p,{children:[(0,c.jsx)(n.code,{children:"Promise"}),"< ",(0,c.jsx)(n.a,{href:"/api/interfaces/RunResult",children:(0,c.jsx)(n.code,{children:"RunResult"})})," >"]}),"\n",(0,c.jsx)(n.p,{children:"A promise that resolves to a RunResult object."}),"\n",(0,c.jsx)(n.h2,{id:"throws",children:"Throws"}),"\n",(0,c.jsxs)(n.p,{children:[(0,c.jsx)(n.a,{href:"/api/interfaces/RunError",children:"RunError"})," if provided command can not be executed."]}),"\n",(0,c.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,c.jsx)(n.p,{children:(0,c.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L3828",children:"packages/extension-api/src/extension-api.d.ts:3828"})})]})}function p(e={}){const{wrapper:n}={...(0,r.a)(),...e.components};return n?(0,c.jsx)(n,{...e,children:(0,c.jsx)(l,{...e})}):l(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>i,a:()=>o});var c=s(27378);const r={},t=c.createContext(r);function o(e){const n=c.useContext(t);return c.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function i(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:o(e.components),c.createElement(t.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/23a8e291.4c4a4c64.js b/assets/js/23a8e291.53f0f9ff.js similarity index 94% rename from assets/js/23a8e291.4c4a4c64.js rename to assets/js/23a8e291.53f0f9ff.js index c38f79c7d93..1d893f05751 100644 --- a/assets/js/23a8e291.4c4a4c64.js +++ b/assets/js/23a8e291.53f0f9ff.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[43274],{23101:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>s,default:()=>l,frontMatter:()=>r,metadata:()=>c,toc:()=>d});var i=t(24246),o=t(71670);const r={},s="Interface: ConfigurationChangeEvent",c={id:"interfaces/ConfigurationChangeEvent",title:"Interface: ConfigurationChangeEvent",description:"An event describing the change in Configuration",source:"@site/api/interfaces/ConfigurationChangeEvent.md",sourceDirName:"interfaces",slug:"/interfaces/ConfigurationChangeEvent",permalink:"/api/interfaces/ConfigurationChangeEvent",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: Configuration",permalink:"/api/interfaces/Configuration"},next:{title:"Interface: ContainerAuthInfo",permalink:"/api/interfaces/ContainerAuthInfo"}},a={},d=[{value:"Methods",id:"methods",level:2},{value:"affectsConfiguration()",id:"affectsconfiguration",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Source",id:"source",level:4}];function h(e){const n={a:"a",blockquote:"blockquote",code:"code",em:"em",h1:"h1",h2:"h2",h3:"h3",h4:"h4",p:"p",strong:"strong",...(0,o.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"interface-configurationchangeevent",children:"Interface: ConfigurationChangeEvent"}),"\n",(0,i.jsx)(n.p,{children:"An event describing the change in Configuration"}),"\n",(0,i.jsx)(n.h2,{id:"methods",children:"Methods"}),"\n",(0,i.jsx)(n.h3,{id:"affectsconfiguration",children:"affectsConfiguration()"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"affectsConfiguration"}),"(",(0,i.jsx)(n.code,{children:"section"}),", ",(0,i.jsx)(n.code,{children:"scope"}),"?): ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Checks if the given section has changed.\nIf scope is provided, checks if the section has changed for resources under the given scope."}),"\n",(0,i.jsx)(n.h4,{id:"parameters",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"section"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n",(0,i.jsxs)(n.p,{children:["Configuration name, supports ",(0,i.jsx)(n.em,{children:"dotted"})," names."]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"scope?"}),": ",(0,i.jsx)(n.a,{href:"/api/type-aliases/ConfigurationScope",children:(0,i.jsx)(n.code,{children:"ConfigurationScope"})})]}),"\n",(0,i.jsx)(n.p,{children:"A scope in which to check."}),"\n",(0,i.jsx)(n.h4,{id:"returns",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"boolean"})}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"true"})," if the given section has changed."]}),"\n",(0,i.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L715",children:"packages/extension-api/src/extension-api.d.ts:715"})})]})}function l(e={}){const{wrapper:n}={...(0,o.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(h,{...e})}):h(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>c,a:()=>s});var i=t(27378);const o={},r=i.createContext(o);function s(e){const n=i.useContext(r);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:s(e.components),i.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[43274],{23101:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>s,default:()=>f,frontMatter:()=>r,metadata:()=>c,toc:()=>d});var i=t(24246),o=t(71670);const r={},s="Interface: ConfigurationChangeEvent",c={id:"interfaces/ConfigurationChangeEvent",title:"Interface: ConfigurationChangeEvent",description:"An event describing the change in Configuration",source:"@site/api/interfaces/ConfigurationChangeEvent.md",sourceDirName:"interfaces",slug:"/interfaces/ConfigurationChangeEvent",permalink:"/api/interfaces/ConfigurationChangeEvent",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: Configuration",permalink:"/api/interfaces/Configuration"},next:{title:"Interface: ContainerAuthInfo",permalink:"/api/interfaces/ContainerAuthInfo"}},a={},d=[{value:"Methods",id:"methods",level:2},{value:"affectsConfiguration()",id:"affectsconfiguration",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Source",id:"source",level:4}];function h(e){const n={a:"a",blockquote:"blockquote",code:"code",em:"em",h1:"h1",h2:"h2",h3:"h3",h4:"h4",p:"p",strong:"strong",...(0,o.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"interface-configurationchangeevent",children:"Interface: ConfigurationChangeEvent"}),"\n",(0,i.jsx)(n.p,{children:"An event describing the change in Configuration"}),"\n",(0,i.jsx)(n.h2,{id:"methods",children:"Methods"}),"\n",(0,i.jsx)(n.h3,{id:"affectsconfiguration",children:"affectsConfiguration()"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"affectsConfiguration"}),"(",(0,i.jsx)(n.code,{children:"section"}),", ",(0,i.jsx)(n.code,{children:"scope"}),"?): ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Checks if the given section has changed.\nIf scope is provided, checks if the section has changed for resources under the given scope."}),"\n",(0,i.jsx)(n.h4,{id:"parameters",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"section"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n",(0,i.jsxs)(n.p,{children:["Configuration name, supports ",(0,i.jsx)(n.em,{children:"dotted"})," names."]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"scope?"}),": ",(0,i.jsx)(n.a,{href:"/api/type-aliases/ConfigurationScope",children:(0,i.jsx)(n.code,{children:"ConfigurationScope"})})]}),"\n",(0,i.jsx)(n.p,{children:"A scope in which to check."}),"\n",(0,i.jsx)(n.h4,{id:"returns",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"boolean"})}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"true"})," if the given section has changed."]}),"\n",(0,i.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L715",children:"packages/extension-api/src/extension-api.d.ts:715"})})]})}function f(e={}){const{wrapper:n}={...(0,o.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(h,{...e})}):h(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>c,a:()=>s});var i=t(27378);const o={},r=i.createContext(o);function s(e){const n=i.useContext(r);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:s(e.components),i.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/24dadce3.853597a2.js b/assets/js/24dadce3.cfee6fc8.js similarity index 97% rename from assets/js/24dadce3.853597a2.js rename to assets/js/24dadce3.cfee6fc8.js index 869a351e106..15b4a759b6f 100644 --- a/assets/js/24dadce3.853597a2.js +++ b/assets/js/24dadce3.cfee6fc8.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[70595],{64784:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>a,contentTitle:()=>i,default:()=>p,frontMatter:()=>o,metadata:()=>s,toc:()=>l});var c=n(24246),r=n(71670);const o={},i="Interface: LifecycleContext",s={id:"interfaces/LifecycleContext",title:"Interface: LifecycleContext",description:"Properties",source:"@site/api/interfaces/LifecycleContext.md",sourceDirName:"interfaces",slug:"/interfaces/LifecycleContext",permalink:"/api/interfaces/LifecycleContext",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: KubernetesProviderConnectionFactory",permalink:"/api/interfaces/KubernetesProviderConnectionFactory"},next:{title:"Interface: Link",permalink:"/api/interfaces/Link"}},a={},l=[{value:"Properties",id:"properties",level:2},{value:"log",id:"log",level:3},{value:"Source",id:"source",level:4}];function d(e){const t={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",p:"p",strong:"strong",...(0,r.a)(),...e.components};return(0,c.jsxs)(c.Fragment,{children:[(0,c.jsx)(t.h1,{id:"interface-lifecyclecontext",children:"Interface: LifecycleContext"}),"\n",(0,c.jsx)(t.h2,{id:"properties",children:"Properties"}),"\n",(0,c.jsx)(t.h3,{id:"log",children:"log"}),"\n",(0,c.jsxs)(t.blockquote,{children:["\n",(0,c.jsxs)(t.p,{children:[(0,c.jsx)(t.strong,{children:"log"}),": ",(0,c.jsx)(t.a,{href:"/api/interfaces/Logger",children:(0,c.jsx)(t.code,{children:"Logger"})})]}),"\n"]}),"\n",(0,c.jsx)(t.h4,{id:"source",children:"Source"}),"\n",(0,c.jsx)(t.p,{children:(0,c.jsx)(t.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L244",children:"packages/extension-api/src/extension-api.d.ts:244"})})]})}function p(e={}){const{wrapper:t}={...(0,r.a)(),...e.components};return t?(0,c.jsx)(t,{...e,children:(0,c.jsx)(d,{...e})}):d(e)}},71670:(e,t,n)=>{n.d(t,{Z:()=>s,a:()=>i});var c=n(27378);const r={},o=c.createContext(r);function i(e){const t=c.useContext(o);return c.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function s(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:i(e.components),c.createElement(o.Provider,{value:t},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[70595],{64784:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>a,contentTitle:()=>i,default:()=>p,frontMatter:()=>o,metadata:()=>s,toc:()=>l});var c=n(24246),r=n(71670);const o={},i="Interface: LifecycleContext",s={id:"interfaces/LifecycleContext",title:"Interface: LifecycleContext",description:"Properties",source:"@site/api/interfaces/LifecycleContext.md",sourceDirName:"interfaces",slug:"/interfaces/LifecycleContext",permalink:"/api/interfaces/LifecycleContext",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: KubernetesProviderConnectionFactory",permalink:"/api/interfaces/KubernetesProviderConnectionFactory"},next:{title:"Interface: Link",permalink:"/api/interfaces/Link"}},a={},l=[{value:"Properties",id:"properties",level:2},{value:"log",id:"log",level:3},{value:"Source",id:"source",level:4}];function d(e){const t={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",p:"p",strong:"strong",...(0,r.a)(),...e.components};return(0,c.jsxs)(c.Fragment,{children:[(0,c.jsx)(t.h1,{id:"interface-lifecyclecontext",children:"Interface: LifecycleContext"}),"\n",(0,c.jsx)(t.h2,{id:"properties",children:"Properties"}),"\n",(0,c.jsx)(t.h3,{id:"log",children:"log"}),"\n",(0,c.jsxs)(t.blockquote,{children:["\n",(0,c.jsxs)(t.p,{children:[(0,c.jsx)(t.strong,{children:"log"}),": ",(0,c.jsx)(t.a,{href:"/api/interfaces/Logger",children:(0,c.jsx)(t.code,{children:"Logger"})})]}),"\n"]}),"\n",(0,c.jsx)(t.h4,{id:"source",children:"Source"}),"\n",(0,c.jsx)(t.p,{children:(0,c.jsx)(t.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L244",children:"packages/extension-api/src/extension-api.d.ts:244"})})]})}function p(e={}){const{wrapper:t}={...(0,r.a)(),...e.components};return t?(0,c.jsx)(t,{...e,children:(0,c.jsx)(d,{...e})}):d(e)}},71670:(e,t,n)=>{n.d(t,{Z:()=>s,a:()=>i});var c=n(27378);const r={},o=c.createContext(r);function i(e){const t=c.useContext(o);return c.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function s(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:i(e.components),c.createElement(o.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/254d0ff5.2442ecbb.js b/assets/js/254d0ff5.0cfbe8c9.js similarity index 87% rename from assets/js/254d0ff5.2442ecbb.js rename to assets/js/254d0ff5.0cfbe8c9.js index 3454cc18975..82c9a43d68b 100644 --- a/assets/js/254d0ff5.2442ecbb.js +++ b/assets/js/254d0ff5.0cfbe8c9.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[60810],{66520:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>a,contentTitle:()=>s,default:()=>p,frontMatter:()=>i,metadata:()=>c,toc:()=>d});var o=r(24246),t=r(71670);const i={},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:"Interface: ProviderEvent",permalink:"/api/interfaces/ProviderEvent"},next:{title:"Interface: ProviderInformation",permalink:"/api/interfaces/ProviderInformation"}},a={},d=[{value:"Properties",id:"properties",level:2},{value:"icon?",id:"icon",level:3},{value:"Source",id:"source",level:4},{value:"logo?",id:"logo",level:3},{value:"Source",id:"source-1",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,t.a)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(n.h1,{id:"interface-providerimages",children:"Interface: ProviderImages"}),"\n",(0,o.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,o.jsx)(n.h3,{id:"icon",children:"icon?"}),"\n",(0,o.jsxs)(n.blockquote,{children:["\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.strong,{children:(0,o.jsx)(n.code,{children:"optional"})})," ",(0,o.jsx)(n.strong,{children:"icon"}),": ",(0,o.jsx)(n.code,{children:"string"})," | ",(0,o.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,o.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,o.jsx)(n.p,{children:(0,o.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L422",children:"packages/extension-api/src/extension-api.d.ts:422"})}),"\n",(0,o.jsx)(n.hr,{}),"\n",(0,o.jsx)(n.h3,{id:"logo",children:"logo?"}),"\n",(0,o.jsxs)(n.blockquote,{children:["\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.strong,{children:(0,o.jsx)(n.code,{children:"optional"})})," ",(0,o.jsx)(n.strong,{children:"logo"}),": ",(0,o.jsx)(n.code,{children:"string"})," | ",(0,o.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,o.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,o.jsx)(n.p,{children:(0,o.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L423",children:"packages/extension-api/src/extension-api.d.ts:423"})})]})}function p(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(l,{...e})}):l(e)}},71670:(e,n,r)=>{r.d(n,{Z:()=>c,a:()=>s});var o=r(27378);const t={},i=o.createContext(t);function s(e){const n=o.useContext(i);return o.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:s(e.components),o.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[60810],{66520:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>d,contentTitle:()=>s,default:()=>p,frontMatter:()=>i,metadata:()=>c,toc:()=>a});var o=r(24246),t=r(71670);const i={},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:"Interface: ProviderEvent",permalink:"/api/interfaces/ProviderEvent"},next:{title:"Interface: ProviderInformation",permalink:"/api/interfaces/ProviderInformation"}},d={},a=[{value:"Properties",id:"properties",level:2},{value:"icon?",id:"icon",level:3},{value:"Source",id:"source",level:4},{value:"logo?",id:"logo",level:3},{value:"Source",id:"source-1",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,t.a)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(n.h1,{id:"interface-providerimages",children:"Interface: ProviderImages"}),"\n",(0,o.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,o.jsx)(n.h3,{id:"icon",children:"icon?"}),"\n",(0,o.jsxs)(n.blockquote,{children:["\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.strong,{children:(0,o.jsx)(n.code,{children:"optional"})})," ",(0,o.jsx)(n.strong,{children:"icon"}),": ",(0,o.jsx)(n.code,{children:"string"})," | ",(0,o.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,o.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,o.jsx)(n.p,{children:(0,o.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L422",children:"packages/extension-api/src/extension-api.d.ts:422"})}),"\n",(0,o.jsx)(n.hr,{}),"\n",(0,o.jsx)(n.h3,{id:"logo",children:"logo?"}),"\n",(0,o.jsxs)(n.blockquote,{children:["\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.strong,{children:(0,o.jsx)(n.code,{children:"optional"})})," ",(0,o.jsx)(n.strong,{children:"logo"}),": ",(0,o.jsx)(n.code,{children:"string"})," | ",(0,o.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,o.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,o.jsx)(n.p,{children:(0,o.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L423",children:"packages/extension-api/src/extension-api.d.ts:423"})})]})}function p(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(l,{...e})}):l(e)}},71670:(e,n,r)=>{r.d(n,{Z:()=>c,a:()=>s});var o=r(27378);const t={},i=o.createContext(t);function s(e){const n=o.useContext(i);return o.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:s(e.components),o.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/271ff0d1.f84e17f8.js b/assets/js/271ff0d1.a6cdce94.js similarity index 98% rename from assets/js/271ff0d1.f84e17f8.js rename to assets/js/271ff0d1.a6cdce94.js index 1ad59e329ac..daa8345960b 100644 --- a/assets/js/271ff0d1.f84e17f8.js +++ b/assets/js/271ff0d1.a6cdce94.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[86335],{27192:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>a,contentTitle:()=>c,default:()=>p,frontMatter:()=>t,metadata:()=>r,toc:()=>d});var o=s(24246),i=s(71670);const t={},c="Function: showOpenDialog()",r={id:"namespaces/window/functions/showOpenDialog",title:"Function: showOpenDialog()",description:"showOpenDialog(options?): Promise\\",source:"@site/api/namespaces/window/functions/showOpenDialog.md",sourceDirName:"namespaces/window/functions",slug:"/namespaces/window/functions/showOpenDialog",permalink:"/api/namespaces/window/functions/showOpenDialog",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Function: showNotification()",permalink:"/api/namespaces/window/functions/showNotification"},next:{title:"Function: showQuickPick()",permalink:"/api/namespaces/window/functions/showQuickPick"}},a={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,i.a)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(n.h1,{id:"function-showopendialog",children:"Function: showOpenDialog()"}),"\n",(0,o.jsxs)(n.blockquote,{children:["\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.strong,{children:"showOpenDialog"}),"(",(0,o.jsx)(n.code,{children:"options"}),"?): ",(0,o.jsx)(n.code,{children:"Promise"}),"< ",(0,o.jsx)(n.a,{href:"/api/classes/Uri",children:(0,o.jsx)(n.code,{children:"Uri"})}),"[] | ",(0,o.jsx)(n.code,{children:"undefined"})," >"]}),"\n"]}),"\n",(0,o.jsx)(n.p,{children:"Shows a file open dialog to the user which allows to select a file\nfor opening-purposes."}),"\n",(0,o.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,o.jsxs)(n.p,{children:["\u2022 ",(0,o.jsx)(n.strong,{children:"options?"}),": ",(0,o.jsx)(n.a,{href:"/api/interfaces/OpenDialogOptions",children:(0,o.jsx)(n.code,{children:"OpenDialogOptions"})})]}),"\n",(0,o.jsx)(n.p,{children:"Options that control the dialog."}),"\n",(0,o.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.code,{children:"Promise"}),"< ",(0,o.jsx)(n.a,{href:"/api/classes/Uri",children:(0,o.jsx)(n.code,{children:"Uri"})}),"[] | ",(0,o.jsx)(n.code,{children:"undefined"})," >"]}),"\n",(0,o.jsxs)(n.p,{children:["A promise that resolves to the selected resources or ",(0,o.jsx)(n.code,{children:"undefined"}),"."]}),"\n",(0,o.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,o.jsx)(n.p,{children:(0,o.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L1713",children:"packages/extension-api/src/extension-api.d.ts:1713"})})]})}function p(e={}){const{wrapper:n}={...(0,i.a)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(l,{...e})}):l(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>r,a:()=>c});var o=s(27378);const i={},t=o.createContext(i);function c(e){const n=o.useContext(t);return o.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function r(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:c(e.components),o.createElement(t.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[86335],{27192:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>a,contentTitle:()=>c,default:()=>p,frontMatter:()=>t,metadata:()=>r,toc:()=>d});var o=s(24246),i=s(71670);const t={},c="Function: showOpenDialog()",r={id:"namespaces/window/functions/showOpenDialog",title:"Function: showOpenDialog()",description:"showOpenDialog(options?): Promise\\",source:"@site/api/namespaces/window/functions/showOpenDialog.md",sourceDirName:"namespaces/window/functions",slug:"/namespaces/window/functions/showOpenDialog",permalink:"/api/namespaces/window/functions/showOpenDialog",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Function: showNotification()",permalink:"/api/namespaces/window/functions/showNotification"},next:{title:"Function: showQuickPick()",permalink:"/api/namespaces/window/functions/showQuickPick"}},a={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,i.a)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(n.h1,{id:"function-showopendialog",children:"Function: showOpenDialog()"}),"\n",(0,o.jsxs)(n.blockquote,{children:["\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.strong,{children:"showOpenDialog"}),"(",(0,o.jsx)(n.code,{children:"options"}),"?): ",(0,o.jsx)(n.code,{children:"Promise"}),"< ",(0,o.jsx)(n.a,{href:"/api/classes/Uri",children:(0,o.jsx)(n.code,{children:"Uri"})}),"[] | ",(0,o.jsx)(n.code,{children:"undefined"})," >"]}),"\n"]}),"\n",(0,o.jsx)(n.p,{children:"Shows a file open dialog to the user which allows to select a file\nfor opening-purposes."}),"\n",(0,o.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,o.jsxs)(n.p,{children:["\u2022 ",(0,o.jsx)(n.strong,{children:"options?"}),": ",(0,o.jsx)(n.a,{href:"/api/interfaces/OpenDialogOptions",children:(0,o.jsx)(n.code,{children:"OpenDialogOptions"})})]}),"\n",(0,o.jsx)(n.p,{children:"Options that control the dialog."}),"\n",(0,o.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.code,{children:"Promise"}),"< ",(0,o.jsx)(n.a,{href:"/api/classes/Uri",children:(0,o.jsx)(n.code,{children:"Uri"})}),"[] | ",(0,o.jsx)(n.code,{children:"undefined"})," >"]}),"\n",(0,o.jsxs)(n.p,{children:["A promise that resolves to the selected resources or ",(0,o.jsx)(n.code,{children:"undefined"}),"."]}),"\n",(0,o.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,o.jsx)(n.p,{children:(0,o.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L1713",children:"packages/extension-api/src/extension-api.d.ts:1713"})})]})}function p(e={}){const{wrapper:n}={...(0,i.a)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(l,{...e})}):l(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>r,a:()=>c});var o=s(27378);const i={},t=o.createContext(i);function c(e){const n=o.useContext(t);return o.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function r(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:c(e.components),o.createElement(t.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/280646e4.189c0e50.js b/assets/js/280646e4.44065112.js similarity index 95% rename from assets/js/280646e4.189c0e50.js rename to assets/js/280646e4.44065112.js index 8ad7ca125f9..c79c93e371b 100644 --- a/assets/js/280646e4.189c0e50.js +++ b/assets/js/280646e4.44065112.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[24726],{56663:(e,t,s)=>{s.r(t),s.d(t,{assets:()=>l,contentTitle:()=>i,default:()=>d,frontMatter:()=>r,metadata:()=>a,toc:()=>o});var n=s(24246),c=s(71670);const r={},i="Interface: HealthCheckResults",a={id:"interfaces/HealthCheckResults",title:"Interface: HealthCheckResults",description:"HealthCheckResults describes the results/logs from a healthcheck",source:"@site/api/interfaces/HealthCheckResults.md",sourceDirName:"interfaces",slug:"/interfaces/HealthCheckResults",permalink:"/api/interfaces/HealthCheckResults",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: HealthCheckLog",permalink:"/api/interfaces/HealthCheckLog"},next:{title:"Interface: HealthConfig",permalink:"/api/interfaces/HealthConfig"}},l={},o=[{value:"Properties",id:"properties",level:2},{value:"FailingStreak",id:"failingstreak",level:3},{value:"Source",id:"source",level:4},{value:"Log",id:"log",level:3},{value:"Source",id:"source-1",level:4},{value:"Status",id:"status",level:3},{value:"Source",id:"source-2",level:4}];function h(e){const t={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,c.a)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(t.h1,{id:"interface-healthcheckresults",children:"Interface: HealthCheckResults"}),"\n",(0,n.jsx)(t.p,{children:"HealthCheckResults describes the results/logs from a healthcheck"}),"\n",(0,n.jsx)(t.h2,{id:"properties",children:"Properties"}),"\n",(0,n.jsx)(t.h3,{id:"failingstreak",children:"FailingStreak"}),"\n",(0,n.jsxs)(t.blockquote,{children:["\n",(0,n.jsxs)(t.p,{children:[(0,n.jsx)(t.strong,{children:"FailingStreak"}),": ",(0,n.jsx)(t.code,{children:"number"})]}),"\n"]}),"\n",(0,n.jsx)(t.p,{children:"FailingStreak is the number of consecutive failed healthchecks"}),"\n",(0,n.jsx)(t.h4,{id:"source",children:"Source"}),"\n",(0,n.jsx)(t.p,{children:(0,n.jsx)(t.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2212",children:"packages/extension-api/src/extension-api.d.ts:2212"})}),"\n",(0,n.jsx)(t.hr,{}),"\n",(0,n.jsx)(t.h3,{id:"log",children:"Log"}),"\n",(0,n.jsxs)(t.blockquote,{children:["\n",(0,n.jsxs)(t.p,{children:[(0,n.jsx)(t.strong,{children:"Log"}),": ",(0,n.jsx)(t.a,{href:"/api/interfaces/HealthCheckLog",children:(0,n.jsx)(t.code,{children:"HealthCheckLog"})}),"[]"]}),"\n"]}),"\n",(0,n.jsx)(t.p,{children:"Log describes healthcheck attempts and results"}),"\n",(0,n.jsx)(t.h4,{id:"source-1",children:"Source"}),"\n",(0,n.jsx)(t.p,{children:(0,n.jsx)(t.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2216",children:"packages/extension-api/src/extension-api.d.ts:2216"})}),"\n",(0,n.jsx)(t.hr,{}),"\n",(0,n.jsx)(t.h3,{id:"status",children:"Status"}),"\n",(0,n.jsxs)(t.blockquote,{children:["\n",(0,n.jsxs)(t.p,{children:[(0,n.jsx)(t.strong,{children:"Status"}),": ",(0,n.jsx)(t.code,{children:"string"})]}),"\n"]}),"\n",(0,n.jsx)(t.p,{children:"Status is starting, healthy or unhealthy"}),"\n",(0,n.jsx)(t.h4,{id:"source-2",children:"Source"}),"\n",(0,n.jsx)(t.p,{children:(0,n.jsx)(t.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2208",children:"packages/extension-api/src/extension-api.d.ts:2208"})})]})}function d(e={}){const{wrapper:t}={...(0,c.a)(),...e.components};return t?(0,n.jsx)(t,{...e,children:(0,n.jsx)(h,{...e})}):h(e)}},71670:(e,t,s)=>{s.d(t,{Z:()=>a,a:()=>i});var n=s(27378);const c={},r=n.createContext(c);function i(e){const t=n.useContext(r);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(c):e.components||c:i(e.components),n.createElement(r.Provider,{value:t},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[24726],{56663:(e,t,s)=>{s.r(t),s.d(t,{assets:()=>l,contentTitle:()=>i,default:()=>d,frontMatter:()=>r,metadata:()=>a,toc:()=>o});var n=s(24246),c=s(71670);const r={},i="Interface: HealthCheckResults",a={id:"interfaces/HealthCheckResults",title:"Interface: HealthCheckResults",description:"HealthCheckResults describes the results/logs from a healthcheck",source:"@site/api/interfaces/HealthCheckResults.md",sourceDirName:"interfaces",slug:"/interfaces/HealthCheckResults",permalink:"/api/interfaces/HealthCheckResults",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: HealthCheckLog",permalink:"/api/interfaces/HealthCheckLog"},next:{title:"Interface: HealthConfig",permalink:"/api/interfaces/HealthConfig"}},l={},o=[{value:"Properties",id:"properties",level:2},{value:"FailingStreak",id:"failingstreak",level:3},{value:"Source",id:"source",level:4},{value:"Log",id:"log",level:3},{value:"Source",id:"source-1",level:4},{value:"Status",id:"status",level:3},{value:"Source",id:"source-2",level:4}];function h(e){const t={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,c.a)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(t.h1,{id:"interface-healthcheckresults",children:"Interface: HealthCheckResults"}),"\n",(0,n.jsx)(t.p,{children:"HealthCheckResults describes the results/logs from a healthcheck"}),"\n",(0,n.jsx)(t.h2,{id:"properties",children:"Properties"}),"\n",(0,n.jsx)(t.h3,{id:"failingstreak",children:"FailingStreak"}),"\n",(0,n.jsxs)(t.blockquote,{children:["\n",(0,n.jsxs)(t.p,{children:[(0,n.jsx)(t.strong,{children:"FailingStreak"}),": ",(0,n.jsx)(t.code,{children:"number"})]}),"\n"]}),"\n",(0,n.jsx)(t.p,{children:"FailingStreak is the number of consecutive failed healthchecks"}),"\n",(0,n.jsx)(t.h4,{id:"source",children:"Source"}),"\n",(0,n.jsx)(t.p,{children:(0,n.jsx)(t.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2212",children:"packages/extension-api/src/extension-api.d.ts:2212"})}),"\n",(0,n.jsx)(t.hr,{}),"\n",(0,n.jsx)(t.h3,{id:"log",children:"Log"}),"\n",(0,n.jsxs)(t.blockquote,{children:["\n",(0,n.jsxs)(t.p,{children:[(0,n.jsx)(t.strong,{children:"Log"}),": ",(0,n.jsx)(t.a,{href:"/api/interfaces/HealthCheckLog",children:(0,n.jsx)(t.code,{children:"HealthCheckLog"})}),"[]"]}),"\n"]}),"\n",(0,n.jsx)(t.p,{children:"Log describes healthcheck attempts and results"}),"\n",(0,n.jsx)(t.h4,{id:"source-1",children:"Source"}),"\n",(0,n.jsx)(t.p,{children:(0,n.jsx)(t.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2216",children:"packages/extension-api/src/extension-api.d.ts:2216"})}),"\n",(0,n.jsx)(t.hr,{}),"\n",(0,n.jsx)(t.h3,{id:"status",children:"Status"}),"\n",(0,n.jsxs)(t.blockquote,{children:["\n",(0,n.jsxs)(t.p,{children:[(0,n.jsx)(t.strong,{children:"Status"}),": ",(0,n.jsx)(t.code,{children:"string"})]}),"\n"]}),"\n",(0,n.jsx)(t.p,{children:"Status is starting, healthy or unhealthy"}),"\n",(0,n.jsx)(t.h4,{id:"source-2",children:"Source"}),"\n",(0,n.jsx)(t.p,{children:(0,n.jsx)(t.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2208",children:"packages/extension-api/src/extension-api.d.ts:2208"})})]})}function d(e={}){const{wrapper:t}={...(0,c.a)(),...e.components};return t?(0,n.jsx)(t,{...e,children:(0,n.jsx)(h,{...e})}):h(e)}},71670:(e,t,s)=>{s.d(t,{Z:()=>a,a:()=>i});var n=s(27378);const c={},r=n.createContext(c);function i(e){const t=n.useContext(r);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(c):e.components||c:i(e.components),n.createElement(r.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/2bb2c1cd.82fb5fa6.js b/assets/js/2bb2c1cd.5a1566a9.js similarity index 95% rename from assets/js/2bb2c1cd.82fb5fa6.js rename to assets/js/2bb2c1cd.5a1566a9.js index 92975cfe5ba..8cea373a318 100644 --- a/assets/js/2bb2c1cd.82fb5fa6.js +++ b/assets/js/2bb2c1cd.5a1566a9.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[74340],{21239:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>s,default:()=>l,frontMatter:()=>r,metadata:()=>c,toc:()=>d});var i=t(24246),o=t(71670);const r={},s="Interface: NetworkingConfig",c={id:"interfaces/NetworkingConfig",title:"Interface: NetworkingConfig",description:"Properties",source:"@site/api/interfaces/NetworkingConfig.md",sourceDirName:"interfaces",slug:"/interfaces/NetworkingConfig",permalink:"/api/interfaces/NetworkingConfig",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: NetworkStats",permalink:"/api/interfaces/NetworkStats"},next:{title:"Interface: NotificationOptions",permalink:"/api/interfaces/NotificationOptions"}},a={},d=[{value:"Properties",id:"properties",level:2},{value:"EndpointsConfig?",id:"endpointsconfig",level:3},{value:"Index signature",id:"index-signature",level:4},{value:"Source",id:"source",level:4}];function p(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",p:"p",strong:"strong",...(0,o.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"interface-networkingconfig",children:"Interface: NetworkingConfig"}),"\n",(0,i.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(n.h3,{id:"endpointsconfig",children:"EndpointsConfig?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"EndpointsConfig"}),": ",(0,i.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"index-signature",children:"Index signature"}),"\n",(0,i.jsxs)(n.p,{children:["[",(0,i.jsx)(n.code,{children:"key"}),": ",(0,i.jsx)(n.code,{children:"string"}),"]: ",(0,i.jsx)(n.a,{href:"/api/interfaces/EndpointSettings",children:(0,i.jsx)(n.code,{children:"EndpointSettings"})})]}),"\n",(0,i.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2535",children:"packages/extension-api/src/extension-api.d.ts:2535"})})]})}function l(e={}){const{wrapper:n}={...(0,o.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(p,{...e})}):p(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>c,a:()=>s});var i=t(27378);const o={},r=i.createContext(o);function s(e){const n=i.useContext(r);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:s(e.components),i.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[74340],{21239:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>s,default:()=>l,frontMatter:()=>r,metadata:()=>c,toc:()=>d});var i=t(24246),o=t(71670);const r={},s="Interface: NetworkingConfig",c={id:"interfaces/NetworkingConfig",title:"Interface: NetworkingConfig",description:"Properties",source:"@site/api/interfaces/NetworkingConfig.md",sourceDirName:"interfaces",slug:"/interfaces/NetworkingConfig",permalink:"/api/interfaces/NetworkingConfig",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: NetworkStats",permalink:"/api/interfaces/NetworkStats"},next:{title:"Interface: NotificationOptions",permalink:"/api/interfaces/NotificationOptions"}},a={},d=[{value:"Properties",id:"properties",level:2},{value:"EndpointsConfig?",id:"endpointsconfig",level:3},{value:"Index signature",id:"index-signature",level:4},{value:"Source",id:"source",level:4}];function p(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",p:"p",strong:"strong",...(0,o.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"interface-networkingconfig",children:"Interface: NetworkingConfig"}),"\n",(0,i.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(n.h3,{id:"endpointsconfig",children:"EndpointsConfig?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"EndpointsConfig"}),": ",(0,i.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"index-signature",children:"Index signature"}),"\n",(0,i.jsxs)(n.p,{children:["[",(0,i.jsx)(n.code,{children:"key"}),": ",(0,i.jsx)(n.code,{children:"string"}),"]: ",(0,i.jsx)(n.a,{href:"/api/interfaces/EndpointSettings",children:(0,i.jsx)(n.code,{children:"EndpointSettings"})})]}),"\n",(0,i.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2535",children:"packages/extension-api/src/extension-api.d.ts:2535"})})]})}function l(e={}){const{wrapper:n}={...(0,o.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(p,{...e})}):p(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>c,a:()=>s});var i=t(27378);const o={},r=i.createContext(o);function s(e){const n=i.useContext(r);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:s(e.components),i.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/2cb13d6d.6c544606.js b/assets/js/2cb13d6d.4bd23de0.js similarity index 83% rename from assets/js/2cb13d6d.6c544606.js rename to assets/js/2cb13d6d.4bd23de0.js index cee7acd2fb2..f945c538237 100644 --- a/assets/js/2cb13d6d.6c544606.js +++ b/assets/js/2cb13d6d.4bd23de0.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[86528],{34952:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>o,default:()=>p,frontMatter:()=>i,metadata:()=>c,toc:()=>l});var s=t(24246),r=t(71670);const i={},o="Interface: BlkioStatEntry",c={id:"interfaces/BlkioStatEntry",title:"Interface: BlkioStatEntry",description:"Properties",source:"@site/api/interfaces/BlkioStatEntry.md",sourceDirName:"interfaces",slug:"/interfaces/BlkioStatEntry",permalink:"/api/interfaces/BlkioStatEntry",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: AuthenticationSessionsChangeEvent",permalink:"/api/interfaces/AuthenticationSessionsChangeEvent"},next:{title:"Interface: BlkioStats",permalink:"/api/interfaces/BlkioStats"}},a={},l=[{value:"Properties",id:"properties",level:2},{value:"major",id:"major",level:3},{value:"Source",id:"source",level:4},{value:"minor",id:"minor",level:3},{value:"Source",id:"source-1",level:4},{value:"op",id:"op",level:3},{value:"Source",id:"source-2",level:4},{value:"value",id:"value",level:3},{value:"Source",id:"source-3",level:4}];function d(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,r.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"interface-blkiostatentry",children:"Interface: BlkioStatEntry"}),"\n",(0,s.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,s.jsx)(n.h3,{id:"major",children:"major"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"major"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2764",children:"packages/extension-api/src/extension-api.d.ts:2764"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"minor",children:"minor"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"minor"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2765",children:"packages/extension-api/src/extension-api.d.ts:2765"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"op",children:"op"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"op"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2766",children:"packages/extension-api/src/extension-api.d.ts:2766"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"value",children:"value"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"value"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2767",children:"packages/extension-api/src/extension-api.d.ts:2767"})})]})}function p(e={}){const{wrapper:n}={...(0,r.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(d,{...e})}):d(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>c,a:()=>o});var s=t(27378);const r={},i=s.createContext(r);function o(e){const n=s.useContext(i);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:o(e.components),s.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[86528],{34952:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>o,default:()=>p,frontMatter:()=>i,metadata:()=>c,toc:()=>d});var s=t(24246),r=t(71670);const i={},o="Interface: BlkioStatEntry",c={id:"interfaces/BlkioStatEntry",title:"Interface: BlkioStatEntry",description:"Properties",source:"@site/api/interfaces/BlkioStatEntry.md",sourceDirName:"interfaces",slug:"/interfaces/BlkioStatEntry",permalink:"/api/interfaces/BlkioStatEntry",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: AuthenticationSessionsChangeEvent",permalink:"/api/interfaces/AuthenticationSessionsChangeEvent"},next:{title:"Interface: BlkioStats",permalink:"/api/interfaces/BlkioStats"}},a={},d=[{value:"Properties",id:"properties",level:2},{value:"major",id:"major",level:3},{value:"Source",id:"source",level:4},{value:"minor",id:"minor",level:3},{value:"Source",id:"source-1",level:4},{value:"op",id:"op",level:3},{value:"Source",id:"source-2",level:4},{value:"value",id:"value",level:3},{value:"Source",id:"source-3",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,r.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"interface-blkiostatentry",children:"Interface: BlkioStatEntry"}),"\n",(0,s.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,s.jsx)(n.h3,{id:"major",children:"major"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"major"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2764",children:"packages/extension-api/src/extension-api.d.ts:2764"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"minor",children:"minor"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"minor"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2765",children:"packages/extension-api/src/extension-api.d.ts:2765"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"op",children:"op"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"op"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2766",children:"packages/extension-api/src/extension-api.d.ts:2766"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"value",children:"value"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"value"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2767",children:"packages/extension-api/src/extension-api.d.ts:2767"})})]})}function p(e={}){const{wrapper:n}={...(0,r.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>c,a:()=>o});var s=t(27378);const r={},i=s.createContext(r);function o(e){const n=s.useContext(i);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:o(e.components),s.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/3109d9d2.b988a45f.js b/assets/js/3109d9d2.91d5e17b.js similarity index 95% rename from assets/js/3109d9d2.b988a45f.js rename to assets/js/3109d9d2.91d5e17b.js index fbccfe63757..597761cacc6 100644 --- a/assets/js/3109d9d2.b988a45f.js +++ b/assets/js/3109d9d2.91d5e17b.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[3745],{20057:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>d,contentTitle:()=>r,default:()=>h,frontMatter:()=>o,metadata:()=>t,toc:()=>l});var i=s(24246),c=s(71670);const o={},r="Function: showQuickPick()",t={id:"namespaces/window/functions/showQuickPick",title:"Function: showQuickPick()",description:"showQuickPick(items, options, token)",source:"@site/api/namespaces/window/functions/showQuickPick.md",sourceDirName:"namespaces/window/functions",slug:"/namespaces/window/functions/showQuickPick",permalink:"/api/namespaces/window/functions/showQuickPick",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Function: showOpenDialog()",permalink:"/api/namespaces/window/functions/showOpenDialog"},next:{title:"Function: showSaveDialog()",permalink:"/api/namespaces/window/functions/showSaveDialog"}},d={},l=[{value:"showQuickPick(items, options, token)",id:"showquickpickitems-options-token",level:2},{value:"Parameters",id:"parameters",level:3},{value:"Returns",id:"returns",level:3},{value:"Source",id:"source",level:3},{value:"showQuickPick(items, options, token)",id:"showquickpickitems-options-token-1",level:2},{value:"Parameters",id:"parameters-1",level:3},{value:"Returns",id:"returns-1",level:3},{value:"Source",id:"source-1",level:3},{value:"showQuickPick(items, options, token)",id:"showquickpickitems-options-token-2",level:2},{value:"Type parameters",id:"type-parameters",level:3},{value:"Parameters",id:"parameters-2",level:3},{value:"Returns",id:"returns-2",level:3},{value:"Source",id:"source-2",level:3},{value:"showQuickPick(items, options, token)",id:"showquickpickitems-options-token-3",level:2},{value:"Type parameters",id:"type-parameters-1",level:3},{value:"Parameters",id:"parameters-3",level:3},{value:"Returns",id:"returns-3",level:3},{value:"Source",id:"source-3",level:3}];function a(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",p:"p",strong:"strong",...(0,c.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"function-showquickpick",children:"Function: showQuickPick()"}),"\n",(0,i.jsx)(n.h2,{id:"showquickpickitems-options-token",children:"showQuickPick(items, options, token)"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"showQuickPick"}),"(",(0,i.jsx)(n.code,{children:"items"}),", ",(0,i.jsx)(n.code,{children:"options"}),", ",(0,i.jsx)(n.code,{children:"token"}),"?): ",(0,i.jsx)(n.code,{children:"Promise"}),"< ",(0,i.jsx)(n.code,{children:"string"}),"[] | ",(0,i.jsx)(n.code,{children:"undefined"})," >"]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Shows a selection list allowing multiple selections."}),"\n",(0,i.jsx)(n.h3,{id:"parameters",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"items"}),": readonly ",(0,i.jsx)(n.code,{children:"string"}),"[] | ",(0,i.jsx)(n.code,{children:"Promise"}),"< readonly ",(0,i.jsx)(n.code,{children:"string"}),"[] >"]}),"\n",(0,i.jsx)(n.p,{children:"An array of strings, or a promise that resolves to an array of strings."}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"options"}),": ",(0,i.jsx)(n.a,{href:"/api/interfaces/QuickPickOptions",children:(0,i.jsx)(n.code,{children:"QuickPickOptions"})})," & ",(0,i.jsx)(n.code,{children:"object"})]}),"\n",(0,i.jsx)(n.p,{children:"Configures the behavior of the selection list."}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"token?"}),": ",(0,i.jsx)(n.a,{href:"/api/interfaces/CancellationToken",children:(0,i.jsx)(n.code,{children:"CancellationToken"})})]}),"\n",(0,i.jsx)(n.p,{children:"A token that can be used to signal cancellation."}),"\n",(0,i.jsx)(n.h3,{id:"returns",children:"Returns"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"Promise"}),"< ",(0,i.jsx)(n.code,{children:"string"}),"[] | ",(0,i.jsx)(n.code,{children:"undefined"})," >"]}),"\n",(0,i.jsxs)(n.p,{children:["A promise that resolves to the selected items or ",(0,i.jsx)(n.code,{children:"undefined"}),"."]}),"\n",(0,i.jsx)(n.h3,{id:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L1732",children:"packages/extension-api/src/extension-api.d.ts:1732"})}),"\n",(0,i.jsx)(n.h2,{id:"showquickpickitems-options-token-1",children:"showQuickPick(items, options, token)"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"showQuickPick"}),"(",(0,i.jsx)(n.code,{children:"items"}),", ",(0,i.jsx)(n.code,{children:"options"}),"?, ",(0,i.jsx)(n.code,{children:"token"}),"?): ",(0,i.jsx)(n.code,{children:"Promise"}),"< ",(0,i.jsx)(n.code,{children:"string"})," | ",(0,i.jsx)(n.code,{children:"undefined"})," >"]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Shows a selection list."}),"\n",(0,i.jsx)(n.h3,{id:"parameters-1",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"items"}),": readonly ",(0,i.jsx)(n.code,{children:"string"}),"[] | ",(0,i.jsx)(n.code,{children:"Promise"}),"< readonly ",(0,i.jsx)(n.code,{children:"string"}),"[] >"]}),"\n",(0,i.jsx)(n.p,{children:"An array of strings, or a promise that resolves to an array of strings."}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"options?"}),": ",(0,i.jsx)(n.a,{href:"/api/interfaces/QuickPickOptions",children:(0,i.jsx)(n.code,{children:"QuickPickOptions"})})]}),"\n",(0,i.jsx)(n.p,{children:"Configures the behavior of the selection list."}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"token?"}),": ",(0,i.jsx)(n.a,{href:"/api/interfaces/CancellationToken",children:(0,i.jsx)(n.code,{children:"CancellationToken"})})]}),"\n",(0,i.jsx)(n.p,{children:"A token that can be used to signal cancellation."}),"\n",(0,i.jsx)(n.h3,{id:"returns-1",children:"Returns"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"Promise"}),"< ",(0,i.jsx)(n.code,{children:"string"})," | ",(0,i.jsx)(n.code,{children:"undefined"})," >"]}),"\n",(0,i.jsxs)(n.p,{children:["A promise that resolves to the selection or ",(0,i.jsx)(n.code,{children:"undefined"}),"."]}),"\n",(0,i.jsx)(n.h3,{id:"source-1",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L1746",children:"packages/extension-api/src/extension-api.d.ts:1746"})}),"\n",(0,i.jsx)(n.h2,{id:"showquickpickitems-options-token-2",children:"showQuickPick(items, options, token)"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"showQuickPick"}),"<",(0,i.jsx)(n.code,{children:"T"}),">(",(0,i.jsx)(n.code,{children:"items"}),", ",(0,i.jsx)(n.code,{children:"options"}),", ",(0,i.jsx)(n.code,{children:"token"}),"?): ",(0,i.jsx)(n.code,{children:"Promise"}),"< ",(0,i.jsx)(n.code,{children:"T"}),"[] | ",(0,i.jsx)(n.code,{children:"undefined"})," >"]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Shows a selection list allowing multiple selections."}),"\n",(0,i.jsx)(n.h3,{id:"type-parameters",children:"Type parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"T"})," extends ",(0,i.jsx)(n.a,{href:"/api/interfaces/QuickPickItem",children:(0,i.jsx)(n.code,{children:"QuickPickItem"})})]}),"\n",(0,i.jsx)(n.h3,{id:"parameters-2",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"items"}),": readonly ",(0,i.jsx)(n.code,{children:"T"}),"[] | ",(0,i.jsx)(n.code,{children:"Promise"}),"< readonly ",(0,i.jsx)(n.code,{children:"T"}),"[] >"]}),"\n",(0,i.jsx)(n.p,{children:"An array of items, or a promise that resolves to an array of items."}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"options"}),": ",(0,i.jsx)(n.a,{href:"/api/interfaces/QuickPickOptions",children:(0,i.jsx)(n.code,{children:"QuickPickOptions"})})," & ",(0,i.jsx)(n.code,{children:"object"})]}),"\n",(0,i.jsx)(n.p,{children:"Configures the behavior of the selection list."}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"token?"}),": ",(0,i.jsx)(n.a,{href:"/api/interfaces/CancellationToken",children:(0,i.jsx)(n.code,{children:"CancellationToken"})})]}),"\n",(0,i.jsx)(n.p,{children:"A token that can be used to signal cancellation."}),"\n",(0,i.jsx)(n.h3,{id:"returns-2",children:"Returns"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"Promise"}),"< ",(0,i.jsx)(n.code,{children:"T"}),"[] | ",(0,i.jsx)(n.code,{children:"undefined"})," >"]}),"\n",(0,i.jsxs)(n.p,{children:["A promise that resolves to the selected items or ",(0,i.jsx)(n.code,{children:"undefined"}),"."]}),"\n",(0,i.jsx)(n.h3,{id:"source-2",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L1760",children:"packages/extension-api/src/extension-api.d.ts:1760"})}),"\n",(0,i.jsx)(n.h2,{id:"showquickpickitems-options-token-3",children:"showQuickPick(items, options, token)"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"showQuickPick"}),"<",(0,i.jsx)(n.code,{children:"T"}),">(",(0,i.jsx)(n.code,{children:"items"}),", ",(0,i.jsx)(n.code,{children:"options"}),"?, ",(0,i.jsx)(n.code,{children:"token"}),"?): ",(0,i.jsx)(n.code,{children:"Promise"}),"< ",(0,i.jsx)(n.code,{children:"T"})," | ",(0,i.jsx)(n.code,{children:"undefined"})," >"]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Shows a selection list."}),"\n",(0,i.jsx)(n.h3,{id:"type-parameters-1",children:"Type parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"T"})," extends ",(0,i.jsx)(n.a,{href:"/api/interfaces/QuickPickItem",children:(0,i.jsx)(n.code,{children:"QuickPickItem"})})]}),"\n",(0,i.jsx)(n.h3,{id:"parameters-3",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"items"}),": readonly ",(0,i.jsx)(n.code,{children:"T"}),"[] | ",(0,i.jsx)(n.code,{children:"Promise"}),"< readonly ",(0,i.jsx)(n.code,{children:"T"}),"[] >"]}),"\n",(0,i.jsx)(n.p,{children:"An array of items, or a promise that resolves to an array of items."}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"options?"}),": ",(0,i.jsx)(n.a,{href:"/api/interfaces/QuickPickOptions",children:(0,i.jsx)(n.code,{children:"QuickPickOptions"})})]}),"\n",(0,i.jsx)(n.p,{children:"Configures the behavior of the selection list."}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"token?"}),": ",(0,i.jsx)(n.a,{href:"/api/interfaces/CancellationToken",children:(0,i.jsx)(n.code,{children:"CancellationToken"})})]}),"\n",(0,i.jsx)(n.p,{children:"A token that can be used to signal cancellation."}),"\n",(0,i.jsx)(n.h3,{id:"returns-3",children:"Returns"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"Promise"}),"< ",(0,i.jsx)(n.code,{children:"T"})," | ",(0,i.jsx)(n.code,{children:"undefined"})," >"]}),"\n",(0,i.jsxs)(n.p,{children:["A promise that resolves to the selected item or ",(0,i.jsx)(n.code,{children:"undefined"}),"."]}),"\n",(0,i.jsx)(n.h3,{id:"source-3",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L1774",children:"packages/extension-api/src/extension-api.d.ts:1774"})})]})}function h(e={}){const{wrapper:n}={...(0,c.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(a,{...e})}):a(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>t,a:()=>r});var i=s(27378);const c={},o=i.createContext(c);function r(e){const n=i.useContext(o);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function t(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(c):e.components||c:r(e.components),i.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[3745],{20057:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>d,contentTitle:()=>r,default:()=>a,frontMatter:()=>o,metadata:()=>t,toc:()=>l});var i=s(24246),c=s(71670);const o={},r="Function: showQuickPick()",t={id:"namespaces/window/functions/showQuickPick",title:"Function: showQuickPick()",description:"showQuickPick(items, options, token)",source:"@site/api/namespaces/window/functions/showQuickPick.md",sourceDirName:"namespaces/window/functions",slug:"/namespaces/window/functions/showQuickPick",permalink:"/api/namespaces/window/functions/showQuickPick",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Function: showOpenDialog()",permalink:"/api/namespaces/window/functions/showOpenDialog"},next:{title:"Function: showSaveDialog()",permalink:"/api/namespaces/window/functions/showSaveDialog"}},d={},l=[{value:"showQuickPick(items, options, token)",id:"showquickpickitems-options-token",level:2},{value:"Parameters",id:"parameters",level:3},{value:"Returns",id:"returns",level:3},{value:"Source",id:"source",level:3},{value:"showQuickPick(items, options, token)",id:"showquickpickitems-options-token-1",level:2},{value:"Parameters",id:"parameters-1",level:3},{value:"Returns",id:"returns-1",level:3},{value:"Source",id:"source-1",level:3},{value:"showQuickPick(items, options, token)",id:"showquickpickitems-options-token-2",level:2},{value:"Type parameters",id:"type-parameters",level:3},{value:"Parameters",id:"parameters-2",level:3},{value:"Returns",id:"returns-2",level:3},{value:"Source",id:"source-2",level:3},{value:"showQuickPick(items, options, token)",id:"showquickpickitems-options-token-3",level:2},{value:"Type parameters",id:"type-parameters-1",level:3},{value:"Parameters",id:"parameters-3",level:3},{value:"Returns",id:"returns-3",level:3},{value:"Source",id:"source-3",level:3}];function h(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",p:"p",strong:"strong",...(0,c.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"function-showquickpick",children:"Function: showQuickPick()"}),"\n",(0,i.jsx)(n.h2,{id:"showquickpickitems-options-token",children:"showQuickPick(items, options, token)"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"showQuickPick"}),"(",(0,i.jsx)(n.code,{children:"items"}),", ",(0,i.jsx)(n.code,{children:"options"}),", ",(0,i.jsx)(n.code,{children:"token"}),"?): ",(0,i.jsx)(n.code,{children:"Promise"}),"< ",(0,i.jsx)(n.code,{children:"string"}),"[] | ",(0,i.jsx)(n.code,{children:"undefined"})," >"]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Shows a selection list allowing multiple selections."}),"\n",(0,i.jsx)(n.h3,{id:"parameters",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"items"}),": readonly ",(0,i.jsx)(n.code,{children:"string"}),"[] | ",(0,i.jsx)(n.code,{children:"Promise"}),"< readonly ",(0,i.jsx)(n.code,{children:"string"}),"[] >"]}),"\n",(0,i.jsx)(n.p,{children:"An array of strings, or a promise that resolves to an array of strings."}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"options"}),": ",(0,i.jsx)(n.a,{href:"/api/interfaces/QuickPickOptions",children:(0,i.jsx)(n.code,{children:"QuickPickOptions"})})," & ",(0,i.jsx)(n.code,{children:"object"})]}),"\n",(0,i.jsx)(n.p,{children:"Configures the behavior of the selection list."}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"token?"}),": ",(0,i.jsx)(n.a,{href:"/api/interfaces/CancellationToken",children:(0,i.jsx)(n.code,{children:"CancellationToken"})})]}),"\n",(0,i.jsx)(n.p,{children:"A token that can be used to signal cancellation."}),"\n",(0,i.jsx)(n.h3,{id:"returns",children:"Returns"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"Promise"}),"< ",(0,i.jsx)(n.code,{children:"string"}),"[] | ",(0,i.jsx)(n.code,{children:"undefined"})," >"]}),"\n",(0,i.jsxs)(n.p,{children:["A promise that resolves to the selected items or ",(0,i.jsx)(n.code,{children:"undefined"}),"."]}),"\n",(0,i.jsx)(n.h3,{id:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L1732",children:"packages/extension-api/src/extension-api.d.ts:1732"})}),"\n",(0,i.jsx)(n.h2,{id:"showquickpickitems-options-token-1",children:"showQuickPick(items, options, token)"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"showQuickPick"}),"(",(0,i.jsx)(n.code,{children:"items"}),", ",(0,i.jsx)(n.code,{children:"options"}),"?, ",(0,i.jsx)(n.code,{children:"token"}),"?): ",(0,i.jsx)(n.code,{children:"Promise"}),"< ",(0,i.jsx)(n.code,{children:"string"})," | ",(0,i.jsx)(n.code,{children:"undefined"})," >"]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Shows a selection list."}),"\n",(0,i.jsx)(n.h3,{id:"parameters-1",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"items"}),": readonly ",(0,i.jsx)(n.code,{children:"string"}),"[] | ",(0,i.jsx)(n.code,{children:"Promise"}),"< readonly ",(0,i.jsx)(n.code,{children:"string"}),"[] >"]}),"\n",(0,i.jsx)(n.p,{children:"An array of strings, or a promise that resolves to an array of strings."}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"options?"}),": ",(0,i.jsx)(n.a,{href:"/api/interfaces/QuickPickOptions",children:(0,i.jsx)(n.code,{children:"QuickPickOptions"})})]}),"\n",(0,i.jsx)(n.p,{children:"Configures the behavior of the selection list."}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"token?"}),": ",(0,i.jsx)(n.a,{href:"/api/interfaces/CancellationToken",children:(0,i.jsx)(n.code,{children:"CancellationToken"})})]}),"\n",(0,i.jsx)(n.p,{children:"A token that can be used to signal cancellation."}),"\n",(0,i.jsx)(n.h3,{id:"returns-1",children:"Returns"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"Promise"}),"< ",(0,i.jsx)(n.code,{children:"string"})," | ",(0,i.jsx)(n.code,{children:"undefined"})," >"]}),"\n",(0,i.jsxs)(n.p,{children:["A promise that resolves to the selection or ",(0,i.jsx)(n.code,{children:"undefined"}),"."]}),"\n",(0,i.jsx)(n.h3,{id:"source-1",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L1746",children:"packages/extension-api/src/extension-api.d.ts:1746"})}),"\n",(0,i.jsx)(n.h2,{id:"showquickpickitems-options-token-2",children:"showQuickPick(items, options, token)"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"showQuickPick"}),"<",(0,i.jsx)(n.code,{children:"T"}),">(",(0,i.jsx)(n.code,{children:"items"}),", ",(0,i.jsx)(n.code,{children:"options"}),", ",(0,i.jsx)(n.code,{children:"token"}),"?): ",(0,i.jsx)(n.code,{children:"Promise"}),"< ",(0,i.jsx)(n.code,{children:"T"}),"[] | ",(0,i.jsx)(n.code,{children:"undefined"})," >"]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Shows a selection list allowing multiple selections."}),"\n",(0,i.jsx)(n.h3,{id:"type-parameters",children:"Type parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"T"})," extends ",(0,i.jsx)(n.a,{href:"/api/interfaces/QuickPickItem",children:(0,i.jsx)(n.code,{children:"QuickPickItem"})})]}),"\n",(0,i.jsx)(n.h3,{id:"parameters-2",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"items"}),": readonly ",(0,i.jsx)(n.code,{children:"T"}),"[] | ",(0,i.jsx)(n.code,{children:"Promise"}),"< readonly ",(0,i.jsx)(n.code,{children:"T"}),"[] >"]}),"\n",(0,i.jsx)(n.p,{children:"An array of items, or a promise that resolves to an array of items."}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"options"}),": ",(0,i.jsx)(n.a,{href:"/api/interfaces/QuickPickOptions",children:(0,i.jsx)(n.code,{children:"QuickPickOptions"})})," & ",(0,i.jsx)(n.code,{children:"object"})]}),"\n",(0,i.jsx)(n.p,{children:"Configures the behavior of the selection list."}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"token?"}),": ",(0,i.jsx)(n.a,{href:"/api/interfaces/CancellationToken",children:(0,i.jsx)(n.code,{children:"CancellationToken"})})]}),"\n",(0,i.jsx)(n.p,{children:"A token that can be used to signal cancellation."}),"\n",(0,i.jsx)(n.h3,{id:"returns-2",children:"Returns"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"Promise"}),"< ",(0,i.jsx)(n.code,{children:"T"}),"[] | ",(0,i.jsx)(n.code,{children:"undefined"})," >"]}),"\n",(0,i.jsxs)(n.p,{children:["A promise that resolves to the selected items or ",(0,i.jsx)(n.code,{children:"undefined"}),"."]}),"\n",(0,i.jsx)(n.h3,{id:"source-2",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L1760",children:"packages/extension-api/src/extension-api.d.ts:1760"})}),"\n",(0,i.jsx)(n.h2,{id:"showquickpickitems-options-token-3",children:"showQuickPick(items, options, token)"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"showQuickPick"}),"<",(0,i.jsx)(n.code,{children:"T"}),">(",(0,i.jsx)(n.code,{children:"items"}),", ",(0,i.jsx)(n.code,{children:"options"}),"?, ",(0,i.jsx)(n.code,{children:"token"}),"?): ",(0,i.jsx)(n.code,{children:"Promise"}),"< ",(0,i.jsx)(n.code,{children:"T"})," | ",(0,i.jsx)(n.code,{children:"undefined"})," >"]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Shows a selection list."}),"\n",(0,i.jsx)(n.h3,{id:"type-parameters-1",children:"Type parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"T"})," extends ",(0,i.jsx)(n.a,{href:"/api/interfaces/QuickPickItem",children:(0,i.jsx)(n.code,{children:"QuickPickItem"})})]}),"\n",(0,i.jsx)(n.h3,{id:"parameters-3",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"items"}),": readonly ",(0,i.jsx)(n.code,{children:"T"}),"[] | ",(0,i.jsx)(n.code,{children:"Promise"}),"< readonly ",(0,i.jsx)(n.code,{children:"T"}),"[] >"]}),"\n",(0,i.jsx)(n.p,{children:"An array of items, or a promise that resolves to an array of items."}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"options?"}),": ",(0,i.jsx)(n.a,{href:"/api/interfaces/QuickPickOptions",children:(0,i.jsx)(n.code,{children:"QuickPickOptions"})})]}),"\n",(0,i.jsx)(n.p,{children:"Configures the behavior of the selection list."}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"token?"}),": ",(0,i.jsx)(n.a,{href:"/api/interfaces/CancellationToken",children:(0,i.jsx)(n.code,{children:"CancellationToken"})})]}),"\n",(0,i.jsx)(n.p,{children:"A token that can be used to signal cancellation."}),"\n",(0,i.jsx)(n.h3,{id:"returns-3",children:"Returns"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"Promise"}),"< ",(0,i.jsx)(n.code,{children:"T"})," | ",(0,i.jsx)(n.code,{children:"undefined"})," >"]}),"\n",(0,i.jsxs)(n.p,{children:["A promise that resolves to the selected item or ",(0,i.jsx)(n.code,{children:"undefined"}),"."]}),"\n",(0,i.jsx)(n.h3,{id:"source-3",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L1774",children:"packages/extension-api/src/extension-api.d.ts:1774"})})]})}function a(e={}){const{wrapper:n}={...(0,c.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(h,{...e})}):h(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>t,a:()=>r});var i=s(27378);const c={},o=i.createContext(c);function r(e){const n=i.useContext(o);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function t(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(c):e.components||c:r(e.components),i.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/3132913e.83a3dc68.js b/assets/js/3132913e.f39d3682.js similarity index 92% rename from assets/js/3132913e.83a3dc68.js rename to assets/js/3132913e.f39d3682.js index f39236b5682..b8456a87e10 100644 --- a/assets/js/3132913e.83a3dc68.js +++ b/assets/js/3132913e.f39d3682.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[68732],{98755:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>a,contentTitle:()=>o,default:()=>h,frontMatter:()=>r,metadata:()=>c,toc:()=>l});var i=s(24246),t=s(71670);const r={},o="Interface: SaveDialogOptions",c={id:"interfaces/SaveDialogOptions",title:"Interface: SaveDialogOptions",description:"Options to configure the behaviour of a file save dialog.",source:"@site/api/interfaces/SaveDialogOptions.md",sourceDirName:"interfaces",slug:"/interfaces/SaveDialogOptions",permalink:"/api/interfaces/SaveDialogOptions",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: RunResult",permalink:"/api/interfaces/RunResult"},next:{title:"Interface: SecretStorage",permalink:"/api/interfaces/SecretStorage"}},a={},l=[{value:"Properties",id:"properties",level:2},{value:"defaultUri?",id:"defaulturi",level:3},{value:"Source",id:"source",level:4},{value:"filters?",id:"filters",level:3},{value:"Source",id:"source-1",level:4},{value:"saveLabel?",id:"savelabel",level:3},{value:"Source",id:"source-2",level:4},{value:"title?",id:"title",level:3},{value:"Source",id:"source-3",level:4}];function d(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,t.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"interface-savedialogoptions",children:"Interface: SaveDialogOptions"}),"\n",(0,i.jsx)(n.p,{children:"Options to configure the behaviour of a file save dialog."}),"\n",(0,i.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(n.h3,{id:"defaulturi",children:"defaultUri?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"defaultUri"}),": ",(0,i.jsx)(n.a,{href:"/api/classes/Uri",children:(0,i.jsx)(n.code,{children:"Uri"})})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"The resource the dialog shows when opened."}),"\n",(0,i.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L1552",children:"packages/extension-api/src/extension-api.d.ts:1552"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"filters",children:"filters?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"filters"}),": ",(0,i.jsx)(n.code,{children:"object"}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"A set of file filters that are used by the dialog."}),"\n",(0,i.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L1562",children:"packages/extension-api/src/extension-api.d.ts:1562"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"savelabel",children:"saveLabel?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"saveLabel"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"A human-readable string for the save button."}),"\n",(0,i.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L1557",children:"packages/extension-api/src/extension-api.d.ts:1557"})}),"\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:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"title"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Dialog title."}),"\n",(0,i.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L1570",children:"packages/extension-api/src/extension-api.d.ts:1570"})})]})}function h(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(d,{...e})}):d(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>c,a:()=>o});var i=s(27378);const t={},r=i.createContext(t);function o(e){const n=i.useContext(r);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:o(e.components),i.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[68732],{98755:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>a,contentTitle:()=>o,default:()=>h,frontMatter:()=>r,metadata:()=>c,toc:()=>l});var i=s(24246),t=s(71670);const r={},o="Interface: SaveDialogOptions",c={id:"interfaces/SaveDialogOptions",title:"Interface: SaveDialogOptions",description:"Options to configure the behaviour of a file save dialog.",source:"@site/api/interfaces/SaveDialogOptions.md",sourceDirName:"interfaces",slug:"/interfaces/SaveDialogOptions",permalink:"/api/interfaces/SaveDialogOptions",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: RunResult",permalink:"/api/interfaces/RunResult"},next:{title:"Interface: SecretStorage",permalink:"/api/interfaces/SecretStorage"}},a={},l=[{value:"Properties",id:"properties",level:2},{value:"defaultUri?",id:"defaulturi",level:3},{value:"Source",id:"source",level:4},{value:"filters?",id:"filters",level:3},{value:"Source",id:"source-1",level:4},{value:"saveLabel?",id:"savelabel",level:3},{value:"Source",id:"source-2",level:4},{value:"title?",id:"title",level:3},{value:"Source",id:"source-3",level:4}];function d(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,t.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"interface-savedialogoptions",children:"Interface: SaveDialogOptions"}),"\n",(0,i.jsx)(n.p,{children:"Options to configure the behaviour of a file save dialog."}),"\n",(0,i.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(n.h3,{id:"defaulturi",children:"defaultUri?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"defaultUri"}),": ",(0,i.jsx)(n.a,{href:"/api/classes/Uri",children:(0,i.jsx)(n.code,{children:"Uri"})})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"The resource the dialog shows when opened."}),"\n",(0,i.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L1552",children:"packages/extension-api/src/extension-api.d.ts:1552"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"filters",children:"filters?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"filters"}),": ",(0,i.jsx)(n.code,{children:"object"}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"A set of file filters that are used by the dialog."}),"\n",(0,i.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L1562",children:"packages/extension-api/src/extension-api.d.ts:1562"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"savelabel",children:"saveLabel?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"saveLabel"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"A human-readable string for the save button."}),"\n",(0,i.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L1557",children:"packages/extension-api/src/extension-api.d.ts:1557"})}),"\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:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"title"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Dialog title."}),"\n",(0,i.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L1570",children:"packages/extension-api/src/extension-api.d.ts:1570"})})]})}function h(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(d,{...e})}):d(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>c,a:()=>o});var i=s(27378);const t={},r=i.createContext(t);function o(e){const n=i.useContext(r);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:o(e.components),i.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/35300761.2078a56d.js b/assets/js/35300761.2078a56d.js new file mode 100644 index 00000000000..93517f07613 --- /dev/null +++ b/assets/js/35300761.2078a56d.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[96120],{98639:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>t,contentTitle:()=>o,default:()=>h,frontMatter:()=>r,metadata:()=>d,toc:()=>l});var i=s(24246),c=s(71670);const r={},o="Interface: MenuItem",d={id:"interfaces/MenuItem",title:"Interface: MenuItem",description:"Properties",source:"@site/api/interfaces/MenuItem.md",sourceDirName:"interfaces",slug:"/interfaces/MenuItem",permalink:"/api/interfaces/MenuItem",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: MemoryStats",permalink:"/api/interfaces/MemoryStats"},next:{title:"Interface: MountSettings",permalink:"/api/interfaces/MountSettings"}},t={},l=[{value:"Properties",id:"properties",level:2},{value:"checked?",id:"checked",level:3},{value:"Source",id:"source",level:4},{value:"enabled?",id:"enabled",level:3},{value:"Source",id:"source-1",level:4},{value:"icon?",id:"icon",level:3},{value:"Source",id:"source-2",level:4},{value:"id",id:"id",level:3},{value:"Source",id:"source-3",level:4},{value:"label?",id:"label",level:3},{value:"Source",id:"source-4",level:4},{value:"submenu?",id:"submenu",level:3},{value:"Source",id:"source-5",level:4},{value:"type?",id:"type",level:3},{value:"Source",id:"source-6",level:4},{value:"visible?",id:"visible",level:3},{value:"Source",id:"source-7",level:4}];function a(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,c.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"interface-menuitem",children:"Interface: MenuItem"}),"\n",(0,i.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(n.h3,{id:"checked",children:"checked?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"checked"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Should only be specified for ",(0,i.jsx)(n.code,{children:"checkbox"})," or ",(0,i.jsx)(n.code,{children:"radio"})," type menu items."]}),"\n",(0,i.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L60",children:"packages/extension-api/src/extension-api.d.ts:60"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"enabled",children:"enabled?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"enabled"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"If false, the menu item will be greyed out and unclickable."}),"\n",(0,i.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L52",children:"packages/extension-api/src/extension-api.d.ts:52"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"icon",children:"icon?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"icon"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L48",children:"packages/extension-api/src/extension-api.d.ts:48"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"id",children:"id"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"id"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Unique within a single menu. Should be same as commandId for handler"}),"\n",(0,i.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L43",children:"packages/extension-api/src/extension-api.d.ts:43"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"label",children:"label?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"label"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-4",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L46",children:"packages/extension-api/src/extension-api.d.ts:46"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"submenu",children:"submenu?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"submenu"}),": ",(0,i.jsx)(n.a,{href:"/api/interfaces/MenuItem",children:(0,i.jsx)(n.code,{children:"MenuItem"})}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-5",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L62",children:"packages/extension-api/src/extension-api.d.ts:62"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"type",children:"type?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"type"}),": ",(0,i.jsx)(n.code,{children:'"normal"'})," | ",(0,i.jsx)(n.code,{children:'"separator"'})," | ",(0,i.jsx)(n.code,{children:'"submenu"'})," | ",(0,i.jsx)(n.code,{children:'"checkbox"'})," | ",(0,i.jsx)(n.code,{children:'"radio"'})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-6",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L45",children:"packages/extension-api/src/extension-api.d.ts:45"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"visible",children:"visible?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"visible"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"If false, the menu item will be entirely hidden."}),"\n",(0,i.jsx)(n.h4,{id:"source-7",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L56",children:"packages/extension-api/src/extension-api.d.ts:56"})})]})}function h(e={}){const{wrapper:n}={...(0,c.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(a,{...e})}):a(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>d,a:()=>o});var i=s(27378);const c={},r=i.createContext(c);function o(e){const n=i.useContext(r);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function d(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(c):e.components||c:o(e.components),i.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/35300761.b8007215.js b/assets/js/35300761.b8007215.js deleted file mode 100644 index 7e84a840629..00000000000 --- a/assets/js/35300761.b8007215.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[96120],{98639:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>d,contentTitle:()=>o,default:()=>h,frontMatter:()=>r,metadata:()=>t,toc:()=>l});var c=s(24246),i=s(71670);const r={},o="Interface: MenuItem",t={id:"interfaces/MenuItem",title:"Interface: MenuItem",description:"Properties",source:"@site/api/interfaces/MenuItem.md",sourceDirName:"interfaces",slug:"/interfaces/MenuItem",permalink:"/api/interfaces/MenuItem",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: MemoryStats",permalink:"/api/interfaces/MemoryStats"},next:{title:"Interface: MountSettings",permalink:"/api/interfaces/MountSettings"}},d={},l=[{value:"Properties",id:"properties",level:2},{value:"checked?",id:"checked",level:3},{value:"Source",id:"source",level:4},{value:"enabled?",id:"enabled",level:3},{value:"Source",id:"source-1",level:4},{value:"icon?",id:"icon",level:3},{value:"Source",id:"source-2",level:4},{value:"id",id:"id",level:3},{value:"Source",id:"source-3",level:4},{value:"label?",id:"label",level:3},{value:"Source",id:"source-4",level:4},{value:"submenu?",id:"submenu",level:3},{value:"Source",id:"source-5",level:4},{value:"type?",id:"type",level:3},{value:"Source",id:"source-6",level:4},{value:"visible?",id:"visible",level:3},{value:"Source",id:"source-7",level:4}];function a(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,i.a)(),...e.components};return(0,c.jsxs)(c.Fragment,{children:[(0,c.jsx)(n.h1,{id:"interface-menuitem",children:"Interface: MenuItem"}),"\n",(0,c.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,c.jsx)(n.h3,{id:"checked",children:"checked?"}),"\n",(0,c.jsxs)(n.blockquote,{children:["\n",(0,c.jsxs)(n.p,{children:[(0,c.jsx)(n.strong,{children:(0,c.jsx)(n.code,{children:"optional"})})," ",(0,c.jsx)(n.strong,{children:"checked"}),": ",(0,c.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,c.jsxs)(n.p,{children:["Should only be specified for ",(0,c.jsx)(n.code,{children:"checkbox"})," or ",(0,c.jsx)(n.code,{children:"radio"})," type menu items."]}),"\n",(0,c.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,c.jsx)(n.p,{children:(0,c.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L60",children:"packages/extension-api/src/extension-api.d.ts:60"})}),"\n",(0,c.jsx)(n.hr,{}),"\n",(0,c.jsx)(n.h3,{id:"enabled",children:"enabled?"}),"\n",(0,c.jsxs)(n.blockquote,{children:["\n",(0,c.jsxs)(n.p,{children:[(0,c.jsx)(n.strong,{children:(0,c.jsx)(n.code,{children:"optional"})})," ",(0,c.jsx)(n.strong,{children:"enabled"}),": ",(0,c.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,c.jsx)(n.p,{children:"If false, the menu item will be greyed out and unclickable."}),"\n",(0,c.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,c.jsx)(n.p,{children:(0,c.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L52",children:"packages/extension-api/src/extension-api.d.ts:52"})}),"\n",(0,c.jsx)(n.hr,{}),"\n",(0,c.jsx)(n.h3,{id:"icon",children:"icon?"}),"\n",(0,c.jsxs)(n.blockquote,{children:["\n",(0,c.jsxs)(n.p,{children:[(0,c.jsx)(n.strong,{children:(0,c.jsx)(n.code,{children:"optional"})})," ",(0,c.jsx)(n.strong,{children:"icon"}),": ",(0,c.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,c.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,c.jsx)(n.p,{children:(0,c.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L48",children:"packages/extension-api/src/extension-api.d.ts:48"})}),"\n",(0,c.jsx)(n.hr,{}),"\n",(0,c.jsx)(n.h3,{id:"id",children:"id"}),"\n",(0,c.jsxs)(n.blockquote,{children:["\n",(0,c.jsxs)(n.p,{children:[(0,c.jsx)(n.strong,{children:"id"}),": ",(0,c.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,c.jsx)(n.p,{children:"Unique within a single menu. Should be same as commandId for handler"}),"\n",(0,c.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,c.jsx)(n.p,{children:(0,c.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L43",children:"packages/extension-api/src/extension-api.d.ts:43"})}),"\n",(0,c.jsx)(n.hr,{}),"\n",(0,c.jsx)(n.h3,{id:"label",children:"label?"}),"\n",(0,c.jsxs)(n.blockquote,{children:["\n",(0,c.jsxs)(n.p,{children:[(0,c.jsx)(n.strong,{children:(0,c.jsx)(n.code,{children:"optional"})})," ",(0,c.jsx)(n.strong,{children:"label"}),": ",(0,c.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,c.jsx)(n.h4,{id:"source-4",children:"Source"}),"\n",(0,c.jsx)(n.p,{children:(0,c.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L46",children:"packages/extension-api/src/extension-api.d.ts:46"})}),"\n",(0,c.jsx)(n.hr,{}),"\n",(0,c.jsx)(n.h3,{id:"submenu",children:"submenu?"}),"\n",(0,c.jsxs)(n.blockquote,{children:["\n",(0,c.jsxs)(n.p,{children:[(0,c.jsx)(n.strong,{children:(0,c.jsx)(n.code,{children:"optional"})})," ",(0,c.jsx)(n.strong,{children:"submenu"}),": ",(0,c.jsx)(n.a,{href:"/api/interfaces/MenuItem",children:(0,c.jsx)(n.code,{children:"MenuItem"})}),"[]"]}),"\n"]}),"\n",(0,c.jsx)(n.h4,{id:"source-5",children:"Source"}),"\n",(0,c.jsx)(n.p,{children:(0,c.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L62",children:"packages/extension-api/src/extension-api.d.ts:62"})}),"\n",(0,c.jsx)(n.hr,{}),"\n",(0,c.jsx)(n.h3,{id:"type",children:"type?"}),"\n",(0,c.jsxs)(n.blockquote,{children:["\n",(0,c.jsxs)(n.p,{children:[(0,c.jsx)(n.strong,{children:(0,c.jsx)(n.code,{children:"optional"})})," ",(0,c.jsx)(n.strong,{children:"type"}),": ",(0,c.jsx)(n.code,{children:'"normal"'})," | ",(0,c.jsx)(n.code,{children:'"separator"'})," | ",(0,c.jsx)(n.code,{children:'"submenu"'})," | ",(0,c.jsx)(n.code,{children:'"checkbox"'})," | ",(0,c.jsx)(n.code,{children:'"radio"'})]}),"\n"]}),"\n",(0,c.jsx)(n.h4,{id:"source-6",children:"Source"}),"\n",(0,c.jsx)(n.p,{children:(0,c.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L45",children:"packages/extension-api/src/extension-api.d.ts:45"})}),"\n",(0,c.jsx)(n.hr,{}),"\n",(0,c.jsx)(n.h3,{id:"visible",children:"visible?"}),"\n",(0,c.jsxs)(n.blockquote,{children:["\n",(0,c.jsxs)(n.p,{children:[(0,c.jsx)(n.strong,{children:(0,c.jsx)(n.code,{children:"optional"})})," ",(0,c.jsx)(n.strong,{children:"visible"}),": ",(0,c.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,c.jsx)(n.p,{children:"If false, the menu item will be entirely hidden."}),"\n",(0,c.jsx)(n.h4,{id:"source-7",children:"Source"}),"\n",(0,c.jsx)(n.p,{children:(0,c.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L56",children:"packages/extension-api/src/extension-api.d.ts:56"})})]})}function h(e={}){const{wrapper:n}={...(0,i.a)(),...e.components};return n?(0,c.jsx)(n,{...e,children:(0,c.jsx)(a,{...e})}):a(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>t,a:()=>o});var c=s(27378);const i={},r=c.createContext(i);function o(e){const n=c.useContext(r);return c.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function t(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:o(e.components),c.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/3866940b.c2fd7ce4.js b/assets/js/3866940b.9582348f.js similarity index 91% rename from assets/js/3866940b.c2fd7ce4.js rename to assets/js/3866940b.9582348f.js index 9fe1f03d589..bcfe53636ef 100644 --- a/assets/js/3866940b.c2fd7ce4.js +++ b/assets/js/3866940b.9582348f.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[6082],{44011:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>a,contentTitle:()=>s,default:()=>p,frontMatter:()=>o,metadata:()=>c,toc:()=>d});var t=r(24246),i=r(71670);const o={},s="Interface: ProviderInformation",c={id:"interfaces/ProviderInformation",title:"Interface: ProviderInformation",description:"Properties",source:"@site/api/interfaces/ProviderInformation.md",sourceDirName:"interfaces",slug:"/interfaces/ProviderInformation",permalink:"/api/interfaces/ProviderInformation",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: ProviderImages",permalink:"/api/interfaces/ProviderImages"},next:{title:"Interface: ProviderInstallation",permalink:"/api/interfaces/ProviderInstallation"}},a={},d=[{value:"Properties",id:"properties",level:2},{value:"details?",id:"details",level:3},{value:"Source",id:"source",level:4},{value:"name",id:"name",level:3},{value:"Source",id:"source-1",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,i.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"interface-providerinformation",children:"Interface: ProviderInformation"}),"\n",(0,t.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,t.jsx)(n.h3,{id:"details",children:"details?"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:(0,t.jsx)(n.code,{children:"optional"})})," ",(0,t.jsx)(n.strong,{children:"details"}),": ",(0,t.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L207",children:"packages/extension-api/src/extension-api.d.ts:207"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"name",children:"name"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"name"}),": ",(0,t.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L206",children:"packages/extension-api/src/extension-api.d.ts:206"})})]})}function p(e={}){const{wrapper:n}={...(0,i.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},71670:(e,n,r)=>{r.d(n,{Z:()=>c,a:()=>s});var t=r(27378);const i={},o=t.createContext(i);function s(e){const n=t.useContext(o);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:s(e.components),t.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[6082],{44011:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>a,contentTitle:()=>s,default:()=>p,frontMatter:()=>o,metadata:()=>c,toc:()=>d});var t=r(24246),i=r(71670);const o={},s="Interface: ProviderInformation",c={id:"interfaces/ProviderInformation",title:"Interface: ProviderInformation",description:"Properties",source:"@site/api/interfaces/ProviderInformation.md",sourceDirName:"interfaces",slug:"/interfaces/ProviderInformation",permalink:"/api/interfaces/ProviderInformation",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: ProviderImages",permalink:"/api/interfaces/ProviderImages"},next:{title:"Interface: ProviderInstallation",permalink:"/api/interfaces/ProviderInstallation"}},a={},d=[{value:"Properties",id:"properties",level:2},{value:"details?",id:"details",level:3},{value:"Source",id:"source",level:4},{value:"name",id:"name",level:3},{value:"Source",id:"source-1",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,i.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"interface-providerinformation",children:"Interface: ProviderInformation"}),"\n",(0,t.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,t.jsx)(n.h3,{id:"details",children:"details?"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:(0,t.jsx)(n.code,{children:"optional"})})," ",(0,t.jsx)(n.strong,{children:"details"}),": ",(0,t.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L207",children:"packages/extension-api/src/extension-api.d.ts:207"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"name",children:"name"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"name"}),": ",(0,t.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L206",children:"packages/extension-api/src/extension-api.d.ts:206"})})]})}function p(e={}){const{wrapper:n}={...(0,i.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},71670:(e,n,r)=>{r.d(n,{Z:()=>c,a:()=>s});var t=r(27378);const i={},o=t.createContext(i);function s(e){const n=t.useContext(o);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:s(e.components),t.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/39ae3791.a43fc0cc.js b/assets/js/39ae3791.7666bfbb.js similarity index 84% rename from assets/js/39ae3791.a43fc0cc.js rename to assets/js/39ae3791.7666bfbb.js index 124afc87bab..2c017f228fb 100644 --- a/assets/js/39ae3791.a43fc0cc.js +++ b/assets/js/39ae3791.7666bfbb.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[955],{74605:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>d,contentTitle:()=>c,default:()=>h,frontMatter:()=>t,metadata:()=>o,toc:()=>a});var r=s(24246),i=s(71670);const t={},c="Interface: ProviderLifecycle",o={id:"interfaces/ProviderLifecycle",title:"Interface: ProviderLifecycle",description:"Methods",source:"@site/api/interfaces/ProviderLifecycle.md",sourceDirName:"interfaces",slug:"/interfaces/ProviderLifecycle",permalink:"/api/interfaces/ProviderLifecycle",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: ProviderInstallation",permalink:"/api/interfaces/ProviderInstallation"},next:{title:"Interface: ProviderOptions",permalink:"/api/interfaces/ProviderOptions"}},d={},a=[{value:"Methods",id:"methods",level:2},{value:"initialize()?",id:"initialize",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Source",id:"source",level:4},{value:"start()",id:"start",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Source",id:"source-1",level:4},{value:"status()",id:"status",level:3},{value:"Returns",id:"returns-2",level:4},{value:"Source",id:"source-2",level:4},{value:"stop()",id:"stop",level:3},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-3",level:4},{value:"Source",id:"source-3",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,i.a)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.h1,{id:"interface-providerlifecycle",children:"Interface: ProviderLifecycle"}),"\n",(0,r.jsx)(n.h2,{id:"methods",children:"Methods"}),"\n",(0,r.jsx)(n.h3,{id:"initialize",children:"initialize()?"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"optional"})})," ",(0,r.jsx)(n.strong,{children:"initialize"}),"(",(0,r.jsx)(n.code,{children:"initContext"}),"): ",(0,r.jsx)(n.code,{children:"Promise"}),"< ",(0,r.jsx)(n.code,{children:"void"})," >"]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"parameters",children:"Parameters"}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"initContext"}),": ",(0,r.jsx)(n.a,{href:"/api/interfaces/LifecycleContext",children:(0,r.jsx)(n.code,{children:"LifecycleContext"})})]}),"\n",(0,r.jsx)(n.h4,{id:"returns",children:"Returns"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"Promise"}),"< ",(0,r.jsx)(n.code,{children:"void"})," >"]}),"\n",(0,r.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L197",children:"packages/extension-api/src/extension-api.d.ts:197"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"start",children:"start()"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"start"}),"(",(0,r.jsx)(n.code,{children:"startContext"}),"): ",(0,r.jsx)(n.code,{children:"Promise"}),"< ",(0,r.jsx)(n.code,{children:"void"})," >"]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"parameters-1",children:"Parameters"}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"startContext"}),": ",(0,r.jsx)(n.a,{href:"/api/interfaces/LifecycleContext",children:(0,r.jsx)(n.code,{children:"LifecycleContext"})})]}),"\n",(0,r.jsx)(n.h4,{id:"returns-1",children:"Returns"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"Promise"}),"< ",(0,r.jsx)(n.code,{children:"void"})," >"]}),"\n",(0,r.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L198",children:"packages/extension-api/src/extension-api.d.ts:198"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"status",children:"status()"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"status"}),"(): ",(0,r.jsx)(n.a,{href:"/api/type-aliases/ProviderStatus",children:(0,r.jsx)(n.code,{children:"ProviderStatus"})})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"returns-2",children:"Returns"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"/api/type-aliases/ProviderStatus",children:(0,r.jsx)(n.code,{children:"ProviderStatus"})})}),"\n",(0,r.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L200",children:"packages/extension-api/src/extension-api.d.ts:200"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"stop",children:"stop()"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"stop"}),"(",(0,r.jsx)(n.code,{children:"stopContext"}),"): ",(0,r.jsx)(n.code,{children:"Promise"}),"< ",(0,r.jsx)(n.code,{children:"void"})," >"]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"parameters-2",children:"Parameters"}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"stopContext"}),": ",(0,r.jsx)(n.a,{href:"/api/interfaces/LifecycleContext",children:(0,r.jsx)(n.code,{children:"LifecycleContext"})})]}),"\n",(0,r.jsx)(n.h4,{id:"returns-3",children:"Returns"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"Promise"}),"< ",(0,r.jsx)(n.code,{children:"void"})," >"]}),"\n",(0,r.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/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,i.a)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(l,{...e})}):l(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>o,a:()=>c});var r=s(27378);const i={},t=r.createContext(i);function c(e){const n=r.useContext(t);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:c(e.components),r.createElement(t.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[955],{74605:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>o,contentTitle:()=>c,default:()=>h,frontMatter:()=>t,metadata:()=>d,toc:()=>l});var r=s(24246),i=s(71670);const t={},c="Interface: ProviderLifecycle",d={id:"interfaces/ProviderLifecycle",title:"Interface: ProviderLifecycle",description:"Methods",source:"@site/api/interfaces/ProviderLifecycle.md",sourceDirName:"interfaces",slug:"/interfaces/ProviderLifecycle",permalink:"/api/interfaces/ProviderLifecycle",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: ProviderInstallation",permalink:"/api/interfaces/ProviderInstallation"},next:{title:"Interface: ProviderOptions",permalink:"/api/interfaces/ProviderOptions"}},o={},l=[{value:"Methods",id:"methods",level:2},{value:"initialize()?",id:"initialize",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Source",id:"source",level:4},{value:"start()",id:"start",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Source",id:"source-1",level:4},{value:"status()",id:"status",level:3},{value:"Returns",id:"returns-2",level:4},{value:"Source",id:"source-2",level:4},{value:"stop()",id:"stop",level:3},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-3",level:4},{value:"Source",id:"source-3",level:4}];function a(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,i.a)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.h1,{id:"interface-providerlifecycle",children:"Interface: ProviderLifecycle"}),"\n",(0,r.jsx)(n.h2,{id:"methods",children:"Methods"}),"\n",(0,r.jsx)(n.h3,{id:"initialize",children:"initialize()?"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"optional"})})," ",(0,r.jsx)(n.strong,{children:"initialize"}),"(",(0,r.jsx)(n.code,{children:"initContext"}),"): ",(0,r.jsx)(n.code,{children:"Promise"}),"< ",(0,r.jsx)(n.code,{children:"void"})," >"]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"parameters",children:"Parameters"}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"initContext"}),": ",(0,r.jsx)(n.a,{href:"/api/interfaces/LifecycleContext",children:(0,r.jsx)(n.code,{children:"LifecycleContext"})})]}),"\n",(0,r.jsx)(n.h4,{id:"returns",children:"Returns"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"Promise"}),"< ",(0,r.jsx)(n.code,{children:"void"})," >"]}),"\n",(0,r.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L197",children:"packages/extension-api/src/extension-api.d.ts:197"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"start",children:"start()"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"start"}),"(",(0,r.jsx)(n.code,{children:"startContext"}),"): ",(0,r.jsx)(n.code,{children:"Promise"}),"< ",(0,r.jsx)(n.code,{children:"void"})," >"]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"parameters-1",children:"Parameters"}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"startContext"}),": ",(0,r.jsx)(n.a,{href:"/api/interfaces/LifecycleContext",children:(0,r.jsx)(n.code,{children:"LifecycleContext"})})]}),"\n",(0,r.jsx)(n.h4,{id:"returns-1",children:"Returns"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"Promise"}),"< ",(0,r.jsx)(n.code,{children:"void"})," >"]}),"\n",(0,r.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L198",children:"packages/extension-api/src/extension-api.d.ts:198"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"status",children:"status()"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"status"}),"(): ",(0,r.jsx)(n.a,{href:"/api/type-aliases/ProviderStatus",children:(0,r.jsx)(n.code,{children:"ProviderStatus"})})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"returns-2",children:"Returns"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"/api/type-aliases/ProviderStatus",children:(0,r.jsx)(n.code,{children:"ProviderStatus"})})}),"\n",(0,r.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L200",children:"packages/extension-api/src/extension-api.d.ts:200"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"stop",children:"stop()"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"stop"}),"(",(0,r.jsx)(n.code,{children:"stopContext"}),"): ",(0,r.jsx)(n.code,{children:"Promise"}),"< ",(0,r.jsx)(n.code,{children:"void"})," >"]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"parameters-2",children:"Parameters"}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"stopContext"}),": ",(0,r.jsx)(n.a,{href:"/api/interfaces/LifecycleContext",children:(0,r.jsx)(n.code,{children:"LifecycleContext"})})]}),"\n",(0,r.jsx)(n.h4,{id:"returns-3",children:"Returns"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"Promise"}),"< ",(0,r.jsx)(n.code,{children:"void"})," >"]}),"\n",(0,r.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/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,i.a)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(a,{...e})}):a(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>d,a:()=>c});var r=s(27378);const i={},t=r.createContext(i);function c(e){const n=r.useContext(t);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function d(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:c(e.components),r.createElement(t.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/3a38a610.d8ef876e.js b/assets/js/3a38a610.c2f3b4bc.js similarity index 81% rename from assets/js/3a38a610.d8ef876e.js rename to assets/js/3a38a610.c2f3b4bc.js index 9d7a1b8922e..ca0582d2afc 100644 --- a/assets/js/3a38a610.d8ef876e.js +++ b/assets/js/3a38a610.c2f3b4bc.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[91721],{38889:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>d,contentTitle:()=>o,default:()=>h,frontMatter:()=>r,metadata:()=>t,toc:()=>a});var i=s(24246),c=s(71670);const r={},o="Interface: ImageInfo",t={id:"interfaces/ImageInfo",title:"Interface: ImageInfo",description:"Properties",source:"@site/api/interfaces/ImageInfo.md",sourceDirName:"interfaces",slug:"/interfaces/ImageInfo",permalink:"/api/interfaces/ImageInfo",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: ImageChecks",permalink:"/api/interfaces/ImageChecks"},next:{title:"Interface: ImageInspectInfo",permalink:"/api/interfaces/ImageInspectInfo"}},d={},a=[{value:"Properties",id:"properties",level:2},{value:"Containers",id:"containers",level:3},{value:"Source",id:"source",level:4},{value:"Created",id:"created",level:3},{value:"Source",id:"source-1",level:4},{value:"History?",id:"history",level:3},{value:"Source",id:"source-2",level:4},{value:"Id",id:"id",level:3},{value:"Source",id:"source-3",level:4},{value:"Labels",id:"labels",level:3},{value:"Index signature",id:"index-signature",level:4},{value:"Source",id:"source-4",level:4},{value:"ParentId",id:"parentid",level:3},{value:"Source",id:"source-5",level:4},{value:"RepoDigests?",id:"repodigests",level:3},{value:"Source",id:"source-6",level:4},{value:"RepoTags",id:"repotags",level:3},{value:"Source",id:"source-7",level:4},{value:"SharedSize",id:"sharedsize",level:3},{value:"Source",id:"source-8",level:4},{value:"Size",id:"size",level:3},{value:"Source",id:"source-9",level:4},{value:"VirtualSize",id:"virtualsize",level:3},{value:"Source",id:"source-10",level:4},{value:"engineId",id:"engineid",level:3},{value:"Source",id:"source-11",level:4},{value:"engineName",id:"enginename",level:3},{value:"Source",id:"source-12",level:4},{value:"isManifest?",id:"ismanifest",level:3},{value:"Source",id:"source-13",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,c.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"interface-imageinfo",children:"Interface: ImageInfo"}),"\n",(0,i.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(n.h3,{id:"containers",children:"Containers"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Containers"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L1869",children:"packages/extension-api/src/extension-api.d.ts:1869"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"created",children:"Created"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Created"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L1864",children:"packages/extension-api/src/extension-api.d.ts:1864"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"history",children:"History?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"History"}),": ",(0,i.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L1870",children:"packages/extension-api/src/extension-api.d.ts:1870"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"id",children:"Id"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Id"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L1860",children:"packages/extension-api/src/extension-api.d.ts:1860"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"labels",children:"Labels"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Labels"}),": ",(0,i.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"index-signature",children:"Index signature"}),"\n",(0,i.jsxs)(n.p,{children:["[",(0,i.jsx)(n.code,{children:"label"}),": ",(0,i.jsx)(n.code,{children:"string"}),"]: ",(0,i.jsx)(n.code,{children:"string"})]}),"\n",(0,i.jsx)(n.h4,{id:"source-4",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L1868",children:"packages/extension-api/src/extension-api.d.ts:1868"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"parentid",children:"ParentId"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"ParentId"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-5",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L1861",children:"packages/extension-api/src/extension-api.d.ts:1861"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"repodigests",children:"RepoDigests?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"RepoDigests"}),": ",(0,i.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-6",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L1863",children:"packages/extension-api/src/extension-api.d.ts:1863"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"repotags",children:"RepoTags"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"RepoTags"}),": ",(0,i.jsx)(n.code,{children:"undefined"})," | ",(0,i.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-7",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L1862",children:"packages/extension-api/src/extension-api.d.ts:1862"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"sharedsize",children:"SharedSize"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"SharedSize"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-8",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L1867",children:"packages/extension-api/src/extension-api.d.ts:1867"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"size",children:"Size"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Size"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-9",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L1865",children:"packages/extension-api/src/extension-api.d.ts:1865"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"virtualsize",children:"VirtualSize"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"VirtualSize"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-10",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L1866",children:"packages/extension-api/src/extension-api.d.ts:1866"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"engineid",children:"engineId"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"engineId"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-11",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L1858",children:"packages/extension-api/src/extension-api.d.ts:1858"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"enginename",children:"engineName"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"engineName"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-12",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L1859",children:"packages/extension-api/src/extension-api.d.ts:1859"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"ismanifest",children:"isManifest?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"isManifest"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-13",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L1873",children:"packages/extension-api/src/extension-api.d.ts:1873"})})]})}function h(e={}){const{wrapper:n}={...(0,c.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>t,a:()=>o});var i=s(27378);const c={},r=i.createContext(c);function o(e){const n=i.useContext(r);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function t(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(c):e.components||c:o(e.components),i.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[91721],{38889:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>t,contentTitle:()=>d,default:()=>h,frontMatter:()=>r,metadata:()=>o,toc:()=>a});var i=s(24246),c=s(71670);const r={},d="Interface: ImageInfo",o={id:"interfaces/ImageInfo",title:"Interface: ImageInfo",description:"Properties",source:"@site/api/interfaces/ImageInfo.md",sourceDirName:"interfaces",slug:"/interfaces/ImageInfo",permalink:"/api/interfaces/ImageInfo",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: ImageChecks",permalink:"/api/interfaces/ImageChecks"},next:{title:"Interface: ImageInspectInfo",permalink:"/api/interfaces/ImageInspectInfo"}},t={},a=[{value:"Properties",id:"properties",level:2},{value:"Containers",id:"containers",level:3},{value:"Source",id:"source",level:4},{value:"Created",id:"created",level:3},{value:"Source",id:"source-1",level:4},{value:"History?",id:"history",level:3},{value:"Source",id:"source-2",level:4},{value:"Id",id:"id",level:3},{value:"Source",id:"source-3",level:4},{value:"Labels",id:"labels",level:3},{value:"Index signature",id:"index-signature",level:4},{value:"Source",id:"source-4",level:4},{value:"ParentId",id:"parentid",level:3},{value:"Source",id:"source-5",level:4},{value:"RepoDigests?",id:"repodigests",level:3},{value:"Source",id:"source-6",level:4},{value:"RepoTags",id:"repotags",level:3},{value:"Source",id:"source-7",level:4},{value:"SharedSize",id:"sharedsize",level:3},{value:"Source",id:"source-8",level:4},{value:"Size",id:"size",level:3},{value:"Source",id:"source-9",level:4},{value:"VirtualSize",id:"virtualsize",level:3},{value:"Source",id:"source-10",level:4},{value:"engineId",id:"engineid",level:3},{value:"Source",id:"source-11",level:4},{value:"engineName",id:"enginename",level:3},{value:"Source",id:"source-12",level:4},{value:"isManifest?",id:"ismanifest",level:3},{value:"Source",id:"source-13",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,c.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"interface-imageinfo",children:"Interface: ImageInfo"}),"\n",(0,i.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(n.h3,{id:"containers",children:"Containers"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Containers"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L1869",children:"packages/extension-api/src/extension-api.d.ts:1869"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"created",children:"Created"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Created"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L1864",children:"packages/extension-api/src/extension-api.d.ts:1864"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"history",children:"History?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"History"}),": ",(0,i.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L1870",children:"packages/extension-api/src/extension-api.d.ts:1870"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"id",children:"Id"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Id"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L1860",children:"packages/extension-api/src/extension-api.d.ts:1860"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"labels",children:"Labels"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Labels"}),": ",(0,i.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"index-signature",children:"Index signature"}),"\n",(0,i.jsxs)(n.p,{children:["[",(0,i.jsx)(n.code,{children:"label"}),": ",(0,i.jsx)(n.code,{children:"string"}),"]: ",(0,i.jsx)(n.code,{children:"string"})]}),"\n",(0,i.jsx)(n.h4,{id:"source-4",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L1868",children:"packages/extension-api/src/extension-api.d.ts:1868"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"parentid",children:"ParentId"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"ParentId"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-5",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L1861",children:"packages/extension-api/src/extension-api.d.ts:1861"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"repodigests",children:"RepoDigests?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"RepoDigests"}),": ",(0,i.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-6",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L1863",children:"packages/extension-api/src/extension-api.d.ts:1863"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"repotags",children:"RepoTags"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"RepoTags"}),": ",(0,i.jsx)(n.code,{children:"undefined"})," | ",(0,i.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-7",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L1862",children:"packages/extension-api/src/extension-api.d.ts:1862"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"sharedsize",children:"SharedSize"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"SharedSize"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-8",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L1867",children:"packages/extension-api/src/extension-api.d.ts:1867"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"size",children:"Size"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Size"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-9",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L1865",children:"packages/extension-api/src/extension-api.d.ts:1865"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"virtualsize",children:"VirtualSize"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"VirtualSize"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-10",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L1866",children:"packages/extension-api/src/extension-api.d.ts:1866"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"engineid",children:"engineId"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"engineId"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-11",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L1858",children:"packages/extension-api/src/extension-api.d.ts:1858"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"enginename",children:"engineName"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"engineName"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-12",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L1859",children:"packages/extension-api/src/extension-api.d.ts:1859"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"ismanifest",children:"isManifest?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"isManifest"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-13",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L1873",children:"packages/extension-api/src/extension-api.d.ts:1873"})})]})}function h(e={}){const{wrapper:n}={...(0,c.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>o,a:()=>d});var i=s(27378);const c={},r=i.createContext(c);function d(e){const n=i.useContext(r);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(c):e.components||c:d(e.components),i.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/3ba80b69.6a2248b1.js b/assets/js/3ba80b69.b9e2e547.js similarity index 81% rename from assets/js/3ba80b69.6a2248b1.js rename to assets/js/3ba80b69.b9e2e547.js index d50153cef99..14e1c98380c 100644 --- a/assets/js/3ba80b69.6a2248b1.js +++ b/assets/js/3ba80b69.b9e2e547.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[3408],{1266:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>i,default:()=>d,frontMatter:()=>r,metadata:()=>o,toc:()=>l});var s=t(24246),c=t(71670);const r={},i="Interface: HealthCheckLog",o={id:"interfaces/HealthCheckLog",title:"Interface: HealthCheckLog",description:"HealthCheckLog describes the results of a single healthcheck",source:"@site/api/interfaces/HealthCheckLog.md",sourceDirName:"interfaces",slug:"/interfaces/HealthCheckLog",permalink:"/api/interfaces/HealthCheckLog",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: GenerateKubeResult",permalink:"/api/interfaces/GenerateKubeResult"},next:{title:"Interface: HealthCheckResults",permalink:"/api/interfaces/HealthCheckResults"}},a={},l=[{value:"Properties",id:"properties",level:2},{value:"End",id:"end",level:3},{value:"Source",id:"source",level:4},{value:"ExitCode",id:"exitcode",level:3},{value:"Source",id:"source-1",level:4},{value:"Output",id:"output",level:3},{value:"Source",id:"source-2",level:4},{value:"Start",id:"start",level:3},{value:"Source",id:"source-3",level:4}];function 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,c.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"interface-healthchecklog",children:"Interface: HealthCheckLog"}),"\n",(0,s.jsx)(n.p,{children:"HealthCheckLog describes the results of a single healthcheck"}),"\n",(0,s.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,s.jsx)(n.h3,{id:"end",children:"End"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"End"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"End time as a string"}),"\n",(0,s.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2230",children:"packages/extension-api/src/extension-api.d.ts:2230"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"exitcode",children:"ExitCode"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"ExitCode"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Exitcode is 0 or 1"}),"\n",(0,s.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/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:"output",children:"Output"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Output"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Output is the stdout/stderr from the healthcheck command"}),"\n",(0,s.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2238",children:"packages/extension-api/src/extension-api.d.ts:2238"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"start",children:"Start"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Start"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Start time as string"}),"\n",(0,s.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2226",children:"packages/extension-api/src/extension-api.d.ts:2226"})})]})}function d(e={}){const{wrapper:n}={...(0,c.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:()=>o,a:()=>i});var s=t(27378);const c={},r=s.createContext(c);function i(e){const n=s.useContext(r);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(c):e.components||c:i(e.components),s.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[3408],{1266:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>i,default:()=>h,frontMatter:()=>r,metadata:()=>o,toc:()=>d});var s=t(24246),c=t(71670);const r={},i="Interface: HealthCheckLog",o={id:"interfaces/HealthCheckLog",title:"Interface: HealthCheckLog",description:"HealthCheckLog describes the results of a single healthcheck",source:"@site/api/interfaces/HealthCheckLog.md",sourceDirName:"interfaces",slug:"/interfaces/HealthCheckLog",permalink:"/api/interfaces/HealthCheckLog",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: GenerateKubeResult",permalink:"/api/interfaces/GenerateKubeResult"},next:{title:"Interface: HealthCheckResults",permalink:"/api/interfaces/HealthCheckResults"}},a={},d=[{value:"Properties",id:"properties",level:2},{value:"End",id:"end",level:3},{value:"Source",id:"source",level:4},{value:"ExitCode",id:"exitcode",level:3},{value:"Source",id:"source-1",level:4},{value:"Output",id:"output",level:3},{value:"Source",id:"source-2",level:4},{value:"Start",id:"start",level:3},{value:"Source",id:"source-3",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,c.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"interface-healthchecklog",children:"Interface: HealthCheckLog"}),"\n",(0,s.jsx)(n.p,{children:"HealthCheckLog describes the results of a single healthcheck"}),"\n",(0,s.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,s.jsx)(n.h3,{id:"end",children:"End"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"End"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"End time as a string"}),"\n",(0,s.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2230",children:"packages/extension-api/src/extension-api.d.ts:2230"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"exitcode",children:"ExitCode"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"ExitCode"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Exitcode is 0 or 1"}),"\n",(0,s.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/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:"output",children:"Output"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Output"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Output is the stdout/stderr from the healthcheck command"}),"\n",(0,s.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2238",children:"packages/extension-api/src/extension-api.d.ts:2238"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"start",children:"Start"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Start"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Start time as string"}),"\n",(0,s.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2226",children:"packages/extension-api/src/extension-api.d.ts:2226"})})]})}function h(e={}){const{wrapper:n}={...(0,c.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>o,a:()=>i});var s=t(27378);const c={},r=s.createContext(c);function i(e){const n=s.useContext(r);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(c):e.components||c:i(e.components),s.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/3e2b82eb.67b26f21.js b/assets/js/3e2b82eb.bc92317e.js similarity index 89% rename from assets/js/3e2b82eb.67b26f21.js rename to assets/js/3e2b82eb.bc92317e.js index 4e5fc7a751d..a91a7c1b2cf 100644 --- a/assets/js/3e2b82eb.67b26f21.js +++ b/assets/js/3e2b82eb.bc92317e.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[40683],{18825:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>r,contentTitle:()=>a,default:()=>l,frontMatter:()=>i,metadata:()=>c,toc:()=>u});var o=t(24246),s=t(71670);const i={},a="Function: navigateToVolume()",c={id:"namespaces/navigation/functions/navigateToVolume",title:"Function: navigateToVolume()",description:"navigateToVolume(name, engineId): Promise\\",source:"@site/api/namespaces/navigation/functions/navigateToVolume.md",sourceDirName:"namespaces/navigation/functions",slug:"/namespaces/navigation/functions/navigateToVolume",permalink:"/api/namespaces/navigation/functions/navigateToVolume",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Function: navigateToResources()",permalink:"/api/namespaces/navigation/functions/navigateToResources"},next:{title:"Function: navigateToVolumes()",permalink:"/api/namespaces/navigation/functions/navigateToVolumes"}},r={},u=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function d(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(n.h1,{id:"function-navigatetovolume",children:"Function: navigateToVolume()"}),"\n",(0,o.jsxs)(n.blockquote,{children:["\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.strong,{children:"navigateToVolume"}),"(",(0,o.jsx)(n.code,{children:"name"}),", ",(0,o.jsx)(n.code,{children:"engineId"}),"): ",(0,o.jsx)(n.code,{children:"Promise"}),"< ",(0,o.jsx)(n.code,{children:"void"})," >"]}),"\n"]}),"\n",(0,o.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,o.jsxs)(n.p,{children:["\u2022 ",(0,o.jsx)(n.strong,{children:"name"}),": ",(0,o.jsx)(n.code,{children:"string"})]}),"\n",(0,o.jsxs)(n.p,{children:["\u2022 ",(0,o.jsx)(n.strong,{children:"engineId"}),": ",(0,o.jsx)(n.code,{children:"string"})]}),"\n",(0,o.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.code,{children:"Promise"}),"< ",(0,o.jsx)(n.code,{children:"void"})," >"]}),"\n",(0,o.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,o.jsx)(n.p,{children:(0,o.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L4160",children:"packages/extension-api/src/extension-api.d.ts:4160"})})]})}function l(e={}){const{wrapper:n}={...(0,s.a)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(d,{...e})}):d(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>c,a:()=>a});var o=t(27378);const s={},i=o.createContext(s);function a(e){const n=o.useContext(i);return o.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:a(e.components),o.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[40683],{18825:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>r,contentTitle:()=>a,default:()=>l,frontMatter:()=>i,metadata:()=>c,toc:()=>d});var o=t(24246),s=t(71670);const i={},a="Function: navigateToVolume()",c={id:"namespaces/navigation/functions/navigateToVolume",title:"Function: navigateToVolume()",description:"navigateToVolume(name, engineId): Promise\\",source:"@site/api/namespaces/navigation/functions/navigateToVolume.md",sourceDirName:"namespaces/navigation/functions",slug:"/namespaces/navigation/functions/navigateToVolume",permalink:"/api/namespaces/navigation/functions/navigateToVolume",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Function: navigateToResources()",permalink:"/api/namespaces/navigation/functions/navigateToResources"},next:{title:"Function: navigateToVolumes()",permalink:"/api/namespaces/navigation/functions/navigateToVolumes"}},r={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function u(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(n.h1,{id:"function-navigatetovolume",children:"Function: navigateToVolume()"}),"\n",(0,o.jsxs)(n.blockquote,{children:["\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.strong,{children:"navigateToVolume"}),"(",(0,o.jsx)(n.code,{children:"name"}),", ",(0,o.jsx)(n.code,{children:"engineId"}),"): ",(0,o.jsx)(n.code,{children:"Promise"}),"< ",(0,o.jsx)(n.code,{children:"void"})," >"]}),"\n"]}),"\n",(0,o.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,o.jsxs)(n.p,{children:["\u2022 ",(0,o.jsx)(n.strong,{children:"name"}),": ",(0,o.jsx)(n.code,{children:"string"})]}),"\n",(0,o.jsxs)(n.p,{children:["\u2022 ",(0,o.jsx)(n.strong,{children:"engineId"}),": ",(0,o.jsx)(n.code,{children:"string"})]}),"\n",(0,o.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.code,{children:"Promise"}),"< ",(0,o.jsx)(n.code,{children:"void"})," >"]}),"\n",(0,o.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,o.jsx)(n.p,{children:(0,o.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L4160",children:"packages/extension-api/src/extension-api.d.ts:4160"})})]})}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:()=>c,a:()=>a});var o=t(27378);const s={},i=o.createContext(s);function a(e){const n=o.useContext(i);return o.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:a(e.components),o.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/3f66023b.17485265.js b/assets/js/3f66023b.6b74b140.js similarity index 84% rename from assets/js/3f66023b.17485265.js rename to assets/js/3f66023b.6b74b140.js index bd119bb80e2..48a4fc4dff9 100644 --- a/assets/js/3f66023b.17485265.js +++ b/assets/js/3f66023b.6b74b140.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[80161],{91442:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>d,contentTitle:()=>o,default:()=>h,frontMatter:()=>r,metadata:()=>t,toc:()=>a});var i=s(24246),c=s(71670);const r={},o="Interface: ContainerInfo",t={id:"interfaces/ContainerInfo",title:"Interface: ContainerInfo",description:"Properties",source:"@site/api/interfaces/ContainerInfo.md",sourceDirName:"interfaces",slug:"/interfaces/ContainerInfo",permalink:"/api/interfaces/ContainerInfo",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: ContainerEngineInfo",permalink:"/api/interfaces/ContainerEngineInfo"},next:{title:"Interface: ContainerInspectInfo",permalink:"/api/interfaces/ContainerInspectInfo"}},d={},a=[{value:"Properties",id:"properties",level:2},{value:"Command",id:"command",level:3},{value:"Source",id:"source",level:4},{value:"Created",id:"created",level:3},{value:"Source",id:"source-1",level:4},{value:"HostConfig",id:"hostconfig",level:3},{value:"NetworkMode",id:"networkmode",level:4},{value:"Source",id:"source-2",level:4},{value:"Id",id:"id",level:3},{value:"Source",id:"source-3",level:4},{value:"Image",id:"image",level:3},{value:"Source",id:"source-4",level:4},{value:"ImageID",id:"imageid",level:3},{value:"Source",id:"source-5",level:4},{value:"Labels",id:"labels",level:3},{value:"Index signature",id:"index-signature",level:4},{value:"Source",id:"source-6",level:4},{value:"Mounts",id:"mounts",level:3},{value:"Source",id:"source-7",level:4},{value:"Names",id:"names",level:3},{value:"Source",id:"source-8",level:4},{value:"NetworkSettings",id:"networksettings",level:3},{value:"Networks",id:"networks",level:4},{value:"Index signature",id:"index-signature-1",level:5},{value:"Source",id:"source-9",level:4},{value:"Ports",id:"ports",level:3},{value:"Source",id:"source-10",level:4},{value:"State",id:"state",level:3},{value:"Source",id:"source-11",level:4},{value:"Status",id:"status",level:3},{value:"Source",id:"source-12",level:4},{value:"engineId",id:"engineid",level:3},{value:"Source",id:"source-13",level:4},{value:"engineName",id:"enginename",level:3},{value:"Source",id:"source-14",level:4},{value:"engineType",id:"enginetype",level:3},{value:"Source",id:"source-15",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",h5:"h5",hr:"hr",p:"p",strong:"strong",...(0,c.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"interface-containerinfo",children:"Interface: ContainerInfo"}),"\n",(0,i.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(n.h3,{id:"command",children:"Command"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Command"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L1992",children:"packages/extension-api/src/extension-api.d.ts:1992"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"created",children:"Created"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Created"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L1993",children:"packages/extension-api/src/extension-api.d.ts:1993"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"hostconfig",children:"HostConfig"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"HostConfig"}),": ",(0,i.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"networkmode",children:"NetworkMode"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"NetworkMode"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L1998",children:"packages/extension-api/src/extension-api.d.ts:1998"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"id",children:"Id"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Id"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L1988",children:"packages/extension-api/src/extension-api.d.ts:1988"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"image",children:"Image"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Image"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-4",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L1990",children:"packages/extension-api/src/extension-api.d.ts:1990"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"imageid",children:"ImageID"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"ImageID"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-5",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L1991",children:"packages/extension-api/src/extension-api.d.ts:1991"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"labels",children:"Labels"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Labels"}),": ",(0,i.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"index-signature",children:"Index signature"}),"\n",(0,i.jsxs)(n.p,{children:["[",(0,i.jsx)(n.code,{children:"label"}),": ",(0,i.jsx)(n.code,{children:"string"}),"]: ",(0,i.jsx)(n.code,{children:"string"})]}),"\n",(0,i.jsx)(n.h4,{id:"source-6",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L1995",children:"packages/extension-api/src/extension-api.d.ts:1995"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"mounts",children:"Mounts"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Mounts"}),": ",(0,i.jsx)(n.code,{children:"object"}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-7",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2004",children:"packages/extension-api/src/extension-api.d.ts:2004"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"names",children:"Names"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Names"}),": ",(0,i.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-8",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L1989",children:"packages/extension-api/src/extension-api.d.ts:1989"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"networksettings",children:"NetworkSettings"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"NetworkSettings"}),": ",(0,i.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"networks",children:"Networks"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Networks"}),": ",(0,i.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsx)(n.h5,{id:"index-signature-1",children:"Index signature"}),"\n",(0,i.jsxs)(n.p,{children:["[",(0,i.jsx)(n.code,{children:"networkType"}),": ",(0,i.jsx)(n.code,{children:"string"}),"]: ",(0,i.jsx)(n.a,{href:"/api/interfaces/NetworkInfo",children:(0,i.jsx)(n.code,{children:"NetworkInfo"})})]}),"\n",(0,i.jsx)(n.h4,{id:"source-9",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2001",children:"packages/extension-api/src/extension-api.d.ts:2001"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"ports",children:"Ports"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Ports"}),": ",(0,i.jsx)(n.a,{href:"/api/interfaces/Port",children:(0,i.jsx)(n.code,{children:"Port"})}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-10",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L1994",children:"packages/extension-api/src/extension-api.d.ts:1994"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"state",children:"State"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"State"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-11",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L1996",children:"packages/extension-api/src/extension-api.d.ts:1996"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"status",children:"Status"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Status"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-12",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L1997",children:"packages/extension-api/src/extension-api.d.ts:1997"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"engineid",children:"engineId"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"engineId"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-13",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L1985",children:"packages/extension-api/src/extension-api.d.ts:1985"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"enginename",children:"engineName"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"engineName"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-14",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L1986",children:"packages/extension-api/src/extension-api.d.ts:1986"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"enginetype",children:"engineType"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"engineType"}),": ",(0,i.jsx)(n.code,{children:'"docker"'})," | ",(0,i.jsx)(n.code,{children:'"podman"'})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-15",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L1987",children:"packages/extension-api/src/extension-api.d.ts:1987"})})]})}function h(e={}){const{wrapper:n}={...(0,c.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>t,a:()=>o});var i=s(27378);const c={},r=i.createContext(c);function o(e){const n=i.useContext(r);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function t(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(c):e.components||c:o(e.components),i.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[80161],{91442:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>t,contentTitle:()=>o,default:()=>h,frontMatter:()=>r,metadata:()=>d,toc:()=>a});var i=s(24246),c=s(71670);const r={},o="Interface: ContainerInfo",d={id:"interfaces/ContainerInfo",title:"Interface: ContainerInfo",description:"Properties",source:"@site/api/interfaces/ContainerInfo.md",sourceDirName:"interfaces",slug:"/interfaces/ContainerInfo",permalink:"/api/interfaces/ContainerInfo",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: ContainerEngineInfo",permalink:"/api/interfaces/ContainerEngineInfo"},next:{title:"Interface: ContainerInspectInfo",permalink:"/api/interfaces/ContainerInspectInfo"}},t={},a=[{value:"Properties",id:"properties",level:2},{value:"Command",id:"command",level:3},{value:"Source",id:"source",level:4},{value:"Created",id:"created",level:3},{value:"Source",id:"source-1",level:4},{value:"HostConfig",id:"hostconfig",level:3},{value:"NetworkMode",id:"networkmode",level:4},{value:"Source",id:"source-2",level:4},{value:"Id",id:"id",level:3},{value:"Source",id:"source-3",level:4},{value:"Image",id:"image",level:3},{value:"Source",id:"source-4",level:4},{value:"ImageID",id:"imageid",level:3},{value:"Source",id:"source-5",level:4},{value:"Labels",id:"labels",level:3},{value:"Index signature",id:"index-signature",level:4},{value:"Source",id:"source-6",level:4},{value:"Mounts",id:"mounts",level:3},{value:"Source",id:"source-7",level:4},{value:"Names",id:"names",level:3},{value:"Source",id:"source-8",level:4},{value:"NetworkSettings",id:"networksettings",level:3},{value:"Networks",id:"networks",level:4},{value:"Index signature",id:"index-signature-1",level:5},{value:"Source",id:"source-9",level:4},{value:"Ports",id:"ports",level:3},{value:"Source",id:"source-10",level:4},{value:"State",id:"state",level:3},{value:"Source",id:"source-11",level:4},{value:"Status",id:"status",level:3},{value:"Source",id:"source-12",level:4},{value:"engineId",id:"engineid",level:3},{value:"Source",id:"source-13",level:4},{value:"engineName",id:"enginename",level:3},{value:"Source",id:"source-14",level:4},{value:"engineType",id:"enginetype",level:3},{value:"Source",id:"source-15",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",h5:"h5",hr:"hr",p:"p",strong:"strong",...(0,c.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"interface-containerinfo",children:"Interface: ContainerInfo"}),"\n",(0,i.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(n.h3,{id:"command",children:"Command"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Command"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L1992",children:"packages/extension-api/src/extension-api.d.ts:1992"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"created",children:"Created"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Created"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L1993",children:"packages/extension-api/src/extension-api.d.ts:1993"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"hostconfig",children:"HostConfig"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"HostConfig"}),": ",(0,i.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"networkmode",children:"NetworkMode"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"NetworkMode"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L1998",children:"packages/extension-api/src/extension-api.d.ts:1998"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"id",children:"Id"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Id"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L1988",children:"packages/extension-api/src/extension-api.d.ts:1988"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"image",children:"Image"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Image"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-4",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L1990",children:"packages/extension-api/src/extension-api.d.ts:1990"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"imageid",children:"ImageID"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"ImageID"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-5",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L1991",children:"packages/extension-api/src/extension-api.d.ts:1991"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"labels",children:"Labels"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Labels"}),": ",(0,i.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"index-signature",children:"Index signature"}),"\n",(0,i.jsxs)(n.p,{children:["[",(0,i.jsx)(n.code,{children:"label"}),": ",(0,i.jsx)(n.code,{children:"string"}),"]: ",(0,i.jsx)(n.code,{children:"string"})]}),"\n",(0,i.jsx)(n.h4,{id:"source-6",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L1995",children:"packages/extension-api/src/extension-api.d.ts:1995"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"mounts",children:"Mounts"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Mounts"}),": ",(0,i.jsx)(n.code,{children:"object"}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-7",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2004",children:"packages/extension-api/src/extension-api.d.ts:2004"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"names",children:"Names"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Names"}),": ",(0,i.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-8",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L1989",children:"packages/extension-api/src/extension-api.d.ts:1989"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"networksettings",children:"NetworkSettings"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"NetworkSettings"}),": ",(0,i.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"networks",children:"Networks"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Networks"}),": ",(0,i.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsx)(n.h5,{id:"index-signature-1",children:"Index signature"}),"\n",(0,i.jsxs)(n.p,{children:["[",(0,i.jsx)(n.code,{children:"networkType"}),": ",(0,i.jsx)(n.code,{children:"string"}),"]: ",(0,i.jsx)(n.a,{href:"/api/interfaces/NetworkInfo",children:(0,i.jsx)(n.code,{children:"NetworkInfo"})})]}),"\n",(0,i.jsx)(n.h4,{id:"source-9",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2001",children:"packages/extension-api/src/extension-api.d.ts:2001"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"ports",children:"Ports"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Ports"}),": ",(0,i.jsx)(n.a,{href:"/api/interfaces/Port",children:(0,i.jsx)(n.code,{children:"Port"})}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-10",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L1994",children:"packages/extension-api/src/extension-api.d.ts:1994"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"state",children:"State"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"State"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-11",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L1996",children:"packages/extension-api/src/extension-api.d.ts:1996"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"status",children:"Status"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Status"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-12",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L1997",children:"packages/extension-api/src/extension-api.d.ts:1997"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"engineid",children:"engineId"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"engineId"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-13",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L1985",children:"packages/extension-api/src/extension-api.d.ts:1985"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"enginename",children:"engineName"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"engineName"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-14",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L1986",children:"packages/extension-api/src/extension-api.d.ts:1986"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"enginetype",children:"engineType"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"engineType"}),": ",(0,i.jsx)(n.code,{children:'"docker"'})," | ",(0,i.jsx)(n.code,{children:'"podman"'})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-15",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L1987",children:"packages/extension-api/src/extension-api.d.ts:1987"})})]})}function h(e={}){const{wrapper:n}={...(0,c.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>d,a:()=>o});var i=s(27378);const c={},r=i.createContext(c);function o(e){const n=i.useContext(r);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function d(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(c):e.components||c:o(e.components),i.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/3f797343.14381b38.js b/assets/js/3f797343.9695e3da.js similarity index 82% rename from assets/js/3f797343.14381b38.js rename to assets/js/3f797343.9695e3da.js index e293e5e5d87..dcf64cf06c9 100644 --- a/assets/js/3f797343.14381b38.js +++ b/assets/js/3f797343.9695e3da.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[85632],{97814:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>a,contentTitle:()=>c,default:()=>p,frontMatter:()=>i,metadata:()=>s,toc:()=>l});var t=r(24246),o=r(71670);const i={},c="Interface: ProviderCleanupExecuteOptions",s={id:"interfaces/ProviderCleanupExecuteOptions",title:"Interface: ProviderCleanupExecuteOptions",description:"Properties",source:"@site/api/interfaces/ProviderCleanupExecuteOptions.md",sourceDirName:"interfaces",slug:"/interfaces/ProviderCleanupExecuteOptions",permalink:"/api/interfaces/ProviderCleanupExecuteOptions",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: ProviderCleanupAction",permalink:"/api/interfaces/ProviderCleanupAction"},next:{title:"Interface: ProviderConnectionFactory",permalink:"/api/interfaces/ProviderConnectionFactory"}},a={},l=[{value:"Properties",id:"properties",level:2},{value:"logger",id:"logger",level:3},{value:"Source",id:"source",level:4},{value:"token?",id:"token",level:3},{value:"Source",id:"source-1",level:4}];function d(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,o.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"interface-providercleanupexecuteoptions",children:"Interface: ProviderCleanupExecuteOptions"}),"\n",(0,t.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,t.jsx)(n.h3,{id:"logger",children:"logger"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"logger"}),": ",(0,t.jsx)(n.a,{href:"/api/interfaces/Logger",children:(0,t.jsx)(n.code,{children:"Logger"})})]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L407",children:"packages/extension-api/src/extension-api.d.ts:407"})}),"\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.strong,{children:(0,t.jsx)(n.code,{children:"optional"})})," ",(0,t.jsx)(n.strong,{children:"token"}),": ",(0,t.jsx)(n.a,{href:"/api/interfaces/CancellationToken",children:(0,t.jsx)(n.code,{children:"CancellationToken"})})]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L408",children:"packages/extension-api/src/extension-api.d.ts:408"})})]})}function p(e={}){const{wrapper:n}={...(0,o.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(d,{...e})}):d(e)}},71670:(e,n,r)=>{r.d(n,{Z:()=>s,a:()=>c});var t=r(27378);const o={},i=t.createContext(o);function c(e){const n=t.useContext(i);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function s(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:c(e.components),t.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[85632],{97814:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>a,contentTitle:()=>c,default:()=>p,frontMatter:()=>i,metadata:()=>s,toc:()=>d});var t=r(24246),o=r(71670);const i={},c="Interface: ProviderCleanupExecuteOptions",s={id:"interfaces/ProviderCleanupExecuteOptions",title:"Interface: ProviderCleanupExecuteOptions",description:"Properties",source:"@site/api/interfaces/ProviderCleanupExecuteOptions.md",sourceDirName:"interfaces",slug:"/interfaces/ProviderCleanupExecuteOptions",permalink:"/api/interfaces/ProviderCleanupExecuteOptions",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: ProviderCleanupAction",permalink:"/api/interfaces/ProviderCleanupAction"},next:{title:"Interface: ProviderConnectionFactory",permalink:"/api/interfaces/ProviderConnectionFactory"}},a={},d=[{value:"Properties",id:"properties",level:2},{value:"logger",id:"logger",level:3},{value:"Source",id:"source",level:4},{value:"token?",id:"token",level:3},{value:"Source",id:"source-1",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,o.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"interface-providercleanupexecuteoptions",children:"Interface: ProviderCleanupExecuteOptions"}),"\n",(0,t.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,t.jsx)(n.h3,{id:"logger",children:"logger"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"logger"}),": ",(0,t.jsx)(n.a,{href:"/api/interfaces/Logger",children:(0,t.jsx)(n.code,{children:"Logger"})})]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L407",children:"packages/extension-api/src/extension-api.d.ts:407"})}),"\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.strong,{children:(0,t.jsx)(n.code,{children:"optional"})})," ",(0,t.jsx)(n.strong,{children:"token"}),": ",(0,t.jsx)(n.a,{href:"/api/interfaces/CancellationToken",children:(0,t.jsx)(n.code,{children:"CancellationToken"})})]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L408",children:"packages/extension-api/src/extension-api.d.ts:408"})})]})}function p(e={}){const{wrapper:n}={...(0,o.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},71670:(e,n,r)=>{r.d(n,{Z:()=>s,a:()=>c});var t=r(27378);const o={},i=t.createContext(o);function c(e){const n=t.useContext(i);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function s(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:c(e.components),t.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/40d377be.f82b3048.js b/assets/js/40d377be.555a9011.js similarity index 91% rename from assets/js/40d377be.f82b3048.js rename to assets/js/40d377be.555a9011.js index ee8ea7509d2..ca79d954d74 100644 --- a/assets/js/40d377be.f82b3048.js +++ b/assets/js/40d377be.555a9011.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[14077],{61634:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>a,contentTitle:()=>c,default:()=>p,frontMatter:()=>t,metadata:()=>o,toc:()=>d});var i=s(24246),r=s(71670);const t={},c="Interface: ManifestCreateOptions",o={id:"interfaces/ManifestCreateOptions",title:"Interface: ManifestCreateOptions",description:"Properties",source:"@site/api/interfaces/ManifestCreateOptions.md",sourceDirName:"interfaces",slug:"/interfaces/ManifestCreateOptions",permalink:"/api/interfaces/ManifestCreateOptions",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: Logger",permalink:"/api/interfaces/Logger"},next:{title:"Interface: MemoryStats",permalink:"/api/interfaces/MemoryStats"}},a={},d=[{value:"Properties",id:"properties",level:2},{value:"all?",id:"all",level:3},{value:"Source",id:"source",level:4},{value:"amend?",id:"amend",level:3},{value:"Source",id:"source-1",level:4},{value:"images",id:"images",level:3},{value:"Source",id:"source-2",level:4},{value:"name",id:"name",level:3},{value:"Source",id:"source-3",level:4},{value:"provider?",id:"provider",level:3},{value:"Source",id:"source-4",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,r.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"interface-manifestcreateoptions",children:"Interface: ManifestCreateOptions"}),"\n",(0,i.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(n.h3,{id:"all",children:"all?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"all"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L292",children:"packages/extension-api/src/extension-api.d.ts:292"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"amend",children:"amend?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"amend"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L291",children:"packages/extension-api/src/extension-api.d.ts:291"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"images",children:"images"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"images"}),": ",(0,i.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L289",children:"packages/extension-api/src/extension-api.d.ts:289"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"name",children:"name"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"name"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L290",children:"packages/extension-api/src/extension-api.d.ts:290"})}),"\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.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"provider"}),": ",(0,i.jsx)(n.a,{href:"/api/interfaces/ContainerProviderConnection",children:(0,i.jsx)(n.code,{children:"ContainerProviderConnection"})})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-4",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L295",children:"packages/extension-api/src/extension-api.d.ts:295"})})]})}function p(e={}){const{wrapper:n}={...(0,r.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>o,a:()=>c});var i=s(27378);const r={},t=i.createContext(r);function c(e){const n=i.useContext(t);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:c(e.components),i.createElement(t.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[14077],{61634:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>a,contentTitle:()=>c,default:()=>p,frontMatter:()=>t,metadata:()=>o,toc:()=>d});var i=s(24246),r=s(71670);const t={},c="Interface: ManifestCreateOptions",o={id:"interfaces/ManifestCreateOptions",title:"Interface: ManifestCreateOptions",description:"Properties",source:"@site/api/interfaces/ManifestCreateOptions.md",sourceDirName:"interfaces",slug:"/interfaces/ManifestCreateOptions",permalink:"/api/interfaces/ManifestCreateOptions",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: Logger",permalink:"/api/interfaces/Logger"},next:{title:"Interface: MemoryStats",permalink:"/api/interfaces/MemoryStats"}},a={},d=[{value:"Properties",id:"properties",level:2},{value:"all?",id:"all",level:3},{value:"Source",id:"source",level:4},{value:"amend?",id:"amend",level:3},{value:"Source",id:"source-1",level:4},{value:"images",id:"images",level:3},{value:"Source",id:"source-2",level:4},{value:"name",id:"name",level:3},{value:"Source",id:"source-3",level:4},{value:"provider?",id:"provider",level:3},{value:"Source",id:"source-4",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,r.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"interface-manifestcreateoptions",children:"Interface: ManifestCreateOptions"}),"\n",(0,i.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(n.h3,{id:"all",children:"all?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"all"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L292",children:"packages/extension-api/src/extension-api.d.ts:292"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"amend",children:"amend?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"amend"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L291",children:"packages/extension-api/src/extension-api.d.ts:291"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"images",children:"images"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"images"}),": ",(0,i.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L289",children:"packages/extension-api/src/extension-api.d.ts:289"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"name",children:"name"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"name"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L290",children:"packages/extension-api/src/extension-api.d.ts:290"})}),"\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.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"provider"}),": ",(0,i.jsx)(n.a,{href:"/api/interfaces/ContainerProviderConnection",children:(0,i.jsx)(n.code,{children:"ContainerProviderConnection"})})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-4",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L295",children:"packages/extension-api/src/extension-api.d.ts:295"})})]})}function p(e={}){const{wrapper:n}={...(0,r.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>o,a:()=>c});var i=s(27378);const r={},t=i.createContext(r);function c(e){const n=i.useContext(t);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:c(e.components),i.createElement(t.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/416d4fcf.1c0e95c6.js b/assets/js/416d4fcf.12805bec.js similarity index 90% rename from assets/js/416d4fcf.1c0e95c6.js rename to assets/js/416d4fcf.12805bec.js index 93f51397928..331201040d8 100644 --- a/assets/js/416d4fcf.1c0e95c6.js +++ b/assets/js/416d4fcf.12805bec.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[44422],{66030:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>s,contentTitle:()=>o,default:()=>p,frontMatter:()=>a,metadata:()=>c,toc:()=>l});var i=t(24246),r=t(71670);const a={},o="Interface: ContainerCreateResult",c={id:"interfaces/ContainerCreateResult",title:"Interface: ContainerCreateResult",description:"Information about the container created by calling the containerEngine.createContainer method",source:"@site/api/interfaces/ContainerCreateResult.md",sourceDirName:"interfaces",slug:"/interfaces/ContainerCreateResult",permalink:"/api/interfaces/ContainerCreateResult",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: ContainerCreateOptions",permalink:"/api/interfaces/ContainerCreateOptions"},next:{title:"Interface: ContainerEngineInfo",permalink:"/api/interfaces/ContainerEngineInfo"}},s={},l=[{value:"Properties",id:"properties",level:2},{value:"id",id:"id",level:3},{value:"Source",id:"source",level:4}];function d(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",p:"p",strong:"strong",...(0,r.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"interface-containercreateresult",children:"Interface: ContainerCreateResult"}),"\n",(0,i.jsxs)(n.p,{children:["Information about the container created by calling the ",(0,i.jsx)(n.a,{href:"/api/namespaces/containerEngine/functions/createContainer",children:"containerEngine.createContainer"})," method"]}),"\n",(0,i.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(n.h3,{id:"id",children:"id"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"id"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["a string uniquely identifying the created container, which can be used to execute other methods on the container (",(0,i.jsx)(n.a,{href:"/api/namespaces/containerEngine/functions/deleteContainer",children:"containerEngine.deleteContainer"}),", ",(0,i.jsx)(n.a,{href:"/api/namespaces/containerEngine/functions/inspectContainer",children:"containerEngine.inspectContainer"}),", ",(0,i.jsx)(n.a,{href:"/api/namespaces/containerEngine/functions/startContainer",children:"containerEngine.startContainer"}),", ",(0,i.jsx)(n.a,{href:"/api/namespaces/containerEngine/functions/stopContainer",children:"containerEngine.stopContainer"}),", ",(0,i.jsx)(n.a,{href:"/api/namespaces/containerEngine/functions/logsContainer",children:"containerEngine.logsContainer"}),")"]}),"\n",(0,i.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2749",children:"packages/extension-api/src/extension-api.d.ts:2749"})})]})}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:()=>c,a:()=>o});var i=t(27378);const r={},a=i.createContext(r);function o(e){const n=i.useContext(a);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:o(e.components),i.createElement(a.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[44422],{66030:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>s,contentTitle:()=>o,default:()=>p,frontMatter:()=>a,metadata:()=>c,toc:()=>d});var i=t(24246),r=t(71670);const a={},o="Interface: ContainerCreateResult",c={id:"interfaces/ContainerCreateResult",title:"Interface: ContainerCreateResult",description:"Information about the container created by calling the containerEngine.createContainer method",source:"@site/api/interfaces/ContainerCreateResult.md",sourceDirName:"interfaces",slug:"/interfaces/ContainerCreateResult",permalink:"/api/interfaces/ContainerCreateResult",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: ContainerCreateOptions",permalink:"/api/interfaces/ContainerCreateOptions"},next:{title:"Interface: ContainerEngineInfo",permalink:"/api/interfaces/ContainerEngineInfo"}},s={},d=[{value:"Properties",id:"properties",level:2},{value:"id",id:"id",level:3},{value:"Source",id:"source",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",p:"p",strong:"strong",...(0,r.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"interface-containercreateresult",children:"Interface: ContainerCreateResult"}),"\n",(0,i.jsxs)(n.p,{children:["Information about the container created by calling the ",(0,i.jsx)(n.a,{href:"/api/namespaces/containerEngine/functions/createContainer",children:"containerEngine.createContainer"})," method"]}),"\n",(0,i.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(n.h3,{id:"id",children:"id"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"id"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["a string uniquely identifying the created container, which can be used to execute other methods on the container (",(0,i.jsx)(n.a,{href:"/api/namespaces/containerEngine/functions/deleteContainer",children:"containerEngine.deleteContainer"}),", ",(0,i.jsx)(n.a,{href:"/api/namespaces/containerEngine/functions/inspectContainer",children:"containerEngine.inspectContainer"}),", ",(0,i.jsx)(n.a,{href:"/api/namespaces/containerEngine/functions/startContainer",children:"containerEngine.startContainer"}),", ",(0,i.jsx)(n.a,{href:"/api/namespaces/containerEngine/functions/stopContainer",children:"containerEngine.stopContainer"}),", ",(0,i.jsx)(n.a,{href:"/api/namespaces/containerEngine/functions/logsContainer",children:"containerEngine.logsContainer"}),")"]}),"\n",(0,i.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2749",children:"packages/extension-api/src/extension-api.d.ts:2749"})})]})}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:()=>o});var i=t(27378);const r={},a=i.createContext(r);function o(e){const n=i.useContext(a);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:o(e.components),i.createElement(a.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/41b2e801.e153f008.js b/assets/js/41b2e801.b724f400.js similarity index 98% rename from assets/js/41b2e801.e153f008.js rename to assets/js/41b2e801.b724f400.js index fa816282ea6..8cc0a3cccbf 100644 --- a/assets/js/41b2e801.e153f008.js +++ b/assets/js/41b2e801.b724f400.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[35137],{71450:(e,r,n)=>{n.r(r),n.d(r,{assets:()=>o,contentTitle:()=>c,default:()=>p,frontMatter:()=>a,metadata:()=>t,toc:()=>d});var s=n(24246),i=n(71670);const a={},c="Function: registerImageCheckerProvider()",t={id:"namespaces/imageChecker/functions/registerImageCheckerProvider",title:"Function: registerImageCheckerProvider()",description:"registerImageCheckerProvider(imageCheckerProvider, metadata?): Disposable",source:"@site/api/namespaces/imageChecker/functions/registerImageCheckerProvider.md",sourceDirName:"namespaces/imageChecker/functions",slug:"/namespaces/imageChecker/functions/registerImageCheckerProvider",permalink:"/api/namespaces/imageChecker/functions/registerImageCheckerProvider",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Namespace: imageChecker",permalink:"/api/namespaces/imageChecker/"},next:{title:"Namespace: kubernetes",permalink:"/api/namespaces/kubernetes/"}},o={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function h(e){const r={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,i.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(r.h1,{id:"function-registerimagecheckerprovider",children:"Function: registerImageCheckerProvider()"}),"\n",(0,s.jsxs)(r.blockquote,{children:["\n",(0,s.jsxs)(r.p,{children:[(0,s.jsx)(r.strong,{children:"registerImageCheckerProvider"}),"(",(0,s.jsx)(r.code,{children:"imageCheckerProvider"}),", ",(0,s.jsx)(r.code,{children:"metadata"}),"?): ",(0,s.jsx)(r.a,{href:"/api/classes/Disposable",children:(0,s.jsx)(r.code,{children:"Disposable"})})]}),"\n"]}),"\n",(0,s.jsx)(r.p,{children:"Register the extension as an Image Checker."}),"\n",(0,s.jsx)(r.p,{children:"As an image checker, a provider needs to implement a specific interface, so the core\napplication can call the provider with specific tasks when necessary."}),"\n",(0,s.jsx)(r.h2,{id:"parameters",children:"Parameters"}),"\n",(0,s.jsxs)(r.p,{children:["\u2022 ",(0,s.jsx)(r.strong,{children:"imageCheckerProvider"}),": ",(0,s.jsx)(r.a,{href:"/api/interfaces/ImageCheckerProvider",children:(0,s.jsx)(r.code,{children:"ImageCheckerProvider"})})]}),"\n",(0,s.jsxs)(r.p,{children:["an object implementing the ",(0,s.jsx)(r.code,{children:"ImageCheckerProvider"})," interface"]}),"\n",(0,s.jsxs)(r.p,{children:["\u2022 ",(0,s.jsx)(r.strong,{children:"metadata?"}),": ",(0,s.jsx)(r.a,{href:"/api/interfaces/ImageCheckerProviderMetadata",children:(0,s.jsx)(r.code,{children:"ImageCheckerProviderMetadata"})})]}),"\n",(0,s.jsx)(r.p,{children:"optional metadata attached to this provider"}),"\n",(0,s.jsx)(r.h2,{id:"returns",children:"Returns"}),"\n",(0,s.jsx)(r.p,{children:(0,s.jsx)(r.a,{href:"/api/classes/Disposable",children:(0,s.jsx)(r.code,{children:"Disposable"})})}),"\n",(0,s.jsx)(r.p,{children:"A disposable that unregisters this provider when being disposed"}),"\n",(0,s.jsx)(r.h2,{id:"source",children:"Source"}),"\n",(0,s.jsx)(r.p,{children:(0,s.jsx)(r.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L4134",children:"packages/extension-api/src/extension-api.d.ts:4134"})})]})}function p(e={}){const{wrapper:r}={...(0,i.a)(),...e.components};return r?(0,s.jsx)(r,{...e,children:(0,s.jsx)(h,{...e})}):h(e)}},71670:(e,r,n)=>{n.d(r,{Z:()=>t,a:()=>c});var s=n(27378);const i={},a=s.createContext(i);function c(e){const r=s.useContext(a);return s.useMemo((function(){return"function"==typeof e?e(r):{...r,...e}}),[r,e])}function t(e){let r;return r=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:c(e.components),s.createElement(a.Provider,{value:r},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[35137],{71450:(e,r,n)=>{n.r(r),n.d(r,{assets:()=>o,contentTitle:()=>c,default:()=>p,frontMatter:()=>a,metadata:()=>t,toc:()=>d});var s=n(24246),i=n(71670);const a={},c="Function: registerImageCheckerProvider()",t={id:"namespaces/imageChecker/functions/registerImageCheckerProvider",title:"Function: registerImageCheckerProvider()",description:"registerImageCheckerProvider(imageCheckerProvider, metadata?): Disposable",source:"@site/api/namespaces/imageChecker/functions/registerImageCheckerProvider.md",sourceDirName:"namespaces/imageChecker/functions",slug:"/namespaces/imageChecker/functions/registerImageCheckerProvider",permalink:"/api/namespaces/imageChecker/functions/registerImageCheckerProvider",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Namespace: imageChecker",permalink:"/api/namespaces/imageChecker/"},next:{title:"Namespace: kubernetes",permalink:"/api/namespaces/kubernetes/"}},o={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function h(e){const r={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,i.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(r.h1,{id:"function-registerimagecheckerprovider",children:"Function: registerImageCheckerProvider()"}),"\n",(0,s.jsxs)(r.blockquote,{children:["\n",(0,s.jsxs)(r.p,{children:[(0,s.jsx)(r.strong,{children:"registerImageCheckerProvider"}),"(",(0,s.jsx)(r.code,{children:"imageCheckerProvider"}),", ",(0,s.jsx)(r.code,{children:"metadata"}),"?): ",(0,s.jsx)(r.a,{href:"/api/classes/Disposable",children:(0,s.jsx)(r.code,{children:"Disposable"})})]}),"\n"]}),"\n",(0,s.jsx)(r.p,{children:"Register the extension as an Image Checker."}),"\n",(0,s.jsx)(r.p,{children:"As an image checker, a provider needs to implement a specific interface, so the core\napplication can call the provider with specific tasks when necessary."}),"\n",(0,s.jsx)(r.h2,{id:"parameters",children:"Parameters"}),"\n",(0,s.jsxs)(r.p,{children:["\u2022 ",(0,s.jsx)(r.strong,{children:"imageCheckerProvider"}),": ",(0,s.jsx)(r.a,{href:"/api/interfaces/ImageCheckerProvider",children:(0,s.jsx)(r.code,{children:"ImageCheckerProvider"})})]}),"\n",(0,s.jsxs)(r.p,{children:["an object implementing the ",(0,s.jsx)(r.code,{children:"ImageCheckerProvider"})," interface"]}),"\n",(0,s.jsxs)(r.p,{children:["\u2022 ",(0,s.jsx)(r.strong,{children:"metadata?"}),": ",(0,s.jsx)(r.a,{href:"/api/interfaces/ImageCheckerProviderMetadata",children:(0,s.jsx)(r.code,{children:"ImageCheckerProviderMetadata"})})]}),"\n",(0,s.jsx)(r.p,{children:"optional metadata attached to this provider"}),"\n",(0,s.jsx)(r.h2,{id:"returns",children:"Returns"}),"\n",(0,s.jsx)(r.p,{children:(0,s.jsx)(r.a,{href:"/api/classes/Disposable",children:(0,s.jsx)(r.code,{children:"Disposable"})})}),"\n",(0,s.jsx)(r.p,{children:"A disposable that unregisters this provider when being disposed"}),"\n",(0,s.jsx)(r.h2,{id:"source",children:"Source"}),"\n",(0,s.jsx)(r.p,{children:(0,s.jsx)(r.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L4134",children:"packages/extension-api/src/extension-api.d.ts:4134"})})]})}function p(e={}){const{wrapper:r}={...(0,i.a)(),...e.components};return r?(0,s.jsx)(r,{...e,children:(0,s.jsx)(h,{...e})}):h(e)}},71670:(e,r,n)=>{n.d(r,{Z:()=>t,a:()=>c});var s=n(27378);const i={},a=s.createContext(i);function c(e){const r=s.useContext(a);return s.useMemo((function(){return"function"==typeof e?e(r):{...r,...e}}),[r,e])}function t(e){let r;return r=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:c(e.components),s.createElement(a.Provider,{value:r},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/423842d7.acf693fd.js b/assets/js/423842d7.c3922d88.js similarity index 98% rename from assets/js/423842d7.acf693fd.js rename to assets/js/423842d7.c3922d88.js index d55694d2c7e..32f329bb1b5 100644 --- a/assets/js/423842d7.acf693fd.js +++ b/assets/js/423842d7.c3922d88.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[27328],{6695:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>i,default:()=>p,frontMatter:()=>o,metadata:()=>c,toc:()=>l});var r=t(24246),s=t(71670);const o={},i="Type alias: KubernetesGeneratorArgument",c={id:"type-aliases/KubernetesGeneratorArgument",title:"Type alias: KubernetesGeneratorArgument",description:"KubernetesGeneratorArgument: object",source:"@site/api/type-aliases/KubernetesGeneratorArgument.md",sourceDirName:"type-aliases",slug:"/type-aliases/KubernetesGeneratorArgument",permalink:"/api/type-aliases/KubernetesGeneratorArgument",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Type alias: ConfigurationScope",permalink:"/api/type-aliases/ConfigurationScope"},next:{title:"Type alias: KubernetesGeneratorSelector",permalink:"/api/type-aliases/KubernetesGeneratorSelector"}},a={},l=[{value:"Type declaration",id:"type-declaration",level:2},{value:"compose?",id:"compose",level:3},{value:"containers?",id:"containers",level:3},{value:"engineId",id:"engineid",level:3},{value:"pods?",id:"pods",level:3},{value:"Source",id:"source",level:2}];function d(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.h1,{id:"type-alias-kubernetesgeneratorargument",children:"Type alias: KubernetesGeneratorArgument"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"KubernetesGeneratorArgument"}),": ",(0,r.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,r.jsx)(n.h2,{id:"type-declaration",children:"Type declaration"}),"\n",(0,r.jsx)(n.h3,{id:"compose",children:"compose?"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{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.strong,{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.strong,{children:(0,r.jsx)(n.code,{children:"optional"})})," ",(0,r.jsx)(n.strong,{children:"pods"}),": ",(0,r.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,r.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L1840",children:"packages/extension-api/src/extension-api.d.ts:1840"})})]})}function p(e={}){const{wrapper:n}={...(0,s.a)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(d,{...e})}):d(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>c,a:()=>i});var r=t(27378);const s={},o=r.createContext(s);function i(e){const n=r.useContext(o);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:i(e.components),r.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[27328],{6695:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>i,default:()=>p,frontMatter:()=>o,metadata:()=>c,toc:()=>l});var r=t(24246),s=t(71670);const o={},i="Type alias: KubernetesGeneratorArgument",c={id:"type-aliases/KubernetesGeneratorArgument",title:"Type alias: KubernetesGeneratorArgument",description:"KubernetesGeneratorArgument: object",source:"@site/api/type-aliases/KubernetesGeneratorArgument.md",sourceDirName:"type-aliases",slug:"/type-aliases/KubernetesGeneratorArgument",permalink:"/api/type-aliases/KubernetesGeneratorArgument",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Type alias: ConfigurationScope",permalink:"/api/type-aliases/ConfigurationScope"},next:{title:"Type alias: KubernetesGeneratorSelector",permalink:"/api/type-aliases/KubernetesGeneratorSelector"}},a={},l=[{value:"Type declaration",id:"type-declaration",level:2},{value:"compose?",id:"compose",level:3},{value:"containers?",id:"containers",level:3},{value:"engineId",id:"engineid",level:3},{value:"pods?",id:"pods",level:3},{value:"Source",id:"source",level:2}];function d(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.h1,{id:"type-alias-kubernetesgeneratorargument",children:"Type alias: KubernetesGeneratorArgument"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"KubernetesGeneratorArgument"}),": ",(0,r.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,r.jsx)(n.h2,{id:"type-declaration",children:"Type declaration"}),"\n",(0,r.jsx)(n.h3,{id:"compose",children:"compose?"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{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.strong,{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.strong,{children:(0,r.jsx)(n.code,{children:"optional"})})," ",(0,r.jsx)(n.strong,{children:"pods"}),": ",(0,r.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,r.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L1840",children:"packages/extension-api/src/extension-api.d.ts:1840"})})]})}function p(e={}){const{wrapper:n}={...(0,s.a)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(d,{...e})}):d(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>c,a:()=>i});var r=t(27378);const s={},o=r.createContext(s);function i(e){const n=r.useContext(o);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:i(e.components),r.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/42b67a8e.ae8f374d.js b/assets/js/42b67a8e.1d462849.js similarity index 72% rename from assets/js/42b67a8e.ae8f374d.js rename to assets/js/42b67a8e.1d462849.js index 66bd29dc77a..27aa78076e0 100644 --- a/assets/js/42b67a8e.ae8f374d.js +++ b/assets/js/42b67a8e.1d462849.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[54774],{76906:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>a,contentTitle:()=>c,default:()=>p,frontMatter:()=>o,metadata:()=>i,toc:()=>l});var s=n(24246),r=n(71670);const o={},c="Interface: HostRestartPolicy",i={id:"interfaces/HostRestartPolicy",title:"Interface: HostRestartPolicy",description:"Properties",source:"@site/api/interfaces/HostRestartPolicy.md",sourceDirName:"interfaces",slug:"/interfaces/HostRestartPolicy",permalink:"/api/interfaces/HostRestartPolicy",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: HostConfig",permalink:"/api/interfaces/HostConfig"},next:{title:"Interface: IPAM",permalink:"/api/interfaces/IPAM"}},a={},l=[{value:"Properties",id:"properties",level:2},{value:"MaximumRetryCount?",id:"maximumretrycount",level:3},{value:"Source",id:"source",level:4},{value:"Name",id:"name",level:3},{value:"Source",id:"source-1",level:4}];function d(e){const t={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,r.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(t.h1,{id:"interface-hostrestartpolicy",children:"Interface: HostRestartPolicy"}),"\n",(0,s.jsx)(t.h2,{id:"properties",children:"Properties"}),"\n",(0,s.jsx)(t.h3,{id:"maximumretrycount",children:"MaximumRetryCount?"}),"\n",(0,s.jsxs)(t.blockquote,{children:["\n",(0,s.jsxs)(t.p,{children:[(0,s.jsx)(t.strong,{children:(0,s.jsx)(t.code,{children:"optional"})})," ",(0,s.jsx)(t.strong,{children:"MaximumRetryCount"}),": ",(0,s.jsx)(t.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(t.h4,{id:"source",children:"Source"}),"\n",(0,s.jsx)(t.p,{children:(0,s.jsx)(t.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2085",children:"packages/extension-api/src/extension-api.d.ts:2085"})}),"\n",(0,s.jsx)(t.hr,{}),"\n",(0,s.jsx)(t.h3,{id:"name",children:"Name"}),"\n",(0,s.jsxs)(t.blockquote,{children:["\n",(0,s.jsxs)(t.p,{children:[(0,s.jsx)(t.strong,{children:"Name"}),": ",(0,s.jsx)(t.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(t.h4,{id:"source-1",children:"Source"}),"\n",(0,s.jsx)(t.p,{children:(0,s.jsx)(t.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2084",children:"packages/extension-api/src/extension-api.d.ts:2084"})})]})}function p(e={}){const{wrapper:t}={...(0,r.a)(),...e.components};return t?(0,s.jsx)(t,{...e,children:(0,s.jsx)(d,{...e})}):d(e)}},71670:(e,t,n)=>{n.d(t,{Z:()=>i,a:()=>c});var s=n(27378);const r={},o=s.createContext(r);function c(e){const t=s.useContext(o);return s.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function i(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:c(e.components),s.createElement(o.Provider,{value:t},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[54774],{76906:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>a,contentTitle:()=>i,default:()=>p,frontMatter:()=>o,metadata:()=>c,toc:()=>d});var s=n(24246),r=n(71670);const o={},i="Interface: HostRestartPolicy",c={id:"interfaces/HostRestartPolicy",title:"Interface: HostRestartPolicy",description:"Properties",source:"@site/api/interfaces/HostRestartPolicy.md",sourceDirName:"interfaces",slug:"/interfaces/HostRestartPolicy",permalink:"/api/interfaces/HostRestartPolicy",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: HostConfig",permalink:"/api/interfaces/HostConfig"},next:{title:"Interface: IPAM",permalink:"/api/interfaces/IPAM"}},a={},d=[{value:"Properties",id:"properties",level:2},{value:"MaximumRetryCount?",id:"maximumretrycount",level:3},{value:"Source",id:"source",level:4},{value:"Name",id:"name",level:3},{value:"Source",id:"source-1",level:4}];function l(e){const t={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,r.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(t.h1,{id:"interface-hostrestartpolicy",children:"Interface: HostRestartPolicy"}),"\n",(0,s.jsx)(t.h2,{id:"properties",children:"Properties"}),"\n",(0,s.jsx)(t.h3,{id:"maximumretrycount",children:"MaximumRetryCount?"}),"\n",(0,s.jsxs)(t.blockquote,{children:["\n",(0,s.jsxs)(t.p,{children:[(0,s.jsx)(t.strong,{children:(0,s.jsx)(t.code,{children:"optional"})})," ",(0,s.jsx)(t.strong,{children:"MaximumRetryCount"}),": ",(0,s.jsx)(t.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(t.h4,{id:"source",children:"Source"}),"\n",(0,s.jsx)(t.p,{children:(0,s.jsx)(t.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2085",children:"packages/extension-api/src/extension-api.d.ts:2085"})}),"\n",(0,s.jsx)(t.hr,{}),"\n",(0,s.jsx)(t.h3,{id:"name",children:"Name"}),"\n",(0,s.jsxs)(t.blockquote,{children:["\n",(0,s.jsxs)(t.p,{children:[(0,s.jsx)(t.strong,{children:"Name"}),": ",(0,s.jsx)(t.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(t.h4,{id:"source-1",children:"Source"}),"\n",(0,s.jsx)(t.p,{children:(0,s.jsx)(t.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2084",children:"packages/extension-api/src/extension-api.d.ts:2084"})})]})}function p(e={}){const{wrapper:t}={...(0,r.a)(),...e.components};return t?(0,s.jsx)(t,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},71670:(e,t,n)=>{n.d(t,{Z:()=>c,a:()=>i});var s=n(27378);const r={},o=s.createContext(r);function i(e){const t=s.useContext(o);return s.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function c(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:i(e.components),s.createElement(o.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/43be69c9.5cc7765f.js b/assets/js/43be69c9.9e2f4325.js similarity index 91% rename from assets/js/43be69c9.5cc7765f.js rename to assets/js/43be69c9.9e2f4325.js index 83146abe8f2..f7d956e0036 100644 --- a/assets/js/43be69c9.5cc7765f.js +++ b/assets/js/43be69c9.9e2f4325.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[86661],{40409:(e,i,n)=>{n.r(i),n.d(i,{assets:()=>a,contentTitle:()=>r,default:()=>h,frontMatter:()=>t,metadata:()=>o,toc:()=>d});var s=n(24246),c=n(71670);const t={},r="Interface: QuickPickItem",o={id:"interfaces/QuickPickItem",title:"Interface: QuickPickItem",description:"Represents an item that can be selected from",source:"@site/api/interfaces/QuickPickItem.md",sourceDirName:"interfaces",slug:"/interfaces/QuickPickItem",permalink:"/api/interfaces/QuickPickItem",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: QuickInputButton",permalink:"/api/interfaces/QuickInputButton"},next:{title:"Interface: QuickPickOptions",permalink:"/api/interfaces/QuickPickOptions"}},a={},d=[{value:"Properties",id:"properties",level:2},{value:"alwaysShow?",id:"alwaysshow",level:3},{value:"Source",id:"source",level:4},{value:"buttons?",id:"buttons",level:3},{value:"Source",id:"source-1",level:4},{value:"description?",id:"description",level:3},{value:"Source",id:"source-2",level:4},{value:"detail?",id:"detail",level:3},{value:"Source",id:"source-3",level:4},{value:"kind?",id:"kind",level:3},{value:"Source",id:"source-4",level:4},{value:"label",id:"label",level:3},{value:"Source",id:"source-5",level:4},{value:"picked?",id:"picked",level:3},{value:"See",id:"see",level:4},{value:"Source",id:"source-6",level:4}];function l(e){const i={a:"a",blockquote:"blockquote",code:"code",em:"em",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,c.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(i.h1,{id:"interface-quickpickitem",children:"Interface: QuickPickItem"}),"\n",(0,s.jsx)(i.p,{children:"Represents an item that can be selected from\na list of items."}),"\n",(0,s.jsx)(i.h2,{id:"properties",children:"Properties"}),"\n",(0,s.jsx)(i.h3,{id:"alwaysshow",children:"alwaysShow?"}),"\n",(0,s.jsxs)(i.blockquote,{children:["\n",(0,s.jsxs)(i.p,{children:[(0,s.jsx)(i.strong,{children:(0,s.jsx)(i.code,{children:"optional"})})," ",(0,s.jsx)(i.strong,{children:"alwaysShow"}),": ",(0,s.jsx)(i.code,{children:"boolean"})]}),"\n"]}),"\n",(0,s.jsx)(i.p,{children:"Always show this item."}),"\n",(0,s.jsxs)(i.p,{children:["Note: this property is ignored when ",(0,s.jsx)(i.a,{href:"/api/interfaces/QuickPickItem#kind",children:"kind"})," is set to ",(0,s.jsx)(i.a,{href:"/api/enumerations/QuickPickItemKind#separator",children:"QuickPickItemKind.Separator"})]}),"\n",(0,s.jsx)(i.h4,{id:"source",children:"Source"}),"\n",(0,s.jsx)(i.p,{children:(0,s.jsx)(i.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L1028",children:"packages/extension-api/src/extension-api.d.ts:1028"})}),"\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.strong,{children:(0,s.jsx)(i.code,{children:"optional"})})," ",(0,s.jsx)(i.strong,{children:"buttons"}),": readonly ",(0,s.jsx)(i.a,{href:"/api/interfaces/QuickInputButton",children:(0,s.jsx)(i.code,{children:"QuickInputButton"})}),"[]"]}),"\n"]}),"\n",(0,s.jsxs)(i.p,{children:["Optional buttons that will be rendered on this particular item. These buttons will trigger\nan QuickPickItemButtonEvent when clicked. Buttons are only rendered when using a quickpick\ncreated by the window.createQuickPick createQuickPick() API. Buttons are not rendered when using\nthe ",(0,s.jsx)(i.a,{href:"/api/namespaces/window/functions/showQuickPick",children:"showQuickPick()"})," API."]}),"\n",(0,s.jsxs)(i.p,{children:["Note: this property is ignored when ",(0,s.jsx)(i.a,{href:"/api/interfaces/QuickPickItem#kind",children:"kind"})," is set to ",(0,s.jsx)(i.a,{href:"/api/enumerations/QuickPickItemKind#separator",children:"QuickPickItemKind.Separator"})]}),"\n",(0,s.jsx)(i.h4,{id:"source-1",children:"Source"}),"\n",(0,s.jsx)(i.p,{children:(0,s.jsx)(i.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L1038",children:"packages/extension-api/src/extension-api.d.ts:1038"})}),"\n",(0,s.jsx)(i.hr,{}),"\n",(0,s.jsx)(i.h3,{id:"description",children:"description?"}),"\n",(0,s.jsxs)(i.blockquote,{children:["\n",(0,s.jsxs)(i.p,{children:[(0,s.jsx)(i.strong,{children:(0,s.jsx)(i.code,{children:"optional"})})," ",(0,s.jsx)(i.strong,{children:"description"}),": ",(0,s.jsx)(i.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsxs)(i.p,{children:["A human-readable string which is rendered less prominent in the same line. Supports rendering of\nThemeIcon theme icons via the ",(0,s.jsx)(i.code,{children:"$()"}),"-syntax."]}),"\n",(0,s.jsxs)(i.p,{children:["Note: this property is ignored when ",(0,s.jsx)(i.a,{href:"/api/interfaces/QuickPickItem#kind",children:"kind"})," is set to ",(0,s.jsx)(i.a,{href:"/api/enumerations/QuickPickItemKind#separator",children:"QuickPickItemKind.Separator"})]}),"\n",(0,s.jsx)(i.h4,{id:"source-2",children:"Source"}),"\n",(0,s.jsx)(i.p,{children:(0,s.jsx)(i.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L1000",children:"packages/extension-api/src/extension-api.d.ts:1000"})}),"\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.strong,{children:(0,s.jsx)(i.code,{children:"optional"})})," ",(0,s.jsx)(i.strong,{children:"detail"}),": ",(0,s.jsx)(i.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsxs)(i.p,{children:["A human-readable string which is rendered less prominent in a separate line. Supports rendering of\nThemeIcon theme icons via the ",(0,s.jsx)(i.code,{children:"$()"}),"-syntax."]}),"\n",(0,s.jsxs)(i.p,{children:["Note: this property is ignored when ",(0,s.jsx)(i.a,{href:"/api/interfaces/QuickPickItem#kind",children:"kind"})," is set to ",(0,s.jsx)(i.a,{href:"/api/enumerations/QuickPickItemKind#separator",children:"QuickPickItemKind.Separator"})]}),"\n",(0,s.jsx)(i.h4,{id:"source-3",children:"Source"}),"\n",(0,s.jsx)(i.p,{children:(0,s.jsx)(i.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L1008",children:"packages/extension-api/src/extension-api.d.ts:1008"})}),"\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.strong,{children:(0,s.jsx)(i.code,{children:"optional"})})," ",(0,s.jsx)(i.strong,{children:"kind"}),": ",(0,s.jsx)(i.a,{href:"/api/enumerations/QuickPickItemKind",children:(0,s.jsx)(i.code,{children:"QuickPickItemKind"})})]}),"\n"]}),"\n",(0,s.jsxs)(i.p,{children:["The kind of QuickPickItem that will determine how this item is rendered in the quick pick. When not specified,\nthe default is ",(0,s.jsx)(i.a,{href:"/api/enumerations/QuickPickItemKind#default",children:"QuickPickItemKind.Default"}),"."]}),"\n",(0,s.jsx)(i.h4,{id:"source-4",children:"Source"}),"\n",(0,s.jsx)(i.p,{children:(0,s.jsx)(i.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L992",children:"packages/extension-api/src/extension-api.d.ts:992"})}),"\n",(0,s.jsx)(i.hr,{}),"\n",(0,s.jsx)(i.h3,{id:"label",children:"label"}),"\n",(0,s.jsxs)(i.blockquote,{children:["\n",(0,s.jsxs)(i.p,{children:[(0,s.jsx)(i.strong,{children:"label"}),": ",(0,s.jsx)(i.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsxs)(i.p,{children:["A human-readable string which is rendered prominent. Supports rendering of ThemeIcon theme icons via\nthe ",(0,s.jsx)(i.code,{children:"$()"}),"-syntax."]}),"\n",(0,s.jsx)(i.h4,{id:"source-5",children:"Source"}),"\n",(0,s.jsx)(i.p,{children:(0,s.jsx)(i.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L986",children:"packages/extension-api/src/extension-api.d.ts:986"})}),"\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.strong,{children:(0,s.jsx)(i.code,{children:"optional"})})," ",(0,s.jsx)(i.strong,{children:"picked"}),": ",(0,s.jsx)(i.code,{children:"boolean"})]}),"\n"]}),"\n",(0,s.jsxs)(i.p,{children:["Optional flag indicating if this item is picked initially. This is only honored when using\nthe ",(0,s.jsx)(i.a,{href:"/api/namespaces/window/functions/showQuickPick",children:"showQuickPick()"})," API. To do the same thing with\nthe window.createQuickPick createQuickPick() API, simply set the QuickPick.selectedItems\nto the items you want picked initially.\n(",(0,s.jsx)(i.em,{children:"Note:"})," This is only honored when the picker allows multiple selections.)"]}),"\n",(0,s.jsx)(i.h4,{id:"see",children:"See"}),"\n",(0,s.jsx)(i.p,{children:(0,s.jsx)(i.a,{href:"/api/interfaces/QuickPickOptions#canpickmany",children:"QuickPickOptions.canPickMany"})}),"\n",(0,s.jsxs)(i.p,{children:["Note: this property is ignored when ",(0,s.jsx)(i.a,{href:"/api/interfaces/QuickPickItem#kind",children:"kind"})," is set to ",(0,s.jsx)(i.a,{href:"/api/enumerations/QuickPickItemKind#separator",children:"QuickPickItemKind.Separator"})]}),"\n",(0,s.jsx)(i.h4,{id:"source-6",children:"Source"}),"\n",(0,s.jsx)(i.p,{children:(0,s.jsx)(i.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L1021",children:"packages/extension-api/src/extension-api.d.ts:1021"})})]})}function h(e={}){const{wrapper:i}={...(0,c.a)(),...e.components};return i?(0,s.jsx)(i,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},71670:(e,i,n)=>{n.d(i,{Z:()=>o,a:()=>r});var s=n(27378);const c={},t=s.createContext(c);function r(e){const i=s.useContext(t);return s.useMemo((function(){return"function"==typeof e?e(i):{...i,...e}}),[i,e])}function o(e){let i;return i=e.disableParentContext?"function"==typeof e.components?e.components(c):e.components||c:r(e.components),s.createElement(t.Provider,{value:i},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[86661],{40409:(e,i,n)=>{n.r(i),n.d(i,{assets:()=>d,contentTitle:()=>r,default:()=>h,frontMatter:()=>t,metadata:()=>o,toc:()=>a});var s=n(24246),c=n(71670);const t={},r="Interface: QuickPickItem",o={id:"interfaces/QuickPickItem",title:"Interface: QuickPickItem",description:"Represents an item that can be selected from",source:"@site/api/interfaces/QuickPickItem.md",sourceDirName:"interfaces",slug:"/interfaces/QuickPickItem",permalink:"/api/interfaces/QuickPickItem",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: QuickInputButton",permalink:"/api/interfaces/QuickInputButton"},next:{title:"Interface: QuickPickOptions",permalink:"/api/interfaces/QuickPickOptions"}},d={},a=[{value:"Properties",id:"properties",level:2},{value:"alwaysShow?",id:"alwaysshow",level:3},{value:"Source",id:"source",level:4},{value:"buttons?",id:"buttons",level:3},{value:"Source",id:"source-1",level:4},{value:"description?",id:"description",level:3},{value:"Source",id:"source-2",level:4},{value:"detail?",id:"detail",level:3},{value:"Source",id:"source-3",level:4},{value:"kind?",id:"kind",level:3},{value:"Source",id:"source-4",level:4},{value:"label",id:"label",level:3},{value:"Source",id:"source-5",level:4},{value:"picked?",id:"picked",level:3},{value:"See",id:"see",level:4},{value:"Source",id:"source-6",level:4}];function l(e){const i={a:"a",blockquote:"blockquote",code:"code",em:"em",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,c.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(i.h1,{id:"interface-quickpickitem",children:"Interface: QuickPickItem"}),"\n",(0,s.jsx)(i.p,{children:"Represents an item that can be selected from\na list of items."}),"\n",(0,s.jsx)(i.h2,{id:"properties",children:"Properties"}),"\n",(0,s.jsx)(i.h3,{id:"alwaysshow",children:"alwaysShow?"}),"\n",(0,s.jsxs)(i.blockquote,{children:["\n",(0,s.jsxs)(i.p,{children:[(0,s.jsx)(i.strong,{children:(0,s.jsx)(i.code,{children:"optional"})})," ",(0,s.jsx)(i.strong,{children:"alwaysShow"}),": ",(0,s.jsx)(i.code,{children:"boolean"})]}),"\n"]}),"\n",(0,s.jsx)(i.p,{children:"Always show this item."}),"\n",(0,s.jsxs)(i.p,{children:["Note: this property is ignored when ",(0,s.jsx)(i.a,{href:"/api/interfaces/QuickPickItem#kind",children:"kind"})," is set to ",(0,s.jsx)(i.a,{href:"/api/enumerations/QuickPickItemKind#separator",children:"QuickPickItemKind.Separator"})]}),"\n",(0,s.jsx)(i.h4,{id:"source",children:"Source"}),"\n",(0,s.jsx)(i.p,{children:(0,s.jsx)(i.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L1028",children:"packages/extension-api/src/extension-api.d.ts:1028"})}),"\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.strong,{children:(0,s.jsx)(i.code,{children:"optional"})})," ",(0,s.jsx)(i.strong,{children:"buttons"}),": readonly ",(0,s.jsx)(i.a,{href:"/api/interfaces/QuickInputButton",children:(0,s.jsx)(i.code,{children:"QuickInputButton"})}),"[]"]}),"\n"]}),"\n",(0,s.jsxs)(i.p,{children:["Optional buttons that will be rendered on this particular item. These buttons will trigger\nan QuickPickItemButtonEvent when clicked. Buttons are only rendered when using a quickpick\ncreated by the window.createQuickPick createQuickPick() API. Buttons are not rendered when using\nthe ",(0,s.jsx)(i.a,{href:"/api/namespaces/window/functions/showQuickPick",children:"showQuickPick()"})," API."]}),"\n",(0,s.jsxs)(i.p,{children:["Note: this property is ignored when ",(0,s.jsx)(i.a,{href:"/api/interfaces/QuickPickItem#kind",children:"kind"})," is set to ",(0,s.jsx)(i.a,{href:"/api/enumerations/QuickPickItemKind#separator",children:"QuickPickItemKind.Separator"})]}),"\n",(0,s.jsx)(i.h4,{id:"source-1",children:"Source"}),"\n",(0,s.jsx)(i.p,{children:(0,s.jsx)(i.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L1038",children:"packages/extension-api/src/extension-api.d.ts:1038"})}),"\n",(0,s.jsx)(i.hr,{}),"\n",(0,s.jsx)(i.h3,{id:"description",children:"description?"}),"\n",(0,s.jsxs)(i.blockquote,{children:["\n",(0,s.jsxs)(i.p,{children:[(0,s.jsx)(i.strong,{children:(0,s.jsx)(i.code,{children:"optional"})})," ",(0,s.jsx)(i.strong,{children:"description"}),": ",(0,s.jsx)(i.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsxs)(i.p,{children:["A human-readable string which is rendered less prominent in the same line. Supports rendering of\nThemeIcon theme icons via the ",(0,s.jsx)(i.code,{children:"$()"}),"-syntax."]}),"\n",(0,s.jsxs)(i.p,{children:["Note: this property is ignored when ",(0,s.jsx)(i.a,{href:"/api/interfaces/QuickPickItem#kind",children:"kind"})," is set to ",(0,s.jsx)(i.a,{href:"/api/enumerations/QuickPickItemKind#separator",children:"QuickPickItemKind.Separator"})]}),"\n",(0,s.jsx)(i.h4,{id:"source-2",children:"Source"}),"\n",(0,s.jsx)(i.p,{children:(0,s.jsx)(i.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L1000",children:"packages/extension-api/src/extension-api.d.ts:1000"})}),"\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.strong,{children:(0,s.jsx)(i.code,{children:"optional"})})," ",(0,s.jsx)(i.strong,{children:"detail"}),": ",(0,s.jsx)(i.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsxs)(i.p,{children:["A human-readable string which is rendered less prominent in a separate line. Supports rendering of\nThemeIcon theme icons via the ",(0,s.jsx)(i.code,{children:"$()"}),"-syntax."]}),"\n",(0,s.jsxs)(i.p,{children:["Note: this property is ignored when ",(0,s.jsx)(i.a,{href:"/api/interfaces/QuickPickItem#kind",children:"kind"})," is set to ",(0,s.jsx)(i.a,{href:"/api/enumerations/QuickPickItemKind#separator",children:"QuickPickItemKind.Separator"})]}),"\n",(0,s.jsx)(i.h4,{id:"source-3",children:"Source"}),"\n",(0,s.jsx)(i.p,{children:(0,s.jsx)(i.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L1008",children:"packages/extension-api/src/extension-api.d.ts:1008"})}),"\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.strong,{children:(0,s.jsx)(i.code,{children:"optional"})})," ",(0,s.jsx)(i.strong,{children:"kind"}),": ",(0,s.jsx)(i.a,{href:"/api/enumerations/QuickPickItemKind",children:(0,s.jsx)(i.code,{children:"QuickPickItemKind"})})]}),"\n"]}),"\n",(0,s.jsxs)(i.p,{children:["The kind of QuickPickItem that will determine how this item is rendered in the quick pick. When not specified,\nthe default is ",(0,s.jsx)(i.a,{href:"/api/enumerations/QuickPickItemKind#default",children:"QuickPickItemKind.Default"}),"."]}),"\n",(0,s.jsx)(i.h4,{id:"source-4",children:"Source"}),"\n",(0,s.jsx)(i.p,{children:(0,s.jsx)(i.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L992",children:"packages/extension-api/src/extension-api.d.ts:992"})}),"\n",(0,s.jsx)(i.hr,{}),"\n",(0,s.jsx)(i.h3,{id:"label",children:"label"}),"\n",(0,s.jsxs)(i.blockquote,{children:["\n",(0,s.jsxs)(i.p,{children:[(0,s.jsx)(i.strong,{children:"label"}),": ",(0,s.jsx)(i.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsxs)(i.p,{children:["A human-readable string which is rendered prominent. Supports rendering of ThemeIcon theme icons via\nthe ",(0,s.jsx)(i.code,{children:"$()"}),"-syntax."]}),"\n",(0,s.jsx)(i.h4,{id:"source-5",children:"Source"}),"\n",(0,s.jsx)(i.p,{children:(0,s.jsx)(i.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L986",children:"packages/extension-api/src/extension-api.d.ts:986"})}),"\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.strong,{children:(0,s.jsx)(i.code,{children:"optional"})})," ",(0,s.jsx)(i.strong,{children:"picked"}),": ",(0,s.jsx)(i.code,{children:"boolean"})]}),"\n"]}),"\n",(0,s.jsxs)(i.p,{children:["Optional flag indicating if this item is picked initially. This is only honored when using\nthe ",(0,s.jsx)(i.a,{href:"/api/namespaces/window/functions/showQuickPick",children:"showQuickPick()"})," API. To do the same thing with\nthe window.createQuickPick createQuickPick() API, simply set the QuickPick.selectedItems\nto the items you want picked initially.\n(",(0,s.jsx)(i.em,{children:"Note:"})," This is only honored when the picker allows multiple selections.)"]}),"\n",(0,s.jsx)(i.h4,{id:"see",children:"See"}),"\n",(0,s.jsx)(i.p,{children:(0,s.jsx)(i.a,{href:"/api/interfaces/QuickPickOptions#canpickmany",children:"QuickPickOptions.canPickMany"})}),"\n",(0,s.jsxs)(i.p,{children:["Note: this property is ignored when ",(0,s.jsx)(i.a,{href:"/api/interfaces/QuickPickItem#kind",children:"kind"})," is set to ",(0,s.jsx)(i.a,{href:"/api/enumerations/QuickPickItemKind#separator",children:"QuickPickItemKind.Separator"})]}),"\n",(0,s.jsx)(i.h4,{id:"source-6",children:"Source"}),"\n",(0,s.jsx)(i.p,{children:(0,s.jsx)(i.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L1021",children:"packages/extension-api/src/extension-api.d.ts:1021"})})]})}function h(e={}){const{wrapper:i}={...(0,c.a)(),...e.components};return i?(0,s.jsx)(i,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},71670:(e,i,n)=>{n.d(i,{Z:()=>o,a:()=>r});var s=n(27378);const c={},t=s.createContext(c);function r(e){const i=s.useContext(t);return s.useMemo((function(){return"function"==typeof e?e(i):{...i,...e}}),[i,e])}function o(e){let i;return i=e.disableParentContext?"function"==typeof e.components?e.components(c):e.components||c:r(e.components),s.createElement(t.Provider,{value:i},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/44287967.935386d3.js b/assets/js/44287967.935386d3.js deleted file mode 100644 index 77df8fced0a..00000000000 --- a/assets/js/44287967.935386d3.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[49867],{17321:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>c,contentTitle:()=>r,default:()=>p,frontMatter:()=>a,metadata:()=>o,toc:()=>l});var t=s(24246),i=s(71670);const a={},r="Function: statsContainer()",o={id:"namespaces/containerEngine/functions/statsContainer",title:"Function: statsContainer()",description:"statsContainer(engineId, id, callback): Promise\\",source:"@site/api/namespaces/containerEngine/functions/statsContainer.md",sourceDirName:"namespaces/containerEngine/functions",slug:"/namespaces/containerEngine/functions/statsContainer",permalink:"/api/namespaces/containerEngine/functions/statsContainer",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Function: startPod()",permalink:"/api/namespaces/containerEngine/functions/startPod"},next:{title:"Function: stopContainer()",permalink:"/api/namespaces/containerEngine/functions/stopContainer"}},c={},l=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Example",id:"example",level:2},{value:"Source",id:"source",level:2}];function d(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",pre:"pre",strong:"strong",...(0,i.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"function-statscontainer",children:"Function: statsContainer()"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"statsContainer"}),"(",(0,t.jsx)(n.code,{children:"engineId"}),", ",(0,t.jsx)(n.code,{children:"id"}),", ",(0,t.jsx)(n.code,{children:"callback"}),"): ",(0,t.jsx)(n.code,{children:"Promise"}),"< ",(0,t.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,t.jsx)(n.code,{children:"Disposable"})})," >"]}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"Get the streamed stats of a running container."}),"\n",(0,t.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"engineId"}),": ",(0,t.jsx)(n.code,{children:"string"})]}),"\n",(0,t.jsxs)(n.p,{children:["the id of the engine managing the container, obtained from the result of ",(0,t.jsx)(n.a,{href:"/api/namespaces/containerEngine/functions/listContainers",children:"containerEngine.listContainers"})]}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"id"}),": ",(0,t.jsx)(n.code,{children:"string"})]}),"\n",(0,t.jsxs)(n.p,{children:["the id or name of the container on this engine, obtained from the result of ",(0,t.jsx)(n.a,{href:"/api/namespaces/containerEngine/functions/listContainers",children:"containerEngine.listContainers"})," or as the result of ",(0,t.jsx)(n.a,{href:"/api/namespaces/containerEngine/functions/createContainer",children:"containerEngine.createContainer"})]}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"callback"})]}),"\n",(0,t.jsx)(n.p,{children:"the function called when container stats info are emitted."}),"\n",(0,t.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"Promise"}),"< ",(0,t.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,t.jsx)(n.code,{children:"Disposable"})})," >"]}),"\n",(0,t.jsxs)(n.p,{children:["A Promise resolving a ",(0,t.jsx)(n.a,{href:"/api/classes/Disposable",children:"Disposable"})," that unregister the callback when called."]}),"\n",(0,t.jsx)(n.h2,{id:"example",children:"Example"}),"\n",(0,t.jsx)(n.p,{children:"Here is a usage example"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-ts",children:"const disposable = await statsContainer('engineId', 'containerId', (stats: ContainerStatsInfo): void => {\n console.log('CPU Usage', stats.cpu_stats.cpu_usage.total_usage);\n});\n\n// When no longer needed\ndisposable.dispose();\n"})}),"\n",(0,t.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L3222",children:"packages/extension-api/src/extension-api.d.ts:3222"})})]})}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/44287967.e926313c.js b/assets/js/44287967.e926313c.js new file mode 100644 index 00000000000..9b9a05d9ce3 --- /dev/null +++ b/assets/js/44287967.e926313c.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[49867],{17321:(n,e,s)=>{s.r(e),s.d(e,{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:"Function: startPod()",permalink:"/api/namespaces/containerEngine/functions/startPod"},next:{title:"Function: stopContainer()",permalink:"/api/namespaces/containerEngine/functions/stopContainer"}},c={},l=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Example",id:"example",level:2},{value:"Source",id:"source",level:2}];function d(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:"source",children:"Source"}),"\n",(0,t.jsx)(e.p,{children:(0,t.jsx)(e.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L3222",children:"packages/extension-api/src/extension-api.d.ts:3222"})})]})}function p(n={}){const{wrapper:e}={...(0,i.a)(),...n.components};return e?(0,t.jsx)(e,{...n,children:(0,t.jsx)(d,{...n})}):d(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/456c0e28.d959dd31.js b/assets/js/456c0e28.27dcf5a9.js similarity index 92% rename from assets/js/456c0e28.d959dd31.js rename to assets/js/456c0e28.27dcf5a9.js index e8a0d34fcb2..f7d3a07736e 100644 --- a/assets/js/456c0e28.d959dd31.js +++ b/assets/js/456c0e28.27dcf5a9.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[33279],{53870:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>o,default:()=>p,frontMatter:()=>i,metadata:()=>c,toc:()=>d});var s=t(24246),r=t(71670);const i={},o="Interface: PodContainerInfo",c={id:"interfaces/PodContainerInfo",title:"Interface: PodContainerInfo",description:"Properties",source:"@site/api/interfaces/PodContainerInfo.md",sourceDirName:"interfaces",slug:"/interfaces/PodContainerInfo",permalink:"/api/interfaces/PodContainerInfo",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: PidsStats",permalink:"/api/interfaces/PidsStats"},next:{title:"Interface: PodCreateOptions",permalink:"/api/interfaces/PodCreateOptions"}},a={},d=[{value:"Properties",id:"properties",level:2},{value:"Id",id:"id",level:3},{value:"Source",id:"source",level:4},{value:"Names",id:"names",level:3},{value:"Source",id:"source-1",level:4},{value:"Status",id:"status",level:3},{value:"Source",id:"source-2",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,r.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"interface-podcontainerinfo",children:"Interface: PodContainerInfo"}),"\n",(0,s.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,s.jsx)(n.h3,{id:"id",children:"Id"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Id"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2039",children:"packages/extension-api/src/extension-api.d.ts:2039"})}),"\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:"source-1",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2040",children:"packages/extension-api/src/extension-api.d.ts:2040"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"status",children:"Status"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Status"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2041",children:"packages/extension-api/src/extension-api.d.ts:2041"})})]})}function p(e={}){const{wrapper:n}={...(0,r.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>c,a:()=>o});var s=t(27378);const r={},i=s.createContext(r);function o(e){const n=s.useContext(i);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:o(e.components),s.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[33279],{53870:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>o,default:()=>p,frontMatter:()=>i,metadata:()=>c,toc:()=>d});var s=t(24246),r=t(71670);const i={},o="Interface: PodContainerInfo",c={id:"interfaces/PodContainerInfo",title:"Interface: PodContainerInfo",description:"Properties",source:"@site/api/interfaces/PodContainerInfo.md",sourceDirName:"interfaces",slug:"/interfaces/PodContainerInfo",permalink:"/api/interfaces/PodContainerInfo",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: PidsStats",permalink:"/api/interfaces/PidsStats"},next:{title:"Interface: PodCreateOptions",permalink:"/api/interfaces/PodCreateOptions"}},a={},d=[{value:"Properties",id:"properties",level:2},{value:"Id",id:"id",level:3},{value:"Source",id:"source",level:4},{value:"Names",id:"names",level:3},{value:"Source",id:"source-1",level:4},{value:"Status",id:"status",level:3},{value:"Source",id:"source-2",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,r.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"interface-podcontainerinfo",children:"Interface: PodContainerInfo"}),"\n",(0,s.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,s.jsx)(n.h3,{id:"id",children:"Id"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Id"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2039",children:"packages/extension-api/src/extension-api.d.ts:2039"})}),"\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:"source-1",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2040",children:"packages/extension-api/src/extension-api.d.ts:2040"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"status",children:"Status"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Status"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2041",children:"packages/extension-api/src/extension-api.d.ts:2041"})})]})}function p(e={}){const{wrapper:n}={...(0,r.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>c,a:()=>o});var s=t(27378);const r={},i=s.createContext(r);function o(e){const n=s.useContext(i);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:o(e.components),s.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/46669adc.7ef9ccbf.js b/assets/js/46669adc.c54854c8.js similarity index 74% rename from assets/js/46669adc.7ef9ccbf.js rename to assets/js/46669adc.c54854c8.js index cf410217c42..a15941ead37 100644 --- a/assets/js/46669adc.7ef9ccbf.js +++ b/assets/js/46669adc.c54854c8.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[51320],{81902:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>d,contentTitle:()=>i,default:()=>p,frontMatter:()=>s,metadata:()=>o,toc:()=>a});var t=r(24246),c=r(71670);const s={},i="Interface: AuditRecord",o={id:"interfaces/AuditRecord",title:"Interface: AuditRecord",description:"Properties",source:"@site/api/interfaces/AuditRecord.md",sourceDirName:"interfaces",slug:"/interfaces/AuditRecord",permalink:"/api/interfaces/AuditRecord",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Class: Uri",permalink:"/api/classes/Uri"},next:{title:"Interface: AuditRequestItems",permalink:"/api/interfaces/AuditRequestItems"}},d={},a=[{value:"Properties",id:"properties",level:2},{value:"record",id:"record",level:3},{value:"Source",id:"source",level:4},{value:"type",id:"type",level:3},{value:"Source",id:"source-1",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,c.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"interface-auditrecord",children:"Interface: AuditRecord"}),"\n",(0,t.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,t.jsx)(n.h3,{id:"record",children:"record"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"record"}),": ",(0,t.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L334",children:"packages/extension-api/src/extension-api.d.ts:334"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"type",children:"type"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"type"}),": ",(0,t.jsx)(n.code,{children:'"error"'})," | ",(0,t.jsx)(n.code,{children:'"info"'})," | ",(0,t.jsx)(n.code,{children:'"warning"'})]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L333",children:"packages/extension-api/src/extension-api.d.ts:333"})})]})}function p(e={}){const{wrapper:n}={...(0,c.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},71670:(e,n,r)=>{r.d(n,{Z:()=>o,a:()=>i});var t=r(27378);const c={},s=t.createContext(c);function i(e){const n=t.useContext(s);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(c):e.components||c:i(e.components),t.createElement(s.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[51320],{81902:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>d,contentTitle:()=>i,default:()=>p,frontMatter:()=>c,metadata:()=>o,toc:()=>a});var t=r(24246),s=r(71670);const c={},i="Interface: AuditRecord",o={id:"interfaces/AuditRecord",title:"Interface: AuditRecord",description:"Properties",source:"@site/api/interfaces/AuditRecord.md",sourceDirName:"interfaces",slug:"/interfaces/AuditRecord",permalink:"/api/interfaces/AuditRecord",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Class: Uri",permalink:"/api/classes/Uri"},next:{title:"Interface: AuditRequestItems",permalink:"/api/interfaces/AuditRequestItems"}},d={},a=[{value:"Properties",id:"properties",level:2},{value:"record",id:"record",level:3},{value:"Source",id:"source",level:4},{value:"type",id:"type",level:3},{value:"Source",id:"source-1",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"interface-auditrecord",children:"Interface: AuditRecord"}),"\n",(0,t.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,t.jsx)(n.h3,{id:"record",children:"record"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"record"}),": ",(0,t.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L334",children:"packages/extension-api/src/extension-api.d.ts:334"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"type",children:"type"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"type"}),": ",(0,t.jsx)(n.code,{children:'"error"'})," | ",(0,t.jsx)(n.code,{children:'"info"'})," | ",(0,t.jsx)(n.code,{children:'"warning"'})]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L333",children:"packages/extension-api/src/extension-api.d.ts:333"})})]})}function p(e={}){const{wrapper:n}={...(0,s.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},71670:(e,n,r)=>{r.d(n,{Z:()=>o,a:()=>i});var t=r(27378);const s={},c=t.createContext(s);function i(e){const n=t.useContext(c);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:i(e.components),t.createElement(c.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/46b3c144.b6032b59.js b/assets/js/46b3c144.1e68703a.js similarity index 77% rename from assets/js/46b3c144.b6032b59.js rename to assets/js/46b3c144.1e68703a.js index df15a90d480..8c75f5c7462 100644 --- a/assets/js/46b3c144.b6032b59.js +++ b/assets/js/46b3c144.1e68703a.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[1868],{5e3:(e,n,o)=>{o.r(n),o.d(n,{assets:()=>a,contentTitle:()=>c,default:()=>l,frontMatter:()=>r,metadata:()=>i,toc:()=>d});var t=o(24246),s=o(71670);const r={},c="Interface: PodCreatePortOptions",i={id:"interfaces/PodCreatePortOptions",title:"Interface: PodCreatePortOptions",description:"Properties",source:"@site/api/interfaces/PodCreatePortOptions.md",sourceDirName:"interfaces",slug:"/interfaces/PodCreatePortOptions",permalink:"/api/interfaces/PodCreatePortOptions",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: PodCreateOptions",permalink:"/api/interfaces/PodCreateOptions"},next:{title:"Interface: PodInfo",permalink:"/api/interfaces/PodInfo"}},a={},d=[{value:"Properties",id:"properties",level:2},{value:"container_port",id:"container_port",level:3},{value:"Source",id:"source",level:4},{value:"host_ip",id:"host_ip",level:3},{value:"Source",id:"source-1",level:4},{value:"host_port",id:"host_port",level:3},{value:"Source",id:"source-2",level:4},{value:"protocol",id:"protocol",level:3},{value:"Source",id:"source-3",level:4},{value:"range",id:"range",level:3},{value:"Source",id:"source-4",level:4}];function p(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"interface-podcreateportoptions",children:"Interface: PodCreatePortOptions"}),"\n",(0,t.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,t.jsx)(n.h3,{id:"container_port",children:"container_port"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"container_port"}),": ",(0,t.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L274",children:"packages/extension-api/src/extension-api.d.ts:274"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"host_ip",children:"host_ip"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"host_ip"}),": ",(0,t.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L273",children:"packages/extension-api/src/extension-api.d.ts:273"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"host_port",children:"host_port"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"host_port"}),": ",(0,t.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L275",children:"packages/extension-api/src/extension-api.d.ts:275"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"protocol",children:"protocol"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"protocol"}),": ",(0,t.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L276",children:"packages/extension-api/src/extension-api.d.ts:276"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"range",children:"range"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"range"}),": ",(0,t.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"source-4",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L277",children:"packages/extension-api/src/extension-api.d.ts:277"})})]})}function l(e={}){const{wrapper:n}={...(0,s.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(p,{...e})}):p(e)}},71670:(e,n,o)=>{o.d(n,{Z:()=>i,a:()=>c});var t=o(27378);const s={},r=t.createContext(s);function c(e){const n=t.useContext(r);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function i(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:c(e.components),t.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[1868],{5e3:(e,n,o)=>{o.r(n),o.d(n,{assets:()=>d,contentTitle:()=>i,default:()=>l,frontMatter:()=>r,metadata:()=>c,toc:()=>a});var t=o(24246),s=o(71670);const r={},i="Interface: PodCreatePortOptions",c={id:"interfaces/PodCreatePortOptions",title:"Interface: PodCreatePortOptions",description:"Properties",source:"@site/api/interfaces/PodCreatePortOptions.md",sourceDirName:"interfaces",slug:"/interfaces/PodCreatePortOptions",permalink:"/api/interfaces/PodCreatePortOptions",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: PodCreateOptions",permalink:"/api/interfaces/PodCreateOptions"},next:{title:"Interface: PodInfo",permalink:"/api/interfaces/PodInfo"}},d={},a=[{value:"Properties",id:"properties",level:2},{value:"container_port",id:"container_port",level:3},{value:"Source",id:"source",level:4},{value:"host_ip",id:"host_ip",level:3},{value:"Source",id:"source-1",level:4},{value:"host_port",id:"host_port",level:3},{value:"Source",id:"source-2",level:4},{value:"protocol",id:"protocol",level:3},{value:"Source",id:"source-3",level:4},{value:"range",id:"range",level:3},{value:"Source",id:"source-4",level:4}];function p(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"interface-podcreateportoptions",children:"Interface: PodCreatePortOptions"}),"\n",(0,t.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,t.jsx)(n.h3,{id:"container_port",children:"container_port"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"container_port"}),": ",(0,t.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L274",children:"packages/extension-api/src/extension-api.d.ts:274"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"host_ip",children:"host_ip"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"host_ip"}),": ",(0,t.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L273",children:"packages/extension-api/src/extension-api.d.ts:273"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"host_port",children:"host_port"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"host_port"}),": ",(0,t.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L275",children:"packages/extension-api/src/extension-api.d.ts:275"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"protocol",children:"protocol"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"protocol"}),": ",(0,t.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L276",children:"packages/extension-api/src/extension-api.d.ts:276"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"range",children:"range"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"range"}),": ",(0,t.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"source-4",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L277",children:"packages/extension-api/src/extension-api.d.ts:277"})})]})}function l(e={}){const{wrapper:n}={...(0,s.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(p,{...e})}):p(e)}},71670:(e,n,o)=>{o.d(n,{Z:()=>c,a:()=>i});var t=o(27378);const s={},r=t.createContext(s);function i(e){const n=t.useContext(r);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:i(e.components),t.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/494e8e75.ff6efc1f.js b/assets/js/494e8e75.64e87537.js similarity index 94% rename from assets/js/494e8e75.ff6efc1f.js rename to assets/js/494e8e75.64e87537.js index bbb8d3b428e..9dfd14e6bd8 100644 --- a/assets/js/494e8e75.ff6efc1f.js +++ b/assets/js/494e8e75.64e87537.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[49076],{32849:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>s,default:()=>l,frontMatter:()=>o,metadata:()=>c,toc:()=>d});var r=t(24246),i=t(71670);const o={},s="Interface: UnregisterContainerConnectionEvent",c={id:"interfaces/UnregisterContainerConnectionEvent",title:"Interface: UnregisterContainerConnectionEvent",description:"Properties",source:"@site/api/interfaces/UnregisterContainerConnectionEvent.md",sourceDirName:"interfaces",slug:"/interfaces/UnregisterContainerConnectionEvent",permalink:"/api/interfaces/UnregisterContainerConnectionEvent",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: ThrottlingData",permalink:"/api/interfaces/ThrottlingData"},next:{title:"Interface: UnregisterKubernetesConnectionEvent",permalink:"/api/interfaces/UnregisterKubernetesConnectionEvent"}},a={},d=[{value:"Properties",id:"properties",level:2},{value:"providerId",id:"providerid",level:3},{value:"Source",id:"source",level:4}];function p(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",p:"p",strong:"strong",...(0,i.a)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.h1,{id:"interface-unregistercontainerconnectionevent",children:"Interface: UnregisterContainerConnectionEvent"}),"\n",(0,r.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,r.jsx)(n.h3,{id:"providerid",children:"providerId"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"providerId"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L527",children:"packages/extension-api/src/extension-api.d.ts:527"})})]})}function l(e={}){const{wrapper:n}={...(0,i.a)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(p,{...e})}):p(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>c,a:()=>s});var r=t(27378);const i={},o=r.createContext(i);function s(e){const n=r.useContext(o);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:s(e.components),r.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[49076],{32849:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>s,default:()=>l,frontMatter:()=>o,metadata:()=>c,toc:()=>d});var r=t(24246),i=t(71670);const o={},s="Interface: UnregisterContainerConnectionEvent",c={id:"interfaces/UnregisterContainerConnectionEvent",title:"Interface: UnregisterContainerConnectionEvent",description:"Properties",source:"@site/api/interfaces/UnregisterContainerConnectionEvent.md",sourceDirName:"interfaces",slug:"/interfaces/UnregisterContainerConnectionEvent",permalink:"/api/interfaces/UnregisterContainerConnectionEvent",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: ThrottlingData",permalink:"/api/interfaces/ThrottlingData"},next:{title:"Interface: UnregisterKubernetesConnectionEvent",permalink:"/api/interfaces/UnregisterKubernetesConnectionEvent"}},a={},d=[{value:"Properties",id:"properties",level:2},{value:"providerId",id:"providerid",level:3},{value:"Source",id:"source",level:4}];function p(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",p:"p",strong:"strong",...(0,i.a)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.h1,{id:"interface-unregistercontainerconnectionevent",children:"Interface: UnregisterContainerConnectionEvent"}),"\n",(0,r.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,r.jsx)(n.h3,{id:"providerid",children:"providerId"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"providerId"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L527",children:"packages/extension-api/src/extension-api.d.ts:527"})})]})}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.f2002d66.js b/assets/js/49bee2be.a456763c.js similarity index 82% rename from assets/js/49bee2be.f2002d66.js rename to assets/js/49bee2be.a456763c.js index 00bd8b1aed0..36ad38fe47f 100644 --- a/assets/js/49bee2be.f2002d66.js +++ b/assets/js/49bee2be.a456763c.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[80448],{35471:(n,e,t)=>{t.r(e),t.d(e,{assets:()=>r,contentTitle:()=>s,default:()=>l,frontMatter:()=>a,metadata:()=>c,toc:()=>u});var i=t(24246),o=t(71670);const a={},s="Function: navigateToContainers()",c={id:"namespaces/navigation/functions/navigateToContainers",title:"Function: navigateToContainers()",description:"navigateToContainers(): Promise\\",source:"@site/api/namespaces/navigation/functions/navigateToContainers.md",sourceDirName:"namespaces/navigation/functions",slug:"/namespaces/navigation/functions/navigateToContainers",permalink:"/api/namespaces/navigation/functions/navigateToContainers",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Function: navigateToContainerTerminal()",permalink:"/api/namespaces/navigation/functions/navigateToContainerTerminal"},next:{title:"Function: navigateToContribution()",permalink:"/api/namespaces/navigation/functions/navigateToContribution"}},r={},u=[{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function d(n){const e={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,o.a)(),...n.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(e.h1,{id:"function-navigatetocontainers",children:"Function: navigateToContainers()"}),"\n",(0,i.jsxs)(e.blockquote,{children:["\n",(0,i.jsxs)(e.p,{children:[(0,i.jsx)(e.strong,{children:"navigateToContainers"}),"(): ",(0,i.jsx)(e.code,{children:"Promise"}),"< ",(0,i.jsx)(e.code,{children:"void"})," >"]}),"\n"]}),"\n",(0,i.jsx)(e.h2,{id:"returns",children:"Returns"}),"\n",(0,i.jsxs)(e.p,{children:[(0,i.jsx)(e.code,{children:"Promise"}),"< ",(0,i.jsx)(e.code,{children:"void"})," >"]}),"\n",(0,i.jsx)(e.h2,{id:"source",children:"Source"}),"\n",(0,i.jsx)(e.p,{children:(0,i.jsx)(e.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L4142",children:"packages/extension-api/src/extension-api.d.ts:4142"})})]})}function l(n={}){const{wrapper:e}={...(0,o.a)(),...n.components};return e?(0,i.jsx)(e,{...n,children:(0,i.jsx)(d,{...n})}):d(n)}},71670:(n,e,t)=>{t.d(e,{Z:()=>c,a:()=>s});var i=t(27378);const o={},a=i.createContext(o);function s(n){const e=i.useContext(a);return i.useMemo((function(){return"function"==typeof n?n(e):{...e,...n}}),[e,n])}function c(n){let e;return e=n.disableParentContext?"function"==typeof n.components?n.components(o):n.components||o:s(n.components),i.createElement(a.Provider,{value:e},n.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[80448],{35471:(n,e,t)=>{t.r(e),t.d(e,{assets:()=>c,contentTitle:()=>s,default:()=>l,frontMatter:()=>a,metadata:()=>r,toc:()=>u});var i=t(24246),o=t(71670);const a={},s="Function: navigateToContainers()",r={id:"namespaces/navigation/functions/navigateToContainers",title:"Function: navigateToContainers()",description:"navigateToContainers(): Promise\\",source:"@site/api/namespaces/navigation/functions/navigateToContainers.md",sourceDirName:"namespaces/navigation/functions",slug:"/namespaces/navigation/functions/navigateToContainers",permalink:"/api/namespaces/navigation/functions/navigateToContainers",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Function: navigateToContainerTerminal()",permalink:"/api/namespaces/navigation/functions/navigateToContainerTerminal"},next:{title:"Function: navigateToContribution()",permalink:"/api/namespaces/navigation/functions/navigateToContribution"}},c={},u=[{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function d(n){const e={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,o.a)(),...n.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(e.h1,{id:"function-navigatetocontainers",children:"Function: navigateToContainers()"}),"\n",(0,i.jsxs)(e.blockquote,{children:["\n",(0,i.jsxs)(e.p,{children:[(0,i.jsx)(e.strong,{children:"navigateToContainers"}),"(): ",(0,i.jsx)(e.code,{children:"Promise"}),"< ",(0,i.jsx)(e.code,{children:"void"})," >"]}),"\n"]}),"\n",(0,i.jsx)(e.h2,{id:"returns",children:"Returns"}),"\n",(0,i.jsxs)(e.p,{children:[(0,i.jsx)(e.code,{children:"Promise"}),"< ",(0,i.jsx)(e.code,{children:"void"})," >"]}),"\n",(0,i.jsx)(e.h2,{id:"source",children:"Source"}),"\n",(0,i.jsx)(e.p,{children:(0,i.jsx)(e.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L4142",children:"packages/extension-api/src/extension-api.d.ts:4142"})})]})}function l(n={}){const{wrapper:e}={...(0,o.a)(),...n.components};return e?(0,i.jsx)(e,{...n,children:(0,i.jsx)(d,{...n})}):d(n)}},71670:(n,e,t)=>{t.d(e,{Z:()=>r,a:()=>s});var i=t(27378);const o={},a=i.createContext(o);function s(n){const e=i.useContext(a);return i.useMemo((function(){return"function"==typeof n?n(e):{...e,...n}}),[e,n])}function r(n){let e;return e=n.disableParentContext?"function"==typeof n.components?n.components(o):n.components||o:s(n.components),i.createElement(a.Provider,{value:e},n.children)}}}]); \ No newline at end of file diff --git a/assets/js/49d9416a.9c1c7d1c.js b/assets/js/49d9416a.e1d5d91d.js similarity index 96% rename from assets/js/49d9416a.9c1c7d1c.js rename to assets/js/49d9416a.e1d5d91d.js index f9f0590db89..3fe533da947 100644 --- a/assets/js/49d9416a.9c1c7d1c.js +++ b/assets/js/49d9416a.e1d5d91d.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[11077],{84149:(n,e,t)=>{t.r(e),t.d(e,{assets:()=>c,contentTitle:()=>o,default:()=>u,frontMatter:()=>r,metadata:()=>a,toc:()=>d});var i=t(24246),s=t(71670);const r={},o="Function: startContainer()",a={id:"namespaces/containerEngine/functions/startContainer",title:"Function: startContainer()",description:"startContainer(engineId, id): Promise\\",source:"@site/api/namespaces/containerEngine/functions/startContainer.md",sourceDirName:"namespaces/containerEngine/functions",slug:"/namespaces/containerEngine/functions/startContainer",permalink:"/api/namespaces/containerEngine/functions/startContainer",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Function: saveImage()",permalink:"/api/namespaces/containerEngine/functions/saveImage"},next:{title:"Function: startPod()",permalink:"/api/namespaces/containerEngine/functions/startPod"}},c={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function l(n){const e={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,s.a)(),...n.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(e.h1,{id:"function-startcontainer",children:"Function: startContainer()"}),"\n",(0,i.jsxs)(e.blockquote,{children:["\n",(0,i.jsxs)(e.p,{children:[(0,i.jsx)(e.strong,{children:"startContainer"}),"(",(0,i.jsx)(e.code,{children:"engineId"}),", ",(0,i.jsx)(e.code,{children:"id"}),"): ",(0,i.jsx)(e.code,{children:"Promise"}),"< ",(0,i.jsx)(e.code,{children:"void"})," >"]}),"\n"]}),"\n",(0,i.jsx)(e.p,{children:"Start an existing container"}),"\n",(0,i.jsx)(e.h2,{id:"parameters",children:"Parameters"}),"\n",(0,i.jsxs)(e.p,{children:["\u2022 ",(0,i.jsx)(e.strong,{children:"engineId"}),": ",(0,i.jsx)(e.code,{children:"string"})]}),"\n",(0,i.jsxs)(e.p,{children:["the id of the engine managing the container, obtained from the result of ",(0,i.jsx)(e.a,{href:"/api/namespaces/containerEngine/functions/listContainers",children:"containerEngine.listContainers"})]}),"\n",(0,i.jsxs)(e.p,{children:["\u2022 ",(0,i.jsx)(e.strong,{children:"id"}),": ",(0,i.jsx)(e.code,{children:"string"})]}),"\n",(0,i.jsxs)(e.p,{children:["the id or name of the container on this engine, obtained from the result of ",(0,i.jsx)(e.a,{href:"/api/namespaces/containerEngine/functions/listContainers",children:"containerEngine.listContainers"})," or as the result of ",(0,i.jsx)(e.a,{href:"/api/namespaces/containerEngine/functions/createContainer",children:"containerEngine.createContainer"})]}),"\n",(0,i.jsx)(e.h2,{id:"returns",children:"Returns"}),"\n",(0,i.jsxs)(e.p,{children:[(0,i.jsx)(e.code,{children:"Promise"}),"< ",(0,i.jsx)(e.code,{children:"void"})," >"]}),"\n",(0,i.jsx)(e.h2,{id:"source",children:"Source"}),"\n",(0,i.jsx)(e.p,{children:(0,i.jsx)(e.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L3187",children:"packages/extension-api/src/extension-api.d.ts:3187"})})]})}function u(n={}){const{wrapper:e}={...(0,s.a)(),...n.components};return e?(0,i.jsx)(e,{...n,children:(0,i.jsx)(l,{...n})}):l(n)}},71670:(n,e,t)=>{t.d(e,{Z:()=>a,a:()=>o});var i=t(27378);const s={},r=i.createContext(s);function o(n){const e=i.useContext(r);return i.useMemo((function(){return"function"==typeof n?n(e):{...e,...n}}),[e,n])}function a(n){let e;return e=n.disableParentContext?"function"==typeof n.components?n.components(s):n.components||s:o(n.components),i.createElement(r.Provider,{value:e},n.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[11077],{84149:(n,e,t)=>{t.r(e),t.d(e,{assets:()=>c,contentTitle:()=>o,default:()=>u,frontMatter:()=>r,metadata:()=>a,toc:()=>d});var i=t(24246),s=t(71670);const r={},o="Function: startContainer()",a={id:"namespaces/containerEngine/functions/startContainer",title:"Function: startContainer()",description:"startContainer(engineId, id): Promise\\",source:"@site/api/namespaces/containerEngine/functions/startContainer.md",sourceDirName:"namespaces/containerEngine/functions",slug:"/namespaces/containerEngine/functions/startContainer",permalink:"/api/namespaces/containerEngine/functions/startContainer",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Function: saveImage()",permalink:"/api/namespaces/containerEngine/functions/saveImage"},next:{title:"Function: startPod()",permalink:"/api/namespaces/containerEngine/functions/startPod"}},c={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function l(n){const e={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,s.a)(),...n.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(e.h1,{id:"function-startcontainer",children:"Function: startContainer()"}),"\n",(0,i.jsxs)(e.blockquote,{children:["\n",(0,i.jsxs)(e.p,{children:[(0,i.jsx)(e.strong,{children:"startContainer"}),"(",(0,i.jsx)(e.code,{children:"engineId"}),", ",(0,i.jsx)(e.code,{children:"id"}),"): ",(0,i.jsx)(e.code,{children:"Promise"}),"< ",(0,i.jsx)(e.code,{children:"void"})," >"]}),"\n"]}),"\n",(0,i.jsx)(e.p,{children:"Start an existing container"}),"\n",(0,i.jsx)(e.h2,{id:"parameters",children:"Parameters"}),"\n",(0,i.jsxs)(e.p,{children:["\u2022 ",(0,i.jsx)(e.strong,{children:"engineId"}),": ",(0,i.jsx)(e.code,{children:"string"})]}),"\n",(0,i.jsxs)(e.p,{children:["the id of the engine managing the container, obtained from the result of ",(0,i.jsx)(e.a,{href:"/api/namespaces/containerEngine/functions/listContainers",children:"containerEngine.listContainers"})]}),"\n",(0,i.jsxs)(e.p,{children:["\u2022 ",(0,i.jsx)(e.strong,{children:"id"}),": ",(0,i.jsx)(e.code,{children:"string"})]}),"\n",(0,i.jsxs)(e.p,{children:["the id or name of the container on this engine, obtained from the result of ",(0,i.jsx)(e.a,{href:"/api/namespaces/containerEngine/functions/listContainers",children:"containerEngine.listContainers"})," or as the result of ",(0,i.jsx)(e.a,{href:"/api/namespaces/containerEngine/functions/createContainer",children:"containerEngine.createContainer"})]}),"\n",(0,i.jsx)(e.h2,{id:"returns",children:"Returns"}),"\n",(0,i.jsxs)(e.p,{children:[(0,i.jsx)(e.code,{children:"Promise"}),"< ",(0,i.jsx)(e.code,{children:"void"})," >"]}),"\n",(0,i.jsx)(e.h2,{id:"source",children:"Source"}),"\n",(0,i.jsx)(e.p,{children:(0,i.jsx)(e.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L3187",children:"packages/extension-api/src/extension-api.d.ts:3187"})})]})}function u(n={}){const{wrapper:e}={...(0,s.a)(),...n.components};return e?(0,i.jsx)(e,{...n,children:(0,i.jsx)(l,{...n})}):l(n)}},71670:(n,e,t)=>{t.d(e,{Z:()=>a,a:()=>o});var i=t(27378);const s={},r=i.createContext(s);function o(n){const e=i.useContext(r);return i.useMemo((function(){return"function"==typeof n?n(e):{...e,...n}}),[e,n])}function a(n){let e;return e=n.disableParentContext?"function"==typeof n.components?n.components(s):n.components||s:o(n.components),i.createElement(r.Provider,{value:e},n.children)}}}]); \ No newline at end of file diff --git a/assets/js/4c217c25.480c06c7.js b/assets/js/4c217c25.8f39ef22.js similarity index 94% rename from assets/js/4c217c25.480c06c7.js rename to assets/js/4c217c25.8f39ef22.js index 550ef3fc41d..78da2e1d61f 100644 --- a/assets/js/4c217c25.480c06c7.js +++ b/assets/js/4c217c25.8f39ef22.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[81900],{28482:(n,e,t)=>{t.r(e),t.d(e,{assets:()=>a,contentTitle:()=>r,default:()=>p,frontMatter:()=>o,metadata:()=>c,toc:()=>l});var i=t(24246),s=t(71670);const o={},r="Function: listContainers()",c={id:"namespaces/containerEngine/functions/listContainers",title:"Function: listContainers()",description:"listContainers(): Promise\\",source:"@site/api/namespaces/containerEngine/functions/listContainers.md",sourceDirName:"namespaces/containerEngine/functions",slug:"/namespaces/containerEngine/functions/listContainers",permalink:"/api/namespaces/containerEngine/functions/listContainers",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Function: inspectContainer()",permalink:"/api/namespaces/containerEngine/functions/inspectContainer"},next:{title:"Function: listImages()",permalink:"/api/namespaces/containerEngine/functions/listImages"}},a={},l=[{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function u(n){const e={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,s.a)(),...n.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(e.h1,{id:"function-listcontainers",children:"Function: listContainers()"}),"\n",(0,i.jsxs)(e.blockquote,{children:["\n",(0,i.jsxs)(e.p,{children:[(0,i.jsx)(e.strong,{children:"listContainers"}),"(): ",(0,i.jsx)(e.code,{children:"Promise"}),"< ",(0,i.jsx)(e.a,{href:"/api/interfaces/ContainerInfo",children:(0,i.jsx)(e.code,{children:"ContainerInfo"})}),"[] >"]}),"\n"]}),"\n",(0,i.jsx)(e.p,{children:"Returns the list of containers across all container engines, in any state (running or not)."}),"\n",(0,i.jsx)(e.h2,{id:"returns",children:"Returns"}),"\n",(0,i.jsxs)(e.p,{children:[(0,i.jsx)(e.code,{children:"Promise"}),"< ",(0,i.jsx)(e.a,{href:"/api/interfaces/ContainerInfo",children:(0,i.jsx)(e.code,{children:"ContainerInfo"})}),"[] >"]}),"\n",(0,i.jsxs)(e.p,{children:["A promise resolving to an array of containers information. This method returns a subset of the available information for containers. To get the complete description of a specific container, you can use the ",(0,i.jsx)(e.a,{href:"/api/namespaces/containerEngine/functions/inspectContainer",children:"containerEngine.inspectContainer"})," method."]}),"\n",(0,i.jsx)(e.h2,{id:"source",children:"Source"}),"\n",(0,i.jsx)(e.p,{children:(0,i.jsx)(e.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L3158",children:"packages/extension-api/src/extension-api.d.ts:3158"})})]})}function p(n={}){const{wrapper:e}={...(0,s.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:()=>r});var i=t(27378);const s={},o=i.createContext(s);function r(n){const e=i.useContext(o);return i.useMemo((function(){return"function"==typeof n?n(e):{...e,...n}}),[e,n])}function c(n){let e;return e=n.disableParentContext?"function"==typeof n.components?n.components(s):n.components||s:r(n.components),i.createElement(o.Provider,{value:e},n.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[81900],{28482:(n,e,t)=>{t.r(e),t.d(e,{assets:()=>a,contentTitle:()=>r,default:()=>d,frontMatter:()=>o,metadata:()=>c,toc:()=>l});var i=t(24246),s=t(71670);const o={},r="Function: listContainers()",c={id:"namespaces/containerEngine/functions/listContainers",title:"Function: listContainers()",description:"listContainers(): Promise\\",source:"@site/api/namespaces/containerEngine/functions/listContainers.md",sourceDirName:"namespaces/containerEngine/functions",slug:"/namespaces/containerEngine/functions/listContainers",permalink:"/api/namespaces/containerEngine/functions/listContainers",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Function: inspectContainer()",permalink:"/api/namespaces/containerEngine/functions/inspectContainer"},next:{title:"Function: listImages()",permalink:"/api/namespaces/containerEngine/functions/listImages"}},a={},l=[{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function u(n){const e={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,s.a)(),...n.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(e.h1,{id:"function-listcontainers",children:"Function: listContainers()"}),"\n",(0,i.jsxs)(e.blockquote,{children:["\n",(0,i.jsxs)(e.p,{children:[(0,i.jsx)(e.strong,{children:"listContainers"}),"(): ",(0,i.jsx)(e.code,{children:"Promise"}),"< ",(0,i.jsx)(e.a,{href:"/api/interfaces/ContainerInfo",children:(0,i.jsx)(e.code,{children:"ContainerInfo"})}),"[] >"]}),"\n"]}),"\n",(0,i.jsx)(e.p,{children:"Returns the list of containers across all container engines, in any state (running or not)."}),"\n",(0,i.jsx)(e.h2,{id:"returns",children:"Returns"}),"\n",(0,i.jsxs)(e.p,{children:[(0,i.jsx)(e.code,{children:"Promise"}),"< ",(0,i.jsx)(e.a,{href:"/api/interfaces/ContainerInfo",children:(0,i.jsx)(e.code,{children:"ContainerInfo"})}),"[] >"]}),"\n",(0,i.jsxs)(e.p,{children:["A promise resolving to an array of containers information. This method returns a subset of the available information for containers. To get the complete description of a specific container, you can use the ",(0,i.jsx)(e.a,{href:"/api/namespaces/containerEngine/functions/inspectContainer",children:"containerEngine.inspectContainer"})," method."]}),"\n",(0,i.jsx)(e.h2,{id:"source",children:"Source"}),"\n",(0,i.jsx)(e.p,{children:(0,i.jsx)(e.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L3158",children:"packages/extension-api/src/extension-api.d.ts:3158"})})]})}function d(n={}){const{wrapper:e}={...(0,s.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:()=>r});var i=t(27378);const s={},o=i.createContext(s);function r(n){const e=i.useContext(o);return i.useMemo((function(){return"function"==typeof n?n(e):{...e,...n}}),[e,n])}function c(n){let e;return e=n.disableParentContext?"function"==typeof n.components?n.components(s):n.components||s:r(n.components),i.createElement(o.Provider,{value:e},n.children)}}}]); \ No newline at end of file diff --git a/assets/js/4c5becac.3618ce01.js b/assets/js/4c5becac.0f710a8d.js similarity index 87% rename from assets/js/4c5becac.3618ce01.js rename to assets/js/4c5becac.0f710a8d.js index b904f02e98b..6411247dec1 100644 --- a/assets/js/4c5becac.3618ce01.js +++ b/assets/js/4c5becac.0f710a8d.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[74961],{52519:(e,s,n)=>{n.r(s),n.d(s,{assets:()=>l,contentTitle:()=>c,default:()=>h,frontMatter:()=>i,metadata:()=>o,toc:()=>d});var t=n(24246),r=n(71670);const i={},c="Class: EventEmitter",o={id:"classes/EventEmitter",title:"Class: EventEmitter\\",description:"A class to create and manage an Event for clients to subscribe to.",source:"@site/api/classes/EventEmitter.md",sourceDirName:"classes",slug:"/classes/EventEmitter",permalink:"/api/classes/EventEmitter",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Class: Disposable",permalink:"/api/classes/Disposable"},next:{title:"Class: TelemetryTrustedValue\\",permalink:"/api/classes/TelemetryTrustedValue"}},l={},d=[{value:"Type parameters",id:"type-parameters",level:2},{value:"Constructors",id:"constructors",level:2},{value:"new EventEmitter()",id:"new-eventemitter",level:3},{value:"Returns",id:"returns",level:4},{value:"Properties",id:"properties",level:2},{value:"event",id:"event",level:3},{value:"Source",id:"source",level:4},{value:"Methods",id:"methods",level:2},{value:"dispose()",id:"dispose",level:3},{value:"Returns",id:"returns-1",level:4},{value:"Source",id:"source-1",level:4},{value:"fire()",id:"fire",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns-2",level:4},{value:"Source",id:"source-2",level:4}];function a(e){const s={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,r.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(s.h1,{id:"class-eventemittert",children:"Class: EventEmitter"}),"\n",(0,t.jsxs)(s.p,{children:["A class to create and manage an ",(0,t.jsx)(s.a,{href:"/api/interfaces/Event",children:"Event"})," for clients to subscribe to.\nThe emitter can only send one kind of event."]}),"\n",(0,t.jsx)(s.p,{children:"Use this class to send events inside extension or provide API to the other\nextensions."}),"\n",(0,t.jsx)(s.h2,{id:"type-parameters",children:"Type parameters"}),"\n",(0,t.jsxs)(s.p,{children:["\u2022 ",(0,t.jsx)(s.strong,{children:"T"})]}),"\n",(0,t.jsx)(s.h2,{id:"constructors",children:"Constructors"}),"\n",(0,t.jsx)(s.h3,{id:"new-eventemitter",children:"new EventEmitter()"}),"\n",(0,t.jsxs)(s.blockquote,{children:["\n",(0,t.jsxs)(s.p,{children:[(0,t.jsx)(s.strong,{children:"new EventEmitter"}),"<",(0,t.jsx)(s.code,{children:"T"}),">(): ",(0,t.jsx)(s.a,{href:"/api/classes/EventEmitter",children:(0,t.jsx)(s.code,{children:"EventEmitter"})}),"< ",(0,t.jsx)(s.code,{children:"T"})," >"]}),"\n"]}),"\n",(0,t.jsx)(s.h4,{id:"returns",children:"Returns"}),"\n",(0,t.jsxs)(s.p,{children:[(0,t.jsx)(s.a,{href:"/api/classes/EventEmitter",children:(0,t.jsx)(s.code,{children:"EventEmitter"})}),"< ",(0,t.jsx)(s.code,{children:"T"})," >"]}),"\n",(0,t.jsx)(s.h2,{id:"properties",children:"Properties"}),"\n",(0,t.jsx)(s.h3,{id:"event",children:"event"}),"\n",(0,t.jsxs)(s.blockquote,{children:["\n",(0,t.jsxs)(s.p,{children:[(0,t.jsx)(s.strong,{children:"event"}),": ",(0,t.jsx)(s.a,{href:"/api/interfaces/Event",children:(0,t.jsx)(s.code,{children:"Event"})}),"< ",(0,t.jsx)(s.code,{children:"T"})," >"]}),"\n"]}),"\n",(0,t.jsx)(s.p,{children:"For the public to allow to subscribe to events from this Emitter"}),"\n",(0,t.jsx)(s.h4,{id:"source",children:"Source"}),"\n",(0,t.jsx)(s.p,{children:(0,t.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L120",children:"packages/extension-api/src/extension-api.d.ts:120"})}),"\n",(0,t.jsx)(s.h2,{id:"methods",children:"Methods"}),"\n",(0,t.jsx)(s.h3,{id:"dispose",children:"dispose()"}),"\n",(0,t.jsxs)(s.blockquote,{children:["\n",(0,t.jsxs)(s.p,{children:[(0,t.jsx)(s.strong,{children:"dispose"}),"(): ",(0,t.jsx)(s.code,{children:"void"})]}),"\n"]}),"\n",(0,t.jsx)(s.p,{children:"Dispose by removing registered listeners"}),"\n",(0,t.jsx)(s.h4,{id:"returns-1",children:"Returns"}),"\n",(0,t.jsx)(s.p,{children:(0,t.jsx)(s.code,{children:"void"})}),"\n",(0,t.jsx)(s.h4,{id:"source-1",children:"Source"}),"\n",(0,t.jsx)(s.p,{children:(0,t.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L129",children:"packages/extension-api/src/extension-api.d.ts:129"})}),"\n",(0,t.jsx)(s.hr,{}),"\n",(0,t.jsx)(s.h3,{id:"fire",children:"fire()"}),"\n",(0,t.jsxs)(s.blockquote,{children:["\n",(0,t.jsxs)(s.p,{children:[(0,t.jsx)(s.strong,{children:"fire"}),"(",(0,t.jsx)(s.code,{children:"data"}),"): ",(0,t.jsx)(s.code,{children:"void"})]}),"\n"]}),"\n",(0,t.jsx)(s.p,{children:"To fire an event to the subscribers"}),"\n",(0,t.jsx)(s.h4,{id:"parameters",children:"Parameters"}),"\n",(0,t.jsxs)(s.p,{children:["\u2022 ",(0,t.jsx)(s.strong,{children:"data"}),": ",(0,t.jsx)(s.code,{children:"T"})]}),"\n",(0,t.jsx)(s.h4,{id:"returns-2",children:"Returns"}),"\n",(0,t.jsx)(s.p,{children:(0,t.jsx)(s.code,{children:"void"})}),"\n",(0,t.jsx)(s.h4,{id:"source-2",children:"Source"}),"\n",(0,t.jsx)(s.p,{children:(0,t.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L125",children:"packages/extension-api/src/extension-api.d.ts:125"})})]})}function h(e={}){const{wrapper:s}={...(0,r.a)(),...e.components};return s?(0,t.jsx)(s,{...e,children:(0,t.jsx)(a,{...e})}):a(e)}},71670:(e,s,n)=>{n.d(s,{Z:()=>o,a:()=>c});var t=n(27378);const r={},i=t.createContext(r);function c(e){const s=t.useContext(i);return t.useMemo((function(){return"function"==typeof e?e(s):{...s,...e}}),[s,e])}function o(e){let s;return s=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:c(e.components),t.createElement(i.Provider,{value:s},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[74961],{52519:(e,s,n)=>{n.r(s),n.d(s,{assets:()=>o,contentTitle:()=>c,default:()=>h,frontMatter:()=>i,metadata:()=>d,toc:()=>l});var t=n(24246),r=n(71670);const i={},c="Class: EventEmitter",d={id:"classes/EventEmitter",title:"Class: EventEmitter\\",description:"A class to create and manage an Event for clients to subscribe to.",source:"@site/api/classes/EventEmitter.md",sourceDirName:"classes",slug:"/classes/EventEmitter",permalink:"/api/classes/EventEmitter",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Class: Disposable",permalink:"/api/classes/Disposable"},next:{title:"Class: TelemetryTrustedValue\\",permalink:"/api/classes/TelemetryTrustedValue"}},o={},l=[{value:"Type parameters",id:"type-parameters",level:2},{value:"Constructors",id:"constructors",level:2},{value:"new EventEmitter()",id:"new-eventemitter",level:3},{value:"Returns",id:"returns",level:4},{value:"Properties",id:"properties",level:2},{value:"event",id:"event",level:3},{value:"Source",id:"source",level:4},{value:"Methods",id:"methods",level:2},{value:"dispose()",id:"dispose",level:3},{value:"Returns",id:"returns-1",level:4},{value:"Source",id:"source-1",level:4},{value:"fire()",id:"fire",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns-2",level:4},{value:"Source",id:"source-2",level:4}];function a(e){const s={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,r.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(s.h1,{id:"class-eventemittert",children:"Class: EventEmitter"}),"\n",(0,t.jsxs)(s.p,{children:["A class to create and manage an ",(0,t.jsx)(s.a,{href:"/api/interfaces/Event",children:"Event"})," for clients to subscribe to.\nThe emitter can only send one kind of event."]}),"\n",(0,t.jsx)(s.p,{children:"Use this class to send events inside extension or provide API to the other\nextensions."}),"\n",(0,t.jsx)(s.h2,{id:"type-parameters",children:"Type parameters"}),"\n",(0,t.jsxs)(s.p,{children:["\u2022 ",(0,t.jsx)(s.strong,{children:"T"})]}),"\n",(0,t.jsx)(s.h2,{id:"constructors",children:"Constructors"}),"\n",(0,t.jsx)(s.h3,{id:"new-eventemitter",children:"new EventEmitter()"}),"\n",(0,t.jsxs)(s.blockquote,{children:["\n",(0,t.jsxs)(s.p,{children:[(0,t.jsx)(s.strong,{children:"new EventEmitter"}),"<",(0,t.jsx)(s.code,{children:"T"}),">(): ",(0,t.jsx)(s.a,{href:"/api/classes/EventEmitter",children:(0,t.jsx)(s.code,{children:"EventEmitter"})}),"< ",(0,t.jsx)(s.code,{children:"T"})," >"]}),"\n"]}),"\n",(0,t.jsx)(s.h4,{id:"returns",children:"Returns"}),"\n",(0,t.jsxs)(s.p,{children:[(0,t.jsx)(s.a,{href:"/api/classes/EventEmitter",children:(0,t.jsx)(s.code,{children:"EventEmitter"})}),"< ",(0,t.jsx)(s.code,{children:"T"})," >"]}),"\n",(0,t.jsx)(s.h2,{id:"properties",children:"Properties"}),"\n",(0,t.jsx)(s.h3,{id:"event",children:"event"}),"\n",(0,t.jsxs)(s.blockquote,{children:["\n",(0,t.jsxs)(s.p,{children:[(0,t.jsx)(s.strong,{children:"event"}),": ",(0,t.jsx)(s.a,{href:"/api/interfaces/Event",children:(0,t.jsx)(s.code,{children:"Event"})}),"< ",(0,t.jsx)(s.code,{children:"T"})," >"]}),"\n"]}),"\n",(0,t.jsx)(s.p,{children:"For the public to allow to subscribe to events from this Emitter"}),"\n",(0,t.jsx)(s.h4,{id:"source",children:"Source"}),"\n",(0,t.jsx)(s.p,{children:(0,t.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L120",children:"packages/extension-api/src/extension-api.d.ts:120"})}),"\n",(0,t.jsx)(s.h2,{id:"methods",children:"Methods"}),"\n",(0,t.jsx)(s.h3,{id:"dispose",children:"dispose()"}),"\n",(0,t.jsxs)(s.blockquote,{children:["\n",(0,t.jsxs)(s.p,{children:[(0,t.jsx)(s.strong,{children:"dispose"}),"(): ",(0,t.jsx)(s.code,{children:"void"})]}),"\n"]}),"\n",(0,t.jsx)(s.p,{children:"Dispose by removing registered listeners"}),"\n",(0,t.jsx)(s.h4,{id:"returns-1",children:"Returns"}),"\n",(0,t.jsx)(s.p,{children:(0,t.jsx)(s.code,{children:"void"})}),"\n",(0,t.jsx)(s.h4,{id:"source-1",children:"Source"}),"\n",(0,t.jsx)(s.p,{children:(0,t.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L129",children:"packages/extension-api/src/extension-api.d.ts:129"})}),"\n",(0,t.jsx)(s.hr,{}),"\n",(0,t.jsx)(s.h3,{id:"fire",children:"fire()"}),"\n",(0,t.jsxs)(s.blockquote,{children:["\n",(0,t.jsxs)(s.p,{children:[(0,t.jsx)(s.strong,{children:"fire"}),"(",(0,t.jsx)(s.code,{children:"data"}),"): ",(0,t.jsx)(s.code,{children:"void"})]}),"\n"]}),"\n",(0,t.jsx)(s.p,{children:"To fire an event to the subscribers"}),"\n",(0,t.jsx)(s.h4,{id:"parameters",children:"Parameters"}),"\n",(0,t.jsxs)(s.p,{children:["\u2022 ",(0,t.jsx)(s.strong,{children:"data"}),": ",(0,t.jsx)(s.code,{children:"T"})]}),"\n",(0,t.jsx)(s.h4,{id:"returns-2",children:"Returns"}),"\n",(0,t.jsx)(s.p,{children:(0,t.jsx)(s.code,{children:"void"})}),"\n",(0,t.jsx)(s.h4,{id:"source-2",children:"Source"}),"\n",(0,t.jsx)(s.p,{children:(0,t.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L125",children:"packages/extension-api/src/extension-api.d.ts:125"})})]})}function h(e={}){const{wrapper:s}={...(0,r.a)(),...e.components};return s?(0,t.jsx)(s,{...e,children:(0,t.jsx)(a,{...e})}):a(e)}},71670:(e,s,n)=>{n.d(s,{Z:()=>d,a:()=>c});var t=n(27378);const r={},i=t.createContext(r);function c(e){const s=t.useContext(i);return t.useMemo((function(){return"function"==typeof e?e(s):{...s,...e}}),[s,e])}function d(e){let s;return s=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:c(e.components),t.createElement(i.Provider,{value:s},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/4f425ff4.31bb7041.js b/assets/js/4f425ff4.f22994fc.js similarity index 96% rename from assets/js/4f425ff4.31bb7041.js rename to assets/js/4f425ff4.f22994fc.js index 34aece0dfdc..0a39f39096c 100644 --- a/assets/js/4f425ff4.31bb7041.js +++ b/assets/js/4f425ff4.f22994fc.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[89799],{53078:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>a,contentTitle:()=>r,default:()=>p,frontMatter:()=>o,metadata:()=>c,toc:()=>d});var i=s(24246),t=s(71670);const o={},r="Function: onDidUpdateContainerConnection()",c={id:"namespaces/provider/functions/onDidUpdateContainerConnection",title:"Function: onDidUpdateContainerConnection()",description:"onDidUpdateContainerConnection(listener, thisArgs?, disposables?): Disposable",source:"@site/api/namespaces/provider/functions/onDidUpdateContainerConnection.md",sourceDirName:"namespaces/provider/functions",slug:"/namespaces/provider/functions/onDidUpdateContainerConnection",permalink:"/api/namespaces/provider/functions/onDidUpdateContainerConnection",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Function: onDidUnregisterContainerConnection()",permalink:"/api/namespaces/provider/functions/onDidUnregisterContainerConnection"},next:{title:"Function: onDidUpdateKubernetesConnection()",permalink:"/api/namespaces/provider/functions/onDidUpdateKubernetesConnection"}},a={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,t.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"function-ondidupdatecontainerconnection",children:"Function: onDidUpdateContainerConnection()"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"onDidUpdateContainerConnection"}),"(",(0,i.jsx)(n.code,{children:"listener"}),", ",(0,i.jsx)(n.code,{children:"thisArgs"}),"?, ",(0,i.jsx)(n.code,{children:"disposables"}),"?): ",(0,i.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(n.code,{children:"Disposable"})})]}),"\n"]}),"\n",(0,i.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"listener"})]}),"\n",(0,i.jsx)(n.p,{children:"The listener function will be called when the event happens."}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"thisArgs?"}),": ",(0,i.jsx)(n.code,{children:"any"})]}),"\n",(0,i.jsxs)(n.p,{children:["The ",(0,i.jsx)(n.code,{children:"this"}),"-argument which will be used when calling the event listener."]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"disposables?"}),": ",(0,i.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(n.code,{children:"Disposable"})}),"[]"]}),"\n",(0,i.jsxs)(n.p,{children:["An array to which a ",(0,i.jsx)(n.a,{href:"/api/classes/Disposable",children:"Disposable"})," will be added."]}),"\n",(0,i.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(n.code,{children:"Disposable"})})}),"\n",(0,i.jsx)(n.p,{children:"A disposable which unsubscribes the event listener."}),"\n",(0,i.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L547",children:"packages/extension-api/src/extension-api.d.ts:547"})})]})}function p(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>c,a:()=>r});var i=s(27378);const t={},o=i.createContext(t);function r(e){const n=i.useContext(o);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:r(e.components),i.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[89799],{53078:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>a,contentTitle:()=>r,default:()=>p,frontMatter:()=>o,metadata:()=>c,toc:()=>d});var i=s(24246),t=s(71670);const o={},r="Function: onDidUpdateContainerConnection()",c={id:"namespaces/provider/functions/onDidUpdateContainerConnection",title:"Function: onDidUpdateContainerConnection()",description:"onDidUpdateContainerConnection(listener, thisArgs?, disposables?): Disposable",source:"@site/api/namespaces/provider/functions/onDidUpdateContainerConnection.md",sourceDirName:"namespaces/provider/functions",slug:"/namespaces/provider/functions/onDidUpdateContainerConnection",permalink:"/api/namespaces/provider/functions/onDidUpdateContainerConnection",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Function: onDidUnregisterContainerConnection()",permalink:"/api/namespaces/provider/functions/onDidUnregisterContainerConnection"},next:{title:"Function: onDidUpdateKubernetesConnection()",permalink:"/api/namespaces/provider/functions/onDidUpdateKubernetesConnection"}},a={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,t.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"function-ondidupdatecontainerconnection",children:"Function: onDidUpdateContainerConnection()"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"onDidUpdateContainerConnection"}),"(",(0,i.jsx)(n.code,{children:"listener"}),", ",(0,i.jsx)(n.code,{children:"thisArgs"}),"?, ",(0,i.jsx)(n.code,{children:"disposables"}),"?): ",(0,i.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(n.code,{children:"Disposable"})})]}),"\n"]}),"\n",(0,i.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"listener"})]}),"\n",(0,i.jsx)(n.p,{children:"The listener function will be called when the event happens."}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"thisArgs?"}),": ",(0,i.jsx)(n.code,{children:"any"})]}),"\n",(0,i.jsxs)(n.p,{children:["The ",(0,i.jsx)(n.code,{children:"this"}),"-argument which will be used when calling the event listener."]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"disposables?"}),": ",(0,i.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(n.code,{children:"Disposable"})}),"[]"]}),"\n",(0,i.jsxs)(n.p,{children:["An array to which a ",(0,i.jsx)(n.a,{href:"/api/classes/Disposable",children:"Disposable"})," will be added."]}),"\n",(0,i.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(n.code,{children:"Disposable"})})}),"\n",(0,i.jsx)(n.p,{children:"A disposable which unsubscribes the event listener."}),"\n",(0,i.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L547",children:"packages/extension-api/src/extension-api.d.ts:547"})})]})}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.62877687.js b/assets/js/4f9e8711.bbd18f66.js similarity index 93% rename from assets/js/4f9e8711.62877687.js rename to assets/js/4f9e8711.bbd18f66.js index 5f4b9a6d4b4..b920988d4f9 100644 --- a/assets/js/4f9e8711.62877687.js +++ b/assets/js/4f9e8711.bbd18f66.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[27177],{469:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>d,contentTitle:()=>c,default:()=>h,frontMatter:()=>o,metadata:()=>s,toc:()=>a});var r=i(24246),t=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:"Interface: ProviderCleanupExecuteOptions",permalink:"/api/interfaces/ProviderCleanupExecuteOptions"},next:{title:"Interface: ProviderConnectionLifecycle",permalink:"/api/interfaces/ProviderConnectionLifecycle"}},d={},a=[{value:"Extended by",id:"extended-by",level:2},{value:"Properties",id:"properties",level:2},{value:"creationButtonTitle?",id:"creationbuttontitle",level:3},{value:"Source",id:"source",level:4},{value:"creationDisplayName?",id:"creationdisplayname",level:3},{value:"Source",id:"source-1",level:4},{value:"Methods",id:"methods",level:2},{value:"initialize()?",id:"initialize",level:3},{value:"Returns",id:"returns",level:4},{value:"Source",id:"source-2",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",li:"li",p:"p",strong:"strong",ul:"ul",...(0,t.a)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.h1,{id:"interface-providerconnectionfactory",children:"Interface: ProviderConnectionFactory"}),"\n",(0,r.jsx)(n.h2,{id:"extended-by",children:"Extended by"}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"/api/interfaces/ContainerProviderConnectionFactory",children:(0,r.jsx)(n.code,{children:"ContainerProviderConnectionFactory"})})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"/api/interfaces/KubernetesProviderConnectionFactory",children:(0,r.jsx)(n.code,{children:"KubernetesProviderConnectionFactory"})})}),"\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.strong,{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:"source",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L317",children:"packages/extension-api/src/extension-api.d.ts:317"})}),"\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.strong,{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:"source-1",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L314",children:"packages/extension-api/src/extension-api.d.ts:314"})}),"\n",(0,r.jsx)(n.h2,{id:"methods",children:"Methods"}),"\n",(0,r.jsx)(n.h3,{id:"initialize",children:"initialize()?"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{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",children:"Returns"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"Promise"}),"< ",(0,r.jsx)(n.code,{children:"void"})," >"]}),"\n",(0,r.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L311",children:"packages/extension-api/src/extension-api.d.ts:311"})})]})}function h(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(l,{...e})}):l(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>s,a:()=>c});var r=i(27378);const t={},o=r.createContext(t);function c(e){const n=r.useContext(o);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function s(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:c(e.components),r.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[27177],{469:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>d,contentTitle:()=>c,default:()=>h,frontMatter:()=>o,metadata:()=>s,toc:()=>a});var r=i(24246),t=i(71670);const o={},c="Interface: 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:"Interface: ProviderCleanupExecuteOptions",permalink:"/api/interfaces/ProviderCleanupExecuteOptions"},next:{title:"Interface: ProviderConnectionLifecycle",permalink:"/api/interfaces/ProviderConnectionLifecycle"}},d={},a=[{value:"Extended by",id:"extended-by",level:2},{value:"Properties",id:"properties",level:2},{value:"creationButtonTitle?",id:"creationbuttontitle",level:3},{value:"Source",id:"source",level:4},{value:"creationDisplayName?",id:"creationdisplayname",level:3},{value:"Source",id:"source-1",level:4},{value:"Methods",id:"methods",level:2},{value:"initialize()?",id:"initialize",level:3},{value:"Returns",id:"returns",level:4},{value:"Source",id:"source-2",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",li:"li",p:"p",strong:"strong",ul:"ul",...(0,t.a)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.h1,{id:"interface-providerconnectionfactory",children:"Interface: ProviderConnectionFactory"}),"\n",(0,r.jsx)(n.h2,{id:"extended-by",children:"Extended by"}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"/api/interfaces/ContainerProviderConnectionFactory",children:(0,r.jsx)(n.code,{children:"ContainerProviderConnectionFactory"})})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"/api/interfaces/KubernetesProviderConnectionFactory",children:(0,r.jsx)(n.code,{children:"KubernetesProviderConnectionFactory"})})}),"\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.strong,{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:"source",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L317",children:"packages/extension-api/src/extension-api.d.ts:317"})}),"\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.strong,{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:"source-1",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L314",children:"packages/extension-api/src/extension-api.d.ts:314"})}),"\n",(0,r.jsx)(n.h2,{id:"methods",children:"Methods"}),"\n",(0,r.jsx)(n.h3,{id:"initialize",children:"initialize()?"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{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",children:"Returns"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"Promise"}),"< ",(0,r.jsx)(n.code,{children:"void"})," >"]}),"\n",(0,r.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L311",children:"packages/extension-api/src/extension-api.d.ts:311"})})]})}function h(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(l,{...e})}):l(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>s,a:()=>c});var r=i(27378);const t={},o=r.createContext(t);function c(e){const n=r.useContext(o);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function s(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:c(e.components),r.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/5046ea8f.5cdba6a6.js b/assets/js/5046ea8f.9a75988c.js similarity index 89% rename from assets/js/5046ea8f.5cdba6a6.js rename to assets/js/5046ea8f.9a75988c.js index 03260b4613b..8ee6e92a27f 100644 --- a/assets/js/5046ea8f.5cdba6a6.js +++ b/assets/js/5046ea8f.9a75988c.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[75167],{13531:(e,s,t)=>{t.r(s),t.d(s,{assets:()=>a,contentTitle:()=>c,default:()=>d,frontMatter:()=>i,metadata:()=>o,toc:()=>u});var r=t(24246),n=t(71670);const i={},c="Function: suggestRegistry()",o={id:"namespaces/registry/functions/suggestRegistry",title:"Function: suggestRegistry()",description:"suggestRegistry(registry): Disposable",source:"@site/api/namespaces/registry/functions/suggestRegistry.md",sourceDirName:"namespaces/registry/functions",slug:"/namespaces/registry/functions/suggestRegistry",permalink:"/api/namespaces/registry/functions/suggestRegistry",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Function: registerRegistryProvider()",permalink:"/api/namespaces/registry/functions/registerRegistryProvider"},next:{title:"Function: unregisterRegistry()",permalink:"/api/namespaces/registry/functions/unregisterRegistry"}},a={},u=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function g(e){const s={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,n.a)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(s.h1,{id:"function-suggestregistry",children:"Function: suggestRegistry()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"suggestRegistry"}),"(",(0,r.jsx)(s.code,{children:"registry"}),"): ",(0,r.jsx)(s.a,{href:"/api/classes/Disposable",children:(0,r.jsx)(s.code,{children:"Disposable"})})]}),"\n"]}),"\n",(0,r.jsx)(s.h2,{id:"parameters",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"registry"}),": ",(0,r.jsx)(s.a,{href:"/api/interfaces/RegistrySuggestedProvider",children:(0,r.jsx)(s.code,{children:"RegistrySuggestedProvider"})})]}),"\n",(0,r.jsx)(s.h2,{id:"returns",children:"Returns"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.a,{href:"/api/classes/Disposable",children:(0,r.jsx)(s.code,{children:"Disposable"})})}),"\n",(0,r.jsx)(s.h2,{id:"source",children:"Source"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L628",children:"packages/extension-api/src/extension-api.d.ts:628"})})]})}function d(e={}){const{wrapper:s}={...(0,n.a)(),...e.components};return s?(0,r.jsx)(s,{...e,children:(0,r.jsx)(g,{...e})}):g(e)}},71670:(e,s,t)=>{t.d(s,{Z:()=>o,a:()=>c});var r=t(27378);const n={},i=r.createContext(n);function c(e){const s=r.useContext(i);return r.useMemo((function(){return"function"==typeof e?e(s):{...s,...e}}),[s,e])}function o(e){let s;return s=e.disableParentContext?"function"==typeof e.components?e.components(n):e.components||n:c(e.components),r.createElement(i.Provider,{value:s},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[75167],{13531:(e,s,t)=>{t.r(s),t.d(s,{assets:()=>a,contentTitle:()=>c,default:()=>g,frontMatter:()=>i,metadata:()=>o,toc:()=>u});var r=t(24246),n=t(71670);const i={},c="Function: suggestRegistry()",o={id:"namespaces/registry/functions/suggestRegistry",title:"Function: suggestRegistry()",description:"suggestRegistry(registry): Disposable",source:"@site/api/namespaces/registry/functions/suggestRegistry.md",sourceDirName:"namespaces/registry/functions",slug:"/namespaces/registry/functions/suggestRegistry",permalink:"/api/namespaces/registry/functions/suggestRegistry",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Function: registerRegistryProvider()",permalink:"/api/namespaces/registry/functions/registerRegistryProvider"},next:{title:"Function: unregisterRegistry()",permalink:"/api/namespaces/registry/functions/unregisterRegistry"}},a={},u=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function d(e){const s={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,n.a)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(s.h1,{id:"function-suggestregistry",children:"Function: suggestRegistry()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"suggestRegistry"}),"(",(0,r.jsx)(s.code,{children:"registry"}),"): ",(0,r.jsx)(s.a,{href:"/api/classes/Disposable",children:(0,r.jsx)(s.code,{children:"Disposable"})})]}),"\n"]}),"\n",(0,r.jsx)(s.h2,{id:"parameters",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"registry"}),": ",(0,r.jsx)(s.a,{href:"/api/interfaces/RegistrySuggestedProvider",children:(0,r.jsx)(s.code,{children:"RegistrySuggestedProvider"})})]}),"\n",(0,r.jsx)(s.h2,{id:"returns",children:"Returns"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.a,{href:"/api/classes/Disposable",children:(0,r.jsx)(s.code,{children:"Disposable"})})}),"\n",(0,r.jsx)(s.h2,{id:"source",children:"Source"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L628",children:"packages/extension-api/src/extension-api.d.ts:628"})})]})}function g(e={}){const{wrapper:s}={...(0,n.a)(),...e.components};return s?(0,r.jsx)(s,{...e,children:(0,r.jsx)(d,{...e})}):d(e)}},71670:(e,s,t)=>{t.d(s,{Z:()=>o,a:()=>c});var r=t(27378);const n={},i=r.createContext(n);function c(e){const s=r.useContext(i);return r.useMemo((function(){return"function"==typeof e?e(s):{...s,...e}}),[s,e])}function o(e){let s;return s=e.disableParentContext?"function"==typeof e.components?e.components(n):e.components||n:c(e.components),r.createElement(i.Provider,{value:s},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/54d805e4.20c0735c.js b/assets/js/54d805e4.a5d47a8f.js similarity index 83% rename from assets/js/54d805e4.20c0735c.js rename to assets/js/54d805e4.a5d47a8f.js index 2652aaaecda..51a46815232 100644 --- a/assets/js/54d805e4.20c0735c.js +++ b/assets/js/54d805e4.a5d47a8f.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[33356],{72045:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>a,contentTitle:()=>t,default:()=>u,frontMatter:()=>o,metadata:()=>c,toc:()=>l});var i=s(24246),r=s(71670);const o={},t="Interface: VolumeListInfo",c={id:"interfaces/VolumeListInfo",title:"Interface: VolumeListInfo",description:"Properties",source:"@site/api/interfaces/VolumeListInfo.md",sourceDirName:"interfaces",slug:"/interfaces/VolumeListInfo",permalink:"/api/interfaces/VolumeListInfo",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: VolumeInfo",permalink:"/api/interfaces/VolumeInfo"},next:{title:"Interface: Webview",permalink:"/api/interfaces/Webview"}},a={},l=[{value:"Properties",id:"properties",level:2},{value:"Volumes",id:"volumes",level:3},{value:"Source",id:"source",level:4},{value:"Warnings",id:"warnings",level:3},{value:"Source",id:"source-1",level:4},{value:"engineId",id:"engineid",level:3},{value:"Source",id:"source-2",level:4},{value:"engineName",id:"enginename",level:3},{value:"Source",id:"source-3",level:4}];function d(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,r.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"interface-volumelistinfo",children:"Interface: VolumeListInfo"}),"\n",(0,i.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(n.h3,{id:"volumes",children:"Volumes"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Volumes"}),": ",(0,i.jsx)(n.a,{href:"/api/interfaces/VolumeInfo",children:(0,i.jsx)(n.code,{children:"VolumeInfo"})}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L3113",children:"packages/extension-api/src/extension-api.d.ts:3113"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"warnings",children:"Warnings"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Warnings"}),": ",(0,i.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L3114",children:"packages/extension-api/src/extension-api.d.ts:3114"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"engineid",children:"engineId"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"engineId"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L3115",children:"packages/extension-api/src/extension-api.d.ts:3115"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"enginename",children:"engineName"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"engineName"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L3116",children:"packages/extension-api/src/extension-api.d.ts:3116"})})]})}function u(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,s)=>{s.d(n,{Z:()=>c,a:()=>t});var i=s(27378);const r={},o=i.createContext(r);function t(e){const n=i.useContext(o);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:t(e.components),i.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[33356],{72045:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>a,contentTitle:()=>t,default:()=>u,frontMatter:()=>o,metadata:()=>c,toc:()=>d});var i=s(24246),r=s(71670);const o={},t="Interface: VolumeListInfo",c={id:"interfaces/VolumeListInfo",title:"Interface: VolumeListInfo",description:"Properties",source:"@site/api/interfaces/VolumeListInfo.md",sourceDirName:"interfaces",slug:"/interfaces/VolumeListInfo",permalink:"/api/interfaces/VolumeListInfo",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: VolumeInfo",permalink:"/api/interfaces/VolumeInfo"},next:{title:"Interface: Webview",permalink:"/api/interfaces/Webview"}},a={},d=[{value:"Properties",id:"properties",level:2},{value:"Volumes",id:"volumes",level:3},{value:"Source",id:"source",level:4},{value:"Warnings",id:"warnings",level:3},{value:"Source",id:"source-1",level:4},{value:"engineId",id:"engineid",level:3},{value:"Source",id:"source-2",level:4},{value:"engineName",id:"enginename",level:3},{value:"Source",id:"source-3",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,r.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"interface-volumelistinfo",children:"Interface: VolumeListInfo"}),"\n",(0,i.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(n.h3,{id:"volumes",children:"Volumes"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Volumes"}),": ",(0,i.jsx)(n.a,{href:"/api/interfaces/VolumeInfo",children:(0,i.jsx)(n.code,{children:"VolumeInfo"})}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L3113",children:"packages/extension-api/src/extension-api.d.ts:3113"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"warnings",children:"Warnings"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Warnings"}),": ",(0,i.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L3114",children:"packages/extension-api/src/extension-api.d.ts:3114"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"engineid",children:"engineId"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"engineId"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L3115",children:"packages/extension-api/src/extension-api.d.ts:3115"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"enginename",children:"engineName"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"engineName"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L3116",children:"packages/extension-api/src/extension-api.d.ts:3116"})})]})}function u(e={}){const{wrapper:n}={...(0,r.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>c,a:()=>t});var i=s(27378);const r={},o=i.createContext(r);function t(e){const n=i.useContext(o);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:t(e.components),i.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/57a8015d.97495d30.js b/assets/js/57a8015d.7d826a7d.js similarity index 96% rename from assets/js/57a8015d.97495d30.js rename to assets/js/57a8015d.7d826a7d.js index d4617087265..47855f637a2 100644 --- a/assets/js/57a8015d.97495d30.js +++ b/assets/js/57a8015d.7d826a7d.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[27268],{47845:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>r,contentTitle:()=>o,default:()=>u,frontMatter:()=>a,metadata:()=>c,toc:()=>d});var s=i(24246),t=i(71670);const a={},o="Function: navigateToWebview()",c={id:"namespaces/navigation/functions/navigateToWebview",title:"Function: navigateToWebview()",description:"navigateToWebview(webviewId): Promise\\",source:"@site/api/namespaces/navigation/functions/navigateToWebview.md",sourceDirName:"namespaces/navigation/functions",slug:"/namespaces/navigation/functions/navigateToWebview",permalink:"/api/namespaces/navigation/functions/navigateToWebview",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Function: navigateToVolumes()",permalink:"/api/namespaces/navigation/functions/navigateToVolumes"},next:{title:"Namespace: process",permalink:"/api/namespaces/process/"}},r={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"See",id:"see",level:2},{value:"Source",id:"source",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",li:"li",p:"p",strong:"strong",ul:"ul",...(0,t.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"function-navigatetowebview",children:"Function: navigateToWebview()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"navigateToWebview"}),"(",(0,s.jsx)(n.code,{children:"webviewId"}),"): ",(0,s.jsx)(n.code,{children:"Promise"}),"< ",(0,s.jsx)(n.code,{children:"void"})," >"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Navigate to a specific Webview"}),"\n",(0,s.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"webviewId"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n",(0,s.jsx)(n.p,{children:"The id of the Webview to navigate to"}),"\n",(0,s.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"Promise"}),"< ",(0,s.jsx)(n.code,{children:"void"})," >"]}),"\n",(0,s.jsx)(n.h2,{id:"see",children:"See"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.a,{href:"/api/namespaces/window/functions/listWebviews",children:"listWebviews"})," to get a list of Webviews and their ids"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.a,{href:"/api/namespaces/window/functions/createWebviewPanel",children:"createWebviewPanel"})," for creating a Webview"]}),"\n"]}),"\n",(0,s.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L4176",children:"packages/extension-api/src/extension-api.d.ts:4176"})})]})}function u(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>c,a:()=>o});var s=i(27378);const t={},a=s.createContext(t);function o(e){const n=s.useContext(a);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:o(e.components),s.createElement(a.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[27268],{47845:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>r,contentTitle:()=>o,default:()=>u,frontMatter:()=>a,metadata:()=>c,toc:()=>d});var s=i(24246),t=i(71670);const a={},o="Function: navigateToWebview()",c={id:"namespaces/navigation/functions/navigateToWebview",title:"Function: navigateToWebview()",description:"navigateToWebview(webviewId): Promise\\",source:"@site/api/namespaces/navigation/functions/navigateToWebview.md",sourceDirName:"namespaces/navigation/functions",slug:"/namespaces/navigation/functions/navigateToWebview",permalink:"/api/namespaces/navigation/functions/navigateToWebview",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Function: navigateToVolumes()",permalink:"/api/namespaces/navigation/functions/navigateToVolumes"},next:{title:"Namespace: process",permalink:"/api/namespaces/process/"}},r={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"See",id:"see",level:2},{value:"Source",id:"source",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",li:"li",p:"p",strong:"strong",ul:"ul",...(0,t.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"function-navigatetowebview",children:"Function: navigateToWebview()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"navigateToWebview"}),"(",(0,s.jsx)(n.code,{children:"webviewId"}),"): ",(0,s.jsx)(n.code,{children:"Promise"}),"< ",(0,s.jsx)(n.code,{children:"void"})," >"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Navigate to a specific Webview"}),"\n",(0,s.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"webviewId"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n",(0,s.jsx)(n.p,{children:"The id of the Webview to navigate to"}),"\n",(0,s.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"Promise"}),"< ",(0,s.jsx)(n.code,{children:"void"})," >"]}),"\n",(0,s.jsx)(n.h2,{id:"see",children:"See"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.a,{href:"/api/namespaces/window/functions/listWebviews",children:"listWebviews"})," to get a list of Webviews and their ids"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.a,{href:"/api/namespaces/window/functions/createWebviewPanel",children:"createWebviewPanel"})," for creating a Webview"]}),"\n"]}),"\n",(0,s.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L4176",children:"packages/extension-api/src/extension-api.d.ts:4176"})})]})}function u(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>c,a:()=>o});var s=i(27378);const t={},a=s.createContext(t);function o(e){const n=s.useContext(a);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:o(e.components),s.createElement(a.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/57dba496.654997fe.js b/assets/js/57dba496.54764f63.js similarity index 82% rename from assets/js/57dba496.654997fe.js rename to assets/js/57dba496.54764f63.js index 9269046ec6d..785df9720d4 100644 --- a/assets/js/57dba496.654997fe.js +++ b/assets/js/57dba496.54764f63.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[5886],{85801:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>l,contentTitle:()=>t,default:()=>h,frontMatter:()=>i,metadata:()=>o,toc:()=>d});var r=s(24246),c=s(71670);const i={},t="Interface: PullEvent",o={id:"interfaces/PullEvent",title:"Interface: PullEvent",description:"Properties",source:"@site/api/interfaces/PullEvent.md",sourceDirName:"interfaces",slug:"/interfaces/PullEvent",permalink:"/api/interfaces/PullEvent",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: ProxySettings",permalink:"/api/interfaces/ProxySettings"},next:{title:"Interface: QuickInputButton",permalink:"/api/interfaces/QuickInputButton"}},l={},d=[{value:"Properties",id:"properties",level:2},{value:"error?",id:"error",level:3},{value:"Source",id:"source",level:4},{value:"errorDetails?",id:"errordetails",level:3},{value:"message?",id:"message",level:4},{value:"Source",id:"source-1",level:4},{value:"id?",id:"id",level:3},{value:"Source",id:"source-2",level:4},{value:"progress?",id:"progress",level:3},{value:"Source",id:"source-3",level:4},{value:"progressDetail?",id:"progressdetail",level:3},{value:"current?",id:"current",level:4},{value:"total?",id:"total",level:4},{value:"Source",id:"source-4",level:4},{value:"status?",id:"status",level:3},{value:"Source",id:"source-5",level:4},{value:"stream?",id:"stream",level:3},{value:"Source",id:"source-6",level:4}];function a(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,c.a)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.h1,{id:"interface-pullevent",children:"Interface: PullEvent"}),"\n",(0,r.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,r.jsx)(n.h3,{id:"error",children:"error?"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"optional"})})," ",(0,r.jsx)(n.strong,{children:"error"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2389",children:"packages/extension-api/src/extension-api.d.ts:2389"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"errordetails",children:"errorDetails?"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"optional"})})," ",(0,r.jsx)(n.strong,{children:"errorDetails"}),": ",(0,r.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"message",children:"message?"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"optional"})})," ",(0,r.jsx)(n.strong,{children:"message"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2390",children:"packages/extension-api/src/extension-api.d.ts:2390"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"id",children:"id?"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"optional"})})," ",(0,r.jsx)(n.strong,{children:"id"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2382",children:"packages/extension-api/src/extension-api.d.ts:2382"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"progress",children:"progress?"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"optional"})})," ",(0,r.jsx)(n.strong,{children:"progress"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2384",children:"packages/extension-api/src/extension-api.d.ts:2384"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"progressdetail",children:"progressDetail?"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"optional"})})," ",(0,r.jsx)(n.strong,{children:"progressDetail"}),": ",(0,r.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"current",children:"current?"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"optional"})})," ",(0,r.jsx)(n.strong,{children:"current"}),": ",(0,r.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"total",children:"total?"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"optional"})})," ",(0,r.jsx)(n.strong,{children:"total"}),": ",(0,r.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"source-4",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2385",children:"packages/extension-api/src/extension-api.d.ts:2385"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"status",children:"status?"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"optional"})})," ",(0,r.jsx)(n.strong,{children:"status"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"source-5",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2383",children:"packages/extension-api/src/extension-api.d.ts:2383"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"stream",children:"stream?"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"optional"})})," ",(0,r.jsx)(n.strong,{children:"stream"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"source-6",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2381",children:"packages/extension-api/src/extension-api.d.ts:2381"})})]})}function h(e={}){const{wrapper:n}={...(0,c.a)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(a,{...e})}):a(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>o,a:()=>t});var r=s(27378);const c={},i=r.createContext(c);function t(e){const n=r.useContext(i);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(c):e.components||c:t(e.components),r.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[5886],{85801:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>d,contentTitle:()=>t,default:()=>h,frontMatter:()=>c,metadata:()=>o,toc:()=>l});var r=s(24246),i=s(71670);const c={},t="Interface: PullEvent",o={id:"interfaces/PullEvent",title:"Interface: PullEvent",description:"Properties",source:"@site/api/interfaces/PullEvent.md",sourceDirName:"interfaces",slug:"/interfaces/PullEvent",permalink:"/api/interfaces/PullEvent",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: ProxySettings",permalink:"/api/interfaces/ProxySettings"},next:{title:"Interface: QuickInputButton",permalink:"/api/interfaces/QuickInputButton"}},d={},l=[{value:"Properties",id:"properties",level:2},{value:"error?",id:"error",level:3},{value:"Source",id:"source",level:4},{value:"errorDetails?",id:"errordetails",level:3},{value:"message?",id:"message",level:4},{value:"Source",id:"source-1",level:4},{value:"id?",id:"id",level:3},{value:"Source",id:"source-2",level:4},{value:"progress?",id:"progress",level:3},{value:"Source",id:"source-3",level:4},{value:"progressDetail?",id:"progressdetail",level:3},{value:"current?",id:"current",level:4},{value:"total?",id:"total",level:4},{value:"Source",id:"source-4",level:4},{value:"status?",id:"status",level:3},{value:"Source",id:"source-5",level:4},{value:"stream?",id:"stream",level:3},{value:"Source",id:"source-6",level:4}];function a(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,i.a)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.h1,{id:"interface-pullevent",children:"Interface: PullEvent"}),"\n",(0,r.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,r.jsx)(n.h3,{id:"error",children:"error?"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"optional"})})," ",(0,r.jsx)(n.strong,{children:"error"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2389",children:"packages/extension-api/src/extension-api.d.ts:2389"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"errordetails",children:"errorDetails?"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"optional"})})," ",(0,r.jsx)(n.strong,{children:"errorDetails"}),": ",(0,r.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"message",children:"message?"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"optional"})})," ",(0,r.jsx)(n.strong,{children:"message"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2390",children:"packages/extension-api/src/extension-api.d.ts:2390"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"id",children:"id?"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"optional"})})," ",(0,r.jsx)(n.strong,{children:"id"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2382",children:"packages/extension-api/src/extension-api.d.ts:2382"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"progress",children:"progress?"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"optional"})})," ",(0,r.jsx)(n.strong,{children:"progress"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2384",children:"packages/extension-api/src/extension-api.d.ts:2384"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"progressdetail",children:"progressDetail?"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"optional"})})," ",(0,r.jsx)(n.strong,{children:"progressDetail"}),": ",(0,r.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"current",children:"current?"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"optional"})})," ",(0,r.jsx)(n.strong,{children:"current"}),": ",(0,r.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"total",children:"total?"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"optional"})})," ",(0,r.jsx)(n.strong,{children:"total"}),": ",(0,r.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"source-4",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2385",children:"packages/extension-api/src/extension-api.d.ts:2385"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"status",children:"status?"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"optional"})})," ",(0,r.jsx)(n.strong,{children:"status"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"source-5",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2383",children:"packages/extension-api/src/extension-api.d.ts:2383"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"stream",children:"stream?"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"optional"})})," ",(0,r.jsx)(n.strong,{children:"stream"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"source-6",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2381",children:"packages/extension-api/src/extension-api.d.ts:2381"})})]})}function h(e={}){const{wrapper:n}={...(0,i.a)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(a,{...e})}):a(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>o,a:()=>t});var r=s(27378);const i={},c=r.createContext(i);function t(e){const n=r.useContext(c);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:t(e.components),r.createElement(c.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/57e01cd5.02acec70.js b/assets/js/57e01cd5.02acec70.js deleted file mode 100644 index e5816d845d2..00000000000 --- a/assets/js/57e01cd5.02acec70.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[43546],{35312:(e,t,a)=>{a.r(t),a.d(t,{assets:()=>l,contentTitle:()=>r,default:()=>p,frontMatter:()=>i,metadata:()=>o,toc:()=>c});var n=a(24246),s=a(71670);const i={},r="Type alias: StatusBarAlignment",o={id:"type-aliases/StatusBarAlignment",title:"Type alias: StatusBarAlignment",description:"StatusBarAlignment: typeof StatusBarAlignLeft \\| typeof StatusBarAlignRight",source:"@site/api/type-aliases/StatusBarAlignment.md",sourceDirName:"type-aliases",slug:"/type-aliases/StatusBarAlignment",permalink:"/api/type-aliases/StatusBarAlignment",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Type alias: ProviderStatus",permalink:"/api/type-aliases/ProviderStatus"},next:{title:"Variable: StatusBarAlignLeft",permalink:"/api/variables/StatusBarAlignLeft"}},l={},c=[{value:"Source",id:"source",level:2}];function u(e){const t={a:"a",blockquote:"blockquote",code:"code",em:"em",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(t.h1,{id:"type-alias-statusbaralignment",children:"Type alias: StatusBarAlignment"}),"\n",(0,n.jsxs)(t.blockquote,{children:["\n",(0,n.jsxs)(t.p,{children:[(0,n.jsx)(t.strong,{children:"StatusBarAlignment"}),": ",(0,n.jsx)(t.em,{children:"typeof"})," ",(0,n.jsx)(t.a,{href:"/api/variables/StatusBarAlignLeft",children:(0,n.jsx)(t.code,{children:"StatusBarAlignLeft"})})," | ",(0,n.jsx)(t.em,{children:"typeof"})," ",(0,n.jsx)(t.a,{href:"/api/variables/StatusBarAlignRight",children:(0,n.jsx)(t.code,{children:"StatusBarAlignRight"})})]}),"\n"]}),"\n",(0,n.jsx)(t.p,{children:"Represents the alignment of status bar items."}),"\n",(0,n.jsx)(t.h2,{id:"source",children:"Source"}),"\n",(0,n.jsx)(t.p,{children:(0,n.jsx)(t.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L1190",children:"packages/extension-api/src/extension-api.d.ts:1190"})})]})}function p(e={}){const{wrapper:t}={...(0,s.a)(),...e.components};return t?(0,n.jsx)(t,{...e,children:(0,n.jsx)(u,{...e})}):u(e)}},71670:(e,t,a)=>{a.d(t,{Z:()=>o,a:()=>r});var n=a(27378);const s={},i=n.createContext(s);function r(e){const t=n.useContext(i);return n.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function o(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:r(e.components),n.createElement(i.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/57e01cd5.8635c150.js b/assets/js/57e01cd5.8635c150.js new file mode 100644 index 00000000000..ee46894c61c --- /dev/null +++ b/assets/js/57e01cd5.8635c150.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[43546],{35312:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>l,contentTitle:()=>r,default:()=>p,frontMatter:()=>i,metadata:()=>o,toc:()=>c});var a=n(24246),s=n(71670);const i={},r="Type alias: StatusBarAlignment",o={id:"type-aliases/StatusBarAlignment",title:"Type alias: StatusBarAlignment",description:"StatusBarAlignment: typeof StatusBarAlignLeft \\| typeof StatusBarAlignRight",source:"@site/api/type-aliases/StatusBarAlignment.md",sourceDirName:"type-aliases",slug:"/type-aliases/StatusBarAlignment",permalink:"/api/type-aliases/StatusBarAlignment",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Type alias: ProviderStatus",permalink:"/api/type-aliases/ProviderStatus"},next:{title:"Variable: StatusBarAlignLeft",permalink:"/api/variables/StatusBarAlignLeft"}},l={},c=[{value:"Source",id:"source",level:2}];function u(e){const t={a:"a",blockquote:"blockquote",code:"code",em:"em",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,a.jsxs)(a.Fragment,{children:[(0,a.jsx)(t.h1,{id:"type-alias-statusbaralignment",children:"Type alias: StatusBarAlignment"}),"\n",(0,a.jsxs)(t.blockquote,{children:["\n",(0,a.jsxs)(t.p,{children:[(0,a.jsx)(t.strong,{children:"StatusBarAlignment"}),": ",(0,a.jsx)(t.em,{children:"typeof"})," ",(0,a.jsx)(t.a,{href:"/api/variables/StatusBarAlignLeft",children:(0,a.jsx)(t.code,{children:"StatusBarAlignLeft"})})," | ",(0,a.jsx)(t.em,{children:"typeof"})," ",(0,a.jsx)(t.a,{href:"/api/variables/StatusBarAlignRight",children:(0,a.jsx)(t.code,{children:"StatusBarAlignRight"})})]}),"\n"]}),"\n",(0,a.jsx)(t.p,{children:"Represents the alignment of status bar items."}),"\n",(0,a.jsx)(t.h2,{id:"source",children:"Source"}),"\n",(0,a.jsx)(t.p,{children:(0,a.jsx)(t.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L1190",children:"packages/extension-api/src/extension-api.d.ts:1190"})})]})}function p(e={}){const{wrapper:t}={...(0,s.a)(),...e.components};return t?(0,a.jsx)(t,{...e,children:(0,a.jsx)(u,{...e})}):u(e)}},71670:(e,t,n)=>{n.d(t,{Z:()=>o,a:()=>r});var a=n(27378);const s={},i=a.createContext(s);function r(e){const t=a.useContext(i);return a.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function o(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:r(e.components),a.createElement(i.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/5a7aef43.78593a3e.js b/assets/js/5a7aef43.39e50b6c.js similarity index 84% rename from assets/js/5a7aef43.78593a3e.js rename to assets/js/5a7aef43.39e50b6c.js index 236951055db..937cfd0cdeb 100644 --- a/assets/js/5a7aef43.78593a3e.js +++ b/assets/js/5a7aef43.39e50b6c.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[59081],{60991:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>r,contentTitle:()=>i,default:()=>p,frontMatter:()=>s,metadata:()=>c,toc:()=>u});var a=t(24246),o=t(71670);const s={},i="Function: navigateToImages()",c={id:"namespaces/navigation/functions/navigateToImages",title:"Function: navigateToImages()",description:"navigateToImages(): Promise\\",source:"@site/api/namespaces/navigation/functions/navigateToImages.md",sourceDirName:"namespaces/navigation/functions",slug:"/namespaces/navigation/functions/navigateToImages",permalink:"/api/namespaces/navigation/functions/navigateToImages",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Function: navigateToImage()",permalink:"/api/namespaces/navigation/functions/navigateToImage"},next:{title:"Function: navigateToPod()",permalink:"/api/namespaces/navigation/functions/navigateToPod"}},r={},u=[{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function d(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,o.a)(),...e.components};return(0,a.jsxs)(a.Fragment,{children:[(0,a.jsx)(n.h1,{id:"function-navigatetoimages",children:"Function: navigateToImages()"}),"\n",(0,a.jsxs)(n.blockquote,{children:["\n",(0,a.jsxs)(n.p,{children:[(0,a.jsx)(n.strong,{children:"navigateToImages"}),"(): ",(0,a.jsx)(n.code,{children:"Promise"}),"< ",(0,a.jsx)(n.code,{children:"void"})," >"]}),"\n"]}),"\n",(0,a.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,a.jsxs)(n.p,{children:[(0,a.jsx)(n.code,{children:"Promise"}),"< ",(0,a.jsx)(n.code,{children:"void"})," >"]}),"\n",(0,a.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,a.jsx)(n.p,{children:(0,a.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L4153",children:"packages/extension-api/src/extension-api.d.ts:4153"})})]})}function p(e={}){const{wrapper:n}={...(0,o.a)(),...e.components};return n?(0,a.jsx)(n,{...e,children:(0,a.jsx)(d,{...e})}):d(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>c,a:()=>i});var a=t(27378);const o={},s=a.createContext(o);function i(e){const n=a.useContext(s);return a.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:i(e.components),a.createElement(s.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[59081],{60991:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>r,contentTitle:()=>i,default:()=>p,frontMatter:()=>s,metadata:()=>c,toc:()=>d});var a=t(24246),o=t(71670);const s={},i="Function: navigateToImages()",c={id:"namespaces/navigation/functions/navigateToImages",title:"Function: navigateToImages()",description:"navigateToImages(): Promise\\",source:"@site/api/namespaces/navigation/functions/navigateToImages.md",sourceDirName:"namespaces/navigation/functions",slug:"/namespaces/navigation/functions/navigateToImages",permalink:"/api/namespaces/navigation/functions/navigateToImages",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Function: navigateToImage()",permalink:"/api/namespaces/navigation/functions/navigateToImage"},next:{title:"Function: navigateToPod()",permalink:"/api/namespaces/navigation/functions/navigateToPod"}},r={},d=[{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function u(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,o.a)(),...e.components};return(0,a.jsxs)(a.Fragment,{children:[(0,a.jsx)(n.h1,{id:"function-navigatetoimages",children:"Function: navigateToImages()"}),"\n",(0,a.jsxs)(n.blockquote,{children:["\n",(0,a.jsxs)(n.p,{children:[(0,a.jsx)(n.strong,{children:"navigateToImages"}),"(): ",(0,a.jsx)(n.code,{children:"Promise"}),"< ",(0,a.jsx)(n.code,{children:"void"})," >"]}),"\n"]}),"\n",(0,a.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,a.jsxs)(n.p,{children:[(0,a.jsx)(n.code,{children:"Promise"}),"< ",(0,a.jsx)(n.code,{children:"void"})," >"]}),"\n",(0,a.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,a.jsx)(n.p,{children:(0,a.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L4153",children:"packages/extension-api/src/extension-api.d.ts:4153"})})]})}function p(e={}){const{wrapper:n}={...(0,o.a)(),...e.components};return n?(0,a.jsx)(n,{...e,children:(0,a.jsx)(u,{...e})}):u(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>c,a:()=>i});var a=t(27378);const o={},s=a.createContext(o);function i(e){const n=a.useContext(s);return a.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:i(e.components),a.createElement(s.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/5a9a7a02.39f1c3c1.js b/assets/js/5a9a7a02.a8f5f98e.js similarity index 95% rename from assets/js/5a9a7a02.39f1c3c1.js rename to assets/js/5a9a7a02.a8f5f98e.js index 9328006796f..07a9b5f2c83 100644 --- a/assets/js/5a9a7a02.39f1c3c1.js +++ b/assets/js/5a9a7a02.a8f5f98e.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[89472],{74014:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>i,default:()=>u,frontMatter:()=>c,metadata:()=>r,toc:()=>l});var s=t(24246),o=t(71670);const c={},i="Function: deleteVolume()",r={id:"namespaces/containerEngine/functions/deleteVolume",title:"Function: deleteVolume()",description:"deleteVolume(volumeName, options?): Promise\\",source:"@site/api/namespaces/containerEngine/functions/deleteVolume.md",sourceDirName:"namespaces/containerEngine/functions",slug:"/namespaces/containerEngine/functions/deleteVolume",permalink:"/api/namespaces/containerEngine/functions/deleteVolume",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Function: deleteImage()",permalink:"/api/namespaces/containerEngine/functions/deleteImage"},next:{title:"Function: getImageInspect()",permalink:"/api/namespaces/containerEngine/functions/getImageInspect"}},a={},l=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function d(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,o.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"function-deletevolume",children:"Function: deleteVolume()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"deleteVolume"}),"(",(0,s.jsx)(n.code,{children:"volumeName"}),", ",(0,s.jsx)(n.code,{children:"options"}),"?): ",(0,s.jsx)(n.code,{children:"Promise"}),"< ",(0,s.jsx)(n.code,{children:"void"})," >"]}),"\n"]}),"\n",(0,s.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"volumeName"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"options?"}),": ",(0,s.jsx)(n.a,{href:"/api/interfaces/VolumeDeleteOptions",children:(0,s.jsx)(n.code,{children:"VolumeDeleteOptions"})})]}),"\n",(0,s.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"Promise"}),"< ",(0,s.jsx)(n.code,{children:"void"})," >"]}),"\n",(0,s.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L3372",children:"packages/extension-api/src/extension-api.d.ts:3372"})})]})}function u(e={}){const{wrapper:n}={...(0,o.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(d,{...e})}):d(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>r,a:()=>i});var s=t(27378);const o={},c=s.createContext(o);function i(e){const n=s.useContext(c);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function r(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:i(e.components),s.createElement(c.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[89472],{74014:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>i,default:()=>u,frontMatter:()=>c,metadata:()=>r,toc:()=>l});var s=t(24246),o=t(71670);const c={},i="Function: deleteVolume()",r={id:"namespaces/containerEngine/functions/deleteVolume",title:"Function: deleteVolume()",description:"deleteVolume(volumeName, options?): Promise\\",source:"@site/api/namespaces/containerEngine/functions/deleteVolume.md",sourceDirName:"namespaces/containerEngine/functions",slug:"/namespaces/containerEngine/functions/deleteVolume",permalink:"/api/namespaces/containerEngine/functions/deleteVolume",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Function: deleteImage()",permalink:"/api/namespaces/containerEngine/functions/deleteImage"},next:{title:"Function: getImageInspect()",permalink:"/api/namespaces/containerEngine/functions/getImageInspect"}},a={},l=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function d(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,o.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"function-deletevolume",children:"Function: deleteVolume()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"deleteVolume"}),"(",(0,s.jsx)(n.code,{children:"volumeName"}),", ",(0,s.jsx)(n.code,{children:"options"}),"?): ",(0,s.jsx)(n.code,{children:"Promise"}),"< ",(0,s.jsx)(n.code,{children:"void"})," >"]}),"\n"]}),"\n",(0,s.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"volumeName"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"options?"}),": ",(0,s.jsx)(n.a,{href:"/api/interfaces/VolumeDeleteOptions",children:(0,s.jsx)(n.code,{children:"VolumeDeleteOptions"})})]}),"\n",(0,s.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"Promise"}),"< ",(0,s.jsx)(n.code,{children:"void"})," >"]}),"\n",(0,s.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L3372",children:"packages/extension-api/src/extension-api.d.ts:3372"})})]})}function u(e={}){const{wrapper:n}={...(0,o.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(d,{...e})}):d(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>r,a:()=>i});var s=t(27378);const o={},c=s.createContext(o);function i(e){const n=s.useContext(c);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function r(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:i(e.components),s.createElement(c.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/5b10a003.4567b66d.js b/assets/js/5b10a003.e57f7289.js similarity index 86% rename from assets/js/5b10a003.4567b66d.js rename to assets/js/5b10a003.e57f7289.js index 35741366873..8160965ae48 100644 --- a/assets/js/5b10a003.4567b66d.js +++ b/assets/js/5b10a003.e57f7289.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[28437],{40310:(e,i,s)=>{s.r(i),s.d(i,{assets:()=>a,contentTitle:()=>t,default:()=>h,frontMatter:()=>c,metadata:()=>o,toc:()=>l});var r=s(24246),n=s(71670);const c={},t="Interface: BlkioStats",o={id:"interfaces/BlkioStats",title:"Interface: BlkioStats",description:"Properties",source:"@site/api/interfaces/BlkioStats.md",sourceDirName:"interfaces",slug:"/interfaces/BlkioStats",permalink:"/api/interfaces/BlkioStats",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: BlkioStatEntry",permalink:"/api/interfaces/BlkioStatEntry"},next:{title:"Interface: BuildImageOptions",permalink:"/api/interfaces/BuildImageOptions"}},a={},l=[{value:"Properties",id:"properties",level:2},{value:"io_merged_recursive",id:"io_merged_recursive",level:3},{value:"Source",id:"source",level:4},{value:"io_queue_recursive",id:"io_queue_recursive",level:3},{value:"Source",id:"source-1",level:4},{value:"io_service_bytes_recursive",id:"io_service_bytes_recursive",level:3},{value:"Source",id:"source-2",level:4},{value:"io_service_time_recursive",id:"io_service_time_recursive",level:3},{value:"Source",id:"source-3",level:4},{value:"io_serviced_recursive",id:"io_serviced_recursive",level:3},{value:"Source",id:"source-4",level:4},{value:"io_time_recursive",id:"io_time_recursive",level:3},{value:"Source",id:"source-5",level:4},{value:"io_wait_time_recursive",id:"io_wait_time_recursive",level:3},{value:"Source",id:"source-6",level:4},{value:"sectors_recursive",id:"sectors_recursive",level:3},{value:"Source",id:"source-7",level:4}];function d(e){const i={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,n.a)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(i.h1,{id:"interface-blkiostats",children:"Interface: BlkioStats"}),"\n",(0,r.jsx)(i.h2,{id:"properties",children:"Properties"}),"\n",(0,r.jsx)(i.h3,{id:"io_merged_recursive",children:"io_merged_recursive"}),"\n",(0,r.jsxs)(i.blockquote,{children:["\n",(0,r.jsxs)(i.p,{children:[(0,r.jsx)(i.strong,{children:"io_merged_recursive"}),": ",(0,r.jsx)(i.a,{href:"/api/interfaces/BlkioStatEntry",children:(0,r.jsx)(i.code,{children:"BlkioStatEntry"})}),"[]"]}),"\n"]}),"\n",(0,r.jsx)(i.h4,{id:"source",children:"Source"}),"\n",(0,r.jsx)(i.p,{children:(0,r.jsx)(i.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2776",children:"packages/extension-api/src/extension-api.d.ts:2776"})}),"\n",(0,r.jsx)(i.hr,{}),"\n",(0,r.jsx)(i.h3,{id:"io_queue_recursive",children:"io_queue_recursive"}),"\n",(0,r.jsxs)(i.blockquote,{children:["\n",(0,r.jsxs)(i.p,{children:[(0,r.jsx)(i.strong,{children:"io_queue_recursive"}),": ",(0,r.jsx)(i.a,{href:"/api/interfaces/BlkioStatEntry",children:(0,r.jsx)(i.code,{children:"BlkioStatEntry"})}),"[]"]}),"\n"]}),"\n",(0,r.jsx)(i.h4,{id:"source-1",children:"Source"}),"\n",(0,r.jsx)(i.p,{children:(0,r.jsx)(i.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2773",children:"packages/extension-api/src/extension-api.d.ts:2773"})}),"\n",(0,r.jsx)(i.hr,{}),"\n",(0,r.jsx)(i.h3,{id:"io_service_bytes_recursive",children:"io_service_bytes_recursive"}),"\n",(0,r.jsxs)(i.blockquote,{children:["\n",(0,r.jsxs)(i.p,{children:[(0,r.jsx)(i.strong,{children:"io_service_bytes_recursive"}),": ",(0,r.jsx)(i.a,{href:"/api/interfaces/BlkioStatEntry",children:(0,r.jsx)(i.code,{children:"BlkioStatEntry"})}),"[]"]}),"\n"]}),"\n",(0,r.jsx)(i.h4,{id:"source-2",children:"Source"}),"\n",(0,r.jsx)(i.p,{children:(0,r.jsx)(i.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2771",children:"packages/extension-api/src/extension-api.d.ts:2771"})}),"\n",(0,r.jsx)(i.hr,{}),"\n",(0,r.jsx)(i.h3,{id:"io_service_time_recursive",children:"io_service_time_recursive"}),"\n",(0,r.jsxs)(i.blockquote,{children:["\n",(0,r.jsxs)(i.p,{children:[(0,r.jsx)(i.strong,{children:"io_service_time_recursive"}),": ",(0,r.jsx)(i.a,{href:"/api/interfaces/BlkioStatEntry",children:(0,r.jsx)(i.code,{children:"BlkioStatEntry"})}),"[]"]}),"\n"]}),"\n",(0,r.jsx)(i.h4,{id:"source-3",children:"Source"}),"\n",(0,r.jsx)(i.p,{children:(0,r.jsx)(i.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2774",children:"packages/extension-api/src/extension-api.d.ts:2774"})}),"\n",(0,r.jsx)(i.hr,{}),"\n",(0,r.jsx)(i.h3,{id:"io_serviced_recursive",children:"io_serviced_recursive"}),"\n",(0,r.jsxs)(i.blockquote,{children:["\n",(0,r.jsxs)(i.p,{children:[(0,r.jsx)(i.strong,{children:"io_serviced_recursive"}),": ",(0,r.jsx)(i.a,{href:"/api/interfaces/BlkioStatEntry",children:(0,r.jsx)(i.code,{children:"BlkioStatEntry"})}),"[]"]}),"\n"]}),"\n",(0,r.jsx)(i.h4,{id:"source-4",children:"Source"}),"\n",(0,r.jsx)(i.p,{children:(0,r.jsx)(i.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2772",children:"packages/extension-api/src/extension-api.d.ts:2772"})}),"\n",(0,r.jsx)(i.hr,{}),"\n",(0,r.jsx)(i.h3,{id:"io_time_recursive",children:"io_time_recursive"}),"\n",(0,r.jsxs)(i.blockquote,{children:["\n",(0,r.jsxs)(i.p,{children:[(0,r.jsx)(i.strong,{children:"io_time_recursive"}),": ",(0,r.jsx)(i.a,{href:"/api/interfaces/BlkioStatEntry",children:(0,r.jsx)(i.code,{children:"BlkioStatEntry"})}),"[]"]}),"\n"]}),"\n",(0,r.jsx)(i.h4,{id:"source-5",children:"Source"}),"\n",(0,r.jsx)(i.p,{children:(0,r.jsx)(i.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2777",children:"packages/extension-api/src/extension-api.d.ts:2777"})}),"\n",(0,r.jsx)(i.hr,{}),"\n",(0,r.jsx)(i.h3,{id:"io_wait_time_recursive",children:"io_wait_time_recursive"}),"\n",(0,r.jsxs)(i.blockquote,{children:["\n",(0,r.jsxs)(i.p,{children:[(0,r.jsx)(i.strong,{children:"io_wait_time_recursive"}),": ",(0,r.jsx)(i.a,{href:"/api/interfaces/BlkioStatEntry",children:(0,r.jsx)(i.code,{children:"BlkioStatEntry"})}),"[]"]}),"\n"]}),"\n",(0,r.jsx)(i.h4,{id:"source-6",children:"Source"}),"\n",(0,r.jsx)(i.p,{children:(0,r.jsx)(i.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2775",children:"packages/extension-api/src/extension-api.d.ts:2775"})}),"\n",(0,r.jsx)(i.hr,{}),"\n",(0,r.jsx)(i.h3,{id:"sectors_recursive",children:"sectors_recursive"}),"\n",(0,r.jsxs)(i.blockquote,{children:["\n",(0,r.jsxs)(i.p,{children:[(0,r.jsx)(i.strong,{children:"sectors_recursive"}),": ",(0,r.jsx)(i.a,{href:"/api/interfaces/BlkioStatEntry",children:(0,r.jsx)(i.code,{children:"BlkioStatEntry"})}),"[]"]}),"\n"]}),"\n",(0,r.jsx)(i.h4,{id:"source-7",children:"Source"}),"\n",(0,r.jsx)(i.p,{children:(0,r.jsx)(i.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2778",children:"packages/extension-api/src/extension-api.d.ts:2778"})})]})}function h(e={}){const{wrapper:i}={...(0,n.a)(),...e.components};return i?(0,r.jsx)(i,{...e,children:(0,r.jsx)(d,{...e})}):d(e)}},71670:(e,i,s)=>{s.d(i,{Z:()=>o,a:()=>t});var r=s(27378);const n={},c=r.createContext(n);function t(e){const i=r.useContext(c);return r.useMemo((function(){return"function"==typeof e?e(i):{...i,...e}}),[i,e])}function o(e){let i;return i=e.disableParentContext?"function"==typeof e.components?e.components(n):e.components||n:t(e.components),r.createElement(c.Provider,{value:i},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[28437],{40310:(e,i,s)=>{s.r(i),s.d(i,{assets:()=>a,contentTitle:()=>t,default:()=>h,frontMatter:()=>c,metadata:()=>o,toc:()=>d});var r=s(24246),n=s(71670);const c={},t="Interface: BlkioStats",o={id:"interfaces/BlkioStats",title:"Interface: BlkioStats",description:"Properties",source:"@site/api/interfaces/BlkioStats.md",sourceDirName:"interfaces",slug:"/interfaces/BlkioStats",permalink:"/api/interfaces/BlkioStats",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: BlkioStatEntry",permalink:"/api/interfaces/BlkioStatEntry"},next:{title:"Interface: BuildImageOptions",permalink:"/api/interfaces/BuildImageOptions"}},a={},d=[{value:"Properties",id:"properties",level:2},{value:"io_merged_recursive",id:"io_merged_recursive",level:3},{value:"Source",id:"source",level:4},{value:"io_queue_recursive",id:"io_queue_recursive",level:3},{value:"Source",id:"source-1",level:4},{value:"io_service_bytes_recursive",id:"io_service_bytes_recursive",level:3},{value:"Source",id:"source-2",level:4},{value:"io_service_time_recursive",id:"io_service_time_recursive",level:3},{value:"Source",id:"source-3",level:4},{value:"io_serviced_recursive",id:"io_serviced_recursive",level:3},{value:"Source",id:"source-4",level:4},{value:"io_time_recursive",id:"io_time_recursive",level:3},{value:"Source",id:"source-5",level:4},{value:"io_wait_time_recursive",id:"io_wait_time_recursive",level:3},{value:"Source",id:"source-6",level:4},{value:"sectors_recursive",id:"sectors_recursive",level:3},{value:"Source",id:"source-7",level:4}];function l(e){const i={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,n.a)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(i.h1,{id:"interface-blkiostats",children:"Interface: BlkioStats"}),"\n",(0,r.jsx)(i.h2,{id:"properties",children:"Properties"}),"\n",(0,r.jsx)(i.h3,{id:"io_merged_recursive",children:"io_merged_recursive"}),"\n",(0,r.jsxs)(i.blockquote,{children:["\n",(0,r.jsxs)(i.p,{children:[(0,r.jsx)(i.strong,{children:"io_merged_recursive"}),": ",(0,r.jsx)(i.a,{href:"/api/interfaces/BlkioStatEntry",children:(0,r.jsx)(i.code,{children:"BlkioStatEntry"})}),"[]"]}),"\n"]}),"\n",(0,r.jsx)(i.h4,{id:"source",children:"Source"}),"\n",(0,r.jsx)(i.p,{children:(0,r.jsx)(i.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2776",children:"packages/extension-api/src/extension-api.d.ts:2776"})}),"\n",(0,r.jsx)(i.hr,{}),"\n",(0,r.jsx)(i.h3,{id:"io_queue_recursive",children:"io_queue_recursive"}),"\n",(0,r.jsxs)(i.blockquote,{children:["\n",(0,r.jsxs)(i.p,{children:[(0,r.jsx)(i.strong,{children:"io_queue_recursive"}),": ",(0,r.jsx)(i.a,{href:"/api/interfaces/BlkioStatEntry",children:(0,r.jsx)(i.code,{children:"BlkioStatEntry"})}),"[]"]}),"\n"]}),"\n",(0,r.jsx)(i.h4,{id:"source-1",children:"Source"}),"\n",(0,r.jsx)(i.p,{children:(0,r.jsx)(i.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2773",children:"packages/extension-api/src/extension-api.d.ts:2773"})}),"\n",(0,r.jsx)(i.hr,{}),"\n",(0,r.jsx)(i.h3,{id:"io_service_bytes_recursive",children:"io_service_bytes_recursive"}),"\n",(0,r.jsxs)(i.blockquote,{children:["\n",(0,r.jsxs)(i.p,{children:[(0,r.jsx)(i.strong,{children:"io_service_bytes_recursive"}),": ",(0,r.jsx)(i.a,{href:"/api/interfaces/BlkioStatEntry",children:(0,r.jsx)(i.code,{children:"BlkioStatEntry"})}),"[]"]}),"\n"]}),"\n",(0,r.jsx)(i.h4,{id:"source-2",children:"Source"}),"\n",(0,r.jsx)(i.p,{children:(0,r.jsx)(i.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2771",children:"packages/extension-api/src/extension-api.d.ts:2771"})}),"\n",(0,r.jsx)(i.hr,{}),"\n",(0,r.jsx)(i.h3,{id:"io_service_time_recursive",children:"io_service_time_recursive"}),"\n",(0,r.jsxs)(i.blockquote,{children:["\n",(0,r.jsxs)(i.p,{children:[(0,r.jsx)(i.strong,{children:"io_service_time_recursive"}),": ",(0,r.jsx)(i.a,{href:"/api/interfaces/BlkioStatEntry",children:(0,r.jsx)(i.code,{children:"BlkioStatEntry"})}),"[]"]}),"\n"]}),"\n",(0,r.jsx)(i.h4,{id:"source-3",children:"Source"}),"\n",(0,r.jsx)(i.p,{children:(0,r.jsx)(i.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2774",children:"packages/extension-api/src/extension-api.d.ts:2774"})}),"\n",(0,r.jsx)(i.hr,{}),"\n",(0,r.jsx)(i.h3,{id:"io_serviced_recursive",children:"io_serviced_recursive"}),"\n",(0,r.jsxs)(i.blockquote,{children:["\n",(0,r.jsxs)(i.p,{children:[(0,r.jsx)(i.strong,{children:"io_serviced_recursive"}),": ",(0,r.jsx)(i.a,{href:"/api/interfaces/BlkioStatEntry",children:(0,r.jsx)(i.code,{children:"BlkioStatEntry"})}),"[]"]}),"\n"]}),"\n",(0,r.jsx)(i.h4,{id:"source-4",children:"Source"}),"\n",(0,r.jsx)(i.p,{children:(0,r.jsx)(i.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2772",children:"packages/extension-api/src/extension-api.d.ts:2772"})}),"\n",(0,r.jsx)(i.hr,{}),"\n",(0,r.jsx)(i.h3,{id:"io_time_recursive",children:"io_time_recursive"}),"\n",(0,r.jsxs)(i.blockquote,{children:["\n",(0,r.jsxs)(i.p,{children:[(0,r.jsx)(i.strong,{children:"io_time_recursive"}),": ",(0,r.jsx)(i.a,{href:"/api/interfaces/BlkioStatEntry",children:(0,r.jsx)(i.code,{children:"BlkioStatEntry"})}),"[]"]}),"\n"]}),"\n",(0,r.jsx)(i.h4,{id:"source-5",children:"Source"}),"\n",(0,r.jsx)(i.p,{children:(0,r.jsx)(i.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2777",children:"packages/extension-api/src/extension-api.d.ts:2777"})}),"\n",(0,r.jsx)(i.hr,{}),"\n",(0,r.jsx)(i.h3,{id:"io_wait_time_recursive",children:"io_wait_time_recursive"}),"\n",(0,r.jsxs)(i.blockquote,{children:["\n",(0,r.jsxs)(i.p,{children:[(0,r.jsx)(i.strong,{children:"io_wait_time_recursive"}),": ",(0,r.jsx)(i.a,{href:"/api/interfaces/BlkioStatEntry",children:(0,r.jsx)(i.code,{children:"BlkioStatEntry"})}),"[]"]}),"\n"]}),"\n",(0,r.jsx)(i.h4,{id:"source-6",children:"Source"}),"\n",(0,r.jsx)(i.p,{children:(0,r.jsx)(i.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2775",children:"packages/extension-api/src/extension-api.d.ts:2775"})}),"\n",(0,r.jsx)(i.hr,{}),"\n",(0,r.jsx)(i.h3,{id:"sectors_recursive",children:"sectors_recursive"}),"\n",(0,r.jsxs)(i.blockquote,{children:["\n",(0,r.jsxs)(i.p,{children:[(0,r.jsx)(i.strong,{children:"sectors_recursive"}),": ",(0,r.jsx)(i.a,{href:"/api/interfaces/BlkioStatEntry",children:(0,r.jsx)(i.code,{children:"BlkioStatEntry"})}),"[]"]}),"\n"]}),"\n",(0,r.jsx)(i.h4,{id:"source-7",children:"Source"}),"\n",(0,r.jsx)(i.p,{children:(0,r.jsx)(i.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2778",children:"packages/extension-api/src/extension-api.d.ts:2778"})})]})}function h(e={}){const{wrapper:i}={...(0,n.a)(),...e.components};return i?(0,r.jsx)(i,{...e,children:(0,r.jsx)(l,{...e})}):l(e)}},71670:(e,i,s)=>{s.d(i,{Z:()=>o,a:()=>t});var r=s(27378);const n={},c=r.createContext(n);function t(e){const i=r.useContext(c);return r.useMemo((function(){return"function"==typeof e?e(i):{...i,...e}}),[i,e])}function o(e){let i;return i=e.disableParentContext?"function"==typeof e.components?e.components(n):e.components||n:t(e.components),r.createElement(c.Provider,{value:i},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/5b7d9ef2.efa9bcd8.js b/assets/js/5b7d9ef2.b16878c3.js similarity index 97% rename from assets/js/5b7d9ef2.efa9bcd8.js rename to assets/js/5b7d9ef2.b16878c3.js index ab99743c7aa..40622b87f1d 100644 --- a/assets/js/5b7d9ef2.efa9bcd8.js +++ b/assets/js/5b7d9ef2.b16878c3.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[86112],{16450:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>c,contentTitle:()=>a,default:()=>u,frontMatter:()=>o,metadata:()=>i,toc:()=>p});var r=n(24246),s=n(71670);const o={},a="Type alias: KubernetesGeneratorType",i={id:"type-aliases/KubernetesGeneratorType",title:"Type alias: KubernetesGeneratorType",description:'KubernetesGeneratorType: "Compose" \\| "Pod" \\| "Container"',source:"@site/api/type-aliases/KubernetesGeneratorType.md",sourceDirName:"type-aliases",slug:"/type-aliases/KubernetesGeneratorType",permalink:"/api/type-aliases/KubernetesGeneratorType",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Type alias: KubernetesGeneratorSelector",permalink:"/api/type-aliases/KubernetesGeneratorSelector"},next:{title:"Type alias: MountConfig",permalink:"/api/type-aliases/MountConfig"}},c={},p=[{value:"Source",id:"source",level:2}];function l(e){const t={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(t.h1,{id:"type-alias-kubernetesgeneratortype",children:"Type alias: KubernetesGeneratorType"}),"\n",(0,r.jsxs)(t.blockquote,{children:["\n",(0,r.jsxs)(t.p,{children:[(0,r.jsx)(t.strong,{children:"KubernetesGeneratorType"}),": ",(0,r.jsx)(t.code,{children:'"Compose"'})," | ",(0,r.jsx)(t.code,{children:'"Pod"'})," | ",(0,r.jsx)(t.code,{children:'"Container"'})]}),"\n"]}),"\n",(0,r.jsx)(t.h2,{id:"source",children:"Source"}),"\n",(0,r.jsx)(t.p,{children:(0,r.jsx)(t.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L1831",children:"packages/extension-api/src/extension-api.d.ts:1831"})})]})}function u(e={}){const{wrapper:t}={...(0,s.a)(),...e.components};return t?(0,r.jsx)(t,{...e,children:(0,r.jsx)(l,{...e})}):l(e)}},71670:(e,t,n)=>{n.d(t,{Z:()=>i,a:()=>a});var r=n(27378);const s={},o=r.createContext(s);function a(e){const t=r.useContext(o);return r.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function i(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:a(e.components),r.createElement(o.Provider,{value:t},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[86112],{16450:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>c,contentTitle:()=>a,default:()=>u,frontMatter:()=>o,metadata:()=>i,toc:()=>p});var r=n(24246),s=n(71670);const o={},a="Type alias: KubernetesGeneratorType",i={id:"type-aliases/KubernetesGeneratorType",title:"Type alias: KubernetesGeneratorType",description:'KubernetesGeneratorType: "Compose" \\| "Pod" \\| "Container"',source:"@site/api/type-aliases/KubernetesGeneratorType.md",sourceDirName:"type-aliases",slug:"/type-aliases/KubernetesGeneratorType",permalink:"/api/type-aliases/KubernetesGeneratorType",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Type alias: KubernetesGeneratorSelector",permalink:"/api/type-aliases/KubernetesGeneratorSelector"},next:{title:"Type alias: MountConfig",permalink:"/api/type-aliases/MountConfig"}},c={},p=[{value:"Source",id:"source",level:2}];function l(e){const t={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(t.h1,{id:"type-alias-kubernetesgeneratortype",children:"Type alias: KubernetesGeneratorType"}),"\n",(0,r.jsxs)(t.blockquote,{children:["\n",(0,r.jsxs)(t.p,{children:[(0,r.jsx)(t.strong,{children:"KubernetesGeneratorType"}),": ",(0,r.jsx)(t.code,{children:'"Compose"'})," | ",(0,r.jsx)(t.code,{children:'"Pod"'})," | ",(0,r.jsx)(t.code,{children:'"Container"'})]}),"\n"]}),"\n",(0,r.jsx)(t.h2,{id:"source",children:"Source"}),"\n",(0,r.jsx)(t.p,{children:(0,r.jsx)(t.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L1831",children:"packages/extension-api/src/extension-api.d.ts:1831"})})]})}function u(e={}){const{wrapper:t}={...(0,s.a)(),...e.components};return t?(0,r.jsx)(t,{...e,children:(0,r.jsx)(l,{...e})}):l(e)}},71670:(e,t,n)=>{n.d(t,{Z:()=>i,a:()=>a});var r=n(27378);const s={},o=r.createContext(s);function a(e){const t=r.useContext(o);return r.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function i(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:a(e.components),r.createElement(o.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/5bc09a53.fd285884.js b/assets/js/5bc09a53.d139a151.js similarity index 93% rename from assets/js/5bc09a53.fd285884.js rename to assets/js/5bc09a53.d139a151.js index 06aa0789457..8dfba4f0bf9 100644 --- a/assets/js/5bc09a53.fd285884.js +++ b/assets/js/5bc09a53.d139a151.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[79649],{32652:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>l,contentTitle:()=>a,default:()=>h,frontMatter:()=>r,metadata:()=>c,toc:()=>o});var t=s(24246),i=s(71670);const r={},a="Interface: HealthConfig",c={id:"interfaces/HealthConfig",title:"Interface: HealthConfig",description:"Configuration options for defining a healthcheck for a container.",source:"@site/api/interfaces/HealthConfig.md",sourceDirName:"interfaces",slug:"/interfaces/HealthConfig",permalink:"/api/interfaces/HealthConfig",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: HealthCheckResults",permalink:"/api/interfaces/HealthCheckResults"},next:{title:"Interface: 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:"Source",id:"source",level:4},{value:"Retries?",id:"retries",level:3},{value:"Example",id:"example-1",level:4},{value:"Source",id:"source-1",level:4},{value:"StartPeriod?",id:"startperiod",level:3},{value:"Example",id:"example-2",level:4},{value:"Source",id:"source-2",level:4},{value:"Test?",id:"test",level:3},{value:"Example",id:"example-3",level:4},{value:"Example",id:"example-4",level:4},{value:"Example",id:"example-5",level:4},{value:"Example",id:"example-6",level:4},{value:"Source",id:"source-3",level:4},{value:"Timeout?",id:"timeout",level:3},{value:"Example",id:"example-7",level:4},{value:"Source",id:"source-4",level:4}];function d(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",pre:"pre",strong:"strong",...(0,i.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"interface-healthconfig",children:"Interface: HealthConfig"}),"\n",(0,t.jsxs)(n.p,{children:["Configuration options for defining a healthcheck for a container.\nTo get health check result you can use ",(0,t.jsx)(n.a,{href:"/api/namespaces/containerEngine/functions/inspectContainer",children:"containerEngine.inspectContainer"})," and inside the obtained ",(0,t.jsx)(n.a,{href:"/api/interfaces/ContainerInspectInfo",children:"ContainerInspectInfo"})," you can access the ",(0,t.jsx)(n.code,{children:"Status.Health"})," property containing a ",(0,t.jsx)(n.a,{href:"/api/interfaces/HealthCheckResults",children:"HealthCheckResults"}),"."]}),"\n",(0,t.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,t.jsx)(n.h3,{id:"interval",children:"Interval?"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:(0,t.jsx)(n.code,{children:"optional"})})," ",(0,t.jsx)(n.strong,{children:"Interval"}),": ",(0,t.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"The time to wait between checks in nanoseconds. It should be 0 or at least 1000000 (1 ms). 0 means inherit."}),"\n",(0,t.jsx)(n.h4,{id:"example",children:"Example"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-ts",children:"// Set interval to 1 second\nInterval?: 1000000000;\n"})}),"\n",(0,t.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2426",children:"packages/extension-api/src/extension-api.d.ts:2426"})}),"\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.strong,{children:(0,t.jsx)(n.code,{children:"optional"})})," ",(0,t.jsx)(n.strong,{children:"Retries"}),": ",(0,t.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"The number of consecutive failures needed to consider a container as unhealthy. 0 means inherit."}),"\n",(0,t.jsx)(n.h4,{id:"example-1",children:"Example"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-ts",children:"// Set retries to 3\nRetries?: 3;\n"})}),"\n",(0,t.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2454",children:"packages/extension-api/src/extension-api.d.ts:2454"})}),"\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.strong,{children:(0,t.jsx)(n.code,{children:"optional"})})," ",(0,t.jsx)(n.strong,{children:"StartPeriod"}),": ",(0,t.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"Start period for the container to initialize before starting health-retries countdown in nanoseconds. It should\nbe 0 or at least 1000000 (1 ms). 0 means inherit."}),"\n",(0,t.jsx)(n.h4,{id:"example-2",children:"Example"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-ts",children:"// Set start period to 2 seconds\nStartPeriod?: 2000000000;\n"})}),"\n",(0,t.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2445",children:"packages/extension-api/src/extension-api.d.ts:2445"})}),"\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.strong,{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:"example-3",children:"Example"}),"\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.h4,{id:"example-4",children:"Example"}),"\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.h4,{id:"example-5",children:"Example"}),"\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.h4,{id:"example-6",children:"Example"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-ts",children:'// Podman will execute the command inside the target container and wait for either a "0" or "failure exit" code.\nTest?: ["CMD-SHELL", "curl http://localhost || exit 1"];\n'})}),"\n",(0,t.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2417",children:"packages/extension-api/src/extension-api.d.ts:2417"})}),"\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.strong,{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-7",children:"Example"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-ts",children:"// Set timeout to 5 seconds\nTimeout?: 5000000000;\n"})}),"\n",(0,t.jsx)(n.h4,{id:"source-4",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2435",children:"packages/extension-api/src/extension-api.d.ts:2435"})})]})}function h(e={}){const{wrapper:n}={...(0,i.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(d,{...e})}):d(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>c,a:()=>a});var t=s(27378);const i={},r=t.createContext(i);function a(e){const n=t.useContext(r);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:a(e.components),t.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[79649],{32652:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>l,contentTitle:()=>a,default:()=>h,frontMatter:()=>r,metadata:()=>c,toc:()=>o});var t=s(24246),i=s(71670);const r={},a="Interface: HealthConfig",c={id:"interfaces/HealthConfig",title:"Interface: HealthConfig",description:"Configuration options for defining a healthcheck for a container.",source:"@site/api/interfaces/HealthConfig.md",sourceDirName:"interfaces",slug:"/interfaces/HealthConfig",permalink:"/api/interfaces/HealthConfig",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: HealthCheckResults",permalink:"/api/interfaces/HealthCheckResults"},next:{title:"Interface: 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:"Source",id:"source",level:4},{value:"Retries?",id:"retries",level:3},{value:"Example",id:"example-1",level:4},{value:"Source",id:"source-1",level:4},{value:"StartPeriod?",id:"startperiod",level:3},{value:"Example",id:"example-2",level:4},{value:"Source",id:"source-2",level:4},{value:"Test?",id:"test",level:3},{value:"Example",id:"example-3",level:4},{value:"Example",id:"example-4",level:4},{value:"Example",id:"example-5",level:4},{value:"Example",id:"example-6",level:4},{value:"Source",id:"source-3",level:4},{value:"Timeout?",id:"timeout",level:3},{value:"Example",id:"example-7",level:4},{value:"Source",id:"source-4",level:4}];function d(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",pre:"pre",strong:"strong",...(0,i.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"interface-healthconfig",children:"Interface: HealthConfig"}),"\n",(0,t.jsxs)(n.p,{children:["Configuration options for defining a healthcheck for a container.\nTo get health check result you can use ",(0,t.jsx)(n.a,{href:"/api/namespaces/containerEngine/functions/inspectContainer",children:"containerEngine.inspectContainer"})," and inside the obtained ",(0,t.jsx)(n.a,{href:"/api/interfaces/ContainerInspectInfo",children:"ContainerInspectInfo"})," you can access the ",(0,t.jsx)(n.code,{children:"Status.Health"})," property containing a ",(0,t.jsx)(n.a,{href:"/api/interfaces/HealthCheckResults",children:"HealthCheckResults"}),"."]}),"\n",(0,t.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,t.jsx)(n.h3,{id:"interval",children:"Interval?"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:(0,t.jsx)(n.code,{children:"optional"})})," ",(0,t.jsx)(n.strong,{children:"Interval"}),": ",(0,t.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"The time to wait between checks in nanoseconds. It should be 0 or at least 1000000 (1 ms). 0 means inherit."}),"\n",(0,t.jsx)(n.h4,{id:"example",children:"Example"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-ts",children:"// Set interval to 1 second\nInterval?: 1000000000;\n"})}),"\n",(0,t.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2426",children:"packages/extension-api/src/extension-api.d.ts:2426"})}),"\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.strong,{children:(0,t.jsx)(n.code,{children:"optional"})})," ",(0,t.jsx)(n.strong,{children:"Retries"}),": ",(0,t.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"The number of consecutive failures needed to consider a container as unhealthy. 0 means inherit."}),"\n",(0,t.jsx)(n.h4,{id:"example-1",children:"Example"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-ts",children:"// Set retries to 3\nRetries?: 3;\n"})}),"\n",(0,t.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2454",children:"packages/extension-api/src/extension-api.d.ts:2454"})}),"\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.strong,{children:(0,t.jsx)(n.code,{children:"optional"})})," ",(0,t.jsx)(n.strong,{children:"StartPeriod"}),": ",(0,t.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"Start period for the container to initialize before starting health-retries countdown in nanoseconds. It should\nbe 0 or at least 1000000 (1 ms). 0 means inherit."}),"\n",(0,t.jsx)(n.h4,{id:"example-2",children:"Example"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-ts",children:"// Set start period to 2 seconds\nStartPeriod?: 2000000000;\n"})}),"\n",(0,t.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2445",children:"packages/extension-api/src/extension-api.d.ts:2445"})}),"\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.strong,{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:"example-3",children:"Example"}),"\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.h4,{id:"example-4",children:"Example"}),"\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.h4,{id:"example-5",children:"Example"}),"\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.h4,{id:"example-6",children:"Example"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-ts",children:'// Podman will execute the command inside the target container and wait for either a "0" or "failure exit" code.\nTest?: ["CMD-SHELL", "curl http://localhost || exit 1"];\n'})}),"\n",(0,t.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2417",children:"packages/extension-api/src/extension-api.d.ts:2417"})}),"\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.strong,{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-7",children:"Example"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-ts",children:"// Set timeout to 5 seconds\nTimeout?: 5000000000;\n"})}),"\n",(0,t.jsx)(n.h4,{id:"source-4",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2435",children:"packages/extension-api/src/extension-api.d.ts:2435"})})]})}function h(e={}){const{wrapper:n}={...(0,i.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(d,{...e})}):d(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>c,a:()=>a});var t=s(27378);const i={},r=t.createContext(i);function a(e){const n=t.useContext(r);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:a(e.components),t.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/5c0f0993.18d7fdbf.js b/assets/js/5c0f0993.4e66892c.js similarity index 87% rename from assets/js/5c0f0993.18d7fdbf.js rename to assets/js/5c0f0993.4e66892c.js index 1a0062df004..3751743a060 100644 --- a/assets/js/5c0f0993.18d7fdbf.js +++ b/assets/js/5c0f0993.4e66892c.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[5674],{282:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>o,contentTitle:()=>c,default:()=>h,frontMatter:()=>i,metadata:()=>d,toc:()=>a});var s=r(24246),t=r(71670);const i={},c="Interface: TelemetrySender",d={id:"interfaces/TelemetrySender",title:"Interface: TelemetrySender",description:"The telemetry sender is the contract between a telemetry logger and some telemetry service. Note that extensions must NOT",source:"@site/api/interfaces/TelemetrySender.md",sourceDirName:"interfaces",slug:"/interfaces/TelemetrySender",permalink:"/api/interfaces/TelemetrySender",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: TelemetryLoggerOptions",permalink:"/api/interfaces/TelemetryLoggerOptions"},next:{title:"Interface: ThrottlingData",permalink:"/api/interfaces/ThrottlingData"}},o={},a=[{value:"Methods",id:"methods",level:2},{value:"flush()?",id:"flush",level:3},{value:"Returns",id:"returns",level:4},{value:"Source",id:"source",level:4},{value:"sendErrorData()",id:"senderrordata",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Source",id:"source-1",level:4},{value:"sendEventData()",id:"sendeventdata",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-2",level:4},{value:"Source",id:"source-2",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,t.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"interface-telemetrysender",children:"Interface: TelemetrySender"}),"\n",(0,s.jsxs)(n.p,{children:["The telemetry sender is the contract between a telemetry logger and some telemetry service. ",(0,s.jsx)(n.strong,{children:"Note"})," that extensions must NOT\ncall the methods of their sender directly as the logger provides extra guards and cleaning."]}),"\n",(0,s.jsx)(n.h2,{id:"methods",children:"Methods"}),"\n",(0,s.jsx)(n.h3,{id:"flush",children:"flush()?"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:(0,s.jsx)(n.code,{children:"optional"})})," ",(0,s.jsx)(n.strong,{children:"flush"}),"(): ",(0,s.jsx)(n.code,{children:"void"})," | ",(0,s.jsx)(n.code,{children:"Promise"}),"< ",(0,s.jsx)(n.code,{children:"void"})," >"]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:["Optional flush function which will give this sender a chance to send any remaining events\nas its ",(0,s.jsx)(n.a,{href:"/api/interfaces/TelemetryLogger",children:"TelemetryLogger"})," is being disposed"]}),"\n",(0,s.jsx)(n.h4,{id:"returns",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"void"})," | ",(0,s.jsx)(n.code,{children:"Promise"}),"< ",(0,s.jsx)(n.code,{children:"void"})," >"]}),"\n",(0,s.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L3934",children:"packages/extension-api/src/extension-api.d.ts:3934"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"senderrordata",children:"sendErrorData()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"sendErrorData"}),"(",(0,s.jsx)(n.code,{children:"error"}),", ",(0,s.jsx)(n.code,{children:"data"}),"?): ",(0,s.jsx)(n.code,{children:"void"})]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:["Function to send an error. Used within a ",(0,s.jsx)(n.a,{href:"/api/interfaces/TelemetryLogger",children:"TelemetryLogger"})]}),"\n",(0,s.jsx)(n.h4,{id:"parameters",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"error"}),": ",(0,s.jsx)(n.code,{children:"Error"})]}),"\n",(0,s.jsx)(n.p,{children:"The error being logged"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"data?"}),": ",(0,s.jsx)(n.code,{children:"Record"}),"< ",(0,s.jsx)(n.code,{children:"string"}),", ",(0,s.jsx)(n.code,{children:"any"})," >"]}),"\n",(0,s.jsx)(n.p,{children:"Any additional data to be collected with the exception"}),"\n",(0,s.jsx)(n.h4,{id:"returns-1",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"void"})}),"\n",(0,s.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L3928",children:"packages/extension-api/src/extension-api.d.ts:3928"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"sendeventdata",children:"sendEventData()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"sendEventData"}),"(",(0,s.jsx)(n.code,{children:"eventName"}),", ",(0,s.jsx)(n.code,{children:"data"}),"?): ",(0,s.jsx)(n.code,{children:"void"})]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:["Function to send event data without a stacktrace. Used within a ",(0,s.jsx)(n.a,{href:"/api/interfaces/TelemetryLogger",children:"TelemetryLogger"})]}),"\n",(0,s.jsx)(n.h4,{id:"parameters-1",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"eventName"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n",(0,s.jsx)(n.p,{children:"The name of the event which you are logging"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"data?"}),": ",(0,s.jsx)(n.code,{children:"Record"}),"< ",(0,s.jsx)(n.code,{children:"string"}),", ",(0,s.jsx)(n.code,{children:"any"})," >"]}),"\n",(0,s.jsx)(n.p,{children:"A serializable key value pair that is being logged"}),"\n",(0,s.jsx)(n.h4,{id:"returns-2",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"void"})}),"\n",(0,s.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L3919",children:"packages/extension-api/src/extension-api.d.ts:3919"})})]})}function h(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},71670:(e,n,r)=>{r.d(n,{Z:()=>d,a:()=>c});var s=r(27378);const t={},i=s.createContext(t);function c(e){const n=s.useContext(i);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function d(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:c(e.components),s.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[5674],{282:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>o,contentTitle:()=>d,default:()=>h,frontMatter:()=>i,metadata:()=>c,toc:()=>a});var s=r(24246),t=r(71670);const i={},d="Interface: TelemetrySender",c={id:"interfaces/TelemetrySender",title:"Interface: TelemetrySender",description:"The telemetry sender is the contract between a telemetry logger and some telemetry service. Note that extensions must NOT",source:"@site/api/interfaces/TelemetrySender.md",sourceDirName:"interfaces",slug:"/interfaces/TelemetrySender",permalink:"/api/interfaces/TelemetrySender",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: TelemetryLoggerOptions",permalink:"/api/interfaces/TelemetryLoggerOptions"},next:{title:"Interface: ThrottlingData",permalink:"/api/interfaces/ThrottlingData"}},o={},a=[{value:"Methods",id:"methods",level:2},{value:"flush()?",id:"flush",level:3},{value:"Returns",id:"returns",level:4},{value:"Source",id:"source",level:4},{value:"sendErrorData()",id:"senderrordata",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Source",id:"source-1",level:4},{value:"sendEventData()",id:"sendeventdata",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-2",level:4},{value:"Source",id:"source-2",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,t.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"interface-telemetrysender",children:"Interface: TelemetrySender"}),"\n",(0,s.jsxs)(n.p,{children:["The telemetry sender is the contract between a telemetry logger and some telemetry service. ",(0,s.jsx)(n.strong,{children:"Note"})," that extensions must NOT\ncall the methods of their sender directly as the logger provides extra guards and cleaning."]}),"\n",(0,s.jsx)(n.h2,{id:"methods",children:"Methods"}),"\n",(0,s.jsx)(n.h3,{id:"flush",children:"flush()?"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:(0,s.jsx)(n.code,{children:"optional"})})," ",(0,s.jsx)(n.strong,{children:"flush"}),"(): ",(0,s.jsx)(n.code,{children:"void"})," | ",(0,s.jsx)(n.code,{children:"Promise"}),"< ",(0,s.jsx)(n.code,{children:"void"})," >"]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:["Optional flush function which will give this sender a chance to send any remaining events\nas its ",(0,s.jsx)(n.a,{href:"/api/interfaces/TelemetryLogger",children:"TelemetryLogger"})," is being disposed"]}),"\n",(0,s.jsx)(n.h4,{id:"returns",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"void"})," | ",(0,s.jsx)(n.code,{children:"Promise"}),"< ",(0,s.jsx)(n.code,{children:"void"})," >"]}),"\n",(0,s.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L3934",children:"packages/extension-api/src/extension-api.d.ts:3934"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"senderrordata",children:"sendErrorData()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"sendErrorData"}),"(",(0,s.jsx)(n.code,{children:"error"}),", ",(0,s.jsx)(n.code,{children:"data"}),"?): ",(0,s.jsx)(n.code,{children:"void"})]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:["Function to send an error. Used within a ",(0,s.jsx)(n.a,{href:"/api/interfaces/TelemetryLogger",children:"TelemetryLogger"})]}),"\n",(0,s.jsx)(n.h4,{id:"parameters",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"error"}),": ",(0,s.jsx)(n.code,{children:"Error"})]}),"\n",(0,s.jsx)(n.p,{children:"The error being logged"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"data?"}),": ",(0,s.jsx)(n.code,{children:"Record"}),"< ",(0,s.jsx)(n.code,{children:"string"}),", ",(0,s.jsx)(n.code,{children:"any"})," >"]}),"\n",(0,s.jsx)(n.p,{children:"Any additional data to be collected with the exception"}),"\n",(0,s.jsx)(n.h4,{id:"returns-1",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"void"})}),"\n",(0,s.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L3928",children:"packages/extension-api/src/extension-api.d.ts:3928"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"sendeventdata",children:"sendEventData()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"sendEventData"}),"(",(0,s.jsx)(n.code,{children:"eventName"}),", ",(0,s.jsx)(n.code,{children:"data"}),"?): ",(0,s.jsx)(n.code,{children:"void"})]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:["Function to send event data without a stacktrace. Used within a ",(0,s.jsx)(n.a,{href:"/api/interfaces/TelemetryLogger",children:"TelemetryLogger"})]}),"\n",(0,s.jsx)(n.h4,{id:"parameters-1",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"eventName"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n",(0,s.jsx)(n.p,{children:"The name of the event which you are logging"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"data?"}),": ",(0,s.jsx)(n.code,{children:"Record"}),"< ",(0,s.jsx)(n.code,{children:"string"}),", ",(0,s.jsx)(n.code,{children:"any"})," >"]}),"\n",(0,s.jsx)(n.p,{children:"A serializable key value pair that is being logged"}),"\n",(0,s.jsx)(n.h4,{id:"returns-2",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"void"})}),"\n",(0,s.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L3919",children:"packages/extension-api/src/extension-api.d.ts:3919"})})]})}function h(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},71670:(e,n,r)=>{r.d(n,{Z:()=>c,a:()=>d});var s=r(27378);const t={},i=s.createContext(t);function d(e){const n=s.useContext(i);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:d(e.components),s.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/5db8318c.69caefe3.js b/assets/js/5db8318c.5b84086f.js similarity index 96% rename from assets/js/5db8318c.69caefe3.js rename to assets/js/5db8318c.5b84086f.js index dad950fb573..4270b4399af 100644 --- a/assets/js/5db8318c.69caefe3.js +++ b/assets/js/5db8318c.5b84086f.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[58792],{45795:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>i,contentTitle:()=>a,default:()=>l,frontMatter:()=>r,metadata:()=>o,toc:()=>d});var t=s(24246),c=s(71670);const r={},a="Function: registerCommand()",o={id:"namespaces/commands/functions/registerCommand",title:"Function: registerCommand()",description:"registerCommand(command, callback, thisArg?): Disposable",source:"@site/api/namespaces/commands/functions/registerCommand.md",sourceDirName:"namespaces/commands/functions",slug:"/namespaces/commands/functions/registerCommand",permalink:"/api/namespaces/commands/functions/registerCommand",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Function: executeCommand()",permalink:"/api/namespaces/commands/functions/executeCommand"},next:{title:"Namespace: configuration",permalink:"/api/namespaces/configuration/"}},i={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Throws",id:"throws",level:2},{value:"Source",id:"source",level:2}];function m(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,c.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"function-registercommand",children:"Function: registerCommand()"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"registerCommand"}),"(",(0,t.jsx)(n.code,{children:"command"}),", ",(0,t.jsx)(n.code,{children:"callback"}),", ",(0,t.jsx)(n.code,{children:"thisArg"}),"?): ",(0,t.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,t.jsx)(n.code,{children:"Disposable"})})]}),"\n"]}),"\n",(0,t.jsxs)(n.p,{children:["Define a command, to be executed later, either by calling ",(0,t.jsx)(n.a,{href:"/api/namespaces/commands/functions/executeCommand",children:"commands.executeCommand"})," or by referencing its name in the ",(0,t.jsx)(n.code,{children:"command"})," field of a ",(0,t.jsx)(n.a,{href:"/api/interfaces/StatusBarItem",children:"StatusBarItem"}),"."]}),"\n",(0,t.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"command"}),": ",(0,t.jsx)(n.code,{children:"string"})]}),"\n",(0,t.jsx)(n.p,{children:"the name of the command. The name must be unique over all extensions. It is recommended to prefix this name with the name of the extension, to avoid conflicts with commands from other extensions."}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"callback"})]}),"\n",(0,t.jsx)(n.p,{children:"the command to execute"}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"thisArg?"}),": ",(0,t.jsx)(n.code,{children:"any"})]}),"\n",(0,t.jsxs)(n.p,{children:["The value of ",(0,t.jsx)(n.code,{children:"this"})," provided for the call to callback"]}),"\n",(0,t.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,t.jsx)(n.code,{children:"Disposable"})})}),"\n",(0,t.jsx)(n.p,{children:"A disposable that unregisters this command when being disposed"}),"\n",(0,t.jsx)(n.h2,{id:"throws",children:"Throws"}),"\n",(0,t.jsx)(n.p,{children:"if a command with the same name is already registered."}),"\n",(0,t.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L493",children:"packages/extension-api/src/extension-api.d.ts:493"})})]})}function l(e={}){const{wrapper:n}={...(0,c.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(m,{...e})}):m(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>o,a:()=>a});var t=s(27378);const c={},r=t.createContext(c);function a(e){const n=t.useContext(r);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(c):e.components||c:a(e.components),t.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[58792],{45795:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>i,contentTitle:()=>a,default:()=>l,frontMatter:()=>r,metadata:()=>o,toc:()=>d});var t=s(24246),c=s(71670);const r={},a="Function: registerCommand()",o={id:"namespaces/commands/functions/registerCommand",title:"Function: registerCommand()",description:"registerCommand(command, callback, thisArg?): Disposable",source:"@site/api/namespaces/commands/functions/registerCommand.md",sourceDirName:"namespaces/commands/functions",slug:"/namespaces/commands/functions/registerCommand",permalink:"/api/namespaces/commands/functions/registerCommand",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Function: executeCommand()",permalink:"/api/namespaces/commands/functions/executeCommand"},next:{title:"Namespace: configuration",permalink:"/api/namespaces/configuration/"}},i={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Throws",id:"throws",level:2},{value:"Source",id:"source",level:2}];function m(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,c.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"function-registercommand",children:"Function: registerCommand()"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"registerCommand"}),"(",(0,t.jsx)(n.code,{children:"command"}),", ",(0,t.jsx)(n.code,{children:"callback"}),", ",(0,t.jsx)(n.code,{children:"thisArg"}),"?): ",(0,t.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,t.jsx)(n.code,{children:"Disposable"})})]}),"\n"]}),"\n",(0,t.jsxs)(n.p,{children:["Define a command, to be executed later, either by calling ",(0,t.jsx)(n.a,{href:"/api/namespaces/commands/functions/executeCommand",children:"commands.executeCommand"})," or by referencing its name in the ",(0,t.jsx)(n.code,{children:"command"})," field of a ",(0,t.jsx)(n.a,{href:"/api/interfaces/StatusBarItem",children:"StatusBarItem"}),"."]}),"\n",(0,t.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"command"}),": ",(0,t.jsx)(n.code,{children:"string"})]}),"\n",(0,t.jsx)(n.p,{children:"the name of the command. The name must be unique over all extensions. It is recommended to prefix this name with the name of the extension, to avoid conflicts with commands from other extensions."}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"callback"})]}),"\n",(0,t.jsx)(n.p,{children:"the command to execute"}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"thisArg?"}),": ",(0,t.jsx)(n.code,{children:"any"})]}),"\n",(0,t.jsxs)(n.p,{children:["The value of ",(0,t.jsx)(n.code,{children:"this"})," provided for the call to callback"]}),"\n",(0,t.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,t.jsx)(n.code,{children:"Disposable"})})}),"\n",(0,t.jsx)(n.p,{children:"A disposable that unregisters this command when being disposed"}),"\n",(0,t.jsx)(n.h2,{id:"throws",children:"Throws"}),"\n",(0,t.jsx)(n.p,{children:"if a command with the same name is already registered."}),"\n",(0,t.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L493",children:"packages/extension-api/src/extension-api.d.ts:493"})})]})}function l(e={}){const{wrapper:n}={...(0,c.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(m,{...e})}):m(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>o,a:()=>a});var t=s(27378);const c={},r=t.createContext(c);function a(e){const n=t.useContext(r);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(c):e.components||c:a(e.components),t.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/5e30269e.b8232d0d.js b/assets/js/5e30269e.34c618e1.js similarity index 95% rename from assets/js/5e30269e.b8232d0d.js rename to assets/js/5e30269e.34c618e1.js index 8059a331a20..f04cbfed0ed 100644 --- a/assets/js/5e30269e.b8232d0d.js +++ b/assets/js/5e30269e.34c618e1.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[27135],{38743:(e,t,s)=>{s.r(t),s.d(t,{assets:()=>c,contentTitle:()=>o,default:()=>p,frontMatter:()=>i,metadata:()=>a,toc:()=>d});var n=s(24246),r=s(71670);const i={},o="Type alias: ProviderStatus",a={id:"type-aliases/ProviderStatus",title:"Type alias: ProviderStatus",description:'ProviderStatus: "not-installed" \\| "installed" \\| "configuring" \\| "configured" \\| "ready" \\| "started" \\| "stopped" \\| "starting" \\| "stopping" \\| "error" \\| "unknown"',source:"@site/api/type-aliases/ProviderStatus.md",sourceDirName:"type-aliases",slug:"/type-aliases/ProviderStatus",permalink:"/api/type-aliases/ProviderStatus",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Type alias: ProviderResult\\",permalink:"/api/type-aliases/ProviderResult"},next:{title:"Type alias: StatusBarAlignment",permalink:"/api/type-aliases/StatusBarAlignment"}},c={},d=[{value:"Source",id:"source",level:2}];function l(e){const t={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,r.a)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(t.h1,{id:"type-alias-providerstatus",children:"Type alias: ProviderStatus"}),"\n",(0,n.jsxs)(t.blockquote,{children:["\n",(0,n.jsxs)(t.p,{children:[(0,n.jsx)(t.strong,{children:"ProviderStatus"}),": ",(0,n.jsx)(t.code,{children:'"not-installed"'})," | ",(0,n.jsx)(t.code,{children:'"installed"'})," | ",(0,n.jsx)(t.code,{children:'"configuring"'})," | ",(0,n.jsx)(t.code,{children:'"configured"'})," | ",(0,n.jsx)(t.code,{children:'"ready"'})," | ",(0,n.jsx)(t.code,{children:'"started"'})," | ",(0,n.jsx)(t.code,{children:'"stopped"'})," | ",(0,n.jsx)(t.code,{children:'"starting"'})," | ",(0,n.jsx)(t.code,{children:'"stopping"'})," | ",(0,n.jsx)(t.code,{children:'"error"'})," | ",(0,n.jsx)(t.code,{children:'"unknown"'})]}),"\n"]}),"\n",(0,n.jsx)(t.h2,{id:"source",children:"Source"}),"\n",(0,n.jsx)(t.p,{children:(0,n.jsx)(t.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L183",children:"packages/extension-api/src/extension-api.d.ts:183"})})]})}function p(e={}){const{wrapper:t}={...(0,r.a)(),...e.components};return t?(0,n.jsx)(t,{...e,children:(0,n.jsx)(l,{...e})}):l(e)}},71670:(e,t,s)=>{s.d(t,{Z:()=>a,a:()=>o});var n=s(27378);const r={},i=n.createContext(r);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(r):e.components||r:o(e.components),n.createElement(i.Provider,{value:t},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[27135],{38743:(e,t,s)=>{s.r(t),s.d(t,{assets:()=>c,contentTitle:()=>o,default:()=>p,frontMatter:()=>i,metadata:()=>a,toc:()=>d});var n=s(24246),r=s(71670);const i={},o="Type alias: ProviderStatus",a={id:"type-aliases/ProviderStatus",title:"Type alias: ProviderStatus",description:'ProviderStatus: "not-installed" \\| "installed" \\| "configuring" \\| "configured" \\| "ready" \\| "started" \\| "stopped" \\| "starting" \\| "stopping" \\| "error" \\| "unknown"',source:"@site/api/type-aliases/ProviderStatus.md",sourceDirName:"type-aliases",slug:"/type-aliases/ProviderStatus",permalink:"/api/type-aliases/ProviderStatus",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Type alias: ProviderResult\\",permalink:"/api/type-aliases/ProviderResult"},next:{title:"Type alias: StatusBarAlignment",permalink:"/api/type-aliases/StatusBarAlignment"}},c={},d=[{value:"Source",id:"source",level:2}];function l(e){const t={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,r.a)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(t.h1,{id:"type-alias-providerstatus",children:"Type alias: ProviderStatus"}),"\n",(0,n.jsxs)(t.blockquote,{children:["\n",(0,n.jsxs)(t.p,{children:[(0,n.jsx)(t.strong,{children:"ProviderStatus"}),": ",(0,n.jsx)(t.code,{children:'"not-installed"'})," | ",(0,n.jsx)(t.code,{children:'"installed"'})," | ",(0,n.jsx)(t.code,{children:'"configuring"'})," | ",(0,n.jsx)(t.code,{children:'"configured"'})," | ",(0,n.jsx)(t.code,{children:'"ready"'})," | ",(0,n.jsx)(t.code,{children:'"started"'})," | ",(0,n.jsx)(t.code,{children:'"stopped"'})," | ",(0,n.jsx)(t.code,{children:'"starting"'})," | ",(0,n.jsx)(t.code,{children:'"stopping"'})," | ",(0,n.jsx)(t.code,{children:'"error"'})," | ",(0,n.jsx)(t.code,{children:'"unknown"'})]}),"\n"]}),"\n",(0,n.jsx)(t.h2,{id:"source",children:"Source"}),"\n",(0,n.jsx)(t.p,{children:(0,n.jsx)(t.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L183",children:"packages/extension-api/src/extension-api.d.ts:183"})})]})}function p(e={}){const{wrapper:t}={...(0,r.a)(),...e.components};return t?(0,n.jsx)(t,{...e,children:(0,n.jsx)(l,{...e})}):l(e)}},71670:(e,t,s)=>{s.d(t,{Z:()=>a,a:()=>o});var n=s(27378);const r={},i=n.createContext(r);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(r):e.components||r:o(e.components),n.createElement(i.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/5e486140.e0dda424.js b/assets/js/5e486140.8fe86923.js similarity index 95% rename from assets/js/5e486140.e0dda424.js rename to assets/js/5e486140.8fe86923.js index c91c35665d8..0d24dce9211 100644 --- a/assets/js/5e486140.e0dda424.js +++ b/assets/js/5e486140.8fe86923.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[26557],{12922:(n,e,s)=>{s.r(e),s.d(e,{assets:()=>a,contentTitle:()=>c,default:()=>u,frontMatter:()=>i,metadata:()=>r,toc:()=>d});var t=s(24246),o=s(71670);const i={},c="Function: listPods()",r={id:"namespaces/containerEngine/functions/listPods",title:"Function: listPods()",description:"listPods(): Promise\\",source:"@site/api/namespaces/containerEngine/functions/listPods.md",sourceDirName:"namespaces/containerEngine/functions",slug:"/namespaces/containerEngine/functions/listPods",permalink:"/api/namespaces/containerEngine/functions/listPods",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Function: listNetworks()",permalink:"/api/namespaces/containerEngine/functions/listNetworks"},next:{title:"Function: listVolumes()",permalink:"/api/namespaces/containerEngine/functions/listVolumes"}},a={},d=[{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function l(n){const e={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,o.a)(),...n.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(e.h1,{id:"function-listpods",children:"Function: listPods()"}),"\n",(0,t.jsxs)(e.blockquote,{children:["\n",(0,t.jsxs)(e.p,{children:[(0,t.jsx)(e.strong,{children:"listPods"}),"(): ",(0,t.jsx)(e.code,{children:"Promise"}),"< ",(0,t.jsx)(e.a,{href:"/api/interfaces/PodInfo",children:(0,t.jsx)(e.code,{children:"PodInfo"})}),"[] >"]}),"\n"]}),"\n",(0,t.jsx)(e.h2,{id:"returns",children:"Returns"}),"\n",(0,t.jsxs)(e.p,{children:[(0,t.jsx)(e.code,{children:"Promise"}),"< ",(0,t.jsx)(e.a,{href:"/api/interfaces/PodInfo",children:(0,t.jsx)(e.code,{children:"PodInfo"})}),"[] >"]}),"\n",(0,t.jsx)(e.h2,{id:"source",children:"Source"}),"\n",(0,t.jsx)(e.p,{children:(0,t.jsx)(e.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L3381",children:"packages/extension-api/src/extension-api.d.ts:3381"})})]})}function u(n={}){const{wrapper:e}={...(0,o.a)(),...n.components};return e?(0,t.jsx)(e,{...n,children:(0,t.jsx)(l,{...n})}):l(n)}},71670:(n,e,s)=>{s.d(e,{Z:()=>r,a:()=>c});var t=s(27378);const o={},i=t.createContext(o);function c(n){const e=t.useContext(i);return t.useMemo((function(){return"function"==typeof n?n(e):{...e,...n}}),[e,n])}function r(n){let e;return e=n.disableParentContext?"function"==typeof n.components?n.components(o):n.components||o:c(n.components),t.createElement(i.Provider,{value:e},n.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[26557],{12922:(n,e,s)=>{s.r(e),s.d(e,{assets:()=>a,contentTitle:()=>c,default:()=>u,frontMatter:()=>i,metadata:()=>r,toc:()=>d});var t=s(24246),o=s(71670);const i={},c="Function: listPods()",r={id:"namespaces/containerEngine/functions/listPods",title:"Function: listPods()",description:"listPods(): Promise\\",source:"@site/api/namespaces/containerEngine/functions/listPods.md",sourceDirName:"namespaces/containerEngine/functions",slug:"/namespaces/containerEngine/functions/listPods",permalink:"/api/namespaces/containerEngine/functions/listPods",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Function: listNetworks()",permalink:"/api/namespaces/containerEngine/functions/listNetworks"},next:{title:"Function: listVolumes()",permalink:"/api/namespaces/containerEngine/functions/listVolumes"}},a={},d=[{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function l(n){const e={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,o.a)(),...n.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(e.h1,{id:"function-listpods",children:"Function: listPods()"}),"\n",(0,t.jsxs)(e.blockquote,{children:["\n",(0,t.jsxs)(e.p,{children:[(0,t.jsx)(e.strong,{children:"listPods"}),"(): ",(0,t.jsx)(e.code,{children:"Promise"}),"< ",(0,t.jsx)(e.a,{href:"/api/interfaces/PodInfo",children:(0,t.jsx)(e.code,{children:"PodInfo"})}),"[] >"]}),"\n"]}),"\n",(0,t.jsx)(e.h2,{id:"returns",children:"Returns"}),"\n",(0,t.jsxs)(e.p,{children:[(0,t.jsx)(e.code,{children:"Promise"}),"< ",(0,t.jsx)(e.a,{href:"/api/interfaces/PodInfo",children:(0,t.jsx)(e.code,{children:"PodInfo"})}),"[] >"]}),"\n",(0,t.jsx)(e.h2,{id:"source",children:"Source"}),"\n",(0,t.jsx)(e.p,{children:(0,t.jsx)(e.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L3381",children:"packages/extension-api/src/extension-api.d.ts:3381"})})]})}function u(n={}){const{wrapper:e}={...(0,o.a)(),...n.components};return e?(0,t.jsx)(e,{...n,children:(0,t.jsx)(l,{...n})}):l(n)}},71670:(n,e,s)=>{s.d(e,{Z:()=>r,a:()=>c});var t=s(27378);const o={},i=t.createContext(o);function c(n){const e=t.useContext(i);return t.useMemo((function(){return"function"==typeof n?n(e):{...e,...n}}),[e,n])}function r(n){let e;return e=n.disableParentContext?"function"==typeof n.components?n.components(o):n.components||o:c(n.components),t.createElement(i.Provider,{value:e},n.children)}}}]); \ No newline at end of file diff --git a/assets/js/5e8fbcdf.521014a7.js b/assets/js/5e8fbcdf.8d05d07e.js similarity index 85% rename from assets/js/5e8fbcdf.521014a7.js rename to assets/js/5e8fbcdf.8d05d07e.js index bc7facdc69d..16f58820536 100644 --- a/assets/js/5e8fbcdf.521014a7.js +++ b/assets/js/5e8fbcdf.8d05d07e.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[5417],{28992:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>l,contentTitle:()=>o,default:()=>h,frontMatter:()=>r,metadata:()=>t,toc:()=>d});var i=s(24246),c=s(71670);const r={},o="Interface: BuildImageOptions",t={id:"interfaces/BuildImageOptions",title:"Interface: BuildImageOptions",description:"Properties",source:"@site/api/interfaces/BuildImageOptions.md",sourceDirName:"interfaces",slug:"/interfaces/BuildImageOptions",permalink:"/api/interfaces/BuildImageOptions",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: BlkioStats",permalink:"/api/interfaces/BlkioStats"},next:{title:"Interface: CPUStats",permalink:"/api/interfaces/CPUStats"}},l={},d=[{value:"Properties",id:"properties",level:2},{value:"abortController?",id:"abortcontroller",level:3},{value:"Source",id:"source",level:4},{value:"buildargs?",id:"buildargs",level:3},{value:"Index signature",id:"index-signature",level:4},{value:"Source",id:"source-1",level:4},{value:"cachefrom?",id:"cachefrom",level:3},{value:"Source",id:"source-2",level:4},{value:"containerFile?",id:"containerfile",level:3},{value:"Source",id:"source-3",level:4},{value:"cpuperiod?",id:"cpuperiod",level:3},{value:"Source",id:"source-4",level:4},{value:"cpuquota?",id:"cpuquota",level:3},{value:"Source",id:"source-5",level:4},{value:"cpusetcpus?",id:"cpusetcpus",level:3},{value:"Source",id:"source-6",level:4},{value:"cpushares?",id:"cpushares",level:3},{value:"Source",id:"source-7",level:4},{value:"extrahosts?",id:"extrahosts",level:3},{value:"Source",id:"source-8",level:4},{value:"forcerm?",id:"forcerm",level:3},{value:"Source",id:"source-9",level:4},{value:"labels?",id:"labels",level:3},{value:"Index signature",id:"index-signature-1",level:4},{value:"Source",id:"source-10",level:4},{value:"memory?",id:"memory",level:3},{value:"Source",id:"source-11",level:4},{value:"memswap?",id:"memswap",level:3},{value:"Source",id:"source-12",level:4},{value:"networkmode?",id:"networkmode",level:3},{value:"Source",id:"source-13",level:4},{value:"nocache?",id:"nocache",level:3},{value:"Source",id:"source-14",level:4},{value:"outputs?",id:"outputs",level:3},{value:"Source",id:"source-15",level:4},{value:"platform?",id:"platform",level:3},{value:"Source",id:"source-16",level:4},{value:"provider?",id:"provider",level:3},{value:"Source",id:"source-17",level:4},{value:"pull?",id:"pull",level:3},{value:"Source",id:"source-18",level:4},{value:"q?",id:"q",level:3},{value:"Source",id:"source-19",level:4},{value:"remote?",id:"remote",level:3},{value:"Source",id:"source-20",level:4},{value:"rm?",id:"rm",level:3},{value:"Source",id:"source-21",level:4},{value:"shmsize?",id:"shmsize",level:3},{value:"Source",id:"source-22",level:4},{value:"squash?",id:"squash",level:3},{value:"Source",id:"source-23",level:4},{value:"tag?",id:"tag",level:3},{value:"Source",id:"source-24",level:4},{value:"target?",id:"target",level:3},{value:"Source",id:"source-25",level:4}];function a(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,c.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"interface-buildimageoptions",children:"Interface: BuildImageOptions"}),"\n",(0,i.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(n.h3,{id:"abortcontroller",children:"abortController?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"abortController"}),": ",(0,i.jsx)(n.code,{children:"AbortController"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"The abort controller for running the build image operation"}),"\n",(0,i.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2906",children:"packages/extension-api/src/extension-api.d.ts:2906"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"buildargs",children:"buildargs?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"buildargs"}),": ",(0,i.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["JSON map of string pairs for build-time variables. Users pass these values at build-time. Docker uses the\nbuildargs as the environment context for commands run via the ",(0,i.jsx)(n.code,{children:"Dockerfile"})," RUN instruction, or for variable\nexpansion in other ",(0,i.jsx)(n.code,{children:"Dockerfilev"})," instructions. This is not meant for passing secret values.\nFor example, the build arg ",(0,i.jsx)(n.code,{children:"FOO=bar"})," would become ",(0,i.jsx)(n.code,{children:'{"FOO":"bar"}'})," in JSON. This would result in the query\nparameter ",(0,i.jsx)(n.code,{children:'buildargs={"FOO":"bar"}'}),". Note that ",(0,i.jsx)(n.code,{children:'{"FOO":"bar"}'})," should be URI component encoded."]}),"\n",(0,i.jsx)(n.h4,{id:"index-signature",children:"Index signature"}),"\n",(0,i.jsxs)(n.p,{children:["[",(0,i.jsx)(n.code,{children:"key"}),": ",(0,i.jsx)(n.code,{children:"string"}),"]: ",(0,i.jsx)(n.code,{children:"string"})]}),"\n",(0,i.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2990",children:"packages/extension-api/src/extension-api.d.ts:2990"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"cachefrom",children:"cachefrom?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"cachefrom"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"JSON array of images used for build cache resolution."}),"\n",(0,i.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2932",children:"packages/extension-api/src/extension-api.d.ts:2932"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"containerfile",children:"containerFile?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"containerFile"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Specifies a Containerfile which contains instructions for building the image"}),"\n",(0,i.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2886",children:"packages/extension-api/src/extension-api.d.ts:2886"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"cpuperiod",children:"cpuperiod?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"cpuperiod"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"The length of a CPU period in microseconds."}),"\n",(0,i.jsx)(n.h4,{id:"source-4",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2976",children:"packages/extension-api/src/extension-api.d.ts:2976"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"cpuquota",children:"cpuquota?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"cpuquota"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Microseconds of CPU time that the container can get in a CPU period."}),"\n",(0,i.jsx)(n.h4,{id:"source-5",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2981",children:"packages/extension-api/src/extension-api.d.ts:2981"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"cpusetcpus",children:"cpusetcpus?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"cpusetcpus"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"CPUs in which to allow execution (e.g., 0-3, 0,1)."}),"\n",(0,i.jsx)(n.h4,{id:"source-6",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2971",children:"packages/extension-api/src/extension-api.d.ts:2971"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"cpushares",children:"cpushares?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"cpushares"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"CPU shares (relative weight)."}),"\n",(0,i.jsx)(n.h4,{id:"source-7",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2966",children:"packages/extension-api/src/extension-api.d.ts:2966"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"extrahosts",children:"extrahosts?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"extrahosts"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Extra hosts to add to /etc/hosts"}),"\n",(0,i.jsx)(n.h4,{id:"source-8",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2911",children:"packages/extension-api/src/extension-api.d.ts:2911"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"forcerm",children:"forcerm?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"forcerm"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Default: false"}),"\n",(0,i.jsx)(n.p,{children:"Always remove intermediate containers, even upon failure."}),"\n",(0,i.jsx)(n.h4,{id:"source-9",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2951",children:"packages/extension-api/src/extension-api.d.ts:2951"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"labels",children:"labels?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"labels"}),": ",(0,i.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Arbitrary key/value labels to set on the image, as a JSON map of string pairs."}),"\n",(0,i.jsx)(n.h4,{id:"index-signature-1",children:"Index signature"}),"\n",(0,i.jsxs)(n.p,{children:["[",(0,i.jsx)(n.code,{children:"key"}),": ",(0,i.jsx)(n.code,{children:"string"}),"]: ",(0,i.jsx)(n.code,{children:"string"})]}),"\n",(0,i.jsx)(n.h4,{id:"source-10",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L3005",children:"packages/extension-api/src/extension-api.d.ts:3005"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"memory",children:"memory?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"memory"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Set memory limit for build."}),"\n",(0,i.jsx)(n.h4,{id:"source-11",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2956",children:"packages/extension-api/src/extension-api.d.ts:2956"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"memswap",children:"memswap?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"memswap"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Total memory (memory + swap). Set as -1 to disable swap."}),"\n",(0,i.jsx)(n.h4,{id:"source-12",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2961",children:"packages/extension-api/src/extension-api.d.ts:2961"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"networkmode",children:"networkmode?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"networkmode"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Sets the networking mode for the run commands during build. Supported standard values are: ",(0,i.jsx)(n.code,{children:"bridge"}),",\n",(0,i.jsx)(n.code,{children:"host"}),", ",(0,i.jsx)(n.code,{children:"none"}),", and ",(0,i.jsx)(n.code,{children:"container:"}),". Any other value is taken as a custom network's name or ID\nto which this container should connect to."]}),"\n",(0,i.jsx)(n.h4,{id:"source-13",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L3012",children:"packages/extension-api/src/extension-api.d.ts:3012"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"nocache",children:"nocache?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"nocache"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Default: false"}),"\n",(0,i.jsx)(n.p,{children:"Do not use the cache when building the image."}),"\n",(0,i.jsx)(n.h4,{id:"source-14",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L3033",children:"packages/extension-api/src/extension-api.d.ts:3033"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"outputs",children:"outputs?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"outputs"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:'Default: ""'}),"\n",(0,i.jsx)(n.p,{children:"BuildKit output configuration"}),"\n",(0,i.jsx)(n.h4,{id:"source-15",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L3026",children:"packages/extension-api/src/extension-api.d.ts:3026"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"platform",children:"platform?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"platform"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Set the os/arch of the built image (and its base image, when using one) to the provided value instead of using the current operating system and architecture of the host"}),"\n",(0,i.jsx)(n.h4,{id:"source-16",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2896",children:"packages/extension-api/src/extension-api.d.ts:2896"})}),"\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.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"provider"}),": ",(0,i.jsx)(n.a,{href:"/api/interfaces/ContainerProviderConnection",children:(0,i.jsx)(n.code,{children:"ContainerProviderConnection"})})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Set the provider to use, if not we will try select the first one available (sorted in favor of Podman)"}),"\n",(0,i.jsx)(n.h4,{id:"source-17",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2901",children:"packages/extension-api/src/extension-api.d.ts:2901"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"pull",children:"pull?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"pull"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Attempt to pull the image even if an older image exists locally."}),"\n",(0,i.jsx)(n.h4,{id:"source-18",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2937",children:"packages/extension-api/src/extension-api.d.ts:2937"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"q",children:"q?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"q"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Default: false"}),"\n",(0,i.jsx)(n.p,{children:"Suppress verbose build output."}),"\n",(0,i.jsx)(n.h4,{id:"source-19",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2927",children:"packages/extension-api/src/extension-api.d.ts:2927"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"remote",children:"remote?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"remote"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"A Git repository URI or HTTP/HTTPS context URI. If the URI points to a single text file, the file\u2019s contents are\nplaced into a file called Dockerfile and the image is built from that file. If the URI points to a tarball, the\nfile is downloaded by the daemon and the contents therein used as the context for the build. If the URI points\nto a tarball and the dockerfile parameter is also specified, there must be a file with the corresponding path\ninside the tarball."}),"\n",(0,i.jsx)(n.h4,{id:"source-20",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2920",children:"packages/extension-api/src/extension-api.d.ts:2920"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"rm",children:"rm?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"rm"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Default: true"}),"\n",(0,i.jsx)(n.p,{children:"Remove intermediate containers after a successful build."}),"\n",(0,i.jsx)(n.h4,{id:"source-21",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2944",children:"packages/extension-api/src/extension-api.d.ts:2944"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"shmsize",children:"shmsize?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"shmsize"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Size of ",(0,i.jsx)(n.code,{children:"/dev/shm"})," in bytes. The size must be greater than 0. If omitted the system uses 64MB."]}),"\n",(0,i.jsx)(n.h4,{id:"source-22",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2995",children:"packages/extension-api/src/extension-api.d.ts:2995"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"squash",children:"squash?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"squash"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Squash the resulting images layers into a single layer."}),"\n",(0,i.jsx)(n.h4,{id:"source-23",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L3000",children:"packages/extension-api/src/extension-api.d.ts:3000"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"tag",children:"tag?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"tag"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Specifies the name which is assigned to the resulting image if the build process completes successfully"}),"\n",(0,i.jsx)(n.h4,{id:"source-24",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2891",children:"packages/extension-api/src/extension-api.d.ts:2891"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"target",children:"target?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"target"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:'Default: ""'}),"\n",(0,i.jsx)(n.p,{children:"Target build stage"}),"\n",(0,i.jsx)(n.h4,{id:"source-25",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L3019",children:"packages/extension-api/src/extension-api.d.ts:3019"})})]})}function h(e={}){const{wrapper:n}={...(0,c.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(a,{...e})}):a(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>t,a:()=>o});var i=s(27378);const c={},r=i.createContext(c);function o(e){const n=i.useContext(r);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function t(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(c):e.components||c:o(e.components),i.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[5417],{28992:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>t,contentTitle:()=>o,default:()=>h,frontMatter:()=>c,metadata:()=>d,toc:()=>l});var i=s(24246),r=s(71670);const c={},o="Interface: BuildImageOptions",d={id:"interfaces/BuildImageOptions",title:"Interface: BuildImageOptions",description:"Properties",source:"@site/api/interfaces/BuildImageOptions.md",sourceDirName:"interfaces",slug:"/interfaces/BuildImageOptions",permalink:"/api/interfaces/BuildImageOptions",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: BlkioStats",permalink:"/api/interfaces/BlkioStats"},next:{title:"Interface: CPUStats",permalink:"/api/interfaces/CPUStats"}},t={},l=[{value:"Properties",id:"properties",level:2},{value:"abortController?",id:"abortcontroller",level:3},{value:"Source",id:"source",level:4},{value:"buildargs?",id:"buildargs",level:3},{value:"Index signature",id:"index-signature",level:4},{value:"Source",id:"source-1",level:4},{value:"cachefrom?",id:"cachefrom",level:3},{value:"Source",id:"source-2",level:4},{value:"containerFile?",id:"containerfile",level:3},{value:"Source",id:"source-3",level:4},{value:"cpuperiod?",id:"cpuperiod",level:3},{value:"Source",id:"source-4",level:4},{value:"cpuquota?",id:"cpuquota",level:3},{value:"Source",id:"source-5",level:4},{value:"cpusetcpus?",id:"cpusetcpus",level:3},{value:"Source",id:"source-6",level:4},{value:"cpushares?",id:"cpushares",level:3},{value:"Source",id:"source-7",level:4},{value:"extrahosts?",id:"extrahosts",level:3},{value:"Source",id:"source-8",level:4},{value:"forcerm?",id:"forcerm",level:3},{value:"Source",id:"source-9",level:4},{value:"labels?",id:"labels",level:3},{value:"Index signature",id:"index-signature-1",level:4},{value:"Source",id:"source-10",level:4},{value:"memory?",id:"memory",level:3},{value:"Source",id:"source-11",level:4},{value:"memswap?",id:"memswap",level:3},{value:"Source",id:"source-12",level:4},{value:"networkmode?",id:"networkmode",level:3},{value:"Source",id:"source-13",level:4},{value:"nocache?",id:"nocache",level:3},{value:"Source",id:"source-14",level:4},{value:"outputs?",id:"outputs",level:3},{value:"Source",id:"source-15",level:4},{value:"platform?",id:"platform",level:3},{value:"Source",id:"source-16",level:4},{value:"provider?",id:"provider",level:3},{value:"Source",id:"source-17",level:4},{value:"pull?",id:"pull",level:3},{value:"Source",id:"source-18",level:4},{value:"q?",id:"q",level:3},{value:"Source",id:"source-19",level:4},{value:"remote?",id:"remote",level:3},{value:"Source",id:"source-20",level:4},{value:"rm?",id:"rm",level:3},{value:"Source",id:"source-21",level:4},{value:"shmsize?",id:"shmsize",level:3},{value:"Source",id:"source-22",level:4},{value:"squash?",id:"squash",level:3},{value:"Source",id:"source-23",level:4},{value:"tag?",id:"tag",level:3},{value:"Source",id:"source-24",level:4},{value:"target?",id:"target",level:3},{value:"Source",id:"source-25",level:4}];function a(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,r.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"interface-buildimageoptions",children:"Interface: BuildImageOptions"}),"\n",(0,i.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(n.h3,{id:"abortcontroller",children:"abortController?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"abortController"}),": ",(0,i.jsx)(n.code,{children:"AbortController"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"The abort controller for running the build image operation"}),"\n",(0,i.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2906",children:"packages/extension-api/src/extension-api.d.ts:2906"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"buildargs",children:"buildargs?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"buildargs"}),": ",(0,i.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["JSON map of string pairs for build-time variables. Users pass these values at build-time. Docker uses the\nbuildargs as the environment context for commands run via the ",(0,i.jsx)(n.code,{children:"Dockerfile"})," RUN instruction, or for variable\nexpansion in other ",(0,i.jsx)(n.code,{children:"Dockerfilev"})," instructions. This is not meant for passing secret values.\nFor example, the build arg ",(0,i.jsx)(n.code,{children:"FOO=bar"})," would become ",(0,i.jsx)(n.code,{children:'{"FOO":"bar"}'})," in JSON. This would result in the query\nparameter ",(0,i.jsx)(n.code,{children:'buildargs={"FOO":"bar"}'}),". Note that ",(0,i.jsx)(n.code,{children:'{"FOO":"bar"}'})," should be URI component encoded."]}),"\n",(0,i.jsx)(n.h4,{id:"index-signature",children:"Index signature"}),"\n",(0,i.jsxs)(n.p,{children:["[",(0,i.jsx)(n.code,{children:"key"}),": ",(0,i.jsx)(n.code,{children:"string"}),"]: ",(0,i.jsx)(n.code,{children:"string"})]}),"\n",(0,i.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2990",children:"packages/extension-api/src/extension-api.d.ts:2990"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"cachefrom",children:"cachefrom?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"cachefrom"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"JSON array of images used for build cache resolution."}),"\n",(0,i.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2932",children:"packages/extension-api/src/extension-api.d.ts:2932"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"containerfile",children:"containerFile?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"containerFile"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Specifies a Containerfile which contains instructions for building the image"}),"\n",(0,i.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2886",children:"packages/extension-api/src/extension-api.d.ts:2886"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"cpuperiod",children:"cpuperiod?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"cpuperiod"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"The length of a CPU period in microseconds."}),"\n",(0,i.jsx)(n.h4,{id:"source-4",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2976",children:"packages/extension-api/src/extension-api.d.ts:2976"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"cpuquota",children:"cpuquota?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"cpuquota"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Microseconds of CPU time that the container can get in a CPU period."}),"\n",(0,i.jsx)(n.h4,{id:"source-5",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2981",children:"packages/extension-api/src/extension-api.d.ts:2981"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"cpusetcpus",children:"cpusetcpus?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"cpusetcpus"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"CPUs in which to allow execution (e.g., 0-3, 0,1)."}),"\n",(0,i.jsx)(n.h4,{id:"source-6",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2971",children:"packages/extension-api/src/extension-api.d.ts:2971"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"cpushares",children:"cpushares?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"cpushares"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"CPU shares (relative weight)."}),"\n",(0,i.jsx)(n.h4,{id:"source-7",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2966",children:"packages/extension-api/src/extension-api.d.ts:2966"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"extrahosts",children:"extrahosts?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"extrahosts"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Extra hosts to add to /etc/hosts"}),"\n",(0,i.jsx)(n.h4,{id:"source-8",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2911",children:"packages/extension-api/src/extension-api.d.ts:2911"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"forcerm",children:"forcerm?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"forcerm"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Default: false"}),"\n",(0,i.jsx)(n.p,{children:"Always remove intermediate containers, even upon failure."}),"\n",(0,i.jsx)(n.h4,{id:"source-9",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2951",children:"packages/extension-api/src/extension-api.d.ts:2951"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"labels",children:"labels?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"labels"}),": ",(0,i.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Arbitrary key/value labels to set on the image, as a JSON map of string pairs."}),"\n",(0,i.jsx)(n.h4,{id:"index-signature-1",children:"Index signature"}),"\n",(0,i.jsxs)(n.p,{children:["[",(0,i.jsx)(n.code,{children:"key"}),": ",(0,i.jsx)(n.code,{children:"string"}),"]: ",(0,i.jsx)(n.code,{children:"string"})]}),"\n",(0,i.jsx)(n.h4,{id:"source-10",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L3005",children:"packages/extension-api/src/extension-api.d.ts:3005"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"memory",children:"memory?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"memory"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Set memory limit for build."}),"\n",(0,i.jsx)(n.h4,{id:"source-11",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2956",children:"packages/extension-api/src/extension-api.d.ts:2956"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"memswap",children:"memswap?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"memswap"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Total memory (memory + swap). Set as -1 to disable swap."}),"\n",(0,i.jsx)(n.h4,{id:"source-12",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2961",children:"packages/extension-api/src/extension-api.d.ts:2961"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"networkmode",children:"networkmode?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"networkmode"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Sets the networking mode for the run commands during build. Supported standard values are: ",(0,i.jsx)(n.code,{children:"bridge"}),",\n",(0,i.jsx)(n.code,{children:"host"}),", ",(0,i.jsx)(n.code,{children:"none"}),", and ",(0,i.jsx)(n.code,{children:"container:"}),". Any other value is taken as a custom network's name or ID\nto which this container should connect to."]}),"\n",(0,i.jsx)(n.h4,{id:"source-13",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L3012",children:"packages/extension-api/src/extension-api.d.ts:3012"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"nocache",children:"nocache?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"nocache"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Default: false"}),"\n",(0,i.jsx)(n.p,{children:"Do not use the cache when building the image."}),"\n",(0,i.jsx)(n.h4,{id:"source-14",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L3033",children:"packages/extension-api/src/extension-api.d.ts:3033"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"outputs",children:"outputs?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"outputs"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:'Default: ""'}),"\n",(0,i.jsx)(n.p,{children:"BuildKit output configuration"}),"\n",(0,i.jsx)(n.h4,{id:"source-15",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L3026",children:"packages/extension-api/src/extension-api.d.ts:3026"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"platform",children:"platform?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"platform"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Set the os/arch of the built image (and its base image, when using one) to the provided value instead of using the current operating system and architecture of the host"}),"\n",(0,i.jsx)(n.h4,{id:"source-16",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2896",children:"packages/extension-api/src/extension-api.d.ts:2896"})}),"\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.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"provider"}),": ",(0,i.jsx)(n.a,{href:"/api/interfaces/ContainerProviderConnection",children:(0,i.jsx)(n.code,{children:"ContainerProviderConnection"})})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Set the provider to use, if not we will try select the first one available (sorted in favor of Podman)"}),"\n",(0,i.jsx)(n.h4,{id:"source-17",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2901",children:"packages/extension-api/src/extension-api.d.ts:2901"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"pull",children:"pull?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"pull"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Attempt to pull the image even if an older image exists locally."}),"\n",(0,i.jsx)(n.h4,{id:"source-18",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2937",children:"packages/extension-api/src/extension-api.d.ts:2937"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"q",children:"q?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"q"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Default: false"}),"\n",(0,i.jsx)(n.p,{children:"Suppress verbose build output."}),"\n",(0,i.jsx)(n.h4,{id:"source-19",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2927",children:"packages/extension-api/src/extension-api.d.ts:2927"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"remote",children:"remote?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"remote"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"A Git repository URI or HTTP/HTTPS context URI. If the URI points to a single text file, the file\u2019s contents are\nplaced into a file called Dockerfile and the image is built from that file. If the URI points to a tarball, the\nfile is downloaded by the daemon and the contents therein used as the context for the build. If the URI points\nto a tarball and the dockerfile parameter is also specified, there must be a file with the corresponding path\ninside the tarball."}),"\n",(0,i.jsx)(n.h4,{id:"source-20",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2920",children:"packages/extension-api/src/extension-api.d.ts:2920"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"rm",children:"rm?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"rm"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Default: true"}),"\n",(0,i.jsx)(n.p,{children:"Remove intermediate containers after a successful build."}),"\n",(0,i.jsx)(n.h4,{id:"source-21",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2944",children:"packages/extension-api/src/extension-api.d.ts:2944"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"shmsize",children:"shmsize?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"shmsize"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Size of ",(0,i.jsx)(n.code,{children:"/dev/shm"})," in bytes. The size must be greater than 0. If omitted the system uses 64MB."]}),"\n",(0,i.jsx)(n.h4,{id:"source-22",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2995",children:"packages/extension-api/src/extension-api.d.ts:2995"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"squash",children:"squash?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"squash"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Squash the resulting images layers into a single layer."}),"\n",(0,i.jsx)(n.h4,{id:"source-23",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L3000",children:"packages/extension-api/src/extension-api.d.ts:3000"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"tag",children:"tag?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"tag"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Specifies the name which is assigned to the resulting image if the build process completes successfully"}),"\n",(0,i.jsx)(n.h4,{id:"source-24",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2891",children:"packages/extension-api/src/extension-api.d.ts:2891"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"target",children:"target?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"target"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:'Default: ""'}),"\n",(0,i.jsx)(n.p,{children:"Target build stage"}),"\n",(0,i.jsx)(n.h4,{id:"source-25",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L3019",children:"packages/extension-api/src/extension-api.d.ts:3019"})})]})}function h(e={}){const{wrapper:n}={...(0,r.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(a,{...e})}):a(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>d,a:()=>o});var i=s(27378);const r={},c=i.createContext(r);function o(e){const n=i.useContext(c);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function d(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:o(e.components),i.createElement(c.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/604e05e4.7681f7c1.js b/assets/js/604e05e4.01d5de6a.js similarity index 80% rename from assets/js/604e05e4.7681f7c1.js rename to assets/js/604e05e4.01d5de6a.js index 7cb6ddf5447..13a3d214390 100644 --- a/assets/js/604e05e4.7681f7c1.js +++ b/assets/js/604e05e4.01d5de6a.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[62871],{28105:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>d,contentTitle:()=>o,default:()=>h,frontMatter:()=>r,metadata:()=>t,toc:()=>a});var i=s(24246),c=s(71670);const r={},o="Interface: NetworkInfo",t={id:"interfaces/NetworkInfo",title:"Interface: NetworkInfo",description:"Properties",source:"@site/api/interfaces/NetworkInfo.md",sourceDirName:"interfaces",slug:"/interfaces/NetworkInfo",permalink:"/api/interfaces/NetworkInfo",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: NetworkCreateResult",permalink:"/api/interfaces/NetworkCreateResult"},next:{title:"Interface: NetworkInspectInfo",permalink:"/api/interfaces/NetworkInspectInfo"}},d={},a=[{value:"Properties",id:"properties",level:2},{value:"Aliases?",id:"aliases",level:3},{value:"Source",id:"source",level:4},{value:"EndpointID",id:"endpointid",level:3},{value:"Source",id:"source-1",level:4},{value:"Gateway",id:"gateway",level:3},{value:"Source",id:"source-2",level:4},{value:"GlobalIPv6Address",id:"globalipv6address",level:3},{value:"Source",id:"source-3",level:4},{value:"GlobalIPv6PrefixLen",id:"globalipv6prefixlen",level:3},{value:"Source",id:"source-4",level:4},{value:"IPAMConfig?",id:"ipamconfig",level:3},{value:"Source",id:"source-5",level:4},{value:"IPAddress",id:"ipaddress",level:3},{value:"Source",id:"source-6",level:4},{value:"IPPrefixLen",id:"ipprefixlen",level:3},{value:"Source",id:"source-7",level:4},{value:"IPv6Gateway",id:"ipv6gateway",level:3},{value:"Source",id:"source-8",level:4},{value:"Links?",id:"links",level:3},{value:"Source",id:"source-9",level:4},{value:"MacAddress",id:"macaddress",level:3},{value:"Source",id:"source-10",level:4},{value:"NetworkID",id:"networkid",level:3},{value:"Source",id:"source-11",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,c.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"interface-networkinfo",children:"Interface: NetworkInfo"}),"\n",(0,i.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(n.h3,{id:"aliases",children:"Aliases?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"Aliases"}),": ",(0,i.jsx)(n.code,{children:"unknown"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2026",children:"packages/extension-api/src/extension-api.d.ts:2026"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"endpointid",children:"EndpointID"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"EndpointID"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2028",children:"packages/extension-api/src/extension-api.d.ts:2028"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"gateway",children:"Gateway"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Gateway"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2029",children:"packages/extension-api/src/extension-api.d.ts:2029"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"globalipv6address",children:"GlobalIPv6Address"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"GlobalIPv6Address"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2033",children:"packages/extension-api/src/extension-api.d.ts:2033"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"globalipv6prefixlen",children:"GlobalIPv6PrefixLen"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"GlobalIPv6PrefixLen"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-4",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2034",children:"packages/extension-api/src/extension-api.d.ts:2034"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"ipamconfig",children:"IPAMConfig?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"IPAMConfig"}),": ",(0,i.jsx)(n.code,{children:"unknown"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-5",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2024",children:"packages/extension-api/src/extension-api.d.ts:2024"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"ipaddress",children:"IPAddress"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"IPAddress"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-6",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2030",children:"packages/extension-api/src/extension-api.d.ts:2030"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"ipprefixlen",children:"IPPrefixLen"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"IPPrefixLen"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-7",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2031",children:"packages/extension-api/src/extension-api.d.ts:2031"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"ipv6gateway",children:"IPv6Gateway"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"IPv6Gateway"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-8",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2032",children:"packages/extension-api/src/extension-api.d.ts:2032"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"links",children:"Links?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"Links"}),": ",(0,i.jsx)(n.code,{children:"unknown"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-9",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2025",children:"packages/extension-api/src/extension-api.d.ts:2025"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"macaddress",children:"MacAddress"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"MacAddress"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-10",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2035",children:"packages/extension-api/src/extension-api.d.ts:2035"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"networkid",children:"NetworkID"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"NetworkID"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-11",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2027",children:"packages/extension-api/src/extension-api.d.ts:2027"})})]})}function h(e={}){const{wrapper:n}={...(0,c.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>t,a:()=>o});var i=s(27378);const c={},r=i.createContext(c);function o(e){const n=i.useContext(r);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function t(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(c):e.components||c:o(e.components),i.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[62871],{28105:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>t,contentTitle:()=>o,default:()=>h,frontMatter:()=>c,metadata:()=>d,toc:()=>a});var i=s(24246),r=s(71670);const c={},o="Interface: NetworkInfo",d={id:"interfaces/NetworkInfo",title:"Interface: NetworkInfo",description:"Properties",source:"@site/api/interfaces/NetworkInfo.md",sourceDirName:"interfaces",slug:"/interfaces/NetworkInfo",permalink:"/api/interfaces/NetworkInfo",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: NetworkCreateResult",permalink:"/api/interfaces/NetworkCreateResult"},next:{title:"Interface: NetworkInspectInfo",permalink:"/api/interfaces/NetworkInspectInfo"}},t={},a=[{value:"Properties",id:"properties",level:2},{value:"Aliases?",id:"aliases",level:3},{value:"Source",id:"source",level:4},{value:"EndpointID",id:"endpointid",level:3},{value:"Source",id:"source-1",level:4},{value:"Gateway",id:"gateway",level:3},{value:"Source",id:"source-2",level:4},{value:"GlobalIPv6Address",id:"globalipv6address",level:3},{value:"Source",id:"source-3",level:4},{value:"GlobalIPv6PrefixLen",id:"globalipv6prefixlen",level:3},{value:"Source",id:"source-4",level:4},{value:"IPAMConfig?",id:"ipamconfig",level:3},{value:"Source",id:"source-5",level:4},{value:"IPAddress",id:"ipaddress",level:3},{value:"Source",id:"source-6",level:4},{value:"IPPrefixLen",id:"ipprefixlen",level:3},{value:"Source",id:"source-7",level:4},{value:"IPv6Gateway",id:"ipv6gateway",level:3},{value:"Source",id:"source-8",level:4},{value:"Links?",id:"links",level:3},{value:"Source",id:"source-9",level:4},{value:"MacAddress",id:"macaddress",level:3},{value:"Source",id:"source-10",level:4},{value:"NetworkID",id:"networkid",level:3},{value:"Source",id:"source-11",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,r.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"interface-networkinfo",children:"Interface: NetworkInfo"}),"\n",(0,i.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(n.h3,{id:"aliases",children:"Aliases?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"Aliases"}),": ",(0,i.jsx)(n.code,{children:"unknown"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2026",children:"packages/extension-api/src/extension-api.d.ts:2026"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"endpointid",children:"EndpointID"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"EndpointID"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2028",children:"packages/extension-api/src/extension-api.d.ts:2028"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"gateway",children:"Gateway"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Gateway"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2029",children:"packages/extension-api/src/extension-api.d.ts:2029"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"globalipv6address",children:"GlobalIPv6Address"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"GlobalIPv6Address"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2033",children:"packages/extension-api/src/extension-api.d.ts:2033"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"globalipv6prefixlen",children:"GlobalIPv6PrefixLen"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"GlobalIPv6PrefixLen"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-4",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2034",children:"packages/extension-api/src/extension-api.d.ts:2034"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"ipamconfig",children:"IPAMConfig?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"IPAMConfig"}),": ",(0,i.jsx)(n.code,{children:"unknown"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-5",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2024",children:"packages/extension-api/src/extension-api.d.ts:2024"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"ipaddress",children:"IPAddress"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"IPAddress"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-6",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2030",children:"packages/extension-api/src/extension-api.d.ts:2030"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"ipprefixlen",children:"IPPrefixLen"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"IPPrefixLen"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-7",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2031",children:"packages/extension-api/src/extension-api.d.ts:2031"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"ipv6gateway",children:"IPv6Gateway"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"IPv6Gateway"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-8",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2032",children:"packages/extension-api/src/extension-api.d.ts:2032"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"links",children:"Links?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"Links"}),": ",(0,i.jsx)(n.code,{children:"unknown"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-9",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2025",children:"packages/extension-api/src/extension-api.d.ts:2025"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"macaddress",children:"MacAddress"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"MacAddress"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-10",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2035",children:"packages/extension-api/src/extension-api.d.ts:2035"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"networkid",children:"NetworkID"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"NetworkID"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-11",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2027",children:"packages/extension-api/src/extension-api.d.ts:2027"})})]})}function h(e={}){const{wrapper:n}={...(0,r.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>d,a:()=>o});var i=s(27378);const r={},c=i.createContext(r);function o(e){const n=i.useContext(c);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function d(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:o(e.components),i.createElement(c.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/60c82955.a0d0937b.js b/assets/js/60c82955.c82ac906.js similarity index 87% rename from assets/js/60c82955.a0d0937b.js rename to assets/js/60c82955.c82ac906.js index a5069f9eb45..d891f1ebe44 100644 --- a/assets/js/60c82955.a0d0937b.js +++ b/assets/js/60c82955.c82ac906.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[48926],{80042:(e,s,n)=>{n.r(s),n.d(s,{assets:()=>l,contentTitle:()=>d,default:()=>h,frontMatter:()=>c,metadata:()=>o,toc:()=>t});var i=n(24246),r=n(71670);const c={},d="Interface: CliTool",o={id:"interfaces/CliTool",title:"Interface: CliTool",description:"Extends",source:"@site/api/interfaces/CliTool.md",sourceDirName:"interfaces",slug:"/interfaces/CliTool",permalink:"/api/interfaces/CliTool",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: CheckResultFixCommand",permalink:"/api/interfaces/CheckResultFixCommand"},next:{title:"Interface: CliToolOptions",permalink:"/api/interfaces/CliToolOptions"}},l={},t=[{value:"Extends",id:"extends",level:2},{value:"Properties",id:"properties",level:2},{value:"displayName",id:"displayname",level:3},{value:"Source",id:"source",level:4},{value:"extensionInfo",id:"extensioninfo",level:3},{value:"id",id:"id",level:4},{value:"label",id:"label",level:4},{value:"Source",id:"source-1",level:4},{value:"id",id:"id-1",level:3},{value:"Source",id:"source-2",level:4},{value:"images",id:"images",level:3},{value:"Source",id:"source-3",level:4},{value:"markdownDescription",id:"markdowndescription",level:3},{value:"Source",id:"source-4",level:4},{value:"name",id:"name",level:3},{value:"Source",id:"source-5",level:4},{value:"onDidUpdateVersion",id:"ondidupdateversion",level:3},{value:"Source",id:"source-6",level:4},{value:"state",id:"state",level:3},{value:"Source",id:"source-7",level:4},{value:"Methods",id:"methods",level:2},{value:"dispose()",id:"dispose",level:3},{value:"Returns",id:"returns",level:4},{value:"Inherited from",id:"inherited-from",level:4},{value:"Source",id:"source-8",level:4},{value:"registerUpdate()",id:"registerupdate",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Source",id:"source-9",level:4},{value:"updateVersion()",id:"updateversion",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-2",level:4},{value:"Source",id:"source-10",level:4}];function a(e){const s={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",li:"li",p:"p",strong:"strong",ul:"ul",...(0,r.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(s.h1,{id:"interface-clitool",children:"Interface: CliTool"}),"\n",(0,i.jsx)(s.h2,{id:"extends",children:"Extends"}),"\n",(0,i.jsxs)(s.ul,{children:["\n",(0,i.jsx)(s.li,{children:(0,i.jsx)(s.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(s.code,{children:"Disposable"})})}),"\n"]}),"\n",(0,i.jsx)(s.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(s.h3,{id:"displayname",children:"displayName"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"displayName"}),": ",(0,i.jsx)(s.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(s.h4,{id:"source",children:"Source"}),"\n",(0,i.jsx)(s.p,{children:(0,i.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L4036",children:"packages/extension-api/src/extension-api.d.ts:4036"})}),"\n",(0,i.jsx)(s.hr,{}),"\n",(0,i.jsx)(s.h3,{id:"extensioninfo",children:"extensionInfo"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"extensionInfo"}),": ",(0,i.jsx)(s.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsx)(s.h4,{id:"id",children:"id"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"id"}),": ",(0,i.jsx)(s.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(s.h4,{id:"label",children:"label"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"label"}),": ",(0,i.jsx)(s.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(s.h4,{id:"source-1",children:"Source"}),"\n",(0,i.jsx)(s.p,{children:(0,i.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L4040",children:"packages/extension-api/src/extension-api.d.ts:4040"})}),"\n",(0,i.jsx)(s.hr,{}),"\n",(0,i.jsx)(s.h3,{id:"id-1",children:"id"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"id"}),": ",(0,i.jsx)(s.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(s.h4,{id:"source-2",children:"Source"}),"\n",(0,i.jsx)(s.p,{children:(0,i.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L4034",children:"packages/extension-api/src/extension-api.d.ts:4034"})}),"\n",(0,i.jsx)(s.hr,{}),"\n",(0,i.jsx)(s.h3,{id:"images",children:"images"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"images"}),": ",(0,i.jsx)(s.a,{href:"/api/interfaces/ProviderImages",children:(0,i.jsx)(s.code,{children:"ProviderImages"})})]}),"\n"]}),"\n",(0,i.jsx)(s.h4,{id:"source-3",children:"Source"}),"\n",(0,i.jsx)(s.p,{children:(0,i.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L4039",children:"packages/extension-api/src/extension-api.d.ts:4039"})}),"\n",(0,i.jsx)(s.hr,{}),"\n",(0,i.jsx)(s.h3,{id:"markdowndescription",children:"markdownDescription"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"markdownDescription"}),": ",(0,i.jsx)(s.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(s.h4,{id:"source-4",children:"Source"}),"\n",(0,i.jsx)(s.p,{children:(0,i.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L4037",children:"packages/extension-api/src/extension-api.d.ts:4037"})}),"\n",(0,i.jsx)(s.hr,{}),"\n",(0,i.jsx)(s.h3,{id:"name",children:"name"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"name"}),": ",(0,i.jsx)(s.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(s.h4,{id:"source-5",children:"Source"}),"\n",(0,i.jsx)(s.p,{children:(0,i.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L4035",children:"packages/extension-api/src/extension-api.d.ts:4035"})}),"\n",(0,i.jsx)(s.hr,{}),"\n",(0,i.jsx)(s.h3,{id:"ondidupdateversion",children:"onDidUpdateVersion"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"onDidUpdateVersion"}),": ",(0,i.jsx)(s.a,{href:"/api/interfaces/Event",children:(0,i.jsx)(s.code,{children:"Event"})}),"< ",(0,i.jsx)(s.code,{children:"string"})," >"]}),"\n"]}),"\n",(0,i.jsx)(s.h4,{id:"source-6",children:"Source"}),"\n",(0,i.jsx)(s.p,{children:(0,i.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L4046",children:"packages/extension-api/src/extension-api.d.ts:4046"})}),"\n",(0,i.jsx)(s.hr,{}),"\n",(0,i.jsx)(s.h3,{id:"state",children:"state"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"state"}),": ",(0,i.jsx)(s.code,{children:'"registered"'})]}),"\n"]}),"\n",(0,i.jsx)(s.h4,{id:"source-7",children:"Source"}),"\n",(0,i.jsx)(s.p,{children:(0,i.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L4038",children:"packages/extension-api/src/extension-api.d.ts:4038"})}),"\n",(0,i.jsx)(s.h2,{id:"methods",children:"Methods"}),"\n",(0,i.jsx)(s.h3,{id:"dispose",children:"dispose()"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"dispose"}),"(): ",(0,i.jsx)(s.code,{children:"void"})]}),"\n"]}),"\n",(0,i.jsx)(s.p,{children:"Dispose this object."}),"\n",(0,i.jsx)(s.h4,{id:"returns",children:"Returns"}),"\n",(0,i.jsx)(s.p,{children:(0,i.jsx)(s.code,{children:"void"})}),"\n",(0,i.jsx)(s.h4,{id:"inherited-from",children:"Inherited from"}),"\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(s.code,{children:"Disposable"})}),".",(0,i.jsx)(s.a,{href:"/api/classes/Disposable#dispose",children:(0,i.jsx)(s.code,{children:"dispose"})})]}),"\n",(0,i.jsx)(s.h4,{id:"source-8",children:"Source"}),"\n",(0,i.jsx)(s.p,{children:(0,i.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L78",children:"packages/extension-api/src/extension-api.d.ts:78"})}),"\n",(0,i.jsx)(s.hr,{}),"\n",(0,i.jsx)(s.h3,{id:"registerupdate",children:"registerUpdate()"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"registerUpdate"}),"(",(0,i.jsx)(s.code,{children:"update"}),"): ",(0,i.jsx)(s.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(s.code,{children:"Disposable"})})]}),"\n"]}),"\n",(0,i.jsx)(s.h4,{id:"parameters",children:"Parameters"}),"\n",(0,i.jsxs)(s.p,{children:["\u2022 ",(0,i.jsx)(s.strong,{children:"update"}),": ",(0,i.jsx)(s.a,{href:"/api/interfaces/CliToolUpdate",children:(0,i.jsx)(s.code,{children:"CliToolUpdate"})})]}),"\n",(0,i.jsx)(s.h4,{id:"returns-1",children:"Returns"}),"\n",(0,i.jsx)(s.p,{children:(0,i.jsx)(s.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(s.code,{children:"Disposable"})})}),"\n",(0,i.jsx)(s.h4,{id:"source-9",children:"Source"}),"\n",(0,i.jsx)(s.p,{children:(0,i.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L4049",children:"packages/extension-api/src/extension-api.d.ts:4049"})}),"\n",(0,i.jsx)(s.hr,{}),"\n",(0,i.jsx)(s.h3,{id:"updateversion",children:"updateVersion()"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"updateVersion"}),"(",(0,i.jsx)(s.code,{children:"version"}),"): ",(0,i.jsx)(s.code,{children:"void"})]}),"\n"]}),"\n",(0,i.jsx)(s.h4,{id:"parameters-1",children:"Parameters"}),"\n",(0,i.jsxs)(s.p,{children:["\u2022 ",(0,i.jsx)(s.strong,{children:"version"}),": ",(0,i.jsx)(s.a,{href:"/api/interfaces/CliToolUpdateOptions",children:(0,i.jsx)(s.code,{children:"CliToolUpdateOptions"})})]}),"\n",(0,i.jsx)(s.h4,{id:"returns-2",children:"Returns"}),"\n",(0,i.jsx)(s.p,{children:(0,i.jsx)(s.code,{children:"void"})}),"\n",(0,i.jsx)(s.h4,{id:"source-10",children:"Source"}),"\n",(0,i.jsx)(s.p,{children:(0,i.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L4045",children:"packages/extension-api/src/extension-api.d.ts:4045"})})]})}function h(e={}){const{wrapper:s}={...(0,r.a)(),...e.components};return s?(0,i.jsx)(s,{...e,children:(0,i.jsx)(a,{...e})}):a(e)}},71670:(e,s,n)=>{n.d(s,{Z:()=>o,a:()=>d});var i=n(27378);const r={},c=i.createContext(r);function d(e){const s=i.useContext(c);return i.useMemo((function(){return"function"==typeof e?e(s):{...s,...e}}),[s,e])}function o(e){let s;return s=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:d(e.components),i.createElement(c.Provider,{value:s},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[48926],{80042:(e,s,n)=>{n.r(s),n.d(s,{assets:()=>l,contentTitle:()=>c,default:()=>h,frontMatter:()=>d,metadata:()=>o,toc:()=>t});var i=n(24246),r=n(71670);const d={},c="Interface: CliTool",o={id:"interfaces/CliTool",title:"Interface: CliTool",description:"Extends",source:"@site/api/interfaces/CliTool.md",sourceDirName:"interfaces",slug:"/interfaces/CliTool",permalink:"/api/interfaces/CliTool",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: CheckResultFixCommand",permalink:"/api/interfaces/CheckResultFixCommand"},next:{title:"Interface: CliToolOptions",permalink:"/api/interfaces/CliToolOptions"}},l={},t=[{value:"Extends",id:"extends",level:2},{value:"Properties",id:"properties",level:2},{value:"displayName",id:"displayname",level:3},{value:"Source",id:"source",level:4},{value:"extensionInfo",id:"extensioninfo",level:3},{value:"id",id:"id",level:4},{value:"label",id:"label",level:4},{value:"Source",id:"source-1",level:4},{value:"id",id:"id-1",level:3},{value:"Source",id:"source-2",level:4},{value:"images",id:"images",level:3},{value:"Source",id:"source-3",level:4},{value:"markdownDescription",id:"markdowndescription",level:3},{value:"Source",id:"source-4",level:4},{value:"name",id:"name",level:3},{value:"Source",id:"source-5",level:4},{value:"onDidUpdateVersion",id:"ondidupdateversion",level:3},{value:"Source",id:"source-6",level:4},{value:"state",id:"state",level:3},{value:"Source",id:"source-7",level:4},{value:"Methods",id:"methods",level:2},{value:"dispose()",id:"dispose",level:3},{value:"Returns",id:"returns",level:4},{value:"Inherited from",id:"inherited-from",level:4},{value:"Source",id:"source-8",level:4},{value:"registerUpdate()",id:"registerupdate",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Source",id:"source-9",level:4},{value:"updateVersion()",id:"updateversion",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-2",level:4},{value:"Source",id:"source-10",level:4}];function a(e){const s={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",li:"li",p:"p",strong:"strong",ul:"ul",...(0,r.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(s.h1,{id:"interface-clitool",children:"Interface: CliTool"}),"\n",(0,i.jsx)(s.h2,{id:"extends",children:"Extends"}),"\n",(0,i.jsxs)(s.ul,{children:["\n",(0,i.jsx)(s.li,{children:(0,i.jsx)(s.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(s.code,{children:"Disposable"})})}),"\n"]}),"\n",(0,i.jsx)(s.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(s.h3,{id:"displayname",children:"displayName"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"displayName"}),": ",(0,i.jsx)(s.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(s.h4,{id:"source",children:"Source"}),"\n",(0,i.jsx)(s.p,{children:(0,i.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L4036",children:"packages/extension-api/src/extension-api.d.ts:4036"})}),"\n",(0,i.jsx)(s.hr,{}),"\n",(0,i.jsx)(s.h3,{id:"extensioninfo",children:"extensionInfo"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"extensionInfo"}),": ",(0,i.jsx)(s.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsx)(s.h4,{id:"id",children:"id"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"id"}),": ",(0,i.jsx)(s.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(s.h4,{id:"label",children:"label"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"label"}),": ",(0,i.jsx)(s.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(s.h4,{id:"source-1",children:"Source"}),"\n",(0,i.jsx)(s.p,{children:(0,i.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L4040",children:"packages/extension-api/src/extension-api.d.ts:4040"})}),"\n",(0,i.jsx)(s.hr,{}),"\n",(0,i.jsx)(s.h3,{id:"id-1",children:"id"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"id"}),": ",(0,i.jsx)(s.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(s.h4,{id:"source-2",children:"Source"}),"\n",(0,i.jsx)(s.p,{children:(0,i.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L4034",children:"packages/extension-api/src/extension-api.d.ts:4034"})}),"\n",(0,i.jsx)(s.hr,{}),"\n",(0,i.jsx)(s.h3,{id:"images",children:"images"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"images"}),": ",(0,i.jsx)(s.a,{href:"/api/interfaces/ProviderImages",children:(0,i.jsx)(s.code,{children:"ProviderImages"})})]}),"\n"]}),"\n",(0,i.jsx)(s.h4,{id:"source-3",children:"Source"}),"\n",(0,i.jsx)(s.p,{children:(0,i.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L4039",children:"packages/extension-api/src/extension-api.d.ts:4039"})}),"\n",(0,i.jsx)(s.hr,{}),"\n",(0,i.jsx)(s.h3,{id:"markdowndescription",children:"markdownDescription"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"markdownDescription"}),": ",(0,i.jsx)(s.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(s.h4,{id:"source-4",children:"Source"}),"\n",(0,i.jsx)(s.p,{children:(0,i.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L4037",children:"packages/extension-api/src/extension-api.d.ts:4037"})}),"\n",(0,i.jsx)(s.hr,{}),"\n",(0,i.jsx)(s.h3,{id:"name",children:"name"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"name"}),": ",(0,i.jsx)(s.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(s.h4,{id:"source-5",children:"Source"}),"\n",(0,i.jsx)(s.p,{children:(0,i.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L4035",children:"packages/extension-api/src/extension-api.d.ts:4035"})}),"\n",(0,i.jsx)(s.hr,{}),"\n",(0,i.jsx)(s.h3,{id:"ondidupdateversion",children:"onDidUpdateVersion"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"onDidUpdateVersion"}),": ",(0,i.jsx)(s.a,{href:"/api/interfaces/Event",children:(0,i.jsx)(s.code,{children:"Event"})}),"< ",(0,i.jsx)(s.code,{children:"string"})," >"]}),"\n"]}),"\n",(0,i.jsx)(s.h4,{id:"source-6",children:"Source"}),"\n",(0,i.jsx)(s.p,{children:(0,i.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L4046",children:"packages/extension-api/src/extension-api.d.ts:4046"})}),"\n",(0,i.jsx)(s.hr,{}),"\n",(0,i.jsx)(s.h3,{id:"state",children:"state"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"state"}),": ",(0,i.jsx)(s.code,{children:'"registered"'})]}),"\n"]}),"\n",(0,i.jsx)(s.h4,{id:"source-7",children:"Source"}),"\n",(0,i.jsx)(s.p,{children:(0,i.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L4038",children:"packages/extension-api/src/extension-api.d.ts:4038"})}),"\n",(0,i.jsx)(s.h2,{id:"methods",children:"Methods"}),"\n",(0,i.jsx)(s.h3,{id:"dispose",children:"dispose()"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"dispose"}),"(): ",(0,i.jsx)(s.code,{children:"void"})]}),"\n"]}),"\n",(0,i.jsx)(s.p,{children:"Dispose this object."}),"\n",(0,i.jsx)(s.h4,{id:"returns",children:"Returns"}),"\n",(0,i.jsx)(s.p,{children:(0,i.jsx)(s.code,{children:"void"})}),"\n",(0,i.jsx)(s.h4,{id:"inherited-from",children:"Inherited from"}),"\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(s.code,{children:"Disposable"})}),".",(0,i.jsx)(s.a,{href:"/api/classes/Disposable#dispose",children:(0,i.jsx)(s.code,{children:"dispose"})})]}),"\n",(0,i.jsx)(s.h4,{id:"source-8",children:"Source"}),"\n",(0,i.jsx)(s.p,{children:(0,i.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L78",children:"packages/extension-api/src/extension-api.d.ts:78"})}),"\n",(0,i.jsx)(s.hr,{}),"\n",(0,i.jsx)(s.h3,{id:"registerupdate",children:"registerUpdate()"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"registerUpdate"}),"(",(0,i.jsx)(s.code,{children:"update"}),"): ",(0,i.jsx)(s.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(s.code,{children:"Disposable"})})]}),"\n"]}),"\n",(0,i.jsx)(s.h4,{id:"parameters",children:"Parameters"}),"\n",(0,i.jsxs)(s.p,{children:["\u2022 ",(0,i.jsx)(s.strong,{children:"update"}),": ",(0,i.jsx)(s.a,{href:"/api/interfaces/CliToolUpdate",children:(0,i.jsx)(s.code,{children:"CliToolUpdate"})})]}),"\n",(0,i.jsx)(s.h4,{id:"returns-1",children:"Returns"}),"\n",(0,i.jsx)(s.p,{children:(0,i.jsx)(s.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(s.code,{children:"Disposable"})})}),"\n",(0,i.jsx)(s.h4,{id:"source-9",children:"Source"}),"\n",(0,i.jsx)(s.p,{children:(0,i.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L4049",children:"packages/extension-api/src/extension-api.d.ts:4049"})}),"\n",(0,i.jsx)(s.hr,{}),"\n",(0,i.jsx)(s.h3,{id:"updateversion",children:"updateVersion()"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"updateVersion"}),"(",(0,i.jsx)(s.code,{children:"version"}),"): ",(0,i.jsx)(s.code,{children:"void"})]}),"\n"]}),"\n",(0,i.jsx)(s.h4,{id:"parameters-1",children:"Parameters"}),"\n",(0,i.jsxs)(s.p,{children:["\u2022 ",(0,i.jsx)(s.strong,{children:"version"}),": ",(0,i.jsx)(s.a,{href:"/api/interfaces/CliToolUpdateOptions",children:(0,i.jsx)(s.code,{children:"CliToolUpdateOptions"})})]}),"\n",(0,i.jsx)(s.h4,{id:"returns-2",children:"Returns"}),"\n",(0,i.jsx)(s.p,{children:(0,i.jsx)(s.code,{children:"void"})}),"\n",(0,i.jsx)(s.h4,{id:"source-10",children:"Source"}),"\n",(0,i.jsx)(s.p,{children:(0,i.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L4045",children:"packages/extension-api/src/extension-api.d.ts:4045"})})]})}function h(e={}){const{wrapper:s}={...(0,r.a)(),...e.components};return s?(0,i.jsx)(s,{...e,children:(0,i.jsx)(a,{...e})}):a(e)}},71670:(e,s,n)=>{n.d(s,{Z:()=>o,a:()=>c});var i=n(27378);const r={},d=i.createContext(r);function c(e){const s=i.useContext(d);return i.useMemo((function(){return"function"==typeof e?e(s):{...s,...e}}),[s,e])}function o(e){let s;return s=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:c(e.components),i.createElement(d.Provider,{value:s},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/610f2c47.b383cecf.js b/assets/js/610f2c47.0d2aa192.js similarity index 91% rename from assets/js/610f2c47.b383cecf.js rename to assets/js/610f2c47.0d2aa192.js index 5713ac420de..6dc5bacc07b 100644 --- a/assets/js/610f2c47.b383cecf.js +++ b/assets/js/610f2c47.0d2aa192.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[23937],{36704:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>a,contentTitle:()=>r,default:()=>p,frontMatter:()=>i,metadata:()=>c,toc:()=>d});var t=s(24246),o=s(71670);const i={},r="Function: showInputBox()",c={id:"namespaces/window/functions/showInputBox",title:"Function: showInputBox()",description:"showInputBox(options?, token?): Promise\\",source:"@site/api/namespaces/window/functions/showInputBox.md",sourceDirName:"namespaces/window/functions",slug:"/namespaces/window/functions/showInputBox",permalink:"/api/namespaces/window/functions/showInputBox",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Function: showInformationMessage()",permalink:"/api/namespaces/window/functions/showInformationMessage"},next:{title:"Function: showNotification()",permalink:"/api/namespaces/window/functions/showNotification"}},a={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function 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-showinputbox",children:"Function: showInputBox()"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"showInputBox"}),"(",(0,t.jsx)(n.code,{children:"options"}),"?, ",(0,t.jsx)(n.code,{children:"token"}),"?): ",(0,t.jsx)(n.code,{children:"Promise"}),"< ",(0,t.jsx)(n.code,{children:"string"})," | ",(0,t.jsx)(n.code,{children:"undefined"})," >"]}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"Opens an input box to ask the user for input."}),"\n",(0,t.jsxs)(n.p,{children:["The returned value will be ",(0,t.jsx)(n.code,{children:"undefined"})," if the input box was canceled (e.g. pressing ESC). Otherwise the\nreturned value will be the string typed by the user or an empty string if the user did not type\nanything but dismissed the input box with OK."]}),"\n",(0,t.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"options?"}),": ",(0,t.jsx)(n.a,{href:"/api/interfaces/InputBoxOptions",children:(0,t.jsx)(n.code,{children:"InputBoxOptions"})})]}),"\n",(0,t.jsx)(n.p,{children:"Configures the behavior of the input box."}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"token?"}),": ",(0,t.jsx)(n.a,{href:"/api/interfaces/CancellationToken",children:(0,t.jsx)(n.code,{children:"CancellationToken"})})]}),"\n",(0,t.jsx)(n.p,{children:"A token that can be used to signal cancellation."}),"\n",(0,t.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"Promise"}),"< ",(0,t.jsx)(n.code,{children:"string"})," | ",(0,t.jsx)(n.code,{children:"undefined"})," >"]}),"\n",(0,t.jsxs)(n.p,{children:["A promise that resolves to a string the user provided or to ",(0,t.jsx)(n.code,{children:"undefined"})," in case of dismissal."]}),"\n",(0,t.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L1704",children:"packages/extension-api/src/extension-api.d.ts:1704"})})]})}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:()=>r});var t=s(27378);const o={},i=t.createContext(o);function r(e){const n=t.useContext(i);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:r(e.components),t.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[23937],{36704:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>d,contentTitle:()=>r,default:()=>p,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:"Function: showInformationMessage()",permalink:"/api/namespaces/window/functions/showInformationMessage"},next:{title:"Function: showNotification()",permalink:"/api/namespaces/window/functions/showNotification"}},d={},a=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function 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-showinputbox",children:"Function: showInputBox()"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"showInputBox"}),"(",(0,t.jsx)(n.code,{children:"options"}),"?, ",(0,t.jsx)(n.code,{children:"token"}),"?): ",(0,t.jsx)(n.code,{children:"Promise"}),"< ",(0,t.jsx)(n.code,{children:"string"})," | ",(0,t.jsx)(n.code,{children:"undefined"})," >"]}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"Opens an input box to ask the user for input."}),"\n",(0,t.jsxs)(n.p,{children:["The returned value will be ",(0,t.jsx)(n.code,{children:"undefined"})," if the input box was canceled (e.g. pressing ESC). Otherwise the\nreturned value will be the string typed by the user or an empty string if the user did not type\nanything but dismissed the input box with OK."]}),"\n",(0,t.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"options?"}),": ",(0,t.jsx)(n.a,{href:"/api/interfaces/InputBoxOptions",children:(0,t.jsx)(n.code,{children:"InputBoxOptions"})})]}),"\n",(0,t.jsx)(n.p,{children:"Configures the behavior of the input box."}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"token?"}),": ",(0,t.jsx)(n.a,{href:"/api/interfaces/CancellationToken",children:(0,t.jsx)(n.code,{children:"CancellationToken"})})]}),"\n",(0,t.jsx)(n.p,{children:"A token that can be used to signal cancellation."}),"\n",(0,t.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"Promise"}),"< ",(0,t.jsx)(n.code,{children:"string"})," | ",(0,t.jsx)(n.code,{children:"undefined"})," >"]}),"\n",(0,t.jsxs)(n.p,{children:["A promise that resolves to a string the user provided or to ",(0,t.jsx)(n.code,{children:"undefined"})," in case of dismissal."]}),"\n",(0,t.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L1704",children:"packages/extension-api/src/extension-api.d.ts:1704"})})]})}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:()=>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.955e4166.js b/assets/js/612345e6.7d26d63e.js similarity index 89% rename from assets/js/612345e6.955e4166.js rename to assets/js/612345e6.7d26d63e.js index ed54db9292b..11184ec7cda 100644 --- a/assets/js/612345e6.955e4166.js +++ b/assets/js/612345e6.7d26d63e.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[47389],{88795:(n,e,t)=>{t.r(e),t.d(e,{assets:()=>c,contentTitle:()=>s,default:()=>l,frontMatter:()=>a,metadata:()=>r,toc:()=>u});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:"Function: navigateToContainers()",permalink:"/api/namespaces/navigation/functions/navigateToContainers"},next:{title:"Function: navigateToEditProviderContainerConnection()",permalink:"/api/namespaces/navigation/functions/navigateToEditProviderContainerConnection"}},c={},u=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function d(n){const e={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,o.a)(),...n.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(e.h1,{id:"function-navigatetocontribution",children:"Function: navigateToContribution()"}),"\n",(0,i.jsxs)(e.blockquote,{children:["\n",(0,i.jsxs)(e.p,{children:[(0,i.jsx)(e.strong,{children:"navigateToContribution"}),"(",(0,i.jsx)(e.code,{children:"name"}),"): ",(0,i.jsx)(e.code,{children:"Promise"}),"< ",(0,i.jsx)(e.code,{children:"void"})," >"]}),"\n"]}),"\n",(0,i.jsx)(e.h2,{id:"parameters",children:"Parameters"}),"\n",(0,i.jsxs)(e.p,{children:["\u2022 ",(0,i.jsx)(e.strong,{children:"name"}),": ",(0,i.jsx)(e.code,{children:"string"})]}),"\n",(0,i.jsx)(e.h2,{id:"returns",children:"Returns"}),"\n",(0,i.jsxs)(e.p,{children:[(0,i.jsx)(e.code,{children:"Promise"}),"< ",(0,i.jsx)(e.code,{children:"void"})," >"]}),"\n",(0,i.jsx)(e.h2,{id:"source",children:"Source"}),"\n",(0,i.jsx)(e.p,{children:(0,i.jsx)(e.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L4168",children:"packages/extension-api/src/extension-api.d.ts:4168"})})]})}function l(n={}){const{wrapper:e}={...(0,o.a)(),...n.components};return e?(0,i.jsx)(e,{...n,children:(0,i.jsx)(d,{...n})}):d(n)}},71670:(n,e,t)=>{t.d(e,{Z:()=>r,a:()=>s});var i=t(27378);const o={},a=i.createContext(o);function s(n){const e=i.useContext(a);return i.useMemo((function(){return"function"==typeof n?n(e):{...e,...n}}),[e,n])}function r(n){let e;return e=n.disableParentContext?"function"==typeof n.components?n.components(o):n.components||o:s(n.components),i.createElement(a.Provider,{value:e},n.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[47389],{88795:(n,e,t)=>{t.r(e),t.d(e,{assets:()=>c,contentTitle:()=>s,default:()=>l,frontMatter:()=>a,metadata:()=>r,toc:()=>d});var i=t(24246),o=t(71670);const a={},s="Function: navigateToContribution()",r={id:"namespaces/navigation/functions/navigateToContribution",title:"Function: navigateToContribution()",description:"navigateToContribution(name): Promise\\",source:"@site/api/namespaces/navigation/functions/navigateToContribution.md",sourceDirName:"namespaces/navigation/functions",slug:"/namespaces/navigation/functions/navigateToContribution",permalink:"/api/namespaces/navigation/functions/navigateToContribution",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Function: navigateToContainers()",permalink:"/api/namespaces/navigation/functions/navigateToContainers"},next:{title:"Function: navigateToEditProviderContainerConnection()",permalink:"/api/namespaces/navigation/functions/navigateToEditProviderContainerConnection"}},c={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function u(n){const e={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,o.a)(),...n.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(e.h1,{id:"function-navigatetocontribution",children:"Function: navigateToContribution()"}),"\n",(0,i.jsxs)(e.blockquote,{children:["\n",(0,i.jsxs)(e.p,{children:[(0,i.jsx)(e.strong,{children:"navigateToContribution"}),"(",(0,i.jsx)(e.code,{children:"name"}),"): ",(0,i.jsx)(e.code,{children:"Promise"}),"< ",(0,i.jsx)(e.code,{children:"void"})," >"]}),"\n"]}),"\n",(0,i.jsx)(e.h2,{id:"parameters",children:"Parameters"}),"\n",(0,i.jsxs)(e.p,{children:["\u2022 ",(0,i.jsx)(e.strong,{children:"name"}),": ",(0,i.jsx)(e.code,{children:"string"})]}),"\n",(0,i.jsx)(e.h2,{id:"returns",children:"Returns"}),"\n",(0,i.jsxs)(e.p,{children:[(0,i.jsx)(e.code,{children:"Promise"}),"< ",(0,i.jsx)(e.code,{children:"void"})," >"]}),"\n",(0,i.jsx)(e.h2,{id:"source",children:"Source"}),"\n",(0,i.jsx)(e.p,{children:(0,i.jsx)(e.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L4168",children:"packages/extension-api/src/extension-api.d.ts:4168"})})]})}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.e85152be.js b/assets/js/62e21724.82dcbf9f.js similarity index 85% rename from assets/js/62e21724.e85152be.js rename to assets/js/62e21724.82dcbf9f.js index 40f5243e2d6..ab999e6e216 100644 --- a/assets/js/62e21724.e85152be.js +++ b/assets/js/62e21724.82dcbf9f.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[33067],{48526:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>r,default:()=>d,frontMatter:()=>o,metadata:()=>s,toc:()=>l});var i=t(24246),c=t(71670);const o={},r="Interface: QuickInputButton",s={id:"interfaces/QuickInputButton",title:"Interface: QuickInputButton",description:"Button for an action in a QuickPick or InputBox.",source:"@site/api/interfaces/QuickInputButton.md",sourceDirName:"interfaces",slug:"/interfaces/QuickInputButton",permalink:"/api/interfaces/QuickInputButton",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: PullEvent",permalink:"/api/interfaces/PullEvent"},next:{title:"Interface: QuickPickItem",permalink:"/api/interfaces/QuickPickItem"}},a={},l=[{value:"Properties",id:"properties",level:2},{value:"iconPath",id:"iconpath",level:3},{value:"Source",id:"source",level:4},{value:"tooltip?",id:"tooltip",level:3},{value:"Source",id:"source-1",level:4}];function u(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,c.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.strong,{children:(0,i.jsx)(n.code,{children:"readonly"})})," ",(0,i.jsx)(n.strong,{children:"iconPath"}),": ",(0,i.jsx)(n.a,{href:"/api/classes/Uri",children:(0,i.jsx)(n.code,{children:"Uri"})})," | ",(0,i.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Icon for the button."}),"\n",(0,i.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L927",children:"packages/extension-api/src/extension-api.d.ts:927"})}),"\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.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"readonly"})})," ",(0,i.jsx)(n.strong,{children:"tooltip"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"An optional tooltip."}),"\n",(0,i.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L932",children:"packages/extension-api/src/extension-api.d.ts:932"})})]})}function d(e={}){const{wrapper:n}={...(0,c.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(u,{...e})}):u(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>s,a:()=>r});var i=t(27378);const c={},o=i.createContext(c);function r(e){const n=i.useContext(o);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function s(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(c):e.components||c:r(e.components),i.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[33067],{48526:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>r,default:()=>u,frontMatter:()=>o,metadata:()=>s,toc:()=>l});var i=t(24246),c=t(71670);const o={},r="Interface: QuickInputButton",s={id:"interfaces/QuickInputButton",title:"Interface: QuickInputButton",description:"Button for an action in a QuickPick or InputBox.",source:"@site/api/interfaces/QuickInputButton.md",sourceDirName:"interfaces",slug:"/interfaces/QuickInputButton",permalink:"/api/interfaces/QuickInputButton",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: PullEvent",permalink:"/api/interfaces/PullEvent"},next:{title:"Interface: QuickPickItem",permalink:"/api/interfaces/QuickPickItem"}},a={},l=[{value:"Properties",id:"properties",level:2},{value:"iconPath",id:"iconpath",level:3},{value:"Source",id:"source",level:4},{value:"tooltip?",id:"tooltip",level:3},{value:"Source",id:"source-1",level:4}];function d(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,c.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.strong,{children:(0,i.jsx)(n.code,{children:"readonly"})})," ",(0,i.jsx)(n.strong,{children:"iconPath"}),": ",(0,i.jsx)(n.a,{href:"/api/classes/Uri",children:(0,i.jsx)(n.code,{children:"Uri"})})," | ",(0,i.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Icon for the button."}),"\n",(0,i.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L927",children:"packages/extension-api/src/extension-api.d.ts:927"})}),"\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.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"readonly"})})," ",(0,i.jsx)(n.strong,{children:"tooltip"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"An optional tooltip."}),"\n",(0,i.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L932",children:"packages/extension-api/src/extension-api.d.ts:932"})})]})}function u(e={}){const{wrapper:n}={...(0,c.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(d,{...e})}):d(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>s,a:()=>r});var i=t(27378);const c={},o=i.createContext(c);function r(e){const n=i.useContext(o);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function s(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(c):e.components||c:r(e.components),i.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/640277b9.4daaabe9.js b/assets/js/640277b9.c441a0a4.js similarity index 97% rename from assets/js/640277b9.4daaabe9.js rename to assets/js/640277b9.c441a0a4.js index 37319a20321..a0152563b4f 100644 --- a/assets/js/640277b9.4daaabe9.js +++ b/assets/js/640277b9.c441a0a4.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[48901],{49161:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>a,contentTitle:()=>c,default:()=>u,frontMatter:()=>o,metadata:()=>r,toc:()=>d});var i=s(24246),t=s(71670);const o={},c="Function: listWebviews()",r={id:"namespaces/window/functions/listWebviews",title:"Function: listWebviews()",description:"listWebviews(): Promise\\",source:"@site/api/namespaces/window/functions/listWebviews.md",sourceDirName:"namespaces/window/functions",slug:"/namespaces/window/functions/listWebviews",permalink:"/api/namespaces/window/functions/listWebviews",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Function: createWebviewPanel()",permalink:"/api/namespaces/window/functions/createWebviewPanel"},next:{title:"Function: showErrorMessage()",permalink:"/api/namespaces/window/functions/showErrorMessage"}},a={},d=[{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,t.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"function-listwebviews",children:"Function: listWebviews()"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"listWebviews"}),"(): ",(0,i.jsx)(n.code,{children:"Promise"}),"< ",(0,i.jsx)(n.a,{href:"/api/interfaces/WebviewInfo",children:(0,i.jsx)(n.code,{children:"WebviewInfo"})}),"[] >"]}),"\n"]}),"\n",(0,i.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"Promise"}),"< ",(0,i.jsx)(n.a,{href:"/api/interfaces/WebviewInfo",children:(0,i.jsx)(n.code,{children:"WebviewInfo"})}),"[] >"]}),"\n",(0,i.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L1797",children:"packages/extension-api/src/extension-api.d.ts:1797"})})]})}function u(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>r,a:()=>c});var i=s(27378);const t={},o=i.createContext(t);function c(e){const n=i.useContext(o);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function r(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:c(e.components),i.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[48901],{49161:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>a,contentTitle:()=>c,default:()=>u,frontMatter:()=>o,metadata:()=>r,toc:()=>d});var i=s(24246),t=s(71670);const o={},c="Function: listWebviews()",r={id:"namespaces/window/functions/listWebviews",title:"Function: listWebviews()",description:"listWebviews(): Promise\\",source:"@site/api/namespaces/window/functions/listWebviews.md",sourceDirName:"namespaces/window/functions",slug:"/namespaces/window/functions/listWebviews",permalink:"/api/namespaces/window/functions/listWebviews",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Function: createWebviewPanel()",permalink:"/api/namespaces/window/functions/createWebviewPanel"},next:{title:"Function: showErrorMessage()",permalink:"/api/namespaces/window/functions/showErrorMessage"}},a={},d=[{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,t.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"function-listwebviews",children:"Function: listWebviews()"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"listWebviews"}),"(): ",(0,i.jsx)(n.code,{children:"Promise"}),"< ",(0,i.jsx)(n.a,{href:"/api/interfaces/WebviewInfo",children:(0,i.jsx)(n.code,{children:"WebviewInfo"})}),"[] >"]}),"\n"]}),"\n",(0,i.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"Promise"}),"< ",(0,i.jsx)(n.a,{href:"/api/interfaces/WebviewInfo",children:(0,i.jsx)(n.code,{children:"WebviewInfo"})}),"[] >"]}),"\n",(0,i.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L1797",children:"packages/extension-api/src/extension-api.d.ts:1797"})})]})}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.97f21a99.js b/assets/js/64134c03.0c1b6feb.js similarity index 67% rename from assets/js/64134c03.97f21a99.js rename to assets/js/64134c03.0c1b6feb.js index 1db6e7b1a1d..b2238dd9179 100644 --- a/assets/js/64134c03.97f21a99.js +++ b/assets/js/64134c03.0c1b6feb.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[71796],{34807:(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: isEnabled()",a={id:"namespaces/proxy/functions/isEnabled",title:"Function: isEnabled()",description:"isEnabled(): boolean",source:"@site/api/namespaces/proxy/functions/isEnabled.md",sourceDirName:"namespaces/proxy/functions",slug:"/namespaces/proxy/functions/isEnabled",permalink:"/api/namespaces/proxy/functions/isEnabled",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Function: getProxySettings()",permalink:"/api/namespaces/proxy/functions/getProxySettings"},next:{title:"Function: onDidStateChange()",permalink:"/api/namespaces/proxy/functions/onDidStateChange"}},r={},d=[{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,o.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"function-isenabled",children:"Function: isEnabled()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"isEnabled"}),"(): ",(0,s.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,s.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"boolean"})}),"\n",(0,s.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L580",children:"packages/extension-api/src/extension-api.d.ts:580"})})]})}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([[71796],{34807:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>c,default:()=>u,frontMatter:()=>i,metadata:()=>r,toc:()=>d});var s=t(24246),o=t(71670);const i={},c="Function: isEnabled()",r={id:"namespaces/proxy/functions/isEnabled",title:"Function: isEnabled()",description:"isEnabled(): boolean",source:"@site/api/namespaces/proxy/functions/isEnabled.md",sourceDirName:"namespaces/proxy/functions",slug:"/namespaces/proxy/functions/isEnabled",permalink:"/api/namespaces/proxy/functions/isEnabled",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Function: getProxySettings()",permalink:"/api/namespaces/proxy/functions/getProxySettings"},next:{title:"Function: onDidStateChange()",permalink:"/api/namespaces/proxy/functions/onDidStateChange"}},a={},d=[{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,o.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"function-isenabled",children:"Function: isEnabled()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"isEnabled"}),"(): ",(0,s.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,s.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"boolean"})}),"\n",(0,s.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L580",children:"packages/extension-api/src/extension-api.d.ts:580"})})]})}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:()=>r,a:()=>c});var s=t(27378);const o={},i=s.createContext(o);function c(e){const n=s.useContext(i);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function r(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:c(e.components),s.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/6477cdc2.40c887b4.js b/assets/js/6477cdc2.f8ec3a84.js similarity index 87% rename from assets/js/6477cdc2.40c887b4.js rename to assets/js/6477cdc2.f8ec3a84.js index 9c1ca7fc765..ce91329da7d 100644 --- a/assets/js/6477cdc2.40c887b4.js +++ b/assets/js/6477cdc2.f8ec3a84.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[16696],{10966:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>a,contentTitle:()=>o,default:()=>p,frontMatter:()=>c,metadata:()=>i,toc:()=>l});var t=r(24246),s=r(71670);const c={},o="Function: createTelemetryLogger()",i={id:"namespaces/env/functions/createTelemetryLogger",title:"Function: createTelemetryLogger()",description:"createTelemetryLogger(sender?, options?): TelemetryLogger",source:"@site/api/namespaces/env/functions/createTelemetryLogger.md",sourceDirName:"namespaces/env/functions",slug:"/namespaces/env/functions/createTelemetryLogger",permalink:"/api/namespaces/env/functions/createTelemetryLogger",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Variable: isWindows",permalink:"/api/namespaces/env/variables/isWindows"},next:{title:"Function: onDidChangeTelemetryEnabled()",permalink:"/api/namespaces/env/functions/onDidChangeTelemetryEnabled"}},a={},l=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function d(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"function-createtelemetrylogger",children:"Function: createTelemetryLogger()"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"createTelemetryLogger"}),"(",(0,t.jsx)(n.code,{children:"sender"}),"?, ",(0,t.jsx)(n.code,{children:"options"}),"?): ",(0,t.jsx)(n.a,{href:"/api/interfaces/TelemetryLogger",children:(0,t.jsx)(n.code,{children:"TelemetryLogger"})})]}),"\n"]}),"\n",(0,t.jsxs)(n.p,{children:["Creates a new ",(0,t.jsx)(n.a,{href:"/api/interfaces/TelemetryLogger",children:"telemetry logger"}),"."]}),"\n",(0,t.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"sender?"}),": ",(0,t.jsx)(n.a,{href:"/api/interfaces/TelemetrySender",children:(0,t.jsx)(n.code,{children:"TelemetrySender"})})]}),"\n",(0,t.jsx)(n.p,{children:"The telemetry sender that is used by the telemetry logger."}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"options?"}),": ",(0,t.jsx)(n.a,{href:"/api/interfaces/TelemetryLoggerOptions",children:(0,t.jsx)(n.code,{children:"TelemetryLoggerOptions"})})]}),"\n",(0,t.jsx)(n.p,{children:"Options for the telemetry logger."}),"\n",(0,t.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"/api/interfaces/TelemetryLogger",children:(0,t.jsx)(n.code,{children:"TelemetryLogger"})})}),"\n",(0,t.jsx)(n.p,{children:"A new telemetry logger"}),"\n",(0,t.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L3712",children:"packages/extension-api/src/extension-api.d.ts:3712"})})]})}function p(e={}){const{wrapper:n}={...(0,s.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(d,{...e})}):d(e)}},71670:(e,n,r)=>{r.d(n,{Z:()=>i,a:()=>o});var t=r(27378);const s={},c=t.createContext(s);function o(e){const n=t.useContext(c);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function i(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:o(e.components),t.createElement(c.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[16696],{10966:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>a,contentTitle:()=>c,default:()=>p,frontMatter:()=>o,metadata:()=>i,toc:()=>l});var t=r(24246),s=r(71670);const o={},c="Function: createTelemetryLogger()",i={id:"namespaces/env/functions/createTelemetryLogger",title:"Function: createTelemetryLogger()",description:"createTelemetryLogger(sender?, options?): TelemetryLogger",source:"@site/api/namespaces/env/functions/createTelemetryLogger.md",sourceDirName:"namespaces/env/functions",slug:"/namespaces/env/functions/createTelemetryLogger",permalink:"/api/namespaces/env/functions/createTelemetryLogger",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Variable: isWindows",permalink:"/api/namespaces/env/variables/isWindows"},next:{title:"Function: onDidChangeTelemetryEnabled()",permalink:"/api/namespaces/env/functions/onDidChangeTelemetryEnabled"}},a={},l=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function d(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"function-createtelemetrylogger",children:"Function: createTelemetryLogger()"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"createTelemetryLogger"}),"(",(0,t.jsx)(n.code,{children:"sender"}),"?, ",(0,t.jsx)(n.code,{children:"options"}),"?): ",(0,t.jsx)(n.a,{href:"/api/interfaces/TelemetryLogger",children:(0,t.jsx)(n.code,{children:"TelemetryLogger"})})]}),"\n"]}),"\n",(0,t.jsxs)(n.p,{children:["Creates a new ",(0,t.jsx)(n.a,{href:"/api/interfaces/TelemetryLogger",children:"telemetry logger"}),"."]}),"\n",(0,t.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"sender?"}),": ",(0,t.jsx)(n.a,{href:"/api/interfaces/TelemetrySender",children:(0,t.jsx)(n.code,{children:"TelemetrySender"})})]}),"\n",(0,t.jsx)(n.p,{children:"The telemetry sender that is used by the telemetry logger."}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"options?"}),": ",(0,t.jsx)(n.a,{href:"/api/interfaces/TelemetryLoggerOptions",children:(0,t.jsx)(n.code,{children:"TelemetryLoggerOptions"})})]}),"\n",(0,t.jsx)(n.p,{children:"Options for the telemetry logger."}),"\n",(0,t.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"/api/interfaces/TelemetryLogger",children:(0,t.jsx)(n.code,{children:"TelemetryLogger"})})}),"\n",(0,t.jsx)(n.p,{children:"A new telemetry logger"}),"\n",(0,t.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L3712",children:"packages/extension-api/src/extension-api.d.ts:3712"})})]})}function p(e={}){const{wrapper:n}={...(0,s.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(d,{...e})}):d(e)}},71670:(e,n,r)=>{r.d(n,{Z:()=>i,a:()=>c});var t=r(27378);const s={},o=t.createContext(s);function c(e){const n=t.useContext(o);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function i(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:c(e.components),t.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/6494b798.542dea5b.js b/assets/js/6494b798.25e58aff.js similarity index 94% rename from assets/js/6494b798.542dea5b.js rename to assets/js/6494b798.25e58aff.js index 256a17f10e6..5c67899d9b8 100644 --- a/assets/js/6494b798.542dea5b.js +++ b/assets/js/6494b798.25e58aff.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[41619],{25093:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>c,contentTitle:()=>o,default:()=>p,frontMatter:()=>a,metadata:()=>r,toc:()=>l});var t=s(24246),i=s(71670);const a={},o="Variable: isWindows",r={id:"namespaces/env/variables/isWindows",title:"Variable: isWindows",description:"const isWindows: boolean",source:"@site/api/namespaces/env/variables/isWindows.md",sourceDirName:"namespaces/env/variables",slug:"/namespaces/env/variables/isWindows",permalink:"/api/namespaces/env/variables/isWindows",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Variable: isTelemetryEnabled",permalink:"/api/namespaces/env/variables/isTelemetryEnabled"},next:{title:"Function: createTelemetryLogger()",permalink:"/api/namespaces/env/functions/createTelemetryLogger"}},c={},l=[{value:"Source",id:"source",level:2}];function d(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,i.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"variable-iswindows",children:"Variable: isWindows"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:(0,t.jsx)(n.code,{children:"const"})})," ",(0,t.jsx)(n.strong,{children:"isWindows"}),": ",(0,t.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"Flag indicating whether we are running on the Windows operating system."}),"\n",(0,t.jsx)(n.p,{children:"If the value of this flag is true, it means the current system is Windows.\nIf the value is false, it means the current system is not Windows."}),"\n",(0,t.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L3675",children:"packages/extension-api/src/extension-api.d.ts:3675"})})]})}function p(e={}){const{wrapper:n}={...(0,i.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(d,{...e})}):d(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>r,a:()=>o});var t=s(27378);const i={},a=t.createContext(i);function o(e){const n=t.useContext(a);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function r(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:o(e.components),t.createElement(a.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[41619],{25093:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>c,contentTitle:()=>o,default:()=>p,frontMatter:()=>a,metadata:()=>r,toc:()=>l});var t=s(24246),i=s(71670);const a={},o="Variable: isWindows",r={id:"namespaces/env/variables/isWindows",title:"Variable: isWindows",description:"const isWindows: boolean",source:"@site/api/namespaces/env/variables/isWindows.md",sourceDirName:"namespaces/env/variables",slug:"/namespaces/env/variables/isWindows",permalink:"/api/namespaces/env/variables/isWindows",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Variable: isTelemetryEnabled",permalink:"/api/namespaces/env/variables/isTelemetryEnabled"},next:{title:"Function: createTelemetryLogger()",permalink:"/api/namespaces/env/functions/createTelemetryLogger"}},c={},l=[{value:"Source",id:"source",level:2}];function d(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,i.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"variable-iswindows",children:"Variable: isWindows"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:(0,t.jsx)(n.code,{children:"const"})})," ",(0,t.jsx)(n.strong,{children:"isWindows"}),": ",(0,t.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"Flag indicating whether we are running on the Windows operating system."}),"\n",(0,t.jsx)(n.p,{children:"If the value of this flag is true, it means the current system is Windows.\nIf the value is false, it means the current system is not Windows."}),"\n",(0,t.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L3675",children:"packages/extension-api/src/extension-api.d.ts:3675"})})]})}function p(e={}){const{wrapper:n}={...(0,i.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(d,{...e})}):d(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>r,a:()=>o});var t=s(27378);const i={},a=t.createContext(i);function o(e){const n=t.useContext(a);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function r(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:o(e.components),t.createElement(a.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/67386898.7394d6c9.js b/assets/js/67386898.c2a2c38c.js similarity index 94% rename from assets/js/67386898.7394d6c9.js rename to assets/js/67386898.c2a2c38c.js index d8d40e92acb..db87826e095 100644 --- a/assets/js/67386898.7394d6c9.js +++ b/assets/js/67386898.c2a2c38c.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[20406],{86600:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>i,default:()=>l,frontMatter:()=>s,metadata:()=>c,toc:()=>d});var r=t(24246),o=t(71670);const s={},i="Interface: VolumeCreateOptions",c={id:"interfaces/VolumeCreateOptions",title:"Interface: VolumeCreateOptions",description:"Properties",source:"@site/api/interfaces/VolumeCreateOptions.md",sourceDirName:"interfaces",slug:"/interfaces/VolumeCreateOptions",permalink:"/api/interfaces/VolumeCreateOptions",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: UpdateKubernetesConnectionEvent",permalink:"/api/interfaces/UpdateKubernetesConnectionEvent"},next:{title:"Interface: VolumeCreateResponseInfo",permalink:"/api/interfaces/VolumeCreateResponseInfo"}},a={},d=[{value:"Properties",id:"properties",level:2},{value:"Name",id:"name",level:3},{value:"Source",id:"source",level:4},{value:"provider?",id:"provider",level:3},{value:"Source",id:"source-1",level:4}];function p(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,o.a)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.h1,{id:"interface-volumecreateoptions",children:"Interface: VolumeCreateOptions"}),"\n",(0,r.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,r.jsx)(n.h3,{id:"name",children:"Name"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"Name"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L3120",children:"packages/extension-api/src/extension-api.d.ts:3120"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"provider",children:"provider?"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"optional"})})," ",(0,r.jsx)(n.strong,{children:"provider"}),": ",(0,r.jsx)(n.a,{href:"/api/interfaces/ContainerProviderConnection",children:(0,r.jsx)(n.code,{children:"ContainerProviderConnection"})})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L3122",children:"packages/extension-api/src/extension-api.d.ts:3122"})})]})}function l(e={}){const{wrapper:n}={...(0,o.a)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(p,{...e})}):p(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>c,a:()=>i});var r=t(27378);const o={},s=r.createContext(o);function i(e){const n=r.useContext(s);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:i(e.components),r.createElement(s.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[20406],{86600:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>i,default:()=>l,frontMatter:()=>s,metadata:()=>c,toc:()=>d});var r=t(24246),o=t(71670);const s={},i="Interface: VolumeCreateOptions",c={id:"interfaces/VolumeCreateOptions",title:"Interface: VolumeCreateOptions",description:"Properties",source:"@site/api/interfaces/VolumeCreateOptions.md",sourceDirName:"interfaces",slug:"/interfaces/VolumeCreateOptions",permalink:"/api/interfaces/VolumeCreateOptions",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: UpdateKubernetesConnectionEvent",permalink:"/api/interfaces/UpdateKubernetesConnectionEvent"},next:{title:"Interface: VolumeCreateResponseInfo",permalink:"/api/interfaces/VolumeCreateResponseInfo"}},a={},d=[{value:"Properties",id:"properties",level:2},{value:"Name",id:"name",level:3},{value:"Source",id:"source",level:4},{value:"provider?",id:"provider",level:3},{value:"Source",id:"source-1",level:4}];function p(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,o.a)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.h1,{id:"interface-volumecreateoptions",children:"Interface: VolumeCreateOptions"}),"\n",(0,r.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,r.jsx)(n.h3,{id:"name",children:"Name"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"Name"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L3120",children:"packages/extension-api/src/extension-api.d.ts:3120"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"provider",children:"provider?"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"optional"})})," ",(0,r.jsx)(n.strong,{children:"provider"}),": ",(0,r.jsx)(n.a,{href:"/api/interfaces/ContainerProviderConnection",children:(0,r.jsx)(n.code,{children:"ContainerProviderConnection"})})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L3122",children:"packages/extension-api/src/extension-api.d.ts:3122"})})]})}function l(e={}){const{wrapper:n}={...(0,o.a)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(p,{...e})}):p(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>c,a:()=>i});var r=t(27378);const o={},s=r.createContext(o);function i(e){const n=r.useContext(s);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:i(e.components),r.createElement(s.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/6763d4e0.fd7e99c8.js b/assets/js/6763d4e0.67e59d17.js similarity index 95% rename from assets/js/6763d4e0.fd7e99c8.js rename to assets/js/6763d4e0.67e59d17.js index e7f216f18e4..9f084179915 100644 --- a/assets/js/6763d4e0.fd7e99c8.js +++ b/assets/js/6763d4e0.67e59d17.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[84513],{35287:(n,e,i)=>{i.r(e),i.d(e,{assets:()=>a,contentTitle:()=>c,default:()=>p,frontMatter:()=>o,metadata:()=>r,toc:()=>d});var t=i(24246),s=i(71670);const o={},c="Function: info()",r={id:"namespaces/containerEngine/functions/info",title:"Function: info()",description:"info(engineId): Promise\\",source:"@site/api/namespaces/containerEngine/functions/info.md",sourceDirName:"namespaces/containerEngine/functions",slug:"/namespaces/containerEngine/functions/info",permalink:"/api/namespaces/containerEngine/functions/info",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Function: getImageInspect()",permalink:"/api/namespaces/containerEngine/functions/getImageInspect"},next:{title:"Function: inspectContainer()",permalink:"/api/namespaces/containerEngine/functions/inspectContainer"}},a={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function u(n){const e={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,s.a)(),...n.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(e.h1,{id:"function-info",children:"Function: info()"}),"\n",(0,t.jsxs)(e.blockquote,{children:["\n",(0,t.jsxs)(e.p,{children:[(0,t.jsx)(e.strong,{children:"info"}),"(",(0,t.jsx)(e.code,{children:"engineId"}),"): ",(0,t.jsx)(e.code,{children:"Promise"}),"< ",(0,t.jsx)(e.a,{href:"/api/interfaces/ContainerEngineInfo",children:(0,t.jsx)(e.code,{children:"ContainerEngineInfo"})})," >"]}),"\n"]}),"\n",(0,t.jsx)(e.h2,{id:"parameters",children:"Parameters"}),"\n",(0,t.jsxs)(e.p,{children:["\u2022 ",(0,t.jsx)(e.strong,{children:"engineId"}),": ",(0,t.jsx)(e.code,{children:"string"})]}),"\n",(0,t.jsx)(e.h2,{id:"returns",children:"Returns"}),"\n",(0,t.jsxs)(e.p,{children:[(0,t.jsx)(e.code,{children:"Promise"}),"< ",(0,t.jsx)(e.a,{href:"/api/interfaces/ContainerEngineInfo",children:(0,t.jsx)(e.code,{children:"ContainerEngineInfo"})})," >"]}),"\n",(0,t.jsx)(e.h2,{id:"source",children:"Source"}),"\n",(0,t.jsx)(e.p,{children:(0,t.jsx)(e.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L3342",children:"packages/extension-api/src/extension-api.d.ts:3342"})})]})}function p(n={}){const{wrapper:e}={...(0,s.a)(),...n.components};return e?(0,t.jsx)(e,{...n,children:(0,t.jsx)(u,{...n})}):u(n)}},71670:(n,e,i)=>{i.d(e,{Z:()=>r,a:()=>c});var t=i(27378);const s={},o=t.createContext(s);function c(n){const e=t.useContext(o);return t.useMemo((function(){return"function"==typeof n?n(e):{...e,...n}}),[e,n])}function r(n){let e;return e=n.disableParentContext?"function"==typeof n.components?n.components(s):n.components||s:c(n.components),t.createElement(o.Provider,{value:e},n.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[84513],{35287:(n,e,i)=>{i.r(e),i.d(e,{assets:()=>a,contentTitle:()=>c,default:()=>p,frontMatter:()=>o,metadata:()=>r,toc:()=>d});var t=i(24246),s=i(71670);const o={},c="Function: info()",r={id:"namespaces/containerEngine/functions/info",title:"Function: info()",description:"info(engineId): Promise\\",source:"@site/api/namespaces/containerEngine/functions/info.md",sourceDirName:"namespaces/containerEngine/functions",slug:"/namespaces/containerEngine/functions/info",permalink:"/api/namespaces/containerEngine/functions/info",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Function: getImageInspect()",permalink:"/api/namespaces/containerEngine/functions/getImageInspect"},next:{title:"Function: inspectContainer()",permalink:"/api/namespaces/containerEngine/functions/inspectContainer"}},a={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function u(n){const e={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,s.a)(),...n.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(e.h1,{id:"function-info",children:"Function: info()"}),"\n",(0,t.jsxs)(e.blockquote,{children:["\n",(0,t.jsxs)(e.p,{children:[(0,t.jsx)(e.strong,{children:"info"}),"(",(0,t.jsx)(e.code,{children:"engineId"}),"): ",(0,t.jsx)(e.code,{children:"Promise"}),"< ",(0,t.jsx)(e.a,{href:"/api/interfaces/ContainerEngineInfo",children:(0,t.jsx)(e.code,{children:"ContainerEngineInfo"})})," >"]}),"\n"]}),"\n",(0,t.jsx)(e.h2,{id:"parameters",children:"Parameters"}),"\n",(0,t.jsxs)(e.p,{children:["\u2022 ",(0,t.jsx)(e.strong,{children:"engineId"}),": ",(0,t.jsx)(e.code,{children:"string"})]}),"\n",(0,t.jsx)(e.h2,{id:"returns",children:"Returns"}),"\n",(0,t.jsxs)(e.p,{children:[(0,t.jsx)(e.code,{children:"Promise"}),"< ",(0,t.jsx)(e.a,{href:"/api/interfaces/ContainerEngineInfo",children:(0,t.jsx)(e.code,{children:"ContainerEngineInfo"})})," >"]}),"\n",(0,t.jsx)(e.h2,{id:"source",children:"Source"}),"\n",(0,t.jsx)(e.p,{children:(0,t.jsx)(e.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L3342",children:"packages/extension-api/src/extension-api.d.ts:3342"})})]})}function p(n={}){const{wrapper:e}={...(0,s.a)(),...n.components};return e?(0,t.jsx)(e,{...n,children:(0,t.jsx)(u,{...n})}):u(n)}},71670:(n,e,i)=>{i.d(e,{Z:()=>r,a:()=>c});var t=i(27378);const s={},o=t.createContext(s);function c(n){const e=t.useContext(o);return t.useMemo((function(){return"function"==typeof n?n(e):{...e,...n}}),[e,n])}function r(n){let e;return e=n.disableParentContext?"function"==typeof n.components?n.components(s):n.components||s:c(n.components),t.createElement(o.Provider,{value:e},n.children)}}}]); \ No newline at end of file diff --git a/assets/js/6774f806.93c6fe56.js b/assets/js/6774f806.9ee49dd1.js similarity index 98% rename from assets/js/6774f806.93c6fe56.js rename to assets/js/6774f806.9ee49dd1.js index 1a241dfa839..2222afd800c 100644 --- a/assets/js/6774f806.93c6fe56.js +++ b/assets/js/6774f806.9ee49dd1.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[35572],{1797:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>a,contentTitle:()=>r,default:()=>u,frontMatter:()=>o,metadata:()=>s,toc:()=>l});var t=i(24246),c=i(71670);const o={},r="Function: pullImage()",s={id:"namespaces/containerEngine/functions/pullImage",title:"Function: pullImage()",description:"pullImage(containerProviderConnection, imageName, callback): Promise\\",source:"@site/api/namespaces/containerEngine/functions/pullImage.md",sourceDirName:"namespaces/containerEngine/functions",slug:"/namespaces/containerEngine/functions/pullImage",permalink:"/api/namespaces/containerEngine/functions/pullImage",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Function: onEvent()",permalink:"/api/namespaces/containerEngine/functions/onEvent"},next:{title:"Function: pushImage()",permalink:"/api/namespaces/containerEngine/functions/pushImage"}},a={},l=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function d(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,c.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"function-pullimage",children:"Function: pullImage()"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"pullImage"}),"(",(0,t.jsx)(n.code,{children:"containerProviderConnection"}),", ",(0,t.jsx)(n.code,{children:"imageName"}),", ",(0,t.jsx)(n.code,{children:"callback"}),"): ",(0,t.jsx)(n.code,{children:"Promise"}),"< ",(0,t.jsx)(n.code,{children:"void"})," >"]}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"Pull an image from a registry"}),"\n",(0,t.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"containerProviderConnection"}),": ",(0,t.jsx)(n.a,{href:"/api/interfaces/ContainerProviderConnection",children:(0,t.jsx)(n.code,{children:"ContainerProviderConnection"})})]}),"\n",(0,t.jsx)(n.p,{children:"the connection to the local engine to use for pulling the image"}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"imageName"}),": ",(0,t.jsx)(n.code,{children:"string"})]}),"\n",(0,t.jsx)(n.p,{children:"the name of the image to pull"}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"callback"})]}),"\n",(0,t.jsx)(n.p,{children:"the function called when new logs are emitted during the pull operation"}),"\n",(0,t.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"Promise"}),"< ",(0,t.jsx)(n.code,{children:"void"})," >"]}),"\n",(0,t.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L3319",children:"packages/extension-api/src/extension-api.d.ts:3319"})})]})}function u(e={}){const{wrapper:n}={...(0,c.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(d,{...e})}):d(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>s,a:()=>r});var t=i(27378);const c={},o=t.createContext(c);function r(e){const n=t.useContext(o);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function s(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(c):e.components||c:r(e.components),t.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[35572],{1797:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>a,contentTitle:()=>r,default:()=>u,frontMatter:()=>o,metadata:()=>s,toc:()=>l});var t=i(24246),c=i(71670);const o={},r="Function: pullImage()",s={id:"namespaces/containerEngine/functions/pullImage",title:"Function: pullImage()",description:"pullImage(containerProviderConnection, imageName, callback): Promise\\",source:"@site/api/namespaces/containerEngine/functions/pullImage.md",sourceDirName:"namespaces/containerEngine/functions",slug:"/namespaces/containerEngine/functions/pullImage",permalink:"/api/namespaces/containerEngine/functions/pullImage",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Function: onEvent()",permalink:"/api/namespaces/containerEngine/functions/onEvent"},next:{title:"Function: pushImage()",permalink:"/api/namespaces/containerEngine/functions/pushImage"}},a={},l=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function d(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,c.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"function-pullimage",children:"Function: pullImage()"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"pullImage"}),"(",(0,t.jsx)(n.code,{children:"containerProviderConnection"}),", ",(0,t.jsx)(n.code,{children:"imageName"}),", ",(0,t.jsx)(n.code,{children:"callback"}),"): ",(0,t.jsx)(n.code,{children:"Promise"}),"< ",(0,t.jsx)(n.code,{children:"void"})," >"]}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"Pull an image from a registry"}),"\n",(0,t.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"containerProviderConnection"}),": ",(0,t.jsx)(n.a,{href:"/api/interfaces/ContainerProviderConnection",children:(0,t.jsx)(n.code,{children:"ContainerProviderConnection"})})]}),"\n",(0,t.jsx)(n.p,{children:"the connection to the local engine to use for pulling the image"}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"imageName"}),": ",(0,t.jsx)(n.code,{children:"string"})]}),"\n",(0,t.jsx)(n.p,{children:"the name of the image to pull"}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"callback"})]}),"\n",(0,t.jsx)(n.p,{children:"the function called when new logs are emitted during the pull operation"}),"\n",(0,t.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"Promise"}),"< ",(0,t.jsx)(n.code,{children:"void"})," >"]}),"\n",(0,t.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L3319",children:"packages/extension-api/src/extension-api.d.ts:3319"})})]})}function u(e={}){const{wrapper:n}={...(0,c.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(d,{...e})}):d(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>s,a:()=>r});var t=i(27378);const c={},o=t.createContext(c);function r(e){const n=t.useContext(o);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function s(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(c):e.components||c:r(e.components),t.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/67eba1be.5ae1a8ca.js b/assets/js/67eba1be.86b64c58.js similarity index 91% rename from assets/js/67eba1be.5ae1a8ca.js rename to assets/js/67eba1be.86b64c58.js index 64eb0f338bf..2500831ee15 100644 --- a/assets/js/67eba1be.5ae1a8ca.js +++ b/assets/js/67eba1be.86b64c58.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[52950],{61902:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>r,default:()=>h,frontMatter:()=>o,metadata:()=>c,toc:()=>d});var s=t(24246),i=t(71670);const o={},r="Interface: Command",c={id:"interfaces/Command",title:"Interface: Command",description:"Represents a reference to a command. Provides a title which",source:"@site/api/interfaces/Command.md",sourceDirName:"interfaces",slug:"/interfaces/Command",permalink:"/api/interfaces/Command",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: Clipboard",permalink:"/api/interfaces/Clipboard"},next:{title:"Interface: Configuration",permalink:"/api/interfaces/Configuration"}},a={},d=[{value:"Properties",id:"properties",level:2},{value:"arguments?",id:"arguments",level:3},{value:"Source",id:"source",level:4},{value:"command",id:"command",level:3},{value:"Source",id:"source-1",level:4},{value:"title",id:"title",level:3},{value:"Source",id:"source-2",level:4},{value:"tooltip?",id:"tooltip",level:3},{value:"Source",id:"source-3",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,i.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"interface-command",children:"Interface: Command"}),"\n",(0,s.jsx)(n.p,{children:"Represents a reference to a command. Provides a title which\nwill be used to represent a command in the UI and, optionally,\nan array of arguments which will be passed to the command handler\nfunction when invoked."}),"\n",(0,s.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,s.jsx)(n.h3,{id:"arguments",children:"arguments?"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:(0,s.jsx)(n.code,{children:"optional"})})," ",(0,s.jsx)(n.strong,{children:"arguments"}),": ",(0,s.jsx)(n.code,{children:"any"}),"[]"]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L36",children:"packages/extension-api/src/extension-api.d.ts:36"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"command",children:"command"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"command"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L33",children:"packages/extension-api/src/extension-api.d.ts:33"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"title",children:"title"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"title"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L32",children:"packages/extension-api/src/extension-api.d.ts:32"})}),"\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.strong,{children:(0,s.jsx)(n.code,{children:"optional"})})," ",(0,s.jsx)(n.strong,{children:"tooltip"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L34",children:"packages/extension-api/src/extension-api.d.ts:34"})})]})}function h(e={}){const{wrapper:n}={...(0,i.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>c,a:()=>r});var s=t(27378);const i={},o=s.createContext(i);function r(e){const n=s.useContext(o);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:r(e.components),s.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[52950],{61902:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>r,default:()=>h,frontMatter:()=>o,metadata:()=>c,toc:()=>d});var s=t(24246),i=t(71670);const o={},r="Interface: Command",c={id:"interfaces/Command",title:"Interface: Command",description:"Represents a reference to a command. Provides a title which",source:"@site/api/interfaces/Command.md",sourceDirName:"interfaces",slug:"/interfaces/Command",permalink:"/api/interfaces/Command",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: Clipboard",permalink:"/api/interfaces/Clipboard"},next:{title:"Interface: Configuration",permalink:"/api/interfaces/Configuration"}},a={},d=[{value:"Properties",id:"properties",level:2},{value:"arguments?",id:"arguments",level:3},{value:"Source",id:"source",level:4},{value:"command",id:"command",level:3},{value:"Source",id:"source-1",level:4},{value:"title",id:"title",level:3},{value:"Source",id:"source-2",level:4},{value:"tooltip?",id:"tooltip",level:3},{value:"Source",id:"source-3",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,i.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"interface-command",children:"Interface: Command"}),"\n",(0,s.jsx)(n.p,{children:"Represents a reference to a command. Provides a title which\nwill be used to represent a command in the UI and, optionally,\nan array of arguments which will be passed to the command handler\nfunction when invoked."}),"\n",(0,s.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,s.jsx)(n.h3,{id:"arguments",children:"arguments?"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:(0,s.jsx)(n.code,{children:"optional"})})," ",(0,s.jsx)(n.strong,{children:"arguments"}),": ",(0,s.jsx)(n.code,{children:"any"}),"[]"]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L36",children:"packages/extension-api/src/extension-api.d.ts:36"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"command",children:"command"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"command"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L33",children:"packages/extension-api/src/extension-api.d.ts:33"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"title",children:"title"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"title"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L32",children:"packages/extension-api/src/extension-api.d.ts:32"})}),"\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.strong,{children:(0,s.jsx)(n.code,{children:"optional"})})," ",(0,s.jsx)(n.strong,{children:"tooltip"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L34",children:"packages/extension-api/src/extension-api.d.ts:34"})})]})}function h(e={}){const{wrapper:n}={...(0,i.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>c,a:()=>r});var s=t(27378);const i={},o=s.createContext(i);function r(e){const n=s.useContext(o);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:r(e.components),s.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/67fccd64.93652144.js b/assets/js/67fccd64.3f6541ed.js similarity index 84% rename from assets/js/67fccd64.93652144.js rename to assets/js/67fccd64.3f6541ed.js index 772065dc143..45c585f73cf 100644 --- a/assets/js/67fccd64.93652144.js +++ b/assets/js/67fccd64.3f6541ed.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[77319],{37186:(e,s,n)=>{n.r(s),n.d(s,{assets:()=>a,contentTitle:()=>r,default:()=>h,frontMatter:()=>c,metadata:()=>o,toc:()=>d});var t=n(24246),i=n(71670);const c={},r="Interface: ContainerStatsInfo",o={id:"interfaces/ContainerStatsInfo",title:"Interface: ContainerStatsInfo",description:"Properties",source:"@site/api/interfaces/ContainerStatsInfo.md",sourceDirName:"interfaces",slug:"/interfaces/ContainerStatsInfo",permalink:"/api/interfaces/ContainerStatsInfo",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: ContainerProviderConnectionFactory",permalink:"/api/interfaces/ContainerProviderConnectionFactory"},next:{title:"Interface: CustomPick\\",permalink:"/api/interfaces/CustomPick"}},a={},d=[{value:"Properties",id:"properties",level:2},{value:"blkio_stats?",id:"blkio_stats",level:3},{value:"Source",id:"source",level:4},{value:"cpu_stats",id:"cpu_stats",level:3},{value:"Source",id:"source-1",level:4},{value:"engineId",id:"engineid",level:3},{value:"Source",id:"source-2",level:4},{value:"engineName",id:"enginename",level:3},{value:"Source",id:"source-3",level:4},{value:"memory_stats",id:"memory_stats",level:3},{value:"Source",id:"source-4",level:4},{value:"networks",id:"networks",level:3},{value:"Source",id:"source-5",level:4},{value:"num_procs",id:"num_procs",level:3},{value:"Source",id:"source-6",level:4},{value:"pids_stats?",id:"pids_stats",level:3},{value:"Source",id:"source-7",level:4},{value:"precpu_stats",id:"precpu_stats",level:3},{value:"Source",id:"source-8",level:4},{value:"preread",id:"preread",level:3},{value:"Source",id:"source-9",level:4},{value:"read",id:"read",level:3},{value:"Source",id:"source-10",level:4},{value:"storage_stats?",id:"storage_stats",level:3},{value:"Source",id:"source-11",level:4}];function l(e){const s={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,i.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(s.h1,{id:"interface-containerstatsinfo",children:"Interface: ContainerStatsInfo"}),"\n",(0,t.jsx)(s.h2,{id:"properties",children:"Properties"}),"\n",(0,t.jsx)(s.h3,{id:"blkio_stats",children:"blkio_stats?"}),"\n",(0,t.jsxs)(s.blockquote,{children:["\n",(0,t.jsxs)(s.p,{children:[(0,t.jsx)(s.strong,{children:(0,t.jsx)(s.code,{children:"optional"})})," ",(0,t.jsx)(s.strong,{children:"blkio_stats"}),": ",(0,t.jsx)(s.a,{href:"/api/interfaces/BlkioStats",children:(0,t.jsx)(s.code,{children:"BlkioStats"})})]}),"\n"]}),"\n",(0,t.jsx)(s.h4,{id:"source",children:"Source"}),"\n",(0,t.jsx)(s.p,{children:(0,t.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2873",children:"packages/extension-api/src/extension-api.d.ts:2873"})}),"\n",(0,t.jsx)(s.hr,{}),"\n",(0,t.jsx)(s.h3,{id:"cpu_stats",children:"cpu_stats"}),"\n",(0,t.jsxs)(s.blockquote,{children:["\n",(0,t.jsxs)(s.p,{children:[(0,t.jsx)(s.strong,{children:"cpu_stats"}),": ",(0,t.jsx)(s.a,{href:"/api/interfaces/CPUStats",children:(0,t.jsx)(s.code,{children:"CPUStats"})})]}),"\n"]}),"\n",(0,t.jsx)(s.h4,{id:"source-1",children:"Source"}),"\n",(0,t.jsx)(s.p,{children:(0,t.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2878",children:"packages/extension-api/src/extension-api.d.ts:2878"})}),"\n",(0,t.jsx)(s.hr,{}),"\n",(0,t.jsx)(s.h3,{id:"engineid",children:"engineId"}),"\n",(0,t.jsxs)(s.blockquote,{children:["\n",(0,t.jsxs)(s.p,{children:[(0,t.jsx)(s.strong,{children:"engineId"}),": ",(0,t.jsx)(s.code,{children:"string"})]}),"\n"]}),"\n",(0,t.jsx)(s.h4,{id:"source-2",children:"Source"}),"\n",(0,t.jsx)(s.p,{children:(0,t.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2868",children:"packages/extension-api/src/extension-api.d.ts:2868"})}),"\n",(0,t.jsx)(s.hr,{}),"\n",(0,t.jsx)(s.h3,{id:"enginename",children:"engineName"}),"\n",(0,t.jsxs)(s.blockquote,{children:["\n",(0,t.jsxs)(s.p,{children:[(0,t.jsx)(s.strong,{children:"engineName"}),": ",(0,t.jsx)(s.code,{children:"string"})]}),"\n"]}),"\n",(0,t.jsx)(s.h4,{id:"source-3",children:"Source"}),"\n",(0,t.jsx)(s.p,{children:(0,t.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2869",children:"packages/extension-api/src/extension-api.d.ts:2869"})}),"\n",(0,t.jsx)(s.hr,{}),"\n",(0,t.jsx)(s.h3,{id:"memory_stats",children:"memory_stats"}),"\n",(0,t.jsxs)(s.blockquote,{children:["\n",(0,t.jsxs)(s.p,{children:[(0,t.jsx)(s.strong,{children:"memory_stats"}),": ",(0,t.jsx)(s.a,{href:"/api/interfaces/MemoryStats",children:(0,t.jsx)(s.code,{children:"MemoryStats"})})]}),"\n"]}),"\n",(0,t.jsx)(s.h4,{id:"source-4",children:"Source"}),"\n",(0,t.jsx)(s.p,{children:(0,t.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2877",children:"packages/extension-api/src/extension-api.d.ts:2877"})}),"\n",(0,t.jsx)(s.hr,{}),"\n",(0,t.jsx)(s.h3,{id:"networks",children:"networks"}),"\n",(0,t.jsxs)(s.blockquote,{children:["\n",(0,t.jsxs)(s.p,{children:[(0,t.jsx)(s.strong,{children:"networks"}),": ",(0,t.jsx)(s.a,{href:"/api/interfaces/NetworkStats",children:(0,t.jsx)(s.code,{children:"NetworkStats"})})]}),"\n"]}),"\n",(0,t.jsx)(s.h4,{id:"source-5",children:"Source"}),"\n",(0,t.jsx)(s.p,{children:(0,t.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2876",children:"packages/extension-api/src/extension-api.d.ts:2876"})}),"\n",(0,t.jsx)(s.hr,{}),"\n",(0,t.jsx)(s.h3,{id:"num_procs",children:"num_procs"}),"\n",(0,t.jsxs)(s.blockquote,{children:["\n",(0,t.jsxs)(s.p,{children:[(0,t.jsx)(s.strong,{children:"num_procs"}),": ",(0,t.jsx)(s.code,{children:"number"})]}),"\n"]}),"\n",(0,t.jsx)(s.h4,{id:"source-6",children:"Source"}),"\n",(0,t.jsx)(s.p,{children:(0,t.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2874",children:"packages/extension-api/src/extension-api.d.ts:2874"})}),"\n",(0,t.jsx)(s.hr,{}),"\n",(0,t.jsx)(s.h3,{id:"pids_stats",children:"pids_stats?"}),"\n",(0,t.jsxs)(s.blockquote,{children:["\n",(0,t.jsxs)(s.p,{children:[(0,t.jsx)(s.strong,{children:(0,t.jsx)(s.code,{children:"optional"})})," ",(0,t.jsx)(s.strong,{children:"pids_stats"}),": ",(0,t.jsx)(s.a,{href:"/api/interfaces/PidsStats",children:(0,t.jsx)(s.code,{children:"PidsStats"})})]}),"\n"]}),"\n",(0,t.jsx)(s.h4,{id:"source-7",children:"Source"}),"\n",(0,t.jsx)(s.p,{children:(0,t.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2872",children:"packages/extension-api/src/extension-api.d.ts:2872"})}),"\n",(0,t.jsx)(s.hr,{}),"\n",(0,t.jsx)(s.h3,{id:"precpu_stats",children:"precpu_stats"}),"\n",(0,t.jsxs)(s.blockquote,{children:["\n",(0,t.jsxs)(s.p,{children:[(0,t.jsx)(s.strong,{children:"precpu_stats"}),": ",(0,t.jsx)(s.a,{href:"/api/interfaces/CPUStats",children:(0,t.jsx)(s.code,{children:"CPUStats"})})]}),"\n"]}),"\n",(0,t.jsx)(s.h4,{id:"source-8",children:"Source"}),"\n",(0,t.jsx)(s.p,{children:(0,t.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2879",children:"packages/extension-api/src/extension-api.d.ts:2879"})}),"\n",(0,t.jsx)(s.hr,{}),"\n",(0,t.jsx)(s.h3,{id:"preread",children:"preread"}),"\n",(0,t.jsxs)(s.blockquote,{children:["\n",(0,t.jsxs)(s.p,{children:[(0,t.jsx)(s.strong,{children:"preread"}),": ",(0,t.jsx)(s.code,{children:"string"})]}),"\n"]}),"\n",(0,t.jsx)(s.h4,{id:"source-9",children:"Source"}),"\n",(0,t.jsx)(s.p,{children:(0,t.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2871",children:"packages/extension-api/src/extension-api.d.ts:2871"})}),"\n",(0,t.jsx)(s.hr,{}),"\n",(0,t.jsx)(s.h3,{id:"read",children:"read"}),"\n",(0,t.jsxs)(s.blockquote,{children:["\n",(0,t.jsxs)(s.p,{children:[(0,t.jsx)(s.strong,{children:"read"}),": ",(0,t.jsx)(s.code,{children:"string"})]}),"\n"]}),"\n",(0,t.jsx)(s.h4,{id:"source-10",children:"Source"}),"\n",(0,t.jsx)(s.p,{children:(0,t.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2870",children:"packages/extension-api/src/extension-api.d.ts:2870"})}),"\n",(0,t.jsx)(s.hr,{}),"\n",(0,t.jsx)(s.h3,{id:"storage_stats",children:"storage_stats?"}),"\n",(0,t.jsxs)(s.blockquote,{children:["\n",(0,t.jsxs)(s.p,{children:[(0,t.jsx)(s.strong,{children:(0,t.jsx)(s.code,{children:"optional"})})," ",(0,t.jsx)(s.strong,{children:"storage_stats"}),": ",(0,t.jsx)(s.a,{href:"/api/interfaces/StorageStats",children:(0,t.jsx)(s.code,{children:"StorageStats"})})]}),"\n"]}),"\n",(0,t.jsx)(s.h4,{id:"source-11",children:"Source"}),"\n",(0,t.jsx)(s.p,{children:(0,t.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2875",children:"packages/extension-api/src/extension-api.d.ts:2875"})})]})}function h(e={}){const{wrapper:s}={...(0,i.a)(),...e.components};return s?(0,t.jsx)(s,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},71670:(e,s,n)=>{n.d(s,{Z:()=>o,a:()=>r});var t=n(27378);const i={},c=t.createContext(i);function r(e){const s=t.useContext(c);return t.useMemo((function(){return"function"==typeof e?e(s):{...s,...e}}),[s,e])}function o(e){let s;return s=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:r(e.components),t.createElement(c.Provider,{value:s},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[77319],{37186:(e,s,n)=>{n.r(s),n.d(s,{assets:()=>a,contentTitle:()=>c,default:()=>h,frontMatter:()=>r,metadata:()=>o,toc:()=>d});var t=n(24246),i=n(71670);const r={},c="Interface: ContainerStatsInfo",o={id:"interfaces/ContainerStatsInfo",title:"Interface: ContainerStatsInfo",description:"Properties",source:"@site/api/interfaces/ContainerStatsInfo.md",sourceDirName:"interfaces",slug:"/interfaces/ContainerStatsInfo",permalink:"/api/interfaces/ContainerStatsInfo",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: ContainerProviderConnectionFactory",permalink:"/api/interfaces/ContainerProviderConnectionFactory"},next:{title:"Interface: CustomPick\\",permalink:"/api/interfaces/CustomPick"}},a={},d=[{value:"Properties",id:"properties",level:2},{value:"blkio_stats?",id:"blkio_stats",level:3},{value:"Source",id:"source",level:4},{value:"cpu_stats",id:"cpu_stats",level:3},{value:"Source",id:"source-1",level:4},{value:"engineId",id:"engineid",level:3},{value:"Source",id:"source-2",level:4},{value:"engineName",id:"enginename",level:3},{value:"Source",id:"source-3",level:4},{value:"memory_stats",id:"memory_stats",level:3},{value:"Source",id:"source-4",level:4},{value:"networks",id:"networks",level:3},{value:"Source",id:"source-5",level:4},{value:"num_procs",id:"num_procs",level:3},{value:"Source",id:"source-6",level:4},{value:"pids_stats?",id:"pids_stats",level:3},{value:"Source",id:"source-7",level:4},{value:"precpu_stats",id:"precpu_stats",level:3},{value:"Source",id:"source-8",level:4},{value:"preread",id:"preread",level:3},{value:"Source",id:"source-9",level:4},{value:"read",id:"read",level:3},{value:"Source",id:"source-10",level:4},{value:"storage_stats?",id:"storage_stats",level:3},{value:"Source",id:"source-11",level:4}];function l(e){const s={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,i.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(s.h1,{id:"interface-containerstatsinfo",children:"Interface: ContainerStatsInfo"}),"\n",(0,t.jsx)(s.h2,{id:"properties",children:"Properties"}),"\n",(0,t.jsx)(s.h3,{id:"blkio_stats",children:"blkio_stats?"}),"\n",(0,t.jsxs)(s.blockquote,{children:["\n",(0,t.jsxs)(s.p,{children:[(0,t.jsx)(s.strong,{children:(0,t.jsx)(s.code,{children:"optional"})})," ",(0,t.jsx)(s.strong,{children:"blkio_stats"}),": ",(0,t.jsx)(s.a,{href:"/api/interfaces/BlkioStats",children:(0,t.jsx)(s.code,{children:"BlkioStats"})})]}),"\n"]}),"\n",(0,t.jsx)(s.h4,{id:"source",children:"Source"}),"\n",(0,t.jsx)(s.p,{children:(0,t.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2873",children:"packages/extension-api/src/extension-api.d.ts:2873"})}),"\n",(0,t.jsx)(s.hr,{}),"\n",(0,t.jsx)(s.h3,{id:"cpu_stats",children:"cpu_stats"}),"\n",(0,t.jsxs)(s.blockquote,{children:["\n",(0,t.jsxs)(s.p,{children:[(0,t.jsx)(s.strong,{children:"cpu_stats"}),": ",(0,t.jsx)(s.a,{href:"/api/interfaces/CPUStats",children:(0,t.jsx)(s.code,{children:"CPUStats"})})]}),"\n"]}),"\n",(0,t.jsx)(s.h4,{id:"source-1",children:"Source"}),"\n",(0,t.jsx)(s.p,{children:(0,t.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2878",children:"packages/extension-api/src/extension-api.d.ts:2878"})}),"\n",(0,t.jsx)(s.hr,{}),"\n",(0,t.jsx)(s.h3,{id:"engineid",children:"engineId"}),"\n",(0,t.jsxs)(s.blockquote,{children:["\n",(0,t.jsxs)(s.p,{children:[(0,t.jsx)(s.strong,{children:"engineId"}),": ",(0,t.jsx)(s.code,{children:"string"})]}),"\n"]}),"\n",(0,t.jsx)(s.h4,{id:"source-2",children:"Source"}),"\n",(0,t.jsx)(s.p,{children:(0,t.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2868",children:"packages/extension-api/src/extension-api.d.ts:2868"})}),"\n",(0,t.jsx)(s.hr,{}),"\n",(0,t.jsx)(s.h3,{id:"enginename",children:"engineName"}),"\n",(0,t.jsxs)(s.blockquote,{children:["\n",(0,t.jsxs)(s.p,{children:[(0,t.jsx)(s.strong,{children:"engineName"}),": ",(0,t.jsx)(s.code,{children:"string"})]}),"\n"]}),"\n",(0,t.jsx)(s.h4,{id:"source-3",children:"Source"}),"\n",(0,t.jsx)(s.p,{children:(0,t.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2869",children:"packages/extension-api/src/extension-api.d.ts:2869"})}),"\n",(0,t.jsx)(s.hr,{}),"\n",(0,t.jsx)(s.h3,{id:"memory_stats",children:"memory_stats"}),"\n",(0,t.jsxs)(s.blockquote,{children:["\n",(0,t.jsxs)(s.p,{children:[(0,t.jsx)(s.strong,{children:"memory_stats"}),": ",(0,t.jsx)(s.a,{href:"/api/interfaces/MemoryStats",children:(0,t.jsx)(s.code,{children:"MemoryStats"})})]}),"\n"]}),"\n",(0,t.jsx)(s.h4,{id:"source-4",children:"Source"}),"\n",(0,t.jsx)(s.p,{children:(0,t.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2877",children:"packages/extension-api/src/extension-api.d.ts:2877"})}),"\n",(0,t.jsx)(s.hr,{}),"\n",(0,t.jsx)(s.h3,{id:"networks",children:"networks"}),"\n",(0,t.jsxs)(s.blockquote,{children:["\n",(0,t.jsxs)(s.p,{children:[(0,t.jsx)(s.strong,{children:"networks"}),": ",(0,t.jsx)(s.a,{href:"/api/interfaces/NetworkStats",children:(0,t.jsx)(s.code,{children:"NetworkStats"})})]}),"\n"]}),"\n",(0,t.jsx)(s.h4,{id:"source-5",children:"Source"}),"\n",(0,t.jsx)(s.p,{children:(0,t.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2876",children:"packages/extension-api/src/extension-api.d.ts:2876"})}),"\n",(0,t.jsx)(s.hr,{}),"\n",(0,t.jsx)(s.h3,{id:"num_procs",children:"num_procs"}),"\n",(0,t.jsxs)(s.blockquote,{children:["\n",(0,t.jsxs)(s.p,{children:[(0,t.jsx)(s.strong,{children:"num_procs"}),": ",(0,t.jsx)(s.code,{children:"number"})]}),"\n"]}),"\n",(0,t.jsx)(s.h4,{id:"source-6",children:"Source"}),"\n",(0,t.jsx)(s.p,{children:(0,t.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2874",children:"packages/extension-api/src/extension-api.d.ts:2874"})}),"\n",(0,t.jsx)(s.hr,{}),"\n",(0,t.jsx)(s.h3,{id:"pids_stats",children:"pids_stats?"}),"\n",(0,t.jsxs)(s.blockquote,{children:["\n",(0,t.jsxs)(s.p,{children:[(0,t.jsx)(s.strong,{children:(0,t.jsx)(s.code,{children:"optional"})})," ",(0,t.jsx)(s.strong,{children:"pids_stats"}),": ",(0,t.jsx)(s.a,{href:"/api/interfaces/PidsStats",children:(0,t.jsx)(s.code,{children:"PidsStats"})})]}),"\n"]}),"\n",(0,t.jsx)(s.h4,{id:"source-7",children:"Source"}),"\n",(0,t.jsx)(s.p,{children:(0,t.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2872",children:"packages/extension-api/src/extension-api.d.ts:2872"})}),"\n",(0,t.jsx)(s.hr,{}),"\n",(0,t.jsx)(s.h3,{id:"precpu_stats",children:"precpu_stats"}),"\n",(0,t.jsxs)(s.blockquote,{children:["\n",(0,t.jsxs)(s.p,{children:[(0,t.jsx)(s.strong,{children:"precpu_stats"}),": ",(0,t.jsx)(s.a,{href:"/api/interfaces/CPUStats",children:(0,t.jsx)(s.code,{children:"CPUStats"})})]}),"\n"]}),"\n",(0,t.jsx)(s.h4,{id:"source-8",children:"Source"}),"\n",(0,t.jsx)(s.p,{children:(0,t.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2879",children:"packages/extension-api/src/extension-api.d.ts:2879"})}),"\n",(0,t.jsx)(s.hr,{}),"\n",(0,t.jsx)(s.h3,{id:"preread",children:"preread"}),"\n",(0,t.jsxs)(s.blockquote,{children:["\n",(0,t.jsxs)(s.p,{children:[(0,t.jsx)(s.strong,{children:"preread"}),": ",(0,t.jsx)(s.code,{children:"string"})]}),"\n"]}),"\n",(0,t.jsx)(s.h4,{id:"source-9",children:"Source"}),"\n",(0,t.jsx)(s.p,{children:(0,t.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2871",children:"packages/extension-api/src/extension-api.d.ts:2871"})}),"\n",(0,t.jsx)(s.hr,{}),"\n",(0,t.jsx)(s.h3,{id:"read",children:"read"}),"\n",(0,t.jsxs)(s.blockquote,{children:["\n",(0,t.jsxs)(s.p,{children:[(0,t.jsx)(s.strong,{children:"read"}),": ",(0,t.jsx)(s.code,{children:"string"})]}),"\n"]}),"\n",(0,t.jsx)(s.h4,{id:"source-10",children:"Source"}),"\n",(0,t.jsx)(s.p,{children:(0,t.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2870",children:"packages/extension-api/src/extension-api.d.ts:2870"})}),"\n",(0,t.jsx)(s.hr,{}),"\n",(0,t.jsx)(s.h3,{id:"storage_stats",children:"storage_stats?"}),"\n",(0,t.jsxs)(s.blockquote,{children:["\n",(0,t.jsxs)(s.p,{children:[(0,t.jsx)(s.strong,{children:(0,t.jsx)(s.code,{children:"optional"})})," ",(0,t.jsx)(s.strong,{children:"storage_stats"}),": ",(0,t.jsx)(s.a,{href:"/api/interfaces/StorageStats",children:(0,t.jsx)(s.code,{children:"StorageStats"})})]}),"\n"]}),"\n",(0,t.jsx)(s.h4,{id:"source-11",children:"Source"}),"\n",(0,t.jsx)(s.p,{children:(0,t.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2875",children:"packages/extension-api/src/extension-api.d.ts:2875"})})]})}function h(e={}){const{wrapper:s}={...(0,i.a)(),...e.components};return s?(0,t.jsx)(s,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},71670:(e,s,n)=>{n.d(s,{Z:()=>o,a:()=>c});var t=n(27378);const i={},r=t.createContext(i);function c(e){const s=t.useContext(r);return t.useMemo((function(){return"function"==typeof e?e(s):{...s,...e}}),[s,e])}function o(e){let s;return s=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:c(e.components),t.createElement(r.Provider,{value:s},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/688ee267.9fc5aec0.js b/assets/js/688ee267.8f8d5f25.js similarity index 96% rename from assets/js/688ee267.9fc5aec0.js rename to assets/js/688ee267.8f8d5f25.js index e45a7254419..ce9993802c2 100644 --- a/assets/js/688ee267.9fc5aec0.js +++ b/assets/js/688ee267.8f8d5f25.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[17708],{44466:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>r,contentTitle:()=>a,default:()=>l,frontMatter:()=>o,metadata:()=>c,toc:()=>d});var i=s(24246),t=s(71670);const o={},a="Function: onDidChangeSessions()",c={id:"namespaces/authentication/functions/onDidChangeSessions",title:"Function: onDidChangeSessions()",description:"onDidChangeSessions(listener, thisArgs?, disposables?): Disposable",source:"@site/api/namespaces/authentication/functions/onDidChangeSessions.md",sourceDirName:"namespaces/authentication/functions",slug:"/namespaces/authentication/functions/onDidChangeSessions",permalink:"/api/namespaces/authentication/functions/onDidChangeSessions",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Function: getSession()",permalink:"/api/namespaces/authentication/functions/getSession"},next:{title:"Function: registerAuthenticationProvider()",permalink:"/api/namespaces/authentication/functions/registerAuthenticationProvider"}},r={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function h(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,t.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"function-ondidchangesessions",children:"Function: onDidChangeSessions()"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"onDidChangeSessions"}),"(",(0,i.jsx)(n.code,{children:"listener"}),", ",(0,i.jsx)(n.code,{children:"thisArgs"}),"?, ",(0,i.jsx)(n.code,{children:"disposables"}),"?): ",(0,i.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(n.code,{children:"Disposable"})})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["An ",(0,i.jsx)(n.a,{href:"#Event",children:"event"})," which fires when the authentication sessions of an authentication provider have\nbeen added, removed, or changed."]}),"\n",(0,i.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"listener"})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"thisArgs?"}),": ",(0,i.jsx)(n.code,{children:"any"})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"disposables?"}),": ",(0,i.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(n.code,{children:"Disposable"})}),"[]"]}),"\n",(0,i.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(n.code,{children:"Disposable"})})}),"\n",(0,i.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L3635",children:"packages/extension-api/src/extension-api.d.ts:3635"})})]})}function l(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(h,{...e})}):h(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>c,a:()=>a});var i=s(27378);const t={},o=i.createContext(t);function a(e){const n=i.useContext(o);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:a(e.components),i.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[17708],{44466:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>r,contentTitle:()=>a,default:()=>l,frontMatter:()=>o,metadata:()=>c,toc:()=>d});var i=s(24246),t=s(71670);const o={},a="Function: onDidChangeSessions()",c={id:"namespaces/authentication/functions/onDidChangeSessions",title:"Function: onDidChangeSessions()",description:"onDidChangeSessions(listener, thisArgs?, disposables?): Disposable",source:"@site/api/namespaces/authentication/functions/onDidChangeSessions.md",sourceDirName:"namespaces/authentication/functions",slug:"/namespaces/authentication/functions/onDidChangeSessions",permalink:"/api/namespaces/authentication/functions/onDidChangeSessions",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Function: getSession()",permalink:"/api/namespaces/authentication/functions/getSession"},next:{title:"Function: registerAuthenticationProvider()",permalink:"/api/namespaces/authentication/functions/registerAuthenticationProvider"}},r={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function h(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,t.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"function-ondidchangesessions",children:"Function: onDidChangeSessions()"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"onDidChangeSessions"}),"(",(0,i.jsx)(n.code,{children:"listener"}),", ",(0,i.jsx)(n.code,{children:"thisArgs"}),"?, ",(0,i.jsx)(n.code,{children:"disposables"}),"?): ",(0,i.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(n.code,{children:"Disposable"})})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["An ",(0,i.jsx)(n.a,{href:"#Event",children:"event"})," which fires when the authentication sessions of an authentication provider have\nbeen added, removed, or changed."]}),"\n",(0,i.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"listener"})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"thisArgs?"}),": ",(0,i.jsx)(n.code,{children:"any"})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"disposables?"}),": ",(0,i.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(n.code,{children:"Disposable"})}),"[]"]}),"\n",(0,i.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(n.code,{children:"Disposable"})})}),"\n",(0,i.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L3635",children:"packages/extension-api/src/extension-api.d.ts:3635"})})]})}function l(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(h,{...e})}):h(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>c,a:()=>a});var i=s(27378);const t={},o=i.createContext(t);function a(e){const n=i.useContext(o);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:a(e.components),i.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/6a1fe514.085c2aa8.js b/assets/js/6a1fe514.ba067b5b.js similarity index 91% rename from assets/js/6a1fe514.085c2aa8.js rename to assets/js/6a1fe514.ba067b5b.js index c8bafe740bd..5446662bacc 100644 --- a/assets/js/6a1fe514.085c2aa8.js +++ b/assets/js/6a1fe514.ba067b5b.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[96017],{15369:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>d,contentTitle:()=>c,default:()=>u,frontMatter:()=>i,metadata:()=>o,toc:()=>a});var s=r(24246),t=r(71670);const i={},c="Interface: RegistrySuggestedProvider",o={id:"interfaces/RegistrySuggestedProvider",title:"Interface: RegistrySuggestedProvider",description:"Properties",source:"@site/api/interfaces/RegistrySuggestedProvider.md",sourceDirName:"interfaces",slug:"/interfaces/RegistrySuggestedProvider",permalink:"/api/interfaces/RegistrySuggestedProvider",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: RegistryProvider",permalink:"/api/interfaces/RegistryProvider"},next:{title:"Interface: RunError",permalink:"/api/interfaces/RunError"}},d={},a=[{value:"Properties",id:"properties",level:2},{value:"icon?",id:"icon",level:3},{value:"Source",id:"source",level:4},{value:"name",id:"name",level:3},{value:"Source",id:"source-1",level:4},{value:"url",id:"url",level:3},{value:"Source",id:"source-2",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,t.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"interface-registrysuggestedprovider",children:"Interface: RegistrySuggestedProvider"}),"\n",(0,s.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,s.jsx)(n.h3,{id:"icon",children:"icon?"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:(0,s.jsx)(n.code,{children:"optional"})})," ",(0,s.jsx)(n.strong,{children:"icon"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/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:"name",children:"name"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"name"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/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:"url",children:"url"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"url"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L589",children:"packages/extension-api/src/extension-api.d.ts:589"})})]})}function u(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},71670:(e,n,r)=>{r.d(n,{Z:()=>o,a:()=>c});var s=r(27378);const t={},i=s.createContext(t);function c(e){const n=s.useContext(i);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:c(e.components),s.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[96017],{15369:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>d,contentTitle:()=>c,default:()=>u,frontMatter:()=>i,metadata:()=>o,toc:()=>a});var s=r(24246),t=r(71670);const i={},c="Interface: RegistrySuggestedProvider",o={id:"interfaces/RegistrySuggestedProvider",title:"Interface: RegistrySuggestedProvider",description:"Properties",source:"@site/api/interfaces/RegistrySuggestedProvider.md",sourceDirName:"interfaces",slug:"/interfaces/RegistrySuggestedProvider",permalink:"/api/interfaces/RegistrySuggestedProvider",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: RegistryProvider",permalink:"/api/interfaces/RegistryProvider"},next:{title:"Interface: RunError",permalink:"/api/interfaces/RunError"}},d={},a=[{value:"Properties",id:"properties",level:2},{value:"icon?",id:"icon",level:3},{value:"Source",id:"source",level:4},{value:"name",id:"name",level:3},{value:"Source",id:"source-1",level:4},{value:"url",id:"url",level:3},{value:"Source",id:"source-2",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,t.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"interface-registrysuggestedprovider",children:"Interface: RegistrySuggestedProvider"}),"\n",(0,s.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,s.jsx)(n.h3,{id:"icon",children:"icon?"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:(0,s.jsx)(n.code,{children:"optional"})})," ",(0,s.jsx)(n.strong,{children:"icon"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/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:"name",children:"name"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"name"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/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:"url",children:"url"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"url"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L589",children:"packages/extension-api/src/extension-api.d.ts:589"})})]})}function u(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},71670:(e,n,r)=>{r.d(n,{Z:()=>o,a:()=>c});var s=r(27378);const t={},i=s.createContext(t);function c(e){const n=s.useContext(i);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:c(e.components),s.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/6aa0b043.22a2843d.js b/assets/js/6aa0b043.67706045.js similarity index 84% rename from assets/js/6aa0b043.22a2843d.js rename to assets/js/6aa0b043.67706045.js index 154274b0631..10c585a0065 100644 --- a/assets/js/6aa0b043.22a2843d.js +++ b/assets/js/6aa0b043.67706045.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[84507],{22525:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>a,contentTitle:()=>c,default:()=>p,frontMatter:()=>t,metadata:()=>s,toc:()=>d});var o=r(24246),i=r(71670);const t={},c="Interface: ProviderContainerConnection",s={id:"interfaces/ProviderContainerConnection",title:"Interface: ProviderContainerConnection",description:"Properties",source:"@site/api/interfaces/ProviderContainerConnection.md",sourceDirName:"interfaces",slug:"/interfaces/ProviderContainerConnection",permalink:"/api/interfaces/ProviderContainerConnection",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: ProviderConnectionLifecycle",permalink:"/api/interfaces/ProviderConnectionLifecycle"},next:{title:"Interface: ProviderDetectionCheck",permalink:"/api/interfaces/ProviderDetectionCheck"}},a={},d=[{value:"Properties",id:"properties",level:2},{value:"connection",id:"connection",level:3},{value:"Source",id:"source",level:4},{value:"providerId",id:"providerid",level:3},{value:"Source",id:"source-1",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,i.a)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(n.h1,{id:"interface-providercontainerconnection",children:"Interface: ProviderContainerConnection"}),"\n",(0,o.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,o.jsx)(n.h3,{id:"connection",children:"connection"}),"\n",(0,o.jsxs)(n.blockquote,{children:["\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.strong,{children:"connection"}),": ",(0,o.jsx)(n.a,{href:"/api/interfaces/ContainerProviderConnection",children:(0,o.jsx)(n.code,{children:"ContainerProviderConnection"})})]}),"\n"]}),"\n",(0,o.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,o.jsx)(n.p,{children:(0,o.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L541",children:"packages/extension-api/src/extension-api.d.ts:541"})}),"\n",(0,o.jsx)(n.hr,{}),"\n",(0,o.jsx)(n.h3,{id:"providerid",children:"providerId"}),"\n",(0,o.jsxs)(n.blockquote,{children:["\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.strong,{children:"providerId"}),": ",(0,o.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,o.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,o.jsx)(n.p,{children:(0,o.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L540",children:"packages/extension-api/src/extension-api.d.ts:540"})})]})}function p(e={}){const{wrapper:n}={...(0,i.a)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(l,{...e})}):l(e)}},71670:(e,n,r)=>{r.d(n,{Z:()=>s,a:()=>c});var o=r(27378);const i={},t=o.createContext(i);function c(e){const n=o.useContext(t);return o.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function s(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:c(e.components),o.createElement(t.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[84507],{22525:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>d,contentTitle:()=>c,default:()=>p,frontMatter:()=>t,metadata:()=>s,toc:()=>a});var o=r(24246),i=r(71670);const t={},c="Interface: ProviderContainerConnection",s={id:"interfaces/ProviderContainerConnection",title:"Interface: ProviderContainerConnection",description:"Properties",source:"@site/api/interfaces/ProviderContainerConnection.md",sourceDirName:"interfaces",slug:"/interfaces/ProviderContainerConnection",permalink:"/api/interfaces/ProviderContainerConnection",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: ProviderConnectionLifecycle",permalink:"/api/interfaces/ProviderConnectionLifecycle"},next:{title:"Interface: ProviderDetectionCheck",permalink:"/api/interfaces/ProviderDetectionCheck"}},d={},a=[{value:"Properties",id:"properties",level:2},{value:"connection",id:"connection",level:3},{value:"Source",id:"source",level:4},{value:"providerId",id:"providerid",level:3},{value:"Source",id:"source-1",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,i.a)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(n.h1,{id:"interface-providercontainerconnection",children:"Interface: ProviderContainerConnection"}),"\n",(0,o.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,o.jsx)(n.h3,{id:"connection",children:"connection"}),"\n",(0,o.jsxs)(n.blockquote,{children:["\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.strong,{children:"connection"}),": ",(0,o.jsx)(n.a,{href:"/api/interfaces/ContainerProviderConnection",children:(0,o.jsx)(n.code,{children:"ContainerProviderConnection"})})]}),"\n"]}),"\n",(0,o.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,o.jsx)(n.p,{children:(0,o.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L541",children:"packages/extension-api/src/extension-api.d.ts:541"})}),"\n",(0,o.jsx)(n.hr,{}),"\n",(0,o.jsx)(n.h3,{id:"providerid",children:"providerId"}),"\n",(0,o.jsxs)(n.blockquote,{children:["\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.strong,{children:"providerId"}),": ",(0,o.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,o.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,o.jsx)(n.p,{children:(0,o.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L540",children:"packages/extension-api/src/extension-api.d.ts:540"})})]})}function p(e={}){const{wrapper:n}={...(0,i.a)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(l,{...e})}):l(e)}},71670:(e,n,r)=>{r.d(n,{Z:()=>s,a:()=>c});var o=r(27378);const i={},t=o.createContext(i);function c(e){const n=o.useContext(t);return o.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function s(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:c(e.components),o.createElement(t.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/6e30ac7b.8545b1d6.js b/assets/js/6e30ac7b.a0526b47.js similarity index 88% rename from assets/js/6e30ac7b.8545b1d6.js rename to assets/js/6e30ac7b.a0526b47.js index ff8ae81751c..331602b5506 100644 --- a/assets/js/6e30ac7b.8545b1d6.js +++ b/assets/js/6e30ac7b.a0526b47.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[57368],{53670:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>l,contentTitle:()=>o,default:()=>h,frontMatter:()=>t,metadata:()=>r,toc:()=>a});var c=i(24246),s=i(71670);const t={},o="Interface: QuickPickOptions",r={id:"interfaces/QuickPickOptions",title:"Interface: QuickPickOptions",description:"Options to configure the behavior of the quick pick UI.",source:"@site/api/interfaces/QuickPickOptions.md",sourceDirName:"interfaces",slug:"/interfaces/QuickPickOptions",permalink:"/api/interfaces/QuickPickOptions",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: QuickPickItem",permalink:"/api/interfaces/QuickPickItem"},next:{title:"Interface: RegisterContainerConnectionEvent",permalink:"/api/interfaces/RegisterContainerConnectionEvent"}},l={},a=[{value:"Properties",id:"properties",level:2},{value:"canPickMany?",id:"canpickmany",level:3},{value:"Source",id:"source",level:4},{value:"ignoreFocusOut?",id:"ignorefocusout",level:3},{value:"Source",id:"source-1",level:4},{value:"matchOnDescription?",id:"matchondescription",level:3},{value:"Source",id:"source-2",level:4},{value:"matchOnDetail?",id:"matchondetail",level:3},{value:"Source",id:"source-3",level:4},{value:"placeHolder?",id:"placeholder",level:3},{value:"Source",id:"source-4",level:4},{value:"title?",id:"title",level:3},{value:"Source",id:"source-5",level:4},{value:"Methods",id:"methods",level:2},{value:"onDidSelectItem()?",id:"ondidselectitem",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Source",id:"source-6",level:4}];function d(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,c.jsxs)(c.Fragment,{children:[(0,c.jsx)(n.h1,{id:"interface-quickpickoptions",children:"Interface: QuickPickOptions"}),"\n",(0,c.jsx)(n.p,{children:"Options to configure the behavior of the quick pick UI."}),"\n",(0,c.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,c.jsx)(n.h3,{id:"canpickmany",children:"canPickMany?"}),"\n",(0,c.jsxs)(n.blockquote,{children:["\n",(0,c.jsxs)(n.p,{children:[(0,c.jsx)(n.strong,{children:(0,c.jsx)(n.code,{children:"optional"})})," ",(0,c.jsx)(n.strong,{children:"canPickMany"}),": ",(0,c.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,c.jsx)(n.p,{children:"An optional flag to make the picker accept multiple selections, if true the result is an array of picks."}),"\n",(0,c.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,c.jsx)(n.p,{children:(0,c.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L968",children:"packages/extension-api/src/extension-api.d.ts:968"})}),"\n",(0,c.jsx)(n.hr,{}),"\n",(0,c.jsx)(n.h3,{id:"ignorefocusout",children:"ignoreFocusOut?"}),"\n",(0,c.jsxs)(n.blockquote,{children:["\n",(0,c.jsxs)(n.p,{children:[(0,c.jsx)(n.strong,{children:(0,c.jsx)(n.code,{children:"optional"})})," ",(0,c.jsx)(n.strong,{children:"ignoreFocusOut"}),": ",(0,c.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,c.jsxs)(n.p,{children:["Set to ",(0,c.jsx)(n.code,{children:"true"})," to keep the picker open when focus moves to another part of the editor or to another window.\nThis setting is ignored on iPad and is always false."]}),"\n",(0,c.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,c.jsx)(n.p,{children:(0,c.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L963",children:"packages/extension-api/src/extension-api.d.ts:963"})}),"\n",(0,c.jsx)(n.hr,{}),"\n",(0,c.jsx)(n.h3,{id:"matchondescription",children:"matchOnDescription?"}),"\n",(0,c.jsxs)(n.blockquote,{children:["\n",(0,c.jsxs)(n.p,{children:[(0,c.jsx)(n.strong,{children:(0,c.jsx)(n.code,{children:"optional"})})," ",(0,c.jsx)(n.strong,{children:"matchOnDescription"}),": ",(0,c.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,c.jsx)(n.p,{children:"An optional flag to include the description when filtering the picks."}),"\n",(0,c.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,c.jsx)(n.p,{children:(0,c.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L947",children:"packages/extension-api/src/extension-api.d.ts:947"})}),"\n",(0,c.jsx)(n.hr,{}),"\n",(0,c.jsx)(n.h3,{id:"matchondetail",children:"matchOnDetail?"}),"\n",(0,c.jsxs)(n.blockquote,{children:["\n",(0,c.jsxs)(n.p,{children:[(0,c.jsx)(n.strong,{children:(0,c.jsx)(n.code,{children:"optional"})})," ",(0,c.jsx)(n.strong,{children:"matchOnDetail"}),": ",(0,c.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,c.jsx)(n.p,{children:"An optional flag to include the detail when filtering the picks."}),"\n",(0,c.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,c.jsx)(n.p,{children:(0,c.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L952",children:"packages/extension-api/src/extension-api.d.ts:952"})}),"\n",(0,c.jsx)(n.hr,{}),"\n",(0,c.jsx)(n.h3,{id:"placeholder",children:"placeHolder?"}),"\n",(0,c.jsxs)(n.blockquote,{children:["\n",(0,c.jsxs)(n.p,{children:[(0,c.jsx)(n.strong,{children:(0,c.jsx)(n.code,{children:"optional"})})," ",(0,c.jsx)(n.strong,{children:"placeHolder"}),": ",(0,c.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,c.jsx)(n.p,{children:"An optional string to show as placeholder in the input box to guide the user what to pick on."}),"\n",(0,c.jsx)(n.h4,{id:"source-4",children:"Source"}),"\n",(0,c.jsx)(n.p,{children:(0,c.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L957",children:"packages/extension-api/src/extension-api.d.ts:957"})}),"\n",(0,c.jsx)(n.hr,{}),"\n",(0,c.jsx)(n.h3,{id:"title",children:"title?"}),"\n",(0,c.jsxs)(n.blockquote,{children:["\n",(0,c.jsxs)(n.p,{children:[(0,c.jsx)(n.strong,{children:(0,c.jsx)(n.code,{children:"optional"})})," ",(0,c.jsx)(n.strong,{children:"title"}),": ",(0,c.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,c.jsx)(n.p,{children:"An optional string that represents the title of the quick pick."}),"\n",(0,c.jsx)(n.h4,{id:"source-5",children:"Source"}),"\n",(0,c.jsx)(n.p,{children:(0,c.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L942",children:"packages/extension-api/src/extension-api.d.ts:942"})}),"\n",(0,c.jsx)(n.h2,{id:"methods",children:"Methods"}),"\n",(0,c.jsx)(n.h3,{id:"ondidselectitem",children:"onDidSelectItem()?"}),"\n",(0,c.jsxs)(n.blockquote,{children:["\n",(0,c.jsxs)(n.p,{children:[(0,c.jsx)(n.strong,{children:(0,c.jsx)(n.code,{children:"optional"})})," ",(0,c.jsx)(n.strong,{children:"onDidSelectItem"}),"(",(0,c.jsx)(n.code,{children:"item"}),"): ",(0,c.jsx)(n.code,{children:"any"})]}),"\n"]}),"\n",(0,c.jsx)(n.p,{children:"An optional function that is invoked whenever an item is selected."}),"\n",(0,c.jsx)(n.h4,{id:"parameters",children:"Parameters"}),"\n",(0,c.jsxs)(n.p,{children:["\u2022 ",(0,c.jsx)(n.strong,{children:"item"}),": ",(0,c.jsx)(n.code,{children:"string"})," | ",(0,c.jsx)(n.a,{href:"/api/interfaces/QuickPickItem",children:(0,c.jsx)(n.code,{children:"QuickPickItem"})})]}),"\n",(0,c.jsx)(n.h4,{id:"returns",children:"Returns"}),"\n",(0,c.jsx)(n.p,{children:(0,c.jsx)(n.code,{children:"any"})}),"\n",(0,c.jsx)(n.h4,{id:"source-6",children:"Source"}),"\n",(0,c.jsx)(n.p,{children:(0,c.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/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,s.a)(),...e.components};return n?(0,c.jsx)(n,{...e,children:(0,c.jsx)(d,{...e})}):d(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>r,a:()=>o});var c=i(27378);const s={},t=c.createContext(s);function o(e){const n=c.useContext(t);return c.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function r(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:o(e.components),c.createElement(t.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[57368],{53670:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>d,contentTitle:()=>o,default:()=>h,frontMatter:()=>t,metadata:()=>r,toc:()=>l});var c=i(24246),s=i(71670);const t={},o="Interface: QuickPickOptions",r={id:"interfaces/QuickPickOptions",title:"Interface: QuickPickOptions",description:"Options to configure the behavior of the quick pick UI.",source:"@site/api/interfaces/QuickPickOptions.md",sourceDirName:"interfaces",slug:"/interfaces/QuickPickOptions",permalink:"/api/interfaces/QuickPickOptions",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: QuickPickItem",permalink:"/api/interfaces/QuickPickItem"},next:{title:"Interface: RegisterContainerConnectionEvent",permalink:"/api/interfaces/RegisterContainerConnectionEvent"}},d={},l=[{value:"Properties",id:"properties",level:2},{value:"canPickMany?",id:"canpickmany",level:3},{value:"Source",id:"source",level:4},{value:"ignoreFocusOut?",id:"ignorefocusout",level:3},{value:"Source",id:"source-1",level:4},{value:"matchOnDescription?",id:"matchondescription",level:3},{value:"Source",id:"source-2",level:4},{value:"matchOnDetail?",id:"matchondetail",level:3},{value:"Source",id:"source-3",level:4},{value:"placeHolder?",id:"placeholder",level:3},{value:"Source",id:"source-4",level:4},{value:"title?",id:"title",level:3},{value:"Source",id:"source-5",level:4},{value:"Methods",id:"methods",level:2},{value:"onDidSelectItem()?",id:"ondidselectitem",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Source",id:"source-6",level:4}];function a(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,c.jsxs)(c.Fragment,{children:[(0,c.jsx)(n.h1,{id:"interface-quickpickoptions",children:"Interface: QuickPickOptions"}),"\n",(0,c.jsx)(n.p,{children:"Options to configure the behavior of the quick pick UI."}),"\n",(0,c.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,c.jsx)(n.h3,{id:"canpickmany",children:"canPickMany?"}),"\n",(0,c.jsxs)(n.blockquote,{children:["\n",(0,c.jsxs)(n.p,{children:[(0,c.jsx)(n.strong,{children:(0,c.jsx)(n.code,{children:"optional"})})," ",(0,c.jsx)(n.strong,{children:"canPickMany"}),": ",(0,c.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,c.jsx)(n.p,{children:"An optional flag to make the picker accept multiple selections, if true the result is an array of picks."}),"\n",(0,c.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,c.jsx)(n.p,{children:(0,c.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L968",children:"packages/extension-api/src/extension-api.d.ts:968"})}),"\n",(0,c.jsx)(n.hr,{}),"\n",(0,c.jsx)(n.h3,{id:"ignorefocusout",children:"ignoreFocusOut?"}),"\n",(0,c.jsxs)(n.blockquote,{children:["\n",(0,c.jsxs)(n.p,{children:[(0,c.jsx)(n.strong,{children:(0,c.jsx)(n.code,{children:"optional"})})," ",(0,c.jsx)(n.strong,{children:"ignoreFocusOut"}),": ",(0,c.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,c.jsxs)(n.p,{children:["Set to ",(0,c.jsx)(n.code,{children:"true"})," to keep the picker open when focus moves to another part of the editor or to another window.\nThis setting is ignored on iPad and is always false."]}),"\n",(0,c.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,c.jsx)(n.p,{children:(0,c.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L963",children:"packages/extension-api/src/extension-api.d.ts:963"})}),"\n",(0,c.jsx)(n.hr,{}),"\n",(0,c.jsx)(n.h3,{id:"matchondescription",children:"matchOnDescription?"}),"\n",(0,c.jsxs)(n.blockquote,{children:["\n",(0,c.jsxs)(n.p,{children:[(0,c.jsx)(n.strong,{children:(0,c.jsx)(n.code,{children:"optional"})})," ",(0,c.jsx)(n.strong,{children:"matchOnDescription"}),": ",(0,c.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,c.jsx)(n.p,{children:"An optional flag to include the description when filtering the picks."}),"\n",(0,c.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,c.jsx)(n.p,{children:(0,c.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L947",children:"packages/extension-api/src/extension-api.d.ts:947"})}),"\n",(0,c.jsx)(n.hr,{}),"\n",(0,c.jsx)(n.h3,{id:"matchondetail",children:"matchOnDetail?"}),"\n",(0,c.jsxs)(n.blockquote,{children:["\n",(0,c.jsxs)(n.p,{children:[(0,c.jsx)(n.strong,{children:(0,c.jsx)(n.code,{children:"optional"})})," ",(0,c.jsx)(n.strong,{children:"matchOnDetail"}),": ",(0,c.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,c.jsx)(n.p,{children:"An optional flag to include the detail when filtering the picks."}),"\n",(0,c.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,c.jsx)(n.p,{children:(0,c.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L952",children:"packages/extension-api/src/extension-api.d.ts:952"})}),"\n",(0,c.jsx)(n.hr,{}),"\n",(0,c.jsx)(n.h3,{id:"placeholder",children:"placeHolder?"}),"\n",(0,c.jsxs)(n.blockquote,{children:["\n",(0,c.jsxs)(n.p,{children:[(0,c.jsx)(n.strong,{children:(0,c.jsx)(n.code,{children:"optional"})})," ",(0,c.jsx)(n.strong,{children:"placeHolder"}),": ",(0,c.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,c.jsx)(n.p,{children:"An optional string to show as placeholder in the input box to guide the user what to pick on."}),"\n",(0,c.jsx)(n.h4,{id:"source-4",children:"Source"}),"\n",(0,c.jsx)(n.p,{children:(0,c.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L957",children:"packages/extension-api/src/extension-api.d.ts:957"})}),"\n",(0,c.jsx)(n.hr,{}),"\n",(0,c.jsx)(n.h3,{id:"title",children:"title?"}),"\n",(0,c.jsxs)(n.blockquote,{children:["\n",(0,c.jsxs)(n.p,{children:[(0,c.jsx)(n.strong,{children:(0,c.jsx)(n.code,{children:"optional"})})," ",(0,c.jsx)(n.strong,{children:"title"}),": ",(0,c.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,c.jsx)(n.p,{children:"An optional string that represents the title of the quick pick."}),"\n",(0,c.jsx)(n.h4,{id:"source-5",children:"Source"}),"\n",(0,c.jsx)(n.p,{children:(0,c.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L942",children:"packages/extension-api/src/extension-api.d.ts:942"})}),"\n",(0,c.jsx)(n.h2,{id:"methods",children:"Methods"}),"\n",(0,c.jsx)(n.h3,{id:"ondidselectitem",children:"onDidSelectItem()?"}),"\n",(0,c.jsxs)(n.blockquote,{children:["\n",(0,c.jsxs)(n.p,{children:[(0,c.jsx)(n.strong,{children:(0,c.jsx)(n.code,{children:"optional"})})," ",(0,c.jsx)(n.strong,{children:"onDidSelectItem"}),"(",(0,c.jsx)(n.code,{children:"item"}),"): ",(0,c.jsx)(n.code,{children:"any"})]}),"\n"]}),"\n",(0,c.jsx)(n.p,{children:"An optional function that is invoked whenever an item is selected."}),"\n",(0,c.jsx)(n.h4,{id:"parameters",children:"Parameters"}),"\n",(0,c.jsxs)(n.p,{children:["\u2022 ",(0,c.jsx)(n.strong,{children:"item"}),": ",(0,c.jsx)(n.code,{children:"string"})," | ",(0,c.jsx)(n.a,{href:"/api/interfaces/QuickPickItem",children:(0,c.jsx)(n.code,{children:"QuickPickItem"})})]}),"\n",(0,c.jsx)(n.h4,{id:"returns",children:"Returns"}),"\n",(0,c.jsx)(n.p,{children:(0,c.jsx)(n.code,{children:"any"})}),"\n",(0,c.jsx)(n.h4,{id:"source-6",children:"Source"}),"\n",(0,c.jsx)(n.p,{children:(0,c.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/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,s.a)(),...e.components};return n?(0,c.jsx)(n,{...e,children:(0,c.jsx)(a,{...e})}):a(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>r,a:()=>o});var c=i(27378);const s={},t=c.createContext(s);function o(e){const n=c.useContext(t);return c.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function r(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:o(e.components),c.createElement(t.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/6e92edd9.74f06cbe.js b/assets/js/6e92edd9.c9596b0e.js similarity index 89% rename from assets/js/6e92edd9.74f06cbe.js rename to assets/js/6e92edd9.c9596b0e.js index ceca33817a6..ab0177bcee6 100644 --- a/assets/js/6e92edd9.74f06cbe.js +++ b/assets/js/6e92edd9.c9596b0e.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[63652],{61422:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>o,contentTitle:()=>c,default:()=>h,frontMatter:()=>t,metadata:()=>d,toc:()=>a});var r=s(24246),i=s(71670);const t={},c="Interface: Configuration",d={id:"interfaces/Configuration",title:"Interface: Configuration",description:"Indexable",source:"@site/api/interfaces/Configuration.md",sourceDirName:"interfaces",slug:"/interfaces/Configuration",permalink:"/api/interfaces/Configuration",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: Command",permalink:"/api/interfaces/Command"},next:{title:"Interface: ConfigurationChangeEvent",permalink:"/api/interfaces/ConfigurationChangeEvent"}},o={},a=[{value:"Indexable",id:"indexable",level:2},{value:"Methods",id:"methods",level:2},{value:"get()",id:"get",level:3},{value:"get(section)",id:"getsection",level:4},{value:"Type parameters",id:"type-parameters",level:5},{value:"Parameters",id:"parameters",level:5},{value:"Returns",id:"returns",level:5},{value:"Source",id:"source",level:5},{value:"get(section, defaultValue)",id:"getsection-defaultvalue",level:4},{value:"Type parameters",id:"type-parameters-1",level:5},{value:"Parameters",id:"parameters-1",level:5},{value:"Returns",id:"returns-1",level:5},{value:"Source",id:"source-1",level:5},{value:"has()",id:"has",level:3},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-2",level:4},{value:"Source",id:"source-2",level:4},{value:"update()",id:"update",level:3},{value:"Parameters",id:"parameters-3",level:4},{value:"Returns",id:"returns-3",level:4},{value:"Source",id:"source-3",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",em:"em",h1:"h1",h2:"h2",h3:"h3",h4:"h4",h5:"h5",hr:"hr",p:"p",strong:"strong",...(0,i.a)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.h1,{id:"interface-configuration",children:"Interface: Configuration"}),"\n",(0,r.jsx)(n.h2,{id:"indexable",children:"Indexable"}),"\n",(0,r.jsxs)(n.p,{children:["[",(0,r.jsx)(n.code,{children:"key"}),": ",(0,r.jsx)(n.code,{children:"string"}),"]: ",(0,r.jsx)(n.code,{children:"any"})]}),"\n",(0,r.jsx)(n.h2,{id:"methods",children:"Methods"}),"\n",(0,r.jsx)(n.h3,{id:"get",children:"get()"}),"\n",(0,r.jsx)(n.h4,{id:"getsection",children:"get(section)"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"get"}),"<",(0,r.jsx)(n.code,{children:"T"}),">(",(0,r.jsx)(n.code,{children:"section"}),"): ",(0,r.jsx)(n.code,{children:"undefined"})," | ",(0,r.jsx)(n.code,{children:"T"})]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"Return a value from this configuration."}),"\n",(0,r.jsx)(n.h5,{id:"type-parameters",children:"Type parameters"}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"T"})]}),"\n",(0,r.jsx)(n.h5,{id:"parameters",children:"Parameters"}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"section"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n",(0,r.jsxs)(n.p,{children:["Configuration name, supports ",(0,r.jsx)(n.em,{children:"dotted"})," names."]}),"\n",(0,r.jsx)(n.h5,{id:"returns",children:"Returns"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"undefined"})," | ",(0,r.jsx)(n.code,{children:"T"})]}),"\n",(0,r.jsxs)(n.p,{children:["The value ",(0,r.jsx)(n.code,{children:"section"})," denotes or ",(0,r.jsx)(n.code,{children:"undefined"}),"."]}),"\n",(0,r.jsx)(n.h5,{id:"source",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L671",children:"packages/extension-api/src/extension-api.d.ts:671"})}),"\n",(0,r.jsx)(n.h4,{id:"getsection-defaultvalue",children:"get(section, defaultValue)"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"get"}),"<",(0,r.jsx)(n.code,{children:"T"}),">(",(0,r.jsx)(n.code,{children:"section"}),", ",(0,r.jsx)(n.code,{children:"defaultValue"}),"): ",(0,r.jsx)(n.code,{children:"T"})]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"Return a value from this configuration."}),"\n",(0,r.jsx)(n.h5,{id:"type-parameters-1",children:"Type parameters"}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"T"})]}),"\n",(0,r.jsx)(n.h5,{id:"parameters-1",children:"Parameters"}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"section"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n",(0,r.jsxs)(n.p,{children:["Configuration name, supports ",(0,r.jsx)(n.em,{children:"dotted"})," names."]}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"defaultValue"}),": ",(0,r.jsx)(n.code,{children:"T"})]}),"\n",(0,r.jsxs)(n.p,{children:["A value should be returned when no value could be found, is ",(0,r.jsx)(n.code,{children:"undefined"}),"."]}),"\n",(0,r.jsx)(n.h5,{id:"returns-1",children:"Returns"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.code,{children:"T"})}),"\n",(0,r.jsxs)(n.p,{children:["The value ",(0,r.jsx)(n.code,{children:"section"})," denotes or the default."]}),"\n",(0,r.jsx)(n.h5,{id:"source-1",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L680",children:"packages/extension-api/src/extension-api.d.ts:680"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"has",children:"has()"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"has"}),"(",(0,r.jsx)(n.code,{children:"section"}),"): ",(0,r.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"Check if this configuration has a certain value."}),"\n",(0,r.jsx)(n.h4,{id:"parameters-2",children:"Parameters"}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"section"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n",(0,r.jsxs)(n.p,{children:["Configuration name, supports ",(0,r.jsx)(n.em,{children:"dotted"})," names."]}),"\n",(0,r.jsx)(n.h4,{id:"returns-2",children:"Returns"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.code,{children:"boolean"})}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"true"})," if the section doesn't resolve to ",(0,r.jsx)(n.code,{children:"undefined"}),"."]}),"\n",(0,r.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L688",children:"packages/extension-api/src/extension-api.d.ts:688"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"update",children:"update()"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"update"}),"(",(0,r.jsx)(n.code,{children:"section"}),", ",(0,r.jsx)(n.code,{children:"value"}),"): ",(0,r.jsx)(n.code,{children:"Promise"}),"< ",(0,r.jsx)(n.code,{children:"void"})," >"]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"Update a configuration value. The updated configuration values are persisted."}),"\n",(0,r.jsx)(n.h4,{id:"parameters-3",children:"Parameters"}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"section"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"value"}),": ",(0,r.jsx)(n.code,{children:"any"})]}),"\n",(0,r.jsx)(n.h4,{id:"returns-3",children:"Returns"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"Promise"}),"< ",(0,r.jsx)(n.code,{children:"void"})," >"]}),"\n",(0,r.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L694",children:"packages/extension-api/src/extension-api.d.ts:694"})})]})}function h(e={}){const{wrapper:n}={...(0,i.a)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(l,{...e})}):l(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>d,a:()=>c});var r=s(27378);const i={},t=r.createContext(i);function c(e){const n=r.useContext(t);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function d(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:c(e.components),r.createElement(t.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[63652],{61422:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>o,contentTitle:()=>t,default:()=>h,frontMatter:()=>d,metadata:()=>c,toc:()=>a});var r=s(24246),i=s(71670);const d={},t="Interface: Configuration",c={id:"interfaces/Configuration",title:"Interface: Configuration",description:"Indexable",source:"@site/api/interfaces/Configuration.md",sourceDirName:"interfaces",slug:"/interfaces/Configuration",permalink:"/api/interfaces/Configuration",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: Command",permalink:"/api/interfaces/Command"},next:{title:"Interface: ConfigurationChangeEvent",permalink:"/api/interfaces/ConfigurationChangeEvent"}},o={},a=[{value:"Indexable",id:"indexable",level:2},{value:"Methods",id:"methods",level:2},{value:"get()",id:"get",level:3},{value:"get(section)",id:"getsection",level:4},{value:"Type parameters",id:"type-parameters",level:5},{value:"Parameters",id:"parameters",level:5},{value:"Returns",id:"returns",level:5},{value:"Source",id:"source",level:5},{value:"get(section, defaultValue)",id:"getsection-defaultvalue",level:4},{value:"Type parameters",id:"type-parameters-1",level:5},{value:"Parameters",id:"parameters-1",level:5},{value:"Returns",id:"returns-1",level:5},{value:"Source",id:"source-1",level:5},{value:"has()",id:"has",level:3},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-2",level:4},{value:"Source",id:"source-2",level:4},{value:"update()",id:"update",level:3},{value:"Parameters",id:"parameters-3",level:4},{value:"Returns",id:"returns-3",level:4},{value:"Source",id:"source-3",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",em:"em",h1:"h1",h2:"h2",h3:"h3",h4:"h4",h5:"h5",hr:"hr",p:"p",strong:"strong",...(0,i.a)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.h1,{id:"interface-configuration",children:"Interface: Configuration"}),"\n",(0,r.jsx)(n.h2,{id:"indexable",children:"Indexable"}),"\n",(0,r.jsxs)(n.p,{children:["[",(0,r.jsx)(n.code,{children:"key"}),": ",(0,r.jsx)(n.code,{children:"string"}),"]: ",(0,r.jsx)(n.code,{children:"any"})]}),"\n",(0,r.jsx)(n.h2,{id:"methods",children:"Methods"}),"\n",(0,r.jsx)(n.h3,{id:"get",children:"get()"}),"\n",(0,r.jsx)(n.h4,{id:"getsection",children:"get(section)"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"get"}),"<",(0,r.jsx)(n.code,{children:"T"}),">(",(0,r.jsx)(n.code,{children:"section"}),"): ",(0,r.jsx)(n.code,{children:"undefined"})," | ",(0,r.jsx)(n.code,{children:"T"})]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"Return a value from this configuration."}),"\n",(0,r.jsx)(n.h5,{id:"type-parameters",children:"Type parameters"}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"T"})]}),"\n",(0,r.jsx)(n.h5,{id:"parameters",children:"Parameters"}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"section"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n",(0,r.jsxs)(n.p,{children:["Configuration name, supports ",(0,r.jsx)(n.em,{children:"dotted"})," names."]}),"\n",(0,r.jsx)(n.h5,{id:"returns",children:"Returns"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"undefined"})," | ",(0,r.jsx)(n.code,{children:"T"})]}),"\n",(0,r.jsxs)(n.p,{children:["The value ",(0,r.jsx)(n.code,{children:"section"})," denotes or ",(0,r.jsx)(n.code,{children:"undefined"}),"."]}),"\n",(0,r.jsx)(n.h5,{id:"source",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L671",children:"packages/extension-api/src/extension-api.d.ts:671"})}),"\n",(0,r.jsx)(n.h4,{id:"getsection-defaultvalue",children:"get(section, defaultValue)"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"get"}),"<",(0,r.jsx)(n.code,{children:"T"}),">(",(0,r.jsx)(n.code,{children:"section"}),", ",(0,r.jsx)(n.code,{children:"defaultValue"}),"): ",(0,r.jsx)(n.code,{children:"T"})]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"Return a value from this configuration."}),"\n",(0,r.jsx)(n.h5,{id:"type-parameters-1",children:"Type parameters"}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"T"})]}),"\n",(0,r.jsx)(n.h5,{id:"parameters-1",children:"Parameters"}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"section"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n",(0,r.jsxs)(n.p,{children:["Configuration name, supports ",(0,r.jsx)(n.em,{children:"dotted"})," names."]}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"defaultValue"}),": ",(0,r.jsx)(n.code,{children:"T"})]}),"\n",(0,r.jsxs)(n.p,{children:["A value should be returned when no value could be found, is ",(0,r.jsx)(n.code,{children:"undefined"}),"."]}),"\n",(0,r.jsx)(n.h5,{id:"returns-1",children:"Returns"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.code,{children:"T"})}),"\n",(0,r.jsxs)(n.p,{children:["The value ",(0,r.jsx)(n.code,{children:"section"})," denotes or the default."]}),"\n",(0,r.jsx)(n.h5,{id:"source-1",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L680",children:"packages/extension-api/src/extension-api.d.ts:680"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"has",children:"has()"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"has"}),"(",(0,r.jsx)(n.code,{children:"section"}),"): ",(0,r.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"Check if this configuration has a certain value."}),"\n",(0,r.jsx)(n.h4,{id:"parameters-2",children:"Parameters"}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"section"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n",(0,r.jsxs)(n.p,{children:["Configuration name, supports ",(0,r.jsx)(n.em,{children:"dotted"})," names."]}),"\n",(0,r.jsx)(n.h4,{id:"returns-2",children:"Returns"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.code,{children:"boolean"})}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"true"})," if the section doesn't resolve to ",(0,r.jsx)(n.code,{children:"undefined"}),"."]}),"\n",(0,r.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L688",children:"packages/extension-api/src/extension-api.d.ts:688"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"update",children:"update()"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"update"}),"(",(0,r.jsx)(n.code,{children:"section"}),", ",(0,r.jsx)(n.code,{children:"value"}),"): ",(0,r.jsx)(n.code,{children:"Promise"}),"< ",(0,r.jsx)(n.code,{children:"void"})," >"]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"Update a configuration value. The updated configuration values are persisted."}),"\n",(0,r.jsx)(n.h4,{id:"parameters-3",children:"Parameters"}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"section"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"value"}),": ",(0,r.jsx)(n.code,{children:"any"})]}),"\n",(0,r.jsx)(n.h4,{id:"returns-3",children:"Returns"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"Promise"}),"< ",(0,r.jsx)(n.code,{children:"void"})," >"]}),"\n",(0,r.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L694",children:"packages/extension-api/src/extension-api.d.ts:694"})})]})}function h(e={}){const{wrapper:n}={...(0,i.a)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(l,{...e})}):l(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>c,a:()=>t});var r=s(27378);const i={},d=r.createContext(i);function t(e){const n=r.useContext(d);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:t(e.components),r.createElement(d.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/6eafe0c7.304211a7.js b/assets/js/6eafe0c7.80d11545.js similarity index 82% rename from assets/js/6eafe0c7.304211a7.js rename to assets/js/6eafe0c7.80d11545.js index 68512321595..3da8eee8229 100644 --- a/assets/js/6eafe0c7.304211a7.js +++ b/assets/js/6eafe0c7.80d11545.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[88089],{80468:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>t,contentTitle:()=>o,default:()=>h,frontMatter:()=>c,metadata:()=>d,toc:()=>a});var i=s(24246),r=s(71670);const c={},o="Interface: EndpointSettings",d={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:"Interface: EndpointIPAMConfig",permalink:"/api/interfaces/EndpointIPAMConfig"},next:{title:"Interface: Event()\\",permalink:"/api/interfaces/Event"}},t={},a=[{value:"Properties",id:"properties",level:2},{value:"Aliases?",id:"aliases",level:3},{value:"Source",id:"source",level:4},{value:"DNSNames?",id:"dnsnames",level:3},{value:"Source",id:"source-1",level:4},{value:"DriverOpts?",id:"driveropts",level:3},{value:"Index signature",id:"index-signature",level:4},{value:"Source",id:"source-2",level:4},{value:"EndpointID?",id:"endpointid",level:3},{value:"Source",id:"source-3",level:4},{value:"Gateway?",id:"gateway",level:3},{value:"Source",id:"source-4",level:4},{value:"GlobalIPv6Address?",id:"globalipv6address",level:3},{value:"Source",id:"source-5",level:4},{value:"GlobalIPv6PrefixLen?",id:"globalipv6prefixlen",level:3},{value:"Source",id:"source-6",level:4},{value:"IPAMConfig?",id:"ipamconfig",level:3},{value:"Source",id:"source-7",level:4},{value:"IPAddress?",id:"ipaddress",level:3},{value:"Source",id:"source-8",level:4},{value:"IPPrefixLen?",id:"ipprefixlen",level:3},{value:"Source",id:"source-9",level:4},{value:"IPv6Gateway?",id:"ipv6gateway",level:3},{value:"Source",id:"source-10",level:4},{value:"Links?",id:"links",level:3},{value:"Source",id:"source-11",level:4},{value:"MacAddress?",id:"macaddress",level:3},{value:"Source",id:"source-12",level:4},{value:"NetworkID?",id:"networkid",level:3},{value:"Source",id:"source-13",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,r.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"interface-endpointsettings",children:"Interface: EndpointSettings"}),"\n",(0,i.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(n.h3,{id:"aliases",children:"Aliases?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"Aliases"}),": ",(0,i.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2476",children:"packages/extension-api/src/extension-api.d.ts:2476"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"dnsnames",children:"DNSNames?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"DNSNames"}),": ",(0,i.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"List of all DNS names an endpoint has on a specific network. This list is based on the container name, network\naliases, container short ID, and hostname."}),"\n",(0,i.jsxs)(n.p,{children:["These DNS names are non-fully qualified but can contain several dots. You can get fully qualified DNS names by\nappending ",(0,i.jsx)(n.code,{children:"."}),". For instance, if container name is ",(0,i.jsx)(n.code,{children:"my.ctr"})," and the network is named\n",(0,i.jsx)(n.code,{children:"testnet"}),", ",(0,i.jsx)(n.code,{children:"DNSNames"})," will contain ",(0,i.jsx)(n.code,{children:"my.ctr"})," and the FQDN will be ",(0,i.jsx)(n.code,{children:"my.ctr.testnet"}),"."]}),"\n",(0,i.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2531",children:"packages/extension-api/src/extension-api.d.ts:2531"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"driveropts",children:"DriverOpts?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"DriverOpts"}),": ",(0,i.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"DriverOpts is a mapping of driver options and values. These options are passed directly to the driver and are driver specific."}),"\n",(0,i.jsx)(n.h4,{id:"index-signature",children:"Index signature"}),"\n",(0,i.jsxs)(n.p,{children:["[",(0,i.jsx)(n.code,{children:"key"}),": ",(0,i.jsx)(n.code,{children:"string"}),"]: ",(0,i.jsx)(n.code,{children:"string"})]}),"\n",(0,i.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2521",children:"packages/extension-api/src/extension-api.d.ts:2521"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"endpointid",children:"EndpointID?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"EndpointID"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Unique ID for the service endpoint in a Sandbox."}),"\n",(0,i.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2486",children:"packages/extension-api/src/extension-api.d.ts:2486"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"gateway",children:"Gateway?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"Gateway"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Gateway address for this network."}),"\n",(0,i.jsx)(n.h4,{id:"source-4",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2491",children:"packages/extension-api/src/extension-api.d.ts:2491"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"globalipv6address",children:"GlobalIPv6Address?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"GlobalIPv6Address"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Global IPv6 address."}),"\n",(0,i.jsx)(n.h4,{id:"source-5",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/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:"globalipv6prefixlen",children:"GlobalIPv6PrefixLen?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"GlobalIPv6PrefixLen"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Mask length of the global IPv6 address."}),"\n",(0,i.jsx)(n.h4,{id:"source-6",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2516",children:"packages/extension-api/src/extension-api.d.ts:2516"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"ipamconfig",children:"IPAMConfig?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"IPAMConfig"}),": ",(0,i.jsx)(n.a,{href:"/api/interfaces/EndpointIPAMConfig",children:(0,i.jsx)(n.code,{children:"EndpointIPAMConfig"})})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"EndpointIPAMConfig represents an endpoint's IPAM configuration."}),"\n",(0,i.jsx)(n.h4,{id:"source-7",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2467",children:"packages/extension-api/src/extension-api.d.ts:2467"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"ipaddress",children:"IPAddress?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"IPAddress"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"IPv4 address."}),"\n",(0,i.jsx)(n.h4,{id:"source-8",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2496",children:"packages/extension-api/src/extension-api.d.ts:2496"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"ipprefixlen",children:"IPPrefixLen?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"IPPrefixLen"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Mask length of the IPv4 address."}),"\n",(0,i.jsx)(n.h4,{id:"source-9",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2501",children:"packages/extension-api/src/extension-api.d.ts:2501"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"ipv6gateway",children:"IPv6Gateway?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"IPv6Gateway"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"IPv6 gateway address."}),"\n",(0,i.jsx)(n.h4,{id:"source-10",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2506",children:"packages/extension-api/src/extension-api.d.ts:2506"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"links",children:"Links?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"Links"}),": ",(0,i.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-11",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2469",children:"packages/extension-api/src/extension-api.d.ts:2469"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"macaddress",children:"MacAddress?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"MacAddress"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"MAC address for the endpoint on this network. The network driver might ignore this parameter."}),"\n",(0,i.jsx)(n.h4,{id:"source-12",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2474",children:"packages/extension-api/src/extension-api.d.ts:2474"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"networkid",children:"NetworkID?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"NetworkID"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Unique ID of the network."}),"\n",(0,i.jsx)(n.h4,{id:"source-13",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2481",children:"packages/extension-api/src/extension-api.d.ts:2481"})})]})}function h(e={}){const{wrapper:n}={...(0,r.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>d,a:()=>o});var i=s(27378);const r={},c=i.createContext(r);function o(e){const n=i.useContext(c);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function d(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:o(e.components),i.createElement(c.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[88089],{80468:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>t,contentTitle:()=>c,default:()=>h,frontMatter:()=>d,metadata:()=>o,toc:()=>l});var i=s(24246),r=s(71670);const d={},c="Interface: EndpointSettings",o={id:"interfaces/EndpointSettings",title:"Interface: EndpointSettings",description:"Properties",source:"@site/api/interfaces/EndpointSettings.md",sourceDirName:"interfaces",slug:"/interfaces/EndpointSettings",permalink:"/api/interfaces/EndpointSettings",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: EndpointIPAMConfig",permalink:"/api/interfaces/EndpointIPAMConfig"},next:{title:"Interface: Event()\\",permalink:"/api/interfaces/Event"}},t={},l=[{value:"Properties",id:"properties",level:2},{value:"Aliases?",id:"aliases",level:3},{value:"Source",id:"source",level:4},{value:"DNSNames?",id:"dnsnames",level:3},{value:"Source",id:"source-1",level:4},{value:"DriverOpts?",id:"driveropts",level:3},{value:"Index signature",id:"index-signature",level:4},{value:"Source",id:"source-2",level:4},{value:"EndpointID?",id:"endpointid",level:3},{value:"Source",id:"source-3",level:4},{value:"Gateway?",id:"gateway",level:3},{value:"Source",id:"source-4",level:4},{value:"GlobalIPv6Address?",id:"globalipv6address",level:3},{value:"Source",id:"source-5",level:4},{value:"GlobalIPv6PrefixLen?",id:"globalipv6prefixlen",level:3},{value:"Source",id:"source-6",level:4},{value:"IPAMConfig?",id:"ipamconfig",level:3},{value:"Source",id:"source-7",level:4},{value:"IPAddress?",id:"ipaddress",level:3},{value:"Source",id:"source-8",level:4},{value:"IPPrefixLen?",id:"ipprefixlen",level:3},{value:"Source",id:"source-9",level:4},{value:"IPv6Gateway?",id:"ipv6gateway",level:3},{value:"Source",id:"source-10",level:4},{value:"Links?",id:"links",level:3},{value:"Source",id:"source-11",level:4},{value:"MacAddress?",id:"macaddress",level:3},{value:"Source",id:"source-12",level:4},{value:"NetworkID?",id:"networkid",level:3},{value:"Source",id:"source-13",level:4}];function a(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,r.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"interface-endpointsettings",children:"Interface: EndpointSettings"}),"\n",(0,i.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(n.h3,{id:"aliases",children:"Aliases?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"Aliases"}),": ",(0,i.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2476",children:"packages/extension-api/src/extension-api.d.ts:2476"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"dnsnames",children:"DNSNames?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"DNSNames"}),": ",(0,i.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"List of all DNS names an endpoint has on a specific network. This list is based on the container name, network\naliases, container short ID, and hostname."}),"\n",(0,i.jsxs)(n.p,{children:["These DNS names are non-fully qualified but can contain several dots. You can get fully qualified DNS names by\nappending ",(0,i.jsx)(n.code,{children:"."}),". For instance, if container name is ",(0,i.jsx)(n.code,{children:"my.ctr"})," and the network is named\n",(0,i.jsx)(n.code,{children:"testnet"}),", ",(0,i.jsx)(n.code,{children:"DNSNames"})," will contain ",(0,i.jsx)(n.code,{children:"my.ctr"})," and the FQDN will be ",(0,i.jsx)(n.code,{children:"my.ctr.testnet"}),"."]}),"\n",(0,i.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2531",children:"packages/extension-api/src/extension-api.d.ts:2531"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"driveropts",children:"DriverOpts?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"DriverOpts"}),": ",(0,i.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"DriverOpts is a mapping of driver options and values. These options are passed directly to the driver and are driver specific."}),"\n",(0,i.jsx)(n.h4,{id:"index-signature",children:"Index signature"}),"\n",(0,i.jsxs)(n.p,{children:["[",(0,i.jsx)(n.code,{children:"key"}),": ",(0,i.jsx)(n.code,{children:"string"}),"]: ",(0,i.jsx)(n.code,{children:"string"})]}),"\n",(0,i.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2521",children:"packages/extension-api/src/extension-api.d.ts:2521"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"endpointid",children:"EndpointID?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"EndpointID"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Unique ID for the service endpoint in a Sandbox."}),"\n",(0,i.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2486",children:"packages/extension-api/src/extension-api.d.ts:2486"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"gateway",children:"Gateway?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"Gateway"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Gateway address for this network."}),"\n",(0,i.jsx)(n.h4,{id:"source-4",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2491",children:"packages/extension-api/src/extension-api.d.ts:2491"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"globalipv6address",children:"GlobalIPv6Address?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"GlobalIPv6Address"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Global IPv6 address."}),"\n",(0,i.jsx)(n.h4,{id:"source-5",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/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:"globalipv6prefixlen",children:"GlobalIPv6PrefixLen?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"GlobalIPv6PrefixLen"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Mask length of the global IPv6 address."}),"\n",(0,i.jsx)(n.h4,{id:"source-6",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2516",children:"packages/extension-api/src/extension-api.d.ts:2516"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"ipamconfig",children:"IPAMConfig?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"IPAMConfig"}),": ",(0,i.jsx)(n.a,{href:"/api/interfaces/EndpointIPAMConfig",children:(0,i.jsx)(n.code,{children:"EndpointIPAMConfig"})})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"EndpointIPAMConfig represents an endpoint's IPAM configuration."}),"\n",(0,i.jsx)(n.h4,{id:"source-7",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2467",children:"packages/extension-api/src/extension-api.d.ts:2467"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"ipaddress",children:"IPAddress?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"IPAddress"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"IPv4 address."}),"\n",(0,i.jsx)(n.h4,{id:"source-8",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2496",children:"packages/extension-api/src/extension-api.d.ts:2496"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"ipprefixlen",children:"IPPrefixLen?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"IPPrefixLen"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Mask length of the IPv4 address."}),"\n",(0,i.jsx)(n.h4,{id:"source-9",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2501",children:"packages/extension-api/src/extension-api.d.ts:2501"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"ipv6gateway",children:"IPv6Gateway?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"IPv6Gateway"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"IPv6 gateway address."}),"\n",(0,i.jsx)(n.h4,{id:"source-10",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2506",children:"packages/extension-api/src/extension-api.d.ts:2506"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"links",children:"Links?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"Links"}),": ",(0,i.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-11",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2469",children:"packages/extension-api/src/extension-api.d.ts:2469"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"macaddress",children:"MacAddress?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"MacAddress"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"MAC address for the endpoint on this network. The network driver might ignore this parameter."}),"\n",(0,i.jsx)(n.h4,{id:"source-12",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2474",children:"packages/extension-api/src/extension-api.d.ts:2474"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"networkid",children:"NetworkID?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"NetworkID"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Unique ID of the network."}),"\n",(0,i.jsx)(n.h4,{id:"source-13",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2481",children:"packages/extension-api/src/extension-api.d.ts:2481"})})]})}function h(e={}){const{wrapper:n}={...(0,r.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(a,{...e})}):a(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>o,a:()=>c});var i=s(27378);const r={},d=i.createContext(r);function c(e){const n=i.useContext(d);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:c(e.components),i.createElement(d.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/70e3b13c.86b953f4.js b/assets/js/70e3b13c.2034da55.js similarity index 95% rename from assets/js/70e3b13c.86b953f4.js rename to assets/js/70e3b13c.2034da55.js index b715ac5b15f..03b1dde8646 100644 --- a/assets/js/70e3b13c.86b953f4.js +++ b/assets/js/70e3b13c.2034da55.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[25817],{12308:(e,s,r)=>{r.r(s),r.d(s,{assets:()=>a,contentTitle:()=>c,default:()=>p,frontMatter:()=>i,metadata:()=>o,toc:()=>d});var t=r(24246),n=r(71670);const i={},c="Function: registerRegistry()",o={id:"namespaces/registry/functions/registerRegistry",title:"Function: registerRegistry()",description:"registerRegistry(registry): Disposable",source:"@site/api/namespaces/registry/functions/registerRegistry.md",sourceDirName:"namespaces/registry/functions",slug:"/namespaces/registry/functions/registerRegistry",permalink:"/api/namespaces/registry/functions/registerRegistry",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Function: onDidUpdateRegistry()",permalink:"/api/namespaces/registry/functions/onDidUpdateRegistry"},next:{title:"Function: registerRegistryProvider()",permalink:"/api/namespaces/registry/functions/registerRegistryProvider"}},a={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function l(e){const s={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,n.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(s.h1,{id:"function-registerregistry",children:"Function: registerRegistry()"}),"\n",(0,t.jsxs)(s.blockquote,{children:["\n",(0,t.jsxs)(s.p,{children:[(0,t.jsx)(s.strong,{children:"registerRegistry"}),"(",(0,t.jsx)(s.code,{children:"registry"}),"): ",(0,t.jsx)(s.a,{href:"/api/classes/Disposable",children:(0,t.jsx)(s.code,{children:"Disposable"})})]}),"\n"]}),"\n",(0,t.jsx)(s.h2,{id:"parameters",children:"Parameters"}),"\n",(0,t.jsxs)(s.p,{children:["\u2022 ",(0,t.jsx)(s.strong,{children:"registry"}),": ",(0,t.jsx)(s.a,{href:"/api/interfaces/Registry",children:(0,t.jsx)(s.code,{children:"Registry"})})]}),"\n",(0,t.jsx)(s.h2,{id:"returns",children:"Returns"}),"\n",(0,t.jsx)(s.p,{children:(0,t.jsx)(s.a,{href:"/api/classes/Disposable",children:(0,t.jsx)(s.code,{children:"Disposable"})})}),"\n",(0,t.jsx)(s.h2,{id:"source",children:"Source"}),"\n",(0,t.jsx)(s.p,{children:(0,t.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L622",children:"packages/extension-api/src/extension-api.d.ts:622"})})]})}function p(e={}){const{wrapper:s}={...(0,n.a)(),...e.components};return s?(0,t.jsx)(s,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},71670:(e,s,r)=>{r.d(s,{Z:()=>o,a:()=>c});var t=r(27378);const n={},i=t.createContext(n);function c(e){const s=t.useContext(i);return t.useMemo((function(){return"function"==typeof e?e(s):{...s,...e}}),[s,e])}function o(e){let s;return s=e.disableParentContext?"function"==typeof e.components?e.components(n):e.components||n:c(e.components),t.createElement(i.Provider,{value:s},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[25817],{12308:(e,s,r)=>{r.r(s),r.d(s,{assets:()=>a,contentTitle:()=>c,default:()=>p,frontMatter:()=>i,metadata:()=>o,toc:()=>d});var t=r(24246),n=r(71670);const i={},c="Function: registerRegistry()",o={id:"namespaces/registry/functions/registerRegistry",title:"Function: registerRegistry()",description:"registerRegistry(registry): Disposable",source:"@site/api/namespaces/registry/functions/registerRegistry.md",sourceDirName:"namespaces/registry/functions",slug:"/namespaces/registry/functions/registerRegistry",permalink:"/api/namespaces/registry/functions/registerRegistry",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Function: onDidUpdateRegistry()",permalink:"/api/namespaces/registry/functions/onDidUpdateRegistry"},next:{title:"Function: registerRegistryProvider()",permalink:"/api/namespaces/registry/functions/registerRegistryProvider"}},a={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function l(e){const s={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,n.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(s.h1,{id:"function-registerregistry",children:"Function: registerRegistry()"}),"\n",(0,t.jsxs)(s.blockquote,{children:["\n",(0,t.jsxs)(s.p,{children:[(0,t.jsx)(s.strong,{children:"registerRegistry"}),"(",(0,t.jsx)(s.code,{children:"registry"}),"): ",(0,t.jsx)(s.a,{href:"/api/classes/Disposable",children:(0,t.jsx)(s.code,{children:"Disposable"})})]}),"\n"]}),"\n",(0,t.jsx)(s.h2,{id:"parameters",children:"Parameters"}),"\n",(0,t.jsxs)(s.p,{children:["\u2022 ",(0,t.jsx)(s.strong,{children:"registry"}),": ",(0,t.jsx)(s.a,{href:"/api/interfaces/Registry",children:(0,t.jsx)(s.code,{children:"Registry"})})]}),"\n",(0,t.jsx)(s.h2,{id:"returns",children:"Returns"}),"\n",(0,t.jsx)(s.p,{children:(0,t.jsx)(s.a,{href:"/api/classes/Disposable",children:(0,t.jsx)(s.code,{children:"Disposable"})})}),"\n",(0,t.jsx)(s.h2,{id:"source",children:"Source"}),"\n",(0,t.jsx)(s.p,{children:(0,t.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L622",children:"packages/extension-api/src/extension-api.d.ts:622"})})]})}function p(e={}){const{wrapper:s}={...(0,n.a)(),...e.components};return s?(0,t.jsx)(s,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},71670:(e,s,r)=>{r.d(s,{Z:()=>o,a:()=>c});var t=r(27378);const n={},i=t.createContext(n);function c(e){const s=t.useContext(i);return t.useMemo((function(){return"function"==typeof e?e(s):{...s,...e}}),[s,e])}function o(e){let s;return s=e.disableParentContext?"function"==typeof e.components?e.components(n):e.components||n:c(e.components),t.createElement(i.Provider,{value:s},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/714e70d1.e8aa7547.js b/assets/js/714e70d1.9b5a36d6.js similarity index 91% rename from assets/js/714e70d1.e8aa7547.js rename to assets/js/714e70d1.9b5a36d6.js index 4cec24580d9..1ee9e8cae9f 100644 --- a/assets/js/714e70d1.e8aa7547.js +++ b/assets/js/714e70d1.9b5a36d6.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[648],{33330:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>a,contentTitle:()=>c,default:()=>p,frontMatter:()=>i,metadata:()=>o,toc:()=>d});var t=r(24246),s=r(71670);const i={},c="Interface: ProviderEvent",o={id:"interfaces/ProviderEvent",title:"Interface: ProviderEvent",description:"Properties",source:"@site/api/interfaces/ProviderEvent.md",sourceDirName:"interfaces",slug:"/interfaces/ProviderEvent",permalink:"/api/interfaces/ProviderEvent",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: ProviderDetectionCheck",permalink:"/api/interfaces/ProviderDetectionCheck"},next:{title:"Interface: ProviderImages",permalink:"/api/interfaces/ProviderImages"}},a={},d=[{value:"Properties",id:"properties",level:2},{value:"id",id:"id",level:3},{value:"Source",id:"source",level:4},{value:"name",id:"name",level:3},{value:"Source",id:"source-1",level:4},{value:"status",id:"status",level:3},{value:"Source",id:"source-2",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"interface-providerevent",children:"Interface: ProviderEvent"}),"\n",(0,t.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,t.jsx)(n.h3,{id:"id",children:"id"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"id"}),": ",(0,t.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L509",children:"packages/extension-api/src/extension-api.d.ts:509"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"name",children:"name"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"name"}),": ",(0,t.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L510",children:"packages/extension-api/src/extension-api.d.ts:510"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"status",children:"status"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"status"}),": ",(0,t.jsx)(n.a,{href:"/api/type-aliases/ProviderStatus",children:(0,t.jsx)(n.code,{children:"ProviderStatus"})})]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L511",children:"packages/extension-api/src/extension-api.d.ts:511"})})]})}function p(e={}){const{wrapper:n}={...(0,s.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},71670:(e,n,r)=>{r.d(n,{Z:()=>o,a:()=>c});var t=r(27378);const s={},i=t.createContext(s);function c(e){const n=t.useContext(i);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:c(e.components),t.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[648],{33330:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>a,contentTitle:()=>c,default:()=>p,frontMatter:()=>i,metadata:()=>o,toc:()=>d});var t=r(24246),s=r(71670);const i={},c="Interface: ProviderEvent",o={id:"interfaces/ProviderEvent",title:"Interface: ProviderEvent",description:"Properties",source:"@site/api/interfaces/ProviderEvent.md",sourceDirName:"interfaces",slug:"/interfaces/ProviderEvent",permalink:"/api/interfaces/ProviderEvent",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: ProviderDetectionCheck",permalink:"/api/interfaces/ProviderDetectionCheck"},next:{title:"Interface: ProviderImages",permalink:"/api/interfaces/ProviderImages"}},a={},d=[{value:"Properties",id:"properties",level:2},{value:"id",id:"id",level:3},{value:"Source",id:"source",level:4},{value:"name",id:"name",level:3},{value:"Source",id:"source-1",level:4},{value:"status",id:"status",level:3},{value:"Source",id:"source-2",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"interface-providerevent",children:"Interface: ProviderEvent"}),"\n",(0,t.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,t.jsx)(n.h3,{id:"id",children:"id"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"id"}),": ",(0,t.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L509",children:"packages/extension-api/src/extension-api.d.ts:509"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"name",children:"name"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"name"}),": ",(0,t.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L510",children:"packages/extension-api/src/extension-api.d.ts:510"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"status",children:"status"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"status"}),": ",(0,t.jsx)(n.a,{href:"/api/type-aliases/ProviderStatus",children:(0,t.jsx)(n.code,{children:"ProviderStatus"})})]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L511",children:"packages/extension-api/src/extension-api.d.ts:511"})})]})}function p(e={}){const{wrapper:n}={...(0,s.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},71670:(e,n,r)=>{r.d(n,{Z:()=>o,a:()=>c});var t=r(27378);const s={},i=t.createContext(s);function c(e){const n=t.useContext(i);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:c(e.components),t.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/71748509.e56064a2.js b/assets/js/71748509.ed3b7894.js similarity index 97% rename from assets/js/71748509.e56064a2.js rename to assets/js/71748509.ed3b7894.js index 2d2a358e960..c558b592e74 100644 --- a/assets/js/71748509.e56064a2.js +++ b/assets/js/71748509.ed3b7894.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[97227],{84530:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>a,contentTitle:()=>c,default:()=>l,frontMatter:()=>i,metadata:()=>o,toc:()=>u});var r=s(24246),t=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:"Function: suggestRegistry()",permalink:"/api/namespaces/registry/functions/suggestRegistry"},next:{title:"Namespace: tray",permalink:"/api/namespaces/tray/"}},a={},u=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function d(e){const 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-unregisterregistry",children:"Function: unregisterRegistry()"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"unregisterRegistry"}),"(",(0,r.jsx)(n.code,{children:"registry"}),"): ",(0,r.jsx)(n.code,{children:"void"})]}),"\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:"registry"}),": ",(0,r.jsx)(n.a,{href:"/api/interfaces/Registry",children:(0,r.jsx)(n.code,{children:"Registry"})})]}),"\n",(0,r.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.code,{children:"void"})}),"\n",(0,r.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L625",children:"packages/extension-api/src/extension-api.d.ts:625"})})]})}function l(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(d,{...e})}):d(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>o,a:()=>c});var r=s(27378);const t={},i=r.createContext(t);function c(e){const n=r.useContext(i);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:c(e.components),r.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[97227],{84530:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>a,contentTitle:()=>c,default:()=>l,frontMatter:()=>i,metadata:()=>o,toc:()=>u});var r=s(24246),t=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:"Function: suggestRegistry()",permalink:"/api/namespaces/registry/functions/suggestRegistry"},next:{title:"Namespace: tray",permalink:"/api/namespaces/tray/"}},a={},u=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function d(e){const 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-unregisterregistry",children:"Function: unregisterRegistry()"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"unregisterRegistry"}),"(",(0,r.jsx)(n.code,{children:"registry"}),"): ",(0,r.jsx)(n.code,{children:"void"})]}),"\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:"registry"}),": ",(0,r.jsx)(n.a,{href:"/api/interfaces/Registry",children:(0,r.jsx)(n.code,{children:"Registry"})})]}),"\n",(0,r.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.code,{children:"void"})}),"\n",(0,r.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L625",children:"packages/extension-api/src/extension-api.d.ts:625"})})]})}function l(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(d,{...e})}):d(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>o,a:()=>c});var r=s(27378);const t={},i=r.createContext(t);function c(e){const n=r.useContext(i);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:c(e.components),r.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/7258860f.68820e48.js b/assets/js/7258860f.306f4d7e.js similarity index 97% rename from assets/js/7258860f.68820e48.js rename to assets/js/7258860f.306f4d7e.js index fd9b62bc753..3e599bf6e60 100644 --- a/assets/js/7258860f.68820e48.js +++ b/assets/js/7258860f.306f4d7e.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[92423],{79993:(n,e,t)=>{t.r(e),t.d(e,{assets:()=>a,contentTitle:()=>r,default:()=>h,frontMatter:()=>o,metadata:()=>c,toc:()=>d});var i=t(24246),s=t(71670);const o={},r="Function: logsContainer()",c={id:"namespaces/containerEngine/functions/logsContainer",title:"Function: logsContainer()",description:"logsContainer(engineId, id, callback): Promise\\",source:"@site/api/namespaces/containerEngine/functions/logsContainer.md",sourceDirName:"namespaces/containerEngine/functions",slug:"/namespaces/containerEngine/functions/logsContainer",permalink:"/api/namespaces/containerEngine/functions/logsContainer",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Function: listVolumes()",permalink:"/api/namespaces/containerEngine/functions/listVolumes"},next:{title:"Function: onEvent()",permalink:"/api/namespaces/containerEngine/functions/onEvent"}},a={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function l(n){const e={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,s.a)(),...n.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(e.h1,{id:"function-logscontainer",children:"Function: logsContainer()"}),"\n",(0,i.jsxs)(e.blockquote,{children:["\n",(0,i.jsxs)(e.p,{children:[(0,i.jsx)(e.strong,{children:"logsContainer"}),"(",(0,i.jsx)(e.code,{children:"engineId"}),", ",(0,i.jsx)(e.code,{children:"id"}),", ",(0,i.jsx)(e.code,{children:"callback"}),"): ",(0,i.jsx)(e.code,{children:"Promise"}),"< ",(0,i.jsx)(e.code,{children:"void"})," >"]}),"\n"]}),"\n",(0,i.jsx)(e.p,{children:"Get the streamed logs of a container"}),"\n",(0,i.jsx)(e.h2,{id:"parameters",children:"Parameters"}),"\n",(0,i.jsxs)(e.p,{children:["\u2022 ",(0,i.jsx)(e.strong,{children:"engineId"}),": ",(0,i.jsx)(e.code,{children:"string"})]}),"\n",(0,i.jsxs)(e.p,{children:["the id of the engine managing the container, obtained from the result of ",(0,i.jsx)(e.a,{href:"/api/namespaces/containerEngine/functions/listContainers",children:"containerEngine.listContainers"})]}),"\n",(0,i.jsxs)(e.p,{children:["\u2022 ",(0,i.jsx)(e.strong,{children:"id"}),": ",(0,i.jsx)(e.code,{children:"string"})]}),"\n",(0,i.jsxs)(e.p,{children:["the id of the container on this engine, obtained from the result of ",(0,i.jsx)(e.a,{href:"/api/namespaces/containerEngine/functions/listContainers",children:"containerEngine.listContainers"})," or as the result of ",(0,i.jsx)(e.a,{href:"/api/namespaces/containerEngine/functions/createContainer",children:"containerEngine.createContainer"})]}),"\n",(0,i.jsxs)(e.p,{children:["\u2022 ",(0,i.jsx)(e.strong,{children:"callback"})]}),"\n",(0,i.jsxs)(e.p,{children:["the function called when new logs are emitted or new events happen on the stream. The value of ",(0,i.jsx)(e.code,{children:"name"})," can be either ",(0,i.jsx)(e.code,{children:"data"})," (and ",(0,i.jsx)(e.code,{children:"data"})," contains the logs), or ",(0,i.jsx)(e.code,{children:"end"})," indicating the end of the stream, or ",(0,i.jsx)(e.code,{children:"first-message"})," indicating no data has been emitted yet on the stream."]}),"\n",(0,i.jsx)(e.h2,{id:"returns",children:"Returns"}),"\n",(0,i.jsxs)(e.p,{children:[(0,i.jsx)(e.code,{children:"Promise"}),"< ",(0,i.jsx)(e.code,{children:"void"})," >"]}),"\n",(0,i.jsx)(e.h2,{id:"source",children:"Source"}),"\n",(0,i.jsx)(e.p,{children:(0,i.jsx)(e.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L3196",children:"packages/extension-api/src/extension-api.d.ts:3196"})})]})}function h(n={}){const{wrapper:e}={...(0,s.a)(),...n.components};return e?(0,i.jsx)(e,{...n,children:(0,i.jsx)(l,{...n})}):l(n)}},71670:(n,e,t)=>{t.d(e,{Z:()=>c,a:()=>r});var i=t(27378);const s={},o=i.createContext(s);function r(n){const e=i.useContext(o);return i.useMemo((function(){return"function"==typeof n?n(e):{...e,...n}}),[e,n])}function c(n){let e;return e=n.disableParentContext?"function"==typeof n.components?n.components(s):n.components||s:r(n.components),i.createElement(o.Provider,{value:e},n.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[92423],{79993:(n,e,t)=>{t.r(e),t.d(e,{assets:()=>a,contentTitle:()=>r,default:()=>h,frontMatter:()=>o,metadata:()=>c,toc:()=>d});var i=t(24246),s=t(71670);const o={},r="Function: logsContainer()",c={id:"namespaces/containerEngine/functions/logsContainer",title:"Function: logsContainer()",description:"logsContainer(engineId, id, callback): Promise\\",source:"@site/api/namespaces/containerEngine/functions/logsContainer.md",sourceDirName:"namespaces/containerEngine/functions",slug:"/namespaces/containerEngine/functions/logsContainer",permalink:"/api/namespaces/containerEngine/functions/logsContainer",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Function: listVolumes()",permalink:"/api/namespaces/containerEngine/functions/listVolumes"},next:{title:"Function: onEvent()",permalink:"/api/namespaces/containerEngine/functions/onEvent"}},a={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function l(n){const e={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,s.a)(),...n.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(e.h1,{id:"function-logscontainer",children:"Function: logsContainer()"}),"\n",(0,i.jsxs)(e.blockquote,{children:["\n",(0,i.jsxs)(e.p,{children:[(0,i.jsx)(e.strong,{children:"logsContainer"}),"(",(0,i.jsx)(e.code,{children:"engineId"}),", ",(0,i.jsx)(e.code,{children:"id"}),", ",(0,i.jsx)(e.code,{children:"callback"}),"): ",(0,i.jsx)(e.code,{children:"Promise"}),"< ",(0,i.jsx)(e.code,{children:"void"})," >"]}),"\n"]}),"\n",(0,i.jsx)(e.p,{children:"Get the streamed logs of a container"}),"\n",(0,i.jsx)(e.h2,{id:"parameters",children:"Parameters"}),"\n",(0,i.jsxs)(e.p,{children:["\u2022 ",(0,i.jsx)(e.strong,{children:"engineId"}),": ",(0,i.jsx)(e.code,{children:"string"})]}),"\n",(0,i.jsxs)(e.p,{children:["the id of the engine managing the container, obtained from the result of ",(0,i.jsx)(e.a,{href:"/api/namespaces/containerEngine/functions/listContainers",children:"containerEngine.listContainers"})]}),"\n",(0,i.jsxs)(e.p,{children:["\u2022 ",(0,i.jsx)(e.strong,{children:"id"}),": ",(0,i.jsx)(e.code,{children:"string"})]}),"\n",(0,i.jsxs)(e.p,{children:["the id of the container on this engine, obtained from the result of ",(0,i.jsx)(e.a,{href:"/api/namespaces/containerEngine/functions/listContainers",children:"containerEngine.listContainers"})," or as the result of ",(0,i.jsx)(e.a,{href:"/api/namespaces/containerEngine/functions/createContainer",children:"containerEngine.createContainer"})]}),"\n",(0,i.jsxs)(e.p,{children:["\u2022 ",(0,i.jsx)(e.strong,{children:"callback"})]}),"\n",(0,i.jsxs)(e.p,{children:["the function called when new logs are emitted or new events happen on the stream. The value of ",(0,i.jsx)(e.code,{children:"name"})," can be either ",(0,i.jsx)(e.code,{children:"data"})," (and ",(0,i.jsx)(e.code,{children:"data"})," contains the logs), or ",(0,i.jsx)(e.code,{children:"end"})," indicating the end of the stream, or ",(0,i.jsx)(e.code,{children:"first-message"})," indicating no data has been emitted yet on the stream."]}),"\n",(0,i.jsx)(e.h2,{id:"returns",children:"Returns"}),"\n",(0,i.jsxs)(e.p,{children:[(0,i.jsx)(e.code,{children:"Promise"}),"< ",(0,i.jsx)(e.code,{children:"void"})," >"]}),"\n",(0,i.jsx)(e.h2,{id:"source",children:"Source"}),"\n",(0,i.jsx)(e.p,{children:(0,i.jsx)(e.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L3196",children:"packages/extension-api/src/extension-api.d.ts:3196"})})]})}function h(n={}){const{wrapper:e}={...(0,s.a)(),...n.components};return e?(0,i.jsx)(e,{...n,children:(0,i.jsx)(l,{...n})}):l(n)}},71670:(n,e,t)=>{t.d(e,{Z:()=>c,a:()=>r});var i=t(27378);const s={},o=i.createContext(s);function r(n){const e=i.useContext(o);return i.useMemo((function(){return"function"==typeof n?n(e):{...e,...n}}),[e,n])}function c(n){let e;return e=n.disableParentContext?"function"==typeof n.components?n.components(s):n.components||s:r(n.components),i.createElement(o.Provider,{value:e},n.children)}}}]); \ No newline at end of file diff --git a/assets/js/73f18a6f.9ecd316f.js b/assets/js/73f18a6f.5462fb52.js similarity index 97% rename from assets/js/73f18a6f.9ecd316f.js rename to assets/js/73f18a6f.5462fb52.js index 3cc08a65b80..3e524a041ef 100644 --- a/assets/js/73f18a6f.9ecd316f.js +++ b/assets/js/73f18a6f.5462fb52.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[14499],{93268:(e,r,n)=>{n.r(r),n.d(r,{assets:()=>a,contentTitle:()=>s,default:()=>u,frontMatter:()=>o,metadata:()=>c,toc:()=>d});var t=n(24246),i=n(71670);const o={},s="Function: createProvider()",c={id:"namespaces/provider/functions/createProvider",title:"Function: createProvider()",description:"createProvider(provider): Provider",source:"@site/api/namespaces/provider/functions/createProvider.md",sourceDirName:"namespaces/provider/functions",slug:"/namespaces/provider/functions/createProvider",permalink:"/api/namespaces/provider/functions/createProvider",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Namespace: provider",permalink:"/api/namespaces/provider/"},next:{title:"Function: getContainerConnections()",permalink:"/api/namespaces/provider/functions/getContainerConnections"}},a={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function p(e){const r={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,i.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(r.h1,{id:"function-createprovider",children:"Function: createProvider()"}),"\n",(0,t.jsxs)(r.blockquote,{children:["\n",(0,t.jsxs)(r.p,{children:[(0,t.jsx)(r.strong,{children:"createProvider"}),"(",(0,t.jsx)(r.code,{children:"provider"}),"): ",(0,t.jsx)(r.a,{href:"/api/interfaces/Provider",children:(0,t.jsx)(r.code,{children:"Provider"})})]}),"\n"]}),"\n",(0,t.jsx)(r.h2,{id:"parameters",children:"Parameters"}),"\n",(0,t.jsxs)(r.p,{children:["\u2022 ",(0,t.jsx)(r.strong,{children:"provider"}),": ",(0,t.jsx)(r.a,{href:"/api/interfaces/ProviderOptions",children:(0,t.jsx)(r.code,{children:"ProviderOptions"})})]}),"\n",(0,t.jsx)(r.h2,{id:"returns",children:"Returns"}),"\n",(0,t.jsx)(r.p,{children:(0,t.jsx)(r.a,{href:"/api/interfaces/Provider",children:(0,t.jsx)(r.code,{children:"Provider"})})}),"\n",(0,t.jsx)(r.h2,{id:"source",children:"Source"}),"\n",(0,t.jsx)(r.p,{children:(0,t.jsx)(r.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L545",children:"packages/extension-api/src/extension-api.d.ts:545"})})]})}function u(e={}){const{wrapper:r}={...(0,i.a)(),...e.components};return r?(0,t.jsx)(r,{...e,children:(0,t.jsx)(p,{...e})}):p(e)}},71670:(e,r,n)=>{n.d(r,{Z:()=>c,a:()=>s});var t=n(27378);const i={},o=t.createContext(i);function s(e){const r=t.useContext(o);return t.useMemo((function(){return"function"==typeof e?e(r):{...r,...e}}),[r,e])}function c(e){let r;return r=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:s(e.components),t.createElement(o.Provider,{value:r},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[14499],{93268:(e,r,n)=>{n.r(r),n.d(r,{assets:()=>a,contentTitle:()=>s,default:()=>u,frontMatter:()=>o,metadata:()=>c,toc:()=>d});var t=n(24246),i=n(71670);const o={},s="Function: createProvider()",c={id:"namespaces/provider/functions/createProvider",title:"Function: createProvider()",description:"createProvider(provider): Provider",source:"@site/api/namespaces/provider/functions/createProvider.md",sourceDirName:"namespaces/provider/functions",slug:"/namespaces/provider/functions/createProvider",permalink:"/api/namespaces/provider/functions/createProvider",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Namespace: provider",permalink:"/api/namespaces/provider/"},next:{title:"Function: getContainerConnections()",permalink:"/api/namespaces/provider/functions/getContainerConnections"}},a={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function p(e){const r={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,i.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(r.h1,{id:"function-createprovider",children:"Function: createProvider()"}),"\n",(0,t.jsxs)(r.blockquote,{children:["\n",(0,t.jsxs)(r.p,{children:[(0,t.jsx)(r.strong,{children:"createProvider"}),"(",(0,t.jsx)(r.code,{children:"provider"}),"): ",(0,t.jsx)(r.a,{href:"/api/interfaces/Provider",children:(0,t.jsx)(r.code,{children:"Provider"})})]}),"\n"]}),"\n",(0,t.jsx)(r.h2,{id:"parameters",children:"Parameters"}),"\n",(0,t.jsxs)(r.p,{children:["\u2022 ",(0,t.jsx)(r.strong,{children:"provider"}),": ",(0,t.jsx)(r.a,{href:"/api/interfaces/ProviderOptions",children:(0,t.jsx)(r.code,{children:"ProviderOptions"})})]}),"\n",(0,t.jsx)(r.h2,{id:"returns",children:"Returns"}),"\n",(0,t.jsx)(r.p,{children:(0,t.jsx)(r.a,{href:"/api/interfaces/Provider",children:(0,t.jsx)(r.code,{children:"Provider"})})}),"\n",(0,t.jsx)(r.h2,{id:"source",children:"Source"}),"\n",(0,t.jsx)(r.p,{children:(0,t.jsx)(r.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L545",children:"packages/extension-api/src/extension-api.d.ts:545"})})]})}function u(e={}){const{wrapper:r}={...(0,i.a)(),...e.components};return r?(0,t.jsx)(r,{...e,children:(0,t.jsx)(p,{...e})}):p(e)}},71670:(e,r,n)=>{n.d(r,{Z:()=>c,a:()=>s});var t=n(27378);const i={},o=t.createContext(i);function s(e){const r=t.useContext(o);return t.useMemo((function(){return"function"==typeof e?e(r):{...r,...e}}),[r,e])}function c(e){let r;return r=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:s(e.components),t.createElement(o.Provider,{value:r},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/73f9658e.8e2732f7.js b/assets/js/73f9658e.55449af1.js similarity index 97% rename from assets/js/73f9658e.8e2732f7.js rename to assets/js/73f9658e.55449af1.js index ffc574d7523..fac069b98a7 100644 --- a/assets/js/73f9658e.8e2732f7.js +++ b/assets/js/73f9658e.55449af1.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[61305],{40680:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>o,contentTitle:()=>c,default:()=>l,frontMatter:()=>a,metadata:()=>r,toc:()=>d});var i=s(24246),t=s(71670);const a={},c="Function: pushImage()",r={id:"namespaces/containerEngine/functions/pushImage",title:"Function: pushImage()",description:"pushImage(engineId, imageId, callback, authInfo?): Promise\\",source:"@site/api/namespaces/containerEngine/functions/pushImage.md",sourceDirName:"namespaces/containerEngine/functions",slug:"/namespaces/containerEngine/functions/pushImage",permalink:"/api/namespaces/containerEngine/functions/pushImage",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Function: pullImage()",permalink:"/api/namespaces/containerEngine/functions/pullImage"},next:{title:"Function: removePod()",permalink:"/api/namespaces/containerEngine/functions/removePod"}},o={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function h(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,t.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"function-pushimage",children:"Function: pushImage()"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"pushImage"}),"(",(0,i.jsx)(n.code,{children:"engineId"}),", ",(0,i.jsx)(n.code,{children:"imageId"}),", ",(0,i.jsx)(n.code,{children:"callback"}),", ",(0,i.jsx)(n.code,{children:"authInfo"}),"?): ",(0,i.jsx)(n.code,{children:"Promise"}),"< ",(0,i.jsx)(n.code,{children:"void"})," >"]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Push an image to a registry."}),"\n",(0,i.jsxs)(n.p,{children:["If you wish to push an image on to a private registry, that image must already have a tag which references the registry. For example, ",(0,i.jsx)(n.code,{children:"registry.example.com/myimage:latest"}),"."]}),"\n",(0,i.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"engineId"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n",(0,i.jsxs)(n.p,{children:["the id of the engine managing the image, obtained from the result of ",(0,i.jsx)(n.a,{href:"/api/namespaces/containerEngine/functions/listImages",children:"containerEngine.listImages"})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"imageId"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n",(0,i.jsxs)(n.p,{children:["the id of the image on this engine, obtained from the result of ",(0,i.jsx)(n.a,{href:"/api/namespaces/containerEngine/functions/listImages",children:"containerEngine.listImages"})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"callback"})]}),"\n",(0,i.jsxs)(n.p,{children:["the function called when new logs are emitted or new events happen on the stream. The value of ",(0,i.jsx)(n.code,{children:"name"})," can be either ",(0,i.jsx)(n.code,{children:"data"}),"(and ",(0,i.jsx)(n.code,{children:"data"})," contains the logs), or ",(0,i.jsx)(n.code,{children:"end"})," indicating the end of the stream, or ",(0,i.jsx)(n.code,{children:"first-message"})," indicating no data has been emitted yet on the stream."]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"authInfo?"}),": ",(0,i.jsx)(n.a,{href:"/api/interfaces/ContainerAuthInfo",children:(0,i.jsx)(n.code,{children:"ContainerAuthInfo"})})]}),"\n",(0,i.jsx)(n.p,{children:"Authentication credentials"}),"\n",(0,i.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"Promise"}),"< ",(0,i.jsx)(n.code,{children:"void"})," >"]}),"\n",(0,i.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L3305",children:"packages/extension-api/src/extension-api.d.ts:3305"})})]})}function l(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(h,{...e})}):h(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>r,a:()=>c});var i=s(27378);const t={},a=i.createContext(t);function c(e){const n=i.useContext(a);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function r(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:c(e.components),i.createElement(a.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[61305],{40680:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>o,contentTitle:()=>c,default:()=>l,frontMatter:()=>a,metadata:()=>r,toc:()=>d});var i=s(24246),t=s(71670);const a={},c="Function: pushImage()",r={id:"namespaces/containerEngine/functions/pushImage",title:"Function: pushImage()",description:"pushImage(engineId, imageId, callback, authInfo?): Promise\\",source:"@site/api/namespaces/containerEngine/functions/pushImage.md",sourceDirName:"namespaces/containerEngine/functions",slug:"/namespaces/containerEngine/functions/pushImage",permalink:"/api/namespaces/containerEngine/functions/pushImage",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Function: pullImage()",permalink:"/api/namespaces/containerEngine/functions/pullImage"},next:{title:"Function: removePod()",permalink:"/api/namespaces/containerEngine/functions/removePod"}},o={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function h(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,t.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"function-pushimage",children:"Function: pushImage()"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"pushImage"}),"(",(0,i.jsx)(n.code,{children:"engineId"}),", ",(0,i.jsx)(n.code,{children:"imageId"}),", ",(0,i.jsx)(n.code,{children:"callback"}),", ",(0,i.jsx)(n.code,{children:"authInfo"}),"?): ",(0,i.jsx)(n.code,{children:"Promise"}),"< ",(0,i.jsx)(n.code,{children:"void"})," >"]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Push an image to a registry."}),"\n",(0,i.jsxs)(n.p,{children:["If you wish to push an image on to a private registry, that image must already have a tag which references the registry. For example, ",(0,i.jsx)(n.code,{children:"registry.example.com/myimage:latest"}),"."]}),"\n",(0,i.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"engineId"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n",(0,i.jsxs)(n.p,{children:["the id of the engine managing the image, obtained from the result of ",(0,i.jsx)(n.a,{href:"/api/namespaces/containerEngine/functions/listImages",children:"containerEngine.listImages"})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"imageId"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n",(0,i.jsxs)(n.p,{children:["the id of the image on this engine, obtained from the result of ",(0,i.jsx)(n.a,{href:"/api/namespaces/containerEngine/functions/listImages",children:"containerEngine.listImages"})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"callback"})]}),"\n",(0,i.jsxs)(n.p,{children:["the function called when new logs are emitted or new events happen on the stream. The value of ",(0,i.jsx)(n.code,{children:"name"})," can be either ",(0,i.jsx)(n.code,{children:"data"}),"(and ",(0,i.jsx)(n.code,{children:"data"})," contains the logs), or ",(0,i.jsx)(n.code,{children:"end"})," indicating the end of the stream, or ",(0,i.jsx)(n.code,{children:"first-message"})," indicating no data has been emitted yet on the stream."]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"authInfo?"}),": ",(0,i.jsx)(n.a,{href:"/api/interfaces/ContainerAuthInfo",children:(0,i.jsx)(n.code,{children:"ContainerAuthInfo"})})]}),"\n",(0,i.jsx)(n.p,{children:"Authentication credentials"}),"\n",(0,i.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"Promise"}),"< ",(0,i.jsx)(n.code,{children:"void"})," >"]}),"\n",(0,i.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L3305",children:"packages/extension-api/src/extension-api.d.ts:3305"})})]})}function l(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(h,{...e})}):h(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>r,a:()=>c});var i=s(27378);const t={},a=i.createContext(t);function c(e){const n=i.useContext(a);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function r(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:c(e.components),i.createElement(a.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/74b658de.9477da39.js b/assets/js/74b658de.0a0f47e0.js similarity index 89% rename from assets/js/74b658de.9477da39.js rename to assets/js/74b658de.0a0f47e0.js index df936af1bc1..9966abb7009 100644 --- a/assets/js/74b658de.9477da39.js +++ b/assets/js/74b658de.0a0f47e0.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[62283],{59451:(e,n,o)=>{o.r(n),o.d(n,{assets:()=>a,contentTitle:()=>i,default:()=>p,frontMatter:()=>r,metadata:()=>c,toc:()=>d});var s=o(24246),t=o(71670);const r={},i="Function: removePod()",c={id:"namespaces/containerEngine/functions/removePod",title:"Function: removePod()",description:"removePod(engineId, podId): Promise\\",source:"@site/api/namespaces/containerEngine/functions/removePod.md",sourceDirName:"namespaces/containerEngine/functions",slug:"/namespaces/containerEngine/functions/removePod",permalink:"/api/namespaces/containerEngine/functions/removePod",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Function: pushImage()",permalink:"/api/namespaces/containerEngine/functions/pushImage"},next:{title:"Function: replicatePodmanContainer()",permalink:"/api/namespaces/containerEngine/functions/replicatePodmanContainer"}},a={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,t.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"function-removepod",children:"Function: removePod()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"removePod"}),"(",(0,s.jsx)(n.code,{children:"engineId"}),", ",(0,s.jsx)(n.code,{children:"podId"}),"): ",(0,s.jsx)(n.code,{children:"Promise"}),"< ",(0,s.jsx)(n.code,{children:"void"})," >"]}),"\n"]}),"\n",(0,s.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"engineId"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"podId"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n",(0,s.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"Promise"}),"< ",(0,s.jsx)(n.code,{children:"void"})," >"]}),"\n",(0,s.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L3383",children:"packages/extension-api/src/extension-api.d.ts:3383"})})]})}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,o)=>{o.d(n,{Z:()=>c,a:()=>i});var s=o(27378);const t={},r=s.createContext(t);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(t):e.components||t:i(e.components),s.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[62283],{59451:(e,n,o)=>{o.r(n),o.d(n,{assets:()=>d,contentTitle:()=>i,default:()=>p,frontMatter:()=>r,metadata:()=>c,toc:()=>a});var s=o(24246),t=o(71670);const r={},i="Function: removePod()",c={id:"namespaces/containerEngine/functions/removePod",title:"Function: removePod()",description:"removePod(engineId, podId): Promise\\",source:"@site/api/namespaces/containerEngine/functions/removePod.md",sourceDirName:"namespaces/containerEngine/functions",slug:"/namespaces/containerEngine/functions/removePod",permalink:"/api/namespaces/containerEngine/functions/removePod",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Function: pushImage()",permalink:"/api/namespaces/containerEngine/functions/pushImage"},next:{title:"Function: replicatePodmanContainer()",permalink:"/api/namespaces/containerEngine/functions/replicatePodmanContainer"}},d={},a=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,t.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"function-removepod",children:"Function: removePod()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"removePod"}),"(",(0,s.jsx)(n.code,{children:"engineId"}),", ",(0,s.jsx)(n.code,{children:"podId"}),"): ",(0,s.jsx)(n.code,{children:"Promise"}),"< ",(0,s.jsx)(n.code,{children:"void"})," >"]}),"\n"]}),"\n",(0,s.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"engineId"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"podId"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n",(0,s.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"Promise"}),"< ",(0,s.jsx)(n.code,{children:"void"})," >"]}),"\n",(0,s.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L3383",children:"packages/extension-api/src/extension-api.d.ts:3383"})})]})}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,o)=>{o.d(n,{Z:()=>c,a:()=>i});var s=o(27378);const t={},r=s.createContext(t);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(t):e.components||t:i(e.components),s.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/7500e360.f1814908.js b/assets/js/7500e360.e298db0a.js similarity index 84% rename from assets/js/7500e360.f1814908.js rename to assets/js/7500e360.e298db0a.js index 88390073500..b9374aa2a6d 100644 --- a/assets/js/7500e360.f1814908.js +++ b/assets/js/7500e360.e298db0a.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[86272],{22147:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>r,contentTitle:()=>c,default:()=>h,frontMatter:()=>t,metadata:()=>a,toc:()=>d});var o=s(24246),i=s(71670);const t={},c="Function: showSaveDialog()",a={id:"namespaces/window/functions/showSaveDialog",title:"Function: showSaveDialog()",description:"showSaveDialog(options?): Promise\\",source:"@site/api/namespaces/window/functions/showSaveDialog.md",sourceDirName:"namespaces/window/functions",slug:"/namespaces/window/functions/showSaveDialog",permalink:"/api/namespaces/window/functions/showSaveDialog",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Function: showQuickPick()",permalink:"/api/namespaces/window/functions/showQuickPick"},next:{title:"Function: showWarningMessage()",permalink:"/api/namespaces/window/functions/showWarningMessage"}},r={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,i.a)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(n.h1,{id:"function-showsavedialog",children:"Function: showSaveDialog()"}),"\n",(0,o.jsxs)(n.blockquote,{children:["\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.strong,{children:"showSaveDialog"}),"(",(0,o.jsx)(n.code,{children:"options"}),"?): ",(0,o.jsx)(n.code,{children:"Promise"}),"< ",(0,o.jsx)(n.a,{href:"/api/classes/Uri",children:(0,o.jsx)(n.code,{children:"Uri"})})," | ",(0,o.jsx)(n.code,{children:"undefined"})," >"]}),"\n"]}),"\n",(0,o.jsx)(n.p,{children:"Shows a file save dialog to the user which allows to select a file\nfor saving-purposes."}),"\n",(0,o.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,o.jsxs)(n.p,{children:["\u2022 ",(0,o.jsx)(n.strong,{children:"options?"}),": ",(0,o.jsx)(n.a,{href:"/api/interfaces/SaveDialogOptions",children:(0,o.jsx)(n.code,{children:"SaveDialogOptions"})})]}),"\n",(0,o.jsx)(n.p,{children:"Options that control the dialog."}),"\n",(0,o.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.code,{children:"Promise"}),"< ",(0,o.jsx)(n.a,{href:"/api/classes/Uri",children:(0,o.jsx)(n.code,{children:"Uri"})})," | ",(0,o.jsx)(n.code,{children:"undefined"})," >"]}),"\n",(0,o.jsxs)(n.p,{children:["A promise that resolves to the selected resource or ",(0,o.jsx)(n.code,{children:"undefined"}),"."]}),"\n",(0,o.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,o.jsx)(n.p,{children:(0,o.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L1722",children:"packages/extension-api/src/extension-api.d.ts:1722"})})]})}function h(e={}){const{wrapper:n}={...(0,i.a)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(l,{...e})}):l(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>a,a:()=>c});var o=s(27378);const i={},t=o.createContext(i);function c(e){const n=o.useContext(t);return o.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function a(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:c(e.components),o.createElement(t.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[86272],{22147:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>a,contentTitle:()=>c,default:()=>h,frontMatter:()=>t,metadata:()=>r,toc:()=>d});var o=s(24246),i=s(71670);const t={},c="Function: showSaveDialog()",r={id:"namespaces/window/functions/showSaveDialog",title:"Function: showSaveDialog()",description:"showSaveDialog(options?): Promise\\",source:"@site/api/namespaces/window/functions/showSaveDialog.md",sourceDirName:"namespaces/window/functions",slug:"/namespaces/window/functions/showSaveDialog",permalink:"/api/namespaces/window/functions/showSaveDialog",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Function: showQuickPick()",permalink:"/api/namespaces/window/functions/showQuickPick"},next:{title:"Function: showWarningMessage()",permalink:"/api/namespaces/window/functions/showWarningMessage"}},a={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,i.a)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(n.h1,{id:"function-showsavedialog",children:"Function: showSaveDialog()"}),"\n",(0,o.jsxs)(n.blockquote,{children:["\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.strong,{children:"showSaveDialog"}),"(",(0,o.jsx)(n.code,{children:"options"}),"?): ",(0,o.jsx)(n.code,{children:"Promise"}),"< ",(0,o.jsx)(n.a,{href:"/api/classes/Uri",children:(0,o.jsx)(n.code,{children:"Uri"})})," | ",(0,o.jsx)(n.code,{children:"undefined"})," >"]}),"\n"]}),"\n",(0,o.jsx)(n.p,{children:"Shows a file save dialog to the user which allows to select a file\nfor saving-purposes."}),"\n",(0,o.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,o.jsxs)(n.p,{children:["\u2022 ",(0,o.jsx)(n.strong,{children:"options?"}),": ",(0,o.jsx)(n.a,{href:"/api/interfaces/SaveDialogOptions",children:(0,o.jsx)(n.code,{children:"SaveDialogOptions"})})]}),"\n",(0,o.jsx)(n.p,{children:"Options that control the dialog."}),"\n",(0,o.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.code,{children:"Promise"}),"< ",(0,o.jsx)(n.a,{href:"/api/classes/Uri",children:(0,o.jsx)(n.code,{children:"Uri"})})," | ",(0,o.jsx)(n.code,{children:"undefined"})," >"]}),"\n",(0,o.jsxs)(n.p,{children:["A promise that resolves to the selected resource or ",(0,o.jsx)(n.code,{children:"undefined"}),"."]}),"\n",(0,o.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,o.jsx)(n.p,{children:(0,o.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L1722",children:"packages/extension-api/src/extension-api.d.ts:1722"})})]})}function h(e={}){const{wrapper:n}={...(0,i.a)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(l,{...e})}):l(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>r,a:()=>c});var o=s(27378);const i={},t=o.createContext(i);function c(e){const n=o.useContext(t);return o.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function r(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:c(e.components),o.createElement(t.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/7547d3bb.9f44d157.js b/assets/js/7547d3bb.fffbdd9e.js similarity index 95% rename from assets/js/7547d3bb.9f44d157.js rename to assets/js/7547d3bb.fffbdd9e.js index 903b532f01d..6d57c5d7e93 100644 --- a/assets/js/7547d3bb.9f44d157.js +++ b/assets/js/7547d3bb.fffbdd9e.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[45835],{41528:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>a,contentTitle:()=>s,default:()=>u,frontMatter:()=>i,metadata:()=>c,toc:()=>d});var t=r(24246),o=r(71670);const i={},s="Interface: ProviderCleanup",c={id:"interfaces/ProviderCleanup",title:"Interface: ProviderCleanup",description:"Allow to clean some resources in case for example",source:"@site/api/interfaces/ProviderCleanup.md",sourceDirName:"interfaces",slug:"/interfaces/ProviderCleanup",permalink:"/api/interfaces/ProviderCleanup",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: ProviderAutostart",permalink:"/api/interfaces/ProviderAutostart"},next:{title:"Interface: ProviderCleanupAction",permalink:"/api/interfaces/ProviderCleanupAction"}},a={},d=[{value:"Methods",id:"methods",level:2},{value:"getActions()",id:"getactions",level:3},{value:"Returns",id:"returns",level:4},{value:"Source",id:"source",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",p:"p",strong:"strong",...(0,o.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"interface-providercleanup",children:"Interface: ProviderCleanup"}),"\n",(0,t.jsx)(n.p,{children:"Allow to clean some resources in case for example"}),"\n",(0,t.jsx)(n.h2,{id:"methods",children:"Methods"}),"\n",(0,t.jsx)(n.h3,{id:"getactions",children:"getActions()"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"getActions"}),"(): ",(0,t.jsx)(n.code,{children:"Promise"}),"< ",(0,t.jsx)(n.a,{href:"/api/interfaces/ProviderCleanupAction",children:(0,t.jsx)(n.code,{children:"ProviderCleanupAction"})}),"[] >"]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"returns",children:"Returns"}),"\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"Promise"}),"< ",(0,t.jsx)(n.a,{href:"/api/interfaces/ProviderCleanupAction",children:(0,t.jsx)(n.code,{children:"ProviderCleanupAction"})}),"[] >"]}),"\n",(0,t.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L403",children:"packages/extension-api/src/extension-api.d.ts:403"})})]})}function u(e={}){const{wrapper:n}={...(0,o.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},71670:(e,n,r)=>{r.d(n,{Z:()=>c,a:()=>s});var t=r(27378);const o={},i=t.createContext(o);function s(e){const n=t.useContext(i);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:s(e.components),t.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[45835],{41528:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>a,contentTitle:()=>s,default:()=>u,frontMatter:()=>i,metadata:()=>c,toc:()=>d});var t=r(24246),o=r(71670);const i={},s="Interface: ProviderCleanup",c={id:"interfaces/ProviderCleanup",title:"Interface: ProviderCleanup",description:"Allow to clean some resources in case for example",source:"@site/api/interfaces/ProviderCleanup.md",sourceDirName:"interfaces",slug:"/interfaces/ProviderCleanup",permalink:"/api/interfaces/ProviderCleanup",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: ProviderAutostart",permalink:"/api/interfaces/ProviderAutostart"},next:{title:"Interface: ProviderCleanupAction",permalink:"/api/interfaces/ProviderCleanupAction"}},a={},d=[{value:"Methods",id:"methods",level:2},{value:"getActions()",id:"getactions",level:3},{value:"Returns",id:"returns",level:4},{value:"Source",id:"source",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",p:"p",strong:"strong",...(0,o.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"interface-providercleanup",children:"Interface: ProviderCleanup"}),"\n",(0,t.jsx)(n.p,{children:"Allow to clean some resources in case for example"}),"\n",(0,t.jsx)(n.h2,{id:"methods",children:"Methods"}),"\n",(0,t.jsx)(n.h3,{id:"getactions",children:"getActions()"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"getActions"}),"(): ",(0,t.jsx)(n.code,{children:"Promise"}),"< ",(0,t.jsx)(n.a,{href:"/api/interfaces/ProviderCleanupAction",children:(0,t.jsx)(n.code,{children:"ProviderCleanupAction"})}),"[] >"]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"returns",children:"Returns"}),"\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"Promise"}),"< ",(0,t.jsx)(n.a,{href:"/api/interfaces/ProviderCleanupAction",children:(0,t.jsx)(n.code,{children:"ProviderCleanupAction"})}),"[] >"]}),"\n",(0,t.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L403",children:"packages/extension-api/src/extension-api.d.ts:403"})})]})}function u(e={}){const{wrapper:n}={...(0,o.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},71670:(e,n,r)=>{r.d(n,{Z:()=>c,a:()=>s});var t=r(27378);const o={},i=t.createContext(o);function s(e){const n=t.useContext(i);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:s(e.components),t.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/786fee93.d444be09.js b/assets/js/786fee93.dba84eb4.js similarity index 89% rename from assets/js/786fee93.d444be09.js rename to assets/js/786fee93.dba84eb4.js index 94d5f270319..b8a0cfc3533 100644 --- a/assets/js/786fee93.d444be09.js +++ b/assets/js/786fee93.dba84eb4.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[7371],{79261:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>o,contentTitle:()=>r,default:()=>p,frontMatter:()=>t,metadata:()=>c,toc:()=>l});var i=s(24246),a=s(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:"Variable: clipboard",permalink:"/api/namespaces/env/variables/clipboard"},next:{title:"Variable: isMac",permalink:"/api/namespaces/env/variables/isMac"}},o={},l=[{value:"Source",id:"source",level:2}];function u(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,a.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"variable-islinux",children:"Variable: isLinux"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"const"})})," ",(0,i.jsx)(n.strong,{children:"isLinux"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Flag indicating whether we are running on a Linux operating system."}),"\n",(0,i.jsx)(n.p,{children:"If the value of this flag is true, it means the current system is Linux.\nIf the value is false, it means the current system is not Linux."}),"\n",(0,i.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L3683",children:"packages/extension-api/src/extension-api.d.ts:3683"})})]})}function p(e={}){const{wrapper:n}={...(0,a.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(u,{...e})}):u(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>c,a:()=>r});var i=s(27378);const a={},t=i.createContext(a);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(a):e.components||a:r(e.components),i.createElement(t.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[7371],{79261:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>o,contentTitle:()=>r,default:()=>d,frontMatter:()=>t,metadata:()=>c,toc:()=>l});var i=s(24246),a=s(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:"Variable: clipboard",permalink:"/api/namespaces/env/variables/clipboard"},next:{title:"Variable: isMac",permalink:"/api/namespaces/env/variables/isMac"}},o={},l=[{value:"Source",id:"source",level:2}];function u(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,a.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"variable-islinux",children:"Variable: isLinux"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"const"})})," ",(0,i.jsx)(n.strong,{children:"isLinux"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Flag indicating whether we are running on a Linux operating system."}),"\n",(0,i.jsx)(n.p,{children:"If the value of this flag is true, it means the current system is Linux.\nIf the value is false, it means the current system is not Linux."}),"\n",(0,i.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L3683",children:"packages/extension-api/src/extension-api.d.ts:3683"})})]})}function d(e={}){const{wrapper:n}={...(0,a.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(u,{...e})}):u(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>c,a:()=>r});var i=s(27378);const a={},t=i.createContext(a);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(a):e.components||a:r(e.components),i.createElement(t.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/79f18c88.3fe305ab.js b/assets/js/79f18c88.d71a505f.js similarity index 90% rename from assets/js/79f18c88.3fe305ab.js rename to assets/js/79f18c88.d71a505f.js index e39c0beb87b..029850bf7b9 100644 --- a/assets/js/79f18c88.3fe305ab.js +++ b/assets/js/79f18c88.d71a505f.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[36006],{15169:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>a,contentTitle:()=>o,default:()=>h,frontMatter:()=>i,metadata:()=>c,toc:()=>d});var r=s(24246),t=s(71670);const i={},o="Interface: ContainerAuthInfo",c={id:"interfaces/ContainerAuthInfo",title:"Interface: ContainerAuthInfo",description:"Authentication credentials, used when pushing an image to a registry",source:"@site/api/interfaces/ContainerAuthInfo.md",sourceDirName:"interfaces",slug:"/interfaces/ContainerAuthInfo",permalink:"/api/interfaces/ContainerAuthInfo",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: ConfigurationChangeEvent",permalink:"/api/interfaces/ConfigurationChangeEvent"},next:{title:"Interface: ContainerCreateOptions",permalink:"/api/interfaces/ContainerCreateOptions"}},a={},d=[{value:"Properties",id:"properties",level:2},{value:"email?",id:"email",level:3},{value:"Source",id:"source",level:4},{value:"password",id:"password",level:3},{value:"Source",id:"source-1",level:4},{value:"serveraddress",id:"serveraddress",level:3},{value:"Source",id:"source-2",level:4},{value:"username",id:"username",level:3},{value:"Source",id:"source-3",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,t.a)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.h1,{id:"interface-containerauthinfo",children:"Interface: ContainerAuthInfo"}),"\n",(0,r.jsx)(n.p,{children:"Authentication credentials, used when pushing an image to a registry"}),"\n",(0,r.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,r.jsx)(n.h3,{id:"email",children:"email?"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"optional"})})," ",(0,r.jsx)(n.strong,{children:"email"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2377",children:"packages/extension-api/src/extension-api.d.ts:2377"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"password",children:"password"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"password"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2375",children:"packages/extension-api/src/extension-api.d.ts:2375"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"serveraddress",children:"serveraddress"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"serveraddress"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2376",children:"packages/extension-api/src/extension-api.d.ts:2376"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"username",children:"username"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"username"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2374",children:"packages/extension-api/src/extension-api.d.ts:2374"})})]})}function h(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(l,{...e})}):l(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>c,a:()=>o});var r=s(27378);const t={},i=r.createContext(t);function o(e){const n=r.useContext(i);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:o(e.components),r.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[36006],{15169:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>a,contentTitle:()=>o,default:()=>h,frontMatter:()=>i,metadata:()=>c,toc:()=>d});var r=s(24246),t=s(71670);const i={},o="Interface: ContainerAuthInfo",c={id:"interfaces/ContainerAuthInfo",title:"Interface: ContainerAuthInfo",description:"Authentication credentials, used when pushing an image to a registry",source:"@site/api/interfaces/ContainerAuthInfo.md",sourceDirName:"interfaces",slug:"/interfaces/ContainerAuthInfo",permalink:"/api/interfaces/ContainerAuthInfo",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: ConfigurationChangeEvent",permalink:"/api/interfaces/ConfigurationChangeEvent"},next:{title:"Interface: ContainerCreateOptions",permalink:"/api/interfaces/ContainerCreateOptions"}},a={},d=[{value:"Properties",id:"properties",level:2},{value:"email?",id:"email",level:3},{value:"Source",id:"source",level:4},{value:"password",id:"password",level:3},{value:"Source",id:"source-1",level:4},{value:"serveraddress",id:"serveraddress",level:3},{value:"Source",id:"source-2",level:4},{value:"username",id:"username",level:3},{value:"Source",id:"source-3",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,t.a)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.h1,{id:"interface-containerauthinfo",children:"Interface: ContainerAuthInfo"}),"\n",(0,r.jsx)(n.p,{children:"Authentication credentials, used when pushing an image to a registry"}),"\n",(0,r.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,r.jsx)(n.h3,{id:"email",children:"email?"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"optional"})})," ",(0,r.jsx)(n.strong,{children:"email"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2377",children:"packages/extension-api/src/extension-api.d.ts:2377"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"password",children:"password"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"password"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2375",children:"packages/extension-api/src/extension-api.d.ts:2375"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"serveraddress",children:"serveraddress"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"serveraddress"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2376",children:"packages/extension-api/src/extension-api.d.ts:2376"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"username",children:"username"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"username"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2374",children:"packages/extension-api/src/extension-api.d.ts:2374"})})]})}function h(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(l,{...e})}):l(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>c,a:()=>o});var r=s(27378);const t={},i=r.createContext(t);function o(e){const n=r.useContext(i);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:o(e.components),r.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/7aa856d6.8cadbd75.js b/assets/js/7aa856d6.0c28b7a8.js similarity index 96% rename from assets/js/7aa856d6.8cadbd75.js rename to assets/js/7aa856d6.0c28b7a8.js index b55f03b8dcf..4f0495d1bec 100644 --- a/assets/js/7aa856d6.8cadbd75.js +++ b/assets/js/7aa856d6.0c28b7a8.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[886],{97542:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>c,contentTitle:()=>i,default:()=>u,frontMatter:()=>o,metadata:()=>a,toc:()=>l});var r=t(24246),s=t(71670);const o={},i="Variable: version",a={id:"variables/version",title:"Variable: version",description:"const version: string",source:"@site/api/variables/version.md",sourceDirName:"variables",slug:"/variables/version",permalink:"/api/variables/version",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Variable: StatusBarItemDefaultPriority",permalink:"/api/variables/StatusBarItemDefaultPriority"}},c={},l=[{value:"Source",id:"source",level:2}];function d(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.h1,{id:"variable-version",children:"Variable: version"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"const"})})," ",(0,r.jsx)(n.strong,{children:"version"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"The version of Podman Desktop."}),"\n",(0,r.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L23",children:"packages/extension-api/src/extension-api.d.ts:23"})})]})}function u(e={}){const{wrapper:n}={...(0,s.a)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(d,{...e})}):d(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>a,a:()=>i});var r=t(27378);const s={},o=r.createContext(s);function i(e){const n=r.useContext(o);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function a(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:i(e.components),r.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[886],{97542:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>c,contentTitle:()=>i,default:()=>u,frontMatter:()=>o,metadata:()=>a,toc:()=>l});var r=t(24246),s=t(71670);const o={},i="Variable: version",a={id:"variables/version",title:"Variable: version",description:"const version: string",source:"@site/api/variables/version.md",sourceDirName:"variables",slug:"/variables/version",permalink:"/api/variables/version",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Variable: StatusBarItemDefaultPriority",permalink:"/api/variables/StatusBarItemDefaultPriority"}},c={},l=[{value:"Source",id:"source",level:2}];function d(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.h1,{id:"variable-version",children:"Variable: version"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"const"})})," ",(0,r.jsx)(n.strong,{children:"version"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"The version of Podman Desktop."}),"\n",(0,r.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L23",children:"packages/extension-api/src/extension-api.d.ts:23"})})]})}function u(e={}){const{wrapper:n}={...(0,s.a)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(d,{...e})}):d(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>a,a:()=>i});var r=t(27378);const s={},o=r.createContext(s);function i(e){const n=r.useContext(o);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function a(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:i(e.components),r.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/7bef3f04.c8701684.js b/assets/js/7bef3f04.2a0b9418.js similarity index 96% rename from assets/js/7bef3f04.c8701684.js rename to assets/js/7bef3f04.2a0b9418.js index 2bb3e07eb9c..29b99a05b3d 100644 --- a/assets/js/7bef3f04.c8701684.js +++ b/assets/js/7bef3f04.2a0b9418.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[24498],{45613:(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: 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:"Function: getProviderLifecycleContext()",permalink:"/api/namespaces/provider/functions/getProviderLifecycleContext"},next:{title:"Function: onDidUnregisterContainerConnection()",permalink:"/api/namespaces/provider/functions/onDidUnregisterContainerConnection"}},a={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,t.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"function-ondidregistercontainerconnection",children:"Function: onDidRegisterContainerConnection()"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"onDidRegisterContainerConnection"}),"(",(0,i.jsx)(n.code,{children:"listener"}),", ",(0,i.jsx)(n.code,{children:"thisArgs"}),"?, ",(0,i.jsx)(n.code,{children:"disposables"}),"?): ",(0,i.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(n.code,{children:"Disposable"})})]}),"\n"]}),"\n",(0,i.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"listener"})]}),"\n",(0,i.jsx)(n.p,{children:"The listener function will be called when the event happens."}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"thisArgs?"}),": ",(0,i.jsx)(n.code,{children:"any"})]}),"\n",(0,i.jsxs)(n.p,{children:["The ",(0,i.jsx)(n.code,{children:"this"}),"-argument which will be used when calling the event listener."]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"disposables?"}),": ",(0,i.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(n.code,{children:"Disposable"})}),"[]"]}),"\n",(0,i.jsxs)(n.p,{children:["An array to which a ",(0,i.jsx)(n.a,{href:"/api/classes/Disposable",children:"Disposable"})," will be added."]}),"\n",(0,i.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(n.code,{children:"Disposable"})})}),"\n",(0,i.jsx)(n.p,{children:"A disposable which unsubscribes the event listener."}),"\n",(0,i.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L550",children:"packages/extension-api/src/extension-api.d.ts:550"})})]})}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([[24498],{45613:(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: 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:"Function: getProviderLifecycleContext()",permalink:"/api/namespaces/provider/functions/getProviderLifecycleContext"},next:{title:"Function: onDidUnregisterContainerConnection()",permalink:"/api/namespaces/provider/functions/onDidUnregisterContainerConnection"}},a={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,t.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"function-ondidregistercontainerconnection",children:"Function: onDidRegisterContainerConnection()"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"onDidRegisterContainerConnection"}),"(",(0,i.jsx)(n.code,{children:"listener"}),", ",(0,i.jsx)(n.code,{children:"thisArgs"}),"?, ",(0,i.jsx)(n.code,{children:"disposables"}),"?): ",(0,i.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(n.code,{children:"Disposable"})})]}),"\n"]}),"\n",(0,i.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"listener"})]}),"\n",(0,i.jsx)(n.p,{children:"The listener function will be called when the event happens."}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"thisArgs?"}),": ",(0,i.jsx)(n.code,{children:"any"})]}),"\n",(0,i.jsxs)(n.p,{children:["The ",(0,i.jsx)(n.code,{children:"this"}),"-argument which will be used when calling the event listener."]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"disposables?"}),": ",(0,i.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(n.code,{children:"Disposable"})}),"[]"]}),"\n",(0,i.jsxs)(n.p,{children:["An array to which a ",(0,i.jsx)(n.a,{href:"/api/classes/Disposable",children:"Disposable"})," will be added."]}),"\n",(0,i.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(n.code,{children:"Disposable"})})}),"\n",(0,i.jsx)(n.p,{children:"A disposable which unsubscribes the event listener."}),"\n",(0,i.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L550",children:"packages/extension-api/src/extension-api.d.ts:550"})})]})}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/7c7a772e.3175a757.js b/assets/js/7c7a772e.8c0ceae2.js similarity index 85% rename from assets/js/7c7a772e.3175a757.js rename to assets/js/7c7a772e.8c0ceae2.js index 4be3ebdf38c..32f4568ab1c 100644 --- a/assets/js/7c7a772e.3175a757.js +++ b/assets/js/7c7a772e.8c0ceae2.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[77060],{50383:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>d,contentTitle:()=>t,default:()=>h,frontMatter:()=>r,metadata:()=>o,toc:()=>l});var i=s(24246),c=s(71670);const r={},t="Interface: WebviewPanel",o={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:"Interface: WebviewOptions",permalink:"/api/interfaces/WebviewOptions"},next:{title:"Interface: WebviewPanelOnDidChangeViewStateEvent",permalink:"/api/interfaces/WebviewPanelOnDidChangeViewStateEvent"}},d={},l=[{value:"Properties",id:"properties",level:2},{value:"active",id:"active",level:3},{value:"Source",id:"source",level:4},{value:"iconPath?",id:"iconpath",level:3},{value:"Source",id:"source-1",level:4},{value:"onDidChangeViewState",id:"ondidchangeviewstate",level:3},{value:"Source",id:"source-2",level:4},{value:"onDidDispose",id:"ondiddispose",level:3},{value:"Source",id:"source-3",level:4},{value:"title",id:"title",level:3},{value:"Source",id:"source-4",level:4},{value:"viewType",id:"viewtype",level:3},{value:"Source",id:"source-5",level:4},{value:"visible",id:"visible",level:3},{value:"Source",id:"source-6",level:4},{value:"webview",id:"webview",level:3},{value:"Source",id:"source-7",level:4},{value:"Methods",id:"methods",level:2},{value:"dispose()",id:"dispose",level:3},{value:"Returns",id:"returns",level:4},{value:"Source",id:"source-8",level:4},{value:"reveal()",id:"reveal",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Source",id:"source-9",level:4}];function a(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,c.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"interface-webviewpanel",children:"Interface: WebviewPanel"}),"\n",(0,i.jsx)(n.p,{children:"A panel that contains a webview."}),"\n",(0,i.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(n.h3,{id:"active",children:"active"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"readonly"})})," ",(0,i.jsx)(n.strong,{children:"active"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Whether the panel is active (focused by the user)."}),"\n",(0,i.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L1473",children:"packages/extension-api/src/extension-api.d.ts:1473"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"iconpath",children:"iconPath?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"iconPath"}),": ",(0,i.jsx)(n.a,{href:"/api/classes/Uri",children:(0,i.jsx)(n.code,{children:"Uri"})})," | ",(0,i.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Icon for the panel shown in UI."}),"\n",(0,i.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L1452",children:"packages/extension-api/src/extension-api.d.ts:1452"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"ondidchangeviewstate",children:"onDidChangeViewState"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"readonly"})})," ",(0,i.jsx)(n.strong,{children:"onDidChangeViewState"}),": ",(0,i.jsx)(n.a,{href:"/api/interfaces/Event",children:(0,i.jsx)(n.code,{children:"Event"})}),"< ",(0,i.jsx)(n.a,{href:"/api/interfaces/WebviewPanelOnDidChangeViewStateEvent",children:(0,i.jsx)(n.code,{children:"WebviewPanelOnDidChangeViewStateEvent"})})," >"]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Fired when the panel's view state changes."}),"\n",(0,i.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L1483",children:"packages/extension-api/src/extension-api.d.ts:1483"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"ondiddispose",children:"onDidDispose"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"readonly"})})," ",(0,i.jsx)(n.strong,{children:"onDidDispose"}),": ",(0,i.jsx)(n.a,{href:"/api/interfaces/Event",children:(0,i.jsx)(n.code,{children:"Event"})}),"< ",(0,i.jsx)(n.code,{children:"void"})," >"]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Fired when the panel is disposed."}),"\n",(0,i.jsxs)(n.p,{children:["This may be because the user closed the panel or because ",(0,i.jsx)(n.code,{children:".dispose()"})," was\ncalled on it."]}),"\n",(0,i.jsx)(n.p,{children:"Trying to use the panel after it has been disposed throws an exception."}),"\n",(0,i.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L1493",children:"packages/extension-api/src/extension-api.d.ts:1493"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"title",children:"title"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"title"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Title of the panel shown in UI."}),"\n",(0,i.jsx)(n.h4,{id:"source-4",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L1447",children:"packages/extension-api/src/extension-api.d.ts:1447"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"viewtype",children:"viewType"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"readonly"})})," ",(0,i.jsx)(n.strong,{children:"viewType"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Identifies the type of the webview panel."}),"\n",(0,i.jsx)(n.h4,{id:"source-5",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L1442",children:"packages/extension-api/src/extension-api.d.ts:1442"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"visible",children:"visible"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"readonly"})})," ",(0,i.jsx)(n.strong,{children:"visible"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Whether the panel is visible."}),"\n",(0,i.jsx)(n.h4,{id:"source-6",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L1478",children:"packages/extension-api/src/extension-api.d.ts:1478"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"webview",children:"webview"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"readonly"})})," ",(0,i.jsx)(n.strong,{children:"webview"}),": ",(0,i.jsx)(n.a,{href:"/api/interfaces/Webview",children:(0,i.jsx)(n.code,{children:"Webview"})})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.a,{href:"/api/interfaces/Webview",children:(0,i.jsx)(n.code,{children:"Webview"})})," belonging to the panel."]}),"\n",(0,i.jsx)(n.h4,{id:"source-7",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L1468",children:"packages/extension-api/src/extension-api.d.ts:1468"})}),"\n",(0,i.jsx)(n.h2,{id:"methods",children:"Methods"}),"\n",(0,i.jsx)(n.h3,{id:"dispose",children:"dispose()"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"dispose"}),"(): ",(0,i.jsx)(n.code,{children:"void"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Dispose of the webview panel."}),"\n",(0,i.jsxs)(n.p,{children:["This closes the panel if it showing and disposes of the resources owned by the webview.\nWebview panels are also disposed when the user closes the webview panel. Both cases\nfire the ",(0,i.jsx)(n.code,{children:"onDispose"})," event."]}),"\n",(0,i.jsx)(n.h4,{id:"returns",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"void"})}),"\n",(0,i.jsx)(n.h4,{id:"source-8",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L1508",children:"packages/extension-api/src/extension-api.d.ts:1508"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"reveal",children:"reveal()"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"reveal"}),"(",(0,i.jsx)(n.code,{children:"preserveFocus"}),"?): ",(0,i.jsx)(n.code,{children:"void"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Show the webview panel."}),"\n",(0,i.jsx)(n.h4,{id:"parameters",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"preserveFocus?"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n",(0,i.jsxs)(n.p,{children:["When ",(0,i.jsx)(n.code,{children:"true"}),", the webview will not take focus."]}),"\n",(0,i.jsx)(n.h4,{id:"returns-1",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"void"})}),"\n",(0,i.jsx)(n.h4,{id:"source-9",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L1499",children:"packages/extension-api/src/extension-api.d.ts:1499"})})]})}function h(e={}){const{wrapper:n}={...(0,c.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(a,{...e})}):a(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>o,a:()=>t});var i=s(27378);const c={},r=i.createContext(c);function t(e){const n=i.useContext(r);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(c):e.components||c:t(e.components),i.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[77060],{50383:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>o,contentTitle:()=>d,default:()=>h,frontMatter:()=>r,metadata:()=>t,toc:()=>l});var i=s(24246),c=s(71670);const r={},d="Interface: WebviewPanel",t={id:"interfaces/WebviewPanel",title:"Interface: WebviewPanel",description:"A panel that contains a webview.",source:"@site/api/interfaces/WebviewPanel.md",sourceDirName:"interfaces",slug:"/interfaces/WebviewPanel",permalink:"/api/interfaces/WebviewPanel",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: WebviewOptions",permalink:"/api/interfaces/WebviewOptions"},next:{title:"Interface: WebviewPanelOnDidChangeViewStateEvent",permalink:"/api/interfaces/WebviewPanelOnDidChangeViewStateEvent"}},o={},l=[{value:"Properties",id:"properties",level:2},{value:"active",id:"active",level:3},{value:"Source",id:"source",level:4},{value:"iconPath?",id:"iconpath",level:3},{value:"Source",id:"source-1",level:4},{value:"onDidChangeViewState",id:"ondidchangeviewstate",level:3},{value:"Source",id:"source-2",level:4},{value:"onDidDispose",id:"ondiddispose",level:3},{value:"Source",id:"source-3",level:4},{value:"title",id:"title",level:3},{value:"Source",id:"source-4",level:4},{value:"viewType",id:"viewtype",level:3},{value:"Source",id:"source-5",level:4},{value:"visible",id:"visible",level:3},{value:"Source",id:"source-6",level:4},{value:"webview",id:"webview",level:3},{value:"Source",id:"source-7",level:4},{value:"Methods",id:"methods",level:2},{value:"dispose()",id:"dispose",level:3},{value:"Returns",id:"returns",level:4},{value:"Source",id:"source-8",level:4},{value:"reveal()",id:"reveal",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Source",id:"source-9",level:4}];function a(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,c.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"interface-webviewpanel",children:"Interface: WebviewPanel"}),"\n",(0,i.jsx)(n.p,{children:"A panel that contains a webview."}),"\n",(0,i.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(n.h3,{id:"active",children:"active"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"readonly"})})," ",(0,i.jsx)(n.strong,{children:"active"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Whether the panel is active (focused by the user)."}),"\n",(0,i.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L1473",children:"packages/extension-api/src/extension-api.d.ts:1473"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"iconpath",children:"iconPath?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"iconPath"}),": ",(0,i.jsx)(n.a,{href:"/api/classes/Uri",children:(0,i.jsx)(n.code,{children:"Uri"})})," | ",(0,i.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Icon for the panel shown in UI."}),"\n",(0,i.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L1452",children:"packages/extension-api/src/extension-api.d.ts:1452"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"ondidchangeviewstate",children:"onDidChangeViewState"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"readonly"})})," ",(0,i.jsx)(n.strong,{children:"onDidChangeViewState"}),": ",(0,i.jsx)(n.a,{href:"/api/interfaces/Event",children:(0,i.jsx)(n.code,{children:"Event"})}),"< ",(0,i.jsx)(n.a,{href:"/api/interfaces/WebviewPanelOnDidChangeViewStateEvent",children:(0,i.jsx)(n.code,{children:"WebviewPanelOnDidChangeViewStateEvent"})})," >"]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Fired when the panel's view state changes."}),"\n",(0,i.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L1483",children:"packages/extension-api/src/extension-api.d.ts:1483"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"ondiddispose",children:"onDidDispose"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"readonly"})})," ",(0,i.jsx)(n.strong,{children:"onDidDispose"}),": ",(0,i.jsx)(n.a,{href:"/api/interfaces/Event",children:(0,i.jsx)(n.code,{children:"Event"})}),"< ",(0,i.jsx)(n.code,{children:"void"})," >"]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Fired when the panel is disposed."}),"\n",(0,i.jsxs)(n.p,{children:["This may be because the user closed the panel or because ",(0,i.jsx)(n.code,{children:".dispose()"})," was\ncalled on it."]}),"\n",(0,i.jsx)(n.p,{children:"Trying to use the panel after it has been disposed throws an exception."}),"\n",(0,i.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L1493",children:"packages/extension-api/src/extension-api.d.ts:1493"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"title",children:"title"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"title"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Title of the panel shown in UI."}),"\n",(0,i.jsx)(n.h4,{id:"source-4",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L1447",children:"packages/extension-api/src/extension-api.d.ts:1447"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"viewtype",children:"viewType"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"readonly"})})," ",(0,i.jsx)(n.strong,{children:"viewType"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Identifies the type of the webview panel."}),"\n",(0,i.jsx)(n.h4,{id:"source-5",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L1442",children:"packages/extension-api/src/extension-api.d.ts:1442"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"visible",children:"visible"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"readonly"})})," ",(0,i.jsx)(n.strong,{children:"visible"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Whether the panel is visible."}),"\n",(0,i.jsx)(n.h4,{id:"source-6",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L1478",children:"packages/extension-api/src/extension-api.d.ts:1478"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"webview",children:"webview"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"readonly"})})," ",(0,i.jsx)(n.strong,{children:"webview"}),": ",(0,i.jsx)(n.a,{href:"/api/interfaces/Webview",children:(0,i.jsx)(n.code,{children:"Webview"})})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.a,{href:"/api/interfaces/Webview",children:(0,i.jsx)(n.code,{children:"Webview"})})," belonging to the panel."]}),"\n",(0,i.jsx)(n.h4,{id:"source-7",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L1468",children:"packages/extension-api/src/extension-api.d.ts:1468"})}),"\n",(0,i.jsx)(n.h2,{id:"methods",children:"Methods"}),"\n",(0,i.jsx)(n.h3,{id:"dispose",children:"dispose()"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"dispose"}),"(): ",(0,i.jsx)(n.code,{children:"void"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Dispose of the webview panel."}),"\n",(0,i.jsxs)(n.p,{children:["This closes the panel if it showing and disposes of the resources owned by the webview.\nWebview panels are also disposed when the user closes the webview panel. Both cases\nfire the ",(0,i.jsx)(n.code,{children:"onDispose"})," event."]}),"\n",(0,i.jsx)(n.h4,{id:"returns",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"void"})}),"\n",(0,i.jsx)(n.h4,{id:"source-8",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L1508",children:"packages/extension-api/src/extension-api.d.ts:1508"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"reveal",children:"reveal()"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"reveal"}),"(",(0,i.jsx)(n.code,{children:"preserveFocus"}),"?): ",(0,i.jsx)(n.code,{children:"void"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Show the webview panel."}),"\n",(0,i.jsx)(n.h4,{id:"parameters",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"preserveFocus?"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n",(0,i.jsxs)(n.p,{children:["When ",(0,i.jsx)(n.code,{children:"true"}),", the webview will not take focus."]}),"\n",(0,i.jsx)(n.h4,{id:"returns-1",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"void"})}),"\n",(0,i.jsx)(n.h4,{id:"source-9",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L1499",children:"packages/extension-api/src/extension-api.d.ts:1499"})})]})}function h(e={}){const{wrapper:n}={...(0,c.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(a,{...e})}):a(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>t,a:()=>d});var i=s(27378);const c={},r=i.createContext(c);function d(e){const n=i.useContext(r);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function t(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(c):e.components||c:d(e.components),i.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/7cde3c49.c7a15492.js b/assets/js/7cde3c49.006b7055.js similarity index 94% rename from assets/js/7cde3c49.c7a15492.js rename to assets/js/7cde3c49.006b7055.js index 746296bd36d..7166e0aaa19 100644 --- a/assets/js/7cde3c49.c7a15492.js +++ b/assets/js/7cde3c49.006b7055.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[37836],{92634:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>s,default:()=>d,frontMatter:()=>i,metadata:()=>c,toc:()=>l});var o=t(24246),r=t(71670);const i={},s="Interface: VolumeDeleteOptions",c={id:"interfaces/VolumeDeleteOptions",title:"Interface: VolumeDeleteOptions",description:"Properties",source:"@site/api/interfaces/VolumeDeleteOptions.md",sourceDirName:"interfaces",slug:"/interfaces/VolumeDeleteOptions",permalink:"/api/interfaces/VolumeDeleteOptions",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: VolumeCreateResponseInfo",permalink:"/api/interfaces/VolumeCreateResponseInfo"},next:{title:"Interface: VolumeInfo",permalink:"/api/interfaces/VolumeInfo"}},a={},l=[{value:"Properties",id:"properties",level:2},{value:"provider?",id:"provider",level:3},{value:"Source",id:"source",level:4}];function p(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",p:"p",strong:"strong",...(0,r.a)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(n.h1,{id:"interface-volumedeleteoptions",children:"Interface: VolumeDeleteOptions"}),"\n",(0,o.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,o.jsx)(n.h3,{id:"provider",children:"provider?"}),"\n",(0,o.jsxs)(n.blockquote,{children:["\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.strong,{children:(0,o.jsx)(n.code,{children:"optional"})})," ",(0,o.jsx)(n.strong,{children:"provider"}),": ",(0,o.jsx)(n.a,{href:"/api/interfaces/ContainerProviderConnection",children:(0,o.jsx)(n.code,{children:"ContainerProviderConnection"})})]}),"\n"]}),"\n",(0,o.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,o.jsx)(n.p,{children:(0,o.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L3127",children:"packages/extension-api/src/extension-api.d.ts:3127"})})]})}function d(e={}){const{wrapper:n}={...(0,r.a)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(p,{...e})}):p(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>c,a:()=>s});var o=t(27378);const r={},i=o.createContext(r);function s(e){const n=o.useContext(i);return o.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:s(e.components),o.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[37836],{92634:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>s,default:()=>d,frontMatter:()=>i,metadata:()=>c,toc:()=>l});var o=t(24246),r=t(71670);const i={},s="Interface: VolumeDeleteOptions",c={id:"interfaces/VolumeDeleteOptions",title:"Interface: VolumeDeleteOptions",description:"Properties",source:"@site/api/interfaces/VolumeDeleteOptions.md",sourceDirName:"interfaces",slug:"/interfaces/VolumeDeleteOptions",permalink:"/api/interfaces/VolumeDeleteOptions",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: VolumeCreateResponseInfo",permalink:"/api/interfaces/VolumeCreateResponseInfo"},next:{title:"Interface: VolumeInfo",permalink:"/api/interfaces/VolumeInfo"}},a={},l=[{value:"Properties",id:"properties",level:2},{value:"provider?",id:"provider",level:3},{value:"Source",id:"source",level:4}];function p(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",p:"p",strong:"strong",...(0,r.a)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(n.h1,{id:"interface-volumedeleteoptions",children:"Interface: VolumeDeleteOptions"}),"\n",(0,o.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,o.jsx)(n.h3,{id:"provider",children:"provider?"}),"\n",(0,o.jsxs)(n.blockquote,{children:["\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.strong,{children:(0,o.jsx)(n.code,{children:"optional"})})," ",(0,o.jsx)(n.strong,{children:"provider"}),": ",(0,o.jsx)(n.a,{href:"/api/interfaces/ContainerProviderConnection",children:(0,o.jsx)(n.code,{children:"ContainerProviderConnection"})})]}),"\n"]}),"\n",(0,o.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,o.jsx)(n.p,{children:(0,o.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L3127",children:"packages/extension-api/src/extension-api.d.ts:3127"})})]})}function d(e={}){const{wrapper:n}={...(0,r.a)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(p,{...e})}):p(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>c,a:()=>s});var o=t(27378);const r={},i=o.createContext(r);function s(e){const n=o.useContext(i);return o.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:s(e.components),o.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/7d9edfb8.481f6f48.js b/assets/js/7d9edfb8.19b21b61.js similarity index 92% rename from assets/js/7d9edfb8.481f6f48.js rename to assets/js/7d9edfb8.19b21b61.js index 8a846a52ad2..84aa3ed9da2 100644 --- a/assets/js/7d9edfb8.481f6f48.js +++ b/assets/js/7d9edfb8.19b21b61.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[90125],{81245:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>c,contentTitle:()=>o,default:()=>d,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:"Function: listContainers()",permalink:"/api/namespaces/containerEngine/functions/listContainers"},next:{title:"Function: listInfos()",permalink:"/api/namespaces/containerEngine/functions/listInfos"}},c={},l=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Example",id:"example",level:2},{value:"Example",id:"example-1",level:2},{value:"Source",id:"source",level:2}];function p(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",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:"example",children:"Example"}),"\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.h2,{id:"example-1",children:"Example"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-ts",children:"// Example 2: List container images for a specific provider.\nconst provider = provider.getContainerConnections().find(connection => connection.connection.status() === 'started');\nconst images = await listImages({ provider: provider.connection });\nconsole.log(images);\n"})}),"\n",(0,i.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L3283",children:"packages/extension-api/src/extension-api.d.ts:3283"})})]})}function d(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(p,{...e})}):p(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>r,a:()=>o});var i=s(27378);const t={},a=i.createContext(t);function o(e){const n=i.useContext(a);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function r(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:o(e.components),i.createElement(a.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[90125],{81245:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>c,contentTitle:()=>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:"Function: listContainers()",permalink:"/api/namespaces/containerEngine/functions/listContainers"},next:{title:"Function: listInfos()",permalink:"/api/namespaces/containerEngine/functions/listInfos"}},c={},l=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Example",id:"example",level:2},{value:"Example",id:"example-1",level:2},{value:"Source",id:"source",level:2}];function d(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",pre:"pre",strong:"strong",...(0,t.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"function-listimages",children:"Function: listImages()"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"listImages"}),"(",(0,i.jsx)(n.code,{children:"options"}),"?): ",(0,i.jsx)(n.code,{children:"Promise"}),"< ",(0,i.jsx)(n.a,{href:"/api/interfaces/ImageInfo",children:(0,i.jsx)(n.code,{children:"ImageInfo"})}),"[] >"]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"List the container images. Only images from a final layer (no children) are returned."}),"\n",(0,i.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"options?"}),": ",(0,i.jsx)(n.a,{href:"/api/interfaces/ListImagesOptions",children:(0,i.jsx)(n.code,{children:"ListImagesOptions"})})]}),"\n",(0,i.jsx)(n.p,{children:"optional options for listing images"}),"\n",(0,i.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"Promise"}),"< ",(0,i.jsx)(n.a,{href:"/api/interfaces/ImageInfo",children:(0,i.jsx)(n.code,{children:"ImageInfo"})}),"[] >"]}),"\n",(0,i.jsxs)(n.p,{children:["A promise resolving to an array of images information. This method returns a subset of the available information for images. To get the complete description of a specific image, you can use the ",(0,i.jsx)(n.a,{href:"/api/namespaces/containerEngine/functions/getImageInspect",children:"containerEngine.getImageInspect"})," method."]}),"\n",(0,i.jsx)(n.h2,{id:"example",children:"Example"}),"\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.h2,{id:"example-1",children:"Example"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-ts",children:"// Example 2: List container images for a specific provider.\nconst provider = provider.getContainerConnections().find(connection => connection.connection.status() === 'started');\nconst images = await listImages({ provider: provider.connection });\nconsole.log(images);\n"})}),"\n",(0,i.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L3283",children:"packages/extension-api/src/extension-api.d.ts:3283"})})]})}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.a7deb713.js b/assets/js/7e2ae3df.4280abc5.js similarity index 98% rename from assets/js/7e2ae3df.a7deb713.js rename to assets/js/7e2ae3df.4280abc5.js index 662ac3a08a8..94875a7c0f6 100644 --- a/assets/js/7e2ae3df.a7deb713.js +++ b/assets/js/7e2ae3df.4280abc5.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[28143],{99597:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>c,contentTitle:()=>o,default:()=>l,frontMatter:()=>s,metadata:()=>a,toc:()=>d});var r=i(24246),t=i(71670);const s={},o="Function: registerAuthenticationProvider()",a={id:"namespaces/authentication/functions/registerAuthenticationProvider",title:"Function: registerAuthenticationProvider()",description:"registerAuthenticationProvider(id, label, provider, options?): Disposable",source:"@site/api/namespaces/authentication/functions/registerAuthenticationProvider.md",sourceDirName:"namespaces/authentication/functions",slug:"/namespaces/authentication/functions/registerAuthenticationProvider",permalink:"/api/namespaces/authentication/functions/registerAuthenticationProvider",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Function: onDidChangeSessions()",permalink:"/api/namespaces/authentication/functions/onDidChangeSessions"},next:{title:"Namespace: cli",permalink:"/api/namespaces/cli/"}},c={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Params",id:"params",level:2},{value:"Source",id:"source",level:2}];function h(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,t.a)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.h1,{id:"function-registerauthenticationprovider",children:"Function: registerAuthenticationProvider()"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"registerAuthenticationProvider"}),"(",(0,r.jsx)(n.code,{children:"id"}),", ",(0,r.jsx)(n.code,{children:"label"}),", ",(0,r.jsx)(n.code,{children:"provider"}),", ",(0,r.jsx)(n.code,{children:"options"}),"?): ",(0,r.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,r.jsx)(n.code,{children:"Disposable"})})]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"Register an authentication provider."}),"\n",(0,r.jsx)(n.p,{children:"There can only be one provider per id and an error is being thrown when an id\nhas already been used by another provider. Ids are case-sensitive."}),"\n",(0,r.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"id"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n",(0,r.jsx)(n.p,{children:"The unique identifier of the provider."}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"label"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n",(0,r.jsx)(n.p,{children:"The human-readable name of the provider."}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"provider"}),": ",(0,r.jsx)(n.a,{href:"/api/interfaces/AuthenticationProvider",children:(0,r.jsx)(n.code,{children:"AuthenticationProvider"})})]}),"\n",(0,r.jsx)(n.p,{children:"The authentication provider provider."}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"options?"}),": ",(0,r.jsx)(n.a,{href:"/api/interfaces/AuthenticationProviderOptions",children:(0,r.jsx)(n.code,{children:"AuthenticationProviderOptions"})})]}),"\n",(0,r.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,r.jsx)(n.code,{children:"Disposable"})})}),"\n",(0,r.jsxs)(n.p,{children:["A ",(0,r.jsx)(n.a,{href:"#Disposable",children:"disposable"})," that unregisters this provider when being disposed."]}),"\n",(0,r.jsx)(n.h2,{id:"params",children:"Params"}),"\n",(0,r.jsx)(n.p,{children:"options Additional options for the provider."}),"\n",(0,r.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L3649",children:"packages/extension-api/src/extension-api.d.ts:3649"})})]})}function l(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(h,{...e})}):h(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>a,a:()=>o});var r=i(27378);const t={},s=r.createContext(t);function o(e){const n=r.useContext(s);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function a(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:o(e.components),r.createElement(s.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[28143],{99597:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>c,contentTitle:()=>o,default:()=>l,frontMatter:()=>s,metadata:()=>a,toc:()=>d});var r=i(24246),t=i(71670);const s={},o="Function: registerAuthenticationProvider()",a={id:"namespaces/authentication/functions/registerAuthenticationProvider",title:"Function: registerAuthenticationProvider()",description:"registerAuthenticationProvider(id, label, provider, options?): Disposable",source:"@site/api/namespaces/authentication/functions/registerAuthenticationProvider.md",sourceDirName:"namespaces/authentication/functions",slug:"/namespaces/authentication/functions/registerAuthenticationProvider",permalink:"/api/namespaces/authentication/functions/registerAuthenticationProvider",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Function: onDidChangeSessions()",permalink:"/api/namespaces/authentication/functions/onDidChangeSessions"},next:{title:"Namespace: cli",permalink:"/api/namespaces/cli/"}},c={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Params",id:"params",level:2},{value:"Source",id:"source",level:2}];function h(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,t.a)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.h1,{id:"function-registerauthenticationprovider",children:"Function: registerAuthenticationProvider()"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"registerAuthenticationProvider"}),"(",(0,r.jsx)(n.code,{children:"id"}),", ",(0,r.jsx)(n.code,{children:"label"}),", ",(0,r.jsx)(n.code,{children:"provider"}),", ",(0,r.jsx)(n.code,{children:"options"}),"?): ",(0,r.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,r.jsx)(n.code,{children:"Disposable"})})]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"Register an authentication provider."}),"\n",(0,r.jsx)(n.p,{children:"There can only be one provider per id and an error is being thrown when an id\nhas already been used by another provider. Ids are case-sensitive."}),"\n",(0,r.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"id"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n",(0,r.jsx)(n.p,{children:"The unique identifier of the provider."}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"label"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n",(0,r.jsx)(n.p,{children:"The human-readable name of the provider."}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"provider"}),": ",(0,r.jsx)(n.a,{href:"/api/interfaces/AuthenticationProvider",children:(0,r.jsx)(n.code,{children:"AuthenticationProvider"})})]}),"\n",(0,r.jsx)(n.p,{children:"The authentication provider provider."}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"options?"}),": ",(0,r.jsx)(n.a,{href:"/api/interfaces/AuthenticationProviderOptions",children:(0,r.jsx)(n.code,{children:"AuthenticationProviderOptions"})})]}),"\n",(0,r.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,r.jsx)(n.code,{children:"Disposable"})})}),"\n",(0,r.jsxs)(n.p,{children:["A ",(0,r.jsx)(n.a,{href:"#Disposable",children:"disposable"})," that unregisters this provider when being disposed."]}),"\n",(0,r.jsx)(n.h2,{id:"params",children:"Params"}),"\n",(0,r.jsx)(n.p,{children:"options Additional options for the provider."}),"\n",(0,r.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L3649",children:"packages/extension-api/src/extension-api.d.ts:3649"})})]})}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.b7d8320e.js b/assets/js/7e5a2776.4405dd1f.js similarity index 92% rename from assets/js/7e5a2776.b7d8320e.js rename to assets/js/7e5a2776.4405dd1f.js index 69f245dd6c4..ebd400e9bd1 100644 --- a/assets/js/7e5a2776.b7d8320e.js +++ b/assets/js/7e5a2776.4405dd1f.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[51171],{61010:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>o,contentTitle:()=>t,default:()=>h,frontMatter:()=>c,metadata:()=>d,toc:()=>l});var i=s(24246),r=s(71670);const c={},t="Interface: FileSystemWatcher",d={id:"interfaces/FileSystemWatcher",title:"Interface: FileSystemWatcher",description:"Notifies changes on files or folders.",source:"@site/api/interfaces/FileSystemWatcher.md",sourceDirName:"interfaces",slug:"/interfaces/FileSystemWatcher",permalink:"/api/interfaces/FileSystemWatcher",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: ExtensionContext",permalink:"/api/interfaces/ExtensionContext"},next:{title:"Interface: GenerateKubeResult",permalink:"/api/interfaces/GenerateKubeResult"}},o={},l=[{value:"Extends",id:"extends",level:2},{value:"Properties",id:"properties",level:2},{value:"onDidChange",id:"ondidchange",level:3},{value:"Source",id:"source",level:4},{value:"onDidCreate",id:"ondidcreate",level:3},{value:"Source",id:"source-1",level:4},{value:"onDidDelete",id:"ondiddelete",level:3},{value:"Source",id:"source-2",level:4},{value:"Methods",id:"methods",level:2},{value:"dispose()",id:"dispose",level:3},{value:"Returns",id:"returns",level:4},{value:"Inherited from",id:"inherited-from",level:4},{value:"Source",id:"source-3",level:4}];function a(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",li:"li",p:"p",strong:"strong",ul:"ul",...(0,r.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"interface-filesystemwatcher",children:"Interface: FileSystemWatcher"}),"\n",(0,i.jsx)(n.p,{children:"Notifies changes on files or folders."}),"\n",(0,i.jsx)(n.h2,{id:"extends",children:"Extends"}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(n.code,{children:"Disposable"})})}),"\n"]}),"\n",(0,i.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(n.h3,{id:"ondidchange",children:"onDidChange"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"readonly"})})," ",(0,i.jsx)(n.strong,{children:"onDidChange"}),": ",(0,i.jsx)(n.a,{href:"/api/interfaces/Event",children:(0,i.jsx)(n.code,{children:"Event"})}),"< ",(0,i.jsx)(n.a,{href:"/api/classes/Uri",children:(0,i.jsx)(n.code,{children:"Uri"})})," >"]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L1372",children:"packages/extension-api/src/extension-api.d.ts:1372"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"ondidcreate",children:"onDidCreate"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"readonly"})})," ",(0,i.jsx)(n.strong,{children:"onDidCreate"}),": ",(0,i.jsx)(n.a,{href:"/api/interfaces/Event",children:(0,i.jsx)(n.code,{children:"Event"})}),"< ",(0,i.jsx)(n.a,{href:"/api/classes/Uri",children:(0,i.jsx)(n.code,{children:"Uri"})})," >"]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L1371",children:"packages/extension-api/src/extension-api.d.ts:1371"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"ondiddelete",children:"onDidDelete"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"readonly"})})," ",(0,i.jsx)(n.strong,{children:"onDidDelete"}),": ",(0,i.jsx)(n.a,{href:"/api/interfaces/Event",children:(0,i.jsx)(n.code,{children:"Event"})}),"< ",(0,i.jsx)(n.a,{href:"/api/classes/Uri",children:(0,i.jsx)(n.code,{children:"Uri"})})," >"]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L1373",children:"packages/extension-api/src/extension-api.d.ts:1373"})}),"\n",(0,i.jsx)(n.h2,{id:"methods",children:"Methods"}),"\n",(0,i.jsx)(n.h3,{id:"dispose",children:"dispose()"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"dispose"}),"(): ",(0,i.jsx)(n.code,{children:"void"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Dispose this object."}),"\n",(0,i.jsx)(n.h4,{id:"returns",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"void"})}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from",children:"Inherited from"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(n.code,{children:"Disposable"})}),".",(0,i.jsx)(n.a,{href:"/api/classes/Disposable#dispose",children:(0,i.jsx)(n.code,{children:"dispose"})})]}),"\n",(0,i.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L78",children:"packages/extension-api/src/extension-api.d.ts:78"})})]})}function h(e={}){const{wrapper:n}={...(0,r.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(a,{...e})}):a(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>d,a:()=>t});var i=s(27378);const r={},c=i.createContext(r);function t(e){const n=i.useContext(c);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function d(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:t(e.components),i.createElement(c.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[51171],{61010:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>o,contentTitle:()=>t,default:()=>h,frontMatter:()=>c,metadata:()=>d,toc:()=>l});var i=s(24246),r=s(71670);const c={},t="Interface: FileSystemWatcher",d={id:"interfaces/FileSystemWatcher",title:"Interface: FileSystemWatcher",description:"Notifies changes on files or folders.",source:"@site/api/interfaces/FileSystemWatcher.md",sourceDirName:"interfaces",slug:"/interfaces/FileSystemWatcher",permalink:"/api/interfaces/FileSystemWatcher",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: ExtensionContext",permalink:"/api/interfaces/ExtensionContext"},next:{title:"Interface: GenerateKubeResult",permalink:"/api/interfaces/GenerateKubeResult"}},o={},l=[{value:"Extends",id:"extends",level:2},{value:"Properties",id:"properties",level:2},{value:"onDidChange",id:"ondidchange",level:3},{value:"Source",id:"source",level:4},{value:"onDidCreate",id:"ondidcreate",level:3},{value:"Source",id:"source-1",level:4},{value:"onDidDelete",id:"ondiddelete",level:3},{value:"Source",id:"source-2",level:4},{value:"Methods",id:"methods",level:2},{value:"dispose()",id:"dispose",level:3},{value:"Returns",id:"returns",level:4},{value:"Inherited from",id:"inherited-from",level:4},{value:"Source",id:"source-3",level:4}];function a(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",li:"li",p:"p",strong:"strong",ul:"ul",...(0,r.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"interface-filesystemwatcher",children:"Interface: FileSystemWatcher"}),"\n",(0,i.jsx)(n.p,{children:"Notifies changes on files or folders."}),"\n",(0,i.jsx)(n.h2,{id:"extends",children:"Extends"}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(n.code,{children:"Disposable"})})}),"\n"]}),"\n",(0,i.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(n.h3,{id:"ondidchange",children:"onDidChange"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"readonly"})})," ",(0,i.jsx)(n.strong,{children:"onDidChange"}),": ",(0,i.jsx)(n.a,{href:"/api/interfaces/Event",children:(0,i.jsx)(n.code,{children:"Event"})}),"< ",(0,i.jsx)(n.a,{href:"/api/classes/Uri",children:(0,i.jsx)(n.code,{children:"Uri"})})," >"]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L1372",children:"packages/extension-api/src/extension-api.d.ts:1372"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"ondidcreate",children:"onDidCreate"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"readonly"})})," ",(0,i.jsx)(n.strong,{children:"onDidCreate"}),": ",(0,i.jsx)(n.a,{href:"/api/interfaces/Event",children:(0,i.jsx)(n.code,{children:"Event"})}),"< ",(0,i.jsx)(n.a,{href:"/api/classes/Uri",children:(0,i.jsx)(n.code,{children:"Uri"})})," >"]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L1371",children:"packages/extension-api/src/extension-api.d.ts:1371"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"ondiddelete",children:"onDidDelete"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"readonly"})})," ",(0,i.jsx)(n.strong,{children:"onDidDelete"}),": ",(0,i.jsx)(n.a,{href:"/api/interfaces/Event",children:(0,i.jsx)(n.code,{children:"Event"})}),"< ",(0,i.jsx)(n.a,{href:"/api/classes/Uri",children:(0,i.jsx)(n.code,{children:"Uri"})})," >"]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L1373",children:"packages/extension-api/src/extension-api.d.ts:1373"})}),"\n",(0,i.jsx)(n.h2,{id:"methods",children:"Methods"}),"\n",(0,i.jsx)(n.h3,{id:"dispose",children:"dispose()"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"dispose"}),"(): ",(0,i.jsx)(n.code,{children:"void"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Dispose this object."}),"\n",(0,i.jsx)(n.h4,{id:"returns",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"void"})}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from",children:"Inherited from"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(n.code,{children:"Disposable"})}),".",(0,i.jsx)(n.a,{href:"/api/classes/Disposable#dispose",children:(0,i.jsx)(n.code,{children:"dispose"})})]}),"\n",(0,i.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L78",children:"packages/extension-api/src/extension-api.d.ts:78"})})]})}function h(e={}){const{wrapper:n}={...(0,r.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(a,{...e})}):a(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>d,a:()=>t});var i=s(27378);const r={},c=i.createContext(r);function t(e){const n=i.useContext(c);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function d(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:t(e.components),i.createElement(c.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/7f0476bd.20f2374d.js b/assets/js/7f0476bd.e7165f51.js similarity index 87% rename from assets/js/7f0476bd.20f2374d.js rename to assets/js/7f0476bd.e7165f51.js index d91eaedeebe..3b337945e53 100644 --- a/assets/js/7f0476bd.20f2374d.js +++ b/assets/js/7f0476bd.e7165f51.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[45346],{37354:(e,s,n)=>{n.r(s),n.d(s,{assets:()=>a,contentTitle:()=>t,default:()=>h,frontMatter:()=>c,metadata:()=>o,toc:()=>l});var i=n(24246),r=n(71670);const c={},t="Interface: Webview",o={id:"interfaces/Webview",title:"Interface: Webview",description:"Displays html content, similarly to an iframe.",source:"@site/api/interfaces/Webview.md",sourceDirName:"interfaces",slug:"/interfaces/Webview",permalink:"/api/interfaces/Webview",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: VolumeListInfo",permalink:"/api/interfaces/VolumeListInfo"},next:{title:"Interface: WebviewInfo",permalink:"/api/interfaces/WebviewInfo"}},a={},l=[{value:"Properties",id:"properties",level:2},{value:"cspSource",id:"cspsource",level:3},{value:"Source",id:"source",level:4},{value:"html",id:"html",level:3},{value:"Source",id:"source-1",level:4},{value:"onDidReceiveMessage",id:"ondidreceivemessage",level:3},{value:"Source",id:"source-2",level:4},{value:"options",id:"options",level:3},{value:"Source",id:"source-3",level:4},{value:"Methods",id:"methods",level:2},{value:"asWebviewUri()",id:"aswebviewuri",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Source",id:"source-4",level:4},{value:"postMessage()",id:"postmessage",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Source",id:"source-5",level:4}];function d(e){const s={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,r.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(s.h1,{id:"interface-webview",children:"Interface: Webview"}),"\n",(0,i.jsx)(s.p,{children:"Displays html content, similarly to an iframe."}),"\n",(0,i.jsx)(s.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(s.h3,{id:"cspsource",children:"cspSource"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:(0,i.jsx)(s.code,{children:"readonly"})})," ",(0,i.jsx)(s.strong,{children:"cspSource"}),": ",(0,i.jsx)(s.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(s.p,{children:"Content security policy source for webview resources."}),"\n",(0,i.jsx)(s.h4,{id:"source",children:"Source"}),"\n",(0,i.jsx)(s.p,{children:(0,i.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L1432",children:"packages/extension-api/src/extension-api.d.ts:1432"})}),"\n",(0,i.jsx)(s.hr,{}),"\n",(0,i.jsx)(s.h3,{id:"html",children:"html"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"html"}),": ",(0,i.jsx)(s.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(s.p,{children:"HTML contents of the webview."}),"\n",(0,i.jsx)(s.p,{children:"This should be a complete, valid html document. Changing this property causes the webview to be reloaded."}),"\n",(0,i.jsx)(s.h4,{id:"source-1",children:"Source"}),"\n",(0,i.jsx)(s.p,{children:(0,i.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L1409",children:"packages/extension-api/src/extension-api.d.ts:1409"})}),"\n",(0,i.jsx)(s.hr,{}),"\n",(0,i.jsx)(s.h3,{id:"ondidreceivemessage",children:"onDidReceiveMessage"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:(0,i.jsx)(s.code,{children:"readonly"})})," ",(0,i.jsx)(s.strong,{children:"onDidReceiveMessage"}),": ",(0,i.jsx)(s.a,{href:"/api/interfaces/Event",children:(0,i.jsx)(s.code,{children:"Event"})}),"< ",(0,i.jsx)(s.code,{children:"unknown"})," >"]}),"\n"]}),"\n",(0,i.jsx)(s.p,{children:"Fired when the webview content posts a message."}),"\n",(0,i.jsx)(s.p,{children:"Webview content can post strings or json serializable objects back to an extension."}),"\n",(0,i.jsx)(s.h4,{id:"source-2",children:"Source"}),"\n",(0,i.jsx)(s.p,{children:(0,i.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L1416",children:"packages/extension-api/src/extension-api.d.ts:1416"})}),"\n",(0,i.jsx)(s.hr,{}),"\n",(0,i.jsx)(s.h3,{id:"options",children:"options"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"options"}),": ",(0,i.jsx)(s.a,{href:"/api/interfaces/WebviewOptions",children:(0,i.jsx)(s.code,{children:"WebviewOptions"})})]}),"\n"]}),"\n",(0,i.jsx)(s.p,{children:"Content settings for the webview."}),"\n",(0,i.jsx)(s.h4,{id:"source-3",children:"Source"}),"\n",(0,i.jsx)(s.p,{children:(0,i.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L1401",children:"packages/extension-api/src/extension-api.d.ts:1401"})}),"\n",(0,i.jsx)(s.h2,{id:"methods",children:"Methods"}),"\n",(0,i.jsx)(s.h3,{id:"aswebviewuri",children:"asWebviewUri()"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"asWebviewUri"}),"(",(0,i.jsx)(s.code,{children:"localResource"}),"): ",(0,i.jsx)(s.a,{href:"/api/classes/Uri",children:(0,i.jsx)(s.code,{children:"Uri"})})]}),"\n"]}),"\n",(0,i.jsx)(s.p,{children:"Convert a uri for the local file system to one that can be used inside webviews."}),"\n",(0,i.jsx)(s.h4,{id:"parameters",children:"Parameters"}),"\n",(0,i.jsxs)(s.p,{children:["\u2022 ",(0,i.jsx)(s.strong,{children:"localResource"}),": ",(0,i.jsx)(s.a,{href:"/api/classes/Uri",children:(0,i.jsx)(s.code,{children:"Uri"})})]}),"\n",(0,i.jsx)(s.h4,{id:"returns",children:"Returns"}),"\n",(0,i.jsx)(s.p,{children:(0,i.jsx)(s.a,{href:"/api/classes/Uri",children:(0,i.jsx)(s.code,{children:"Uri"})})}),"\n",(0,i.jsx)(s.h4,{id:"source-4",children:"Source"}),"\n",(0,i.jsx)(s.p,{children:(0,i.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L1426",children:"packages/extension-api/src/extension-api.d.ts:1426"})}),"\n",(0,i.jsx)(s.hr,{}),"\n",(0,i.jsx)(s.h3,{id:"postmessage",children:"postMessage()"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"postMessage"}),"(",(0,i.jsx)(s.code,{children:"message"}),"): ",(0,i.jsx)(s.code,{children:"Promise"}),"< ",(0,i.jsx)(s.code,{children:"boolean"})," >"]}),"\n"]}),"\n",(0,i.jsx)(s.p,{children:"Post a message to the webview content."}),"\n",(0,i.jsx)(s.h4,{id:"parameters-1",children:"Parameters"}),"\n",(0,i.jsxs)(s.p,{children:["\u2022 ",(0,i.jsx)(s.strong,{children:"message"}),": ",(0,i.jsx)(s.code,{children:"unknown"})]}),"\n",(0,i.jsx)(s.h4,{id:"returns-1",children:"Returns"}),"\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.code,{children:"Promise"}),"< ",(0,i.jsx)(s.code,{children:"boolean"})," >"]}),"\n",(0,i.jsx)(s.h4,{id:"source-5",children:"Source"}),"\n",(0,i.jsx)(s.p,{children:(0,i.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L1421",children:"packages/extension-api/src/extension-api.d.ts:1421"})})]})}function h(e={}){const{wrapper:s}={...(0,r.a)(),...e.components};return s?(0,i.jsx)(s,{...e,children:(0,i.jsx)(d,{...e})}):d(e)}},71670:(e,s,n)=>{n.d(s,{Z:()=>o,a:()=>t});var i=n(27378);const r={},c=i.createContext(r);function t(e){const s=i.useContext(c);return i.useMemo((function(){return"function"==typeof e?e(s):{...s,...e}}),[s,e])}function o(e){let s;return s=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:t(e.components),i.createElement(c.Provider,{value:s},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[45346],{37354:(e,s,n)=>{n.r(s),n.d(s,{assets:()=>d,contentTitle:()=>t,default:()=>h,frontMatter:()=>c,metadata:()=>o,toc:()=>a});var i=n(24246),r=n(71670);const c={},t="Interface: Webview",o={id:"interfaces/Webview",title:"Interface: Webview",description:"Displays html content, similarly to an iframe.",source:"@site/api/interfaces/Webview.md",sourceDirName:"interfaces",slug:"/interfaces/Webview",permalink:"/api/interfaces/Webview",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: VolumeListInfo",permalink:"/api/interfaces/VolumeListInfo"},next:{title:"Interface: WebviewInfo",permalink:"/api/interfaces/WebviewInfo"}},d={},a=[{value:"Properties",id:"properties",level:2},{value:"cspSource",id:"cspsource",level:3},{value:"Source",id:"source",level:4},{value:"html",id:"html",level:3},{value:"Source",id:"source-1",level:4},{value:"onDidReceiveMessage",id:"ondidreceivemessage",level:3},{value:"Source",id:"source-2",level:4},{value:"options",id:"options",level:3},{value:"Source",id:"source-3",level:4},{value:"Methods",id:"methods",level:2},{value:"asWebviewUri()",id:"aswebviewuri",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Source",id:"source-4",level:4},{value:"postMessage()",id:"postmessage",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Source",id:"source-5",level:4}];function l(e){const s={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,r.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(s.h1,{id:"interface-webview",children:"Interface: Webview"}),"\n",(0,i.jsx)(s.p,{children:"Displays html content, similarly to an iframe."}),"\n",(0,i.jsx)(s.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(s.h3,{id:"cspsource",children:"cspSource"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:(0,i.jsx)(s.code,{children:"readonly"})})," ",(0,i.jsx)(s.strong,{children:"cspSource"}),": ",(0,i.jsx)(s.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(s.p,{children:"Content security policy source for webview resources."}),"\n",(0,i.jsx)(s.h4,{id:"source",children:"Source"}),"\n",(0,i.jsx)(s.p,{children:(0,i.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L1432",children:"packages/extension-api/src/extension-api.d.ts:1432"})}),"\n",(0,i.jsx)(s.hr,{}),"\n",(0,i.jsx)(s.h3,{id:"html",children:"html"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"html"}),": ",(0,i.jsx)(s.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(s.p,{children:"HTML contents of the webview."}),"\n",(0,i.jsx)(s.p,{children:"This should be a complete, valid html document. Changing this property causes the webview to be reloaded."}),"\n",(0,i.jsx)(s.h4,{id:"source-1",children:"Source"}),"\n",(0,i.jsx)(s.p,{children:(0,i.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L1409",children:"packages/extension-api/src/extension-api.d.ts:1409"})}),"\n",(0,i.jsx)(s.hr,{}),"\n",(0,i.jsx)(s.h3,{id:"ondidreceivemessage",children:"onDidReceiveMessage"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:(0,i.jsx)(s.code,{children:"readonly"})})," ",(0,i.jsx)(s.strong,{children:"onDidReceiveMessage"}),": ",(0,i.jsx)(s.a,{href:"/api/interfaces/Event",children:(0,i.jsx)(s.code,{children:"Event"})}),"< ",(0,i.jsx)(s.code,{children:"unknown"})," >"]}),"\n"]}),"\n",(0,i.jsx)(s.p,{children:"Fired when the webview content posts a message."}),"\n",(0,i.jsx)(s.p,{children:"Webview content can post strings or json serializable objects back to an extension."}),"\n",(0,i.jsx)(s.h4,{id:"source-2",children:"Source"}),"\n",(0,i.jsx)(s.p,{children:(0,i.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L1416",children:"packages/extension-api/src/extension-api.d.ts:1416"})}),"\n",(0,i.jsx)(s.hr,{}),"\n",(0,i.jsx)(s.h3,{id:"options",children:"options"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"options"}),": ",(0,i.jsx)(s.a,{href:"/api/interfaces/WebviewOptions",children:(0,i.jsx)(s.code,{children:"WebviewOptions"})})]}),"\n"]}),"\n",(0,i.jsx)(s.p,{children:"Content settings for the webview."}),"\n",(0,i.jsx)(s.h4,{id:"source-3",children:"Source"}),"\n",(0,i.jsx)(s.p,{children:(0,i.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L1401",children:"packages/extension-api/src/extension-api.d.ts:1401"})}),"\n",(0,i.jsx)(s.h2,{id:"methods",children:"Methods"}),"\n",(0,i.jsx)(s.h3,{id:"aswebviewuri",children:"asWebviewUri()"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"asWebviewUri"}),"(",(0,i.jsx)(s.code,{children:"localResource"}),"): ",(0,i.jsx)(s.a,{href:"/api/classes/Uri",children:(0,i.jsx)(s.code,{children:"Uri"})})]}),"\n"]}),"\n",(0,i.jsx)(s.p,{children:"Convert a uri for the local file system to one that can be used inside webviews."}),"\n",(0,i.jsx)(s.h4,{id:"parameters",children:"Parameters"}),"\n",(0,i.jsxs)(s.p,{children:["\u2022 ",(0,i.jsx)(s.strong,{children:"localResource"}),": ",(0,i.jsx)(s.a,{href:"/api/classes/Uri",children:(0,i.jsx)(s.code,{children:"Uri"})})]}),"\n",(0,i.jsx)(s.h4,{id:"returns",children:"Returns"}),"\n",(0,i.jsx)(s.p,{children:(0,i.jsx)(s.a,{href:"/api/classes/Uri",children:(0,i.jsx)(s.code,{children:"Uri"})})}),"\n",(0,i.jsx)(s.h4,{id:"source-4",children:"Source"}),"\n",(0,i.jsx)(s.p,{children:(0,i.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L1426",children:"packages/extension-api/src/extension-api.d.ts:1426"})}),"\n",(0,i.jsx)(s.hr,{}),"\n",(0,i.jsx)(s.h3,{id:"postmessage",children:"postMessage()"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"postMessage"}),"(",(0,i.jsx)(s.code,{children:"message"}),"): ",(0,i.jsx)(s.code,{children:"Promise"}),"< ",(0,i.jsx)(s.code,{children:"boolean"})," >"]}),"\n"]}),"\n",(0,i.jsx)(s.p,{children:"Post a message to the webview content."}),"\n",(0,i.jsx)(s.h4,{id:"parameters-1",children:"Parameters"}),"\n",(0,i.jsxs)(s.p,{children:["\u2022 ",(0,i.jsx)(s.strong,{children:"message"}),": ",(0,i.jsx)(s.code,{children:"unknown"})]}),"\n",(0,i.jsx)(s.h4,{id:"returns-1",children:"Returns"}),"\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.code,{children:"Promise"}),"< ",(0,i.jsx)(s.code,{children:"boolean"})," >"]}),"\n",(0,i.jsx)(s.h4,{id:"source-5",children:"Source"}),"\n",(0,i.jsx)(s.p,{children:(0,i.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L1421",children:"packages/extension-api/src/extension-api.d.ts:1421"})})]})}function h(e={}){const{wrapper:s}={...(0,r.a)(),...e.components};return s?(0,i.jsx)(s,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},71670:(e,s,n)=>{n.d(s,{Z:()=>o,a:()=>t});var i=n(27378);const r={},c=i.createContext(r);function t(e){const s=i.useContext(c);return i.useMemo((function(){return"function"==typeof e?e(s):{...s,...e}}),[s,e])}function o(e){let s;return s=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:t(e.components),i.createElement(c.Provider,{value:s},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/7fa133e1.962898de.js b/assets/js/7fa133e1.bd68b85a.js similarity index 88% rename from assets/js/7fa133e1.962898de.js rename to assets/js/7fa133e1.bd68b85a.js index 2310bd82654..dadfd130a6e 100644 --- a/assets/js/7fa133e1.962898de.js +++ b/assets/js/7fa133e1.bd68b85a.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[31512],{62338:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>a,contentTitle:()=>r,default:()=>h,frontMatter:()=>c,metadata:()=>o,toc:()=>d});var t=s(24246),i=s(71670);const c={},r="Interface: CustomPickItem",o={id:"interfaces/CustomPickItem",title:"Interface: CustomPickItem",description:"Represents an item that can be selected from",source:"@site/api/interfaces/CustomPickItem.md",sourceDirName:"interfaces",slug:"/interfaces/CustomPickItem",permalink:"/api/interfaces/CustomPickItem",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: CustomPick\\",permalink:"/api/interfaces/CustomPick"},next:{title:"Interface: CustomPickSectionItem",permalink:"/api/interfaces/CustomPickSectionItem"}},a={},d=[{value:"Properties",id:"properties",level:2},{value:"description?",id:"description",level:3},{value:"Source",id:"source",level:4},{value:"markDownContent",id:"markdowncontent",level:3},{value:"Source",id:"source-1",level:4},{value:"sections?",id:"sections",level:3},{value:"Source",id:"source-2",level:4},{value:"selected?",id:"selected",level:3},{value:"Source",id:"source-3",level:4},{value:"title",id:"title",level:3},{value:"Source",id:"source-4",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,i.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"interface-custompickitem",children:"Interface: CustomPickItem"}),"\n",(0,t.jsx)(n.p,{children:"Represents an item that can be selected from\na list of items."}),"\n",(0,t.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,t.jsx)(n.h3,{id:"description",children:"description?"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:(0,t.jsx)(n.code,{children:"optional"})})," ",(0,t.jsx)(n.strong,{children:"description"}),": ",(0,t.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"A human-readable string which is rendered less prominent in the same line."}),"\n",(0,t.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L1074",children:"packages/extension-api/src/extension-api.d.ts:1074"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"markdowncontent",children:"markDownContent"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"markDownContent"}),": ",(0,t.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"A human-readable string which is rendered in a separate line. (Markdown format)"}),"\n",(0,t.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L1078",children:"packages/extension-api/src/extension-api.d.ts:1078"})}),"\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.strong,{children:(0,t.jsx)(n.code,{children:"optional"})})," ",(0,t.jsx)(n.strong,{children:"sections"}),": ",(0,t.jsx)(n.a,{href:"/api/interfaces/CustomPickSectionItem",children:(0,t.jsx)(n.code,{children:"CustomPickSectionItem"})}),"[]"]}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"Optional sections that will be rendered in separate lines"}),"\n",(0,t.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L1082",children:"packages/extension-api/src/extension-api.d.ts:1082"})}),"\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.strong,{children:(0,t.jsx)(n.code,{children:"optional"})})," ",(0,t.jsx)(n.strong,{children:"selected"}),": ",(0,t.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"Optional flag indicating if this item is selected initially"}),"\n",(0,t.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L1086",children:"packages/extension-api/src/extension-api.d.ts:1086"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"title",children:"title"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"title"}),": ",(0,t.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"A human-readable string which is rendered prominent."}),"\n",(0,t.jsx)(n.h4,{id:"source-4",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L1070",children:"packages/extension-api/src/extension-api.d.ts:1070"})})]})}function h(e={}){const{wrapper:n}={...(0,i.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>o,a:()=>r});var t=s(27378);const i={},c=t.createContext(i);function r(e){const n=t.useContext(c);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:r(e.components),t.createElement(c.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[31512],{62338:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>d,contentTitle:()=>r,default:()=>h,frontMatter:()=>c,metadata:()=>o,toc:()=>a});var t=s(24246),i=s(71670);const c={},r="Interface: CustomPickItem",o={id:"interfaces/CustomPickItem",title:"Interface: CustomPickItem",description:"Represents an item that can be selected from",source:"@site/api/interfaces/CustomPickItem.md",sourceDirName:"interfaces",slug:"/interfaces/CustomPickItem",permalink:"/api/interfaces/CustomPickItem",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: CustomPick\\",permalink:"/api/interfaces/CustomPick"},next:{title:"Interface: CustomPickSectionItem",permalink:"/api/interfaces/CustomPickSectionItem"}},d={},a=[{value:"Properties",id:"properties",level:2},{value:"description?",id:"description",level:3},{value:"Source",id:"source",level:4},{value:"markDownContent",id:"markdowncontent",level:3},{value:"Source",id:"source-1",level:4},{value:"sections?",id:"sections",level:3},{value:"Source",id:"source-2",level:4},{value:"selected?",id:"selected",level:3},{value:"Source",id:"source-3",level:4},{value:"title",id:"title",level:3},{value:"Source",id:"source-4",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,i.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"interface-custompickitem",children:"Interface: CustomPickItem"}),"\n",(0,t.jsx)(n.p,{children:"Represents an item that can be selected from\na list of items."}),"\n",(0,t.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,t.jsx)(n.h3,{id:"description",children:"description?"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:(0,t.jsx)(n.code,{children:"optional"})})," ",(0,t.jsx)(n.strong,{children:"description"}),": ",(0,t.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"A human-readable string which is rendered less prominent in the same line."}),"\n",(0,t.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L1074",children:"packages/extension-api/src/extension-api.d.ts:1074"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"markdowncontent",children:"markDownContent"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"markDownContent"}),": ",(0,t.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"A human-readable string which is rendered in a separate line. (Markdown format)"}),"\n",(0,t.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L1078",children:"packages/extension-api/src/extension-api.d.ts:1078"})}),"\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.strong,{children:(0,t.jsx)(n.code,{children:"optional"})})," ",(0,t.jsx)(n.strong,{children:"sections"}),": ",(0,t.jsx)(n.a,{href:"/api/interfaces/CustomPickSectionItem",children:(0,t.jsx)(n.code,{children:"CustomPickSectionItem"})}),"[]"]}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"Optional sections that will be rendered in separate lines"}),"\n",(0,t.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L1082",children:"packages/extension-api/src/extension-api.d.ts:1082"})}),"\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.strong,{children:(0,t.jsx)(n.code,{children:"optional"})})," ",(0,t.jsx)(n.strong,{children:"selected"}),": ",(0,t.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"Optional flag indicating if this item is selected initially"}),"\n",(0,t.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L1086",children:"packages/extension-api/src/extension-api.d.ts:1086"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"title",children:"title"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"title"}),": ",(0,t.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"A human-readable string which is rendered prominent."}),"\n",(0,t.jsx)(n.h4,{id:"source-4",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L1070",children:"packages/extension-api/src/extension-api.d.ts:1070"})})]})}function h(e={}){const{wrapper:n}={...(0,i.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>o,a:()=>r});var t=s(27378);const i={},c=t.createContext(i);function r(e){const n=t.useContext(c);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:r(e.components),t.createElement(c.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/814402d7.168ecaa5.js b/assets/js/814402d7.4b3642f5.js similarity index 90% rename from assets/js/814402d7.168ecaa5.js rename to assets/js/814402d7.4b3642f5.js index 8232f32e93e..f452de13217 100644 --- a/assets/js/814402d7.168ecaa5.js +++ b/assets/js/814402d7.4b3642f5.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[70985],{49272:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>r,default:()=>l,frontMatter:()=>o,metadata:()=>c,toc:()=>h});var i=t(24246),s=t(71670);const o={},r="Interface: AuthenticationProviderAuthenticationSessionsChangeEvent",c={id:"interfaces/AuthenticationProviderAuthenticationSessionsChangeEvent",title:"Interface: AuthenticationProviderAuthenticationSessionsChangeEvent",description:"An event which fires when an AuthenticationSession is added, removed, or changed.",source:"@site/api/interfaces/AuthenticationProviderAuthenticationSessionsChangeEvent.md",sourceDirName:"interfaces",slug:"/interfaces/AuthenticationProviderAuthenticationSessionsChangeEvent",permalink:"/api/interfaces/AuthenticationProviderAuthenticationSessionsChangeEvent",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: AuthenticationProvider",permalink:"/api/interfaces/AuthenticationProvider"},next:{title:"Interface: AuthenticationProviderInformation",permalink:"/api/interfaces/AuthenticationProviderInformation"}},a={},h=[{value:"Properties",id:"properties",level:2},{value:"added?",id:"added",level:3},{value:"Source",id:"source",level:4},{value:"changed?",id:"changed",level:3},{value:"Source",id:"source-1",level:4},{value:"removed?",id:"removed",level:3},{value:"Source",id:"source-2",level:4}];function 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-authenticationproviderauthenticationsessionschangeevent",children:"Interface: AuthenticationProviderAuthenticationSessionsChangeEvent"}),"\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:"added",children:"added?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"readonly"})})," ",(0,i.jsx)(n.strong,{children:"added"}),": readonly ",(0,i.jsx)(n.a,{href:"/api/interfaces/AuthenticationSession",children:(0,i.jsx)(n.code,{children:"AuthenticationSession"})}),"[]"]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["The ",(0,i.jsx)(n.a,{href:"#AuthenticationSession",children:"AuthenticationSession"}),"s of the ",(0,i.jsx)(n.a,{href:"#AuthentiationProvider",children:"AuthenticationProvider"})," that have been added."]}),"\n",(0,i.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L3530",children:"packages/extension-api/src/extension-api.d.ts:3530"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"changed",children:"changed?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"readonly"})})," ",(0,i.jsx)(n.strong,{children:"changed"}),": readonly ",(0,i.jsx)(n.a,{href:"/api/interfaces/AuthenticationSession",children:(0,i.jsx)(n.code,{children:"AuthenticationSession"})}),"[]"]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["The ",(0,i.jsx)(n.a,{href:"#AuthenticationSession",children:"AuthenticationSession"}),"s of the ",(0,i.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,i.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L3542",children:"packages/extension-api/src/extension-api.d.ts:3542"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"removed",children:"removed?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"readonly"})})," ",(0,i.jsx)(n.strong,{children:"removed"}),": readonly ",(0,i.jsx)(n.a,{href:"/api/interfaces/AuthenticationSession",children:(0,i.jsx)(n.code,{children:"AuthenticationSession"})}),"[]"]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["The ",(0,i.jsx)(n.a,{href:"#AuthenticationSession",children:"AuthenticationSession"}),"s of the ",(0,i.jsx)(n.a,{href:"#AuthentiationProvider",children:"AuthenticationProvider"})," that have been removed."]}),"\n",(0,i.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L3535",children:"packages/extension-api/src/extension-api.d.ts:3535"})})]})}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:()=>c,a:()=>r});var i=t(27378);const s={},o=i.createContext(s);function r(e){const n=i.useContext(o);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:r(e.components),i.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[70985],{49272:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>r,default:()=>l,frontMatter:()=>o,metadata:()=>c,toc:()=>d});var i=t(24246),s=t(71670);const o={},r="Interface: AuthenticationProviderAuthenticationSessionsChangeEvent",c={id:"interfaces/AuthenticationProviderAuthenticationSessionsChangeEvent",title:"Interface: AuthenticationProviderAuthenticationSessionsChangeEvent",description:"An event which fires when an AuthenticationSession is added, removed, or changed.",source:"@site/api/interfaces/AuthenticationProviderAuthenticationSessionsChangeEvent.md",sourceDirName:"interfaces",slug:"/interfaces/AuthenticationProviderAuthenticationSessionsChangeEvent",permalink:"/api/interfaces/AuthenticationProviderAuthenticationSessionsChangeEvent",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: AuthenticationProvider",permalink:"/api/interfaces/AuthenticationProvider"},next:{title:"Interface: AuthenticationProviderInformation",permalink:"/api/interfaces/AuthenticationProviderInformation"}},a={},d=[{value:"Properties",id:"properties",level:2},{value:"added?",id:"added",level:3},{value:"Source",id:"source",level:4},{value:"changed?",id:"changed",level:3},{value:"Source",id:"source-1",level:4},{value:"removed?",id:"removed",level:3},{value:"Source",id:"source-2",level:4}];function h(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"interface-authenticationproviderauthenticationsessionschangeevent",children:"Interface: AuthenticationProviderAuthenticationSessionsChangeEvent"}),"\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:"added",children:"added?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"readonly"})})," ",(0,i.jsx)(n.strong,{children:"added"}),": readonly ",(0,i.jsx)(n.a,{href:"/api/interfaces/AuthenticationSession",children:(0,i.jsx)(n.code,{children:"AuthenticationSession"})}),"[]"]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["The ",(0,i.jsx)(n.a,{href:"#AuthenticationSession",children:"AuthenticationSession"}),"s of the ",(0,i.jsx)(n.a,{href:"#AuthentiationProvider",children:"AuthenticationProvider"})," that have been added."]}),"\n",(0,i.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L3530",children:"packages/extension-api/src/extension-api.d.ts:3530"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"changed",children:"changed?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"readonly"})})," ",(0,i.jsx)(n.strong,{children:"changed"}),": readonly ",(0,i.jsx)(n.a,{href:"/api/interfaces/AuthenticationSession",children:(0,i.jsx)(n.code,{children:"AuthenticationSession"})}),"[]"]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["The ",(0,i.jsx)(n.a,{href:"#AuthenticationSession",children:"AuthenticationSession"}),"s of the ",(0,i.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,i.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L3542",children:"packages/extension-api/src/extension-api.d.ts:3542"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"removed",children:"removed?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"readonly"})})," ",(0,i.jsx)(n.strong,{children:"removed"}),": readonly ",(0,i.jsx)(n.a,{href:"/api/interfaces/AuthenticationSession",children:(0,i.jsx)(n.code,{children:"AuthenticationSession"})}),"[]"]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["The ",(0,i.jsx)(n.a,{href:"#AuthenticationSession",children:"AuthenticationSession"}),"s of the ",(0,i.jsx)(n.a,{href:"#AuthentiationProvider",children:"AuthenticationProvider"})," that have been removed."]}),"\n",(0,i.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L3535",children:"packages/extension-api/src/extension-api.d.ts:3535"})})]})}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:()=>c,a:()=>r});var i=t(27378);const s={},o=i.createContext(s);function r(e){const n=i.useContext(o);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:r(e.components),i.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/814d49b7.f35d1c27.js b/assets/js/814d49b7.d64be048.js similarity index 85% rename from assets/js/814d49b7.f35d1c27.js rename to assets/js/814d49b7.d64be048.js index 137d86f3e09..fe42e9372ee 100644 --- a/assets/js/814d49b7.f35d1c27.js +++ b/assets/js/814d49b7.d64be048.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[125],{12005:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>a,contentTitle:()=>r,default:()=>p,frontMatter:()=>t,metadata:()=>c,toc:()=>d});var i=s(24246),o=s(71670);const t={},r="Interface: CliToolUpdateOptions",c={id:"interfaces/CliToolUpdateOptions",title:"Interface: CliToolUpdateOptions",description:"Options to update CliTool instance",source:"@site/api/interfaces/CliToolUpdateOptions.md",sourceDirName:"interfaces",slug:"/interfaces/CliToolUpdateOptions",permalink:"/api/interfaces/CliToolUpdateOptions",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: CliToolUpdate",permalink:"/api/interfaces/CliToolUpdate"},next:{title:"Interface: Clipboard",permalink:"/api/interfaces/Clipboard"}},a={},d=[{value:"Properties",id:"properties",level:2},{value:"displayName?",id:"displayname",level:3},{value:"Source",id:"source",level:4},{value:"images?",id:"images",level:3},{value:"Source",id:"source-1",level:4},{value:"markdownDescription?",id:"markdowndescription",level:3},{value:"Source",id:"source-2",level:4},{value:"path?",id:"path",level:3},{value:"Source",id:"source-3",level:4},{value:"version",id:"version",level:3},{value:"Source",id:"source-4",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,o.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"interface-clitoolupdateoptions",children:"Interface: CliToolUpdateOptions"}),"\n",(0,i.jsx)(n.p,{children:"Options to update CliTool instance"}),"\n",(0,i.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(n.h3,{id:"displayname",children:"displayName?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"displayName"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L4020",children:"packages/extension-api/src/extension-api.d.ts:4020"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"images",children:"images?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"images"}),": ",(0,i.jsx)(n.a,{href:"/api/interfaces/ProviderImages",children:(0,i.jsx)(n.code,{children:"ProviderImages"})})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L4022",children:"packages/extension-api/src/extension-api.d.ts:4022"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"markdowndescription",children:"markdownDescription?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"markdownDescription"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L4021",children:"packages/extension-api/src/extension-api.d.ts:4021"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"path",children:"path?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"path"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L4023",children:"packages/extension-api/src/extension-api.d.ts:4023"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"version",children:"version"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"version"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-4",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L4019",children:"packages/extension-api/src/extension-api.d.ts:4019"})})]})}function p(e={}){const{wrapper:n}={...(0,o.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>c,a:()=>r});var i=s(27378);const o={},t=i.createContext(o);function r(e){const n=i.useContext(t);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:r(e.components),i.createElement(t.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[125],{12005:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>d,contentTitle:()=>r,default:()=>p,frontMatter:()=>t,metadata:()=>c,toc:()=>a});var i=s(24246),o=s(71670);const t={},r="Interface: CliToolUpdateOptions",c={id:"interfaces/CliToolUpdateOptions",title:"Interface: CliToolUpdateOptions",description:"Options to update CliTool instance",source:"@site/api/interfaces/CliToolUpdateOptions.md",sourceDirName:"interfaces",slug:"/interfaces/CliToolUpdateOptions",permalink:"/api/interfaces/CliToolUpdateOptions",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: CliToolUpdate",permalink:"/api/interfaces/CliToolUpdate"},next:{title:"Interface: Clipboard",permalink:"/api/interfaces/Clipboard"}},d={},a=[{value:"Properties",id:"properties",level:2},{value:"displayName?",id:"displayname",level:3},{value:"Source",id:"source",level:4},{value:"images?",id:"images",level:3},{value:"Source",id:"source-1",level:4},{value:"markdownDescription?",id:"markdowndescription",level:3},{value:"Source",id:"source-2",level:4},{value:"path?",id:"path",level:3},{value:"Source",id:"source-3",level:4},{value:"version",id:"version",level:3},{value:"Source",id:"source-4",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,o.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"interface-clitoolupdateoptions",children:"Interface: CliToolUpdateOptions"}),"\n",(0,i.jsx)(n.p,{children:"Options to update CliTool instance"}),"\n",(0,i.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(n.h3,{id:"displayname",children:"displayName?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"displayName"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L4020",children:"packages/extension-api/src/extension-api.d.ts:4020"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"images",children:"images?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"images"}),": ",(0,i.jsx)(n.a,{href:"/api/interfaces/ProviderImages",children:(0,i.jsx)(n.code,{children:"ProviderImages"})})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L4022",children:"packages/extension-api/src/extension-api.d.ts:4022"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"markdowndescription",children:"markdownDescription?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"markdownDescription"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L4021",children:"packages/extension-api/src/extension-api.d.ts:4021"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"path",children:"path?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"path"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L4023",children:"packages/extension-api/src/extension-api.d.ts:4023"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"version",children:"version"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"version"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-4",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L4019",children:"packages/extension-api/src/extension-api.d.ts:4019"})})]})}function p(e={}){const{wrapper:n}={...(0,o.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>c,a:()=>r});var i=s(27378);const o={},t=i.createContext(o);function r(e){const n=i.useContext(t);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:r(e.components),i.createElement(t.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/81b69ac7.12bfd79d.js b/assets/js/81b69ac7.e88b3c8e.js similarity index 89% rename from assets/js/81b69ac7.12bfd79d.js rename to assets/js/81b69ac7.e88b3c8e.js index 1b729c5ed93..2109342ef2c 100644 --- a/assets/js/81b69ac7.12bfd79d.js +++ b/assets/js/81b69ac7.e88b3c8e.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[92786],{63500:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>d,contentTitle:()=>o,default:()=>h,frontMatter:()=>c,metadata:()=>s,toc:()=>a});var r=i(24246),t=i(71670);const c={},o="Interface: KubernetesProviderConnectionFactory",s={id:"interfaces/KubernetesProviderConnectionFactory",title:"Interface: KubernetesProviderConnectionFactory",description:"Extends",source:"@site/api/interfaces/KubernetesProviderConnectionFactory.md",sourceDirName:"interfaces",slug:"/interfaces/KubernetesProviderConnectionFactory",permalink:"/api/interfaces/KubernetesProviderConnectionFactory",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: KubernetesProviderConnectionEndpoint",permalink:"/api/interfaces/KubernetesProviderConnectionEndpoint"},next:{title:"Interface: LifecycleContext",permalink:"/api/interfaces/LifecycleContext"}},d={},a=[{value:"Extends",id:"extends",level:2},{value:"Properties",id:"properties",level:2},{value:"creationButtonTitle?",id:"creationbuttontitle",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Source",id:"source",level:4},{value:"creationDisplayName?",id:"creationdisplayname",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Source",id:"source-1",level:4},{value:"Methods",id:"methods",level:2},{value:"create()?",id:"create",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Source",id:"source-2",level:4},{value:"initialize()?",id:"initialize",level:3},{value:"Returns",id:"returns-1",level:4},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Source",id:"source-3",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",li:"li",p:"p",strong:"strong",ul:"ul",...(0,t.a)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.h1,{id:"interface-kubernetesproviderconnectionfactory",children:"Interface: KubernetesProviderConnectionFactory"}),"\n",(0,r.jsx)(n.h2,{id:"extends",children:"Extends"}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"/api/interfaces/ProviderConnectionFactory",children:(0,r.jsx)(n.code,{children:"ProviderConnectionFactory"})})}),"\n"]}),"\n",(0,r.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,r.jsx)(n.h3,{id:"creationbuttontitle",children:"creationButtonTitle?"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"optional"})})," ",(0,r.jsx)(n.strong,{children:"creationButtonTitle"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"inherited-from",children:"Inherited from"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.a,{href:"/api/interfaces/ProviderConnectionFactory",children:(0,r.jsx)(n.code,{children:"ProviderConnectionFactory"})}),".",(0,r.jsx)(n.a,{href:"/api/interfaces/ProviderConnectionFactory#creationbuttontitle",children:(0,r.jsx)(n.code,{children:"creationButtonTitle"})})]}),"\n",(0,r.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L317",children:"packages/extension-api/src/extension-api.d.ts:317"})}),"\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.strong,{children:(0,r.jsx)(n.code,{children:"optional"})})," ",(0,r.jsx)(n.strong,{children:"creationDisplayName"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"inherited-from-1",children:"Inherited from"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.a,{href:"/api/interfaces/ProviderConnectionFactory",children:(0,r.jsx)(n.code,{children:"ProviderConnectionFactory"})}),".",(0,r.jsx)(n.a,{href:"/api/interfaces/ProviderConnectionFactory#creationdisplayname",children:(0,r.jsx)(n.code,{children:"creationDisplayName"})})]}),"\n",(0,r.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L314",children:"packages/extension-api/src/extension-api.d.ts:314"})}),"\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:(0,r.jsx)(n.code,{children:"optional"})})," ",(0,r.jsx)(n.strong,{children:"create"}),"(",(0,r.jsx)(n.code,{children:"params"}),", ",(0,r.jsx)(n.code,{children:"logger"}),"?, ",(0,r.jsx)(n.code,{children:"token"}),"?): ",(0,r.jsx)(n.code,{children:"Promise"}),"< ",(0,r.jsx)(n.code,{children:"void"})," >"]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"parameters",children:"Parameters"}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"params"})]}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"logger?"}),": ",(0,r.jsx)(n.a,{href:"/api/interfaces/Logger",children:(0,r.jsx)(n.code,{children:"Logger"})})]}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"token?"}),": ",(0,r.jsx)(n.a,{href:"/api/interfaces/CancellationToken",children:(0,r.jsx)(n.code,{children:"CancellationToken"})})]}),"\n",(0,r.jsx)(n.h4,{id:"returns",children:"Returns"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"Promise"}),"< ",(0,r.jsx)(n.code,{children:"void"})," >"]}),"\n",(0,r.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L329",children:"packages/extension-api/src/extension-api.d.ts:329"})}),"\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.strong,{children:(0,r.jsx)(n.code,{children:"optional"})})," ",(0,r.jsx)(n.strong,{children:"initialize"}),"(): ",(0,r.jsx)(n.code,{children:"Promise"}),"< ",(0,r.jsx)(n.code,{children:"void"})," >"]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"returns-1",children:"Returns"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"Promise"}),"< ",(0,r.jsx)(n.code,{children:"void"})," >"]}),"\n",(0,r.jsx)(n.h4,{id:"inherited-from-2",children:"Inherited from"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.a,{href:"/api/interfaces/ProviderConnectionFactory",children:(0,r.jsx)(n.code,{children:"ProviderConnectionFactory"})}),".",(0,r.jsx)(n.a,{href:"/api/interfaces/ProviderConnectionFactory#initialize",children:(0,r.jsx)(n.code,{children:"initialize"})})]}),"\n",(0,r.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L311",children:"packages/extension-api/src/extension-api.d.ts:311"})})]})}function h(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(l,{...e})}):l(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>s,a:()=>o});var r=i(27378);const t={},c=r.createContext(t);function o(e){const n=r.useContext(c);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function s(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:o(e.components),r.createElement(c.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[92786],{63500:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>d,contentTitle:()=>c,default:()=>h,frontMatter:()=>o,metadata:()=>s,toc:()=>a});var r=i(24246),t=i(71670);const o={},c="Interface: KubernetesProviderConnectionFactory",s={id:"interfaces/KubernetesProviderConnectionFactory",title:"Interface: KubernetesProviderConnectionFactory",description:"Extends",source:"@site/api/interfaces/KubernetesProviderConnectionFactory.md",sourceDirName:"interfaces",slug:"/interfaces/KubernetesProviderConnectionFactory",permalink:"/api/interfaces/KubernetesProviderConnectionFactory",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: KubernetesProviderConnectionEndpoint",permalink:"/api/interfaces/KubernetesProviderConnectionEndpoint"},next:{title:"Interface: LifecycleContext",permalink:"/api/interfaces/LifecycleContext"}},d={},a=[{value:"Extends",id:"extends",level:2},{value:"Properties",id:"properties",level:2},{value:"creationButtonTitle?",id:"creationbuttontitle",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Source",id:"source",level:4},{value:"creationDisplayName?",id:"creationdisplayname",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Source",id:"source-1",level:4},{value:"Methods",id:"methods",level:2},{value:"create()?",id:"create",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Source",id:"source-2",level:4},{value:"initialize()?",id:"initialize",level:3},{value:"Returns",id:"returns-1",level:4},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Source",id:"source-3",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",li:"li",p:"p",strong:"strong",ul:"ul",...(0,t.a)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.h1,{id:"interface-kubernetesproviderconnectionfactory",children:"Interface: KubernetesProviderConnectionFactory"}),"\n",(0,r.jsx)(n.h2,{id:"extends",children:"Extends"}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"/api/interfaces/ProviderConnectionFactory",children:(0,r.jsx)(n.code,{children:"ProviderConnectionFactory"})})}),"\n"]}),"\n",(0,r.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,r.jsx)(n.h3,{id:"creationbuttontitle",children:"creationButtonTitle?"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"optional"})})," ",(0,r.jsx)(n.strong,{children:"creationButtonTitle"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"inherited-from",children:"Inherited from"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.a,{href:"/api/interfaces/ProviderConnectionFactory",children:(0,r.jsx)(n.code,{children:"ProviderConnectionFactory"})}),".",(0,r.jsx)(n.a,{href:"/api/interfaces/ProviderConnectionFactory#creationbuttontitle",children:(0,r.jsx)(n.code,{children:"creationButtonTitle"})})]}),"\n",(0,r.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L317",children:"packages/extension-api/src/extension-api.d.ts:317"})}),"\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.strong,{children:(0,r.jsx)(n.code,{children:"optional"})})," ",(0,r.jsx)(n.strong,{children:"creationDisplayName"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"inherited-from-1",children:"Inherited from"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.a,{href:"/api/interfaces/ProviderConnectionFactory",children:(0,r.jsx)(n.code,{children:"ProviderConnectionFactory"})}),".",(0,r.jsx)(n.a,{href:"/api/interfaces/ProviderConnectionFactory#creationdisplayname",children:(0,r.jsx)(n.code,{children:"creationDisplayName"})})]}),"\n",(0,r.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L314",children:"packages/extension-api/src/extension-api.d.ts:314"})}),"\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:(0,r.jsx)(n.code,{children:"optional"})})," ",(0,r.jsx)(n.strong,{children:"create"}),"(",(0,r.jsx)(n.code,{children:"params"}),", ",(0,r.jsx)(n.code,{children:"logger"}),"?, ",(0,r.jsx)(n.code,{children:"token"}),"?): ",(0,r.jsx)(n.code,{children:"Promise"}),"< ",(0,r.jsx)(n.code,{children:"void"})," >"]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"parameters",children:"Parameters"}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"params"})]}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"logger?"}),": ",(0,r.jsx)(n.a,{href:"/api/interfaces/Logger",children:(0,r.jsx)(n.code,{children:"Logger"})})]}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"token?"}),": ",(0,r.jsx)(n.a,{href:"/api/interfaces/CancellationToken",children:(0,r.jsx)(n.code,{children:"CancellationToken"})})]}),"\n",(0,r.jsx)(n.h4,{id:"returns",children:"Returns"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"Promise"}),"< ",(0,r.jsx)(n.code,{children:"void"})," >"]}),"\n",(0,r.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L329",children:"packages/extension-api/src/extension-api.d.ts:329"})}),"\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.strong,{children:(0,r.jsx)(n.code,{children:"optional"})})," ",(0,r.jsx)(n.strong,{children:"initialize"}),"(): ",(0,r.jsx)(n.code,{children:"Promise"}),"< ",(0,r.jsx)(n.code,{children:"void"})," >"]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"returns-1",children:"Returns"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"Promise"}),"< ",(0,r.jsx)(n.code,{children:"void"})," >"]}),"\n",(0,r.jsx)(n.h4,{id:"inherited-from-2",children:"Inherited from"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.a,{href:"/api/interfaces/ProviderConnectionFactory",children:(0,r.jsx)(n.code,{children:"ProviderConnectionFactory"})}),".",(0,r.jsx)(n.a,{href:"/api/interfaces/ProviderConnectionFactory#initialize",children:(0,r.jsx)(n.code,{children:"initialize"})})]}),"\n",(0,r.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L311",children:"packages/extension-api/src/extension-api.d.ts:311"})})]})}function h(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(l,{...e})}):l(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>s,a:()=>c});var r=i(27378);const t={},o=r.createContext(t);function c(e){const n=r.useContext(o);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function s(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:c(e.components),r.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/82170cf7.ef992965.js b/assets/js/82170cf7.da09643d.js similarity index 98% rename from assets/js/82170cf7.ef992965.js rename to assets/js/82170cf7.da09643d.js index a980d0d0a9c..501d3fb98a5 100644 --- a/assets/js/82170cf7.ef992965.js +++ b/assets/js/82170cf7.da09643d.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[28263],{95261:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>o,default:()=>p,frontMatter:()=>c,metadata:()=>r,toc:()=>d});var s=t(24246),i=t(71670);const c={},o="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:"Function: deleteVolume()",permalink:"/api/namespaces/containerEngine/functions/deleteVolume"},next:{title:"Function: info()",permalink:"/api/namespaces/containerEngine/functions/info"}},a={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,i.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"function-getimageinspect",children:"Function: getImageInspect()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"getImageInspect"}),"(",(0,s.jsx)(n.code,{children:"engineId"}),", ",(0,s.jsx)(n.code,{children:"id"}),"): ",(0,s.jsx)(n.code,{children:"Promise"}),"< ",(0,s.jsx)(n.a,{href:"/api/interfaces/ImageInspectInfo",children:(0,s.jsx)(n.code,{children:"ImageInspectInfo"})})," >"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Return low-level information about an image"}),"\n",(0,s.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"engineId"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n",(0,s.jsxs)(n.p,{children:["the id of the engine managing the image, obtained from the result of ",(0,s.jsx)(n.a,{href:"/api/namespaces/containerEngine/functions/listImages",children:"containerEngine.listImages"})]}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"id"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n",(0,s.jsxs)(n.p,{children:["the id of the image on this engine, obtained from the result of ",(0,s.jsx)(n.a,{href:"/api/namespaces/containerEngine/functions/listImages",children:"containerEngine.listImages"})]}),"\n",(0,s.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"Promise"}),"< ",(0,s.jsx)(n.a,{href:"/api/interfaces/ImageInspectInfo",children:(0,s.jsx)(n.code,{children:"ImageInspectInfo"})})," >"]}),"\n",(0,s.jsx)(n.p,{children:"A promise resolving to a structure containing the image information"}),"\n",(0,s.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L3340",children:"packages/extension-api/src/extension-api.d.ts:3340"})})]})}function p(e={}){const{wrapper:n}={...(0,i.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>r,a:()=>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([[28263],{95261:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>o,default:()=>p,frontMatter:()=>c,metadata:()=>r,toc:()=>d});var s=t(24246),i=t(71670);const c={},o="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:"Function: deleteVolume()",permalink:"/api/namespaces/containerEngine/functions/deleteVolume"},next:{title:"Function: info()",permalink:"/api/namespaces/containerEngine/functions/info"}},a={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,i.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"function-getimageinspect",children:"Function: getImageInspect()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"getImageInspect"}),"(",(0,s.jsx)(n.code,{children:"engineId"}),", ",(0,s.jsx)(n.code,{children:"id"}),"): ",(0,s.jsx)(n.code,{children:"Promise"}),"< ",(0,s.jsx)(n.a,{href:"/api/interfaces/ImageInspectInfo",children:(0,s.jsx)(n.code,{children:"ImageInspectInfo"})})," >"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Return low-level information about an image"}),"\n",(0,s.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"engineId"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n",(0,s.jsxs)(n.p,{children:["the id of the engine managing the image, obtained from the result of ",(0,s.jsx)(n.a,{href:"/api/namespaces/containerEngine/functions/listImages",children:"containerEngine.listImages"})]}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"id"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n",(0,s.jsxs)(n.p,{children:["the id of the image on this engine, obtained from the result of ",(0,s.jsx)(n.a,{href:"/api/namespaces/containerEngine/functions/listImages",children:"containerEngine.listImages"})]}),"\n",(0,s.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"Promise"}),"< ",(0,s.jsx)(n.a,{href:"/api/interfaces/ImageInspectInfo",children:(0,s.jsx)(n.code,{children:"ImageInspectInfo"})})," >"]}),"\n",(0,s.jsx)(n.p,{children:"A promise resolving to a structure containing the image information"}),"\n",(0,s.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L3340",children:"packages/extension-api/src/extension-api.d.ts:3340"})})]})}function p(e={}){const{wrapper:n}={...(0,i.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>r,a:()=>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/825ec378.4d60eb6d.js b/assets/js/825ec378.6b40b5e1.js similarity index 96% rename from assets/js/825ec378.4d60eb6d.js rename to assets/js/825ec378.6b40b5e1.js index 2ae5d23904c..5196224bdbe 100644 --- a/assets/js/825ec378.4d60eb6d.js +++ b/assets/js/825ec378.6b40b5e1.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[83039],{71998:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>a,contentTitle:()=>r,default:()=>u,frontMatter:()=>c,metadata:()=>o,toc:()=>d});var t=i(24246),s=i(71670);const c={},r="Function: buildImage()",o={id:"namespaces/containerEngine/functions/buildImage",title:"Function: buildImage()",description:"buildImage(context, eventCollect, options?): Promise\\",source:"@site/api/namespaces/containerEngine/functions/buildImage.md",sourceDirName:"namespaces/containerEngine/functions",slug:"/namespaces/containerEngine/functions/buildImage",permalink:"/api/namespaces/containerEngine/functions/buildImage",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Namespace: containerEngine",permalink:"/api/namespaces/containerEngine/"},next:{title:"Function: createContainer()",permalink:"/api/namespaces/containerEngine/functions/createContainer"}},a={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"function-buildimage",children:"Function: buildImage()"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"buildImage"}),"(",(0,t.jsx)(n.code,{children:"context"}),", ",(0,t.jsx)(n.code,{children:"eventCollect"}),", ",(0,t.jsx)(n.code,{children:"options"}),"?): ",(0,t.jsx)(n.code,{children:"Promise"}),"< ",(0,t.jsx)(n.code,{children:"unknown"})," >"]}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"Build a container image"}),"\n",(0,t.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"context"}),": ",(0,t.jsx)(n.code,{children:"string"})]}),"\n",(0,t.jsx)(n.p,{children:"the build context directory"}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"eventCollect"})]}),"\n",(0,t.jsxs)(n.p,{children:["a function called when new build logs are emitted or new events happen during the build operation. The value of ",(0,t.jsx)(n.code,{children:"eventName"})," can be either ",(0,t.jsx)(n.code,{children:"stream"})," (and ",(0,t.jsx)(n.code,{children:"data"})," contains the logs), or ",(0,t.jsx)(n.code,{children:"finish"})," indicating the end of the build operation, or ",(0,t.jsx)(n.code,{children:"error"})," in case of build error (and ",(0,t.jsx)(n.code,{children:"data"})," contains the error message)"]}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"options?"}),": ",(0,t.jsx)(n.a,{href:"/api/interfaces/BuildImageOptions",children:(0,t.jsx)(n.code,{children:"BuildImageOptions"})})]}),"\n",(0,t.jsx)(n.p,{children:"parameters for the build operation"}),"\n",(0,t.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"Promise"}),"< ",(0,t.jsx)(n.code,{children:"unknown"})," >"]}),"\n",(0,t.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L3251",children:"packages/extension-api/src/extension-api.d.ts:3251"})})]})}function u(e={}){const{wrapper:n}={...(0,s.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>o,a:()=>r});var t=i(27378);const s={},c=t.createContext(s);function r(e){const n=t.useContext(c);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:r(e.components),t.createElement(c.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[83039],{71998:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>a,contentTitle:()=>r,default:()=>u,frontMatter:()=>c,metadata:()=>o,toc:()=>d});var t=i(24246),s=i(71670);const c={},r="Function: buildImage()",o={id:"namespaces/containerEngine/functions/buildImage",title:"Function: buildImage()",description:"buildImage(context, eventCollect, options?): Promise\\",source:"@site/api/namespaces/containerEngine/functions/buildImage.md",sourceDirName:"namespaces/containerEngine/functions",slug:"/namespaces/containerEngine/functions/buildImage",permalink:"/api/namespaces/containerEngine/functions/buildImage",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Namespace: containerEngine",permalink:"/api/namespaces/containerEngine/"},next:{title:"Function: createContainer()",permalink:"/api/namespaces/containerEngine/functions/createContainer"}},a={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"function-buildimage",children:"Function: buildImage()"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"buildImage"}),"(",(0,t.jsx)(n.code,{children:"context"}),", ",(0,t.jsx)(n.code,{children:"eventCollect"}),", ",(0,t.jsx)(n.code,{children:"options"}),"?): ",(0,t.jsx)(n.code,{children:"Promise"}),"< ",(0,t.jsx)(n.code,{children:"unknown"})," >"]}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"Build a container image"}),"\n",(0,t.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"context"}),": ",(0,t.jsx)(n.code,{children:"string"})]}),"\n",(0,t.jsx)(n.p,{children:"the build context directory"}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"eventCollect"})]}),"\n",(0,t.jsxs)(n.p,{children:["a function called when new build logs are emitted or new events happen during the build operation. The value of ",(0,t.jsx)(n.code,{children:"eventName"})," can be either ",(0,t.jsx)(n.code,{children:"stream"})," (and ",(0,t.jsx)(n.code,{children:"data"})," contains the logs), or ",(0,t.jsx)(n.code,{children:"finish"})," indicating the end of the build operation, or ",(0,t.jsx)(n.code,{children:"error"})," in case of build error (and ",(0,t.jsx)(n.code,{children:"data"})," contains the error message)"]}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"options?"}),": ",(0,t.jsx)(n.a,{href:"/api/interfaces/BuildImageOptions",children:(0,t.jsx)(n.code,{children:"BuildImageOptions"})})]}),"\n",(0,t.jsx)(n.p,{children:"parameters for the build operation"}),"\n",(0,t.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"Promise"}),"< ",(0,t.jsx)(n.code,{children:"unknown"})," >"]}),"\n",(0,t.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L3251",children:"packages/extension-api/src/extension-api.d.ts:3251"})})]})}function u(e={}){const{wrapper:n}={...(0,s.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>o,a:()=>r});var t=i(27378);const s={},c=t.createContext(s);function r(e){const n=t.useContext(c);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:r(e.components),t.createElement(c.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/8519c2b0.6837a6bf.js b/assets/js/8519c2b0.151d6303.js similarity index 96% rename from assets/js/8519c2b0.6837a6bf.js rename to assets/js/8519c2b0.151d6303.js index 2f0bd292874..152d942f680 100644 --- a/assets/js/8519c2b0.6837a6bf.js +++ b/assets/js/8519c2b0.151d6303.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[40569],{17883:(e,s,n)=>{n.r(s),n.d(s,{assets:()=>a,contentTitle:()=>i,default:()=>h,frontMatter:()=>t,metadata:()=>c,toc:()=>d});var r=n(24246),o=n(71670);const t={},i="Function: showErrorMessage()",c={id:"namespaces/window/functions/showErrorMessage",title:"Function: showErrorMessage()",description:"showErrorMessage(message, ...items): Promise\\",source:"@site/api/namespaces/window/functions/showErrorMessage.md",sourceDirName:"namespaces/window/functions",slug:"/namespaces/window/functions/showErrorMessage",permalink:"/api/namespaces/window/functions/showErrorMessage",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Function: listWebviews()",permalink:"/api/namespaces/window/functions/listWebviews"},next:{title:"Function: showInformationMessage()",permalink:"/api/namespaces/window/functions/showInformationMessage"}},a={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function l(e){const s={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,o.a)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(s.h1,{id:"function-showerrormessage",children:"Function: showErrorMessage()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"showErrorMessage"}),"(",(0,r.jsx)(s.code,{children:"message"}),", ...",(0,r.jsx)(s.code,{children:"items"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"< ",(0,r.jsx)(s.code,{children:"string"})," | ",(0,r.jsx)(s.code,{children:"undefined"})," >"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Show a error message. Optionally provide an array of items which will be presented as\nclickable buttons."}),"\n",(0,r.jsx)(s.h2,{id:"parameters",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"message"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:"The message to show."}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ...",(0,r.jsx)(s.strong,{children:"items"}),": ",(0,r.jsx)(s.code,{children:"string"}),"[]"]}),"\n",(0,r.jsx)(s.p,{children:"A set of items that will be rendered as actions in the message."}),"\n",(0,r.jsx)(s.h2,{id:"returns",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"< ",(0,r.jsx)(s.code,{children:"string"})," | ",(0,r.jsx)(s.code,{children:"undefined"})," >"]}),"\n",(0,r.jsxs)(s.p,{children:["A promise that resolves to the selected item or ",(0,r.jsx)(s.code,{children:"undefined"})," when being dismissed."]}),"\n",(0,r.jsx)(s.h2,{id:"source",children:"Source"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L1612",children:"packages/extension-api/src/extension-api.d.ts:1612"})})]})}function h(e={}){const{wrapper:s}={...(0,o.a)(),...e.components};return s?(0,r.jsx)(s,{...e,children:(0,r.jsx)(l,{...e})}):l(e)}},71670:(e,s,n)=>{n.d(s,{Z:()=>c,a:()=>i});var r=n(27378);const o={},t=r.createContext(o);function i(e){const s=r.useContext(t);return r.useMemo((function(){return"function"==typeof e?e(s):{...s,...e}}),[s,e])}function c(e){let s;return s=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:i(e.components),r.createElement(t.Provider,{value:s},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[40569],{17883:(e,s,n)=>{n.r(s),n.d(s,{assets:()=>a,contentTitle:()=>i,default:()=>h,frontMatter:()=>t,metadata:()=>c,toc:()=>d});var r=n(24246),o=n(71670);const t={},i="Function: showErrorMessage()",c={id:"namespaces/window/functions/showErrorMessage",title:"Function: showErrorMessage()",description:"showErrorMessage(message, ...items): Promise\\",source:"@site/api/namespaces/window/functions/showErrorMessage.md",sourceDirName:"namespaces/window/functions",slug:"/namespaces/window/functions/showErrorMessage",permalink:"/api/namespaces/window/functions/showErrorMessage",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Function: listWebviews()",permalink:"/api/namespaces/window/functions/listWebviews"},next:{title:"Function: showInformationMessage()",permalink:"/api/namespaces/window/functions/showInformationMessage"}},a={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function l(e){const s={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,o.a)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(s.h1,{id:"function-showerrormessage",children:"Function: showErrorMessage()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"showErrorMessage"}),"(",(0,r.jsx)(s.code,{children:"message"}),", ...",(0,r.jsx)(s.code,{children:"items"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"< ",(0,r.jsx)(s.code,{children:"string"})," | ",(0,r.jsx)(s.code,{children:"undefined"})," >"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Show a error message. Optionally provide an array of items which will be presented as\nclickable buttons."}),"\n",(0,r.jsx)(s.h2,{id:"parameters",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"message"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:"The message to show."}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ...",(0,r.jsx)(s.strong,{children:"items"}),": ",(0,r.jsx)(s.code,{children:"string"}),"[]"]}),"\n",(0,r.jsx)(s.p,{children:"A set of items that will be rendered as actions in the message."}),"\n",(0,r.jsx)(s.h2,{id:"returns",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"< ",(0,r.jsx)(s.code,{children:"string"})," | ",(0,r.jsx)(s.code,{children:"undefined"})," >"]}),"\n",(0,r.jsxs)(s.p,{children:["A promise that resolves to the selected item or ",(0,r.jsx)(s.code,{children:"undefined"})," when being dismissed."]}),"\n",(0,r.jsx)(s.h2,{id:"source",children:"Source"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L1612",children:"packages/extension-api/src/extension-api.d.ts:1612"})})]})}function h(e={}){const{wrapper:s}={...(0,o.a)(),...e.components};return s?(0,r.jsx)(s,{...e,children:(0,r.jsx)(l,{...e})}):l(e)}},71670:(e,s,n)=>{n.d(s,{Z:()=>c,a:()=>i});var r=n(27378);const o={},t=r.createContext(o);function i(e){const s=r.useContext(t);return r.useMemo((function(){return"function"==typeof e?e(s):{...s,...e}}),[s,e])}function c(e){let s;return s=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:i(e.components),r.createElement(t.Provider,{value:s},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/86e64757.8612b05d.js b/assets/js/86e64757.51c888a4.js similarity index 92% rename from assets/js/86e64757.8612b05d.js rename to assets/js/86e64757.51c888a4.js index 652c33245d7..623d652e7a2 100644 --- a/assets/js/86e64757.8612b05d.js +++ b/assets/js/86e64757.51c888a4.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[36075],{44491:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>c,contentTitle:()=>i,default:()=>b,frontMatter:()=>r,metadata:()=>o,toc:()=>l});var t=s(24246),a=s(71670);const r={},i="Variable: isTelemetryEnabled",o={id:"namespaces/env/variables/isTelemetryEnabled",title:"Variable: isTelemetryEnabled",description:"const isTelemetryEnabled: boolean",source:"@site/api/namespaces/env/variables/isTelemetryEnabled.md",sourceDirName:"namespaces/env/variables",slug:"/namespaces/env/variables/isTelemetryEnabled",permalink:"/api/namespaces/env/variables/isTelemetryEnabled",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Variable: isMac",permalink:"/api/namespaces/env/variables/isMac"},next:{title:"Variable: isWindows",permalink:"/api/namespaces/env/variables/isWindows"}},c={},l=[{value:"Source",id:"source",level:2}];function d(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,a.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"variable-istelemetryenabled",children:"Variable: isTelemetryEnabled"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:(0,t.jsx)(n.code,{children:"const"})})," ",(0,t.jsx)(n.strong,{children:"isTelemetryEnabled"}),": ",(0,t.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"Indicates whether the users has telemetry enabled.\nCan be observed to determine if the extension should send telemetry."}),"\n",(0,t.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L3689",children:"packages/extension-api/src/extension-api.d.ts:3689"})})]})}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:()=>i});var t=s(27378);const a={},r=t.createContext(a);function i(e){const n=t.useContext(r);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(a):e.components||a:i(e.components),t.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[36075],{44491:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>c,contentTitle:()=>i,default:()=>p,frontMatter:()=>r,metadata:()=>o,toc:()=>l});var t=s(24246),a=s(71670);const r={},i="Variable: isTelemetryEnabled",o={id:"namespaces/env/variables/isTelemetryEnabled",title:"Variable: isTelemetryEnabled",description:"const isTelemetryEnabled: boolean",source:"@site/api/namespaces/env/variables/isTelemetryEnabled.md",sourceDirName:"namespaces/env/variables",slug:"/namespaces/env/variables/isTelemetryEnabled",permalink:"/api/namespaces/env/variables/isTelemetryEnabled",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Variable: isMac",permalink:"/api/namespaces/env/variables/isMac"},next:{title:"Variable: isWindows",permalink:"/api/namespaces/env/variables/isWindows"}},c={},l=[{value:"Source",id:"source",level:2}];function d(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,a.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"variable-istelemetryenabled",children:"Variable: isTelemetryEnabled"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:(0,t.jsx)(n.code,{children:"const"})})," ",(0,t.jsx)(n.strong,{children:"isTelemetryEnabled"}),": ",(0,t.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"Indicates whether the users has telemetry enabled.\nCan be observed to determine if the extension should send telemetry."}),"\n",(0,t.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L3689",children:"packages/extension-api/src/extension-api.d.ts:3689"})})]})}function p(e={}){const{wrapper:n}={...(0,a.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(d,{...e})}):d(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>o,a:()=>i});var t=s(27378);const a={},r=t.createContext(a);function i(e){const n=t.useContext(r);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(a):e.components||a:i(e.components),t.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/86f8c256.3690581c.js b/assets/js/86f8c256.466d0ae2.js similarity index 91% rename from assets/js/86f8c256.3690581c.js rename to assets/js/86f8c256.466d0ae2.js index f89b5f6c259..c6448b4dc66 100644 --- a/assets/js/86f8c256.3690581c.js +++ b/assets/js/86f8c256.466d0ae2.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[29234],{11457:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>o,contentTitle:()=>d,default:()=>a,frontMatter:()=>r,metadata:()=>l,toc:()=>t});var i=s(24246),c=s(71670);const r={},d="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:"Interface: ImageInfo",permalink:"/api/interfaces/ImageInfo"},next:{title:"Interface: InputBoxOptions",permalink:"/api/interfaces/InputBoxOptions"}},o={},t=[{value:"Properties",id:"properties",level:2},{value:"Architecture",id:"architecture",level:3},{value:"Source",id:"source",level:4},{value:"Author",id:"author",level:3},{value:"Source",id:"source-1",level:4},{value:"Comment",id:"comment",level:3},{value:"Source",id:"source-2",level:4},{value:"Config",id:"config",level:3},{value:"ArgsEscaped",id:"argsescaped",level:4},{value:"AttachStderr",id:"attachstderr",level:4},{value:"AttachStdin",id:"attachstdin",level:4},{value:"AttachStdout",id:"attachstdout",level:4},{value:"Cmd",id:"cmd",level:4},{value:"Domainname",id:"domainname",level:4},{value:"Entrypoint?",id:"entrypoint",level:4},{value:"Env",id:"env",level:4},{value:"ExposedPorts",id:"exposedports",level:4},{value:"Index signature",id:"index-signature",level:5},{value:"Hostname",id:"hostname",level:4},{value:"Image",id:"image",level:4},{value:"Labels",id:"labels",level:4},{value:"Index signature",id:"index-signature-1",level:5},{value:"OnBuild",id:"onbuild",level:4},{value:"OpenStdin",id:"openstdin",level:4},{value:"StdinOnce",id:"stdinonce",level:4},{value:"Tty",id:"tty",level:4},{value:"User",id:"user",level:4},{value:"Volumes",id:"volumes",level:4},{value:"Index signature",id:"index-signature-2",level:5},{value:"WorkingDir",id:"workingdir",level:4},{value:"Source",id:"source-3",level:4},{value:"Container",id:"container",level:3},{value:"Source",id:"source-4",level:4},{value:"ContainerConfig",id:"containerconfig",level:3},{value:"ArgsEscaped",id:"argsescaped-1",level:4},{value:"AttachStderr",id:"attachstderr-1",level:4},{value:"AttachStdin",id:"attachstdin-1",level:4},{value:"AttachStdout",id:"attachstdout-1",level:4},{value:"Cmd",id:"cmd-1",level:4},{value:"Domainname",id:"domainname-1",level:4},{value:"Entrypoint?",id:"entrypoint-1",level:4},{value:"Env",id:"env-1",level:4},{value:"ExposedPorts",id:"exposedports-1",level:4},{value:"Index signature",id:"index-signature-3",level:5},{value:"Hostname",id:"hostname-1",level:4},{value:"Image",id:"image-1",level:4},{value:"Labels",id:"labels-1",level:4},{value:"Index signature",id:"index-signature-4",level:5},{value:"OnBuild?",id:"onbuild-1",level:4},{value:"OpenStdin",id:"openstdin-1",level:4},{value:"StdinOnce",id:"stdinonce-1",level:4},{value:"Tty",id:"tty-1",level:4},{value:"User",id:"user-1",level:4},{value:"Volumes",id:"volumes-1",level:4},{value:"Index signature",id:"index-signature-5",level:5},{value:"WorkingDir",id:"workingdir-1",level:4},{value:"Source",id:"source-5",level:4},{value:"Created",id:"created",level:3},{value:"Source",id:"source-6",level:4},{value:"DockerVersion",id:"dockerversion",level:3},{value:"Source",id:"source-7",level:4},{value:"GraphDriver",id:"graphdriver",level:3},{value:"Data",id:"data",level:4},{value:"Data.DeviceId",id:"datadeviceid",level:4},{value:"Data.DeviceName",id:"datadevicename",level:4},{value:"Data.DeviceSize",id:"datadevicesize",level:4},{value:"Name",id:"name",level:4},{value:"Source",id:"source-8",level:4},{value:"Id",id:"id",level:3},{value:"Source",id:"source-9",level:4},{value:"Os",id:"os",level:3},{value:"Source",id:"source-10",level:4},{value:"Parent",id:"parent",level:3},{value:"Source",id:"source-11",level:4},{value:"RepoDigests",id:"repodigests",level:3},{value:"Source",id:"source-12",level:4},{value:"RepoTags",id:"repotags",level:3},{value:"Source",id:"source-13",level:4},{value:"RootFS",id:"rootfs",level:3},{value:"BaseLayer?",id:"baselayer",level:4},{value:"Layers?",id:"layers",level:4},{value:"Type",id:"type",level:4},{value:"Source",id:"source-14",level:4},{value:"Size",id:"size",level:3},{value:"Source",id:"source-15",level:4},{value:"VirtualSize",id:"virtualsize",level:3},{value:"Source",id:"source-16",level:4},{value:"engineId",id:"engineid",level:3},{value:"Source",id:"source-17",level:4},{value:"engineName",id:"enginename",level:3},{value:"Source",id:"source-18",level:4}];function h(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",h5:"h5",hr:"hr",p:"p",strong:"strong",...(0,c.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"interface-imageinspectinfo",children:"Interface: ImageInspectInfo"}),"\n",(0,i.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(n.h3,{id:"architecture",children:"Architecture"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Architecture"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L1930",children:"packages/extension-api/src/extension-api.d.ts:1930"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"author",children:"Author"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Author"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L1908",children:"packages/extension-api/src/extension-api.d.ts:1908"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"comment",children:"Comment"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Comment"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L1883",children:"packages/extension-api/src/extension-api.d.ts:1883"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"config",children:"Config"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Config"}),": ",(0,i.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"argsescaped",children:"ArgsEscaped"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"ArgsEscaped"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"attachstderr",children:"AttachStderr"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"AttachStderr"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"attachstdin",children:"AttachStdin"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"AttachStdin"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"attachstdout",children:"AttachStdout"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"AttachStdout"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"cmd",children:"Cmd"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Cmd"}),": ",(0,i.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"domainname",children:"Domainname"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Domainname"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"entrypoint",children:"Entrypoint?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"Entrypoint"}),": ",(0,i.jsx)(n.code,{children:"string"})," | ",(0,i.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"env",children:"Env"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Env"}),": ",(0,i.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"exposedports",children:"ExposedPorts"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"ExposedPorts"}),": ",(0,i.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsx)(n.h5,{id:"index-signature",children:"Index signature"}),"\n",(0,i.jsxs)(n.p,{children:["[",(0,i.jsx)(n.code,{children:"portAndProtocol"}),": ",(0,i.jsx)(n.code,{children:"string"}),"]: ",(0,i.jsx)(n.code,{children:"unknown"})]}),"\n",(0,i.jsx)(n.h4,{id:"hostname",children:"Hostname"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Hostname"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"image",children:"Image"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Image"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"labels",children:"Labels"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Labels"}),": ",(0,i.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsx)(n.h5,{id:"index-signature-1",children:"Index signature"}),"\n",(0,i.jsxs)(n.p,{children:["[",(0,i.jsx)(n.code,{children:"label"}),": ",(0,i.jsx)(n.code,{children:"string"}),"]: ",(0,i.jsx)(n.code,{children:"string"})]}),"\n",(0,i.jsx)(n.h4,{id:"onbuild",children:"OnBuild"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"OnBuild"}),": ",(0,i.jsx)(n.code,{children:"unknown"}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"openstdin",children:"OpenStdin"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"OpenStdin"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"stdinonce",children:"StdinOnce"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"StdinOnce"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"tty",children:"Tty"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Tty"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"user",children:"User"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"User"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"volumes",children:"Volumes"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Volumes"}),": ",(0,i.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsx)(n.h5,{id:"index-signature-2",children:"Index signature"}),"\n",(0,i.jsxs)(n.p,{children:["[",(0,i.jsx)(n.code,{children:"path"}),": ",(0,i.jsx)(n.code,{children:"string"}),"]: ",(0,i.jsx)(n.code,{children:"unknown"})]}),"\n",(0,i.jsx)(n.h4,{id:"workingdir",children:"WorkingDir"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"WorkingDir"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L1909",children:"packages/extension-api/src/extension-api.d.ts:1909"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"container",children:"Container"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Container"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-4",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L1885",children:"packages/extension-api/src/extension-api.d.ts:1885"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"containerconfig",children:"ContainerConfig"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"ContainerConfig"}),": ",(0,i.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"argsescaped-1",children:"ArgsEscaped"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"ArgsEscaped"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"attachstderr-1",children:"AttachStderr"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"AttachStderr"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"attachstdin-1",children:"AttachStdin"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"AttachStdin"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"attachstdout-1",children:"AttachStdout"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"AttachStdout"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"cmd-1",children:"Cmd"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Cmd"}),": ",(0,i.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"domainname-1",children:"Domainname"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Domainname"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"entrypoint-1",children:"Entrypoint?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"Entrypoint"}),": ",(0,i.jsx)(n.code,{children:"string"})," | ",(0,i.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"env-1",children:"Env"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Env"}),": ",(0,i.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"exposedports-1",children:"ExposedPorts"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"ExposedPorts"}),": ",(0,i.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsx)(n.h5,{id:"index-signature-3",children:"Index signature"}),"\n",(0,i.jsxs)(n.p,{children:["[",(0,i.jsx)(n.code,{children:"portAndProtocol"}),": ",(0,i.jsx)(n.code,{children:"string"}),"]: ",(0,i.jsx)(n.code,{children:"unknown"})]}),"\n",(0,i.jsx)(n.h4,{id:"hostname-1",children:"Hostname"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Hostname"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"image-1",children:"Image"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Image"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"labels-1",children:"Labels"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Labels"}),": ",(0,i.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsx)(n.h5,{id:"index-signature-4",children:"Index signature"}),"\n",(0,i.jsxs)(n.p,{children:["[",(0,i.jsx)(n.code,{children:"label"}),": ",(0,i.jsx)(n.code,{children:"string"}),"]: ",(0,i.jsx)(n.code,{children:"string"})]}),"\n",(0,i.jsx)(n.h4,{id:"onbuild-1",children:"OnBuild?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"OnBuild"}),": ",(0,i.jsx)(n.code,{children:"unknown"}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"openstdin-1",children:"OpenStdin"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"OpenStdin"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"stdinonce-1",children:"StdinOnce"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"StdinOnce"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"tty-1",children:"Tty"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Tty"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"user-1",children:"User"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"User"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"volumes-1",children:"Volumes"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Volumes"}),": ",(0,i.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsx)(n.h5,{id:"index-signature-5",children:"Index signature"}),"\n",(0,i.jsxs)(n.p,{children:["[",(0,i.jsx)(n.code,{children:"path"}),": ",(0,i.jsx)(n.code,{children:"string"}),"]: ",(0,i.jsx)(n.code,{children:"unknown"})]}),"\n",(0,i.jsx)(n.h4,{id:"workingdir-1",children:"WorkingDir"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"WorkingDir"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-5",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L1886",children:"packages/extension-api/src/extension-api.d.ts:1886"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"created",children:"Created"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Created"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-6",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L1884",children:"packages/extension-api/src/extension-api.d.ts:1884"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"dockerversion",children:"DockerVersion"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"DockerVersion"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-7",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L1907",children:"packages/extension-api/src/extension-api.d.ts:1907"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"graphdriver",children:"GraphDriver"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"GraphDriver"}),": ",(0,i.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"data",children:"Data"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Data"}),": ",(0,i.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"datadeviceid",children:"Data.DeviceId"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"DeviceId"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"datadevicename",children:"Data.DeviceName"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"DeviceName"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"datadevicesize",children:"Data.DeviceSize"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"DeviceSize"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"name",children:"Name"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Name"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-8",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L1934",children:"packages/extension-api/src/extension-api.d.ts:1934"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"id",children:"Id"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Id"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-9",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L1879",children:"packages/extension-api/src/extension-api.d.ts:1879"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"os",children:"Os"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Os"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-10",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L1931",children:"packages/extension-api/src/extension-api.d.ts:1931"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"parent",children:"Parent"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Parent"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-11",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L1882",children:"packages/extension-api/src/extension-api.d.ts:1882"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"repodigests",children:"RepoDigests"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"RepoDigests"}),": ",(0,i.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-12",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L1881",children:"packages/extension-api/src/extension-api.d.ts:1881"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"repotags",children:"RepoTags"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"RepoTags"}),": ",(0,i.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-13",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L1880",children:"packages/extension-api/src/extension-api.d.ts:1880"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"rootfs",children:"RootFS"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"RootFS"}),": ",(0,i.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"baselayer",children:"BaseLayer?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"BaseLayer"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"layers",children:"Layers?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"Layers"}),": ",(0,i.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"type",children:"Type"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Type"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-14",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L1942",children:"packages/extension-api/src/extension-api.d.ts:1942"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"size",children:"Size"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Size"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-15",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L1932",children:"packages/extension-api/src/extension-api.d.ts:1932"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"virtualsize",children:"VirtualSize"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"VirtualSize"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-16",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L1933",children:"packages/extension-api/src/extension-api.d.ts:1933"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"engineid",children:"engineId"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"engineId"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-17",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L1877",children:"packages/extension-api/src/extension-api.d.ts:1877"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"enginename",children:"engineName"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"engineName"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-18",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L1878",children:"packages/extension-api/src/extension-api.d.ts:1878"})})]})}function a(e={}){const{wrapper:n}={...(0,c.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(h,{...e})}):h(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>l,a:()=>d});var i=s(27378);const c={},r=i.createContext(c);function d(e){const n=i.useContext(r);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function l(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(c):e.components||c:d(e.components),i.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[29234],{11457:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>o,contentTitle:()=>r,default:()=>a,frontMatter:()=>c,metadata:()=>l,toc:()=>t});var i=s(24246),d=s(71670);const c={},r="Interface: ImageInspectInfo",l={id:"interfaces/ImageInspectInfo",title:"Interface: ImageInspectInfo",description:"Properties",source:"@site/api/interfaces/ImageInspectInfo.md",sourceDirName:"interfaces",slug:"/interfaces/ImageInspectInfo",permalink:"/api/interfaces/ImageInspectInfo",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: ImageInfo",permalink:"/api/interfaces/ImageInfo"},next:{title:"Interface: InputBoxOptions",permalink:"/api/interfaces/InputBoxOptions"}},o={},t=[{value:"Properties",id:"properties",level:2},{value:"Architecture",id:"architecture",level:3},{value:"Source",id:"source",level:4},{value:"Author",id:"author",level:3},{value:"Source",id:"source-1",level:4},{value:"Comment",id:"comment",level:3},{value:"Source",id:"source-2",level:4},{value:"Config",id:"config",level:3},{value:"ArgsEscaped",id:"argsescaped",level:4},{value:"AttachStderr",id:"attachstderr",level:4},{value:"AttachStdin",id:"attachstdin",level:4},{value:"AttachStdout",id:"attachstdout",level:4},{value:"Cmd",id:"cmd",level:4},{value:"Domainname",id:"domainname",level:4},{value:"Entrypoint?",id:"entrypoint",level:4},{value:"Env",id:"env",level:4},{value:"ExposedPorts",id:"exposedports",level:4},{value:"Index signature",id:"index-signature",level:5},{value:"Hostname",id:"hostname",level:4},{value:"Image",id:"image",level:4},{value:"Labels",id:"labels",level:4},{value:"Index signature",id:"index-signature-1",level:5},{value:"OnBuild",id:"onbuild",level:4},{value:"OpenStdin",id:"openstdin",level:4},{value:"StdinOnce",id:"stdinonce",level:4},{value:"Tty",id:"tty",level:4},{value:"User",id:"user",level:4},{value:"Volumes",id:"volumes",level:4},{value:"Index signature",id:"index-signature-2",level:5},{value:"WorkingDir",id:"workingdir",level:4},{value:"Source",id:"source-3",level:4},{value:"Container",id:"container",level:3},{value:"Source",id:"source-4",level:4},{value:"ContainerConfig",id:"containerconfig",level:3},{value:"ArgsEscaped",id:"argsescaped-1",level:4},{value:"AttachStderr",id:"attachstderr-1",level:4},{value:"AttachStdin",id:"attachstdin-1",level:4},{value:"AttachStdout",id:"attachstdout-1",level:4},{value:"Cmd",id:"cmd-1",level:4},{value:"Domainname",id:"domainname-1",level:4},{value:"Entrypoint?",id:"entrypoint-1",level:4},{value:"Env",id:"env-1",level:4},{value:"ExposedPorts",id:"exposedports-1",level:4},{value:"Index signature",id:"index-signature-3",level:5},{value:"Hostname",id:"hostname-1",level:4},{value:"Image",id:"image-1",level:4},{value:"Labels",id:"labels-1",level:4},{value:"Index signature",id:"index-signature-4",level:5},{value:"OnBuild?",id:"onbuild-1",level:4},{value:"OpenStdin",id:"openstdin-1",level:4},{value:"StdinOnce",id:"stdinonce-1",level:4},{value:"Tty",id:"tty-1",level:4},{value:"User",id:"user-1",level:4},{value:"Volumes",id:"volumes-1",level:4},{value:"Index signature",id:"index-signature-5",level:5},{value:"WorkingDir",id:"workingdir-1",level:4},{value:"Source",id:"source-5",level:4},{value:"Created",id:"created",level:3},{value:"Source",id:"source-6",level:4},{value:"DockerVersion",id:"dockerversion",level:3},{value:"Source",id:"source-7",level:4},{value:"GraphDriver",id:"graphdriver",level:3},{value:"Data",id:"data",level:4},{value:"Data.DeviceId",id:"datadeviceid",level:4},{value:"Data.DeviceName",id:"datadevicename",level:4},{value:"Data.DeviceSize",id:"datadevicesize",level:4},{value:"Name",id:"name",level:4},{value:"Source",id:"source-8",level:4},{value:"Id",id:"id",level:3},{value:"Source",id:"source-9",level:4},{value:"Os",id:"os",level:3},{value:"Source",id:"source-10",level:4},{value:"Parent",id:"parent",level:3},{value:"Source",id:"source-11",level:4},{value:"RepoDigests",id:"repodigests",level:3},{value:"Source",id:"source-12",level:4},{value:"RepoTags",id:"repotags",level:3},{value:"Source",id:"source-13",level:4},{value:"RootFS",id:"rootfs",level:3},{value:"BaseLayer?",id:"baselayer",level:4},{value:"Layers?",id:"layers",level:4},{value:"Type",id:"type",level:4},{value:"Source",id:"source-14",level:4},{value:"Size",id:"size",level:3},{value:"Source",id:"source-15",level:4},{value:"VirtualSize",id:"virtualsize",level:3},{value:"Source",id:"source-16",level:4},{value:"engineId",id:"engineid",level:3},{value:"Source",id:"source-17",level:4},{value:"engineName",id:"enginename",level:3},{value:"Source",id:"source-18",level:4}];function h(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",h5:"h5",hr:"hr",p:"p",strong:"strong",...(0,d.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"interface-imageinspectinfo",children:"Interface: ImageInspectInfo"}),"\n",(0,i.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(n.h3,{id:"architecture",children:"Architecture"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Architecture"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L1930",children:"packages/extension-api/src/extension-api.d.ts:1930"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"author",children:"Author"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Author"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L1908",children:"packages/extension-api/src/extension-api.d.ts:1908"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"comment",children:"Comment"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Comment"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L1883",children:"packages/extension-api/src/extension-api.d.ts:1883"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"config",children:"Config"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Config"}),": ",(0,i.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"argsescaped",children:"ArgsEscaped"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"ArgsEscaped"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"attachstderr",children:"AttachStderr"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"AttachStderr"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"attachstdin",children:"AttachStdin"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"AttachStdin"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"attachstdout",children:"AttachStdout"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"AttachStdout"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"cmd",children:"Cmd"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Cmd"}),": ",(0,i.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"domainname",children:"Domainname"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Domainname"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"entrypoint",children:"Entrypoint?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"Entrypoint"}),": ",(0,i.jsx)(n.code,{children:"string"})," | ",(0,i.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"env",children:"Env"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Env"}),": ",(0,i.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"exposedports",children:"ExposedPorts"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"ExposedPorts"}),": ",(0,i.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsx)(n.h5,{id:"index-signature",children:"Index signature"}),"\n",(0,i.jsxs)(n.p,{children:["[",(0,i.jsx)(n.code,{children:"portAndProtocol"}),": ",(0,i.jsx)(n.code,{children:"string"}),"]: ",(0,i.jsx)(n.code,{children:"unknown"})]}),"\n",(0,i.jsx)(n.h4,{id:"hostname",children:"Hostname"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Hostname"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"image",children:"Image"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Image"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"labels",children:"Labels"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Labels"}),": ",(0,i.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsx)(n.h5,{id:"index-signature-1",children:"Index signature"}),"\n",(0,i.jsxs)(n.p,{children:["[",(0,i.jsx)(n.code,{children:"label"}),": ",(0,i.jsx)(n.code,{children:"string"}),"]: ",(0,i.jsx)(n.code,{children:"string"})]}),"\n",(0,i.jsx)(n.h4,{id:"onbuild",children:"OnBuild"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"OnBuild"}),": ",(0,i.jsx)(n.code,{children:"unknown"}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"openstdin",children:"OpenStdin"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"OpenStdin"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"stdinonce",children:"StdinOnce"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"StdinOnce"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"tty",children:"Tty"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Tty"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"user",children:"User"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"User"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"volumes",children:"Volumes"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Volumes"}),": ",(0,i.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsx)(n.h5,{id:"index-signature-2",children:"Index signature"}),"\n",(0,i.jsxs)(n.p,{children:["[",(0,i.jsx)(n.code,{children:"path"}),": ",(0,i.jsx)(n.code,{children:"string"}),"]: ",(0,i.jsx)(n.code,{children:"unknown"})]}),"\n",(0,i.jsx)(n.h4,{id:"workingdir",children:"WorkingDir"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"WorkingDir"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L1909",children:"packages/extension-api/src/extension-api.d.ts:1909"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"container",children:"Container"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Container"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-4",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L1885",children:"packages/extension-api/src/extension-api.d.ts:1885"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"containerconfig",children:"ContainerConfig"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"ContainerConfig"}),": ",(0,i.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"argsescaped-1",children:"ArgsEscaped"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"ArgsEscaped"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"attachstderr-1",children:"AttachStderr"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"AttachStderr"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"attachstdin-1",children:"AttachStdin"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"AttachStdin"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"attachstdout-1",children:"AttachStdout"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"AttachStdout"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"cmd-1",children:"Cmd"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Cmd"}),": ",(0,i.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"domainname-1",children:"Domainname"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Domainname"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"entrypoint-1",children:"Entrypoint?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"Entrypoint"}),": ",(0,i.jsx)(n.code,{children:"string"})," | ",(0,i.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"env-1",children:"Env"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Env"}),": ",(0,i.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"exposedports-1",children:"ExposedPorts"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"ExposedPorts"}),": ",(0,i.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsx)(n.h5,{id:"index-signature-3",children:"Index signature"}),"\n",(0,i.jsxs)(n.p,{children:["[",(0,i.jsx)(n.code,{children:"portAndProtocol"}),": ",(0,i.jsx)(n.code,{children:"string"}),"]: ",(0,i.jsx)(n.code,{children:"unknown"})]}),"\n",(0,i.jsx)(n.h4,{id:"hostname-1",children:"Hostname"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Hostname"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"image-1",children:"Image"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Image"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"labels-1",children:"Labels"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Labels"}),": ",(0,i.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsx)(n.h5,{id:"index-signature-4",children:"Index signature"}),"\n",(0,i.jsxs)(n.p,{children:["[",(0,i.jsx)(n.code,{children:"label"}),": ",(0,i.jsx)(n.code,{children:"string"}),"]: ",(0,i.jsx)(n.code,{children:"string"})]}),"\n",(0,i.jsx)(n.h4,{id:"onbuild-1",children:"OnBuild?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"OnBuild"}),": ",(0,i.jsx)(n.code,{children:"unknown"}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"openstdin-1",children:"OpenStdin"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"OpenStdin"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"stdinonce-1",children:"StdinOnce"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"StdinOnce"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"tty-1",children:"Tty"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Tty"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"user-1",children:"User"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"User"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"volumes-1",children:"Volumes"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Volumes"}),": ",(0,i.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsx)(n.h5,{id:"index-signature-5",children:"Index signature"}),"\n",(0,i.jsxs)(n.p,{children:["[",(0,i.jsx)(n.code,{children:"path"}),": ",(0,i.jsx)(n.code,{children:"string"}),"]: ",(0,i.jsx)(n.code,{children:"unknown"})]}),"\n",(0,i.jsx)(n.h4,{id:"workingdir-1",children:"WorkingDir"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"WorkingDir"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-5",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L1886",children:"packages/extension-api/src/extension-api.d.ts:1886"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"created",children:"Created"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Created"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-6",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L1884",children:"packages/extension-api/src/extension-api.d.ts:1884"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"dockerversion",children:"DockerVersion"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"DockerVersion"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-7",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L1907",children:"packages/extension-api/src/extension-api.d.ts:1907"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"graphdriver",children:"GraphDriver"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"GraphDriver"}),": ",(0,i.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"data",children:"Data"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Data"}),": ",(0,i.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"datadeviceid",children:"Data.DeviceId"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"DeviceId"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"datadevicename",children:"Data.DeviceName"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"DeviceName"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"datadevicesize",children:"Data.DeviceSize"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"DeviceSize"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"name",children:"Name"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Name"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-8",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L1934",children:"packages/extension-api/src/extension-api.d.ts:1934"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"id",children:"Id"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Id"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-9",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L1879",children:"packages/extension-api/src/extension-api.d.ts:1879"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"os",children:"Os"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Os"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-10",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L1931",children:"packages/extension-api/src/extension-api.d.ts:1931"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"parent",children:"Parent"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Parent"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-11",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L1882",children:"packages/extension-api/src/extension-api.d.ts:1882"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"repodigests",children:"RepoDigests"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"RepoDigests"}),": ",(0,i.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-12",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L1881",children:"packages/extension-api/src/extension-api.d.ts:1881"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"repotags",children:"RepoTags"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"RepoTags"}),": ",(0,i.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-13",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L1880",children:"packages/extension-api/src/extension-api.d.ts:1880"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"rootfs",children:"RootFS"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"RootFS"}),": ",(0,i.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"baselayer",children:"BaseLayer?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"BaseLayer"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"layers",children:"Layers?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"Layers"}),": ",(0,i.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"type",children:"Type"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Type"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-14",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L1942",children:"packages/extension-api/src/extension-api.d.ts:1942"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"size",children:"Size"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Size"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-15",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L1932",children:"packages/extension-api/src/extension-api.d.ts:1932"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"virtualsize",children:"VirtualSize"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"VirtualSize"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-16",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L1933",children:"packages/extension-api/src/extension-api.d.ts:1933"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"engineid",children:"engineId"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"engineId"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-17",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L1877",children:"packages/extension-api/src/extension-api.d.ts:1877"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"enginename",children:"engineName"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"engineName"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-18",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L1878",children:"packages/extension-api/src/extension-api.d.ts:1878"})})]})}function a(e={}){const{wrapper:n}={...(0,d.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(h,{...e})}):h(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>l,a:()=>r});var i=s(27378);const d={},c=i.createContext(d);function r(e){const n=i.useContext(c);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function l(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(d):e.components||d:r(e.components),i.createElement(c.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/871ce139.6ae88921.js b/assets/js/871ce139.91af4629.js similarity index 83% rename from assets/js/871ce139.6ae88921.js rename to assets/js/871ce139.91af4629.js index 659c0cef9ca..0c211becb06 100644 --- a/assets/js/871ce139.6ae88921.js +++ b/assets/js/871ce139.91af4629.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[91893],{54790:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>c,contentTitle:()=>i,default:()=>d,frontMatter:()=>s,metadata:()=>a,toc:()=>p});var r=n(24246),o=n(71670);const s={},i="Interface: NetworkCreateOptions",a={id:"interfaces/NetworkCreateOptions",title:"Interface: NetworkCreateOptions",description:"Properties",source:"@site/api/interfaces/NetworkCreateOptions.md",sourceDirName:"interfaces",slug:"/interfaces/NetworkCreateOptions",permalink:"/api/interfaces/NetworkCreateOptions",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: NetworkContainer",permalink:"/api/interfaces/NetworkContainer"},next:{title:"Interface: NetworkCreateResult",permalink:"/api/interfaces/NetworkCreateResult"}},c={},p=[{value:"Properties",id:"properties",level:2},{value:"Name",id:"name",level:3},{value:"Source",id:"source",level:4}];function l(e){const t={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",p:"p",strong:"strong",...(0,o.a)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(t.h1,{id:"interface-networkcreateoptions",children:"Interface: NetworkCreateOptions"}),"\n",(0,r.jsx)(t.h2,{id:"properties",children:"Properties"}),"\n",(0,r.jsx)(t.h3,{id:"name",children:"Name"}),"\n",(0,r.jsxs)(t.blockquote,{children:["\n",(0,r.jsxs)(t.p,{children:[(0,r.jsx)(t.strong,{children:"Name"}),": ",(0,r.jsx)(t.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(t.h4,{id:"source",children:"Source"}),"\n",(0,r.jsx)(t.p,{children:(0,r.jsx)(t.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L3046",children:"packages/extension-api/src/extension-api.d.ts:3046"})})]})}function d(e={}){const{wrapper:t}={...(0,o.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:()=>i});var r=n(27378);const o={},s=r.createContext(o);function i(e){const t=r.useContext(s);return r.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function a(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:i(e.components),r.createElement(s.Provider,{value:t},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[91893],{54790:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>c,contentTitle:()=>i,default:()=>l,frontMatter:()=>s,metadata:()=>a,toc:()=>p});var r=n(24246),o=n(71670);const s={},i="Interface: NetworkCreateOptions",a={id:"interfaces/NetworkCreateOptions",title:"Interface: NetworkCreateOptions",description:"Properties",source:"@site/api/interfaces/NetworkCreateOptions.md",sourceDirName:"interfaces",slug:"/interfaces/NetworkCreateOptions",permalink:"/api/interfaces/NetworkCreateOptions",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: NetworkContainer",permalink:"/api/interfaces/NetworkContainer"},next:{title:"Interface: NetworkCreateResult",permalink:"/api/interfaces/NetworkCreateResult"}},c={},p=[{value:"Properties",id:"properties",level:2},{value:"Name",id:"name",level:3},{value:"Source",id:"source",level:4}];function d(e){const t={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",p:"p",strong:"strong",...(0,o.a)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(t.h1,{id:"interface-networkcreateoptions",children:"Interface: NetworkCreateOptions"}),"\n",(0,r.jsx)(t.h2,{id:"properties",children:"Properties"}),"\n",(0,r.jsx)(t.h3,{id:"name",children:"Name"}),"\n",(0,r.jsxs)(t.blockquote,{children:["\n",(0,r.jsxs)(t.p,{children:[(0,r.jsx)(t.strong,{children:"Name"}),": ",(0,r.jsx)(t.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(t.h4,{id:"source",children:"Source"}),"\n",(0,r.jsx)(t.p,{children:(0,r.jsx)(t.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L3046",children:"packages/extension-api/src/extension-api.d.ts:3046"})})]})}function l(e={}){const{wrapper:t}={...(0,o.a)(),...e.components};return t?(0,r.jsx)(t,{...e,children:(0,r.jsx)(d,{...e})}):d(e)}},71670:(e,t,n)=>{n.d(t,{Z:()=>a,a:()=>i});var r=n(27378);const o={},s=r.createContext(o);function i(e){const t=r.useContext(s);return r.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function a(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:i(e.components),r.createElement(s.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/874690d0.c4989b3b.js b/assets/js/874690d0.087af6c1.js similarity index 87% rename from assets/js/874690d0.c4989b3b.js rename to assets/js/874690d0.087af6c1.js index 4779ed8bf13..0435c8cf7be 100644 --- a/assets/js/874690d0.c4989b3b.js +++ b/assets/js/874690d0.087af6c1.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[58216],{45652:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>a,contentTitle:()=>c,default:()=>h,frontMatter:()=>r,metadata:()=>o,toc:()=>d});var i=s(24246),t=s(71670);const r={},c="Interface: StatusBarItem",o={id:"interfaces/StatusBarItem",title:"Interface: StatusBarItem",description:"A status bar item is a status bar contribution that can",source:"@site/api/interfaces/StatusBarItem.md",sourceDirName:"interfaces",slug:"/interfaces/StatusBarItem",permalink:"/api/interfaces/StatusBarItem",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: SecretStorageChangeEvent",permalink:"/api/interfaces/SecretStorageChangeEvent"},next:{title:"Interface: StorageStats",permalink:"/api/interfaces/StorageStats"}},a={},d=[{value:"Properties",id:"properties",level:2},{value:"alignment",id:"alignment",level:3},{value:"Source",id:"source",level:4},{value:"command?",id:"command",level:3},{value:"Source",id:"source-1",level:4},{value:"commandArgs?",id:"commandargs",level:3},{value:"Source",id:"source-2",level:4},{value:"enabled",id:"enabled",level:3},{value:"Source",id:"source-3",level:4},{value:"iconClass?",id:"iconclass",level:3},{value:"Source",id:"source-4",level:4},{value:"priority",id:"priority",level:3},{value:"Source",id:"source-5",level:4},{value:"text?",id:"text",level:3},{value:"Source",id:"source-6",level:4},{value:"tooltip?",id:"tooltip",level:3},{value:"Source",id:"source-7",level:4},{value:"Methods",id:"methods",level:2},{value:"dispose()",id:"dispose",level:3},{value:"Returns",id:"returns",level:4},{value:"Source",id:"source-8",level:4},{value:"hide()",id:"hide",level:3},{value:"Returns",id:"returns-1",level:4},{value:"Source",id:"source-9",level:4},{value:"show()",id:"show",level:3},{value:"Returns",id:"returns-2",level:4},{value:"Source",id:"source-10",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,t.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"interface-statusbaritem",children:"Interface: StatusBarItem"}),"\n",(0,i.jsx)(n.p,{children:"A status bar item is a status bar contribution that can\nshow text and icons and run a command on click."}),"\n",(0,i.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(n.h3,{id:"alignment",children:"alignment"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"readonly"})})," ",(0,i.jsx)(n.strong,{children:"alignment"}),": ",(0,i.jsx)(n.a,{href:"/api/type-aliases/StatusBarAlignment",children:(0,i.jsx)(n.code,{children:"StatusBarAlignment"})})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"The alignment of this item."}),"\n",(0,i.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L1205",children:"packages/extension-api/src/extension-api.d.ts:1205"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"command",children:"command?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"command"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["The identifier of a command, previously registered with ",(0,i.jsx)(n.a,{href:"/api/namespaces/commands/functions/registerCommand",children:"commands.registerCommand"}),", to run on click."]}),"\n",(0,i.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L1233",children:"packages/extension-api/src/extension-api.d.ts:1233"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"commandargs",children:"commandArgs?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"commandArgs"}),": ",(0,i.jsx)(n.code,{children:"any"}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Arguments that the command handler should be invoked with."}),"\n",(0,i.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L1238",children:"packages/extension-api/src/extension-api.d.ts:1238"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"enabled",children:"enabled"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"enabled"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Marks an item as disabled. When property is set to true, then icon will be changed to inactive\nand there won't be possible to execute a command if it is provided in the following configuration."}),"\n",(0,i.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L1229",children:"packages/extension-api/src/extension-api.d.ts:1229"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"iconclass",children:"iconClass?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"iconClass"}),": ",(0,i.jsx)(n.code,{children:"string"})," | ",(0,i.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Icon class that is used to display the particular icon from the Font Awesome icon set.\nIcon class should be in format e.g. 'fa fa-toggle-on'. It is possible to provide an icons\nfor state which can be enabled or disabled."}),"\n",(0,i.jsx)(n.h4,{id:"source-4",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L1224",children:"packages/extension-api/src/extension-api.d.ts:1224"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"priority",children:"priority"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"readonly"})})," ",(0,i.jsx)(n.strong,{children:"priority"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"The priority of this item. Higher value means the item should be shown more to the left\nor more to the right."}),"\n",(0,i.jsx)(n.h4,{id:"source-5",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L1210",children:"packages/extension-api/src/extension-api.d.ts:1210"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"text",children:"text?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"text"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"The text to show for the entry."}),"\n",(0,i.jsx)(n.h4,{id:"source-6",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L1214",children:"packages/extension-api/src/extension-api.d.ts:1214"})}),"\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.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"tooltip"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"The tooltip text when you hover over this entry."}),"\n",(0,i.jsx)(n.h4,{id:"source-7",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L1218",children:"packages/extension-api/src/extension-api.d.ts:1218"})}),"\n",(0,i.jsx)(n.h2,{id:"methods",children:"Methods"}),"\n",(0,i.jsx)(n.h3,{id:"dispose",children:"dispose()"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"dispose"}),"(): ",(0,i.jsx)(n.code,{children:"void"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Dispose and free associated resources. Call\n",(0,i.jsx)(n.a,{href:"/api/interfaces/StatusBarItem#hide",children:"StatusBarItem.hide"}),"."]}),"\n",(0,i.jsx)(n.h4,{id:"returns",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"void"})}),"\n",(0,i.jsx)(n.h4,{id:"source-8",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L1252",children:"packages/extension-api/src/extension-api.d.ts:1252"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"hide",children:"hide()"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"hide"}),"(): ",(0,i.jsx)(n.code,{children:"void"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Hides the entry in the status bar."}),"\n",(0,i.jsx)(n.h4,{id:"returns-1",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"void"})}),"\n",(0,i.jsx)(n.h4,{id:"source-9",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L1246",children:"packages/extension-api/src/extension-api.d.ts:1246"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"show",children:"show()"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"show"}),"(): ",(0,i.jsx)(n.code,{children:"void"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Shows the entry in the status bar."}),"\n",(0,i.jsx)(n.h4,{id:"returns-2",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"void"})}),"\n",(0,i.jsx)(n.h4,{id:"source-10",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L1242",children:"packages/extension-api/src/extension-api.d.ts:1242"})})]})}function h(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>o,a:()=>c});var i=s(27378);const t={},r=i.createContext(t);function c(e){const n=i.useContext(r);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:c(e.components),i.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[58216],{45652:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>d,contentTitle:()=>c,default:()=>h,frontMatter:()=>r,metadata:()=>o,toc:()=>a});var i=s(24246),t=s(71670);const r={},c="Interface: StatusBarItem",o={id:"interfaces/StatusBarItem",title:"Interface: StatusBarItem",description:"A status bar item is a status bar contribution that can",source:"@site/api/interfaces/StatusBarItem.md",sourceDirName:"interfaces",slug:"/interfaces/StatusBarItem",permalink:"/api/interfaces/StatusBarItem",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: SecretStorageChangeEvent",permalink:"/api/interfaces/SecretStorageChangeEvent"},next:{title:"Interface: StorageStats",permalink:"/api/interfaces/StorageStats"}},d={},a=[{value:"Properties",id:"properties",level:2},{value:"alignment",id:"alignment",level:3},{value:"Source",id:"source",level:4},{value:"command?",id:"command",level:3},{value:"Source",id:"source-1",level:4},{value:"commandArgs?",id:"commandargs",level:3},{value:"Source",id:"source-2",level:4},{value:"enabled",id:"enabled",level:3},{value:"Source",id:"source-3",level:4},{value:"iconClass?",id:"iconclass",level:3},{value:"Source",id:"source-4",level:4},{value:"priority",id:"priority",level:3},{value:"Source",id:"source-5",level:4},{value:"text?",id:"text",level:3},{value:"Source",id:"source-6",level:4},{value:"tooltip?",id:"tooltip",level:3},{value:"Source",id:"source-7",level:4},{value:"Methods",id:"methods",level:2},{value:"dispose()",id:"dispose",level:3},{value:"Returns",id:"returns",level:4},{value:"Source",id:"source-8",level:4},{value:"hide()",id:"hide",level:3},{value:"Returns",id:"returns-1",level:4},{value:"Source",id:"source-9",level:4},{value:"show()",id:"show",level:3},{value:"Returns",id:"returns-2",level:4},{value:"Source",id:"source-10",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,t.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"interface-statusbaritem",children:"Interface: StatusBarItem"}),"\n",(0,i.jsx)(n.p,{children:"A status bar item is a status bar contribution that can\nshow text and icons and run a command on click."}),"\n",(0,i.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(n.h3,{id:"alignment",children:"alignment"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"readonly"})})," ",(0,i.jsx)(n.strong,{children:"alignment"}),": ",(0,i.jsx)(n.a,{href:"/api/type-aliases/StatusBarAlignment",children:(0,i.jsx)(n.code,{children:"StatusBarAlignment"})})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"The alignment of this item."}),"\n",(0,i.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L1205",children:"packages/extension-api/src/extension-api.d.ts:1205"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"command",children:"command?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"command"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["The identifier of a command, previously registered with ",(0,i.jsx)(n.a,{href:"/api/namespaces/commands/functions/registerCommand",children:"commands.registerCommand"}),", to run on click."]}),"\n",(0,i.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L1233",children:"packages/extension-api/src/extension-api.d.ts:1233"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"commandargs",children:"commandArgs?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"commandArgs"}),": ",(0,i.jsx)(n.code,{children:"any"}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Arguments that the command handler should be invoked with."}),"\n",(0,i.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L1238",children:"packages/extension-api/src/extension-api.d.ts:1238"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"enabled",children:"enabled"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"enabled"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Marks an item as disabled. When property is set to true, then icon will be changed to inactive\nand there won't be possible to execute a command if it is provided in the following configuration."}),"\n",(0,i.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L1229",children:"packages/extension-api/src/extension-api.d.ts:1229"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"iconclass",children:"iconClass?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"iconClass"}),": ",(0,i.jsx)(n.code,{children:"string"})," | ",(0,i.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Icon class that is used to display the particular icon from the Font Awesome icon set.\nIcon class should be in format e.g. 'fa fa-toggle-on'. It is possible to provide an icons\nfor state which can be enabled or disabled."}),"\n",(0,i.jsx)(n.h4,{id:"source-4",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L1224",children:"packages/extension-api/src/extension-api.d.ts:1224"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"priority",children:"priority"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"readonly"})})," ",(0,i.jsx)(n.strong,{children:"priority"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"The priority of this item. Higher value means the item should be shown more to the left\nor more to the right."}),"\n",(0,i.jsx)(n.h4,{id:"source-5",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L1210",children:"packages/extension-api/src/extension-api.d.ts:1210"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"text",children:"text?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"text"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"The text to show for the entry."}),"\n",(0,i.jsx)(n.h4,{id:"source-6",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L1214",children:"packages/extension-api/src/extension-api.d.ts:1214"})}),"\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.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"tooltip"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"The tooltip text when you hover over this entry."}),"\n",(0,i.jsx)(n.h4,{id:"source-7",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L1218",children:"packages/extension-api/src/extension-api.d.ts:1218"})}),"\n",(0,i.jsx)(n.h2,{id:"methods",children:"Methods"}),"\n",(0,i.jsx)(n.h3,{id:"dispose",children:"dispose()"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"dispose"}),"(): ",(0,i.jsx)(n.code,{children:"void"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Dispose and free associated resources. Call\n",(0,i.jsx)(n.a,{href:"/api/interfaces/StatusBarItem#hide",children:"StatusBarItem.hide"}),"."]}),"\n",(0,i.jsx)(n.h4,{id:"returns",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"void"})}),"\n",(0,i.jsx)(n.h4,{id:"source-8",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L1252",children:"packages/extension-api/src/extension-api.d.ts:1252"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"hide",children:"hide()"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"hide"}),"(): ",(0,i.jsx)(n.code,{children:"void"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Hides the entry in the status bar."}),"\n",(0,i.jsx)(n.h4,{id:"returns-1",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"void"})}),"\n",(0,i.jsx)(n.h4,{id:"source-9",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L1246",children:"packages/extension-api/src/extension-api.d.ts:1246"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"show",children:"show()"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"show"}),"(): ",(0,i.jsx)(n.code,{children:"void"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Shows the entry in the status bar."}),"\n",(0,i.jsx)(n.h4,{id:"returns-2",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"void"})}),"\n",(0,i.jsx)(n.h4,{id:"source-10",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L1242",children:"packages/extension-api/src/extension-api.d.ts:1242"})})]})}function h(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>o,a:()=>c});var i=s(27378);const t={},r=i.createContext(t);function c(e){const n=i.useContext(r);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:c(e.components),i.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/8785b74d.1940120b.js b/assets/js/8785b74d.7bda79f2.js similarity index 89% rename from assets/js/8785b74d.1940120b.js rename to assets/js/8785b74d.7bda79f2.js index 4b54a59ab08..f25da8ef45d 100644 --- a/assets/js/8785b74d.1940120b.js +++ b/assets/js/8785b74d.7bda79f2.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[83672],{43791:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>l,contentTitle:()=>o,default:()=>h,frontMatter:()=>i,metadata:()=>c,toc:()=>d});var s=r(24246),t=r(71670);const i={},o="Interface: TelemetryLogger",c={id:"interfaces/TelemetryLogger",title:"Interface: TelemetryLogger",description:"A telemetry logger which can be used by extensions to log usage and error telementry.",source:"@site/api/interfaces/TelemetryLogger.md",sourceDirName:"interfaces",slug:"/interfaces/TelemetryLogger",permalink:"/api/interfaces/TelemetryLogger",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: StorageStats",permalink:"/api/interfaces/StorageStats"},next:{title:"Interface: TelemetryLoggerOptions",permalink:"/api/interfaces/TelemetryLoggerOptions"}},l={},d=[{value:"Properties",id:"properties",level:2},{value:"isErrorsEnabled",id:"iserrorsenabled",level:3},{value:"Source",id:"source",level:4},{value:"isUsageEnabled",id:"isusageenabled",level:3},{value:"Source",id:"source-1",level:4},{value:"onDidChangeEnableStates",id:"ondidchangeenablestates",level:3},{value:"Source",id:"source-2",level:4},{value:"Methods",id:"methods",level:2},{value:"dispose()",id:"dispose",level:3},{value:"Returns",id:"returns",level:4},{value:"Source",id:"source-3",level:4},{value:"logError()",id:"logerror",level:3},{value:"logError(eventName, data)",id:"logerroreventname-data",level:4},{value:"Parameters",id:"parameters",level:5},{value:"Returns",id:"returns-1",level:5},{value:"Source",id:"source-4",level:5},{value:"logError(error, data)",id:"logerrorerror-data",level:4},{value:"Parameters",id:"parameters-1",level:5},{value:"Returns",id:"returns-2",level:5},{value:"Source",id:"source-5",level:5},{value:"logUsage()",id:"logusage",level:3},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-3",level:4},{value:"Source",id:"source-6",level:4}];function a(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",h5:"h5",hr:"hr",li:"li",p:"p",strong:"strong",ul:"ul",...(0,t.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"interface-telemetrylogger",children:"Interface: TelemetryLogger"}),"\n",(0,s.jsx)(n.p,{children:"A telemetry logger which can be used by extensions to log usage and error telementry."}),"\n",(0,s.jsxs)(n.p,{children:["A logger wraps around an ",(0,s.jsx)(n.a,{href:"/api/interfaces/TelemetrySender",children:"sender"})," but it guarantees that"]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsx)(n.li,{children:"user settings to disable or tweak telemetry are respected, and that"}),"\n",(0,s.jsx)(n.li,{children:"potential sensitive data is removed"}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:'It also enables an "echo UI" that prints whatever data is send and it allows the editor\nto forward unhandled errors to the respective extensions.'}),"\n",(0,s.jsxs)(n.p,{children:["To get an instance of a ",(0,s.jsx)(n.code,{children:"TelemetryLogger"}),", use\n",(0,s.jsx)(n.a,{href:"/api/namespaces/env/functions/createTelemetryLogger",children:(0,s.jsx)(n.code,{children:"createTelemetryLogger"})}),"."]}),"\n",(0,s.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,s.jsx)(n.h3,{id:"iserrorsenabled",children:"isErrorsEnabled"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:(0,s.jsx)(n.code,{children:"readonly"})})," ",(0,s.jsx)(n.strong,{children:"isErrorsEnabled"}),": ",(0,s.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Whether or not error telemetry is enabled for this logger."}),"\n",(0,s.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L3869",children:"packages/extension-api/src/extension-api.d.ts:3869"})}),"\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.strong,{children:(0,s.jsx)(n.code,{children:"readonly"})})," ",(0,s.jsx)(n.strong,{children:"isUsageEnabled"}),": ",(0,s.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Whether or not usage telemetry is enabled for this logger."}),"\n",(0,s.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L3864",children:"packages/extension-api/src/extension-api.d.ts:3864"})}),"\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.strong,{children:(0,s.jsx)(n.code,{children:"readonly"})})," ",(0,s.jsx)(n.strong,{children:"onDidChangeEnableStates"}),": ",(0,s.jsx)(n.a,{href:"/api/interfaces/Event",children:(0,s.jsx)(n.code,{children:"Event"})}),"< ",(0,s.jsx)(n.a,{href:"/api/interfaces/TelemetryLogger",children:(0,s.jsx)(n.code,{children:"TelemetryLogger"})})," >"]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:["An ",(0,s.jsx)(n.a,{href:"/api/interfaces/Event",children:"Event"})," which fires when the enablement state of usage or error telemetry changes."]}),"\n",(0,s.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L3859",children:"packages/extension-api/src/extension-api.d.ts:3859"})}),"\n",(0,s.jsx)(n.h2,{id:"methods",children:"Methods"}),"\n",(0,s.jsx)(n.h3,{id:"dispose",children:"dispose()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"dispose"}),"(): ",(0,s.jsx)(n.code,{children:"void"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Dispose this object and free resources."}),"\n",(0,s.jsx)(n.h4,{id:"returns",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"void"})}),"\n",(0,s.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L3904",children:"packages/extension-api/src/extension-api.d.ts:3904"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"logerror",children:"logError()"}),"\n",(0,s.jsx)(n.h4,{id:"logerroreventname-data",children:"logError(eventName, data)"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"logError"}),"(",(0,s.jsx)(n.code,{children:"eventName"}),", ",(0,s.jsx)(n.code,{children:"data"}),"?): ",(0,s.jsx)(n.code,{children:"void"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Log an error event."}),"\n",(0,s.jsxs)(n.p,{children:["After completing cleaning, telemetry setting checks, and data mix-in calls ",(0,s.jsx)(n.code,{children:"TelemetrySender.sendEventData"})," to log the event. Differs from ",(0,s.jsx)(n.code,{children:"logUsage"})," in that it will log the event if the telemetry setting is Error+.\nAutomatically supports echoing to extension telemetry output channel."]}),"\n",(0,s.jsx)(n.h5,{id:"parameters",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"eventName"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n",(0,s.jsx)(n.p,{children:"The event name to log"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"data?"}),": ",(0,s.jsx)(n.code,{children:"Record"}),"< ",(0,s.jsx)(n.code,{children:"string"}),", ",(0,s.jsx)(n.code,{children:"any"})," >"]}),"\n",(0,s.jsx)(n.p,{children:"The data to log"}),"\n",(0,s.jsx)(n.h5,{id:"returns-1",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"void"})}),"\n",(0,s.jsx)(n.h5,{id:"source-4",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L3891",children:"packages/extension-api/src/extension-api.d.ts:3891"})}),"\n",(0,s.jsx)(n.h4,{id:"logerrorerror-data",children:"logError(error, data)"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"logError"}),"(",(0,s.jsx)(n.code,{children:"error"}),", ",(0,s.jsx)(n.code,{children:"data"}),"?): ",(0,s.jsx)(n.code,{children:"void"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Log an error event."}),"\n",(0,s.jsx)(n.h5,{id:"parameters-1",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"error"}),": ",(0,s.jsx)(n.code,{children:"Error"})]}),"\n",(0,s.jsx)(n.p,{children:"The error object which contains the stack trace cleaned of PII"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"data?"}),": ",(0,s.jsx)(n.code,{children:"Record"}),"< ",(0,s.jsx)(n.code,{children:"string"}),", ",(0,s.jsx)(n.code,{children:"any"})," >"]}),"\n",(0,s.jsx)(n.p,{children:"Additional data to log alongside the stack trace"}),"\n",(0,s.jsx)(n.h5,{id:"returns-2",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"void"})}),"\n",(0,s.jsx)(n.h5,{id:"source-5",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L3899",children:"packages/extension-api/src/extension-api.d.ts:3899"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"logusage",children:"logUsage()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"logUsage"}),"(",(0,s.jsx)(n.code,{children:"eventName"}),", ",(0,s.jsx)(n.code,{children:"data"}),"?): ",(0,s.jsx)(n.code,{children:"void"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Log a usage event."}),"\n",(0,s.jsxs)(n.p,{children:["After completing cleaning, telemetry setting checks, and data mix-in calls ",(0,s.jsx)(n.code,{children:"TelemetrySender.sendEventData"})," to log the event.\nAutomatically supports echoing to extension telemetry output channel."]}),"\n",(0,s.jsx)(n.h4,{id:"parameters-2",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"eventName"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n",(0,s.jsx)(n.p,{children:"The event name to log"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"data?"}),": ",(0,s.jsx)(n.code,{children:"Record"}),"< ",(0,s.jsx)(n.code,{children:"string"}),", ",(0,s.jsx)(n.code,{children:"any"})," >"]}),"\n",(0,s.jsx)(n.p,{children:"The data to log"}),"\n",(0,s.jsx)(n.h4,{id:"returns-3",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"void"})}),"\n",(0,s.jsx)(n.h4,{id:"source-6",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L3880",children:"packages/extension-api/src/extension-api.d.ts:3880"})})]})}function h(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(a,{...e})}):a(e)}},71670:(e,n,r)=>{r.d(n,{Z:()=>c,a:()=>o});var s=r(27378);const t={},i=s.createContext(t);function o(e){const n=s.useContext(i);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:o(e.components),s.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[83672],{43791:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>c,contentTitle:()=>o,default:()=>h,frontMatter:()=>i,metadata:()=>d,toc:()=>l});var s=r(24246),t=r(71670);const i={},o="Interface: TelemetryLogger",d={id:"interfaces/TelemetryLogger",title:"Interface: TelemetryLogger",description:"A telemetry logger which can be used by extensions to log usage and error telementry.",source:"@site/api/interfaces/TelemetryLogger.md",sourceDirName:"interfaces",slug:"/interfaces/TelemetryLogger",permalink:"/api/interfaces/TelemetryLogger",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: StorageStats",permalink:"/api/interfaces/StorageStats"},next:{title:"Interface: TelemetryLoggerOptions",permalink:"/api/interfaces/TelemetryLoggerOptions"}},c={},l=[{value:"Properties",id:"properties",level:2},{value:"isErrorsEnabled",id:"iserrorsenabled",level:3},{value:"Source",id:"source",level:4},{value:"isUsageEnabled",id:"isusageenabled",level:3},{value:"Source",id:"source-1",level:4},{value:"onDidChangeEnableStates",id:"ondidchangeenablestates",level:3},{value:"Source",id:"source-2",level:4},{value:"Methods",id:"methods",level:2},{value:"dispose()",id:"dispose",level:3},{value:"Returns",id:"returns",level:4},{value:"Source",id:"source-3",level:4},{value:"logError()",id:"logerror",level:3},{value:"logError(eventName, data)",id:"logerroreventname-data",level:4},{value:"Parameters",id:"parameters",level:5},{value:"Returns",id:"returns-1",level:5},{value:"Source",id:"source-4",level:5},{value:"logError(error, data)",id:"logerrorerror-data",level:4},{value:"Parameters",id:"parameters-1",level:5},{value:"Returns",id:"returns-2",level:5},{value:"Source",id:"source-5",level:5},{value:"logUsage()",id:"logusage",level:3},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-3",level:4},{value:"Source",id:"source-6",level:4}];function a(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",h5:"h5",hr:"hr",li:"li",p:"p",strong:"strong",ul:"ul",...(0,t.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"interface-telemetrylogger",children:"Interface: TelemetryLogger"}),"\n",(0,s.jsx)(n.p,{children:"A telemetry logger which can be used by extensions to log usage and error telementry."}),"\n",(0,s.jsxs)(n.p,{children:["A logger wraps around an ",(0,s.jsx)(n.a,{href:"/api/interfaces/TelemetrySender",children:"sender"})," but it guarantees that"]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsx)(n.li,{children:"user settings to disable or tweak telemetry are respected, and that"}),"\n",(0,s.jsx)(n.li,{children:"potential sensitive data is removed"}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:'It also enables an "echo UI" that prints whatever data is send and it allows the editor\nto forward unhandled errors to the respective extensions.'}),"\n",(0,s.jsxs)(n.p,{children:["To get an instance of a ",(0,s.jsx)(n.code,{children:"TelemetryLogger"}),", use\n",(0,s.jsx)(n.a,{href:"/api/namespaces/env/functions/createTelemetryLogger",children:(0,s.jsx)(n.code,{children:"createTelemetryLogger"})}),"."]}),"\n",(0,s.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,s.jsx)(n.h3,{id:"iserrorsenabled",children:"isErrorsEnabled"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:(0,s.jsx)(n.code,{children:"readonly"})})," ",(0,s.jsx)(n.strong,{children:"isErrorsEnabled"}),": ",(0,s.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Whether or not error telemetry is enabled for this logger."}),"\n",(0,s.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L3869",children:"packages/extension-api/src/extension-api.d.ts:3869"})}),"\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.strong,{children:(0,s.jsx)(n.code,{children:"readonly"})})," ",(0,s.jsx)(n.strong,{children:"isUsageEnabled"}),": ",(0,s.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Whether or not usage telemetry is enabled for this logger."}),"\n",(0,s.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L3864",children:"packages/extension-api/src/extension-api.d.ts:3864"})}),"\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.strong,{children:(0,s.jsx)(n.code,{children:"readonly"})})," ",(0,s.jsx)(n.strong,{children:"onDidChangeEnableStates"}),": ",(0,s.jsx)(n.a,{href:"/api/interfaces/Event",children:(0,s.jsx)(n.code,{children:"Event"})}),"< ",(0,s.jsx)(n.a,{href:"/api/interfaces/TelemetryLogger",children:(0,s.jsx)(n.code,{children:"TelemetryLogger"})})," >"]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:["An ",(0,s.jsx)(n.a,{href:"/api/interfaces/Event",children:"Event"})," which fires when the enablement state of usage or error telemetry changes."]}),"\n",(0,s.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L3859",children:"packages/extension-api/src/extension-api.d.ts:3859"})}),"\n",(0,s.jsx)(n.h2,{id:"methods",children:"Methods"}),"\n",(0,s.jsx)(n.h3,{id:"dispose",children:"dispose()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"dispose"}),"(): ",(0,s.jsx)(n.code,{children:"void"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Dispose this object and free resources."}),"\n",(0,s.jsx)(n.h4,{id:"returns",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"void"})}),"\n",(0,s.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L3904",children:"packages/extension-api/src/extension-api.d.ts:3904"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"logerror",children:"logError()"}),"\n",(0,s.jsx)(n.h4,{id:"logerroreventname-data",children:"logError(eventName, data)"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"logError"}),"(",(0,s.jsx)(n.code,{children:"eventName"}),", ",(0,s.jsx)(n.code,{children:"data"}),"?): ",(0,s.jsx)(n.code,{children:"void"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Log an error event."}),"\n",(0,s.jsxs)(n.p,{children:["After completing cleaning, telemetry setting checks, and data mix-in calls ",(0,s.jsx)(n.code,{children:"TelemetrySender.sendEventData"})," to log the event. Differs from ",(0,s.jsx)(n.code,{children:"logUsage"})," in that it will log the event if the telemetry setting is Error+.\nAutomatically supports echoing to extension telemetry output channel."]}),"\n",(0,s.jsx)(n.h5,{id:"parameters",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"eventName"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n",(0,s.jsx)(n.p,{children:"The event name to log"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"data?"}),": ",(0,s.jsx)(n.code,{children:"Record"}),"< ",(0,s.jsx)(n.code,{children:"string"}),", ",(0,s.jsx)(n.code,{children:"any"})," >"]}),"\n",(0,s.jsx)(n.p,{children:"The data to log"}),"\n",(0,s.jsx)(n.h5,{id:"returns-1",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"void"})}),"\n",(0,s.jsx)(n.h5,{id:"source-4",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L3891",children:"packages/extension-api/src/extension-api.d.ts:3891"})}),"\n",(0,s.jsx)(n.h4,{id:"logerrorerror-data",children:"logError(error, data)"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"logError"}),"(",(0,s.jsx)(n.code,{children:"error"}),", ",(0,s.jsx)(n.code,{children:"data"}),"?): ",(0,s.jsx)(n.code,{children:"void"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Log an error event."}),"\n",(0,s.jsx)(n.h5,{id:"parameters-1",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"error"}),": ",(0,s.jsx)(n.code,{children:"Error"})]}),"\n",(0,s.jsx)(n.p,{children:"The error object which contains the stack trace cleaned of PII"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"data?"}),": ",(0,s.jsx)(n.code,{children:"Record"}),"< ",(0,s.jsx)(n.code,{children:"string"}),", ",(0,s.jsx)(n.code,{children:"any"})," >"]}),"\n",(0,s.jsx)(n.p,{children:"Additional data to log alongside the stack trace"}),"\n",(0,s.jsx)(n.h5,{id:"returns-2",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"void"})}),"\n",(0,s.jsx)(n.h5,{id:"source-5",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L3899",children:"packages/extension-api/src/extension-api.d.ts:3899"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"logusage",children:"logUsage()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"logUsage"}),"(",(0,s.jsx)(n.code,{children:"eventName"}),", ",(0,s.jsx)(n.code,{children:"data"}),"?): ",(0,s.jsx)(n.code,{children:"void"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Log a usage event."}),"\n",(0,s.jsxs)(n.p,{children:["After completing cleaning, telemetry setting checks, and data mix-in calls ",(0,s.jsx)(n.code,{children:"TelemetrySender.sendEventData"})," to log the event.\nAutomatically supports echoing to extension telemetry output channel."]}),"\n",(0,s.jsx)(n.h4,{id:"parameters-2",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"eventName"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n",(0,s.jsx)(n.p,{children:"The event name to log"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"data?"}),": ",(0,s.jsx)(n.code,{children:"Record"}),"< ",(0,s.jsx)(n.code,{children:"string"}),", ",(0,s.jsx)(n.code,{children:"any"})," >"]}),"\n",(0,s.jsx)(n.p,{children:"The data to log"}),"\n",(0,s.jsx)(n.h4,{id:"returns-3",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"void"})}),"\n",(0,s.jsx)(n.h4,{id:"source-6",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L3880",children:"packages/extension-api/src/extension-api.d.ts:3880"})})]})}function h(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(a,{...e})}):a(e)}},71670:(e,n,r)=>{r.d(n,{Z:()=>d,a:()=>o});var s=r(27378);const t={},i=s.createContext(t);function o(e){const n=s.useContext(i);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function d(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:o(e.components),s.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/878aa0e7.6f1b7c68.js b/assets/js/878aa0e7.239ec341.js similarity index 90% rename from assets/js/878aa0e7.6f1b7c68.js rename to assets/js/878aa0e7.239ec341.js index 40f9303d054..5b85feeb145 100644 --- a/assets/js/878aa0e7.6f1b7c68.js +++ b/assets/js/878aa0e7.239ec341.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[16467],{12972:(e,n,o)=>{o.r(n),o.d(n,{assets:()=>c,contentTitle:()=>s,default:()=>u,frontMatter:()=>r,metadata:()=>a,toc:()=>p});var t=o(24246),i=o(71670);const r={},s="Type alias: ConfigurationScope",a={id:"type-aliases/ConfigurationScope",title:"Type alias: ConfigurationScope",description:"ConfigurationScope: string \\| ContainerProviderConnection \\| KubernetesProviderConnection",source:"@site/api/type-aliases/ConfigurationScope.md",sourceDirName:"type-aliases",slug:"/type-aliases/ConfigurationScope",permalink:"/api/type-aliases/ConfigurationScope",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Type alias: CliToolState",permalink:"/api/type-aliases/CliToolState"},next:{title:"Type alias: KubernetesGeneratorArgument",permalink:"/api/type-aliases/KubernetesGeneratorArgument"}},c={},p=[{value:"Source",id:"source",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,i.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"type-alias-configurationscope",children:"Type alias: ConfigurationScope"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"ConfigurationScope"}),": ",(0,t.jsx)(n.code,{children:"string"})," | ",(0,t.jsx)(n.a,{href:"/api/interfaces/ContainerProviderConnection",children:(0,t.jsx)(n.code,{children:"ContainerProviderConnection"})})," | ",(0,t.jsx)(n.a,{href:"/api/interfaces/KubernetesProviderConnection",children:(0,t.jsx)(n.code,{children:"KubernetesProviderConnection"})})]}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"The configuration scope"}),"\n",(0,t.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L662",children:"packages/extension-api/src/extension-api.d.ts:662"})})]})}function u(e={}){const{wrapper:n}={...(0,i.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},71670:(e,n,o)=>{o.d(n,{Z:()=>a,a:()=>s});var t=o(27378);const i={},r=t.createContext(i);function s(e){const n=t.useContext(r);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function a(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:s(e.components),t.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[16467],{12972:(e,n,o)=>{o.r(n),o.d(n,{assets:()=>c,contentTitle:()=>s,default:()=>d,frontMatter:()=>r,metadata:()=>a,toc:()=>p});var t=o(24246),i=o(71670);const r={},s="Type alias: ConfigurationScope",a={id:"type-aliases/ConfigurationScope",title:"Type alias: ConfigurationScope",description:"ConfigurationScope: string \\| ContainerProviderConnection \\| KubernetesProviderConnection",source:"@site/api/type-aliases/ConfigurationScope.md",sourceDirName:"type-aliases",slug:"/type-aliases/ConfigurationScope",permalink:"/api/type-aliases/ConfigurationScope",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Type alias: CliToolState",permalink:"/api/type-aliases/CliToolState"},next:{title:"Type alias: KubernetesGeneratorArgument",permalink:"/api/type-aliases/KubernetesGeneratorArgument"}},c={},p=[{value:"Source",id:"source",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,i.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"type-alias-configurationscope",children:"Type alias: ConfigurationScope"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"ConfigurationScope"}),": ",(0,t.jsx)(n.code,{children:"string"})," | ",(0,t.jsx)(n.a,{href:"/api/interfaces/ContainerProviderConnection",children:(0,t.jsx)(n.code,{children:"ContainerProviderConnection"})})," | ",(0,t.jsx)(n.a,{href:"/api/interfaces/KubernetesProviderConnection",children:(0,t.jsx)(n.code,{children:"KubernetesProviderConnection"})})]}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"The configuration scope"}),"\n",(0,t.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L662",children:"packages/extension-api/src/extension-api.d.ts:662"})})]})}function d(e={}){const{wrapper:n}={...(0,i.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},71670:(e,n,o)=>{o.d(n,{Z:()=>a,a:()=>s});var t=o(27378);const i={},r=t.createContext(i);function s(e){const n=t.useContext(r);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function a(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:s(e.components),t.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/87a5fc8a.544c883c.js b/assets/js/87a5fc8a.e2b44fde.js similarity index 95% rename from assets/js/87a5fc8a.544c883c.js rename to assets/js/87a5fc8a.e2b44fde.js index 69b25eff369..2550f304dad 100644 --- a/assets/js/87a5fc8a.544c883c.js +++ b/assets/js/87a5fc8a.e2b44fde.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[61573],{56268:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>c,default:()=>p,frontMatter:()=>i,metadata:()=>o,toc:()=>d});var s=t(24246),r=t(71670);const i={},c="Interface: PidsStats",o={id:"interfaces/PidsStats",title:"Interface: PidsStats",description:"Properties",source:"@site/api/interfaces/PidsStats.md",sourceDirName:"interfaces",slug:"/interfaces/PidsStats",permalink:"/api/interfaces/PidsStats",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: OpenDialogOptions",permalink:"/api/interfaces/OpenDialogOptions"},next:{title:"Interface: PodContainerInfo",permalink:"/api/interfaces/PodContainerInfo"}},a={},d=[{value:"Properties",id:"properties",level:2},{value:"current?",id:"current",level:3},{value:"Source",id:"source",level:4},{value:"limit?",id:"limit",level:3},{value:"Source",id:"source-1",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,r.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"interface-pidsstats",children:"Interface: PidsStats"}),"\n",(0,s.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,s.jsx)(n.h3,{id:"current",children:"current?"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:(0,s.jsx)(n.code,{children:"optional"})})," ",(0,s.jsx)(n.strong,{children:"current"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2759",children:"packages/extension-api/src/extension-api.d.ts:2759"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"limit",children:"limit?"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:(0,s.jsx)(n.code,{children:"optional"})})," ",(0,s.jsx)(n.strong,{children:"limit"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2760",children:"packages/extension-api/src/extension-api.d.ts:2760"})})]})}function p(e={}){const{wrapper:n}={...(0,r.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>o,a:()=>c});var s=t(27378);const r={},i=s.createContext(r);function c(e){const n=s.useContext(i);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:c(e.components),s.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[61573],{56268:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>c,default:()=>p,frontMatter:()=>i,metadata:()=>o,toc:()=>d});var s=t(24246),r=t(71670);const i={},c="Interface: PidsStats",o={id:"interfaces/PidsStats",title:"Interface: PidsStats",description:"Properties",source:"@site/api/interfaces/PidsStats.md",sourceDirName:"interfaces",slug:"/interfaces/PidsStats",permalink:"/api/interfaces/PidsStats",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: OpenDialogOptions",permalink:"/api/interfaces/OpenDialogOptions"},next:{title:"Interface: PodContainerInfo",permalink:"/api/interfaces/PodContainerInfo"}},a={},d=[{value:"Properties",id:"properties",level:2},{value:"current?",id:"current",level:3},{value:"Source",id:"source",level:4},{value:"limit?",id:"limit",level:3},{value:"Source",id:"source-1",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,r.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"interface-pidsstats",children:"Interface: PidsStats"}),"\n",(0,s.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,s.jsx)(n.h3,{id:"current",children:"current?"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:(0,s.jsx)(n.code,{children:"optional"})})," ",(0,s.jsx)(n.strong,{children:"current"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2759",children:"packages/extension-api/src/extension-api.d.ts:2759"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"limit",children:"limit?"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:(0,s.jsx)(n.code,{children:"optional"})})," ",(0,s.jsx)(n.strong,{children:"limit"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2760",children:"packages/extension-api/src/extension-api.d.ts:2760"})})]})}function p(e={}){const{wrapper:n}={...(0,r.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>o,a:()=>c});var s=t(27378);const r={},i=s.createContext(r);function c(e){const n=s.useContext(i);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:c(e.components),s.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/883e2c3c.c30481f9.js b/assets/js/883e2c3c.87b41090.js similarity index 95% rename from assets/js/883e2c3c.c30481f9.js rename to assets/js/883e2c3c.87b41090.js index 52e440c9b19..0a580ab2e77 100644 --- a/assets/js/883e2c3c.c30481f9.js +++ b/assets/js/883e2c3c.87b41090.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[53479],{4120:(n,e,t)=>{t.r(e),t.d(e,{assets:()=>a,contentTitle:()=>i,default:()=>u,frontMatter:()=>o,metadata:()=>c,toc:()=>d});var s=t(24246),r=t(71670);const o={},i="Function: startPod()",c={id:"namespaces/containerEngine/functions/startPod",title:"Function: startPod()",description:"startPod(engineId, podId): Promise\\",source:"@site/api/namespaces/containerEngine/functions/startPod.md",sourceDirName:"namespaces/containerEngine/functions",slug:"/namespaces/containerEngine/functions/startPod",permalink:"/api/namespaces/containerEngine/functions/startPod",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Function: startContainer()",permalink:"/api/namespaces/containerEngine/functions/startContainer"},next:{title:"Function: statsContainer()",permalink:"/api/namespaces/containerEngine/functions/statsContainer"}},a={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function l(n){const e={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,r.a)(),...n.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(e.h1,{id:"function-startpod",children:"Function: startPod()"}),"\n",(0,s.jsxs)(e.blockquote,{children:["\n",(0,s.jsxs)(e.p,{children:[(0,s.jsx)(e.strong,{children:"startPod"}),"(",(0,s.jsx)(e.code,{children:"engineId"}),", ",(0,s.jsx)(e.code,{children:"podId"}),"): ",(0,s.jsx)(e.code,{children:"Promise"}),"< ",(0,s.jsx)(e.code,{children:"void"})," >"]}),"\n"]}),"\n",(0,s.jsx)(e.h2,{id:"parameters",children:"Parameters"}),"\n",(0,s.jsxs)(e.p,{children:["\u2022 ",(0,s.jsx)(e.strong,{children:"engineId"}),": ",(0,s.jsx)(e.code,{children:"string"})]}),"\n",(0,s.jsxs)(e.p,{children:["\u2022 ",(0,s.jsx)(e.strong,{children:"podId"}),": ",(0,s.jsx)(e.code,{children:"string"})]}),"\n",(0,s.jsx)(e.h2,{id:"returns",children:"Returns"}),"\n",(0,s.jsxs)(e.p,{children:[(0,s.jsx)(e.code,{children:"Promise"}),"< ",(0,s.jsx)(e.code,{children:"void"})," >"]}),"\n",(0,s.jsx)(e.h2,{id:"source",children:"Source"}),"\n",(0,s.jsx)(e.p,{children:(0,s.jsx)(e.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L3380",children:"packages/extension-api/src/extension-api.d.ts:3380"})})]})}function u(n={}){const{wrapper:e}={...(0,r.a)(),...n.components};return e?(0,s.jsx)(e,{...n,children:(0,s.jsx)(l,{...n})}):l(n)}},71670:(n,e,t)=>{t.d(e,{Z:()=>c,a:()=>i});var s=t(27378);const r={},o=s.createContext(r);function i(n){const e=s.useContext(o);return s.useMemo((function(){return"function"==typeof n?n(e):{...e,...n}}),[e,n])}function c(n){let e;return e=n.disableParentContext?"function"==typeof n.components?n.components(r):n.components||r:i(n.components),s.createElement(o.Provider,{value:e},n.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[53479],{4120:(n,e,t)=>{t.r(e),t.d(e,{assets:()=>a,contentTitle:()=>i,default:()=>u,frontMatter:()=>o,metadata:()=>c,toc:()=>d});var s=t(24246),r=t(71670);const o={},i="Function: startPod()",c={id:"namespaces/containerEngine/functions/startPod",title:"Function: startPod()",description:"startPod(engineId, podId): Promise\\",source:"@site/api/namespaces/containerEngine/functions/startPod.md",sourceDirName:"namespaces/containerEngine/functions",slug:"/namespaces/containerEngine/functions/startPod",permalink:"/api/namespaces/containerEngine/functions/startPod",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Function: startContainer()",permalink:"/api/namespaces/containerEngine/functions/startContainer"},next:{title:"Function: statsContainer()",permalink:"/api/namespaces/containerEngine/functions/statsContainer"}},a={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function l(n){const e={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,r.a)(),...n.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(e.h1,{id:"function-startpod",children:"Function: startPod()"}),"\n",(0,s.jsxs)(e.blockquote,{children:["\n",(0,s.jsxs)(e.p,{children:[(0,s.jsx)(e.strong,{children:"startPod"}),"(",(0,s.jsx)(e.code,{children:"engineId"}),", ",(0,s.jsx)(e.code,{children:"podId"}),"): ",(0,s.jsx)(e.code,{children:"Promise"}),"< ",(0,s.jsx)(e.code,{children:"void"})," >"]}),"\n"]}),"\n",(0,s.jsx)(e.h2,{id:"parameters",children:"Parameters"}),"\n",(0,s.jsxs)(e.p,{children:["\u2022 ",(0,s.jsx)(e.strong,{children:"engineId"}),": ",(0,s.jsx)(e.code,{children:"string"})]}),"\n",(0,s.jsxs)(e.p,{children:["\u2022 ",(0,s.jsx)(e.strong,{children:"podId"}),": ",(0,s.jsx)(e.code,{children:"string"})]}),"\n",(0,s.jsx)(e.h2,{id:"returns",children:"Returns"}),"\n",(0,s.jsxs)(e.p,{children:[(0,s.jsx)(e.code,{children:"Promise"}),"< ",(0,s.jsx)(e.code,{children:"void"})," >"]}),"\n",(0,s.jsx)(e.h2,{id:"source",children:"Source"}),"\n",(0,s.jsx)(e.p,{children:(0,s.jsx)(e.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L3380",children:"packages/extension-api/src/extension-api.d.ts:3380"})})]})}function u(n={}){const{wrapper:e}={...(0,r.a)(),...n.components};return e?(0,s.jsx)(e,{...n,children:(0,s.jsx)(l,{...n})}):l(n)}},71670:(n,e,t)=>{t.d(e,{Z:()=>c,a:()=>i});var s=t(27378);const r={},o=s.createContext(r);function i(n){const e=s.useContext(o);return s.useMemo((function(){return"function"==typeof n?n(e):{...e,...n}}),[e,n])}function c(n){let e;return e=n.disableParentContext?"function"==typeof n.components?n.components(r):n.components||r:i(n.components),s.createElement(o.Provider,{value:e},n.children)}}}]); \ No newline at end of file diff --git a/assets/js/8a864d1e.81975c62.js b/assets/js/8a864d1e.2ec45b44.js similarity index 94% rename from assets/js/8a864d1e.81975c62.js rename to assets/js/8a864d1e.2ec45b44.js index d0e77a87854..7dcd3cd55ad 100644 --- a/assets/js/8a864d1e.81975c62.js +++ b/assets/js/8a864d1e.2ec45b44.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[68974],{79206:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>c,contentTitle:()=>r,default:()=>l,frontMatter:()=>i,metadata:()=>a,toc:()=>d});var o=n(24246),s=n(71670);const i={},r="Type alias: ProviderConnectionStatus",a={id:"type-aliases/ProviderConnectionStatus",title:"Type alias: ProviderConnectionStatus",description:'ProviderConnectionStatus: "started" \\| "stopped" \\| "starting" \\| "stopping" \\| "unknown"',source:"@site/api/type-aliases/ProviderConnectionStatus.md",sourceDirName:"type-aliases",slug:"/type-aliases/ProviderConnectionStatus",permalink:"/api/type-aliases/ProviderConnectionStatus",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Type alias: NotificationType",permalink:"/api/type-aliases/NotificationType"},next:{title:"Type alias: ProviderLinks",permalink:"/api/type-aliases/ProviderLinks"}},c={},d=[{value:"Source",id:"source",level:2}];function p(e){const t={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(t.h1,{id:"type-alias-providerconnectionstatus",children:"Type alias: ProviderConnectionStatus"}),"\n",(0,o.jsxs)(t.blockquote,{children:["\n",(0,o.jsxs)(t.p,{children:[(0,o.jsx)(t.strong,{children:"ProviderConnectionStatus"}),": ",(0,o.jsx)(t.code,{children:'"started"'})," | ",(0,o.jsx)(t.code,{children:'"stopped"'})," | ",(0,o.jsx)(t.code,{children:'"starting"'})," | ",(0,o.jsx)(t.code,{children:'"stopping"'})," | ",(0,o.jsx)(t.code,{children:'"unknown"'})]}),"\n"]}),"\n",(0,o.jsx)(t.h2,{id:"source",children:"Source"}),"\n",(0,o.jsx)(t.p,{children:(0,o.jsx)(t.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L232",children:"packages/extension-api/src/extension-api.d.ts:232"})})]})}function l(e={}){const{wrapper:t}={...(0,s.a)(),...e.components};return t?(0,o.jsx)(t,{...e,children:(0,o.jsx)(p,{...e})}):p(e)}},71670:(e,t,n)=>{n.d(t,{Z:()=>a,a:()=>r});var o=n(27378);const s={},i=o.createContext(s);function r(e){const t=o.useContext(i);return o.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function a(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:r(e.components),o.createElement(i.Provider,{value:t},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[68974],{79206:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>c,contentTitle:()=>r,default:()=>l,frontMatter:()=>i,metadata:()=>a,toc:()=>d});var o=n(24246),s=n(71670);const i={},r="Type alias: ProviderConnectionStatus",a={id:"type-aliases/ProviderConnectionStatus",title:"Type alias: ProviderConnectionStatus",description:'ProviderConnectionStatus: "started" \\| "stopped" \\| "starting" \\| "stopping" \\| "unknown"',source:"@site/api/type-aliases/ProviderConnectionStatus.md",sourceDirName:"type-aliases",slug:"/type-aliases/ProviderConnectionStatus",permalink:"/api/type-aliases/ProviderConnectionStatus",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Type alias: NotificationType",permalink:"/api/type-aliases/NotificationType"},next:{title:"Type alias: ProviderLinks",permalink:"/api/type-aliases/ProviderLinks"}},c={},d=[{value:"Source",id:"source",level:2}];function p(e){const t={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(t.h1,{id:"type-alias-providerconnectionstatus",children:"Type alias: ProviderConnectionStatus"}),"\n",(0,o.jsxs)(t.blockquote,{children:["\n",(0,o.jsxs)(t.p,{children:[(0,o.jsx)(t.strong,{children:"ProviderConnectionStatus"}),": ",(0,o.jsx)(t.code,{children:'"started"'})," | ",(0,o.jsx)(t.code,{children:'"stopped"'})," | ",(0,o.jsx)(t.code,{children:'"starting"'})," | ",(0,o.jsx)(t.code,{children:'"stopping"'})," | ",(0,o.jsx)(t.code,{children:'"unknown"'})]}),"\n"]}),"\n",(0,o.jsx)(t.h2,{id:"source",children:"Source"}),"\n",(0,o.jsx)(t.p,{children:(0,o.jsx)(t.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L232",children:"packages/extension-api/src/extension-api.d.ts:232"})})]})}function l(e={}){const{wrapper:t}={...(0,s.a)(),...e.components};return t?(0,o.jsx)(t,{...e,children:(0,o.jsx)(p,{...e})}):p(e)}},71670:(e,t,n)=>{n.d(t,{Z:()=>a,a:()=>r});var o=n(27378);const s={},i=o.createContext(s);function r(e){const t=o.useContext(i);return o.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function a(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:r(e.components),o.createElement(i.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/8abd0ba5.c3076744.js b/assets/js/8abd0ba5.0438e79c.js similarity index 90% rename from assets/js/8abd0ba5.c3076744.js rename to assets/js/8abd0ba5.0438e79c.js index 57d43920c80..096adbe4a86 100644 --- a/assets/js/8abd0ba5.c3076744.js +++ b/assets/js/8abd0ba5.0438e79c.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[1516],{68471:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>r,default:()=>h,frontMatter:()=>c,metadata:()=>o,toc:()=>d});var s=t(24246),i=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:"Interface: CustomPickItem",permalink:"/api/interfaces/CustomPickItem"},next:{title:"Interface: DeviceRequest",permalink:"/api/interfaces/DeviceRequest"}},a={},d=[{value:"Properties",id:"properties",level:2},{value:"content?",id:"content",level:3},{value:"Source",id:"source",level:4},{value:"markDownContent?",id:"markdowncontent",level:3},{value:"Source",id:"source-1",level:4},{value:"title",id:"title",level:3},{value:"Source",id:"source-2",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,i.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"interface-custompicksectionitem",children:"Interface: CustomPickSectionItem"}),"\n",(0,s.jsx)(n.p,{children:"Represents an item that can be selected from\na list of items."}),"\n",(0,s.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,s.jsx)(n.h3,{id:"content",children:"content?"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:(0,s.jsx)(n.code,{children:"optional"})})," ",(0,s.jsx)(n.strong,{children:"content"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"A human-readable string which is rendered in a separate line."}),"\n",(0,s.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L1054",children:"packages/extension-api/src/extension-api.d.ts:1054"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"markdowncontent",children:"markDownContent?"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:(0,s.jsx)(n.code,{children:"optional"})})," ",(0,s.jsx)(n.strong,{children:"markDownContent"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"A human-readable string which is rendered in a separate line. (Markdown format)"}),"\n",(0,s.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L1059",children:"packages/extension-api/src/extension-api.d.ts:1059"})}),"\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:"A human-readable string which is rendered prominent."}),"\n",(0,s.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L1049",children:"packages/extension-api/src/extension-api.d.ts:1049"})})]})}function h(e={}){const{wrapper:n}={...(0,i.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>o,a:()=>r});var s=t(27378);const i={},c=s.createContext(i);function r(e){const n=s.useContext(c);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:r(e.components),s.createElement(c.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[1516],{68471:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>r,default:()=>h,frontMatter:()=>c,metadata:()=>o,toc:()=>d});var s=t(24246),i=t(71670);const c={},r="Interface: 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:"Interface: CustomPickItem",permalink:"/api/interfaces/CustomPickItem"},next:{title:"Interface: DeviceRequest",permalink:"/api/interfaces/DeviceRequest"}},a={},d=[{value:"Properties",id:"properties",level:2},{value:"content?",id:"content",level:3},{value:"Source",id:"source",level:4},{value:"markDownContent?",id:"markdowncontent",level:3},{value:"Source",id:"source-1",level:4},{value:"title",id:"title",level:3},{value:"Source",id:"source-2",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,i.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"interface-custompicksectionitem",children:"Interface: CustomPickSectionItem"}),"\n",(0,s.jsx)(n.p,{children:"Represents an item that can be selected from\na list of items."}),"\n",(0,s.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,s.jsx)(n.h3,{id:"content",children:"content?"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:(0,s.jsx)(n.code,{children:"optional"})})," ",(0,s.jsx)(n.strong,{children:"content"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"A human-readable string which is rendered in a separate line."}),"\n",(0,s.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L1054",children:"packages/extension-api/src/extension-api.d.ts:1054"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"markdowncontent",children:"markDownContent?"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:(0,s.jsx)(n.code,{children:"optional"})})," ",(0,s.jsx)(n.strong,{children:"markDownContent"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"A human-readable string which is rendered in a separate line. (Markdown format)"}),"\n",(0,s.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L1059",children:"packages/extension-api/src/extension-api.d.ts:1059"})}),"\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:"A human-readable string which is rendered prominent."}),"\n",(0,s.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L1049",children:"packages/extension-api/src/extension-api.d.ts:1049"})})]})}function h(e={}){const{wrapper:n}={...(0,i.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>o,a:()=>r});var s=t(27378);const i={},c=s.createContext(i);function r(e){const n=s.useContext(c);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:r(e.components),s.createElement(c.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/8b4ba22f.382b0a90.js b/assets/js/8b4ba22f.354e65d0.js similarity index 89% rename from assets/js/8b4ba22f.382b0a90.js rename to assets/js/8b4ba22f.354e65d0.js index 14a3d5f6635..ca2d3e42d92 100644 --- a/assets/js/8b4ba22f.382b0a90.js +++ b/assets/js/8b4ba22f.354e65d0.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[60564],{10051:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>a,contentTitle:()=>i,default:()=>p,frontMatter:()=>s,metadata:()=>c,toc:()=>d});var t=r(24246),o=r(71670);const s={},i="Interface: CliToolUpdate",c={id:"interfaces/CliToolUpdate",title:"Interface: CliToolUpdate",description:"Properties",source:"@site/api/interfaces/CliToolUpdate.md",sourceDirName:"interfaces",slug:"/interfaces/CliToolUpdate",permalink:"/api/interfaces/CliToolUpdate",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: CliToolOptions",permalink:"/api/interfaces/CliToolOptions"},next:{title:"Interface: CliToolUpdateOptions",permalink:"/api/interfaces/CliToolUpdateOptions"}},a={},d=[{value:"Properties",id:"properties",level:2},{value:"doUpdate()",id:"doupdate",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Source",id:"source",level:4},{value:"version",id:"version",level:3},{value:"Source",id:"source-1",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,o.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"interface-clitoolupdate",children:"Interface: CliToolUpdate"}),"\n",(0,t.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,t.jsx)(n.h3,{id:"doupdate",children:"doUpdate()"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"doUpdate"}),": (",(0,t.jsx)(n.code,{children:"logger"}),") => ",(0,t.jsx)(n.code,{children:"Promise"}),"< ",(0,t.jsx)(n.code,{children:"void"})," >"]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"parameters",children:"Parameters"}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"logger"}),": ",(0,t.jsx)(n.a,{href:"/api/interfaces/Logger",children:(0,t.jsx)(n.code,{children:"Logger"})})]}),"\n",(0,t.jsx)(n.h4,{id:"returns",children:"Returns"}),"\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"Promise"}),"< ",(0,t.jsx)(n.code,{children:"void"})," >"]}),"\n",(0,t.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L4028",children:"packages/extension-api/src/extension-api.d.ts:4028"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"version",children:"version"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"version"}),": ",(0,t.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L4027",children:"packages/extension-api/src/extension-api.d.ts:4027"})})]})}function p(e={}){const{wrapper:n}={...(0,o.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},71670:(e,n,r)=>{r.d(n,{Z:()=>c,a:()=>i});var t=r(27378);const o={},s=t.createContext(o);function i(e){const n=t.useContext(s);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:i(e.components),t.createElement(s.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[60564],{10051:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>d,contentTitle:()=>i,default:()=>p,frontMatter:()=>s,metadata:()=>c,toc:()=>a});var t=r(24246),o=r(71670);const s={},i="Interface: CliToolUpdate",c={id:"interfaces/CliToolUpdate",title:"Interface: CliToolUpdate",description:"Properties",source:"@site/api/interfaces/CliToolUpdate.md",sourceDirName:"interfaces",slug:"/interfaces/CliToolUpdate",permalink:"/api/interfaces/CliToolUpdate",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: CliToolOptions",permalink:"/api/interfaces/CliToolOptions"},next:{title:"Interface: CliToolUpdateOptions",permalink:"/api/interfaces/CliToolUpdateOptions"}},d={},a=[{value:"Properties",id:"properties",level:2},{value:"doUpdate()",id:"doupdate",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Source",id:"source",level:4},{value:"version",id:"version",level:3},{value:"Source",id:"source-1",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,o.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"interface-clitoolupdate",children:"Interface: CliToolUpdate"}),"\n",(0,t.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,t.jsx)(n.h3,{id:"doupdate",children:"doUpdate()"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"doUpdate"}),": (",(0,t.jsx)(n.code,{children:"logger"}),") => ",(0,t.jsx)(n.code,{children:"Promise"}),"< ",(0,t.jsx)(n.code,{children:"void"})," >"]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"parameters",children:"Parameters"}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"logger"}),": ",(0,t.jsx)(n.a,{href:"/api/interfaces/Logger",children:(0,t.jsx)(n.code,{children:"Logger"})})]}),"\n",(0,t.jsx)(n.h4,{id:"returns",children:"Returns"}),"\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"Promise"}),"< ",(0,t.jsx)(n.code,{children:"void"})," >"]}),"\n",(0,t.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L4028",children:"packages/extension-api/src/extension-api.d.ts:4028"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"version",children:"version"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"version"}),": ",(0,t.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L4027",children:"packages/extension-api/src/extension-api.d.ts:4027"})})]})}function p(e={}){const{wrapper:n}={...(0,o.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},71670:(e,n,r)=>{r.d(n,{Z:()=>c,a:()=>i});var t=r(27378);const o={},s=t.createContext(o);function i(e){const n=t.useContext(s);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:i(e.components),t.createElement(s.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/8c6c72f9.31adf943.js b/assets/js/8c6c72f9.5f8a72f5.js similarity index 94% rename from assets/js/8c6c72f9.31adf943.js rename to assets/js/8c6c72f9.5f8a72f5.js index e690cde73c1..aa0a3da7d7a 100644 --- a/assets/js/8c6c72f9.31adf943.js +++ b/assets/js/8c6c72f9.5f8a72f5.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[63707],{49406:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>r,contentTitle:()=>c,default:()=>u,frontMatter:()=>a,metadata:()=>o,toc:()=>l});var s=n(24246),i=n(71670);const a={},c="Type alias: CheckResultLink",o={id:"type-aliases/CheckResultLink",title:"Type alias: CheckResultLink",description:"CheckResultLink: Link",source:"@site/api/type-aliases/CheckResultLink.md",sourceDirName:"type-aliases",slug:"/type-aliases/CheckResultLink",permalink:"/api/type-aliases/CheckResultLink",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: WebviewPanelOnDidChangeViewStateEvent",permalink:"/api/interfaces/WebviewPanelOnDidChangeViewStateEvent"},next:{title:"Type alias: CliToolState",permalink:"/api/type-aliases/CliToolState"}},r={},l=[{value:"Source",id:"source",level:2}];function p(e){const t={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,i.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(t.h1,{id:"type-alias-checkresultlink",children:"Type alias: CheckResultLink"}),"\n",(0,s.jsxs)(t.blockquote,{children:["\n",(0,s.jsxs)(t.p,{children:[(0,s.jsx)(t.strong,{children:"CheckResultLink"}),": ",(0,s.jsx)(t.a,{href:"/api/interfaces/Link",children:(0,s.jsx)(t.code,{children:"Link"})})]}),"\n"]}),"\n",(0,s.jsx)(t.h2,{id:"source",children:"Source"}),"\n",(0,s.jsx)(t.p,{children:(0,s.jsx)(t.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L355",children:"packages/extension-api/src/extension-api.d.ts:355"})})]})}function u(e={}){const{wrapper:t}={...(0,i.a)(),...e.components};return t?(0,s.jsx)(t,{...e,children:(0,s.jsx)(p,{...e})}):p(e)}},71670:(e,t,n)=>{n.d(t,{Z:()=>o,a:()=>c});var s=n(27378);const i={},a=s.createContext(i);function c(e){const t=s.useContext(a);return s.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function o(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:c(e.components),s.createElement(a.Provider,{value:t},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[63707],{49406:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>r,contentTitle:()=>c,default:()=>u,frontMatter:()=>a,metadata:()=>o,toc:()=>l});var s=n(24246),i=n(71670);const a={},c="Type alias: CheckResultLink",o={id:"type-aliases/CheckResultLink",title:"Type alias: CheckResultLink",description:"CheckResultLink: Link",source:"@site/api/type-aliases/CheckResultLink.md",sourceDirName:"type-aliases",slug:"/type-aliases/CheckResultLink",permalink:"/api/type-aliases/CheckResultLink",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: WebviewPanelOnDidChangeViewStateEvent",permalink:"/api/interfaces/WebviewPanelOnDidChangeViewStateEvent"},next:{title:"Type alias: CliToolState",permalink:"/api/type-aliases/CliToolState"}},r={},l=[{value:"Source",id:"source",level:2}];function p(e){const t={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,i.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(t.h1,{id:"type-alias-checkresultlink",children:"Type alias: CheckResultLink"}),"\n",(0,s.jsxs)(t.blockquote,{children:["\n",(0,s.jsxs)(t.p,{children:[(0,s.jsx)(t.strong,{children:"CheckResultLink"}),": ",(0,s.jsx)(t.a,{href:"/api/interfaces/Link",children:(0,s.jsx)(t.code,{children:"Link"})})]}),"\n"]}),"\n",(0,s.jsx)(t.h2,{id:"source",children:"Source"}),"\n",(0,s.jsx)(t.p,{children:(0,s.jsx)(t.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L355",children:"packages/extension-api/src/extension-api.d.ts:355"})})]})}function u(e={}){const{wrapper:t}={...(0,i.a)(),...e.components};return t?(0,s.jsx)(t,{...e,children:(0,s.jsx)(p,{...e})}):p(e)}},71670:(e,t,n)=>{n.d(t,{Z:()=>o,a:()=>c});var s=n(27378);const i={},a=s.createContext(i);function c(e){const t=s.useContext(a);return s.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function o(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:c(e.components),s.createElement(a.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/8c8ef21f.1b7d7278.js b/assets/js/8c8ef21f.1e58e7ca.js similarity index 90% rename from assets/js/8c8ef21f.1b7d7278.js rename to assets/js/8c8ef21f.1e58e7ca.js index 54b8c0dfdb4..4a3b8de3b8f 100644 --- a/assets/js/8c8ef21f.1b7d7278.js +++ b/assets/js/8c8ef21f.1e58e7ca.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[80954],{4706:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>c,default:()=>p,frontMatter:()=>r,metadata:()=>o,toc:()=>l});var s=t(24246),i=t(71670);const r={},c="Interface: Link",o={id:"interfaces/Link",title:"Interface: Link",description:"Properties",source:"@site/api/interfaces/Link.md",sourceDirName:"interfaces",slug:"/interfaces/Link",permalink:"/api/interfaces/Link",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: LifecycleContext",permalink:"/api/interfaces/LifecycleContext"},next:{title:"Interface: ListImagesOptions",permalink:"/api/interfaces/ListImagesOptions"}},a={},l=[{value:"Properties",id:"properties",level:2},{value:"group?",id:"group",level:3},{value:"Source",id:"source",level:4},{value:"title",id:"title",level:3},{value:"Source",id:"source-1",level:4},{value:"url",id:"url",level:3},{value:"Source",id:"source-2",level:4}];function d(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,i.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"interface-link",children:"Interface: Link"}),"\n",(0,s.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,s.jsx)(n.h3,{id:"group",children:"group?"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:(0,s.jsx)(n.code,{children:"optional"})})," ",(0,s.jsx)(n.strong,{children:"group"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L353",children:"packages/extension-api/src/extension-api.d.ts:353"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"title",children:"title"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"title"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L351",children:"packages/extension-api/src/extension-api.d.ts:351"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"url",children:"url"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"url"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L352",children:"packages/extension-api/src/extension-api.d.ts:352"})})]})}function p(e={}){const{wrapper:n}={...(0,i.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(d,{...e})}):d(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>o,a:()=>c});var s=t(27378);const i={},r=s.createContext(i);function c(e){const n=s.useContext(r);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:c(e.components),s.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[80954],{4706:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>c,default:()=>p,frontMatter:()=>r,metadata:()=>o,toc:()=>l});var s=t(24246),i=t(71670);const r={},c="Interface: Link",o={id:"interfaces/Link",title:"Interface: Link",description:"Properties",source:"@site/api/interfaces/Link.md",sourceDirName:"interfaces",slug:"/interfaces/Link",permalink:"/api/interfaces/Link",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: LifecycleContext",permalink:"/api/interfaces/LifecycleContext"},next:{title:"Interface: ListImagesOptions",permalink:"/api/interfaces/ListImagesOptions"}},a={},l=[{value:"Properties",id:"properties",level:2},{value:"group?",id:"group",level:3},{value:"Source",id:"source",level:4},{value:"title",id:"title",level:3},{value:"Source",id:"source-1",level:4},{value:"url",id:"url",level:3},{value:"Source",id:"source-2",level:4}];function d(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,i.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"interface-link",children:"Interface: Link"}),"\n",(0,s.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,s.jsx)(n.h3,{id:"group",children:"group?"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:(0,s.jsx)(n.code,{children:"optional"})})," ",(0,s.jsx)(n.strong,{children:"group"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L353",children:"packages/extension-api/src/extension-api.d.ts:353"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"title",children:"title"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"title"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L351",children:"packages/extension-api/src/extension-api.d.ts:351"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"url",children:"url"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"url"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L352",children:"packages/extension-api/src/extension-api.d.ts:352"})})]})}function p(e={}){const{wrapper:n}={...(0,i.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(d,{...e})}):d(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>o,a:()=>c});var s=t(27378);const i={},r=s.createContext(i);function c(e){const n=s.useContext(r);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:c(e.components),s.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/8cb0269b.6fffbe36.js b/assets/js/8cb0269b.7d259e69.js similarity index 91% rename from assets/js/8cb0269b.6fffbe36.js rename to assets/js/8cb0269b.7d259e69.js index 7f6346a9499..d5ad543ea90 100644 --- a/assets/js/8cb0269b.6fffbe36.js +++ b/assets/js/8cb0269b.7d259e69.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[35281],{50604:(e,s,n)=>{n.r(s),n.d(s,{assets:()=>d,contentTitle:()=>t,default:()=>o,frontMatter:()=>c,metadata:()=>h,toc:()=>l});var r=n(24246),i=n(71670);const c={},t="Class: Uri",h={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:"Class: TelemetryTrustedValue\\",permalink:"/api/classes/TelemetryTrustedValue"},next:{title:"Interface: AuditRecord",permalink:"/api/interfaces/AuditRecord"}},d={},l=[{value:"Constructors",id:"constructors",level:2},{value:"new Uri(scheme, authority, path, query, fragment)",id:"new-urischeme-authority-path-query-fragment",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Source",id:"source",level:4},{value:"Properties",id:"properties",level:2},{value:"authority",id:"authority",level:3},{value:"Source",id:"source-1",level:4},{value:"fragment",id:"fragment",level:3},{value:"Source",id:"source-2",level:4},{value:"fsPath",id:"fspath",level:3},{value:"Source",id:"source-3",level:4},{value:"path",id:"path",level:3},{value:"Source",id:"source-4",level:4},{value:"query",id:"query",level:3},{value:"Source",id:"source-5",level:4},{value:"scheme",id:"scheme",level:3},{value:"Source",id:"source-6",level:4},{value:"Methods",id:"methods",level:2},{value:"toString()",id:"tostring",level:3},{value:"Returns",id:"returns-1",level:4},{value:"Source",id:"source-7",level:4},{value:"with()",id:"with",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-2",level:4},{value:"Source",id:"source-8",level:4},{value:"file()",id:"file",level:3},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-3",level:4},{value:"Source",id:"source-9",level:4},{value:"joinPath()",id:"joinpath",level:3},{value:"Parameters",id:"parameters-3",level:4},{value:"Returns",id:"returns-4",level:4},{value:"Source",id:"source-10",level:4},{value:"parse()",id:"parse",level:3},{value:"Parameters",id:"parameters-4",level:4},{value:"Returns",id:"returns-5",level:4},{value:"See",id:"see",level:4},{value:"Source",id:"source-11",level:4}];function a(e){const s={a:"a",blockquote:"blockquote",code:"code",em:"em",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",pre:"pre",strong:"strong",...(0,i.a)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(s.h1,{id:"class-uri",children:"Class: Uri"}),"\n",(0,r.jsx)(s.p,{children:"Resource identifier for a resource"}),"\n",(0,r.jsx)(s.h2,{id:"constructors",children:"Constructors"}),"\n",(0,r.jsx)(s.h3,{id:"new-urischeme-authority-path-query-fragment",children:"new Uri(scheme, authority, path, query, fragment)"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:(0,r.jsx)(s.code,{children:"private"})})," ",(0,r.jsx)(s.strong,{children:"new Uri"}),"(",(0,r.jsx)(s.code,{children:"scheme"}),", ",(0,r.jsx)(s.code,{children:"authority"}),", ",(0,r.jsx)(s.code,{children:"path"}),", ",(0,r.jsx)(s.code,{children:"query"}),", ",(0,r.jsx)(s.code,{children:"fragment"}),"): ",(0,r.jsx)(s.a,{href:"/api/classes/Uri",children:(0,r.jsx)(s.code,{children:"Uri"})})]}),"\n"]}),"\n",(0,r.jsxs)(s.p,{children:["Use the ",(0,r.jsx)(s.code,{children:"file"})," and ",(0,r.jsx)(s.code,{children:"parse"})," factory functions to create new ",(0,r.jsx)(s.code,{children:"Uri"})," objects."]}),"\n",(0,r.jsx)(s.h4,{id:"parameters",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"scheme"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"authority"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"path"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"query"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"fragment"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.h4,{id:"returns",children:"Returns"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.a,{href:"/api/classes/Uri",children:(0,r.jsx)(s.code,{children:"Uri"})})}),"\n",(0,r.jsx)(s.h4,{id:"source",children:"Source"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L1293",children:"packages/extension-api/src/extension-api.d.ts:1293"})}),"\n",(0,r.jsx)(s.h2,{id:"properties",children:"Properties"}),"\n",(0,r.jsx)(s.h3,{id:"authority",children:"authority"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:(0,r.jsx)(s.code,{children:"readonly"})})," ",(0,r.jsx)(s.strong,{children:"authority"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsxs)(s.p,{children:["Authority is the ",(0,r.jsx)(s.code,{children:"www.example.com"})," part of ",(0,r.jsx)(s.code,{children:"http://www.example.com/some/path?query#fragment"}),".\nThe part between the first double slashes and the next slash."]}),"\n",(0,r.jsx)(s.h4,{id:"source-1",children:"Source"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L1305",children:"packages/extension-api/src/extension-api.d.ts:1305"})}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"fragment",children:"fragment"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:(0,r.jsx)(s.code,{children:"readonly"})})," ",(0,r.jsx)(s.strong,{children:"fragment"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsxs)(s.p,{children:["Fragment is the ",(0,r.jsx)(s.code,{children:"fragment"})," part of ",(0,r.jsx)(s.code,{children:"http://www.example.com/some/path?query#fragment"}),"."]}),"\n",(0,r.jsx)(s.h4,{id:"source-2",children:"Source"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L1325",children:"packages/extension-api/src/extension-api.d.ts:1325"})}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"fspath",children:"fsPath"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:(0,r.jsx)(s.code,{children:"readonly"})})," ",(0,r.jsx)(s.strong,{children:"fsPath"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"The string representing the corresponding file system path of this Uri."}),"\n",(0,r.jsx)(s.h4,{id:"source-3",children:"Source"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L1315",children:"packages/extension-api/src/extension-api.d.ts:1315"})}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"path",children:"path"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:(0,r.jsx)(s.code,{children:"readonly"})})," ",(0,r.jsx)(s.strong,{children:"path"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsxs)(s.p,{children:["Path is the ",(0,r.jsx)(s.code,{children:"/some/path"})," part of ",(0,r.jsx)(s.code,{children:"http://www.example.com/some/path?query#fragment"}),"."]}),"\n",(0,r.jsx)(s.h4,{id:"source-4",children:"Source"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L1310",children:"packages/extension-api/src/extension-api.d.ts:1310"})}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"query",children:"query"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:(0,r.jsx)(s.code,{children:"readonly"})})," ",(0,r.jsx)(s.strong,{children:"query"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsxs)(s.p,{children:["Query is the ",(0,r.jsx)(s.code,{children:"query"})," part of ",(0,r.jsx)(s.code,{children:"http://www.example.com/some/path?query#fragment"}),"."]}),"\n",(0,r.jsx)(s.h4,{id:"source-5",children:"Source"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L1320",children:"packages/extension-api/src/extension-api.d.ts:1320"})}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"scheme",children:"scheme"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:(0,r.jsx)(s.code,{children:"readonly"})})," ",(0,r.jsx)(s.strong,{children:"scheme"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsxs)(s.p,{children:["Scheme is the ",(0,r.jsx)(s.code,{children:"http"})," part of ",(0,r.jsx)(s.code,{children:"http://www.example.com/some/path?query#fragment"}),".\nThe part before the first colon."]}),"\n",(0,r.jsx)(s.h4,{id:"source-6",children:"Source"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L1299",children:"packages/extension-api/src/extension-api.d.ts:1299"})}),"\n",(0,r.jsx)(s.h2,{id:"methods",children:"Methods"}),"\n",(0,r.jsx)(s.h3,{id:"tostring",children:"toString()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"toString"}),"(): ",(0,r.jsx)(s.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(s.h4,{id:"returns-1",children:"Returns"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.code,{children:"string"})}),"\n",(0,r.jsx)(s.h4,{id:"source-7",children:"Source"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L1364",children:"packages/extension-api/src/extension-api.d.ts:1364"})}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"with",children:"with()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"with"}),"(",(0,r.jsx)(s.code,{children:"change"}),"): ",(0,r.jsx)(s.a,{href:"/api/classes/Uri",children:(0,r.jsx)(s.code,{children:"Uri"})})]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Derive a new Uri from this Uri."}),"\n",(0,r.jsx)(s.pre,{children:(0,r.jsx)(s.code,{className:"language-ts",children:"const foo = Uri.parse('http://foo');\nconst httpsFoo = foo.with({ scheme: 'https' });\n// httpsFoo is now 'https://foo'\n"})}),"\n",(0,r.jsx)(s.h4,{id:"parameters-1",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"change"})]}),"\n",(0,r.jsxs)(s.p,{children:["An object that describes a change to this Uri. To unset components use ",(0,r.jsx)(s.code,{children:"undefined"})," or\nthe empty string."]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"change.authority?"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:"The new authority, defaults to this Uri's authority."}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"change.fragment?"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:"The new fragment, defaults to this Uri's fragment."}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"change.path?"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:"The new path, defaults to this Uri's path."}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"change.query?"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:"The new query, defaults to this Uri's query."}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"change.scheme?"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:"The new scheme, defaults to this Uri's scheme."}),"\n",(0,r.jsx)(s.h4,{id:"returns-2",children:"Returns"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.a,{href:"/api/classes/Uri",children:(0,r.jsx)(s.code,{children:"Uri"})})}),"\n",(0,r.jsxs)(s.p,{children:["A new Uri that reflects the given change. Will return ",(0,r.jsx)(s.code,{children:"this"})," Uri if the change\nis not changing anything."]}),"\n",(0,r.jsx)(s.h4,{id:"source-8",children:"Source"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L1341",children:"packages/extension-api/src/extension-api.d.ts:1341"})}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"file",children:"file()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:(0,r.jsx)(s.code,{children:"static"})})," ",(0,r.jsx)(s.strong,{children:"file"}),"(",(0,r.jsx)(s.code,{children:"path"}),"): ",(0,r.jsx)(s.a,{href:"/api/classes/Uri",children:(0,r.jsx)(s.code,{children:"Uri"})})]}),"\n"]}),"\n",(0,r.jsxs)(s.p,{children:["Create an URI from a file system path. The ",(0,r.jsx)(s.a,{href:"/api/classes/Uri#scheme",children:"scheme"}),"\nwill be ",(0,r.jsx)(s.code,{children:"file"}),"."]}),"\n",(0,r.jsx)(s.h4,{id:"parameters-2",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"path"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-3",children:"Returns"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.a,{href:"/api/classes/Uri",children:(0,r.jsx)(s.code,{children:"Uri"})})}),"\n",(0,r.jsx)(s.h4,{id:"source-9",children:"Source"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L1278",children:"packages/extension-api/src/extension-api.d.ts:1278"})}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"joinpath",children:"joinPath()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:(0,r.jsx)(s.code,{children:"static"})})," ",(0,r.jsx)(s.strong,{children:"joinPath"}),"(",(0,r.jsx)(s.code,{children:"base"}),", ...",(0,r.jsx)(s.code,{children:"pathSegments"}),"): ",(0,r.jsx)(s.a,{href:"/api/classes/Uri",children:(0,r.jsx)(s.code,{children:"Uri"})})]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Create a new uri which path is the result of joining\nthe path of the base uri with the provided path segments."}),"\n",(0,r.jsx)(s.h4,{id:"parameters-3",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"base"}),": ",(0,r.jsx)(s.a,{href:"/api/classes/Uri",children:(0,r.jsx)(s.code,{children:"Uri"})})]}),"\n",(0,r.jsx)(s.p,{children:"An uri. Must have a path."}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ...",(0,r.jsx)(s.strong,{children:"pathSegments"}),": ",(0,r.jsx)(s.code,{children:"string"}),"[]"]}),"\n",(0,r.jsx)(s.p,{children:"One more more path fragments"}),"\n",(0,r.jsx)(s.h4,{id:"returns-4",children:"Returns"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.a,{href:"/api/classes/Uri",children:(0,r.jsx)(s.code,{children:"Uri"})})}),"\n",(0,r.jsx)(s.p,{children:"A new uri which path is joined with the given fragments"}),"\n",(0,r.jsx)(s.h4,{id:"source-10",children:"Source"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L1288",children:"packages/extension-api/src/extension-api.d.ts:1288"})}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"parse",children:"parse()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:(0,r.jsx)(s.code,{children:"static"})})," ",(0,r.jsx)(s.strong,{children:"parse"}),"(",(0,r.jsx)(s.code,{children:"value"}),", ",(0,r.jsx)(s.code,{children:"strict"}),"?): ",(0,r.jsx)(s.a,{href:"/api/classes/Uri",children:(0,r.jsx)(s.code,{children:"Uri"})})]}),"\n"]}),"\n",(0,r.jsxs)(s.p,{children:["Create an URI from a string, e.g. ",(0,r.jsx)(s.code,{children:"http://www.example.com/some/path"}),",\n",(0,r.jsx)(s.code,{children:"file:///usr/home"}),", or ",(0,r.jsx)(s.code,{children:"scheme:with/path"}),"."]}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.em,{children:"Note"})," that for a while uris without a ",(0,r.jsx)(s.code,{children:"scheme"})," were accepted. That is not correct\nas all uris should have a scheme. To avoid breakage of existing code the optional\n",(0,r.jsx)(s.code,{children:"strict"}),"-argument has been added. We ",(0,r.jsx)(s.em,{children:"strongly"})," advise to use it, e.g. ",(0,r.jsx)(s.code,{children:"Uri.parse('my:uri', true)"})]}),"\n",(0,r.jsx)(s.h4,{id:"parameters-4",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"value"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:"The string value of an Uri."}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"strict?"}),": ",(0,r.jsx)(s.code,{children:"boolean"})]}),"\n",(0,r.jsxs)(s.p,{children:["Throw an error when ",(0,r.jsx)(s.code,{children:"value"})," is empty or when no ",(0,r.jsx)(s.code,{children:"scheme"})," can be parsed."]}),"\n",(0,r.jsx)(s.h4,{id:"returns-5",children:"Returns"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.a,{href:"/api/classes/Uri",children:(0,r.jsx)(s.code,{children:"Uri"})})}),"\n",(0,r.jsx)(s.p,{children:"A new Uri instance."}),"\n",(0,r.jsx)(s.h4,{id:"see",children:"See"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.a,{href:"/api/classes/Uri#tostring",children:"Uri.toString"})}),"\n",(0,r.jsx)(s.h4,{id:"source-11",children:"Source"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L1272",children:"packages/extension-api/src/extension-api.d.ts:1272"})})]})}function o(e={}){const{wrapper:s}={...(0,i.a)(),...e.components};return s?(0,r.jsx)(s,{...e,children:(0,r.jsx)(a,{...e})}):a(e)}},71670:(e,s,n)=>{n.d(s,{Z:()=>h,a:()=>t});var r=n(27378);const i={},c=r.createContext(i);function t(e){const s=r.useContext(c);return r.useMemo((function(){return"function"==typeof e?e(s):{...s,...e}}),[s,e])}function h(e){let s;return s=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:t(e.components),r.createElement(c.Provider,{value:s},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[35281],{50604:(e,s,n)=>{n.r(s),n.d(s,{assets:()=>h,contentTitle:()=>t,default:()=>a,frontMatter:()=>c,metadata:()=>d,toc:()=>l});var r=n(24246),i=n(71670);const c={},t="Class: Uri",d={id:"classes/Uri",title:"Class: Uri",description:"Resource identifier for a resource",source:"@site/api/classes/Uri.md",sourceDirName:"classes",slug:"/classes/Uri",permalink:"/api/classes/Uri",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Class: TelemetryTrustedValue\\",permalink:"/api/classes/TelemetryTrustedValue"},next:{title:"Interface: AuditRecord",permalink:"/api/interfaces/AuditRecord"}},h={},l=[{value:"Constructors",id:"constructors",level:2},{value:"new Uri(scheme, authority, path, query, fragment)",id:"new-urischeme-authority-path-query-fragment",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Source",id:"source",level:4},{value:"Properties",id:"properties",level:2},{value:"authority",id:"authority",level:3},{value:"Source",id:"source-1",level:4},{value:"fragment",id:"fragment",level:3},{value:"Source",id:"source-2",level:4},{value:"fsPath",id:"fspath",level:3},{value:"Source",id:"source-3",level:4},{value:"path",id:"path",level:3},{value:"Source",id:"source-4",level:4},{value:"query",id:"query",level:3},{value:"Source",id:"source-5",level:4},{value:"scheme",id:"scheme",level:3},{value:"Source",id:"source-6",level:4},{value:"Methods",id:"methods",level:2},{value:"toString()",id:"tostring",level:3},{value:"Returns",id:"returns-1",level:4},{value:"Source",id:"source-7",level:4},{value:"with()",id:"with",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-2",level:4},{value:"Source",id:"source-8",level:4},{value:"file()",id:"file",level:3},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-3",level:4},{value:"Source",id:"source-9",level:4},{value:"joinPath()",id:"joinpath",level:3},{value:"Parameters",id:"parameters-3",level:4},{value:"Returns",id:"returns-4",level:4},{value:"Source",id:"source-10",level:4},{value:"parse()",id:"parse",level:3},{value:"Parameters",id:"parameters-4",level:4},{value:"Returns",id:"returns-5",level:4},{value:"See",id:"see",level:4},{value:"Source",id:"source-11",level:4}];function o(e){const s={a:"a",blockquote:"blockquote",code:"code",em:"em",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",pre:"pre",strong:"strong",...(0,i.a)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(s.h1,{id:"class-uri",children:"Class: Uri"}),"\n",(0,r.jsx)(s.p,{children:"Resource identifier for a resource"}),"\n",(0,r.jsx)(s.h2,{id:"constructors",children:"Constructors"}),"\n",(0,r.jsx)(s.h3,{id:"new-urischeme-authority-path-query-fragment",children:"new Uri(scheme, authority, path, query, fragment)"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:(0,r.jsx)(s.code,{children:"private"})})," ",(0,r.jsx)(s.strong,{children:"new Uri"}),"(",(0,r.jsx)(s.code,{children:"scheme"}),", ",(0,r.jsx)(s.code,{children:"authority"}),", ",(0,r.jsx)(s.code,{children:"path"}),", ",(0,r.jsx)(s.code,{children:"query"}),", ",(0,r.jsx)(s.code,{children:"fragment"}),"): ",(0,r.jsx)(s.a,{href:"/api/classes/Uri",children:(0,r.jsx)(s.code,{children:"Uri"})})]}),"\n"]}),"\n",(0,r.jsxs)(s.p,{children:["Use the ",(0,r.jsx)(s.code,{children:"file"})," and ",(0,r.jsx)(s.code,{children:"parse"})," factory functions to create new ",(0,r.jsx)(s.code,{children:"Uri"})," objects."]}),"\n",(0,r.jsx)(s.h4,{id:"parameters",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"scheme"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"authority"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"path"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"query"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"fragment"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.h4,{id:"returns",children:"Returns"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.a,{href:"/api/classes/Uri",children:(0,r.jsx)(s.code,{children:"Uri"})})}),"\n",(0,r.jsx)(s.h4,{id:"source",children:"Source"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L1293",children:"packages/extension-api/src/extension-api.d.ts:1293"})}),"\n",(0,r.jsx)(s.h2,{id:"properties",children:"Properties"}),"\n",(0,r.jsx)(s.h3,{id:"authority",children:"authority"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:(0,r.jsx)(s.code,{children:"readonly"})})," ",(0,r.jsx)(s.strong,{children:"authority"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsxs)(s.p,{children:["Authority is the ",(0,r.jsx)(s.code,{children:"www.example.com"})," part of ",(0,r.jsx)(s.code,{children:"http://www.example.com/some/path?query#fragment"}),".\nThe part between the first double slashes and the next slash."]}),"\n",(0,r.jsx)(s.h4,{id:"source-1",children:"Source"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L1305",children:"packages/extension-api/src/extension-api.d.ts:1305"})}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"fragment",children:"fragment"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:(0,r.jsx)(s.code,{children:"readonly"})})," ",(0,r.jsx)(s.strong,{children:"fragment"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsxs)(s.p,{children:["Fragment is the ",(0,r.jsx)(s.code,{children:"fragment"})," part of ",(0,r.jsx)(s.code,{children:"http://www.example.com/some/path?query#fragment"}),"."]}),"\n",(0,r.jsx)(s.h4,{id:"source-2",children:"Source"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L1325",children:"packages/extension-api/src/extension-api.d.ts:1325"})}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"fspath",children:"fsPath"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:(0,r.jsx)(s.code,{children:"readonly"})})," ",(0,r.jsx)(s.strong,{children:"fsPath"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"The string representing the corresponding file system path of this Uri."}),"\n",(0,r.jsx)(s.h4,{id:"source-3",children:"Source"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L1315",children:"packages/extension-api/src/extension-api.d.ts:1315"})}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"path",children:"path"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:(0,r.jsx)(s.code,{children:"readonly"})})," ",(0,r.jsx)(s.strong,{children:"path"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsxs)(s.p,{children:["Path is the ",(0,r.jsx)(s.code,{children:"/some/path"})," part of ",(0,r.jsx)(s.code,{children:"http://www.example.com/some/path?query#fragment"}),"."]}),"\n",(0,r.jsx)(s.h4,{id:"source-4",children:"Source"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L1310",children:"packages/extension-api/src/extension-api.d.ts:1310"})}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"query",children:"query"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:(0,r.jsx)(s.code,{children:"readonly"})})," ",(0,r.jsx)(s.strong,{children:"query"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsxs)(s.p,{children:["Query is the ",(0,r.jsx)(s.code,{children:"query"})," part of ",(0,r.jsx)(s.code,{children:"http://www.example.com/some/path?query#fragment"}),"."]}),"\n",(0,r.jsx)(s.h4,{id:"source-5",children:"Source"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L1320",children:"packages/extension-api/src/extension-api.d.ts:1320"})}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"scheme",children:"scheme"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:(0,r.jsx)(s.code,{children:"readonly"})})," ",(0,r.jsx)(s.strong,{children:"scheme"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsxs)(s.p,{children:["Scheme is the ",(0,r.jsx)(s.code,{children:"http"})," part of ",(0,r.jsx)(s.code,{children:"http://www.example.com/some/path?query#fragment"}),".\nThe part before the first colon."]}),"\n",(0,r.jsx)(s.h4,{id:"source-6",children:"Source"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L1299",children:"packages/extension-api/src/extension-api.d.ts:1299"})}),"\n",(0,r.jsx)(s.h2,{id:"methods",children:"Methods"}),"\n",(0,r.jsx)(s.h3,{id:"tostring",children:"toString()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"toString"}),"(): ",(0,r.jsx)(s.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(s.h4,{id:"returns-1",children:"Returns"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.code,{children:"string"})}),"\n",(0,r.jsx)(s.h4,{id:"source-7",children:"Source"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L1364",children:"packages/extension-api/src/extension-api.d.ts:1364"})}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"with",children:"with()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"with"}),"(",(0,r.jsx)(s.code,{children:"change"}),"): ",(0,r.jsx)(s.a,{href:"/api/classes/Uri",children:(0,r.jsx)(s.code,{children:"Uri"})})]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Derive a new Uri from this Uri."}),"\n",(0,r.jsx)(s.pre,{children:(0,r.jsx)(s.code,{className:"language-ts",children:"const foo = Uri.parse('http://foo');\nconst httpsFoo = foo.with({ scheme: 'https' });\n// httpsFoo is now 'https://foo'\n"})}),"\n",(0,r.jsx)(s.h4,{id:"parameters-1",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"change"})]}),"\n",(0,r.jsxs)(s.p,{children:["An object that describes a change to this Uri. To unset components use ",(0,r.jsx)(s.code,{children:"undefined"})," or\nthe empty string."]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"change.authority?"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:"The new authority, defaults to this Uri's authority."}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"change.fragment?"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:"The new fragment, defaults to this Uri's fragment."}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"change.path?"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:"The new path, defaults to this Uri's path."}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"change.query?"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:"The new query, defaults to this Uri's query."}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"change.scheme?"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:"The new scheme, defaults to this Uri's scheme."}),"\n",(0,r.jsx)(s.h4,{id:"returns-2",children:"Returns"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.a,{href:"/api/classes/Uri",children:(0,r.jsx)(s.code,{children:"Uri"})})}),"\n",(0,r.jsxs)(s.p,{children:["A new Uri that reflects the given change. Will return ",(0,r.jsx)(s.code,{children:"this"})," Uri if the change\nis not changing anything."]}),"\n",(0,r.jsx)(s.h4,{id:"source-8",children:"Source"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L1341",children:"packages/extension-api/src/extension-api.d.ts:1341"})}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"file",children:"file()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:(0,r.jsx)(s.code,{children:"static"})})," ",(0,r.jsx)(s.strong,{children:"file"}),"(",(0,r.jsx)(s.code,{children:"path"}),"): ",(0,r.jsx)(s.a,{href:"/api/classes/Uri",children:(0,r.jsx)(s.code,{children:"Uri"})})]}),"\n"]}),"\n",(0,r.jsxs)(s.p,{children:["Create an URI from a file system path. The ",(0,r.jsx)(s.a,{href:"/api/classes/Uri#scheme",children:"scheme"}),"\nwill be ",(0,r.jsx)(s.code,{children:"file"}),"."]}),"\n",(0,r.jsx)(s.h4,{id:"parameters-2",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"path"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-3",children:"Returns"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.a,{href:"/api/classes/Uri",children:(0,r.jsx)(s.code,{children:"Uri"})})}),"\n",(0,r.jsx)(s.h4,{id:"source-9",children:"Source"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L1278",children:"packages/extension-api/src/extension-api.d.ts:1278"})}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"joinpath",children:"joinPath()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:(0,r.jsx)(s.code,{children:"static"})})," ",(0,r.jsx)(s.strong,{children:"joinPath"}),"(",(0,r.jsx)(s.code,{children:"base"}),", ...",(0,r.jsx)(s.code,{children:"pathSegments"}),"): ",(0,r.jsx)(s.a,{href:"/api/classes/Uri",children:(0,r.jsx)(s.code,{children:"Uri"})})]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Create a new uri which path is the result of joining\nthe path of the base uri with the provided path segments."}),"\n",(0,r.jsx)(s.h4,{id:"parameters-3",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"base"}),": ",(0,r.jsx)(s.a,{href:"/api/classes/Uri",children:(0,r.jsx)(s.code,{children:"Uri"})})]}),"\n",(0,r.jsx)(s.p,{children:"An uri. Must have a path."}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ...",(0,r.jsx)(s.strong,{children:"pathSegments"}),": ",(0,r.jsx)(s.code,{children:"string"}),"[]"]}),"\n",(0,r.jsx)(s.p,{children:"One more more path fragments"}),"\n",(0,r.jsx)(s.h4,{id:"returns-4",children:"Returns"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.a,{href:"/api/classes/Uri",children:(0,r.jsx)(s.code,{children:"Uri"})})}),"\n",(0,r.jsx)(s.p,{children:"A new uri which path is joined with the given fragments"}),"\n",(0,r.jsx)(s.h4,{id:"source-10",children:"Source"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L1288",children:"packages/extension-api/src/extension-api.d.ts:1288"})}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"parse",children:"parse()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:(0,r.jsx)(s.code,{children:"static"})})," ",(0,r.jsx)(s.strong,{children:"parse"}),"(",(0,r.jsx)(s.code,{children:"value"}),", ",(0,r.jsx)(s.code,{children:"strict"}),"?): ",(0,r.jsx)(s.a,{href:"/api/classes/Uri",children:(0,r.jsx)(s.code,{children:"Uri"})})]}),"\n"]}),"\n",(0,r.jsxs)(s.p,{children:["Create an URI from a string, e.g. ",(0,r.jsx)(s.code,{children:"http://www.example.com/some/path"}),",\n",(0,r.jsx)(s.code,{children:"file:///usr/home"}),", or ",(0,r.jsx)(s.code,{children:"scheme:with/path"}),"."]}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.em,{children:"Note"})," that for a while uris without a ",(0,r.jsx)(s.code,{children:"scheme"})," were accepted. That is not correct\nas all uris should have a scheme. To avoid breakage of existing code the optional\n",(0,r.jsx)(s.code,{children:"strict"}),"-argument has been added. We ",(0,r.jsx)(s.em,{children:"strongly"})," advise to use it, e.g. ",(0,r.jsx)(s.code,{children:"Uri.parse('my:uri', true)"})]}),"\n",(0,r.jsx)(s.h4,{id:"parameters-4",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"value"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:"The string value of an Uri."}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"strict?"}),": ",(0,r.jsx)(s.code,{children:"boolean"})]}),"\n",(0,r.jsxs)(s.p,{children:["Throw an error when ",(0,r.jsx)(s.code,{children:"value"})," is empty or when no ",(0,r.jsx)(s.code,{children:"scheme"})," can be parsed."]}),"\n",(0,r.jsx)(s.h4,{id:"returns-5",children:"Returns"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.a,{href:"/api/classes/Uri",children:(0,r.jsx)(s.code,{children:"Uri"})})}),"\n",(0,r.jsx)(s.p,{children:"A new Uri instance."}),"\n",(0,r.jsx)(s.h4,{id:"see",children:"See"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.a,{href:"/api/classes/Uri#tostring",children:"Uri.toString"})}),"\n",(0,r.jsx)(s.h4,{id:"source-11",children:"Source"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L1272",children:"packages/extension-api/src/extension-api.d.ts:1272"})})]})}function a(e={}){const{wrapper:s}={...(0,i.a)(),...e.components};return s?(0,r.jsx)(s,{...e,children:(0,r.jsx)(o,{...e})}):o(e)}},71670:(e,s,n)=>{n.d(s,{Z:()=>d,a:()=>t});var r=n(27378);const i={},c=r.createContext(i);function t(e){const s=r.useContext(c);return r.useMemo((function(){return"function"==typeof e?e(s):{...s,...e}}),[s,e])}function d(e){let s;return s=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:t(e.components),r.createElement(c.Provider,{value:s},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/8ccdb99f.cd5305ea.js b/assets/js/8ccdb99f.6dd4865a.js similarity index 83% rename from assets/js/8ccdb99f.cd5305ea.js rename to assets/js/8ccdb99f.6dd4865a.js index 0842ccfeb54..530a47f48ef 100644 --- a/assets/js/8ccdb99f.cd5305ea.js +++ b/assets/js/8ccdb99f.6dd4865a.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[6639],{70593:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>r,contentTitle:()=>c,default:()=>p,frontMatter:()=>i,metadata:()=>a,toc:()=>l});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:"Type alias: MountConfig",permalink:"/api/type-aliases/MountConfig"},next:{title:"Type alias: MountPropagation",permalink:"/api/type-aliases/MountPropagation"}},r={},l=[{value:"Source",id:"source",level:2}];function d(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,o.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"type-alias-mountconsistency",children:"Type alias: MountConsistency"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"MountConsistency"}),": ",(0,s.jsx)(n.code,{children:'"default"'})," | ",(0,s.jsx)(n.code,{children:'"consistent"'})," | ",(0,s.jsx)(n.code,{children:'"cached"'})," | ",(0,s.jsx)(n.code,{children:'"delegated"'})]}),"\n"]}),"\n",(0,s.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2090",children:"packages/extension-api/src/extension-api.d.ts:2090"})})]})}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:()=>a,a:()=>c});var s=t(27378);const o={},i=s.createContext(o);function c(e){const n=s.useContext(i);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function a(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:c(e.components),s.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[6639],{70593:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>r,contentTitle:()=>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:"Type alias: MountConfig",permalink:"/api/type-aliases/MountConfig"},next:{title:"Type alias: MountPropagation",permalink:"/api/type-aliases/MountPropagation"}},r={},d=[{value:"Source",id:"source",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,o.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"type-alias-mountconsistency",children:"Type alias: MountConsistency"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"MountConsistency"}),": ",(0,s.jsx)(n.code,{children:'"default"'})," | ",(0,s.jsx)(n.code,{children:'"consistent"'})," | ",(0,s.jsx)(n.code,{children:'"cached"'})," | ",(0,s.jsx)(n.code,{children:'"delegated"'})]}),"\n"]}),"\n",(0,s.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2090",children:"packages/extension-api/src/extension-api.d.ts:2090"})})]})}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.53547e7f.js b/assets/js/8dbb6800.33f9cde6.js similarity index 95% rename from assets/js/8dbb6800.53547e7f.js rename to assets/js/8dbb6800.33f9cde6.js index dbab0957769..990234d2e02 100644 --- a/assets/js/8dbb6800.53547e7f.js +++ b/assets/js/8dbb6800.33f9cde6.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[46738],{71773:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>a,contentTitle:()=>c,default:()=>d,frontMatter:()=>i,metadata:()=>r,toc:()=>l});var t=s(24246),o=s(71670);const i={},c="Function: listVolumes()",r={id:"namespaces/containerEngine/functions/listVolumes",title:"Function: listVolumes()",description:"listVolumes(): Promise\\",source:"@site/api/namespaces/containerEngine/functions/listVolumes.md",sourceDirName:"namespaces/containerEngine/functions",slug:"/namespaces/containerEngine/functions/listVolumes",permalink:"/api/namespaces/containerEngine/functions/listVolumes",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Function: listPods()",permalink:"/api/namespaces/containerEngine/functions/listPods"},next:{title:"Function: logsContainer()",permalink:"/api/namespaces/containerEngine/functions/logsContainer"}},a={},l=[{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function u(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,o.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"function-listvolumes",children:"Function: listVolumes()"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"listVolumes"}),"(): ",(0,t.jsx)(n.code,{children:"Promise"}),"< ",(0,t.jsx)(n.a,{href:"/api/interfaces/VolumeListInfo",children:(0,t.jsx)(n.code,{children:"VolumeListInfo"})}),"[] >"]}),"\n"]}),"\n",(0,t.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"Promise"}),"< ",(0,t.jsx)(n.a,{href:"/api/interfaces/VolumeListInfo",children:(0,t.jsx)(n.code,{children:"VolumeListInfo"})}),"[] >"]}),"\n",(0,t.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L3370",children:"packages/extension-api/src/extension-api.d.ts:3370"})})]})}function d(e={}){const{wrapper:n}={...(0,o.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(u,{...e})}):u(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>r,a:()=>c});var t=s(27378);const o={},i=t.createContext(o);function c(e){const n=t.useContext(i);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function r(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:c(e.components),t.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[46738],{71773:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>a,contentTitle:()=>c,default:()=>d,frontMatter:()=>i,metadata:()=>r,toc:()=>l});var t=s(24246),o=s(71670);const i={},c="Function: listVolumes()",r={id:"namespaces/containerEngine/functions/listVolumes",title:"Function: listVolumes()",description:"listVolumes(): Promise\\",source:"@site/api/namespaces/containerEngine/functions/listVolumes.md",sourceDirName:"namespaces/containerEngine/functions",slug:"/namespaces/containerEngine/functions/listVolumes",permalink:"/api/namespaces/containerEngine/functions/listVolumes",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Function: listPods()",permalink:"/api/namespaces/containerEngine/functions/listPods"},next:{title:"Function: logsContainer()",permalink:"/api/namespaces/containerEngine/functions/logsContainer"}},a={},l=[{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function u(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,o.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"function-listvolumes",children:"Function: listVolumes()"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"listVolumes"}),"(): ",(0,t.jsx)(n.code,{children:"Promise"}),"< ",(0,t.jsx)(n.a,{href:"/api/interfaces/VolumeListInfo",children:(0,t.jsx)(n.code,{children:"VolumeListInfo"})}),"[] >"]}),"\n"]}),"\n",(0,t.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"Promise"}),"< ",(0,t.jsx)(n.a,{href:"/api/interfaces/VolumeListInfo",children:(0,t.jsx)(n.code,{children:"VolumeListInfo"})}),"[] >"]}),"\n",(0,t.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L3370",children:"packages/extension-api/src/extension-api.d.ts:3370"})})]})}function d(e={}){const{wrapper:n}={...(0,o.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(u,{...e})}):u(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>r,a:()=>c});var t=s(27378);const o={},i=t.createContext(o);function c(e){const n=t.useContext(i);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function r(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:c(e.components),t.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/8eeedb31.7e594d7c.js b/assets/js/8eeedb31.844b4391.js similarity index 95% rename from assets/js/8eeedb31.7e594d7c.js rename to assets/js/8eeedb31.844b4391.js index 620eda80be1..103cf251be1 100644 --- a/assets/js/8eeedb31.7e594d7c.js +++ b/assets/js/8eeedb31.844b4391.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[28682],{50174:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>o,contentTitle:()=>r,default:()=>h,frontMatter:()=>s,metadata:()=>c,toc:()=>l});var i=t(24246),a=t(71670);const s={},r="Interface: WebviewPanelOnDidChangeViewStateEvent",c={id:"interfaces/WebviewPanelOnDidChangeViewStateEvent",title:"Interface: WebviewPanelOnDidChangeViewStateEvent",description:"Event fired when a webview panel's view state changes.",source:"@site/api/interfaces/WebviewPanelOnDidChangeViewStateEvent.md",sourceDirName:"interfaces",slug:"/interfaces/WebviewPanelOnDidChangeViewStateEvent",permalink:"/api/interfaces/WebviewPanelOnDidChangeViewStateEvent",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: WebviewPanel",permalink:"/api/interfaces/WebviewPanel"},next:{title:"Type alias: CheckResultLink",permalink:"/api/type-aliases/CheckResultLink"}},o={},l=[{value:"Properties",id:"properties",level:2},{value:"webviewPanel",id:"webviewpanel",level:3},{value:"Source",id:"source",level:4}];function d(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",p:"p",strong:"strong",...(0,a.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"interface-webviewpanelondidchangeviewstateevent",children:"Interface: WebviewPanelOnDidChangeViewStateEvent"}),"\n",(0,i.jsx)(n.p,{children:"Event fired when a webview panel's view state changes."}),"\n",(0,i.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(n.h3,{id:"webviewpanel",children:"webviewPanel"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"readonly"})})," ",(0,i.jsx)(n.strong,{children:"webviewPanel"}),": ",(0,i.jsx)(n.a,{href:"/api/interfaces/WebviewPanel",children:(0,i.jsx)(n.code,{children:"WebviewPanel"})})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Webview panel whose view state changed."}),"\n",(0,i.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L1580",children:"packages/extension-api/src/extension-api.d.ts:1580"})})]})}function h(e={}){const{wrapper:n}={...(0,a.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(d,{...e})}):d(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>c,a:()=>r});var i=t(27378);const a={},s=i.createContext(a);function r(e){const n=i.useContext(s);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(a):e.components||a:r(e.components),i.createElement(s.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[28682],{50174:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>o,contentTitle:()=>r,default:()=>h,frontMatter:()=>s,metadata:()=>c,toc:()=>l});var i=t(24246),a=t(71670);const s={},r="Interface: WebviewPanelOnDidChangeViewStateEvent",c={id:"interfaces/WebviewPanelOnDidChangeViewStateEvent",title:"Interface: WebviewPanelOnDidChangeViewStateEvent",description:"Event fired when a webview panel's view state changes.",source:"@site/api/interfaces/WebviewPanelOnDidChangeViewStateEvent.md",sourceDirName:"interfaces",slug:"/interfaces/WebviewPanelOnDidChangeViewStateEvent",permalink:"/api/interfaces/WebviewPanelOnDidChangeViewStateEvent",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: WebviewPanel",permalink:"/api/interfaces/WebviewPanel"},next:{title:"Type alias: CheckResultLink",permalink:"/api/type-aliases/CheckResultLink"}},o={},l=[{value:"Properties",id:"properties",level:2},{value:"webviewPanel",id:"webviewpanel",level:3},{value:"Source",id:"source",level:4}];function d(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",p:"p",strong:"strong",...(0,a.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"interface-webviewpanelondidchangeviewstateevent",children:"Interface: WebviewPanelOnDidChangeViewStateEvent"}),"\n",(0,i.jsx)(n.p,{children:"Event fired when a webview panel's view state changes."}),"\n",(0,i.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(n.h3,{id:"webviewpanel",children:"webviewPanel"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"readonly"})})," ",(0,i.jsx)(n.strong,{children:"webviewPanel"}),": ",(0,i.jsx)(n.a,{href:"/api/interfaces/WebviewPanel",children:(0,i.jsx)(n.code,{children:"WebviewPanel"})})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Webview panel whose view state changed."}),"\n",(0,i.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L1580",children:"packages/extension-api/src/extension-api.d.ts:1580"})})]})}function h(e={}){const{wrapper:n}={...(0,a.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(d,{...e})}):d(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>c,a:()=>r});var i=t(27378);const a={},s=i.createContext(a);function r(e){const n=i.useContext(s);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(a):e.components||a:r(e.components),i.createElement(s.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/905702d2.392ffcd7.js b/assets/js/905702d2.04a3dd7a.js similarity index 95% rename from assets/js/905702d2.392ffcd7.js rename to assets/js/905702d2.04a3dd7a.js index 403f12dcc0a..7d435fca261 100644 --- a/assets/js/905702d2.392ffcd7.js +++ b/assets/js/905702d2.04a3dd7a.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[38056],{85316:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>o,contentTitle:()=>a,default:()=>l,frontMatter:()=>i,metadata:()=>c,toc:()=>u});var s=t(24246),r=t(71670);const i={},a="Function: registerMenuItem()",c={id:"namespaces/tray/functions/registerMenuItem",title:"Function: registerMenuItem()",description:"registerMenuItem(item): Disposable",source:"@site/api/namespaces/tray/functions/registerMenuItem.md",sourceDirName:"namespaces/tray/functions",slug:"/namespaces/tray/functions/registerMenuItem",permalink:"/api/namespaces/tray/functions/registerMenuItem",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Namespace: tray",permalink:"/api/namespaces/tray/"},next:{title:"Function: registerProviderMenuItem()",permalink:"/api/namespaces/tray/functions/registerProviderMenuItem"}},o={},u=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function d(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,r.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"function-registermenuitem",children:"Function: registerMenuItem()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"registerMenuItem"}),"(",(0,s.jsx)(n.code,{children:"item"}),"): ",(0,s.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,s.jsx)(n.code,{children:"Disposable"})})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Creates a menu not related to a Provider"}),"\n",(0,s.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"item"}),": ",(0,s.jsx)(n.a,{href:"/api/interfaces/MenuItem",children:(0,s.jsx)(n.code,{children:"MenuItem"})})]}),"\n",(0,s.jsx)(n.p,{children:"the item to add in the tray menu"}),"\n",(0,s.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,s.jsx)(n.code,{children:"Disposable"})})}),"\n",(0,s.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L640",children:"packages/extension-api/src/extension-api.d.ts:640"})})]})}function l(e={}){const{wrapper:n}={...(0,r.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(d,{...e})}):d(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>c,a:()=>a});var s=t(27378);const r={},i=s.createContext(r);function a(e){const n=s.useContext(i);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:a(e.components),s.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[38056],{85316:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>o,contentTitle:()=>a,default:()=>l,frontMatter:()=>i,metadata:()=>c,toc:()=>u});var s=t(24246),r=t(71670);const i={},a="Function: registerMenuItem()",c={id:"namespaces/tray/functions/registerMenuItem",title:"Function: registerMenuItem()",description:"registerMenuItem(item): Disposable",source:"@site/api/namespaces/tray/functions/registerMenuItem.md",sourceDirName:"namespaces/tray/functions",slug:"/namespaces/tray/functions/registerMenuItem",permalink:"/api/namespaces/tray/functions/registerMenuItem",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Namespace: tray",permalink:"/api/namespaces/tray/"},next:{title:"Function: registerProviderMenuItem()",permalink:"/api/namespaces/tray/functions/registerProviderMenuItem"}},o={},u=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function d(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,r.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"function-registermenuitem",children:"Function: registerMenuItem()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"registerMenuItem"}),"(",(0,s.jsx)(n.code,{children:"item"}),"): ",(0,s.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,s.jsx)(n.code,{children:"Disposable"})})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Creates a menu not related to a Provider"}),"\n",(0,s.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"item"}),": ",(0,s.jsx)(n.a,{href:"/api/interfaces/MenuItem",children:(0,s.jsx)(n.code,{children:"MenuItem"})})]}),"\n",(0,s.jsx)(n.p,{children:"the item to add in the tray menu"}),"\n",(0,s.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,s.jsx)(n.code,{children:"Disposable"})})}),"\n",(0,s.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L640",children:"packages/extension-api/src/extension-api.d.ts:640"})})]})}function l(e={}){const{wrapper:n}={...(0,r.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(d,{...e})}):d(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>c,a:()=>a});var s=t(27378);const r={},i=s.createContext(r);function a(e){const n=s.useContext(i);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:a(e.components),s.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/91008145.81ffd509.js b/assets/js/91008145.81ffd509.js new file mode 100644 index 00000000000..686a467c4b8 --- /dev/null +++ b/assets/js/91008145.81ffd509.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[42423],{90927:(n,e,t)=>{t.r(e),t.d(e,{assets:()=>a,contentTitle:()=>c,default:()=>u,frontMatter:()=>i,metadata:()=>r,toc:()=>l});var s=t(24246),o=t(71670);const i={},c="Function: listNetworks()",r={id:"namespaces/containerEngine/functions/listNetworks",title:"Function: listNetworks()",description:"listNetworks(): Promise\\",source:"@site/api/namespaces/containerEngine/functions/listNetworks.md",sourceDirName:"namespaces/containerEngine/functions",slug:"/namespaces/containerEngine/functions/listNetworks",permalink:"/api/namespaces/containerEngine/functions/listNetworks",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Function: listInfos()",permalink:"/api/namespaces/containerEngine/functions/listInfos"},next:{title:"Function: listPods()",permalink:"/api/namespaces/containerEngine/functions/listPods"}},a={},l=[{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function d(n){const e={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,o.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:"source",children:"Source"}),"\n",(0,s.jsx)(e.p,{children:(0,s.jsx)(e.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L3364",children:"packages/extension-api/src/extension-api.d.ts:3364"})})]})}function u(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,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/91008145.92c7330d.js b/assets/js/91008145.92c7330d.js deleted file mode 100644 index 8c44207bd5e..00000000000 --- a/assets/js/91008145.92c7330d.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[42423],{90927:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>c,default:()=>d,frontMatter:()=>i,metadata:()=>r,toc:()=>l});var s=t(24246),o=t(71670);const i={},c="Function: listNetworks()",r={id:"namespaces/containerEngine/functions/listNetworks",title:"Function: listNetworks()",description:"listNetworks(): Promise\\",source:"@site/api/namespaces/containerEngine/functions/listNetworks.md",sourceDirName:"namespaces/containerEngine/functions",slug:"/namespaces/containerEngine/functions/listNetworks",permalink:"/api/namespaces/containerEngine/functions/listNetworks",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Function: listInfos()",permalink:"/api/namespaces/containerEngine/functions/listInfos"},next:{title:"Function: listPods()",permalink:"/api/namespaces/containerEngine/functions/listPods"}},a={},l=[{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function u(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,o.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"function-listnetworks",children:"Function: listNetworks()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"listNetworks"}),"(): ",(0,s.jsx)(n.code,{children:"Promise"}),"< ",(0,s.jsx)(n.a,{href:"/api/interfaces/NetworkInspectInfo",children:(0,s.jsx)(n.code,{children:"NetworkInspectInfo"})}),"[] >"]}),"\n"]}),"\n",(0,s.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"Promise"}),"< ",(0,s.jsx)(n.a,{href:"/api/interfaces/NetworkInspectInfo",children:(0,s.jsx)(n.code,{children:"NetworkInspectInfo"})}),"[] >"]}),"\n",(0,s.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L3364",children:"packages/extension-api/src/extension-api.d.ts:3364"})})]})}function d(e={}){const{wrapper:n}={...(0,o.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:()=>c});var s=t(27378);const o={},i=s.createContext(o);function c(e){const n=s.useContext(i);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function r(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:c(e.components),s.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/91392348.f5cb6f27.js b/assets/js/91392348.249ac3d9.js similarity index 97% rename from assets/js/91392348.f5cb6f27.js rename to assets/js/91392348.249ac3d9.js index f7cddcfb3c5..bdb545a0255 100644 --- a/assets/js/91392348.f5cb6f27.js +++ b/assets/js/91392348.249ac3d9.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[60637],{11495:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>s,default:()=>u,frontMatter:()=>o,metadata:()=>c,toc:()=>d});var r=t(24246),i=t(71670);const o={},s="Interface: UnregisterKubernetesConnectionEvent",c={id:"interfaces/UnregisterKubernetesConnectionEvent",title:"Interface: UnregisterKubernetesConnectionEvent",description:"Properties",source:"@site/api/interfaces/UnregisterKubernetesConnectionEvent.md",sourceDirName:"interfaces",slug:"/interfaces/UnregisterKubernetesConnectionEvent",permalink:"/api/interfaces/UnregisterKubernetesConnectionEvent",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: UnregisterContainerConnectionEvent",permalink:"/api/interfaces/UnregisterContainerConnectionEvent"},next:{title:"Interface: UpdateContainerConnectionEvent",permalink:"/api/interfaces/UpdateContainerConnectionEvent"}},a={},d=[{value:"Properties",id:"properties",level:2},{value:"providerId",id:"providerid",level:3},{value:"Source",id:"source",level:4}];function p(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",p:"p",strong:"strong",...(0,i.a)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.h1,{id:"interface-unregisterkubernetesconnectionevent",children:"Interface: UnregisterKubernetesConnectionEvent"}),"\n",(0,r.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,r.jsx)(n.h3,{id:"providerid",children:"providerId"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"providerId"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L530",children:"packages/extension-api/src/extension-api.d.ts:530"})})]})}function u(e={}){const{wrapper:n}={...(0,i.a)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(p,{...e})}):p(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>c,a:()=>s});var r=t(27378);const i={},o=r.createContext(i);function s(e){const n=r.useContext(o);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:s(e.components),r.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[60637],{11495:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>s,default:()=>u,frontMatter:()=>o,metadata:()=>c,toc:()=>d});var r=t(24246),i=t(71670);const o={},s="Interface: UnregisterKubernetesConnectionEvent",c={id:"interfaces/UnregisterKubernetesConnectionEvent",title:"Interface: UnregisterKubernetesConnectionEvent",description:"Properties",source:"@site/api/interfaces/UnregisterKubernetesConnectionEvent.md",sourceDirName:"interfaces",slug:"/interfaces/UnregisterKubernetesConnectionEvent",permalink:"/api/interfaces/UnregisterKubernetesConnectionEvent",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: UnregisterContainerConnectionEvent",permalink:"/api/interfaces/UnregisterContainerConnectionEvent"},next:{title:"Interface: UpdateContainerConnectionEvent",permalink:"/api/interfaces/UpdateContainerConnectionEvent"}},a={},d=[{value:"Properties",id:"properties",level:2},{value:"providerId",id:"providerid",level:3},{value:"Source",id:"source",level:4}];function p(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",p:"p",strong:"strong",...(0,i.a)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.h1,{id:"interface-unregisterkubernetesconnectionevent",children:"Interface: UnregisterKubernetesConnectionEvent"}),"\n",(0,r.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,r.jsx)(n.h3,{id:"providerid",children:"providerId"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"providerId"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L530",children:"packages/extension-api/src/extension-api.d.ts:530"})})]})}function u(e={}){const{wrapper:n}={...(0,i.a)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(p,{...e})}):p(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>c,a:()=>s});var r=t(27378);const i={},o=r.createContext(i);function s(e){const n=r.useContext(o);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:s(e.components),r.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/91fe1403.3ca595fb.js b/assets/js/91fe1403.a5eec8d0.js similarity index 81% rename from assets/js/91fe1403.3ca595fb.js rename to assets/js/91fe1403.a5eec8d0.js index 935f3792df4..5fbc4dc71c6 100644 --- a/assets/js/91fe1403.3ca595fb.js +++ b/assets/js/91fe1403.a5eec8d0.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[92916],{78154:(e,n,a)=>{a.r(n),a.d(n,{assets:()=>o,contentTitle:()=>i,default:()=>d,frontMatter:()=>c,metadata:()=>t,toc:()=>l});var s=a(24246),r=a(71670);const c={},i="Variable: clipboard",t={id:"namespaces/env/variables/clipboard",title:"Variable: clipboard",description:"const clipboard: Clipboard",source:"@site/api/namespaces/env/variables/clipboard.md",sourceDirName:"namespaces/env/variables",slug:"/namespaces/env/variables/clipboard",permalink:"/api/namespaces/env/variables/clipboard",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Namespace: env",permalink:"/api/namespaces/env/"},next:{title:"Variable: isLinux",permalink:"/api/namespaces/env/variables/isLinux"}},o={},l=[{value:"Source",id:"source",level:2}];function p(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,r.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"variable-clipboard",children:"Variable: clipboard"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:(0,s.jsx)(n.code,{children:"const"})})," ",(0,s.jsx)(n.strong,{children:"clipboard"}),": ",(0,s.jsx)(n.a,{href:"/api/interfaces/Clipboard",children:(0,s.jsx)(n.code,{children:"Clipboard"})})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The system clipboard."}),"\n",(0,s.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L3717",children:"packages/extension-api/src/extension-api.d.ts:3717"})})]})}function d(e={}){const{wrapper:n}={...(0,r.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(p,{...e})}):p(e)}},71670:(e,n,a)=>{a.d(n,{Z:()=>t,a:()=>i});var s=a(27378);const r={},c=s.createContext(r);function i(e){const n=s.useContext(c);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function t(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:i(e.components),s.createElement(c.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[92916],{78154:(e,n,a)=>{a.r(n),a.d(n,{assets:()=>o,contentTitle:()=>c,default:()=>d,frontMatter:()=>i,metadata:()=>t,toc:()=>l});var s=a(24246),r=a(71670);const i={},c="Variable: clipboard",t={id:"namespaces/env/variables/clipboard",title:"Variable: clipboard",description:"const clipboard: Clipboard",source:"@site/api/namespaces/env/variables/clipboard.md",sourceDirName:"namespaces/env/variables",slug:"/namespaces/env/variables/clipboard",permalink:"/api/namespaces/env/variables/clipboard",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Namespace: env",permalink:"/api/namespaces/env/"},next:{title:"Variable: isLinux",permalink:"/api/namespaces/env/variables/isLinux"}},o={},l=[{value:"Source",id:"source",level:2}];function p(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,r.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"variable-clipboard",children:"Variable: clipboard"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:(0,s.jsx)(n.code,{children:"const"})})," ",(0,s.jsx)(n.strong,{children:"clipboard"}),": ",(0,s.jsx)(n.a,{href:"/api/interfaces/Clipboard",children:(0,s.jsx)(n.code,{children:"Clipboard"})})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The system clipboard."}),"\n",(0,s.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L3717",children:"packages/extension-api/src/extension-api.d.ts:3717"})})]})}function d(e={}){const{wrapper:n}={...(0,r.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(p,{...e})}):p(e)}},71670:(e,n,a)=>{a.d(n,{Z:()=>t,a:()=>c});var s=a(27378);const r={},i=s.createContext(r);function c(e){const n=s.useContext(i);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function t(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:c(e.components),s.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/920c2ac2.5a9797d9.js b/assets/js/920c2ac2.c947655c.js similarity index 94% rename from assets/js/920c2ac2.5a9797d9.js rename to assets/js/920c2ac2.c947655c.js index e3399dfd09f..91b09a0de50 100644 --- a/assets/js/920c2ac2.5a9797d9.js +++ b/assets/js/920c2ac2.c947655c.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[2281],{64075:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>o,contentTitle:()=>c,default:()=>h,frontMatter:()=>t,metadata:()=>r,toc:()=>a});var s=i(24246),l=i(71670);const t={},c="Interface: MemoryStats",r={id:"interfaces/MemoryStats",title:"Interface: MemoryStats",description:"Properties",source:"@site/api/interfaces/MemoryStats.md",sourceDirName:"interfaces",slug:"/interfaces/MemoryStats",permalink:"/api/interfaces/MemoryStats",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: ManifestCreateOptions",permalink:"/api/interfaces/ManifestCreateOptions"},next:{title:"Interface: MenuItem",permalink:"/api/interfaces/MenuItem"}},o={},a=[{value:"Properties",id:"properties",level:2},{value:"commitbytes?",id:"commitbytes",level:3},{value:"Source",id:"source",level:4},{value:"commitpeakbytes?",id:"commitpeakbytes",level:3},{value:"Source",id:"source-1",level:4},{value:"failcnt",id:"failcnt",level:3},{value:"Source",id:"source-2",level:4},{value:"limit",id:"limit",level:3},{value:"Source",id:"source-3",level:4},{value:"max_usage",id:"max_usage",level:3},{value:"Source",id:"source-4",level:4},{value:"privateworkingset?",id:"privateworkingset",level:3},{value:"Source",id:"source-5",level:4},{value:"stats",id:"stats",level:3},{value:"active_anon",id:"active_anon",level:4},{value:"active_file",id:"active_file",level:4},{value:"cache",id:"cache",level:4},{value:"hierarchical_memory_limit",id:"hierarchical_memory_limit",level:4},{value:"inactive_anon",id:"inactive_anon",level:4},{value:"inactive_file",id:"inactive_file",level:4},{value:"mapped_file",id:"mapped_file",level:4},{value:"pgfault",id:"pgfault",level:4},{value:"pgmajfault",id:"pgmajfault",level:4},{value:"pgpgin",id:"pgpgin",level:4},{value:"pgpgout",id:"pgpgout",level:4},{value:"rss",id:"rss",level:4},{value:"rss_huge",id:"rss_huge",level:4},{value:"total_active_anon",id:"total_active_anon",level:4},{value:"total_active_file",id:"total_active_file",level:4},{value:"total_cache",id:"total_cache",level:4},{value:"total_inactive_anon",id:"total_inactive_anon",level:4},{value:"total_inactive_file",id:"total_inactive_file",level:4},{value:"total_mapped_file",id:"total_mapped_file",level:4},{value:"total_pgfault",id:"total_pgfault",level:4},{value:"total_pgmajfault",id:"total_pgmajfault",level:4},{value:"total_pgpgin",id:"total_pgpgin",level:4},{value:"total_pgpgout",id:"total_pgpgout",level:4},{value:"total_rss",id:"total_rss",level:4},{value:"total_rss_huge",id:"total_rss_huge",level:4},{value:"total_unevictable",id:"total_unevictable",level:4},{value:"total_writeback",id:"total_writeback",level:4},{value:"unevictable",id:"unevictable",level:4},{value:"writeback",id:"writeback",level:4},{value:"Source",id:"source-6",level:4},{value:"usage",id:"usage",level:3},{value:"Source",id:"source-7",level:4}];function d(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,l.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"interface-memorystats",children:"Interface: MemoryStats"}),"\n",(0,s.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,s.jsx)(n.h3,{id:"commitbytes",children:"commitbytes?"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:(0,s.jsx)(n.code,{children:"optional"})})," ",(0,s.jsx)(n.strong,{children:"commitbytes"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2842",children:"packages/extension-api/src/extension-api.d.ts:2842"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"commitpeakbytes",children:"commitpeakbytes?"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:(0,s.jsx)(n.code,{children:"optional"})})," ",(0,s.jsx)(n.strong,{children:"commitpeakbytes"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2843",children:"packages/extension-api/src/extension-api.d.ts:2843"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"failcnt",children:"failcnt"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"failcnt"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2838",children:"packages/extension-api/src/extension-api.d.ts:2838"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"limit",children:"limit"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"limit"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2839",children:"packages/extension-api/src/extension-api.d.ts:2839"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"max_usage",children:"max_usage"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"max_usage"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"source-4",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2836",children:"packages/extension-api/src/extension-api.d.ts:2836"})}),"\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.strong,{children:(0,s.jsx)(n.code,{children:"optional"})})," ",(0,s.jsx)(n.strong,{children:"privateworkingset"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"source-5",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/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:"stats",children:"stats"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"stats"}),": ",(0,s.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"active_anon",children:"active_anon"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"active_anon"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"active_file",children:"active_file"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"active_file"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"cache",children:"cache"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"cache"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"hierarchical_memory_limit",children:"hierarchical_memory_limit"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"hierarchical_memory_limit"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"inactive_anon",children:"inactive_anon"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"inactive_anon"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"inactive_file",children:"inactive_file"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"inactive_file"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"mapped_file",children:"mapped_file"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"mapped_file"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"pgfault",children:"pgfault"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"pgfault"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"pgmajfault",children:"pgmajfault"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"pgmajfault"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"pgpgin",children:"pgpgin"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"pgpgin"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"pgpgout",children:"pgpgout"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"pgpgout"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"rss",children:"rss"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"rss"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"rss_huge",children:"rss_huge"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"rss_huge"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"total_active_anon",children:"total_active_anon"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"total_active_anon"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"total_active_file",children:"total_active_file"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"total_active_file"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"total_cache",children:"total_cache"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"total_cache"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"total_inactive_anon",children:"total_inactive_anon"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"total_inactive_anon"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"total_inactive_file",children:"total_inactive_file"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"total_inactive_file"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"total_mapped_file",children:"total_mapped_file"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"total_mapped_file"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"total_pgfault",children:"total_pgfault"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"total_pgfault"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"total_pgmajfault",children:"total_pgmajfault"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"total_pgmajfault"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"total_pgpgin",children:"total_pgpgin"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"total_pgpgin"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"total_pgpgout",children:"total_pgpgout"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"total_pgpgout"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"total_rss",children:"total_rss"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"total_rss"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"total_rss_huge",children:"total_rss_huge"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"total_rss_huge"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"total_unevictable",children:"total_unevictable"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"total_unevictable"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"total_writeback",children:"total_writeback"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"total_writeback"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"unevictable",children:"unevictable"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"unevictable"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"writeback",children:"writeback"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"writeback"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"source-6",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2805",children:"packages/extension-api/src/extension-api.d.ts:2805"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"usage",children:"usage"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"usage"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"source-7",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2837",children:"packages/extension-api/src/extension-api.d.ts:2837"})})]})}function h(e={}){const{wrapper:n}={...(0,l.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(d,{...e})}):d(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>r,a:()=>c});var s=i(27378);const l={},t=s.createContext(l);function c(e){const n=s.useContext(t);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function r(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(l):e.components||l:c(e.components),s.createElement(t.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[2281],{64075:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>o,contentTitle:()=>c,default:()=>h,frontMatter:()=>t,metadata:()=>r,toc:()=>a});var s=i(24246),l=i(71670);const t={},c="Interface: MemoryStats",r={id:"interfaces/MemoryStats",title:"Interface: MemoryStats",description:"Properties",source:"@site/api/interfaces/MemoryStats.md",sourceDirName:"interfaces",slug:"/interfaces/MemoryStats",permalink:"/api/interfaces/MemoryStats",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: ManifestCreateOptions",permalink:"/api/interfaces/ManifestCreateOptions"},next:{title:"Interface: MenuItem",permalink:"/api/interfaces/MenuItem"}},o={},a=[{value:"Properties",id:"properties",level:2},{value:"commitbytes?",id:"commitbytes",level:3},{value:"Source",id:"source",level:4},{value:"commitpeakbytes?",id:"commitpeakbytes",level:3},{value:"Source",id:"source-1",level:4},{value:"failcnt",id:"failcnt",level:3},{value:"Source",id:"source-2",level:4},{value:"limit",id:"limit",level:3},{value:"Source",id:"source-3",level:4},{value:"max_usage",id:"max_usage",level:3},{value:"Source",id:"source-4",level:4},{value:"privateworkingset?",id:"privateworkingset",level:3},{value:"Source",id:"source-5",level:4},{value:"stats",id:"stats",level:3},{value:"active_anon",id:"active_anon",level:4},{value:"active_file",id:"active_file",level:4},{value:"cache",id:"cache",level:4},{value:"hierarchical_memory_limit",id:"hierarchical_memory_limit",level:4},{value:"inactive_anon",id:"inactive_anon",level:4},{value:"inactive_file",id:"inactive_file",level:4},{value:"mapped_file",id:"mapped_file",level:4},{value:"pgfault",id:"pgfault",level:4},{value:"pgmajfault",id:"pgmajfault",level:4},{value:"pgpgin",id:"pgpgin",level:4},{value:"pgpgout",id:"pgpgout",level:4},{value:"rss",id:"rss",level:4},{value:"rss_huge",id:"rss_huge",level:4},{value:"total_active_anon",id:"total_active_anon",level:4},{value:"total_active_file",id:"total_active_file",level:4},{value:"total_cache",id:"total_cache",level:4},{value:"total_inactive_anon",id:"total_inactive_anon",level:4},{value:"total_inactive_file",id:"total_inactive_file",level:4},{value:"total_mapped_file",id:"total_mapped_file",level:4},{value:"total_pgfault",id:"total_pgfault",level:4},{value:"total_pgmajfault",id:"total_pgmajfault",level:4},{value:"total_pgpgin",id:"total_pgpgin",level:4},{value:"total_pgpgout",id:"total_pgpgout",level:4},{value:"total_rss",id:"total_rss",level:4},{value:"total_rss_huge",id:"total_rss_huge",level:4},{value:"total_unevictable",id:"total_unevictable",level:4},{value:"total_writeback",id:"total_writeback",level:4},{value:"unevictable",id:"unevictable",level:4},{value:"writeback",id:"writeback",level:4},{value:"Source",id:"source-6",level:4},{value:"usage",id:"usage",level:3},{value:"Source",id:"source-7",level:4}];function d(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,l.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"interface-memorystats",children:"Interface: MemoryStats"}),"\n",(0,s.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,s.jsx)(n.h3,{id:"commitbytes",children:"commitbytes?"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:(0,s.jsx)(n.code,{children:"optional"})})," ",(0,s.jsx)(n.strong,{children:"commitbytes"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2842",children:"packages/extension-api/src/extension-api.d.ts:2842"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"commitpeakbytes",children:"commitpeakbytes?"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:(0,s.jsx)(n.code,{children:"optional"})})," ",(0,s.jsx)(n.strong,{children:"commitpeakbytes"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2843",children:"packages/extension-api/src/extension-api.d.ts:2843"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"failcnt",children:"failcnt"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"failcnt"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2838",children:"packages/extension-api/src/extension-api.d.ts:2838"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"limit",children:"limit"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"limit"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2839",children:"packages/extension-api/src/extension-api.d.ts:2839"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"max_usage",children:"max_usage"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"max_usage"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"source-4",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2836",children:"packages/extension-api/src/extension-api.d.ts:2836"})}),"\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.strong,{children:(0,s.jsx)(n.code,{children:"optional"})})," ",(0,s.jsx)(n.strong,{children:"privateworkingset"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"source-5",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/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:"stats",children:"stats"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"stats"}),": ",(0,s.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"active_anon",children:"active_anon"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"active_anon"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"active_file",children:"active_file"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"active_file"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"cache",children:"cache"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"cache"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"hierarchical_memory_limit",children:"hierarchical_memory_limit"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"hierarchical_memory_limit"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"inactive_anon",children:"inactive_anon"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"inactive_anon"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"inactive_file",children:"inactive_file"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"inactive_file"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"mapped_file",children:"mapped_file"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"mapped_file"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"pgfault",children:"pgfault"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"pgfault"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"pgmajfault",children:"pgmajfault"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"pgmajfault"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"pgpgin",children:"pgpgin"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"pgpgin"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"pgpgout",children:"pgpgout"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"pgpgout"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"rss",children:"rss"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"rss"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"rss_huge",children:"rss_huge"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"rss_huge"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"total_active_anon",children:"total_active_anon"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"total_active_anon"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"total_active_file",children:"total_active_file"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"total_active_file"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"total_cache",children:"total_cache"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"total_cache"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"total_inactive_anon",children:"total_inactive_anon"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"total_inactive_anon"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"total_inactive_file",children:"total_inactive_file"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"total_inactive_file"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"total_mapped_file",children:"total_mapped_file"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"total_mapped_file"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"total_pgfault",children:"total_pgfault"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"total_pgfault"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"total_pgmajfault",children:"total_pgmajfault"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"total_pgmajfault"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"total_pgpgin",children:"total_pgpgin"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"total_pgpgin"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"total_pgpgout",children:"total_pgpgout"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"total_pgpgout"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"total_rss",children:"total_rss"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"total_rss"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"total_rss_huge",children:"total_rss_huge"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"total_rss_huge"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"total_unevictable",children:"total_unevictable"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"total_unevictable"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"total_writeback",children:"total_writeback"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"total_writeback"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"unevictable",children:"unevictable"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"unevictable"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"writeback",children:"writeback"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"writeback"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"source-6",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2805",children:"packages/extension-api/src/extension-api.d.ts:2805"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"usage",children:"usage"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"usage"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"source-7",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2837",children:"packages/extension-api/src/extension-api.d.ts:2837"})})]})}function h(e={}){const{wrapper:n}={...(0,l.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(d,{...e})}):d(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>r,a:()=>c});var s=i(27378);const l={},t=s.createContext(l);function c(e){const n=s.useContext(t);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function r(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(l):e.components||l:c(e.components),s.createElement(t.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/927c84a6.f30be07f.js b/assets/js/927c84a6.5f4f85e0.js similarity index 84% rename from assets/js/927c84a6.f30be07f.js rename to assets/js/927c84a6.5f4f85e0.js index f138412056c..7f233d03f07 100644 --- a/assets/js/927c84a6.f30be07f.js +++ b/assets/js/927c84a6.5f4f85e0.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[8039],{45518:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>r,default:()=>h,frontMatter:()=>c,metadata:()=>o,toc:()=>l});var s=t(24246),i=t(71670);const c={},r="Interface: CheckResultFixCommand",o={id:"interfaces/CheckResultFixCommand",title:"Interface: CheckResultFixCommand",description:"Properties",source:"@site/api/interfaces/CheckResultFixCommand.md",sourceDirName:"interfaces",slug:"/interfaces/CheckResultFixCommand",permalink:"/api/interfaces/CheckResultFixCommand",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: CheckResult",permalink:"/api/interfaces/CheckResult"},next:{title:"Interface: CliTool",permalink:"/api/interfaces/CliTool"}},a={},l=[{value:"Properties",id:"properties",level:2},{value:"id",id:"id",level:3},{value:"Source",id:"source",level:4},{value:"title",id:"title",level:3},{value:"Source",id:"source-1",level:4}];function d(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,i.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"interface-checkresultfixcommand",children:"Interface: CheckResultFixCommand"}),"\n",(0,s.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,s.jsx)(n.h3,{id:"id",children:"id"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"id"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L358",children:"packages/extension-api/src/extension-api.d.ts:358"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"title",children:"title"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"title"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L359",children:"packages/extension-api/src/extension-api.d.ts:359"})})]})}function h(e={}){const{wrapper:n}={...(0,i.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(d,{...e})}):d(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>o,a:()=>r});var s=t(27378);const i={},c=s.createContext(i);function r(e){const n=s.useContext(c);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:r(e.components),s.createElement(c.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[8039],{45518:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>r,default:()=>h,frontMatter:()=>c,metadata:()=>o,toc:()=>d});var s=t(24246),i=t(71670);const c={},r="Interface: CheckResultFixCommand",o={id:"interfaces/CheckResultFixCommand",title:"Interface: CheckResultFixCommand",description:"Properties",source:"@site/api/interfaces/CheckResultFixCommand.md",sourceDirName:"interfaces",slug:"/interfaces/CheckResultFixCommand",permalink:"/api/interfaces/CheckResultFixCommand",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: CheckResult",permalink:"/api/interfaces/CheckResult"},next:{title:"Interface: CliTool",permalink:"/api/interfaces/CliTool"}},a={},d=[{value:"Properties",id:"properties",level:2},{value:"id",id:"id",level:3},{value:"Source",id:"source",level:4},{value:"title",id:"title",level:3},{value:"Source",id:"source-1",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,i.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"interface-checkresultfixcommand",children:"Interface: CheckResultFixCommand"}),"\n",(0,s.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,s.jsx)(n.h3,{id:"id",children:"id"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"id"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L358",children:"packages/extension-api/src/extension-api.d.ts:358"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"title",children:"title"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"title"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L359",children:"packages/extension-api/src/extension-api.d.ts:359"})})]})}function h(e={}){const{wrapper:n}={...(0,i.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>o,a:()=>r});var s=t(27378);const i={},c=s.createContext(i);function r(e){const n=s.useContext(c);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:r(e.components),s.createElement(c.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/9286a297.bc6850d2.js b/assets/js/9286a297.84365624.js similarity index 84% rename from assets/js/9286a297.bc6850d2.js rename to assets/js/9286a297.84365624.js index a0a6284e50c..5d07dc062f6 100644 --- a/assets/js/9286a297.bc6850d2.js +++ b/assets/js/9286a297.84365624.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[21360],{19539:(n,e,i)=>{i.r(e),i.d(e,{assets:()=>s,contentTitle:()=>r,default:()=>l,frontMatter:()=>a,metadata:()=>c,toc:()=>d});var o=i(24246),t=i(71670);const a={},r="Function: navigateToEditProviderContainerConnection()",c={id:"namespaces/navigation/functions/navigateToEditProviderContainerConnection",title:"Function: navigateToEditProviderContainerConnection()",description:"navigateToEditProviderContainerConnection(connection): Promise\\",source:"@site/api/namespaces/navigation/functions/navigateToEditProviderContainerConnection.md",sourceDirName:"namespaces/navigation/functions",slug:"/namespaces/navigation/functions/navigateToEditProviderContainerConnection",permalink:"/api/namespaces/navigation/functions/navigateToEditProviderContainerConnection",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Function: navigateToContribution()",permalink:"/api/namespaces/navigation/functions/navigateToContribution"},next:{title:"Function: navigateToImage()",permalink:"/api/namespaces/navigation/functions/navigateToImage"}},s={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function u(n){const e={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,t.a)(),...n.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(e.h1,{id:"function-navigatetoeditprovidercontainerconnection",children:"Function: navigateToEditProviderContainerConnection()"}),"\n",(0,o.jsxs)(e.blockquote,{children:["\n",(0,o.jsxs)(e.p,{children:[(0,o.jsx)(e.strong,{children:"navigateToEditProviderContainerConnection"}),"(",(0,o.jsx)(e.code,{children:"connection"}),"): ",(0,o.jsx)(e.code,{children:"Promise"}),"< ",(0,o.jsx)(e.code,{children:"void"})," >"]}),"\n"]}),"\n",(0,o.jsx)(e.p,{children:"Navigate to the Edit Provider Container Connection page"}),"\n",(0,o.jsx)(e.h2,{id:"parameters",children:"Parameters"}),"\n",(0,o.jsxs)(e.p,{children:["\u2022 ",(0,o.jsx)(e.strong,{children:"connection"}),": ",(0,o.jsx)(e.a,{href:"/api/interfaces/ProviderContainerConnection",children:(0,o.jsx)(e.code,{children:"ProviderContainerConnection"})})]}),"\n",(0,o.jsx)(e.h2,{id:"returns",children:"Returns"}),"\n",(0,o.jsxs)(e.p,{children:[(0,o.jsx)(e.code,{children:"Promise"}),"< ",(0,o.jsx)(e.code,{children:"void"})," >"]}),"\n",(0,o.jsx)(e.h2,{id:"source",children:"Source"}),"\n",(0,o.jsx)(e.p,{children:(0,o.jsx)(e.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L4190",children:"packages/extension-api/src/extension-api.d.ts:4190"})})]})}function l(n={}){const{wrapper:e}={...(0,t.a)(),...n.components};return e?(0,o.jsx)(e,{...n,children:(0,o.jsx)(u,{...n})}):u(n)}},71670:(n,e,i)=>{i.d(e,{Z:()=>c,a:()=>r});var o=i(27378);const t={},a=o.createContext(t);function r(n){const e=o.useContext(a);return o.useMemo((function(){return"function"==typeof n?n(e):{...e,...n}}),[e,n])}function c(n){let e;return e=n.disableParentContext?"function"==typeof n.components?n.components(t):n.components||t:r(n.components),o.createElement(a.Provider,{value:e},n.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[21360],{19539:(n,e,i)=>{i.r(e),i.d(e,{assets:()=>s,contentTitle:()=>a,default:()=>l,frontMatter:()=>r,metadata:()=>c,toc:()=>d});var o=i(24246),t=i(71670);const r={},a="Function: navigateToEditProviderContainerConnection()",c={id:"namespaces/navigation/functions/navigateToEditProviderContainerConnection",title:"Function: navigateToEditProviderContainerConnection()",description:"navigateToEditProviderContainerConnection(connection): Promise\\",source:"@site/api/namespaces/navigation/functions/navigateToEditProviderContainerConnection.md",sourceDirName:"namespaces/navigation/functions",slug:"/namespaces/navigation/functions/navigateToEditProviderContainerConnection",permalink:"/api/namespaces/navigation/functions/navigateToEditProviderContainerConnection",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Function: navigateToContribution()",permalink:"/api/namespaces/navigation/functions/navigateToContribution"},next:{title:"Function: navigateToImage()",permalink:"/api/namespaces/navigation/functions/navigateToImage"}},s={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function u(n){const e={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,t.a)(),...n.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(e.h1,{id:"function-navigatetoeditprovidercontainerconnection",children:"Function: navigateToEditProviderContainerConnection()"}),"\n",(0,o.jsxs)(e.blockquote,{children:["\n",(0,o.jsxs)(e.p,{children:[(0,o.jsx)(e.strong,{children:"navigateToEditProviderContainerConnection"}),"(",(0,o.jsx)(e.code,{children:"connection"}),"): ",(0,o.jsx)(e.code,{children:"Promise"}),"< ",(0,o.jsx)(e.code,{children:"void"})," >"]}),"\n"]}),"\n",(0,o.jsx)(e.p,{children:"Navigate to the Edit Provider Container Connection page"}),"\n",(0,o.jsx)(e.h2,{id:"parameters",children:"Parameters"}),"\n",(0,o.jsxs)(e.p,{children:["\u2022 ",(0,o.jsx)(e.strong,{children:"connection"}),": ",(0,o.jsx)(e.a,{href:"/api/interfaces/ProviderContainerConnection",children:(0,o.jsx)(e.code,{children:"ProviderContainerConnection"})})]}),"\n",(0,o.jsx)(e.h2,{id:"returns",children:"Returns"}),"\n",(0,o.jsxs)(e.p,{children:[(0,o.jsx)(e.code,{children:"Promise"}),"< ",(0,o.jsx)(e.code,{children:"void"})," >"]}),"\n",(0,o.jsx)(e.h2,{id:"source",children:"Source"}),"\n",(0,o.jsx)(e.p,{children:(0,o.jsx)(e.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L4190",children:"packages/extension-api/src/extension-api.d.ts:4190"})})]})}function l(n={}){const{wrapper:e}={...(0,t.a)(),...n.components};return e?(0,o.jsx)(e,{...n,children:(0,o.jsx)(u,{...n})}):u(n)}},71670:(n,e,i)=>{i.d(e,{Z:()=>c,a:()=>a});var o=i(27378);const t={},r=o.createContext(t);function a(n){const e=o.useContext(r);return o.useMemo((function(){return"function"==typeof n?n(e):{...e,...n}}),[e,n])}function c(n){let e;return e=n.disableParentContext?"function"==typeof n.components?n.components(t):n.components||t:a(n.components),o.createElement(r.Provider,{value:e},n.children)}}}]); \ No newline at end of file diff --git a/assets/js/92b08985.9df6d360.js b/assets/js/92b08985.3381bcd2.js similarity index 88% rename from assets/js/92b08985.9df6d360.js rename to assets/js/92b08985.3381bcd2.js index fd3cf3c9010..e88a4af26b6 100644 --- a/assets/js/92b08985.9df6d360.js +++ b/assets/js/92b08985.3381bcd2.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[57321],{60379:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>d,contentTitle:()=>c,default:()=>p,frontMatter:()=>i,metadata:()=>o,toc:()=>a});var r=s(24246),t=s(71670);const i={},c="Interface: NetworkContainer",o={id:"interfaces/NetworkContainer",title:"Interface: NetworkContainer",description:"Properties",source:"@site/api/interfaces/NetworkContainer.md",sourceDirName:"interfaces",slug:"/interfaces/NetworkContainer",permalink:"/api/interfaces/NetworkContainer",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: MountSettings",permalink:"/api/interfaces/MountSettings"},next:{title:"Interface: NetworkCreateOptions",permalink:"/api/interfaces/NetworkCreateOptions"}},d={},a=[{value:"Properties",id:"properties",level:2},{value:"EndpointID",id:"endpointid",level:3},{value:"Source",id:"source",level:4},{value:"IPv4Address",id:"ipv4address",level:3},{value:"Source",id:"source-1",level:4},{value:"IPv6Address",id:"ipv6address",level:3},{value:"Source",id:"source-2",level:4},{value:"MacAddress",id:"macaddress",level:3},{value:"Source",id:"source-3",level:4},{value:"Name",id:"name",level:3},{value:"Source",id:"source-4",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,t.a)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.h1,{id:"interface-networkcontainer",children:"Interface: NetworkContainer"}),"\n",(0,r.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,r.jsx)(n.h3,{id:"endpointid",children:"EndpointID"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"EndpointID"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L1951",children:"packages/extension-api/src/extension-api.d.ts:1951"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"ipv4address",children:"IPv4Address"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"IPv4Address"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L1953",children:"packages/extension-api/src/extension-api.d.ts:1953"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"ipv6address",children:"IPv6Address"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"IPv6Address"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L1954",children:"packages/extension-api/src/extension-api.d.ts:1954"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"macaddress",children:"MacAddress"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"MacAddress"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L1952",children:"packages/extension-api/src/extension-api.d.ts:1952"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"name",children:"Name"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"Name"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"source-4",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L1950",children:"packages/extension-api/src/extension-api.d.ts:1950"})})]})}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,s)=>{s.d(n,{Z:()=>o,a:()=>c});var r=s(27378);const t={},i=r.createContext(t);function c(e){const n=r.useContext(i);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:c(e.components),r.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[57321],{60379:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>d,contentTitle:()=>c,default:()=>p,frontMatter:()=>i,metadata:()=>o,toc:()=>a});var r=s(24246),t=s(71670);const i={},c="Interface: NetworkContainer",o={id:"interfaces/NetworkContainer",title:"Interface: NetworkContainer",description:"Properties",source:"@site/api/interfaces/NetworkContainer.md",sourceDirName:"interfaces",slug:"/interfaces/NetworkContainer",permalink:"/api/interfaces/NetworkContainer",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: MountSettings",permalink:"/api/interfaces/MountSettings"},next:{title:"Interface: NetworkCreateOptions",permalink:"/api/interfaces/NetworkCreateOptions"}},d={},a=[{value:"Properties",id:"properties",level:2},{value:"EndpointID",id:"endpointid",level:3},{value:"Source",id:"source",level:4},{value:"IPv4Address",id:"ipv4address",level:3},{value:"Source",id:"source-1",level:4},{value:"IPv6Address",id:"ipv6address",level:3},{value:"Source",id:"source-2",level:4},{value:"MacAddress",id:"macaddress",level:3},{value:"Source",id:"source-3",level:4},{value:"Name",id:"name",level:3},{value:"Source",id:"source-4",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,t.a)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.h1,{id:"interface-networkcontainer",children:"Interface: NetworkContainer"}),"\n",(0,r.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,r.jsx)(n.h3,{id:"endpointid",children:"EndpointID"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"EndpointID"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L1951",children:"packages/extension-api/src/extension-api.d.ts:1951"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"ipv4address",children:"IPv4Address"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"IPv4Address"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L1953",children:"packages/extension-api/src/extension-api.d.ts:1953"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"ipv6address",children:"IPv6Address"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"IPv6Address"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L1954",children:"packages/extension-api/src/extension-api.d.ts:1954"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"macaddress",children:"MacAddress"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"MacAddress"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L1952",children:"packages/extension-api/src/extension-api.d.ts:1952"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"name",children:"Name"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"Name"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"source-4",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L1950",children:"packages/extension-api/src/extension-api.d.ts:1950"})})]})}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,s)=>{s.d(n,{Z:()=>o,a:()=>c});var r=s(27378);const t={},i=r.createContext(t);function c(e){const n=r.useContext(i);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:c(e.components),r.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/92d7df62.224182d5.js b/assets/js/92d7df62.97d668e1.js similarity index 95% rename from assets/js/92d7df62.224182d5.js rename to assets/js/92d7df62.97d668e1.js index 399c258d1a8..782a8d130c4 100644 --- a/assets/js/92d7df62.224182d5.js +++ b/assets/js/92d7df62.97d668e1.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[2353],{69313:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>o,contentTitle:()=>c,default:()=>l,frontMatter:()=>r,metadata:()=>d,toc:()=>a});var s=n(24246),i=n(71670);const r={},c="Interface: Auditor",d={id:"interfaces/Auditor",title:"Interface: Auditor",description:"Methods",source:"@site/api/interfaces/Auditor.md",sourceDirName:"interfaces",slug:"/interfaces/Auditor",permalink:"/api/interfaces/Auditor",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: AuditResult",permalink:"/api/interfaces/AuditResult"},next:{title:"Interface: AuthConfig",permalink:"/api/interfaces/AuthConfig"}},o={},a=[{value:"Methods",id:"methods",level:2},{value:"auditItems()",id:"audititems",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Source",id:"source",level:4}];function u(e){const t={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",p:"p",strong:"strong",...(0,i.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(t.h1,{id:"interface-auditor",children:"Interface: Auditor"}),"\n",(0,s.jsx)(t.h2,{id:"methods",children:"Methods"}),"\n",(0,s.jsx)(t.h3,{id:"audititems",children:"auditItems()"}),"\n",(0,s.jsxs)(t.blockquote,{children:["\n",(0,s.jsxs)(t.p,{children:[(0,s.jsx)(t.strong,{children:"auditItems"}),"(",(0,s.jsx)(t.code,{children:"items"}),"): ",(0,s.jsx)(t.code,{children:"Promise"}),"< ",(0,s.jsx)(t.a,{href:"/api/interfaces/AuditResult",children:(0,s.jsx)(t.code,{children:"AuditResult"})})," >"]}),"\n"]}),"\n",(0,s.jsx)(t.h4,{id:"parameters",children:"Parameters"}),"\n",(0,s.jsxs)(t.p,{children:["\u2022 ",(0,s.jsx)(t.strong,{children:"items"}),": ",(0,s.jsx)(t.a,{href:"/api/interfaces/AuditRequestItems",children:(0,s.jsx)(t.code,{children:"AuditRequestItems"})})]}),"\n",(0,s.jsx)(t.h4,{id:"returns",children:"Returns"}),"\n",(0,s.jsxs)(t.p,{children:[(0,s.jsx)(t.code,{children:"Promise"}),"< ",(0,s.jsx)(t.a,{href:"/api/interfaces/AuditResult",children:(0,s.jsx)(t.code,{children:"AuditResult"})})," >"]}),"\n",(0,s.jsx)(t.h4,{id:"source",children:"Source"}),"\n",(0,s.jsx)(t.p,{children:(0,s.jsx)(t.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L347",children:"packages/extension-api/src/extension-api.d.ts:347"})})]})}function l(e={}){const{wrapper:t}={...(0,i.a)(),...e.components};return t?(0,s.jsx)(t,{...e,children:(0,s.jsx)(u,{...e})}):u(e)}},71670:(e,t,n)=>{n.d(t,{Z:()=>d,a:()=>c});var s=n(27378);const i={},r=s.createContext(i);function c(e){const t=s.useContext(r);return s.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function d(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:c(e.components),s.createElement(r.Provider,{value:t},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[2353],{69313:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>o,contentTitle:()=>c,default:()=>l,frontMatter:()=>r,metadata:()=>d,toc:()=>a});var s=n(24246),i=n(71670);const r={},c="Interface: Auditor",d={id:"interfaces/Auditor",title:"Interface: Auditor",description:"Methods",source:"@site/api/interfaces/Auditor.md",sourceDirName:"interfaces",slug:"/interfaces/Auditor",permalink:"/api/interfaces/Auditor",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: AuditResult",permalink:"/api/interfaces/AuditResult"},next:{title:"Interface: AuthConfig",permalink:"/api/interfaces/AuthConfig"}},o={},a=[{value:"Methods",id:"methods",level:2},{value:"auditItems()",id:"audititems",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Source",id:"source",level:4}];function u(e){const t={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",p:"p",strong:"strong",...(0,i.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(t.h1,{id:"interface-auditor",children:"Interface: Auditor"}),"\n",(0,s.jsx)(t.h2,{id:"methods",children:"Methods"}),"\n",(0,s.jsx)(t.h3,{id:"audititems",children:"auditItems()"}),"\n",(0,s.jsxs)(t.blockquote,{children:["\n",(0,s.jsxs)(t.p,{children:[(0,s.jsx)(t.strong,{children:"auditItems"}),"(",(0,s.jsx)(t.code,{children:"items"}),"): ",(0,s.jsx)(t.code,{children:"Promise"}),"< ",(0,s.jsx)(t.a,{href:"/api/interfaces/AuditResult",children:(0,s.jsx)(t.code,{children:"AuditResult"})})," >"]}),"\n"]}),"\n",(0,s.jsx)(t.h4,{id:"parameters",children:"Parameters"}),"\n",(0,s.jsxs)(t.p,{children:["\u2022 ",(0,s.jsx)(t.strong,{children:"items"}),": ",(0,s.jsx)(t.a,{href:"/api/interfaces/AuditRequestItems",children:(0,s.jsx)(t.code,{children:"AuditRequestItems"})})]}),"\n",(0,s.jsx)(t.h4,{id:"returns",children:"Returns"}),"\n",(0,s.jsxs)(t.p,{children:[(0,s.jsx)(t.code,{children:"Promise"}),"< ",(0,s.jsx)(t.a,{href:"/api/interfaces/AuditResult",children:(0,s.jsx)(t.code,{children:"AuditResult"})})," >"]}),"\n",(0,s.jsx)(t.h4,{id:"source",children:"Source"}),"\n",(0,s.jsx)(t.p,{children:(0,s.jsx)(t.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L347",children:"packages/extension-api/src/extension-api.d.ts:347"})})]})}function l(e={}){const{wrapper:t}={...(0,i.a)(),...e.components};return t?(0,s.jsx)(t,{...e,children:(0,s.jsx)(u,{...e})}):u(e)}},71670:(e,t,n)=>{n.d(t,{Z:()=>d,a:()=>c});var s=n(27378);const i={},r=s.createContext(i);function c(e){const t=s.useContext(r);return s.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function d(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:c(e.components),s.createElement(r.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/931e3b0a.7cdaf6bb.js b/assets/js/931e3b0a.e529feb3.js similarity index 85% rename from assets/js/931e3b0a.7cdaf6bb.js rename to assets/js/931e3b0a.e529feb3.js index 8524144ca80..63ef26a78f4 100644 --- a/assets/js/931e3b0a.7cdaf6bb.js +++ b/assets/js/931e3b0a.e529feb3.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[55904],{33505:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>i,default:()=>l,frontMatter:()=>s,metadata:()=>c,toc:()=>d});var r=t(24246),o=t(71670);const s={},i="Interface: PortBinding",c={id:"interfaces/PortBinding",title:"Interface: PortBinding",description:"Properties",source:"@site/api/interfaces/PortBinding.md",sourceDirName:"interfaces",slug:"/interfaces/PortBinding",permalink:"/api/interfaces/PortBinding",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: Port",permalink:"/api/interfaces/Port"},next:{title:"Interface: PortMap",permalink:"/api/interfaces/PortMap"}},a={},d=[{value:"Properties",id:"properties",level:2},{value:"HostIp?",id:"hostip",level:3},{value:"Source",id:"source",level:4},{value:"HostPort?",id:"hostport",level:3},{value:"Source",id:"source-1",level:4}];function p(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,o.a)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.h1,{id:"interface-portbinding",children:"Interface: PortBinding"}),"\n",(0,r.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,r.jsx)(n.h3,{id:"hostip",children:"HostIp?"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"optional"})})," ",(0,r.jsx)(n.strong,{children:"HostIp"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2075",children:"packages/extension-api/src/extension-api.d.ts:2075"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"hostport",children:"HostPort?"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"optional"})})," ",(0,r.jsx)(n.strong,{children:"HostPort"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2076",children:"packages/extension-api/src/extension-api.d.ts:2076"})})]})}function l(e={}){const{wrapper:n}={...(0,o.a)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(p,{...e})}):p(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>c,a:()=>i});var r=t(27378);const o={},s=r.createContext(o);function i(e){const n=r.useContext(s);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:i(e.components),r.createElement(s.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[55904],{33505:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>d,contentTitle:()=>i,default:()=>l,frontMatter:()=>s,metadata:()=>c,toc:()=>a});var r=t(24246),o=t(71670);const s={},i="Interface: PortBinding",c={id:"interfaces/PortBinding",title:"Interface: PortBinding",description:"Properties",source:"@site/api/interfaces/PortBinding.md",sourceDirName:"interfaces",slug:"/interfaces/PortBinding",permalink:"/api/interfaces/PortBinding",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: Port",permalink:"/api/interfaces/Port"},next:{title:"Interface: PortMap",permalink:"/api/interfaces/PortMap"}},d={},a=[{value:"Properties",id:"properties",level:2},{value:"HostIp?",id:"hostip",level:3},{value:"Source",id:"source",level:4},{value:"HostPort?",id:"hostport",level:3},{value:"Source",id:"source-1",level:4}];function p(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,o.a)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.h1,{id:"interface-portbinding",children:"Interface: PortBinding"}),"\n",(0,r.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,r.jsx)(n.h3,{id:"hostip",children:"HostIp?"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"optional"})})," ",(0,r.jsx)(n.strong,{children:"HostIp"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2075",children:"packages/extension-api/src/extension-api.d.ts:2075"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"hostport",children:"HostPort?"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"optional"})})," ",(0,r.jsx)(n.strong,{children:"HostPort"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2076",children:"packages/extension-api/src/extension-api.d.ts:2076"})})]})}function l(e={}){const{wrapper:n}={...(0,o.a)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(p,{...e})}):p(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>c,a:()=>i});var r=t(27378);const o={},s=r.createContext(o);function i(e){const n=r.useContext(s);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:i(e.components),r.createElement(s.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/94324b0e.7d30de25.js b/assets/js/94324b0e.b1164170.js similarity index 95% rename from assets/js/94324b0e.7d30de25.js rename to assets/js/94324b0e.b1164170.js index 0d66de51f03..268bc48ad82 100644 --- a/assets/js/94324b0e.7d30de25.js +++ b/assets/js/94324b0e.b1164170.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[76267],{82658:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>c,default:()=>d,frontMatter:()=>r,metadata:()=>i,toc:()=>l});var o=t(24246),s=t(71670);const r={},c="Function: createVolume()",i={id:"namespaces/containerEngine/functions/createVolume",title:"Function: createVolume()",description:"createVolume(options?): Promise\\",source:"@site/api/namespaces/containerEngine/functions/createVolume.md",sourceDirName:"namespaces/containerEngine/functions",slug:"/namespaces/containerEngine/functions/createVolume",permalink:"/api/namespaces/containerEngine/functions/createVolume",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Function: createPod()",permalink:"/api/namespaces/containerEngine/functions/createPod"},next:{title:"Function: deleteContainer()",permalink:"/api/namespaces/containerEngine/functions/deleteContainer"}},a={},l=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function u(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(n.h1,{id:"function-createvolume",children:"Function: createVolume()"}),"\n",(0,o.jsxs)(n.blockquote,{children:["\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.strong,{children:"createVolume"}),"(",(0,o.jsx)(n.code,{children:"options"}),"?): ",(0,o.jsx)(n.code,{children:"Promise"}),"< ",(0,o.jsx)(n.a,{href:"/api/interfaces/VolumeCreateResponseInfo",children:(0,o.jsx)(n.code,{children:"VolumeCreateResponseInfo"})})," >"]}),"\n"]}),"\n",(0,o.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,o.jsxs)(n.p,{children:["\u2022 ",(0,o.jsx)(n.strong,{children:"options?"}),": ",(0,o.jsx)(n.a,{href:"/api/interfaces/VolumeCreateOptions",children:(0,o.jsx)(n.code,{children:"VolumeCreateOptions"})})]}),"\n",(0,o.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.code,{children:"Promise"}),"< ",(0,o.jsx)(n.a,{href:"/api/interfaces/VolumeCreateResponseInfo",children:(0,o.jsx)(n.code,{children:"VolumeCreateResponseInfo"})})," >"]}),"\n",(0,o.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,o.jsx)(n.p,{children:(0,o.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L3371",children:"packages/extension-api/src/extension-api.d.ts:3371"})})]})}function d(e={}){const{wrapper:n}={...(0,s.a)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(u,{...e})}):u(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>i,a:()=>c});var o=t(27378);const s={},r=o.createContext(s);function c(e){const n=o.useContext(r);return o.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function i(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:c(e.components),o.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[76267],{82658:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>c,default:()=>d,frontMatter:()=>r,metadata:()=>i,toc:()=>l});var o=t(24246),s=t(71670);const r={},c="Function: createVolume()",i={id:"namespaces/containerEngine/functions/createVolume",title:"Function: createVolume()",description:"createVolume(options?): Promise\\",source:"@site/api/namespaces/containerEngine/functions/createVolume.md",sourceDirName:"namespaces/containerEngine/functions",slug:"/namespaces/containerEngine/functions/createVolume",permalink:"/api/namespaces/containerEngine/functions/createVolume",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Function: createPod()",permalink:"/api/namespaces/containerEngine/functions/createPod"},next:{title:"Function: deleteContainer()",permalink:"/api/namespaces/containerEngine/functions/deleteContainer"}},a={},l=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function u(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(n.h1,{id:"function-createvolume",children:"Function: createVolume()"}),"\n",(0,o.jsxs)(n.blockquote,{children:["\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.strong,{children:"createVolume"}),"(",(0,o.jsx)(n.code,{children:"options"}),"?): ",(0,o.jsx)(n.code,{children:"Promise"}),"< ",(0,o.jsx)(n.a,{href:"/api/interfaces/VolumeCreateResponseInfo",children:(0,o.jsx)(n.code,{children:"VolumeCreateResponseInfo"})})," >"]}),"\n"]}),"\n",(0,o.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,o.jsxs)(n.p,{children:["\u2022 ",(0,o.jsx)(n.strong,{children:"options?"}),": ",(0,o.jsx)(n.a,{href:"/api/interfaces/VolumeCreateOptions",children:(0,o.jsx)(n.code,{children:"VolumeCreateOptions"})})]}),"\n",(0,o.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.code,{children:"Promise"}),"< ",(0,o.jsx)(n.a,{href:"/api/interfaces/VolumeCreateResponseInfo",children:(0,o.jsx)(n.code,{children:"VolumeCreateResponseInfo"})})," >"]}),"\n",(0,o.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,o.jsx)(n.p,{children:(0,o.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L3371",children:"packages/extension-api/src/extension-api.d.ts:3371"})})]})}function d(e={}){const{wrapper:n}={...(0,s.a)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(u,{...e})}):u(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>i,a:()=>c});var o=t(27378);const s={},r=o.createContext(s);function c(e){const n=o.useContext(r);return o.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function i(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:c(e.components),o.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/95646edb.d2a6155b.js b/assets/js/95646edb.0cab0632.js similarity index 98% rename from assets/js/95646edb.d2a6155b.js rename to assets/js/95646edb.0cab0632.js index 65f356eae2a..789eb1d9a13 100644 --- a/assets/js/95646edb.d2a6155b.js +++ b/assets/js/95646edb.0cab0632.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[66e3],{25235:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>a,contentTitle:()=>r,default:()=>p,frontMatter:()=>c,metadata:()=>o,toc:()=>l});var i=s(24246),t=s(71670);const c={},r="Function: onEvent()",o={id:"namespaces/containerEngine/functions/onEvent",title:"Function: onEvent()",description:"onEvent(listener, thisArgs?, disposables?): Disposable",source:"@site/api/namespaces/containerEngine/functions/onEvent.md",sourceDirName:"namespaces/containerEngine/functions",slug:"/namespaces/containerEngine/functions/onEvent",permalink:"/api/namespaces/containerEngine/functions/onEvent",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Function: logsContainer()",permalink:"/api/namespaces/containerEngine/functions/logsContainer"},next:{title:"Function: pullImage()",permalink:"/api/namespaces/containerEngine/functions/pullImage"}},a={},l=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function d(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,t.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"function-onevent",children:"Function: onEvent()"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"onEvent"}),"(",(0,i.jsx)(n.code,{children:"listener"}),", ",(0,i.jsx)(n.code,{children:"thisArgs"}),"?, ",(0,i.jsx)(n.code,{children:"disposables"}),"?): ",(0,i.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(n.code,{children:"Disposable"})})]}),"\n"]}),"\n",(0,i.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"listener"})]}),"\n",(0,i.jsx)(n.p,{children:"The listener function will be called when the event happens."}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"thisArgs?"}),": ",(0,i.jsx)(n.code,{children:"any"})]}),"\n",(0,i.jsxs)(n.p,{children:["The ",(0,i.jsx)(n.code,{children:"this"}),"-argument which will be used when calling the event listener."]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"disposables?"}),": ",(0,i.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(n.code,{children:"Disposable"})}),"[]"]}),"\n",(0,i.jsxs)(n.p,{children:["An array to which a ",(0,i.jsx)(n.a,{href:"/api/classes/Disposable",children:"Disposable"})," will be added."]}),"\n",(0,i.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(n.code,{children:"Disposable"})})}),"\n",(0,i.jsx)(n.p,{children:"A disposable which unsubscribes the event listener."}),"\n",(0,i.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L3362",children:"packages/extension-api/src/extension-api.d.ts:3362"})})]})}function p(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(d,{...e})}):d(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>o,a:()=>r});var i=s(27378);const t={},c=i.createContext(t);function r(e){const n=i.useContext(c);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:r(e.components),i.createElement(c.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[66e3],{25235:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>a,contentTitle:()=>r,default:()=>p,frontMatter:()=>c,metadata:()=>o,toc:()=>l});var i=s(24246),t=s(71670);const c={},r="Function: onEvent()",o={id:"namespaces/containerEngine/functions/onEvent",title:"Function: onEvent()",description:"onEvent(listener, thisArgs?, disposables?): Disposable",source:"@site/api/namespaces/containerEngine/functions/onEvent.md",sourceDirName:"namespaces/containerEngine/functions",slug:"/namespaces/containerEngine/functions/onEvent",permalink:"/api/namespaces/containerEngine/functions/onEvent",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Function: logsContainer()",permalink:"/api/namespaces/containerEngine/functions/logsContainer"},next:{title:"Function: pullImage()",permalink:"/api/namespaces/containerEngine/functions/pullImage"}},a={},l=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function d(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,t.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"function-onevent",children:"Function: onEvent()"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"onEvent"}),"(",(0,i.jsx)(n.code,{children:"listener"}),", ",(0,i.jsx)(n.code,{children:"thisArgs"}),"?, ",(0,i.jsx)(n.code,{children:"disposables"}),"?): ",(0,i.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(n.code,{children:"Disposable"})})]}),"\n"]}),"\n",(0,i.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"listener"})]}),"\n",(0,i.jsx)(n.p,{children:"The listener function will be called when the event happens."}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"thisArgs?"}),": ",(0,i.jsx)(n.code,{children:"any"})]}),"\n",(0,i.jsxs)(n.p,{children:["The ",(0,i.jsx)(n.code,{children:"this"}),"-argument which will be used when calling the event listener."]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"disposables?"}),": ",(0,i.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(n.code,{children:"Disposable"})}),"[]"]}),"\n",(0,i.jsxs)(n.p,{children:["An array to which a ",(0,i.jsx)(n.a,{href:"/api/classes/Disposable",children:"Disposable"})," will be added."]}),"\n",(0,i.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(n.code,{children:"Disposable"})})}),"\n",(0,i.jsx)(n.p,{children:"A disposable which unsubscribes the event listener."}),"\n",(0,i.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L3362",children:"packages/extension-api/src/extension-api.d.ts:3362"})})]})}function p(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(d,{...e})}):d(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>o,a:()=>r});var i=s(27378);const t={},c=i.createContext(t);function r(e){const n=i.useContext(c);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:r(e.components),i.createElement(c.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/97c7db18.890c0ba6.js b/assets/js/97c7db18.ff81a9aa.js similarity index 97% rename from assets/js/97c7db18.890c0ba6.js rename to assets/js/97c7db18.ff81a9aa.js index b6732d90840..3d607b86383 100644 --- a/assets/js/97c7db18.890c0ba6.js +++ b/assets/js/97c7db18.ff81a9aa.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[52343],{78092:(n,e,t)=>{t.r(e),t.d(e,{assets:()=>r,contentTitle:()=>s,default:()=>u,frontMatter:()=>a,metadata:()=>c,toc:()=>d});var i=t(24246),o=t(71670);const a={},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:"Function: navigateToContainer()",permalink:"/api/namespaces/navigation/functions/navigateToContainer"},next:{title:"Function: navigateToContainerLogs()",permalink:"/api/namespaces/navigation/functions/navigateToContainerLogs"}},r={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function p(n){const e={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,o.a)(),...n.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(e.h1,{id:"function-navigatetocontainerinspect",children:"Function: navigateToContainerInspect()"}),"\n",(0,i.jsxs)(e.blockquote,{children:["\n",(0,i.jsxs)(e.p,{children:[(0,i.jsx)(e.strong,{children:"navigateToContainerInspect"}),"(",(0,i.jsx)(e.code,{children:"id"}),"): ",(0,i.jsx)(e.code,{children:"Promise"}),"< ",(0,i.jsx)(e.code,{children:"void"})," >"]}),"\n"]}),"\n",(0,i.jsx)(e.h2,{id:"parameters",children:"Parameters"}),"\n",(0,i.jsxs)(e.p,{children:["\u2022 ",(0,i.jsx)(e.strong,{children:"id"}),": ",(0,i.jsx)(e.code,{children:"string"})]}),"\n",(0,i.jsx)(e.h2,{id:"returns",children:"Returns"}),"\n",(0,i.jsxs)(e.p,{children:[(0,i.jsx)(e.code,{children:"Promise"}),"< ",(0,i.jsx)(e.code,{children:"void"})," >"]}),"\n",(0,i.jsx)(e.h2,{id:"source",children:"Source"}),"\n",(0,i.jsx)(e.p,{children:(0,i.jsx)(e.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L4148",children:"packages/extension-api/src/extension-api.d.ts:4148"})})]})}function u(n={}){const{wrapper:e}={...(0,o.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 o={},a=i.createContext(o);function s(n){const e=i.useContext(a);return i.useMemo((function(){return"function"==typeof n?n(e):{...e,...n}}),[e,n])}function c(n){let e;return e=n.disableParentContext?"function"==typeof n.components?n.components(o):n.components||o:s(n.components),i.createElement(a.Provider,{value:e},n.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[52343],{78092:(n,e,t)=>{t.r(e),t.d(e,{assets:()=>r,contentTitle:()=>s,default:()=>u,frontMatter:()=>a,metadata:()=>c,toc:()=>d});var i=t(24246),o=t(71670);const a={},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:"Function: navigateToContainer()",permalink:"/api/namespaces/navigation/functions/navigateToContainer"},next:{title:"Function: navigateToContainerLogs()",permalink:"/api/namespaces/navigation/functions/navigateToContainerLogs"}},r={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function p(n){const e={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,o.a)(),...n.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(e.h1,{id:"function-navigatetocontainerinspect",children:"Function: navigateToContainerInspect()"}),"\n",(0,i.jsxs)(e.blockquote,{children:["\n",(0,i.jsxs)(e.p,{children:[(0,i.jsx)(e.strong,{children:"navigateToContainerInspect"}),"(",(0,i.jsx)(e.code,{children:"id"}),"): ",(0,i.jsx)(e.code,{children:"Promise"}),"< ",(0,i.jsx)(e.code,{children:"void"})," >"]}),"\n"]}),"\n",(0,i.jsx)(e.h2,{id:"parameters",children:"Parameters"}),"\n",(0,i.jsxs)(e.p,{children:["\u2022 ",(0,i.jsx)(e.strong,{children:"id"}),": ",(0,i.jsx)(e.code,{children:"string"})]}),"\n",(0,i.jsx)(e.h2,{id:"returns",children:"Returns"}),"\n",(0,i.jsxs)(e.p,{children:[(0,i.jsx)(e.code,{children:"Promise"}),"< ",(0,i.jsx)(e.code,{children:"void"})," >"]}),"\n",(0,i.jsx)(e.h2,{id:"source",children:"Source"}),"\n",(0,i.jsx)(e.p,{children:(0,i.jsx)(e.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L4148",children:"packages/extension-api/src/extension-api.d.ts:4148"})})]})}function u(n={}){const{wrapper:e}={...(0,o.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 o={},a=i.createContext(o);function s(n){const e=i.useContext(a);return i.useMemo((function(){return"function"==typeof n?n(e):{...e,...n}}),[e,n])}function c(n){let e;return e=n.disableParentContext?"function"==typeof n.components?n.components(o):n.components||o:s(n.components),i.createElement(a.Provider,{value:e},n.children)}}}]); \ No newline at end of file diff --git a/assets/js/97d49594.c2ee2107.js b/assets/js/97d49594.6213b55f.js similarity index 96% rename from assets/js/97d49594.c2ee2107.js rename to assets/js/97d49594.6213b55f.js index 9097c2b15d7..38bc1e3f4bf 100644 --- a/assets/js/97d49594.c2ee2107.js +++ b/assets/js/97d49594.6213b55f.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[45708],{90816:(n,e,i)=>{i.r(e),i.d(e,{assets:()=>a,contentTitle:()=>o,default:()=>p,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:"Function: info()",permalink:"/api/namespaces/containerEngine/functions/info"},next:{title:"Function: listContainers()",permalink:"/api/namespaces/containerEngine/functions/listContainers"}},a={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function 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-inspectcontainer",children:"Function: inspectContainer()"}),"\n",(0,t.jsxs)(e.blockquote,{children:["\n",(0,t.jsxs)(e.p,{children:[(0,t.jsx)(e.strong,{children:"inspectContainer"}),"(",(0,t.jsx)(e.code,{children:"engineId"}),", ",(0,t.jsx)(e.code,{children:"id"}),"): ",(0,t.jsx)(e.code,{children:"Promise"}),"< ",(0,t.jsx)(e.a,{href:"/api/interfaces/ContainerInspectInfo",children:(0,t.jsx)(e.code,{children:"ContainerInspectInfo"})})," >"]}),"\n"]}),"\n",(0,t.jsx)(e.p,{children:"Get the complete low-level information about a specific container."}),"\n",(0,t.jsx)(e.h2,{id:"parameters",children:"Parameters"}),"\n",(0,t.jsxs)(e.p,{children:["\u2022 ",(0,t.jsx)(e.strong,{children:"engineId"}),": ",(0,t.jsx)(e.code,{children:"string"})]}),"\n",(0,t.jsxs)(e.p,{children:["the id of the engine managing the container, obtained from the result of ",(0,t.jsx)(e.a,{href:"/api/namespaces/containerEngine/functions/listContainers",children:"containerEngine.listContainers"})]}),"\n",(0,t.jsxs)(e.p,{children:["\u2022 ",(0,t.jsx)(e.strong,{children:"id"}),": ",(0,t.jsx)(e.code,{children:"string"})]}),"\n",(0,t.jsxs)(e.p,{children:["the id or name of the container on this engine, obtained from the result of ",(0,t.jsx)(e.a,{href:"/api/namespaces/containerEngine/functions/listContainers",children:"containerEngine.listContainers"})," or as the result of ",(0,t.jsx)(e.a,{href:"/api/namespaces/containerEngine/functions/createContainer",children:"containerEngine.createContainer"})]}),"\n",(0,t.jsx)(e.h2,{id:"returns",children:"Returns"}),"\n",(0,t.jsxs)(e.p,{children:[(0,t.jsx)(e.code,{children:"Promise"}),"< ",(0,t.jsx)(e.a,{href:"/api/interfaces/ContainerInspectInfo",children:(0,t.jsx)(e.code,{children:"ContainerInspectInfo"})})," >"]}),"\n",(0,t.jsx)(e.p,{children:"A promise resolving to a structure containing the container information"}),"\n",(0,t.jsx)(e.h2,{id:"source",children:"Source"}),"\n",(0,t.jsx)(e.p,{children:(0,t.jsx)(e.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L3167",children:"packages/extension-api/src/extension-api.d.ts:3167"})})]})}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:()=>o});var t=i(27378);const s={},r=t.createContext(s);function o(n){const e=t.useContext(r);return t.useMemo((function(){return"function"==typeof n?n(e):{...e,...n}}),[e,n])}function c(n){let e;return e=n.disableParentContext?"function"==typeof n.components?n.components(s):n.components||s:o(n.components),t.createElement(r.Provider,{value:e},n.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[45708],{90816:(n,e,i)=>{i.r(e),i.d(e,{assets:()=>a,contentTitle:()=>o,default:()=>p,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:"Function: info()",permalink:"/api/namespaces/containerEngine/functions/info"},next:{title:"Function: listContainers()",permalink:"/api/namespaces/containerEngine/functions/listContainers"}},a={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function 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-inspectcontainer",children:"Function: inspectContainer()"}),"\n",(0,t.jsxs)(e.blockquote,{children:["\n",(0,t.jsxs)(e.p,{children:[(0,t.jsx)(e.strong,{children:"inspectContainer"}),"(",(0,t.jsx)(e.code,{children:"engineId"}),", ",(0,t.jsx)(e.code,{children:"id"}),"): ",(0,t.jsx)(e.code,{children:"Promise"}),"< ",(0,t.jsx)(e.a,{href:"/api/interfaces/ContainerInspectInfo",children:(0,t.jsx)(e.code,{children:"ContainerInspectInfo"})})," >"]}),"\n"]}),"\n",(0,t.jsx)(e.p,{children:"Get the complete low-level information about a specific container."}),"\n",(0,t.jsx)(e.h2,{id:"parameters",children:"Parameters"}),"\n",(0,t.jsxs)(e.p,{children:["\u2022 ",(0,t.jsx)(e.strong,{children:"engineId"}),": ",(0,t.jsx)(e.code,{children:"string"})]}),"\n",(0,t.jsxs)(e.p,{children:["the id of the engine managing the container, obtained from the result of ",(0,t.jsx)(e.a,{href:"/api/namespaces/containerEngine/functions/listContainers",children:"containerEngine.listContainers"})]}),"\n",(0,t.jsxs)(e.p,{children:["\u2022 ",(0,t.jsx)(e.strong,{children:"id"}),": ",(0,t.jsx)(e.code,{children:"string"})]}),"\n",(0,t.jsxs)(e.p,{children:["the id or name of the container on this engine, obtained from the result of ",(0,t.jsx)(e.a,{href:"/api/namespaces/containerEngine/functions/listContainers",children:"containerEngine.listContainers"})," or as the result of ",(0,t.jsx)(e.a,{href:"/api/namespaces/containerEngine/functions/createContainer",children:"containerEngine.createContainer"})]}),"\n",(0,t.jsx)(e.h2,{id:"returns",children:"Returns"}),"\n",(0,t.jsxs)(e.p,{children:[(0,t.jsx)(e.code,{children:"Promise"}),"< ",(0,t.jsx)(e.a,{href:"/api/interfaces/ContainerInspectInfo",children:(0,t.jsx)(e.code,{children:"ContainerInspectInfo"})})," >"]}),"\n",(0,t.jsx)(e.p,{children:"A promise resolving to a structure containing the container information"}),"\n",(0,t.jsx)(e.h2,{id:"source",children:"Source"}),"\n",(0,t.jsx)(e.p,{children:(0,t.jsx)(e.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L3167",children:"packages/extension-api/src/extension-api.d.ts:3167"})})]})}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:()=>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.9b0c29a1.js b/assets/js/97eb992d.b86d82bb.js similarity index 84% rename from assets/js/97eb992d.9b0c29a1.js rename to assets/js/97eb992d.b86d82bb.js index 17dd34039db..429b9c1720b 100644 --- a/assets/js/97eb992d.9b0c29a1.js +++ b/assets/js/97eb992d.b86d82bb.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[53800],{53544:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>d,contentTitle:()=>o,default:()=>h,frontMatter:()=>r,metadata:()=>t,toc:()=>l});var i=s(24246),c=s(71670);const r={},o="Interface: 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:"Interface: NetworkInfo",permalink:"/api/interfaces/NetworkInfo"},next:{title:"Interface: NetworkStats",permalink:"/api/interfaces/NetworkStats"}},d={},l=[{value:"Properties",id:"properties",level:2},{value:"Attachable",id:"attachable",level:3},{value:"Source",id:"source",level:4},{value:"ConfigFrom?",id:"configfrom",level:3},{value:"Network",id:"network",level:4},{value:"Source",id:"source-1",level:4},{value:"ConfigOnly",id:"configonly",level:3},{value:"Source",id:"source-2",level:4},{value:"Containers?",id:"containers",level:3},{value:"Index signature",id:"index-signature",level:4},{value:"Source",id:"source-3",level:4},{value:"Created",id:"created",level:3},{value:"Source",id:"source-4",level:4},{value:"Driver",id:"driver",level:3},{value:"Source",id:"source-5",level:4},{value:"EnableIPv6",id:"enableipv6",level:3},{value:"Source",id:"source-6",level:4},{value:"IPAM?",id:"ipam",level:3},{value:"Source",id:"source-7",level:4},{value:"Id",id:"id",level:3},{value:"Source",id:"source-8",level:4},{value:"Ingress",id:"ingress",level:3},{value:"Source",id:"source-9",level:4},{value:"Internal",id:"internal",level:3},{value:"Source",id:"source-10",level:4},{value:"Labels?",id:"labels",level:3},{value:"Index signature",id:"index-signature-1",level:4},{value:"Source",id:"source-11",level:4},{value:"Name",id:"name",level:3},{value:"Source",id:"source-12",level:4},{value:"Options?",id:"options",level:3},{value:"Index signature",id:"index-signature-2",level:4},{value:"Source",id:"source-13",level:4},{value:"Scope",id:"scope",level:3},{value:"Source",id:"source-14",level:4},{value:"engineId",id:"engineid",level:3},{value:"Source",id:"source-15",level:4},{value:"engineName",id:"enginename",level:3},{value:"Source",id:"source-16",level:4},{value:"engineType",id:"enginetype",level:3},{value:"Source",id:"source-17",level:4}];function a(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,c.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"interface-networkinspectinfo",children:"Interface: NetworkInspectInfo"}),"\n",(0,i.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(n.h3,{id:"attachable",children:"Attachable"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Attachable"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L1975",children:"packages/extension-api/src/extension-api.d.ts:1975"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"configfrom",children:"ConfigFrom?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"ConfigFrom"}),": ",(0,i.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"network",children:"Network"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Network"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L1977",children:"packages/extension-api/src/extension-api.d.ts:1977"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"configonly",children:"ConfigOnly"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"ConfigOnly"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L1978",children:"packages/extension-api/src/extension-api.d.ts:1978"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"containers",children:"Containers?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"Containers"}),": ",(0,i.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"index-signature",children:"Index signature"}),"\n",(0,i.jsxs)(n.p,{children:["[",(0,i.jsx)(n.code,{children:"id"}),": ",(0,i.jsx)(n.code,{children:"string"}),"]: ",(0,i.jsx)(n.a,{href:"/api/interfaces/NetworkContainer",children:(0,i.jsx)(n.code,{children:"NetworkContainer"})})]}),"\n",(0,i.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L1979",children:"packages/extension-api/src/extension-api.d.ts:1979"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"created",children:"Created"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Created"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-4",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L1969",children:"packages/extension-api/src/extension-api.d.ts:1969"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"driver",children:"Driver"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Driver"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-5",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L1971",children:"packages/extension-api/src/extension-api.d.ts:1971"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"enableipv6",children:"EnableIPv6"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"EnableIPv6"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-6",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L1972",children:"packages/extension-api/src/extension-api.d.ts:1972"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"ipam",children:"IPAM?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"IPAM"}),": ",(0,i.jsx)(n.a,{href:"/api/interfaces/IPAM",children:(0,i.jsx)(n.code,{children:"IPAM"})})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-7",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L1973",children:"packages/extension-api/src/extension-api.d.ts:1973"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"id",children:"Id"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Id"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-8",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L1968",children:"packages/extension-api/src/extension-api.d.ts:1968"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"ingress",children:"Ingress"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Ingress"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-9",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L1976",children:"packages/extension-api/src/extension-api.d.ts:1976"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"internal",children:"Internal"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Internal"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-10",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L1974",children:"packages/extension-api/src/extension-api.d.ts:1974"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"labels",children:"Labels?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"Labels"}),": ",(0,i.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"index-signature-1",children:"Index signature"}),"\n",(0,i.jsxs)(n.p,{children:["[",(0,i.jsx)(n.code,{children:"key"}),": ",(0,i.jsx)(n.code,{children:"string"}),"]: ",(0,i.jsx)(n.code,{children:"string"})]}),"\n",(0,i.jsx)(n.h4,{id:"source-11",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L1981",children:"packages/extension-api/src/extension-api.d.ts:1981"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"name",children:"Name"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Name"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-12",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L1967",children:"packages/extension-api/src/extension-api.d.ts:1967"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"options",children:"Options?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"Options"}),": ",(0,i.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"index-signature-2",children:"Index signature"}),"\n",(0,i.jsxs)(n.p,{children:["[",(0,i.jsx)(n.code,{children:"key"}),": ",(0,i.jsx)(n.code,{children:"string"}),"]: ",(0,i.jsx)(n.code,{children:"string"})]}),"\n",(0,i.jsx)(n.h4,{id:"source-13",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L1980",children:"packages/extension-api/src/extension-api.d.ts:1980"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"scope",children:"Scope"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Scope"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-14",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L1970",children:"packages/extension-api/src/extension-api.d.ts:1970"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"engineid",children:"engineId"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"engineId"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-15",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L1964",children:"packages/extension-api/src/extension-api.d.ts:1964"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"enginename",children:"engineName"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"engineName"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-16",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L1965",children:"packages/extension-api/src/extension-api.d.ts:1965"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"enginetype",children:"engineType"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"engineType"}),": ",(0,i.jsx)(n.code,{children:'"docker"'})," | ",(0,i.jsx)(n.code,{children:'"podman"'})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-17",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L1966",children:"packages/extension-api/src/extension-api.d.ts:1966"})})]})}function h(e={}){const{wrapper:n}={...(0,c.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(a,{...e})}):a(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>t,a:()=>o});var i=s(27378);const c={},r=i.createContext(c);function o(e){const n=i.useContext(r);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function t(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(c):e.components||c:o(e.components),i.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[53800],{53544:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>t,contentTitle:()=>o,default:()=>h,frontMatter:()=>r,metadata:()=>d,toc:()=>l});var i=s(24246),c=s(71670);const r={},o="Interface: NetworkInspectInfo",d={id:"interfaces/NetworkInspectInfo",title:"Interface: NetworkInspectInfo",description:"Properties",source:"@site/api/interfaces/NetworkInspectInfo.md",sourceDirName:"interfaces",slug:"/interfaces/NetworkInspectInfo",permalink:"/api/interfaces/NetworkInspectInfo",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: NetworkInfo",permalink:"/api/interfaces/NetworkInfo"},next:{title:"Interface: NetworkStats",permalink:"/api/interfaces/NetworkStats"}},t={},l=[{value:"Properties",id:"properties",level:2},{value:"Attachable",id:"attachable",level:3},{value:"Source",id:"source",level:4},{value:"ConfigFrom?",id:"configfrom",level:3},{value:"Network",id:"network",level:4},{value:"Source",id:"source-1",level:4},{value:"ConfigOnly",id:"configonly",level:3},{value:"Source",id:"source-2",level:4},{value:"Containers?",id:"containers",level:3},{value:"Index signature",id:"index-signature",level:4},{value:"Source",id:"source-3",level:4},{value:"Created",id:"created",level:3},{value:"Source",id:"source-4",level:4},{value:"Driver",id:"driver",level:3},{value:"Source",id:"source-5",level:4},{value:"EnableIPv6",id:"enableipv6",level:3},{value:"Source",id:"source-6",level:4},{value:"IPAM?",id:"ipam",level:3},{value:"Source",id:"source-7",level:4},{value:"Id",id:"id",level:3},{value:"Source",id:"source-8",level:4},{value:"Ingress",id:"ingress",level:3},{value:"Source",id:"source-9",level:4},{value:"Internal",id:"internal",level:3},{value:"Source",id:"source-10",level:4},{value:"Labels?",id:"labels",level:3},{value:"Index signature",id:"index-signature-1",level:4},{value:"Source",id:"source-11",level:4},{value:"Name",id:"name",level:3},{value:"Source",id:"source-12",level:4},{value:"Options?",id:"options",level:3},{value:"Index signature",id:"index-signature-2",level:4},{value:"Source",id:"source-13",level:4},{value:"Scope",id:"scope",level:3},{value:"Source",id:"source-14",level:4},{value:"engineId",id:"engineid",level:3},{value:"Source",id:"source-15",level:4},{value:"engineName",id:"enginename",level:3},{value:"Source",id:"source-16",level:4},{value:"engineType",id:"enginetype",level:3},{value:"Source",id:"source-17",level:4}];function a(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,c.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"interface-networkinspectinfo",children:"Interface: NetworkInspectInfo"}),"\n",(0,i.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(n.h3,{id:"attachable",children:"Attachable"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Attachable"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L1975",children:"packages/extension-api/src/extension-api.d.ts:1975"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"configfrom",children:"ConfigFrom?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"ConfigFrom"}),": ",(0,i.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"network",children:"Network"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Network"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L1977",children:"packages/extension-api/src/extension-api.d.ts:1977"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"configonly",children:"ConfigOnly"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"ConfigOnly"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L1978",children:"packages/extension-api/src/extension-api.d.ts:1978"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"containers",children:"Containers?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"Containers"}),": ",(0,i.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"index-signature",children:"Index signature"}),"\n",(0,i.jsxs)(n.p,{children:["[",(0,i.jsx)(n.code,{children:"id"}),": ",(0,i.jsx)(n.code,{children:"string"}),"]: ",(0,i.jsx)(n.a,{href:"/api/interfaces/NetworkContainer",children:(0,i.jsx)(n.code,{children:"NetworkContainer"})})]}),"\n",(0,i.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L1979",children:"packages/extension-api/src/extension-api.d.ts:1979"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"created",children:"Created"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Created"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-4",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L1969",children:"packages/extension-api/src/extension-api.d.ts:1969"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"driver",children:"Driver"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Driver"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-5",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L1971",children:"packages/extension-api/src/extension-api.d.ts:1971"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"enableipv6",children:"EnableIPv6"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"EnableIPv6"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-6",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L1972",children:"packages/extension-api/src/extension-api.d.ts:1972"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"ipam",children:"IPAM?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"IPAM"}),": ",(0,i.jsx)(n.a,{href:"/api/interfaces/IPAM",children:(0,i.jsx)(n.code,{children:"IPAM"})})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-7",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L1973",children:"packages/extension-api/src/extension-api.d.ts:1973"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"id",children:"Id"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Id"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-8",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L1968",children:"packages/extension-api/src/extension-api.d.ts:1968"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"ingress",children:"Ingress"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Ingress"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-9",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L1976",children:"packages/extension-api/src/extension-api.d.ts:1976"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"internal",children:"Internal"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Internal"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-10",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L1974",children:"packages/extension-api/src/extension-api.d.ts:1974"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"labels",children:"Labels?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"Labels"}),": ",(0,i.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"index-signature-1",children:"Index signature"}),"\n",(0,i.jsxs)(n.p,{children:["[",(0,i.jsx)(n.code,{children:"key"}),": ",(0,i.jsx)(n.code,{children:"string"}),"]: ",(0,i.jsx)(n.code,{children:"string"})]}),"\n",(0,i.jsx)(n.h4,{id:"source-11",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L1981",children:"packages/extension-api/src/extension-api.d.ts:1981"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"name",children:"Name"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Name"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-12",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L1967",children:"packages/extension-api/src/extension-api.d.ts:1967"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"options",children:"Options?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"Options"}),": ",(0,i.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"index-signature-2",children:"Index signature"}),"\n",(0,i.jsxs)(n.p,{children:["[",(0,i.jsx)(n.code,{children:"key"}),": ",(0,i.jsx)(n.code,{children:"string"}),"]: ",(0,i.jsx)(n.code,{children:"string"})]}),"\n",(0,i.jsx)(n.h4,{id:"source-13",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L1980",children:"packages/extension-api/src/extension-api.d.ts:1980"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"scope",children:"Scope"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Scope"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-14",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L1970",children:"packages/extension-api/src/extension-api.d.ts:1970"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"engineid",children:"engineId"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"engineId"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-15",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L1964",children:"packages/extension-api/src/extension-api.d.ts:1964"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"enginename",children:"engineName"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"engineName"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-16",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L1965",children:"packages/extension-api/src/extension-api.d.ts:1965"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"enginetype",children:"engineType"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"engineType"}),": ",(0,i.jsx)(n.code,{children:'"docker"'})," | ",(0,i.jsx)(n.code,{children:'"podman"'})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-17",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L1966",children:"packages/extension-api/src/extension-api.d.ts:1966"})})]})}function h(e={}){const{wrapper:n}={...(0,c.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(a,{...e})}):a(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>d,a:()=>o});var i=s(27378);const c={},r=i.createContext(c);function o(e){const n=i.useContext(r);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function d(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(c):e.components||c:o(e.components),i.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/98ced590.8c808427.js b/assets/js/98ced590.ea0aabec.js similarity index 97% rename from assets/js/98ced590.8c808427.js rename to assets/js/98ced590.ea0aabec.js index 8fcd140e4e8..5fa735c3aa6 100644 --- a/assets/js/98ced590.8c808427.js +++ b/assets/js/98ced590.ea0aabec.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[80325],{46443:(n,e,t)=>{t.r(e),t.d(e,{assets:()=>c,contentTitle:()=>s,default:()=>u,frontMatter:()=>o,metadata:()=>r,toc:()=>d});var i=t(24246),a=t(71670);const o={},s="Function: navigateToContainerTerminal()",r={id:"namespaces/navigation/functions/navigateToContainerTerminal",title:"Function: navigateToContainerTerminal()",description:"navigateToContainerTerminal(id): Promise\\",source:"@site/api/namespaces/navigation/functions/navigateToContainerTerminal.md",sourceDirName:"namespaces/navigation/functions",slug:"/namespaces/navigation/functions/navigateToContainerTerminal",permalink:"/api/namespaces/navigation/functions/navigateToContainerTerminal",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Function: navigateToContainerLogs()",permalink:"/api/namespaces/navigation/functions/navigateToContainerLogs"},next:{title:"Function: navigateToContainers()",permalink:"/api/namespaces/navigation/functions/navigateToContainers"}},c={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function l(n){const e={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,a.a)(),...n.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(e.h1,{id:"function-navigatetocontainerterminal",children:"Function: navigateToContainerTerminal()"}),"\n",(0,i.jsxs)(e.blockquote,{children:["\n",(0,i.jsxs)(e.p,{children:[(0,i.jsx)(e.strong,{children:"navigateToContainerTerminal"}),"(",(0,i.jsx)(e.code,{children:"id"}),"): ",(0,i.jsx)(e.code,{children:"Promise"}),"< ",(0,i.jsx)(e.code,{children:"void"})," >"]}),"\n"]}),"\n",(0,i.jsx)(e.h2,{id:"parameters",children:"Parameters"}),"\n",(0,i.jsxs)(e.p,{children:["\u2022 ",(0,i.jsx)(e.strong,{children:"id"}),": ",(0,i.jsx)(e.code,{children:"string"})]}),"\n",(0,i.jsx)(e.h2,{id:"returns",children:"Returns"}),"\n",(0,i.jsxs)(e.p,{children:[(0,i.jsx)(e.code,{children:"Promise"}),"< ",(0,i.jsx)(e.code,{children:"void"})," >"]}),"\n",(0,i.jsx)(e.h2,{id:"source",children:"Source"}),"\n",(0,i.jsx)(e.p,{children:(0,i.jsx)(e.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L4150",children:"packages/extension-api/src/extension-api.d.ts:4150"})})]})}function u(n={}){const{wrapper:e}={...(0,a.a)(),...n.components};return e?(0,i.jsx)(e,{...n,children:(0,i.jsx)(l,{...n})}):l(n)}},71670:(n,e,t)=>{t.d(e,{Z:()=>r,a:()=>s});var i=t(27378);const a={},o=i.createContext(a);function s(n){const e=i.useContext(o);return i.useMemo((function(){return"function"==typeof n?n(e):{...e,...n}}),[e,n])}function r(n){let e;return e=n.disableParentContext?"function"==typeof n.components?n.components(a):n.components||a:s(n.components),i.createElement(o.Provider,{value:e},n.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[80325],{46443:(n,e,t)=>{t.r(e),t.d(e,{assets:()=>c,contentTitle:()=>s,default:()=>u,frontMatter:()=>o,metadata:()=>r,toc:()=>d});var i=t(24246),a=t(71670);const o={},s="Function: navigateToContainerTerminal()",r={id:"namespaces/navigation/functions/navigateToContainerTerminal",title:"Function: navigateToContainerTerminal()",description:"navigateToContainerTerminal(id): Promise\\",source:"@site/api/namespaces/navigation/functions/navigateToContainerTerminal.md",sourceDirName:"namespaces/navigation/functions",slug:"/namespaces/navigation/functions/navigateToContainerTerminal",permalink:"/api/namespaces/navigation/functions/navigateToContainerTerminal",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Function: navigateToContainerLogs()",permalink:"/api/namespaces/navigation/functions/navigateToContainerLogs"},next:{title:"Function: navigateToContainers()",permalink:"/api/namespaces/navigation/functions/navigateToContainers"}},c={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function l(n){const e={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,a.a)(),...n.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(e.h1,{id:"function-navigatetocontainerterminal",children:"Function: navigateToContainerTerminal()"}),"\n",(0,i.jsxs)(e.blockquote,{children:["\n",(0,i.jsxs)(e.p,{children:[(0,i.jsx)(e.strong,{children:"navigateToContainerTerminal"}),"(",(0,i.jsx)(e.code,{children:"id"}),"): ",(0,i.jsx)(e.code,{children:"Promise"}),"< ",(0,i.jsx)(e.code,{children:"void"})," >"]}),"\n"]}),"\n",(0,i.jsx)(e.h2,{id:"parameters",children:"Parameters"}),"\n",(0,i.jsxs)(e.p,{children:["\u2022 ",(0,i.jsx)(e.strong,{children:"id"}),": ",(0,i.jsx)(e.code,{children:"string"})]}),"\n",(0,i.jsx)(e.h2,{id:"returns",children:"Returns"}),"\n",(0,i.jsxs)(e.p,{children:[(0,i.jsx)(e.code,{children:"Promise"}),"< ",(0,i.jsx)(e.code,{children:"void"})," >"]}),"\n",(0,i.jsx)(e.h2,{id:"source",children:"Source"}),"\n",(0,i.jsx)(e.p,{children:(0,i.jsx)(e.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L4150",children:"packages/extension-api/src/extension-api.d.ts:4150"})})]})}function u(n={}){const{wrapper:e}={...(0,a.a)(),...n.components};return e?(0,i.jsx)(e,{...n,children:(0,i.jsx)(l,{...n})}):l(n)}},71670:(n,e,t)=>{t.d(e,{Z:()=>r,a:()=>s});var i=t(27378);const a={},o=i.createContext(a);function s(n){const e=i.useContext(o);return i.useMemo((function(){return"function"==typeof n?n(e):{...e,...n}}),[e,n])}function r(n){let e;return e=n.disableParentContext?"function"==typeof n.components?n.components(a):n.components||a:s(n.components),i.createElement(o.Provider,{value:e},n.children)}}}]); \ No newline at end of file diff --git a/assets/js/9af13eab.8da8ec28.js b/assets/js/9af13eab.156822f7.js similarity index 97% rename from assets/js/9af13eab.8da8ec28.js rename to assets/js/9af13eab.156822f7.js index 77e9f287a83..5b95633ca4c 100644 --- a/assets/js/9af13eab.8da8ec28.js +++ b/assets/js/9af13eab.156822f7.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[45033],{85516:(n,e,t)=>{t.r(e),t.d(e,{assets:()=>a,contentTitle:()=>c,default:()=>u,frontMatter:()=>r,metadata:()=>s,toc:()=>d});var o=t(24246),i=t(71670);const r={},c="Function: getContainerConnections()",s={id:"namespaces/provider/functions/getContainerConnections",title:"Function: getContainerConnections()",description:"getContainerConnections(): ProviderContainerConnection[]",source:"@site/api/namespaces/provider/functions/getContainerConnections.md",sourceDirName:"namespaces/provider/functions",slug:"/namespaces/provider/functions/getContainerConnections",permalink:"/api/namespaces/provider/functions/getContainerConnections",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Function: createProvider()",permalink:"/api/namespaces/provider/functions/createProvider"},next:{title:"Function: getProviderLifecycleContext()",permalink:"/api/namespaces/provider/functions/getProviderLifecycleContext"}},a={},d=[{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function p(n){const e={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,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:"source",children:"Source"}),"\n",(0,o.jsx)(e.p,{children:(0,o.jsx)(e.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L551",children:"packages/extension-api/src/extension-api.d.ts:551"})})]})}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:()=>s,a:()=>c});var o=t(27378);const i={},r=o.createContext(i);function c(n){const e=o.useContext(r);return o.useMemo((function(){return"function"==typeof n?n(e):{...e,...n}}),[e,n])}function s(n){let e;return e=n.disableParentContext?"function"==typeof n.components?n.components(i):n.components||i:c(n.components),o.createElement(r.Provider,{value:e},n.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[45033],{85516:(n,e,t)=>{t.r(e),t.d(e,{assets:()=>a,contentTitle:()=>c,default:()=>u,frontMatter:()=>r,metadata:()=>s,toc:()=>d});var o=t(24246),i=t(71670);const r={},c="Function: getContainerConnections()",s={id:"namespaces/provider/functions/getContainerConnections",title:"Function: getContainerConnections()",description:"getContainerConnections(): ProviderContainerConnection[]",source:"@site/api/namespaces/provider/functions/getContainerConnections.md",sourceDirName:"namespaces/provider/functions",slug:"/namespaces/provider/functions/getContainerConnections",permalink:"/api/namespaces/provider/functions/getContainerConnections",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Function: createProvider()",permalink:"/api/namespaces/provider/functions/createProvider"},next:{title:"Function: getProviderLifecycleContext()",permalink:"/api/namespaces/provider/functions/getProviderLifecycleContext"}},a={},d=[{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function p(n){const e={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,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:"source",children:"Source"}),"\n",(0,o.jsx)(e.p,{children:(0,o.jsx)(e.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L551",children:"packages/extension-api/src/extension-api.d.ts:551"})})]})}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:()=>s,a:()=>c});var o=t(27378);const i={},r=o.createContext(i);function c(n){const e=o.useContext(r);return o.useMemo((function(){return"function"==typeof n?n(e):{...e,...n}}),[e,n])}function s(n){let e;return e=n.disableParentContext?"function"==typeof n.components?n.components(i):n.components||i:c(n.components),o.createElement(r.Provider,{value:e},n.children)}}}]); \ No newline at end of file diff --git a/assets/js/9c540f0b.354b35e1.js b/assets/js/9c540f0b.cfa53ebb.js similarity index 92% rename from assets/js/9c540f0b.354b35e1.js rename to assets/js/9c540f0b.cfa53ebb.js index 60fa08d35b9..7fdb47abc10 100644 --- a/assets/js/9c540f0b.354b35e1.js +++ b/assets/js/9c540f0b.cfa53ebb.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[14026],{29698:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>d,contentTitle:()=>r,default:()=>h,frontMatter:()=>c,metadata:()=>t,toc:()=>l});var i=s(24246),o=s(71670);const c={},r="Interface: MountSettings",t={id:"interfaces/MountSettings",title:"Interface: MountSettings",description:"Properties",source:"@site/api/interfaces/MountSettings.md",sourceDirName:"interfaces",slug:"/interfaces/MountSettings",permalink:"/api/interfaces/MountSettings",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: MenuItem",permalink:"/api/interfaces/MenuItem"},next:{title:"Interface: NetworkContainer",permalink:"/api/interfaces/NetworkContainer"}},d={},l=[{value:"Properties",id:"properties",level:2},{value:"BindOptions?",id:"bindoptions",level:3},{value:"Propagation",id:"propagation",level:4},{value:"Source",id:"source",level:4},{value:"Consistency?",id:"consistency",level:3},{value:"Source",id:"source-1",level:4},{value:"Mode?",id:"mode",level:3},{value:"Source",id:"source-2",level:4},{value:"ReadOnly?",id:"readonly",level:3},{value:"Source",id:"source-3",level:4},{value:"Source",id:"source-4",level:3},{value:"Source",id:"source-5",level:4},{value:"Target",id:"target",level:3},{value:"Source",id:"source-6",level:4},{value:"TmpfsOptions?",id:"tmpfsoptions",level:3},{value:"Mode",id:"mode-1",level:4},{value:"SizeBytes",id:"sizebytes",level:4},{value:"Source",id:"source-7",level:4},{value:"Type",id:"type",level:3},{value:"Source",id:"source-8",level:4},{value:"VolumeOptions?",id:"volumeoptions",level:3},{value:"DriverConfig",id:"driverconfig",level:4},{value:"DriverConfig.Name",id:"driverconfigname",level:4},{value:"DriverConfig.Options",id:"driverconfigoptions",level:4},{value:"Index signature",id:"index-signature",level:5},{value:"Labels",id:"labels",level:4},{value:"Index signature",id:"index-signature-1",level:5},{value:"NoCopy",id:"nocopy",level:4},{value:"Source",id:"source-9",level:4}];function a(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",h5:"h5",hr:"hr",p:"p",strong:"strong",...(0,o.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"interface-mountsettings",children:"Interface: MountSettings"}),"\n",(0,i.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(n.h3,{id:"bindoptions",children:"BindOptions?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"BindOptions"}),": ",(0,i.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"propagation",children:"Propagation"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Propagation"}),": ",(0,i.jsx)(n.a,{href:"/api/type-aliases/MountPropagation",children:(0,i.jsx)(n.code,{children:"MountPropagation"})})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2101",children:"packages/extension-api/src/extension-api.d.ts:2101"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"consistency",children:"Consistency?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"Consistency"}),": ",(0,i.jsx)(n.a,{href:"/api/type-aliases/MountConsistency",children:(0,i.jsx)(n.code,{children:"MountConsistency"})})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2099",children:"packages/extension-api/src/extension-api.d.ts:2099"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"mode",children:"Mode?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"Mode"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2100",children:"packages/extension-api/src/extension-api.d.ts:2100"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"readonly",children:"ReadOnly?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"ReadOnly"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2098",children:"packages/extension-api/src/extension-api.d.ts:2098"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"source-4",children:"Source"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Source"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-5",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2096",children:"packages/extension-api/src/extension-api.d.ts:2096"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"target",children:"Target"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Target"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-6",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2095",children:"packages/extension-api/src/extension-api.d.ts:2095"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"tmpfsoptions",children:"TmpfsOptions?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"TmpfsOptions"}),": ",(0,i.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"mode-1",children:"Mode"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Mode"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"sizebytes",children:"SizeBytes"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"SizeBytes"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-7",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2112",children:"packages/extension-api/src/extension-api.d.ts:2112"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"type",children:"Type"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Type"}),": ",(0,i.jsx)(n.a,{href:"/api/type-aliases/MountType",children:(0,i.jsx)(n.code,{children:"MountType"})})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-8",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2097",children:"packages/extension-api/src/extension-api.d.ts:2097"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"volumeoptions",children:"VolumeOptions?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"VolumeOptions"}),": ",(0,i.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"driverconfig",children:"DriverConfig"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"DriverConfig"}),": ",(0,i.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"driverconfigname",children:"DriverConfig.Name"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Name"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"driverconfigoptions",children:"DriverConfig.Options"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Options"}),": ",(0,i.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsx)(n.h5,{id:"index-signature",children:"Index signature"}),"\n",(0,i.jsxs)(n.p,{children:["[",(0,i.jsx)(n.code,{children:"option"}),": ",(0,i.jsx)(n.code,{children:"string"}),"]: ",(0,i.jsx)(n.code,{children:"string"})]}),"\n",(0,i.jsx)(n.h4,{id:"labels",children:"Labels"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Labels"}),": ",(0,i.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsx)(n.h5,{id:"index-signature-1",children:"Index signature"}),"\n",(0,i.jsxs)(n.p,{children:["[",(0,i.jsx)(n.code,{children:"label"}),": ",(0,i.jsx)(n.code,{children:"string"}),"]: ",(0,i.jsx)(n.code,{children:"string"})]}),"\n",(0,i.jsx)(n.h4,{id:"nocopy",children:"NoCopy"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"NoCopy"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-9",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2104",children:"packages/extension-api/src/extension-api.d.ts:2104"})})]})}function h(e={}){const{wrapper:n}={...(0,o.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(a,{...e})}):a(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>t,a:()=>r});var i=s(27378);const o={},c=i.createContext(o);function r(e){const n=i.useContext(c);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function t(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:r(e.components),i.createElement(c.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[14026],{29698:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>d,contentTitle:()=>r,default:()=>h,frontMatter:()=>c,metadata:()=>t,toc:()=>l});var i=s(24246),o=s(71670);const c={},r="Interface: MountSettings",t={id:"interfaces/MountSettings",title:"Interface: MountSettings",description:"Properties",source:"@site/api/interfaces/MountSettings.md",sourceDirName:"interfaces",slug:"/interfaces/MountSettings",permalink:"/api/interfaces/MountSettings",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: MenuItem",permalink:"/api/interfaces/MenuItem"},next:{title:"Interface: NetworkContainer",permalink:"/api/interfaces/NetworkContainer"}},d={},l=[{value:"Properties",id:"properties",level:2},{value:"BindOptions?",id:"bindoptions",level:3},{value:"Propagation",id:"propagation",level:4},{value:"Source",id:"source",level:4},{value:"Consistency?",id:"consistency",level:3},{value:"Source",id:"source-1",level:4},{value:"Mode?",id:"mode",level:3},{value:"Source",id:"source-2",level:4},{value:"ReadOnly?",id:"readonly",level:3},{value:"Source",id:"source-3",level:4},{value:"Source",id:"source-4",level:3},{value:"Source",id:"source-5",level:4},{value:"Target",id:"target",level:3},{value:"Source",id:"source-6",level:4},{value:"TmpfsOptions?",id:"tmpfsoptions",level:3},{value:"Mode",id:"mode-1",level:4},{value:"SizeBytes",id:"sizebytes",level:4},{value:"Source",id:"source-7",level:4},{value:"Type",id:"type",level:3},{value:"Source",id:"source-8",level:4},{value:"VolumeOptions?",id:"volumeoptions",level:3},{value:"DriverConfig",id:"driverconfig",level:4},{value:"DriverConfig.Name",id:"driverconfigname",level:4},{value:"DriverConfig.Options",id:"driverconfigoptions",level:4},{value:"Index signature",id:"index-signature",level:5},{value:"Labels",id:"labels",level:4},{value:"Index signature",id:"index-signature-1",level:5},{value:"NoCopy",id:"nocopy",level:4},{value:"Source",id:"source-9",level:4}];function a(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",h5:"h5",hr:"hr",p:"p",strong:"strong",...(0,o.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"interface-mountsettings",children:"Interface: MountSettings"}),"\n",(0,i.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(n.h3,{id:"bindoptions",children:"BindOptions?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"BindOptions"}),": ",(0,i.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"propagation",children:"Propagation"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Propagation"}),": ",(0,i.jsx)(n.a,{href:"/api/type-aliases/MountPropagation",children:(0,i.jsx)(n.code,{children:"MountPropagation"})})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2101",children:"packages/extension-api/src/extension-api.d.ts:2101"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"consistency",children:"Consistency?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"Consistency"}),": ",(0,i.jsx)(n.a,{href:"/api/type-aliases/MountConsistency",children:(0,i.jsx)(n.code,{children:"MountConsistency"})})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2099",children:"packages/extension-api/src/extension-api.d.ts:2099"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"mode",children:"Mode?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"Mode"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2100",children:"packages/extension-api/src/extension-api.d.ts:2100"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"readonly",children:"ReadOnly?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"ReadOnly"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2098",children:"packages/extension-api/src/extension-api.d.ts:2098"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"source-4",children:"Source"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Source"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-5",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2096",children:"packages/extension-api/src/extension-api.d.ts:2096"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"target",children:"Target"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Target"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-6",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2095",children:"packages/extension-api/src/extension-api.d.ts:2095"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"tmpfsoptions",children:"TmpfsOptions?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"TmpfsOptions"}),": ",(0,i.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"mode-1",children:"Mode"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Mode"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"sizebytes",children:"SizeBytes"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"SizeBytes"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-7",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2112",children:"packages/extension-api/src/extension-api.d.ts:2112"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"type",children:"Type"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Type"}),": ",(0,i.jsx)(n.a,{href:"/api/type-aliases/MountType",children:(0,i.jsx)(n.code,{children:"MountType"})})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-8",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2097",children:"packages/extension-api/src/extension-api.d.ts:2097"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"volumeoptions",children:"VolumeOptions?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"VolumeOptions"}),": ",(0,i.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"driverconfig",children:"DriverConfig"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"DriverConfig"}),": ",(0,i.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"driverconfigname",children:"DriverConfig.Name"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Name"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"driverconfigoptions",children:"DriverConfig.Options"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Options"}),": ",(0,i.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsx)(n.h5,{id:"index-signature",children:"Index signature"}),"\n",(0,i.jsxs)(n.p,{children:["[",(0,i.jsx)(n.code,{children:"option"}),": ",(0,i.jsx)(n.code,{children:"string"}),"]: ",(0,i.jsx)(n.code,{children:"string"})]}),"\n",(0,i.jsx)(n.h4,{id:"labels",children:"Labels"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Labels"}),": ",(0,i.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsx)(n.h5,{id:"index-signature-1",children:"Index signature"}),"\n",(0,i.jsxs)(n.p,{children:["[",(0,i.jsx)(n.code,{children:"label"}),": ",(0,i.jsx)(n.code,{children:"string"}),"]: ",(0,i.jsx)(n.code,{children:"string"})]}),"\n",(0,i.jsx)(n.h4,{id:"nocopy",children:"NoCopy"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"NoCopy"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-9",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2104",children:"packages/extension-api/src/extension-api.d.ts:2104"})})]})}function h(e={}){const{wrapper:n}={...(0,o.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(a,{...e})}):a(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>t,a:()=>r});var i=s(27378);const o={},c=i.createContext(o);function r(e){const n=i.useContext(c);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function t(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:r(e.components),i.createElement(c.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/9d2d4743.2d36c3d3.js b/assets/js/9d2d4743.6470cd8c.js similarity index 97% rename from assets/js/9d2d4743.2d36c3d3.js rename to assets/js/9d2d4743.6470cd8c.js index d4ed3704c54..9d20170700f 100644 --- a/assets/js/9d2d4743.2d36c3d3.js +++ b/assets/js/9d2d4743.6470cd8c.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[89731],{22313:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>c,default:()=>l,frontMatter:()=>i,metadata:()=>s,toc:()=>d});var o=t(24246),r=t(71670);const i={},c="Interface: ContainerProviderConnectionEndpoint",s={id:"interfaces/ContainerProviderConnectionEndpoint",title:"Interface: ContainerProviderConnectionEndpoint",description:"Properties",source:"@site/api/interfaces/ContainerProviderConnectionEndpoint.md",sourceDirName:"interfaces",slug:"/interfaces/ContainerProviderConnectionEndpoint",permalink:"/api/interfaces/ContainerProviderConnectionEndpoint",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: ContainerProviderConnection",permalink:"/api/interfaces/ContainerProviderConnection"},next:{title:"Interface: ContainerProviderConnectionFactory",permalink:"/api/interfaces/ContainerProviderConnectionFactory"}},a={},d=[{value:"Properties",id:"properties",level:2},{value:"socketPath",id:"socketpath",level:3},{value:"Source",id:"source",level:4}];function p(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",p:"p",strong:"strong",...(0,r.a)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(n.h1,{id:"interface-containerproviderconnectionendpoint",children:"Interface: ContainerProviderConnectionEndpoint"}),"\n",(0,o.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,o.jsx)(n.h3,{id:"socketpath",children:"socketPath"}),"\n",(0,o.jsxs)(n.blockquote,{children:["\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.strong,{children:"socketPath"}),": ",(0,o.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,o.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,o.jsx)(n.p,{children:(0,o.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L261",children:"packages/extension-api/src/extension-api.d.ts:261"})})]})}function l(e={}){const{wrapper:n}={...(0,r.a)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(p,{...e})}):p(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>s,a:()=>c});var o=t(27378);const r={},i=o.createContext(r);function c(e){const n=o.useContext(i);return o.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function s(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:c(e.components),o.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[89731],{22313:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>c,default:()=>l,frontMatter:()=>i,metadata:()=>s,toc:()=>d});var o=t(24246),r=t(71670);const i={},c="Interface: ContainerProviderConnectionEndpoint",s={id:"interfaces/ContainerProviderConnectionEndpoint",title:"Interface: ContainerProviderConnectionEndpoint",description:"Properties",source:"@site/api/interfaces/ContainerProviderConnectionEndpoint.md",sourceDirName:"interfaces",slug:"/interfaces/ContainerProviderConnectionEndpoint",permalink:"/api/interfaces/ContainerProviderConnectionEndpoint",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: ContainerProviderConnection",permalink:"/api/interfaces/ContainerProviderConnection"},next:{title:"Interface: ContainerProviderConnectionFactory",permalink:"/api/interfaces/ContainerProviderConnectionFactory"}},a={},d=[{value:"Properties",id:"properties",level:2},{value:"socketPath",id:"socketpath",level:3},{value:"Source",id:"source",level:4}];function p(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",p:"p",strong:"strong",...(0,r.a)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(n.h1,{id:"interface-containerproviderconnectionendpoint",children:"Interface: ContainerProviderConnectionEndpoint"}),"\n",(0,o.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,o.jsx)(n.h3,{id:"socketpath",children:"socketPath"}),"\n",(0,o.jsxs)(n.blockquote,{children:["\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.strong,{children:"socketPath"}),": ",(0,o.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,o.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,o.jsx)(n.p,{children:(0,o.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L261",children:"packages/extension-api/src/extension-api.d.ts:261"})})]})}function l(e={}){const{wrapper:n}={...(0,r.a)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(p,{...e})}):p(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>s,a:()=>c});var o=t(27378);const r={},i=o.createContext(r);function c(e){const n=o.useContext(i);return o.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function s(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:c(e.components),o.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/9d887a11.42b6bc62.js b/assets/js/9d887a11.139663b0.js similarity index 96% rename from assets/js/9d887a11.42b6bc62.js rename to assets/js/9d887a11.139663b0.js index f55da197a54..232b29077be 100644 --- a/assets/js/9d887a11.42b6bc62.js +++ b/assets/js/9d887a11.139663b0.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[24904],{94806:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>o,contentTitle:()=>r,default:()=>p,frontMatter:()=>c,metadata:()=>a,toc:()=>l});var i=t(24246),s=t(71670);const c={},r="Function: createWebviewPanel()",a={id:"namespaces/window/functions/createWebviewPanel",title:"Function: createWebviewPanel()",description:"createWebviewPanel(viewType, title, options?): WebviewPanel",source:"@site/api/namespaces/window/functions/createWebviewPanel.md",sourceDirName:"namespaces/window/functions",slug:"/namespaces/window/functions/createWebviewPanel",permalink:"/api/namespaces/window/functions/createWebviewPanel",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Function: createStatusBarItem()",permalink:"/api/namespaces/window/functions/createStatusBarItem"},next:{title:"Function: listWebviews()",permalink:"/api/namespaces/window/functions/listWebviews"}},o={},l=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function d(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"function-createwebviewpanel",children:"Function: createWebviewPanel()"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"createWebviewPanel"}),"(",(0,i.jsx)(n.code,{children:"viewType"}),", ",(0,i.jsx)(n.code,{children:"title"}),", ",(0,i.jsx)(n.code,{children:"options"}),"?): ",(0,i.jsx)(n.a,{href:"/api/interfaces/WebviewPanel",children:(0,i.jsx)(n.code,{children:"WebviewPanel"})})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Create and show a new webview panel."}),"\n",(0,i.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"viewType"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n",(0,i.jsx)(n.p,{children:"Identifies the type of the webview panel."}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"title"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n",(0,i.jsx)(n.p,{children:"Title of the panel."}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"options?"}),": ",(0,i.jsx)(n.a,{href:"/api/interfaces/WebviewOptions",children:(0,i.jsx)(n.code,{children:"WebviewOptions"})})]}),"\n",(0,i.jsx)(n.p,{children:"Settings for the new panel."}),"\n",(0,i.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"/api/interfaces/WebviewPanel",children:(0,i.jsx)(n.code,{children:"WebviewPanel"})})}),"\n",(0,i.jsx)(n.p,{children:"New webview panel."}),"\n",(0,i.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L1795",children:"packages/extension-api/src/extension-api.d.ts:1795"})})]})}function p(e={}){const{wrapper:n}={...(0,s.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(d,{...e})}):d(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>a,a:()=>r});var i=t(27378);const s={},c=i.createContext(s);function r(e){const n=i.useContext(c);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function a(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:r(e.components),i.createElement(c.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[24904],{94806:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>o,contentTitle:()=>r,default:()=>p,frontMatter:()=>c,metadata:()=>a,toc:()=>l});var i=t(24246),s=t(71670);const c={},r="Function: createWebviewPanel()",a={id:"namespaces/window/functions/createWebviewPanel",title:"Function: createWebviewPanel()",description:"createWebviewPanel(viewType, title, options?): WebviewPanel",source:"@site/api/namespaces/window/functions/createWebviewPanel.md",sourceDirName:"namespaces/window/functions",slug:"/namespaces/window/functions/createWebviewPanel",permalink:"/api/namespaces/window/functions/createWebviewPanel",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Function: createStatusBarItem()",permalink:"/api/namespaces/window/functions/createStatusBarItem"},next:{title:"Function: listWebviews()",permalink:"/api/namespaces/window/functions/listWebviews"}},o={},l=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function d(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"function-createwebviewpanel",children:"Function: createWebviewPanel()"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"createWebviewPanel"}),"(",(0,i.jsx)(n.code,{children:"viewType"}),", ",(0,i.jsx)(n.code,{children:"title"}),", ",(0,i.jsx)(n.code,{children:"options"}),"?): ",(0,i.jsx)(n.a,{href:"/api/interfaces/WebviewPanel",children:(0,i.jsx)(n.code,{children:"WebviewPanel"})})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Create and show a new webview panel."}),"\n",(0,i.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"viewType"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n",(0,i.jsx)(n.p,{children:"Identifies the type of the webview panel."}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"title"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n",(0,i.jsx)(n.p,{children:"Title of the panel."}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"options?"}),": ",(0,i.jsx)(n.a,{href:"/api/interfaces/WebviewOptions",children:(0,i.jsx)(n.code,{children:"WebviewOptions"})})]}),"\n",(0,i.jsx)(n.p,{children:"Settings for the new panel."}),"\n",(0,i.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"/api/interfaces/WebviewPanel",children:(0,i.jsx)(n.code,{children:"WebviewPanel"})})}),"\n",(0,i.jsx)(n.p,{children:"New webview panel."}),"\n",(0,i.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L1795",children:"packages/extension-api/src/extension-api.d.ts:1795"})})]})}function p(e={}){const{wrapper:n}={...(0,s.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(d,{...e})}):d(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>a,a:()=>r});var i=t(27378);const s={},c=i.createContext(s);function r(e){const n=i.useContext(c);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function a(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:r(e.components),i.createElement(c.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/9db962b6.e52a7b2c.js b/assets/js/9db962b6.3dc46992.js similarity index 93% rename from assets/js/9db962b6.e52a7b2c.js rename to assets/js/9db962b6.3dc46992.js index 6813678da53..41b5b044294 100644 --- a/assets/js/9db962b6.e52a7b2c.js +++ b/assets/js/9db962b6.3dc46992.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[41644],{54100:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>a,contentTitle:()=>r,default:()=>p,frontMatter:()=>o,metadata:()=>c,toc:()=>d});var i=s(24246),t=s(71670);const o={},r="Function: onDidUpdateKubernetesConnection()",c={id:"namespaces/provider/functions/onDidUpdateKubernetesConnection",title:"Function: onDidUpdateKubernetesConnection()",description:"onDidUpdateKubernetesConnection(listener, thisArgs?, disposables?): Disposable",source:"@site/api/namespaces/provider/functions/onDidUpdateKubernetesConnection.md",sourceDirName:"namespaces/provider/functions",slug:"/namespaces/provider/functions/onDidUpdateKubernetesConnection",permalink:"/api/namespaces/provider/functions/onDidUpdateKubernetesConnection",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Function: onDidUpdateContainerConnection()",permalink:"/api/namespaces/provider/functions/onDidUpdateContainerConnection"},next:{title:"Function: onDidUpdateProvider()",permalink:"/api/namespaces/provider/functions/onDidUpdateProvider"}},a={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,t.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"function-ondidupdatekubernetesconnection",children:"Function: onDidUpdateKubernetesConnection()"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"onDidUpdateKubernetesConnection"}),"(",(0,i.jsx)(n.code,{children:"listener"}),", ",(0,i.jsx)(n.code,{children:"thisArgs"}),"?, ",(0,i.jsx)(n.code,{children:"disposables"}),"?): ",(0,i.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(n.code,{children:"Disposable"})})]}),"\n"]}),"\n",(0,i.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"listener"})]}),"\n",(0,i.jsx)(n.p,{children:"The listener function will be called when the event happens."}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"thisArgs?"}),": ",(0,i.jsx)(n.code,{children:"any"})]}),"\n",(0,i.jsxs)(n.p,{children:["The ",(0,i.jsx)(n.code,{children:"this"}),"-argument which will be used when calling the event listener."]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"disposables?"}),": ",(0,i.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(n.code,{children:"Disposable"})}),"[]"]}),"\n",(0,i.jsxs)(n.p,{children:["An array to which a ",(0,i.jsx)(n.a,{href:"/api/classes/Disposable",children:"Disposable"})," will be added."]}),"\n",(0,i.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(n.code,{children:"Disposable"})})}),"\n",(0,i.jsx)(n.p,{children:"A disposable which unsubscribes the event listener."}),"\n",(0,i.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L548",children:"packages/extension-api/src/extension-api.d.ts:548"})})]})}function p(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>c,a:()=>r});var i=s(27378);const t={},o=i.createContext(t);function r(e){const n=i.useContext(o);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:r(e.components),i.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[41644],{54100:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>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:"Function: onDidUpdateContainerConnection()",permalink:"/api/namespaces/provider/functions/onDidUpdateContainerConnection"},next:{title:"Function: onDidUpdateProvider()",permalink:"/api/namespaces/provider/functions/onDidUpdateProvider"}},d={},a=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,t.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"function-ondidupdatekubernetesconnection",children:"Function: onDidUpdateKubernetesConnection()"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"onDidUpdateKubernetesConnection"}),"(",(0,i.jsx)(n.code,{children:"listener"}),", ",(0,i.jsx)(n.code,{children:"thisArgs"}),"?, ",(0,i.jsx)(n.code,{children:"disposables"}),"?): ",(0,i.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(n.code,{children:"Disposable"})})]}),"\n"]}),"\n",(0,i.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"listener"})]}),"\n",(0,i.jsx)(n.p,{children:"The listener function will be called when the event happens."}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"thisArgs?"}),": ",(0,i.jsx)(n.code,{children:"any"})]}),"\n",(0,i.jsxs)(n.p,{children:["The ",(0,i.jsx)(n.code,{children:"this"}),"-argument which will be used when calling the event listener."]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"disposables?"}),": ",(0,i.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(n.code,{children:"Disposable"})}),"[]"]}),"\n",(0,i.jsxs)(n.p,{children:["An array to which a ",(0,i.jsx)(n.a,{href:"/api/classes/Disposable",children:"Disposable"})," will be added."]}),"\n",(0,i.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(n.code,{children:"Disposable"})})}),"\n",(0,i.jsx)(n.p,{children:"A disposable which unsubscribes the event listener."}),"\n",(0,i.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L548",children:"packages/extension-api/src/extension-api.d.ts:548"})})]})}function p(e={}){const{wrapper:n}={...(0,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.9874c0f0.js b/assets/js/9dd60997.245c5ffe.js similarity index 98% rename from assets/js/9dd60997.9874c0f0.js rename to assets/js/9dd60997.245c5ffe.js index 498f2852ed5..609dddd507e 100644 --- a/assets/js/9dd60997.9874c0f0.js +++ b/assets/js/9dd60997.245c5ffe.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[76518],{27456:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>d,contentTitle:()=>r,default:()=>p,frontMatter:()=>o,metadata:()=>c,toc:()=>a});var i=s(24246),t=s(71670);const o={},r="Function: getSession()",c={id:"namespaces/authentication/functions/getSession",title:"Function: getSession()",description:"getSession(providerId, scopes, options)",source:"@site/api/namespaces/authentication/functions/getSession.md",sourceDirName:"namespaces/authentication/functions",slug:"/namespaces/authentication/functions/getSession",permalink:"/api/namespaces/authentication/functions/getSession",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Namespace: authentication",permalink:"/api/namespaces/authentication/"},next:{title:"Function: onDidChangeSessions()",permalink:"/api/namespaces/authentication/functions/onDidChangeSessions"}},d={},a=[{value:"getSession(providerId, scopes, options)",id:"getsessionproviderid-scopes-options",level:2},{value:"Parameters",id:"parameters",level:3},{value:"Returns",id:"returns",level:3},{value:"Source",id:"source",level:3},{value:"getSession(providerId, scopes, options)",id:"getsessionproviderid-scopes-options-1",level:2},{value:"Parameters",id:"parameters-1",level:3},{value:"Returns",id:"returns-1",level:3},{value:"Source",id:"source-1",level:3}];function h(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",p:"p",strong:"strong",...(0,t.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"function-getsession",children:"Function: getSession()"}),"\n",(0,i.jsx)(n.h2,{id:"getsessionproviderid-scopes-options",children:"getSession(providerId, scopes, options)"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"getSession"}),"(",(0,i.jsx)(n.code,{children:"providerId"}),", ",(0,i.jsx)(n.code,{children:"scopes"}),", ",(0,i.jsx)(n.code,{children:"options"}),"): ",(0,i.jsx)(n.code,{children:"Promise"}),"< ",(0,i.jsx)(n.a,{href:"/api/interfaces/AuthenticationSession",children:(0,i.jsx)(n.code,{children:"AuthenticationSession"})})," | ",(0,i.jsx)(n.code,{children:"undefined"})," >"]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Get an authentication session matching the desired scopes. Rejects if a provider with providerId is not\nregistered, or if the user does not consent to sharing authentication information with\nthe extension. If there are multiple sessions with the same scopes, the user will be shown a\nquickpick to select which account they would like to use."}),"\n",(0,i.jsx)(n.p,{children:"Currently, there are only two authentication providers that are contributed from built in extensions\nto VS Code that implement GitHub and Microsoft authentication: their providerId's are 'github' and 'microsoft'."}),"\n",(0,i.jsx)(n.h3,{id:"parameters",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"providerId"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n",(0,i.jsx)(n.p,{children:"The id of the provider to use"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"scopes"}),": ",(0,i.jsx)(n.code,{children:"string"}),"[]"]}),"\n",(0,i.jsx)(n.p,{children:"A list of scopes representing the permissions requested. These are dependent on the authentication provider"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"options"}),": ",(0,i.jsx)(n.a,{href:"/api/interfaces/AuthenticationGetSessionOptions",children:(0,i.jsx)(n.code,{children:"AuthenticationGetSessionOptions"})})," & ",(0,i.jsx)(n.code,{children:"object"})]}),"\n",(0,i.jsxs)(n.p,{children:["The ",(0,i.jsx)(n.a,{href:"#GetSessionOptions",children:"getSessionOptions"})," to use"]}),"\n",(0,i.jsx)(n.h3,{id:"returns",children:"Returns"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"Promise"}),"< ",(0,i.jsx)(n.a,{href:"/api/interfaces/AuthenticationSession",children:(0,i.jsx)(n.code,{children:"AuthenticationSession"})})," | ",(0,i.jsx)(n.code,{children:"undefined"})," >"]}),"\n",(0,i.jsx)(n.p,{children:"A promise that resolves to an authentication session"}),"\n",(0,i.jsx)(n.h3,{id:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L3606",children:"packages/extension-api/src/extension-api.d.ts:3606"})}),"\n",(0,i.jsx)(n.h2,{id:"getsessionproviderid-scopes-options-1",children:"getSession(providerId, scopes, options)"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"getSession"}),"(",(0,i.jsx)(n.code,{children:"providerId"}),", ",(0,i.jsx)(n.code,{children:"scopes"}),", ",(0,i.jsx)(n.code,{children:"options"}),"?): ",(0,i.jsx)(n.code,{children:"Promise"}),"< ",(0,i.jsx)(n.a,{href:"/api/interfaces/AuthenticationSession",children:(0,i.jsx)(n.code,{children:"AuthenticationSession"})})," | ",(0,i.jsx)(n.code,{children:"undefined"})," >"]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Get an authentication session matching the desired scopes. Rejects if a provider with providerId is not\nregistered, or if the user does not consent to sharing authentication information with\nthe extension. If there are multiple sessions with the same scopes, the user will be shown a\nquickpick to select which account they would like to use."}),"\n",(0,i.jsx)(n.p,{children:"Currently, there are only two authentication providers that are contributed from built in extensions\nto VS Code that implement GitHub and Microsoft authentication: their providerId's are 'github' and 'microsoft'."}),"\n",(0,i.jsx)(n.h3,{id:"parameters-1",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"providerId"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n",(0,i.jsx)(n.p,{children:"The id of the provider to use"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"scopes"}),": ",(0,i.jsx)(n.code,{children:"string"}),"[]"]}),"\n",(0,i.jsx)(n.p,{children:"A list of scopes representing the permissions requested. These are dependent on the authentication provider"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"options?"}),": ",(0,i.jsx)(n.a,{href:"/api/interfaces/AuthenticationGetSessionOptions",children:(0,i.jsx)(n.code,{children:"AuthenticationGetSessionOptions"})})]}),"\n",(0,i.jsxs)(n.p,{children:["The ",(0,i.jsx)(n.a,{href:"#GetSessionOptions",children:"getSessionOptions"})," to use"]}),"\n",(0,i.jsx)(n.h3,{id:"returns-1",children:"Returns"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"Promise"}),"< ",(0,i.jsx)(n.a,{href:"/api/interfaces/AuthenticationSession",children:(0,i.jsx)(n.code,{children:"AuthenticationSession"})})," | ",(0,i.jsx)(n.code,{children:"undefined"})," >"]}),"\n",(0,i.jsx)(n.p,{children:"A promise that resolves to an authentication session if available, or undefined if there are no sessions"}),"\n",(0,i.jsx)(n.h3,{id:"source-1",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/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,t.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(h,{...e})}):h(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>c,a:()=>r});var i=s(27378);const t={},o=i.createContext(t);function r(e){const n=i.useContext(o);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:r(e.components),i.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[76518],{27456:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>d,contentTitle:()=>r,default:()=>p,frontMatter:()=>o,metadata:()=>c,toc:()=>a});var i=s(24246),t=s(71670);const o={},r="Function: getSession()",c={id:"namespaces/authentication/functions/getSession",title:"Function: getSession()",description:"getSession(providerId, scopes, options)",source:"@site/api/namespaces/authentication/functions/getSession.md",sourceDirName:"namespaces/authentication/functions",slug:"/namespaces/authentication/functions/getSession",permalink:"/api/namespaces/authentication/functions/getSession",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Namespace: authentication",permalink:"/api/namespaces/authentication/"},next:{title:"Function: onDidChangeSessions()",permalink:"/api/namespaces/authentication/functions/onDidChangeSessions"}},d={},a=[{value:"getSession(providerId, scopes, options)",id:"getsessionproviderid-scopes-options",level:2},{value:"Parameters",id:"parameters",level:3},{value:"Returns",id:"returns",level:3},{value:"Source",id:"source",level:3},{value:"getSession(providerId, scopes, options)",id:"getsessionproviderid-scopes-options-1",level:2},{value:"Parameters",id:"parameters-1",level:3},{value:"Returns",id:"returns-1",level:3},{value:"Source",id:"source-1",level:3}];function h(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",p:"p",strong:"strong",...(0,t.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"function-getsession",children:"Function: getSession()"}),"\n",(0,i.jsx)(n.h2,{id:"getsessionproviderid-scopes-options",children:"getSession(providerId, scopes, options)"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"getSession"}),"(",(0,i.jsx)(n.code,{children:"providerId"}),", ",(0,i.jsx)(n.code,{children:"scopes"}),", ",(0,i.jsx)(n.code,{children:"options"}),"): ",(0,i.jsx)(n.code,{children:"Promise"}),"< ",(0,i.jsx)(n.a,{href:"/api/interfaces/AuthenticationSession",children:(0,i.jsx)(n.code,{children:"AuthenticationSession"})})," | ",(0,i.jsx)(n.code,{children:"undefined"})," >"]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Get an authentication session matching the desired scopes. Rejects if a provider with providerId is not\nregistered, or if the user does not consent to sharing authentication information with\nthe extension. If there are multiple sessions with the same scopes, the user will be shown a\nquickpick to select which account they would like to use."}),"\n",(0,i.jsx)(n.p,{children:"Currently, there are only two authentication providers that are contributed from built in extensions\nto VS Code that implement GitHub and Microsoft authentication: their providerId's are 'github' and 'microsoft'."}),"\n",(0,i.jsx)(n.h3,{id:"parameters",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"providerId"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n",(0,i.jsx)(n.p,{children:"The id of the provider to use"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"scopes"}),": ",(0,i.jsx)(n.code,{children:"string"}),"[]"]}),"\n",(0,i.jsx)(n.p,{children:"A list of scopes representing the permissions requested. These are dependent on the authentication provider"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"options"}),": ",(0,i.jsx)(n.a,{href:"/api/interfaces/AuthenticationGetSessionOptions",children:(0,i.jsx)(n.code,{children:"AuthenticationGetSessionOptions"})})," & ",(0,i.jsx)(n.code,{children:"object"})]}),"\n",(0,i.jsxs)(n.p,{children:["The ",(0,i.jsx)(n.a,{href:"#GetSessionOptions",children:"getSessionOptions"})," to use"]}),"\n",(0,i.jsx)(n.h3,{id:"returns",children:"Returns"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"Promise"}),"< ",(0,i.jsx)(n.a,{href:"/api/interfaces/AuthenticationSession",children:(0,i.jsx)(n.code,{children:"AuthenticationSession"})})," | ",(0,i.jsx)(n.code,{children:"undefined"})," >"]}),"\n",(0,i.jsx)(n.p,{children:"A promise that resolves to an authentication session"}),"\n",(0,i.jsx)(n.h3,{id:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L3606",children:"packages/extension-api/src/extension-api.d.ts:3606"})}),"\n",(0,i.jsx)(n.h2,{id:"getsessionproviderid-scopes-options-1",children:"getSession(providerId, scopes, options)"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"getSession"}),"(",(0,i.jsx)(n.code,{children:"providerId"}),", ",(0,i.jsx)(n.code,{children:"scopes"}),", ",(0,i.jsx)(n.code,{children:"options"}),"?): ",(0,i.jsx)(n.code,{children:"Promise"}),"< ",(0,i.jsx)(n.a,{href:"/api/interfaces/AuthenticationSession",children:(0,i.jsx)(n.code,{children:"AuthenticationSession"})})," | ",(0,i.jsx)(n.code,{children:"undefined"})," >"]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Get an authentication session matching the desired scopes. Rejects if a provider with providerId is not\nregistered, or if the user does not consent to sharing authentication information with\nthe extension. If there are multiple sessions with the same scopes, the user will be shown a\nquickpick to select which account they would like to use."}),"\n",(0,i.jsx)(n.p,{children:"Currently, there are only two authentication providers that are contributed from built in extensions\nto VS Code that implement GitHub and Microsoft authentication: their providerId's are 'github' and 'microsoft'."}),"\n",(0,i.jsx)(n.h3,{id:"parameters-1",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"providerId"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n",(0,i.jsx)(n.p,{children:"The id of the provider to use"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"scopes"}),": ",(0,i.jsx)(n.code,{children:"string"}),"[]"]}),"\n",(0,i.jsx)(n.p,{children:"A list of scopes representing the permissions requested. These are dependent on the authentication provider"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"options?"}),": ",(0,i.jsx)(n.a,{href:"/api/interfaces/AuthenticationGetSessionOptions",children:(0,i.jsx)(n.code,{children:"AuthenticationGetSessionOptions"})})]}),"\n",(0,i.jsxs)(n.p,{children:["The ",(0,i.jsx)(n.a,{href:"#GetSessionOptions",children:"getSessionOptions"})," to use"]}),"\n",(0,i.jsx)(n.h3,{id:"returns-1",children:"Returns"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"Promise"}),"< ",(0,i.jsx)(n.a,{href:"/api/interfaces/AuthenticationSession",children:(0,i.jsx)(n.code,{children:"AuthenticationSession"})})," | ",(0,i.jsx)(n.code,{children:"undefined"})," >"]}),"\n",(0,i.jsx)(n.p,{children:"A promise that resolves to an authentication session if available, or undefined if there are no sessions"}),"\n",(0,i.jsx)(n.h3,{id:"source-1",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/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,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.61512d3e.js b/assets/js/a08dfa31.b783495f.js similarity index 89% rename from assets/js/a08dfa31.61512d3e.js rename to assets/js/a08dfa31.b783495f.js index 449d4c50886..ec970bfb6ed 100644 --- a/assets/js/a08dfa31.61512d3e.js +++ b/assets/js/a08dfa31.b783495f.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[69006],{95971:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>d,contentTitle:()=>o,default:()=>h,frontMatter:()=>c,metadata:()=>t,toc:()=>a});var i=s(24246),r=s(71670);const c={},o="Interface: ProviderOptions",t={id:"interfaces/ProviderOptions",title:"Interface: ProviderOptions",description:"Properties",source:"@site/api/interfaces/ProviderOptions.md",sourceDirName:"interfaces",slug:"/interfaces/ProviderOptions",permalink:"/api/interfaces/ProviderOptions",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: ProviderLifecycle",permalink:"/api/interfaces/ProviderLifecycle"},next:{title:"Interface: ProviderUpdate",permalink:"/api/interfaces/ProviderUpdate"}},d={},a=[{value:"Properties",id:"properties",level:2},{value:"detectionChecks?",id:"detectionchecks",level:3},{value:"Source",id:"source",level:4},{value:"emptyConnectionMarkdownDescription?",id:"emptyconnectionmarkdowndescription",level:3},{value:"Source",id:"source-1",level:4},{value:"id",id:"id",level:3},{value:"Source",id:"source-2",level:4},{value:"images?",id:"images",level:3},{value:"Source",id:"source-3",level:4},{value:"links?",id:"links",level:3},{value:"Source",id:"source-4",level:4},{value:"name",id:"name",level:3},{value:"Source",id:"source-5",level:4},{value:"status",id:"status",level:3},{value:"Source",id:"source-6",level:4},{value:"version?",id:"version",level:3},{value:"Source",id:"source-7",level:4},{value:"warnings?",id:"warnings",level:3},{value:"Source",id:"source-8",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,r.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"interface-provideroptions",children:"Interface: ProviderOptions"}),"\n",(0,i.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(n.h3,{id:"detectionchecks",children:"detectionChecks?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"detectionChecks"}),": ",(0,i.jsx)(n.a,{href:"/api/interfaces/ProviderDetectionCheck",children:(0,i.jsx)(n.code,{children:"ProviderDetectionCheck"})}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L223",children:"packages/extension-api/src/extension-api.d.ts:223"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"emptyconnectionmarkdowndescription",children:"emptyConnectionMarkdownDescription?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"emptyConnectionMarkdownDescription"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L229",children:"packages/extension-api/src/extension-api.d.ts:229"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"id",children:"id"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"id"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L217",children:"packages/extension-api/src/extension-api.d.ts:217"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"images",children:"images?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"images"}),": ",(0,i.jsx)(n.a,{href:"/api/interfaces/ProviderImages",children:(0,i.jsx)(n.code,{children:"ProviderImages"})})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L221",children:"packages/extension-api/src/extension-api.d.ts:221"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"links",children:"links?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"links"}),": ",(0,i.jsx)(n.a,{href:"/api/interfaces/Link",children:(0,i.jsx)(n.code,{children:"Link"})}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-4",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L222",children:"packages/extension-api/src/extension-api.d.ts:222"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"name",children:"name"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"name"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-5",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L218",children:"packages/extension-api/src/extension-api.d.ts:218"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"status",children:"status"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"status"}),": ",(0,i.jsx)(n.a,{href:"/api/type-aliases/ProviderStatus",children:(0,i.jsx)(n.code,{children:"ProviderStatus"})})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-6",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L219",children:"packages/extension-api/src/extension-api.d.ts:219"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"version",children:"version?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"version"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-7",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L220",children:"packages/extension-api/src/extension-api.d.ts:220"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"warnings",children:"warnings?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"warnings"}),": ",(0,i.jsx)(n.a,{href:"/api/interfaces/ProviderInformation",children:(0,i.jsx)(n.code,{children:"ProviderInformation"})}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-8",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L226",children:"packages/extension-api/src/extension-api.d.ts:226"})})]})}function h(e={}){const{wrapper:n}={...(0,r.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>t,a:()=>o});var i=s(27378);const r={},c=i.createContext(r);function o(e){const n=i.useContext(c);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function t(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:o(e.components),i.createElement(c.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[69006],{95971:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>d,contentTitle:()=>o,default:()=>h,frontMatter:()=>c,metadata:()=>t,toc:()=>a});var i=s(24246),r=s(71670);const c={},o="Interface: ProviderOptions",t={id:"interfaces/ProviderOptions",title:"Interface: ProviderOptions",description:"Properties",source:"@site/api/interfaces/ProviderOptions.md",sourceDirName:"interfaces",slug:"/interfaces/ProviderOptions",permalink:"/api/interfaces/ProviderOptions",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: ProviderLifecycle",permalink:"/api/interfaces/ProviderLifecycle"},next:{title:"Interface: ProviderUpdate",permalink:"/api/interfaces/ProviderUpdate"}},d={},a=[{value:"Properties",id:"properties",level:2},{value:"detectionChecks?",id:"detectionchecks",level:3},{value:"Source",id:"source",level:4},{value:"emptyConnectionMarkdownDescription?",id:"emptyconnectionmarkdowndescription",level:3},{value:"Source",id:"source-1",level:4},{value:"id",id:"id",level:3},{value:"Source",id:"source-2",level:4},{value:"images?",id:"images",level:3},{value:"Source",id:"source-3",level:4},{value:"links?",id:"links",level:3},{value:"Source",id:"source-4",level:4},{value:"name",id:"name",level:3},{value:"Source",id:"source-5",level:4},{value:"status",id:"status",level:3},{value:"Source",id:"source-6",level:4},{value:"version?",id:"version",level:3},{value:"Source",id:"source-7",level:4},{value:"warnings?",id:"warnings",level:3},{value:"Source",id:"source-8",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,r.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"interface-provideroptions",children:"Interface: ProviderOptions"}),"\n",(0,i.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(n.h3,{id:"detectionchecks",children:"detectionChecks?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"detectionChecks"}),": ",(0,i.jsx)(n.a,{href:"/api/interfaces/ProviderDetectionCheck",children:(0,i.jsx)(n.code,{children:"ProviderDetectionCheck"})}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L223",children:"packages/extension-api/src/extension-api.d.ts:223"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"emptyconnectionmarkdowndescription",children:"emptyConnectionMarkdownDescription?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"emptyConnectionMarkdownDescription"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L229",children:"packages/extension-api/src/extension-api.d.ts:229"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"id",children:"id"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"id"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L217",children:"packages/extension-api/src/extension-api.d.ts:217"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"images",children:"images?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"images"}),": ",(0,i.jsx)(n.a,{href:"/api/interfaces/ProviderImages",children:(0,i.jsx)(n.code,{children:"ProviderImages"})})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L221",children:"packages/extension-api/src/extension-api.d.ts:221"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"links",children:"links?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"links"}),": ",(0,i.jsx)(n.a,{href:"/api/interfaces/Link",children:(0,i.jsx)(n.code,{children:"Link"})}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-4",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L222",children:"packages/extension-api/src/extension-api.d.ts:222"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"name",children:"name"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"name"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-5",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L218",children:"packages/extension-api/src/extension-api.d.ts:218"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"status",children:"status"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"status"}),": ",(0,i.jsx)(n.a,{href:"/api/type-aliases/ProviderStatus",children:(0,i.jsx)(n.code,{children:"ProviderStatus"})})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-6",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L219",children:"packages/extension-api/src/extension-api.d.ts:219"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"version",children:"version?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"version"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-7",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L220",children:"packages/extension-api/src/extension-api.d.ts:220"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"warnings",children:"warnings?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"warnings"}),": ",(0,i.jsx)(n.a,{href:"/api/interfaces/ProviderInformation",children:(0,i.jsx)(n.code,{children:"ProviderInformation"})}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-8",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L226",children:"packages/extension-api/src/extension-api.d.ts:226"})})]})}function h(e={}){const{wrapper:n}={...(0,r.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>t,a:()=>o});var i=s(27378);const r={},c=i.createContext(r);function o(e){const n=i.useContext(c);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function t(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:o(e.components),i.createElement(c.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/a2c6f402.3f84d72b.js b/assets/js/a2c6f402.85586986.js similarity index 94% rename from assets/js/a2c6f402.3f84d72b.js rename to assets/js/a2c6f402.85586986.js index 24386bfd3ec..b87a210c7a6 100644 --- a/assets/js/a2c6f402.3f84d72b.js +++ b/assets/js/a2c6f402.85586986.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[6266],{79199:(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="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:"Type alias: ProviderConnectionStatus",permalink:"/api/type-aliases/ProviderConnectionStatus"},next:{title:"Type alias: ProviderResult\\",permalink:"/api/type-aliases/ProviderResult"}},c={},d=[{value:"Source",id:"source",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,i.a)(),...e.components};return(0,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:"source",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L419",children:"packages/extension-api/src/extension-api.d.ts:419"})})]})}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 +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[6266],{79199:(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="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:"Type alias: ProviderConnectionStatus",permalink:"/api/type-aliases/ProviderConnectionStatus"},next:{title:"Type alias: ProviderResult\\",permalink:"/api/type-aliases/ProviderResult"}},c={},d=[{value:"Source",id:"source",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,i.a)(),...e.components};return(0,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:"source",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L419",children:"packages/extension-api/src/extension-api.d.ts:419"})})]})}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/a2d1ff94.cd42370c.js b/assets/js/a2d1ff94.02a3412b.js similarity index 87% rename from assets/js/a2d1ff94.cd42370c.js rename to assets/js/a2d1ff94.02a3412b.js index 05c64735547..debcaeb6a45 100644 --- a/assets/js/a2d1ff94.cd42370c.js +++ b/assets/js/a2d1ff94.02a3412b.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[41169],{65150:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>a,contentTitle:()=>s,default:()=>p,frontMatter:()=>o,metadata:()=>c,toc:()=>d});var r=i(24246),t=i(71670);const o={},s="Interface: ContainerProviderConnection",c={id:"interfaces/ContainerProviderConnection",title:"Interface: ContainerProviderConnection",description:"Properties",source:"@site/api/interfaces/ContainerProviderConnection.md",sourceDirName:"interfaces",slug:"/interfaces/ContainerProviderConnection",permalink:"/api/interfaces/ContainerProviderConnection",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: ContainerJSONEvent",permalink:"/api/interfaces/ContainerJSONEvent"},next:{title:"Interface: ContainerProviderConnectionEndpoint",permalink:"/api/interfaces/ContainerProviderConnectionEndpoint"}},a={},d=[{value:"Properties",id:"properties",level:2},{value:"endpoint",id:"endpoint",level:3},{value:"Source",id:"source",level:4},{value:"lifecycle?",id:"lifecycle",level:3},{value:"Source",id:"source-1",level:4},{value:"name",id:"name",level:3},{value:"Source",id:"source-2",level:4},{value:"type",id:"type",level:3},{value:"Source",id:"source-3",level:4},{value:"Methods",id:"methods",level:2},{value:"status()",id:"status",level:3},{value:"Returns",id:"returns",level:4},{value:"Source",id:"source-4",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,t.a)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.h1,{id:"interface-containerproviderconnection",children:"Interface: ContainerProviderConnection"}),"\n",(0,r.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,r.jsx)(n.h3,{id:"endpoint",children:"endpoint"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"endpoint"}),": ",(0,r.jsx)(n.a,{href:"/api/interfaces/ContainerProviderConnectionEndpoint",children:(0,r.jsx)(n.code,{children:"ContainerProviderConnectionEndpoint"})})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L267",children:"packages/extension-api/src/extension-api.d.ts:267"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"lifecycle",children:"lifecycle?"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"optional"})})," ",(0,r.jsx)(n.strong,{children:"lifecycle"}),": ",(0,r.jsx)(n.a,{href:"/api/interfaces/ProviderConnectionLifecycle",children:(0,r.jsx)(n.code,{children:"ProviderConnectionLifecycle"})})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L268",children:"packages/extension-api/src/extension-api.d.ts:268"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"name",children:"name"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"name"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L265",children:"packages/extension-api/src/extension-api.d.ts:265"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"type",children:"type"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"type"}),": ",(0,r.jsx)(n.code,{children:'"docker"'})," | ",(0,r.jsx)(n.code,{children:'"podman"'})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L266",children:"packages/extension-api/src/extension-api.d.ts:266"})}),"\n",(0,r.jsx)(n.h2,{id:"methods",children:"Methods"}),"\n",(0,r.jsx)(n.h3,{id:"status",children:"status()"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"status"}),"(): ",(0,r.jsx)(n.a,{href:"/api/type-aliases/ProviderConnectionStatus",children:(0,r.jsx)(n.code,{children:"ProviderConnectionStatus"})})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"returns",children:"Returns"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"/api/type-aliases/ProviderConnectionStatus",children:(0,r.jsx)(n.code,{children:"ProviderConnectionStatus"})})}),"\n",(0,r.jsx)(n.h4,{id:"source-4",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L269",children:"packages/extension-api/src/extension-api.d.ts:269"})})]})}function p(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(l,{...e})}):l(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>c,a:()=>s});var r=i(27378);const t={},o=r.createContext(t);function s(e){const n=r.useContext(o);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:s(e.components),r.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[41169],{65150:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>d,contentTitle:()=>s,default:()=>p,frontMatter:()=>o,metadata:()=>c,toc:()=>a});var r=i(24246),t=i(71670);const o={},s="Interface: ContainerProviderConnection",c={id:"interfaces/ContainerProviderConnection",title:"Interface: ContainerProviderConnection",description:"Properties",source:"@site/api/interfaces/ContainerProviderConnection.md",sourceDirName:"interfaces",slug:"/interfaces/ContainerProviderConnection",permalink:"/api/interfaces/ContainerProviderConnection",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: ContainerJSONEvent",permalink:"/api/interfaces/ContainerJSONEvent"},next:{title:"Interface: ContainerProviderConnectionEndpoint",permalink:"/api/interfaces/ContainerProviderConnectionEndpoint"}},d={},a=[{value:"Properties",id:"properties",level:2},{value:"endpoint",id:"endpoint",level:3},{value:"Source",id:"source",level:4},{value:"lifecycle?",id:"lifecycle",level:3},{value:"Source",id:"source-1",level:4},{value:"name",id:"name",level:3},{value:"Source",id:"source-2",level:4},{value:"type",id:"type",level:3},{value:"Source",id:"source-3",level:4},{value:"Methods",id:"methods",level:2},{value:"status()",id:"status",level:3},{value:"Returns",id:"returns",level:4},{value:"Source",id:"source-4",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,t.a)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.h1,{id:"interface-containerproviderconnection",children:"Interface: ContainerProviderConnection"}),"\n",(0,r.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,r.jsx)(n.h3,{id:"endpoint",children:"endpoint"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"endpoint"}),": ",(0,r.jsx)(n.a,{href:"/api/interfaces/ContainerProviderConnectionEndpoint",children:(0,r.jsx)(n.code,{children:"ContainerProviderConnectionEndpoint"})})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L267",children:"packages/extension-api/src/extension-api.d.ts:267"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"lifecycle",children:"lifecycle?"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"optional"})})," ",(0,r.jsx)(n.strong,{children:"lifecycle"}),": ",(0,r.jsx)(n.a,{href:"/api/interfaces/ProviderConnectionLifecycle",children:(0,r.jsx)(n.code,{children:"ProviderConnectionLifecycle"})})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L268",children:"packages/extension-api/src/extension-api.d.ts:268"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"name",children:"name"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"name"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L265",children:"packages/extension-api/src/extension-api.d.ts:265"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"type",children:"type"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"type"}),": ",(0,r.jsx)(n.code,{children:'"docker"'})," | ",(0,r.jsx)(n.code,{children:'"podman"'})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L266",children:"packages/extension-api/src/extension-api.d.ts:266"})}),"\n",(0,r.jsx)(n.h2,{id:"methods",children:"Methods"}),"\n",(0,r.jsx)(n.h3,{id:"status",children:"status()"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"status"}),"(): ",(0,r.jsx)(n.a,{href:"/api/type-aliases/ProviderConnectionStatus",children:(0,r.jsx)(n.code,{children:"ProviderConnectionStatus"})})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"returns",children:"Returns"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"/api/type-aliases/ProviderConnectionStatus",children:(0,r.jsx)(n.code,{children:"ProviderConnectionStatus"})})}),"\n",(0,r.jsx)(n.h4,{id:"source-4",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L269",children:"packages/extension-api/src/extension-api.d.ts:269"})})]})}function p(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(l,{...e})}):l(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>c,a:()=>s});var r=i(27378);const t={},o=r.createContext(t);function s(e){const n=r.useContext(o);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:s(e.components),r.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/a2ffcc0f.53e8c703.js b/assets/js/a2ffcc0f.fa69250d.js similarity index 96% rename from assets/js/a2ffcc0f.53e8c703.js rename to assets/js/a2ffcc0f.fa69250d.js index 59fd74efa3a..9dab1a36f7a 100644 --- a/assets/js/a2ffcc0f.53e8c703.js +++ b/assets/js/a2ffcc0f.fa69250d.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[51843],{49351:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>a,contentTitle:()=>i,default:()=>p,frontMatter:()=>o,metadata:()=>c,toc:()=>u});var s=r(24246),t=r(71670);const o={},i="Function: registerKubernetesGenerator()",c={id:"namespaces/kubernetes/functions/registerKubernetesGenerator",title:"Function: registerKubernetesGenerator()",description:"registerKubernetesGenerator(provider): Disposable",source:"@site/api/namespaces/kubernetes/functions/registerKubernetesGenerator.md",sourceDirName:"namespaces/kubernetes/functions",slug:"/namespaces/kubernetes/functions/registerKubernetesGenerator",permalink:"/api/namespaces/kubernetes/functions/registerKubernetesGenerator",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Function: onDidUpdateKubeconfig()",permalink:"/api/namespaces/kubernetes/functions/onDidUpdateKubeconfig"},next:{title:"Function: setKubeconfig()",permalink:"/api/namespaces/kubernetes/functions/setKubeconfig"}},a={},u=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function d(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,t.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"function-registerkubernetesgenerator",children:"Function: registerKubernetesGenerator()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"registerKubernetesGenerator"}),"(",(0,s.jsx)(n.code,{children:"provider"}),"): ",(0,s.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,s.jsx)(n.code,{children:"Disposable"})})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Add a KubernetesGenerator to KubernetesGeneratorRegistry"}),"\n",(0,s.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"provider"}),": ",(0,s.jsx)(n.a,{href:"/api/interfaces/KubernetesGeneratorProvider",children:(0,s.jsx)(n.code,{children:"KubernetesGeneratorProvider"})})]}),"\n",(0,s.jsx)(n.p,{children:"the custom provider to add"}),"\n",(0,s.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,s.jsx)(n.code,{children:"Disposable"})})}),"\n",(0,s.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L1819",children:"packages/extension-api/src/extension-api.d.ts:1819"})})]})}function p(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(d,{...e})}):d(e)}},71670:(e,n,r)=>{r.d(n,{Z:()=>c,a:()=>i});var s=r(27378);const t={},o=s.createContext(t);function i(e){const n=s.useContext(o);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:i(e.components),s.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[51843],{49351:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>a,contentTitle:()=>i,default:()=>p,frontMatter:()=>o,metadata:()=>c,toc:()=>u});var s=r(24246),t=r(71670);const o={},i="Function: registerKubernetesGenerator()",c={id:"namespaces/kubernetes/functions/registerKubernetesGenerator",title:"Function: registerKubernetesGenerator()",description:"registerKubernetesGenerator(provider): Disposable",source:"@site/api/namespaces/kubernetes/functions/registerKubernetesGenerator.md",sourceDirName:"namespaces/kubernetes/functions",slug:"/namespaces/kubernetes/functions/registerKubernetesGenerator",permalink:"/api/namespaces/kubernetes/functions/registerKubernetesGenerator",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Function: onDidUpdateKubeconfig()",permalink:"/api/namespaces/kubernetes/functions/onDidUpdateKubeconfig"},next:{title:"Function: setKubeconfig()",permalink:"/api/namespaces/kubernetes/functions/setKubeconfig"}},a={},u=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function d(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,t.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"function-registerkubernetesgenerator",children:"Function: registerKubernetesGenerator()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"registerKubernetesGenerator"}),"(",(0,s.jsx)(n.code,{children:"provider"}),"): ",(0,s.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,s.jsx)(n.code,{children:"Disposable"})})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Add a KubernetesGenerator to KubernetesGeneratorRegistry"}),"\n",(0,s.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"provider"}),": ",(0,s.jsx)(n.a,{href:"/api/interfaces/KubernetesGeneratorProvider",children:(0,s.jsx)(n.code,{children:"KubernetesGeneratorProvider"})})]}),"\n",(0,s.jsx)(n.p,{children:"the custom provider to add"}),"\n",(0,s.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,s.jsx)(n.code,{children:"Disposable"})})}),"\n",(0,s.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L1819",children:"packages/extension-api/src/extension-api.d.ts:1819"})})]})}function p(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(d,{...e})}):d(e)}},71670:(e,n,r)=>{r.d(n,{Z:()=>c,a:()=>i});var s=r(27378);const t={},o=s.createContext(t);function i(e){const n=s.useContext(o);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:i(e.components),s.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/a3002291.4e03a42c.js b/assets/js/a3002291.b3dadeca.js similarity index 98% rename from assets/js/a3002291.4e03a42c.js rename to assets/js/a3002291.b3dadeca.js index 6c8e9ff607f..dc640dbee4f 100644 --- a/assets/js/a3002291.4e03a42c.js +++ b/assets/js/a3002291.b3dadeca.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[36424],{483:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>i,default:()=>u,frontMatter:()=>c,metadata:()=>s,toc:()=>d});var r=t(24246),o=t(71670);const c={},i="Function: createNetwork()",s={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:"Function: createManifest()",permalink:"/api/namespaces/containerEngine/functions/createManifest"},next:{title:"Function: createPod()",permalink:"/api/namespaces/containerEngine/functions/createPod"}},a={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,o.a)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.h1,{id:"function-createnetwork",children:"Function: createNetwork()"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"createNetwork"}),"(",(0,r.jsx)(n.code,{children:"containerProviderConnection"}),", ",(0,r.jsx)(n.code,{children:"networkCreateOptions"}),"): ",(0,r.jsx)(n.code,{children:"Promise"}),"< ",(0,r.jsx)(n.a,{href:"/api/interfaces/NetworkCreateResult",children:(0,r.jsx)(n.code,{children:"NetworkCreateResult"})})," >"]}),"\n"]}),"\n",(0,r.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"containerProviderConnection"}),": ",(0,r.jsx)(n.a,{href:"/api/interfaces/ContainerProviderConnection",children:(0,r.jsx)(n.code,{children:"ContainerProviderConnection"})})]}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"networkCreateOptions"}),": ",(0,r.jsx)(n.a,{href:"/api/interfaces/NetworkCreateOptions",children:(0,r.jsx)(n.code,{children:"NetworkCreateOptions"})})]}),"\n",(0,r.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"Promise"}),"< ",(0,r.jsx)(n.a,{href:"/api/interfaces/NetworkCreateResult",children:(0,r.jsx)(n.code,{children:"NetworkCreateResult"})})," >"]}),"\n",(0,r.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L3365",children:"packages/extension-api/src/extension-api.d.ts:3365"})})]})}function u(e={}){const{wrapper:n}={...(0,o.a)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(l,{...e})}):l(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>s,a:()=>i});var r=t(27378);const o={},c=r.createContext(o);function i(e){const n=r.useContext(c);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function s(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:i(e.components),r.createElement(c.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[36424],{483:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>i,default:()=>u,frontMatter:()=>c,metadata:()=>s,toc:()=>d});var r=t(24246),o=t(71670);const c={},i="Function: createNetwork()",s={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:"Function: createManifest()",permalink:"/api/namespaces/containerEngine/functions/createManifest"},next:{title:"Function: createPod()",permalink:"/api/namespaces/containerEngine/functions/createPod"}},a={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,o.a)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.h1,{id:"function-createnetwork",children:"Function: createNetwork()"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"createNetwork"}),"(",(0,r.jsx)(n.code,{children:"containerProviderConnection"}),", ",(0,r.jsx)(n.code,{children:"networkCreateOptions"}),"): ",(0,r.jsx)(n.code,{children:"Promise"}),"< ",(0,r.jsx)(n.a,{href:"/api/interfaces/NetworkCreateResult",children:(0,r.jsx)(n.code,{children:"NetworkCreateResult"})})," >"]}),"\n"]}),"\n",(0,r.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"containerProviderConnection"}),": ",(0,r.jsx)(n.a,{href:"/api/interfaces/ContainerProviderConnection",children:(0,r.jsx)(n.code,{children:"ContainerProviderConnection"})})]}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"networkCreateOptions"}),": ",(0,r.jsx)(n.a,{href:"/api/interfaces/NetworkCreateOptions",children:(0,r.jsx)(n.code,{children:"NetworkCreateOptions"})})]}),"\n",(0,r.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"Promise"}),"< ",(0,r.jsx)(n.a,{href:"/api/interfaces/NetworkCreateResult",children:(0,r.jsx)(n.code,{children:"NetworkCreateResult"})})," >"]}),"\n",(0,r.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L3365",children:"packages/extension-api/src/extension-api.d.ts:3365"})})]})}function u(e={}){const{wrapper:n}={...(0,o.a)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(l,{...e})}):l(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>s,a:()=>i});var r=t(27378);const o={},c=r.createContext(o);function i(e){const n=r.useContext(c);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function s(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:i(e.components),r.createElement(c.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/a30c0d44.e51907d0.js b/assets/js/a30c0d44.9dae885d.js similarity index 91% rename from assets/js/a30c0d44.e51907d0.js rename to assets/js/a30c0d44.9dae885d.js index f0a3e693d5f..dea237bf3b8 100644 --- a/assets/js/a30c0d44.e51907d0.js +++ b/assets/js/a30c0d44.9dae885d.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[64891],{47516:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>l,contentTitle:()=>r,default:()=>h,frontMatter:()=>o,metadata:()=>c,toc:()=>d});var i=s(24246),t=s(71670);const o={},r="Interface: InputBoxOptions",c={id:"interfaces/InputBoxOptions",title:"Interface: InputBoxOptions",description:"Options to configure the behavior of the input box UI.",source:"@site/api/interfaces/InputBoxOptions.md",sourceDirName:"interfaces",slug:"/interfaces/InputBoxOptions",permalink:"/api/interfaces/InputBoxOptions",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: ImageInspectInfo",permalink:"/api/interfaces/ImageInspectInfo"},next:{title:"Interface: InputBoxValidationMessage",permalink:"/api/interfaces/InputBoxValidationMessage"}},l={},d=[{value:"Properties",id:"properties",level:2},{value:"ignoreFocusOut?",id:"ignorefocusout",level:3},{value:"Source",id:"source",level:4},{value:"markdownDescription?",id:"markdowndescription",level:3},{value:"Source",id:"source-1",level:4},{value:"multiline?",id:"multiline",level:3},{value:"Source",id:"source-2",level:4},{value:"password?",id:"password",level:3},{value:"Source",id:"source-3",level:4},{value:"placeHolder?",id:"placeholder",level:3},{value:"Source",id:"source-4",level:4},{value:"prompt?",id:"prompt",level:3},{value:"Source",id:"source-5",level:4},{value:"title?",id:"title",level:3},{value:"Source",id:"source-6",level:4},{value:"value?",id:"value",level:3},{value:"Source",id:"source-7",level:4},{value:"valueSelection?",id:"valueselection",level:3},{value:"Source",id:"source-8",level:4},{value:"Methods",id:"methods",level:2},{value:"validateInput()?",id:"validateinput",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Source",id:"source-9",level:4}];function a(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,t.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"interface-inputboxoptions",children:"Interface: InputBoxOptions"}),"\n",(0,i.jsx)(n.p,{children:"Options to configure the behavior of the input box UI."}),"\n",(0,i.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(n.h3,{id:"ignorefocusout",children:"ignoreFocusOut?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"ignoreFocusOut"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Set to ",(0,i.jsx)(n.code,{children:"true"})," to keep the input box open when focus moves to another part of the editor or to another window.\nThis setting is ignored on iPad and is always false."]}),"\n",(0,i.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L880",children:"packages/extension-api/src/extension-api.d.ts:880"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"markdowndescription",children:"markdownDescription?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"markdownDescription"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"A description of the field to be show (Markdown format)"}),"\n",(0,i.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L864",children:"packages/extension-api/src/extension-api.d.ts:864"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"multiline",children:"multiline?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"multiline"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Set to ",(0,i.jsx)(n.code,{children:"true"})," when value represents a multi line content."]}),"\n",(0,i.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L885",children:"packages/extension-api/src/extension-api.d.ts:885"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"password",children:"password?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"password"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Controls if a password input is shown. Password input hides the typed text."}),"\n",(0,i.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L874",children:"packages/extension-api/src/extension-api.d.ts:874"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"placeholder",children:"placeHolder?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"placeHolder"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"An optional string to show as placeholder in the input box to guide the user what to type."}),"\n",(0,i.jsx)(n.h4,{id:"source-4",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L869",children:"packages/extension-api/src/extension-api.d.ts:869"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"prompt",children:"prompt?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"prompt"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"The text to display underneath the input box."}),"\n",(0,i.jsx)(n.h4,{id:"source-5",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L859",children:"packages/extension-api/src/extension-api.d.ts:859"})}),"\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:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"title"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"An optional string that represents the title of the input box."}),"\n",(0,i.jsx)(n.h4,{id:"source-6",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L841",children:"packages/extension-api/src/extension-api.d.ts:841"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"value",children:"value?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"value"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"The value to pre-fill in the input box."}),"\n",(0,i.jsx)(n.h4,{id:"source-7",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L846",children:"packages/extension-api/src/extension-api.d.ts:846"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"valueselection",children:"valueSelection?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"valueSelection"}),": [",(0,i.jsx)(n.code,{children:"number"}),", ",(0,i.jsx)(n.code,{children:"number"}),"]"]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Selection of the pre-filled ",(0,i.jsx)(n.a,{href:"/api/interfaces/InputBoxOptions#value",children:(0,i.jsx)(n.code,{children:"value"})}),". Defined as tuple of two number where the\nfirst is the inclusive start index and the second the exclusive end index. When ",(0,i.jsx)(n.code,{children:"undefined"})," the whole\npre-filled value will be selected, when empty (start equals end) only the cursor will be set,\notherwise the defined range will be selected."]}),"\n",(0,i.jsx)(n.h4,{id:"source-8",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L854",children:"packages/extension-api/src/extension-api.d.ts:854"})}),"\n",(0,i.jsx)(n.h2,{id:"methods",children:"Methods"}),"\n",(0,i.jsx)(n.h3,{id:"validateinput",children:"validateInput()?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"validateInput"}),"(",(0,i.jsx)(n.code,{children:"value"}),"): ",(0,i.jsx)(n.code,{children:"undefined"})," | ",(0,i.jsx)(n.code,{children:"null"})," | ",(0,i.jsx)(n.code,{children:"string"})," | ",(0,i.jsx)(n.a,{href:"/api/interfaces/InputBoxValidationMessage",children:(0,i.jsx)(n.code,{children:"InputBoxValidationMessage"})})," | ",(0,i.jsx)(n.code,{children:"Promise"}),"< ",(0,i.jsx)(n.code,{children:"undefined"})," | ",(0,i.jsx)(n.code,{children:"null"})," | ",(0,i.jsx)(n.code,{children:"string"})," | ",(0,i.jsx)(n.a,{href:"/api/interfaces/InputBoxValidationMessage",children:(0,i.jsx)(n.code,{children:"InputBoxValidationMessage"})})," >"]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"An optional function that will be called to validate input and to give a hint\nto the user."}),"\n",(0,i.jsx)(n.h4,{id:"parameters",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"value"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n",(0,i.jsx)(n.p,{children:"The current value of the input box."}),"\n",(0,i.jsx)(n.h4,{id:"returns",children:"Returns"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"undefined"})," | ",(0,i.jsx)(n.code,{children:"null"})," | ",(0,i.jsx)(n.code,{children:"string"})," | ",(0,i.jsx)(n.a,{href:"/api/interfaces/InputBoxValidationMessage",children:(0,i.jsx)(n.code,{children:"InputBoxValidationMessage"})})," | ",(0,i.jsx)(n.code,{children:"Promise"}),"< ",(0,i.jsx)(n.code,{children:"undefined"})," | ",(0,i.jsx)(n.code,{children:"null"})," | ",(0,i.jsx)(n.code,{children:"string"})," | ",(0,i.jsx)(n.a,{href:"/api/interfaces/InputBoxValidationMessage",children:(0,i.jsx)(n.code,{children:"InputBoxValidationMessage"})})," >"]}),"\n",(0,i.jsxs)(n.p,{children:["Either a human-readable string which is presented as an error message or an ",(0,i.jsx)(n.a,{href:"/api/interfaces/InputBoxValidationMessage",children:"InputBoxValidationMessage"}),"\nwhich can provide a specific message severity. Return ",(0,i.jsx)(n.code,{children:"undefined"}),", ",(0,i.jsx)(n.code,{children:"null"}),", or the empty string when 'value' is valid."]}),"\n",(0,i.jsx)(n.h4,{id:"source-9",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L895",children:"packages/extension-api/src/extension-api.d.ts:895"})})]})}function h(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(a,{...e})}):a(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>c,a:()=>r});var i=s(27378);const 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([[64891],{47516:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>d,contentTitle:()=>r,default:()=>h,frontMatter:()=>o,metadata:()=>c,toc:()=>l});var i=s(24246),t=s(71670);const o={},r="Interface: InputBoxOptions",c={id:"interfaces/InputBoxOptions",title:"Interface: InputBoxOptions",description:"Options to configure the behavior of the input box UI.",source:"@site/api/interfaces/InputBoxOptions.md",sourceDirName:"interfaces",slug:"/interfaces/InputBoxOptions",permalink:"/api/interfaces/InputBoxOptions",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: ImageInspectInfo",permalink:"/api/interfaces/ImageInspectInfo"},next:{title:"Interface: InputBoxValidationMessage",permalink:"/api/interfaces/InputBoxValidationMessage"}},d={},l=[{value:"Properties",id:"properties",level:2},{value:"ignoreFocusOut?",id:"ignorefocusout",level:3},{value:"Source",id:"source",level:4},{value:"markdownDescription?",id:"markdowndescription",level:3},{value:"Source",id:"source-1",level:4},{value:"multiline?",id:"multiline",level:3},{value:"Source",id:"source-2",level:4},{value:"password?",id:"password",level:3},{value:"Source",id:"source-3",level:4},{value:"placeHolder?",id:"placeholder",level:3},{value:"Source",id:"source-4",level:4},{value:"prompt?",id:"prompt",level:3},{value:"Source",id:"source-5",level:4},{value:"title?",id:"title",level:3},{value:"Source",id:"source-6",level:4},{value:"value?",id:"value",level:3},{value:"Source",id:"source-7",level:4},{value:"valueSelection?",id:"valueselection",level:3},{value:"Source",id:"source-8",level:4},{value:"Methods",id:"methods",level:2},{value:"validateInput()?",id:"validateinput",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Source",id:"source-9",level:4}];function a(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,t.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"interface-inputboxoptions",children:"Interface: InputBoxOptions"}),"\n",(0,i.jsx)(n.p,{children:"Options to configure the behavior of the input box UI."}),"\n",(0,i.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(n.h3,{id:"ignorefocusout",children:"ignoreFocusOut?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"ignoreFocusOut"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Set to ",(0,i.jsx)(n.code,{children:"true"})," to keep the input box open when focus moves to another part of the editor or to another window.\nThis setting is ignored on iPad and is always false."]}),"\n",(0,i.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L880",children:"packages/extension-api/src/extension-api.d.ts:880"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"markdowndescription",children:"markdownDescription?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"markdownDescription"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"A description of the field to be show (Markdown format)"}),"\n",(0,i.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L864",children:"packages/extension-api/src/extension-api.d.ts:864"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"multiline",children:"multiline?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"multiline"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Set to ",(0,i.jsx)(n.code,{children:"true"})," when value represents a multi line content."]}),"\n",(0,i.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L885",children:"packages/extension-api/src/extension-api.d.ts:885"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"password",children:"password?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"password"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Controls if a password input is shown. Password input hides the typed text."}),"\n",(0,i.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L874",children:"packages/extension-api/src/extension-api.d.ts:874"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"placeholder",children:"placeHolder?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"placeHolder"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"An optional string to show as placeholder in the input box to guide the user what to type."}),"\n",(0,i.jsx)(n.h4,{id:"source-4",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L869",children:"packages/extension-api/src/extension-api.d.ts:869"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"prompt",children:"prompt?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"prompt"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"The text to display underneath the input box."}),"\n",(0,i.jsx)(n.h4,{id:"source-5",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L859",children:"packages/extension-api/src/extension-api.d.ts:859"})}),"\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:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"title"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"An optional string that represents the title of the input box."}),"\n",(0,i.jsx)(n.h4,{id:"source-6",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L841",children:"packages/extension-api/src/extension-api.d.ts:841"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"value",children:"value?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"value"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"The value to pre-fill in the input box."}),"\n",(0,i.jsx)(n.h4,{id:"source-7",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L846",children:"packages/extension-api/src/extension-api.d.ts:846"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"valueselection",children:"valueSelection?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"valueSelection"}),": [",(0,i.jsx)(n.code,{children:"number"}),", ",(0,i.jsx)(n.code,{children:"number"}),"]"]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Selection of the pre-filled ",(0,i.jsx)(n.a,{href:"/api/interfaces/InputBoxOptions#value",children:(0,i.jsx)(n.code,{children:"value"})}),". Defined as tuple of two number where the\nfirst is the inclusive start index and the second the exclusive end index. When ",(0,i.jsx)(n.code,{children:"undefined"})," the whole\npre-filled value will be selected, when empty (start equals end) only the cursor will be set,\notherwise the defined range will be selected."]}),"\n",(0,i.jsx)(n.h4,{id:"source-8",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L854",children:"packages/extension-api/src/extension-api.d.ts:854"})}),"\n",(0,i.jsx)(n.h2,{id:"methods",children:"Methods"}),"\n",(0,i.jsx)(n.h3,{id:"validateinput",children:"validateInput()?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"validateInput"}),"(",(0,i.jsx)(n.code,{children:"value"}),"): ",(0,i.jsx)(n.code,{children:"undefined"})," | ",(0,i.jsx)(n.code,{children:"null"})," | ",(0,i.jsx)(n.code,{children:"string"})," | ",(0,i.jsx)(n.a,{href:"/api/interfaces/InputBoxValidationMessage",children:(0,i.jsx)(n.code,{children:"InputBoxValidationMessage"})})," | ",(0,i.jsx)(n.code,{children:"Promise"}),"< ",(0,i.jsx)(n.code,{children:"undefined"})," | ",(0,i.jsx)(n.code,{children:"null"})," | ",(0,i.jsx)(n.code,{children:"string"})," | ",(0,i.jsx)(n.a,{href:"/api/interfaces/InputBoxValidationMessage",children:(0,i.jsx)(n.code,{children:"InputBoxValidationMessage"})})," >"]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"An optional function that will be called to validate input and to give a hint\nto the user."}),"\n",(0,i.jsx)(n.h4,{id:"parameters",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"value"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n",(0,i.jsx)(n.p,{children:"The current value of the input box."}),"\n",(0,i.jsx)(n.h4,{id:"returns",children:"Returns"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"undefined"})," | ",(0,i.jsx)(n.code,{children:"null"})," | ",(0,i.jsx)(n.code,{children:"string"})," | ",(0,i.jsx)(n.a,{href:"/api/interfaces/InputBoxValidationMessage",children:(0,i.jsx)(n.code,{children:"InputBoxValidationMessage"})})," | ",(0,i.jsx)(n.code,{children:"Promise"}),"< ",(0,i.jsx)(n.code,{children:"undefined"})," | ",(0,i.jsx)(n.code,{children:"null"})," | ",(0,i.jsx)(n.code,{children:"string"})," | ",(0,i.jsx)(n.a,{href:"/api/interfaces/InputBoxValidationMessage",children:(0,i.jsx)(n.code,{children:"InputBoxValidationMessage"})})," >"]}),"\n",(0,i.jsxs)(n.p,{children:["Either a human-readable string which is presented as an error message or an ",(0,i.jsx)(n.a,{href:"/api/interfaces/InputBoxValidationMessage",children:"InputBoxValidationMessage"}),"\nwhich can provide a specific message severity. Return ",(0,i.jsx)(n.code,{children:"undefined"}),", ",(0,i.jsx)(n.code,{children:"null"}),", or the empty string when 'value' is valid."]}),"\n",(0,i.jsx)(n.h4,{id:"source-9",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L895",children:"packages/extension-api/src/extension-api.d.ts:895"})})]})}function h(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(a,{...e})}):a(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>c,a:()=>r});var i=s(27378);const 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/a334b453.1ef49b1d.js b/assets/js/a334b453.159a6a62.js similarity index 90% rename from assets/js/a334b453.1ef49b1d.js rename to assets/js/a334b453.159a6a62.js index 15f5ba39b67..c4fb767c028 100644 --- a/assets/js/a334b453.1ef49b1d.js +++ b/assets/js/a334b453.159a6a62.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[4004],{53987:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>s,default:()=>l,frontMatter:()=>r,metadata:()=>c,toc:()=>d});var i=t(24246),o=t(71670);const r={},s="Interface: UpdateContainerConnectionEvent",c={id:"interfaces/UpdateContainerConnectionEvent",title:"Interface: UpdateContainerConnectionEvent",description:"Properties",source:"@site/api/interfaces/UpdateContainerConnectionEvent.md",sourceDirName:"interfaces",slug:"/interfaces/UpdateContainerConnectionEvent",permalink:"/api/interfaces/UpdateContainerConnectionEvent",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: UnregisterKubernetesConnectionEvent",permalink:"/api/interfaces/UnregisterKubernetesConnectionEvent"},next:{title:"Interface: UpdateKubernetesConnectionEvent",permalink:"/api/interfaces/UpdateKubernetesConnectionEvent"}},a={},d=[{value:"Properties",id:"properties",level:2},{value:"connection",id:"connection",level:3},{value:"Source",id:"source",level:4},{value:"providerId",id:"providerid",level:3},{value:"Source",id:"source-1",level:4},{value:"status",id:"status",level:3},{value:"Source",id:"source-2",level:4}];function p(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,o.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"interface-updatecontainerconnectionevent",children:"Interface: UpdateContainerConnectionEvent"}),"\n",(0,i.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(n.h3,{id:"connection",children:"connection"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"connection"}),": ",(0,i.jsx)(n.a,{href:"/api/interfaces/ContainerProviderConnection",children:(0,i.jsx)(n.code,{children:"ContainerProviderConnection"})})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L516",children:"packages/extension-api/src/extension-api.d.ts:516"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"providerid",children:"providerId"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"providerId"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L515",children:"packages/extension-api/src/extension-api.d.ts:515"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"status",children:"status"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"status"}),": ",(0,i.jsx)(n.a,{href:"/api/type-aliases/ProviderConnectionStatus",children:(0,i.jsx)(n.code,{children:"ProviderConnectionStatus"})})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L517",children:"packages/extension-api/src/extension-api.d.ts:517"})})]})}function l(e={}){const{wrapper:n}={...(0,o.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(p,{...e})}):p(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>c,a:()=>s});var i=t(27378);const o={},r=i.createContext(o);function s(e){const n=i.useContext(r);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:s(e.components),i.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[4004],{53987:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>s,default:()=>l,frontMatter:()=>r,metadata:()=>c,toc:()=>d});var i=t(24246),o=t(71670);const r={},s="Interface: UpdateContainerConnectionEvent",c={id:"interfaces/UpdateContainerConnectionEvent",title:"Interface: UpdateContainerConnectionEvent",description:"Properties",source:"@site/api/interfaces/UpdateContainerConnectionEvent.md",sourceDirName:"interfaces",slug:"/interfaces/UpdateContainerConnectionEvent",permalink:"/api/interfaces/UpdateContainerConnectionEvent",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: UnregisterKubernetesConnectionEvent",permalink:"/api/interfaces/UnregisterKubernetesConnectionEvent"},next:{title:"Interface: UpdateKubernetesConnectionEvent",permalink:"/api/interfaces/UpdateKubernetesConnectionEvent"}},a={},d=[{value:"Properties",id:"properties",level:2},{value:"connection",id:"connection",level:3},{value:"Source",id:"source",level:4},{value:"providerId",id:"providerid",level:3},{value:"Source",id:"source-1",level:4},{value:"status",id:"status",level:3},{value:"Source",id:"source-2",level:4}];function p(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,o.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"interface-updatecontainerconnectionevent",children:"Interface: UpdateContainerConnectionEvent"}),"\n",(0,i.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(n.h3,{id:"connection",children:"connection"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"connection"}),": ",(0,i.jsx)(n.a,{href:"/api/interfaces/ContainerProviderConnection",children:(0,i.jsx)(n.code,{children:"ContainerProviderConnection"})})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L516",children:"packages/extension-api/src/extension-api.d.ts:516"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"providerid",children:"providerId"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"providerId"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L515",children:"packages/extension-api/src/extension-api.d.ts:515"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"status",children:"status"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"status"}),": ",(0,i.jsx)(n.a,{href:"/api/type-aliases/ProviderConnectionStatus",children:(0,i.jsx)(n.code,{children:"ProviderConnectionStatus"})})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L517",children:"packages/extension-api/src/extension-api.d.ts:517"})})]})}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.c7d79b25.js b/assets/js/a38d285e.efa86be3.js similarity index 96% rename from assets/js/a38d285e.c7d79b25.js rename to assets/js/a38d285e.efa86be3.js index e7288cd90b3..3b30021b4d0 100644 --- a/assets/js/a38d285e.c7d79b25.js +++ b/assets/js/a38d285e.efa86be3.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[86477],{11991:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>c,default:()=>l,frontMatter:()=>o,metadata:()=>s,toc:()=>d});var i=t(24246),r=t(71670);const o={},c="Interface: RegisterContainerConnectionEvent",s={id:"interfaces/RegisterContainerConnectionEvent",title:"Interface: RegisterContainerConnectionEvent",description:"Properties",source:"@site/api/interfaces/RegisterContainerConnectionEvent.md",sourceDirName:"interfaces",slug:"/interfaces/RegisterContainerConnectionEvent",permalink:"/api/interfaces/RegisterContainerConnectionEvent",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: QuickPickOptions",permalink:"/api/interfaces/QuickPickOptions"},next:{title:"Interface: RegisterKubernetesConnectionEvent",permalink:"/api/interfaces/RegisterKubernetesConnectionEvent"}},a={},d=[{value:"Properties",id:"properties",level:2},{value:"connection",id:"connection",level:3},{value:"Source",id:"source",level:4},{value:"providerId",id:"providerid",level:3},{value:"Source",id:"source-1",level:4}];function p(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,r.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"interface-registercontainerconnectionevent",children:"Interface: RegisterContainerConnectionEvent"}),"\n",(0,i.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(n.h3,{id:"connection",children:"connection"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"connection"}),": ",(0,i.jsx)(n.a,{href:"/api/interfaces/ContainerProviderConnection",children:(0,i.jsx)(n.code,{children:"ContainerProviderConnection"})})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L537",children:"packages/extension-api/src/extension-api.d.ts:537"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"providerid",children:"providerId"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"providerId"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L536",children:"packages/extension-api/src/extension-api.d.ts:536"})})]})}function l(e={}){const{wrapper:n}={...(0,r.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(p,{...e})}):p(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>s,a:()=>c});var i=t(27378);const r={},o=i.createContext(r);function c(e){const n=i.useContext(o);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function s(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:c(e.components),i.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[86477],{11991:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>c,default:()=>l,frontMatter:()=>o,metadata:()=>s,toc:()=>d});var i=t(24246),r=t(71670);const o={},c="Interface: RegisterContainerConnectionEvent",s={id:"interfaces/RegisterContainerConnectionEvent",title:"Interface: RegisterContainerConnectionEvent",description:"Properties",source:"@site/api/interfaces/RegisterContainerConnectionEvent.md",sourceDirName:"interfaces",slug:"/interfaces/RegisterContainerConnectionEvent",permalink:"/api/interfaces/RegisterContainerConnectionEvent",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: QuickPickOptions",permalink:"/api/interfaces/QuickPickOptions"},next:{title:"Interface: RegisterKubernetesConnectionEvent",permalink:"/api/interfaces/RegisterKubernetesConnectionEvent"}},a={},d=[{value:"Properties",id:"properties",level:2},{value:"connection",id:"connection",level:3},{value:"Source",id:"source",level:4},{value:"providerId",id:"providerid",level:3},{value:"Source",id:"source-1",level:4}];function p(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,r.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"interface-registercontainerconnectionevent",children:"Interface: RegisterContainerConnectionEvent"}),"\n",(0,i.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(n.h3,{id:"connection",children:"connection"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"connection"}),": ",(0,i.jsx)(n.a,{href:"/api/interfaces/ContainerProviderConnection",children:(0,i.jsx)(n.code,{children:"ContainerProviderConnection"})})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L537",children:"packages/extension-api/src/extension-api.d.ts:537"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"providerid",children:"providerId"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"providerId"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L536",children:"packages/extension-api/src/extension-api.d.ts:536"})})]})}function l(e={}){const{wrapper:n}={...(0,r.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(p,{...e})}):p(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>s,a:()=>c});var i=t(27378);const r={},o=i.createContext(r);function c(e){const n=i.useContext(o);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function s(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:c(e.components),i.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/a3f8794a.d031425c.js b/assets/js/a3f8794a.66644bd9.js similarity index 86% rename from assets/js/a3f8794a.d031425c.js rename to assets/js/a3f8794a.66644bd9.js index 53679ceb6b3..b7617c8814b 100644 --- a/assets/js/a3f8794a.d031425c.js +++ b/assets/js/a3f8794a.66644bd9.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[60334],{84214:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>o,contentTitle:()=>c,default:()=>p,frontMatter:()=>a,metadata:()=>s,toc:()=>d});var i=t(24246),r=t(71670);const a={},c="Function: createContainer()",s={id:"namespaces/containerEngine/functions/createContainer",title:"Function: createContainer()",description:"createContainer(engineId, containerCreateOptions): Promise\\",source:"@site/api/namespaces/containerEngine/functions/createContainer.md",sourceDirName:"namespaces/containerEngine/functions",slug:"/namespaces/containerEngine/functions/createContainer",permalink:"/api/namespaces/containerEngine/functions/createContainer",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Function: buildImage()",permalink:"/api/namespaces/containerEngine/functions/buildImage"},next:{title:"Function: createManifest()",permalink:"/api/namespaces/containerEngine/functions/createManifest"}},o={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,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:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L3176",children:"packages/extension-api/src/extension-api.d.ts:3176"})})]})}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={},a=i.createContext(r);function c(e){const n=i.useContext(a);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function s(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:c(e.components),i.createElement(a.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[60334],{84214:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>o,contentTitle:()=>s,default:()=>p,frontMatter:()=>a,metadata:()=>c,toc:()=>d});var 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:"Function: buildImage()",permalink:"/api/namespaces/containerEngine/functions/buildImage"},next:{title:"Function: createManifest()",permalink:"/api/namespaces/containerEngine/functions/createManifest"}},o={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,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:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L3176",children:"packages/extension-api/src/extension-api.d.ts:3176"})})]})}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.81494862.js b/assets/js/a4794f2e.0a97aa4c.js similarity index 95% rename from assets/js/a4794f2e.81494862.js rename to assets/js/a4794f2e.0a97aa4c.js index cd3701ef8f7..4782de68a27 100644 --- a/assets/js/a4794f2e.81494862.js +++ b/assets/js/a4794f2e.0a97aa4c.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[11161],{82563:(e,r,s)=>{s.r(r),s.d(r,{assets:()=>a,contentTitle:()=>o,default:()=>p,frontMatter:()=>n,metadata:()=>c,toc:()=>d});var t=s(24246),i=s(71670);const n={},o="Function: registerRegistryProvider()",c={id:"namespaces/registry/functions/registerRegistryProvider",title:"Function: registerRegistryProvider()",description:"registerRegistryProvider(registryProvider): Disposable",source:"@site/api/namespaces/registry/functions/registerRegistryProvider.md",sourceDirName:"namespaces/registry/functions",slug:"/namespaces/registry/functions/registerRegistryProvider",permalink:"/api/namespaces/registry/functions/registerRegistryProvider",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Function: registerRegistry()",permalink:"/api/namespaces/registry/functions/registerRegistry"},next:{title:"Function: suggestRegistry()",permalink:"/api/namespaces/registry/functions/suggestRegistry"}},a={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function l(e){const r={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,i.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(r.h1,{id:"function-registerregistryprovider",children:"Function: registerRegistryProvider()"}),"\n",(0,t.jsxs)(r.blockquote,{children:["\n",(0,t.jsxs)(r.p,{children:[(0,t.jsx)(r.strong,{children:"registerRegistryProvider"}),"(",(0,t.jsx)(r.code,{children:"registryProvider"}),"): ",(0,t.jsx)(r.a,{href:"/api/classes/Disposable",children:(0,t.jsx)(r.code,{children:"Disposable"})})]}),"\n"]}),"\n",(0,t.jsx)(r.h2,{id:"parameters",children:"Parameters"}),"\n",(0,t.jsxs)(r.p,{children:["\u2022 ",(0,t.jsx)(r.strong,{children:"registryProvider"}),": ",(0,t.jsx)(r.a,{href:"/api/interfaces/RegistryProvider",children:(0,t.jsx)(r.code,{children:"RegistryProvider"})})]}),"\n",(0,t.jsx)(r.h2,{id:"returns",children:"Returns"}),"\n",(0,t.jsx)(r.p,{children:(0,t.jsx)(r.a,{href:"/api/classes/Disposable",children:(0,t.jsx)(r.code,{children:"Disposable"})})}),"\n",(0,t.jsx)(r.h2,{id:"source",children:"Source"}),"\n",(0,t.jsx)(r.p,{children:(0,t.jsx)(r.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L619",children:"packages/extension-api/src/extension-api.d.ts:619"})})]})}function p(e={}){const{wrapper:r}={...(0,i.a)(),...e.components};return r?(0,t.jsx)(r,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},71670:(e,r,s)=>{s.d(r,{Z:()=>c,a:()=>o});var t=s(27378);const i={},n=t.createContext(i);function o(e){const r=t.useContext(n);return t.useMemo((function(){return"function"==typeof e?e(r):{...r,...e}}),[r,e])}function c(e){let r;return r=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:o(e.components),t.createElement(n.Provider,{value:r},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[11161],{82563:(e,r,s)=>{s.r(r),s.d(r,{assets:()=>a,contentTitle:()=>o,default:()=>p,frontMatter:()=>n,metadata:()=>c,toc:()=>d});var t=s(24246),i=s(71670);const n={},o="Function: registerRegistryProvider()",c={id:"namespaces/registry/functions/registerRegistryProvider",title:"Function: registerRegistryProvider()",description:"registerRegistryProvider(registryProvider): Disposable",source:"@site/api/namespaces/registry/functions/registerRegistryProvider.md",sourceDirName:"namespaces/registry/functions",slug:"/namespaces/registry/functions/registerRegistryProvider",permalink:"/api/namespaces/registry/functions/registerRegistryProvider",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Function: registerRegistry()",permalink:"/api/namespaces/registry/functions/registerRegistry"},next:{title:"Function: suggestRegistry()",permalink:"/api/namespaces/registry/functions/suggestRegistry"}},a={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function l(e){const r={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,i.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(r.h1,{id:"function-registerregistryprovider",children:"Function: registerRegistryProvider()"}),"\n",(0,t.jsxs)(r.blockquote,{children:["\n",(0,t.jsxs)(r.p,{children:[(0,t.jsx)(r.strong,{children:"registerRegistryProvider"}),"(",(0,t.jsx)(r.code,{children:"registryProvider"}),"): ",(0,t.jsx)(r.a,{href:"/api/classes/Disposable",children:(0,t.jsx)(r.code,{children:"Disposable"})})]}),"\n"]}),"\n",(0,t.jsx)(r.h2,{id:"parameters",children:"Parameters"}),"\n",(0,t.jsxs)(r.p,{children:["\u2022 ",(0,t.jsx)(r.strong,{children:"registryProvider"}),": ",(0,t.jsx)(r.a,{href:"/api/interfaces/RegistryProvider",children:(0,t.jsx)(r.code,{children:"RegistryProvider"})})]}),"\n",(0,t.jsx)(r.h2,{id:"returns",children:"Returns"}),"\n",(0,t.jsx)(r.p,{children:(0,t.jsx)(r.a,{href:"/api/classes/Disposable",children:(0,t.jsx)(r.code,{children:"Disposable"})})}),"\n",(0,t.jsx)(r.h2,{id:"source",children:"Source"}),"\n",(0,t.jsx)(r.p,{children:(0,t.jsx)(r.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L619",children:"packages/extension-api/src/extension-api.d.ts:619"})})]})}function p(e={}){const{wrapper:r}={...(0,i.a)(),...e.components};return r?(0,t.jsx)(r,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},71670:(e,r,s)=>{s.d(r,{Z:()=>c,a:()=>o});var t=s(27378);const i={},n=t.createContext(i);function o(e){const r=t.useContext(n);return t.useMemo((function(){return"function"==typeof e?e(r):{...r,...e}}),[r,e])}function c(e){let r;return r=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:o(e.components),t.createElement(n.Provider,{value:r},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/a9fa5b1f.a33a2883.js b/assets/js/a9fa5b1f.619c6397.js similarity index 94% rename from assets/js/a9fa5b1f.a33a2883.js rename to assets/js/a9fa5b1f.619c6397.js index f2404db6295..6f8c83dfd70 100644 --- a/assets/js/a9fa5b1f.a33a2883.js +++ b/assets/js/a9fa5b1f.619c6397.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[44619],{12816:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>a,contentTitle:()=>c,default:()=>p,frontMatter:()=>s,metadata:()=>o,toc:()=>d});var t=r(24246),i=r(71670);const s={},c="Interface: ProviderCleanupAction",o={id:"interfaces/ProviderCleanupAction",title:"Interface: ProviderCleanupAction",description:"Properties",source:"@site/api/interfaces/ProviderCleanupAction.md",sourceDirName:"interfaces",slug:"/interfaces/ProviderCleanupAction",permalink:"/api/interfaces/ProviderCleanupAction",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: ProviderCleanup",permalink:"/api/interfaces/ProviderCleanup"},next:{title:"Interface: ProviderCleanupExecuteOptions",permalink:"/api/interfaces/ProviderCleanupExecuteOptions"}},a={},d=[{value:"Properties",id:"properties",level:2},{value:"name",id:"name",level:3},{value:"Source",id:"source",level:4},{value:"Methods",id:"methods",level:2},{value:"execute()",id:"execute",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Source",id:"source-1",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",p:"p",strong:"strong",...(0,i.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"interface-providercleanupaction",children:"Interface: ProviderCleanupAction"}),"\n",(0,t.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,t.jsx)(n.h3,{id:"name",children:"name"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"name"}),": ",(0,t.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L414",children:"packages/extension-api/src/extension-api.d.ts:414"})}),"\n",(0,t.jsx)(n.h2,{id:"methods",children:"Methods"}),"\n",(0,t.jsx)(n.h3,{id:"execute",children:"execute()"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"execute"}),"(",(0,t.jsx)(n.code,{children:"options"}),"): ",(0,t.jsx)(n.code,{children:"Promise"}),"< ",(0,t.jsx)(n.code,{children:"void"})," >"]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"parameters",children:"Parameters"}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"options"}),": ",(0,t.jsx)(n.a,{href:"/api/interfaces/ProviderCleanupExecuteOptions",children:(0,t.jsx)(n.code,{children:"ProviderCleanupExecuteOptions"})})]}),"\n",(0,t.jsx)(n.h4,{id:"returns",children:"Returns"}),"\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"Promise"}),"< ",(0,t.jsx)(n.code,{children:"void"})," >"]}),"\n",(0,t.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L416",children:"packages/extension-api/src/extension-api.d.ts:416"})})]})}function p(e={}){const{wrapper:n}={...(0,i.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},71670:(e,n,r)=>{r.d(n,{Z:()=>o,a:()=>c});var t=r(27378);const i={},s=t.createContext(i);function c(e){const n=t.useContext(s);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:c(e.components),t.createElement(s.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[44619],{12816:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>a,contentTitle:()=>c,default:()=>p,frontMatter:()=>s,metadata:()=>o,toc:()=>d});var t=r(24246),i=r(71670);const s={},c="Interface: ProviderCleanupAction",o={id:"interfaces/ProviderCleanupAction",title:"Interface: ProviderCleanupAction",description:"Properties",source:"@site/api/interfaces/ProviderCleanupAction.md",sourceDirName:"interfaces",slug:"/interfaces/ProviderCleanupAction",permalink:"/api/interfaces/ProviderCleanupAction",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: ProviderCleanup",permalink:"/api/interfaces/ProviderCleanup"},next:{title:"Interface: ProviderCleanupExecuteOptions",permalink:"/api/interfaces/ProviderCleanupExecuteOptions"}},a={},d=[{value:"Properties",id:"properties",level:2},{value:"name",id:"name",level:3},{value:"Source",id:"source",level:4},{value:"Methods",id:"methods",level:2},{value:"execute()",id:"execute",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Source",id:"source-1",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",p:"p",strong:"strong",...(0,i.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"interface-providercleanupaction",children:"Interface: ProviderCleanupAction"}),"\n",(0,t.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,t.jsx)(n.h3,{id:"name",children:"name"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"name"}),": ",(0,t.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L414",children:"packages/extension-api/src/extension-api.d.ts:414"})}),"\n",(0,t.jsx)(n.h2,{id:"methods",children:"Methods"}),"\n",(0,t.jsx)(n.h3,{id:"execute",children:"execute()"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"execute"}),"(",(0,t.jsx)(n.code,{children:"options"}),"): ",(0,t.jsx)(n.code,{children:"Promise"}),"< ",(0,t.jsx)(n.code,{children:"void"})," >"]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"parameters",children:"Parameters"}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"options"}),": ",(0,t.jsx)(n.a,{href:"/api/interfaces/ProviderCleanupExecuteOptions",children:(0,t.jsx)(n.code,{children:"ProviderCleanupExecuteOptions"})})]}),"\n",(0,t.jsx)(n.h4,{id:"returns",children:"Returns"}),"\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"Promise"}),"< ",(0,t.jsx)(n.code,{children:"void"})," >"]}),"\n",(0,t.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L416",children:"packages/extension-api/src/extension-api.d.ts:416"})})]})}function p(e={}){const{wrapper:n}={...(0,i.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},71670:(e,n,r)=>{r.d(n,{Z:()=>o,a:()=>c});var t=r(27378);const i={},s=t.createContext(i);function c(e){const n=t.useContext(s);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:c(e.components),t.createElement(s.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/ab69fe56.af3fffe6.js b/assets/js/ab69fe56.d7d08ca0.js similarity index 94% rename from assets/js/ab69fe56.af3fffe6.js rename to assets/js/ab69fe56.d7d08ca0.js index b9cd91f0a12..04db51e5c54 100644 --- a/assets/js/ab69fe56.af3fffe6.js +++ b/assets/js/ab69fe56.d7d08ca0.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[25314],{85297:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>c,contentTitle:()=>a,default:()=>l,frontMatter:()=>i,metadata:()=>r,toc:()=>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:"Type alias: KubernetesGeneratorType",permalink:"/api/type-aliases/KubernetesGeneratorType"},next:{title:"Type alias: MountConsistency",permalink:"/api/type-aliases/MountConsistency"}},c={},p=[{value:"Source",id:"source",level:2}];function u(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(n.h1,{id:"type-alias-mountconfig",children:"Type alias: MountConfig"}),"\n",(0,o.jsxs)(n.blockquote,{children:["\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.strong,{children:"MountConfig"}),": ",(0,o.jsx)(n.a,{href:"/api/interfaces/MountSettings",children:(0,o.jsx)(n.code,{children:"MountSettings"})}),"[]"]}),"\n"]}),"\n",(0,o.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,o.jsx)(n.p,{children:(0,o.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2118",children:"packages/extension-api/src/extension-api.d.ts:2118"})})]})}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],{85297:(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:"Type alias: KubernetesGeneratorType",permalink:"/api/type-aliases/KubernetesGeneratorType"},next:{title:"Type alias: MountConsistency",permalink:"/api/type-aliases/MountConsistency"}},c={},p=[{value:"Source",id:"source",level:2}];function u(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(n.h1,{id:"type-alias-mountconfig",children:"Type alias: MountConfig"}),"\n",(0,o.jsxs)(n.blockquote,{children:["\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.strong,{children:"MountConfig"}),": ",(0,o.jsx)(n.a,{href:"/api/interfaces/MountSettings",children:(0,o.jsx)(n.code,{children:"MountSettings"})}),"[]"]}),"\n"]}),"\n",(0,o.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,o.jsx)(n.p,{children:(0,o.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2118",children:"packages/extension-api/src/extension-api.d.ts:2118"})})]})}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 diff --git a/assets/js/adcef0a2.6d1248c1.js b/assets/js/adcef0a2.b0e2c17e.js similarity index 96% rename from assets/js/adcef0a2.6d1248c1.js rename to assets/js/adcef0a2.b0e2c17e.js index 055a769db1c..34fbd39f178 100644 --- a/assets/js/adcef0a2.6d1248c1.js +++ b/assets/js/adcef0a2.b0e2c17e.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[66464],{55068:(e,r,n)=>{n.r(r),n.d(r,{assets:()=>o,contentTitle:()=>i,default:()=>l,frontMatter:()=>a,metadata:()=>s,toc:()=>d});var c=n(24246),t=n(71670);const a={},i="Interface: ImageCheckerProvider",s={id:"interfaces/ImageCheckerProvider",title:"Interface: ImageCheckerProvider",description:"Interface to be implemented by image checker providers",source:"@site/api/interfaces/ImageCheckerProvider.md",sourceDirName:"interfaces",slug:"/interfaces/ImageCheckerProvider",permalink:"/api/interfaces/ImageCheckerProvider",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: ImageCheck",permalink:"/api/interfaces/ImageCheck"},next:{title:"Interface: ImageCheckerProviderMetadata",permalink:"/api/interfaces/ImageCheckerProviderMetadata"}},o={},d=[{value:"Methods",id:"methods",level:2},{value:"check()",id:"check",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Source",id:"source",level:4}];function h(e){const r={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",p:"p",strong:"strong",...(0,t.a)(),...e.components};return(0,c.jsxs)(c.Fragment,{children:[(0,c.jsx)(r.h1,{id:"interface-imagecheckerprovider",children:"Interface: ImageCheckerProvider"}),"\n",(0,c.jsx)(r.p,{children:"Interface to be implemented by image checker providers"}),"\n",(0,c.jsx)(r.h2,{id:"methods",children:"Methods"}),"\n",(0,c.jsx)(r.h3,{id:"check",children:"check()"}),"\n",(0,c.jsxs)(r.blockquote,{children:["\n",(0,c.jsxs)(r.p,{children:[(0,c.jsx)(r.strong,{children:"check"}),"(",(0,c.jsx)(r.code,{children:"image"}),", ",(0,c.jsx)(r.code,{children:"token"}),"?): ",(0,c.jsx)(r.a,{href:"/api/type-aliases/ProviderResult",children:(0,c.jsx)(r.code,{children:"ProviderResult"})}),"< ",(0,c.jsx)(r.a,{href:"/api/interfaces/ImageChecks",children:(0,c.jsx)(r.code,{children:"ImageChecks"})})," >"]}),"\n"]}),"\n",(0,c.jsx)(r.h4,{id:"parameters",children:"Parameters"}),"\n",(0,c.jsxs)(r.p,{children:["\u2022 ",(0,c.jsx)(r.strong,{children:"image"}),": ",(0,c.jsx)(r.a,{href:"/api/interfaces/ImageInfo",children:(0,c.jsx)(r.code,{children:"ImageInfo"})})]}),"\n",(0,c.jsx)(r.p,{children:"Info about the image to analyze"}),"\n",(0,c.jsxs)(r.p,{children:["\u2022 ",(0,c.jsx)(r.strong,{children:"token?"}),": ",(0,c.jsx)(r.a,{href:"/api/interfaces/CancellationToken",children:(0,c.jsx)(r.code,{children:"CancellationToken"})})]}),"\n",(0,c.jsx)(r.p,{children:"a cancellation token the function can use to be informed when the caller asks for the operation to be cancelled"}),"\n",(0,c.jsx)(r.h4,{id:"returns",children:"Returns"}),"\n",(0,c.jsxs)(r.p,{children:[(0,c.jsx)(r.a,{href:"/api/type-aliases/ProviderResult",children:(0,c.jsx)(r.code,{children:"ProviderResult"})}),"< ",(0,c.jsx)(r.a,{href:"/api/interfaces/ImageChecks",children:(0,c.jsx)(r.code,{children:"ImageChecks"})})," >"]}),"\n",(0,c.jsx)(r.p,{children:"the complete result of the analyze, either synchronously of through a Promise"}),"\n",(0,c.jsx)(r.h4,{id:"source",children:"Source"}),"\n",(0,c.jsx)(r.p,{children:(0,c.jsx)(r.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L4109",children:"packages/extension-api/src/extension-api.d.ts:4109"})})]})}function l(e={}){const{wrapper:r}={...(0,t.a)(),...e.components};return r?(0,c.jsx)(r,{...e,children:(0,c.jsx)(h,{...e})}):h(e)}},71670:(e,r,n)=>{n.d(r,{Z:()=>s,a:()=>i});var c=n(27378);const t={},a=c.createContext(t);function i(e){const r=c.useContext(a);return c.useMemo((function(){return"function"==typeof e?e(r):{...r,...e}}),[r,e])}function s(e){let r;return r=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:i(e.components),c.createElement(a.Provider,{value:r},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[66464],{55068:(e,r,n)=>{n.r(r),n.d(r,{assets:()=>o,contentTitle:()=>i,default:()=>l,frontMatter:()=>a,metadata:()=>s,toc:()=>d});var c=n(24246),t=n(71670);const a={},i="Interface: ImageCheckerProvider",s={id:"interfaces/ImageCheckerProvider",title:"Interface: ImageCheckerProvider",description:"Interface to be implemented by image checker providers",source:"@site/api/interfaces/ImageCheckerProvider.md",sourceDirName:"interfaces",slug:"/interfaces/ImageCheckerProvider",permalink:"/api/interfaces/ImageCheckerProvider",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: ImageCheck",permalink:"/api/interfaces/ImageCheck"},next:{title:"Interface: ImageCheckerProviderMetadata",permalink:"/api/interfaces/ImageCheckerProviderMetadata"}},o={},d=[{value:"Methods",id:"methods",level:2},{value:"check()",id:"check",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Source",id:"source",level:4}];function h(e){const r={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",p:"p",strong:"strong",...(0,t.a)(),...e.components};return(0,c.jsxs)(c.Fragment,{children:[(0,c.jsx)(r.h1,{id:"interface-imagecheckerprovider",children:"Interface: ImageCheckerProvider"}),"\n",(0,c.jsx)(r.p,{children:"Interface to be implemented by image checker providers"}),"\n",(0,c.jsx)(r.h2,{id:"methods",children:"Methods"}),"\n",(0,c.jsx)(r.h3,{id:"check",children:"check()"}),"\n",(0,c.jsxs)(r.blockquote,{children:["\n",(0,c.jsxs)(r.p,{children:[(0,c.jsx)(r.strong,{children:"check"}),"(",(0,c.jsx)(r.code,{children:"image"}),", ",(0,c.jsx)(r.code,{children:"token"}),"?): ",(0,c.jsx)(r.a,{href:"/api/type-aliases/ProviderResult",children:(0,c.jsx)(r.code,{children:"ProviderResult"})}),"< ",(0,c.jsx)(r.a,{href:"/api/interfaces/ImageChecks",children:(0,c.jsx)(r.code,{children:"ImageChecks"})})," >"]}),"\n"]}),"\n",(0,c.jsx)(r.h4,{id:"parameters",children:"Parameters"}),"\n",(0,c.jsxs)(r.p,{children:["\u2022 ",(0,c.jsx)(r.strong,{children:"image"}),": ",(0,c.jsx)(r.a,{href:"/api/interfaces/ImageInfo",children:(0,c.jsx)(r.code,{children:"ImageInfo"})})]}),"\n",(0,c.jsx)(r.p,{children:"Info about the image to analyze"}),"\n",(0,c.jsxs)(r.p,{children:["\u2022 ",(0,c.jsx)(r.strong,{children:"token?"}),": ",(0,c.jsx)(r.a,{href:"/api/interfaces/CancellationToken",children:(0,c.jsx)(r.code,{children:"CancellationToken"})})]}),"\n",(0,c.jsx)(r.p,{children:"a cancellation token the function can use to be informed when the caller asks for the operation to be cancelled"}),"\n",(0,c.jsx)(r.h4,{id:"returns",children:"Returns"}),"\n",(0,c.jsxs)(r.p,{children:[(0,c.jsx)(r.a,{href:"/api/type-aliases/ProviderResult",children:(0,c.jsx)(r.code,{children:"ProviderResult"})}),"< ",(0,c.jsx)(r.a,{href:"/api/interfaces/ImageChecks",children:(0,c.jsx)(r.code,{children:"ImageChecks"})})," >"]}),"\n",(0,c.jsx)(r.p,{children:"the complete result of the analyze, either synchronously of through a Promise"}),"\n",(0,c.jsx)(r.h4,{id:"source",children:"Source"}),"\n",(0,c.jsx)(r.p,{children:(0,c.jsx)(r.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L4109",children:"packages/extension-api/src/extension-api.d.ts:4109"})})]})}function l(e={}){const{wrapper:r}={...(0,t.a)(),...e.components};return r?(0,c.jsx)(r,{...e,children:(0,c.jsx)(h,{...e})}):h(e)}},71670:(e,r,n)=>{n.d(r,{Z:()=>s,a:()=>i});var c=n(27378);const t={},a=c.createContext(t);function i(e){const r=c.useContext(a);return c.useMemo((function(){return"function"==typeof e?e(r):{...r,...e}}),[r,e])}function s(e){let r;return r=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:i(e.components),c.createElement(a.Provider,{value:r},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/adfdec4a.f70bb652.js b/assets/js/adfdec4a.9cd2751b.js similarity index 87% rename from assets/js/adfdec4a.f70bb652.js rename to assets/js/adfdec4a.9cd2751b.js index 195c1b2379b..d7edf84bba2 100644 --- a/assets/js/adfdec4a.f70bb652.js +++ b/assets/js/adfdec4a.9cd2751b.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[71970],{28305:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>d,contentTitle:()=>o,default:()=>h,frontMatter:()=>t,metadata:()=>r,toc:()=>l});var i=s(24246),c=s(71670);const t={},o="Interface: CustomPick",r={id:"interfaces/CustomPick",title:"Interface: CustomPick\\",description:"A concrete CustomPick to let the user pick an item from a list of items of type T.",source:"@site/api/interfaces/CustomPick.md",sourceDirName:"interfaces",slug:"/interfaces/CustomPick",permalink:"/api/interfaces/CustomPick",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: ContainerStatsInfo",permalink:"/api/interfaces/ContainerStatsInfo"},next:{title:"Interface: CustomPickItem",permalink:"/api/interfaces/CustomPickItem"}},d={},l=[{value:"Type parameters",id:"type-parameters",level:2},{value:"Properties",id:"properties",level:2},{value:"canSelectMany",id:"canselectmany",level:3},{value:"Source",id:"source",level:4},{value:"description?",id:"description",level:3},{value:"Source",id:"source-1",level:4},{value:"hideItemSections",id:"hideitemsections",level:3},{value:"Source",id:"source-2",level:4},{value:"icon?",id:"icon",level:3},{value:"Source",id:"source-3",level:4},{value:"items",id:"items",level:3},{value:"Source",id:"source-4",level:4},{value:"minHeight?",id:"minheight",level:3},{value:"Source",id:"source-5",level:4},{value:"onDidConfirmSelection",id:"ondidconfirmselection",level:3},{value:"Source",id:"source-6",level:4},{value:"onDidHide",id:"ondidhide",level:3},{value:"Source",id:"source-7",level:4},{value:"title?",id:"title",level:3},{value:"Source",id:"source-8",level:4},{value:"Methods",id:"methods",level:2},{value:"dispose()",id:"dispose",level:3},{value:"Returns",id:"returns",level:4},{value:"Source",id:"source-9",level:4},{value:"hide()",id:"hide",level:3},{value:"Returns",id:"returns-1",level:4},{value:"Source",id:"source-10",level:4},{value:"show()",id:"show",level:3},{value:"Returns",id:"returns-2",level:4},{value:"Source",id:"source-11",level:4}];function a(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,c.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"interface-custompickt",children:"Interface: CustomPick"}),"\n",(0,i.jsx)(n.p,{children:"A concrete CustomPick to let the user pick an item from a list of items of type T.\nThe items are rendered using a custom UI."}),"\n",(0,i.jsx)(n.h2,{id:"type-parameters",children:"Type parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"T"})," extends ",(0,i.jsx)(n.a,{href:"/api/interfaces/CustomPickItem",children:(0,i.jsx)(n.code,{children:"CustomPickItem"})})]}),"\n",(0,i.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(n.h3,{id:"canselectmany",children:"canSelectMany"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"canSelectMany"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"If multiple items can be selected at the same time. Defaults to false."}),"\n",(0,i.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L1113",children:"packages/extension-api/src/extension-api.d.ts:1113"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"description",children:"description?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"description"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"An optional human-readable string which is rendered less prominent in a separate line."}),"\n",(0,i.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L1101",children:"packages/extension-api/src/extension-api.d.ts:1101"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"hideitemsections",children:"hideItemSections"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"hideItemSections"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"If the additional sections of an item should be hidden by default when the dialog opens up.\nThe user can still open them by clicking on the 'show more' button.\nDefaults to false."}),"\n",(0,i.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L1119",children:"packages/extension-api/src/extension-api.d.ts:1119"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"icon",children:"icon?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"icon"}),": ",(0,i.jsx)(n.code,{children:"string"})," | ",(0,i.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"An optional base64 PNG image"}),"\n",(0,i.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L1105",children:"packages/extension-api/src/extension-api.d.ts:1105"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"items",children:"items"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"items"}),": ",(0,i.jsx)(n.code,{children:"T"}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Items to pick from. This can be read and updated by the extension."}),"\n",(0,i.jsx)(n.h4,{id:"source-4",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L1109",children:"packages/extension-api/src/extension-api.d.ts:1109"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"minheight",children:"minHeight?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"minHeight"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"When a custompick is closed (the sections are hidden) it is possible to set a minimum height so to force different items to have the same height.\nIt must be set using pixels or percentage (e.g 100px or 50%)\nUse it carefully as it could break the layout."}),"\n",(0,i.jsx)(n.h4,{id:"source-5",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L1125",children:"packages/extension-api/src/extension-api.d.ts:1125"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"ondidconfirmselection",children:"onDidConfirmSelection"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"readonly"})})," ",(0,i.jsx)(n.strong,{children:"onDidConfirmSelection"}),": ",(0,i.jsx)(n.a,{href:"/api/interfaces/Event",children:(0,i.jsx)(n.code,{children:"Event"})}),"< ",(0,i.jsx)(n.code,{children:"number"}),"[] >"]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"An event signaling when the user indicated confirmation of the selected item(s) index(es)."}),"\n",(0,i.jsx)(n.h4,{id:"source-6",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L1129",children:"packages/extension-api/src/extension-api.d.ts:1129"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"ondidhide",children:"onDidHide"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"readonly"})})," ",(0,i.jsx)(n.strong,{children:"onDidHide"}),": ",(0,i.jsx)(n.a,{href:"/api/interfaces/Event",children:(0,i.jsx)(n.code,{children:"Event"})}),"< ",(0,i.jsx)(n.code,{children:"void"})," >"]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"An event signaling when this input UI is hidden."}),"\n",(0,i.jsx)(n.h4,{id:"source-7",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L1133",children:"packages/extension-api/src/extension-api.d.ts:1133"})}),"\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:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"title"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"An optional human-readable string which is rendered prominent."}),"\n",(0,i.jsx)(n.h4,{id:"source-8",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L1097",children:"packages/extension-api/src/extension-api.d.ts:1097"})}),"\n",(0,i.jsx)(n.h2,{id:"methods",children:"Methods"}),"\n",(0,i.jsx)(n.h3,{id:"dispose",children:"dispose()"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"dispose"}),"(): ",(0,i.jsx)(n.code,{children:"void"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Dispose and free associated resources. Call\n",(0,i.jsx)(n.a,{href:"/api/interfaces/CustomPick#hide",children:"CustomPick.hide"}),"."]}),"\n",(0,i.jsx)(n.h4,{id:"returns",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"void"})}),"\n",(0,i.jsx)(n.h4,{id:"source-9",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L1147",children:"packages/extension-api/src/extension-api.d.ts:1147"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"hide",children:"hide()"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"hide"}),"(): ",(0,i.jsx)(n.code,{children:"void"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Hides the custom pick."}),"\n",(0,i.jsx)(n.h4,{id:"returns-1",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"void"})}),"\n",(0,i.jsx)(n.h4,{id:"source-10",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L1141",children:"packages/extension-api/src/extension-api.d.ts:1141"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"show",children:"show()"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"show"}),"(): ",(0,i.jsx)(n.code,{children:"void"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Shows the custom pick."}),"\n",(0,i.jsx)(n.h4,{id:"returns-2",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"void"})}),"\n",(0,i.jsx)(n.h4,{id:"source-11",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L1137",children:"packages/extension-api/src/extension-api.d.ts:1137"})})]})}function h(e={}){const{wrapper:n}={...(0,c.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(a,{...e})}):a(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>r,a:()=>o});var i=s(27378);const c={},t=i.createContext(c);function o(e){const n=i.useContext(t);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function r(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(c):e.components||c:o(e.components),i.createElement(t.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[71970],{28305:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>d,contentTitle:()=>o,default:()=>a,frontMatter:()=>t,metadata:()=>r,toc:()=>l});var i=s(24246),c=s(71670);const t={},o="Interface: CustomPick",r={id:"interfaces/CustomPick",title:"Interface: CustomPick\\",description:"A concrete CustomPick to let the user pick an item from a list of items of type T.",source:"@site/api/interfaces/CustomPick.md",sourceDirName:"interfaces",slug:"/interfaces/CustomPick",permalink:"/api/interfaces/CustomPick",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: ContainerStatsInfo",permalink:"/api/interfaces/ContainerStatsInfo"},next:{title:"Interface: CustomPickItem",permalink:"/api/interfaces/CustomPickItem"}},d={},l=[{value:"Type parameters",id:"type-parameters",level:2},{value:"Properties",id:"properties",level:2},{value:"canSelectMany",id:"canselectmany",level:3},{value:"Source",id:"source",level:4},{value:"description?",id:"description",level:3},{value:"Source",id:"source-1",level:4},{value:"hideItemSections",id:"hideitemsections",level:3},{value:"Source",id:"source-2",level:4},{value:"icon?",id:"icon",level:3},{value:"Source",id:"source-3",level:4},{value:"items",id:"items",level:3},{value:"Source",id:"source-4",level:4},{value:"minHeight?",id:"minheight",level:3},{value:"Source",id:"source-5",level:4},{value:"onDidConfirmSelection",id:"ondidconfirmselection",level:3},{value:"Source",id:"source-6",level:4},{value:"onDidHide",id:"ondidhide",level:3},{value:"Source",id:"source-7",level:4},{value:"title?",id:"title",level:3},{value:"Source",id:"source-8",level:4},{value:"Methods",id:"methods",level:2},{value:"dispose()",id:"dispose",level:3},{value:"Returns",id:"returns",level:4},{value:"Source",id:"source-9",level:4},{value:"hide()",id:"hide",level:3},{value:"Returns",id:"returns-1",level:4},{value:"Source",id:"source-10",level:4},{value:"show()",id:"show",level:3},{value:"Returns",id:"returns-2",level:4},{value:"Source",id:"source-11",level:4}];function h(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,c.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"interface-custompickt",children:"Interface: CustomPick"}),"\n",(0,i.jsx)(n.p,{children:"A concrete CustomPick to let the user pick an item from a list of items of type T.\nThe items are rendered using a custom UI."}),"\n",(0,i.jsx)(n.h2,{id:"type-parameters",children:"Type parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"T"})," extends ",(0,i.jsx)(n.a,{href:"/api/interfaces/CustomPickItem",children:(0,i.jsx)(n.code,{children:"CustomPickItem"})})]}),"\n",(0,i.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(n.h3,{id:"canselectmany",children:"canSelectMany"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"canSelectMany"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"If multiple items can be selected at the same time. Defaults to false."}),"\n",(0,i.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L1113",children:"packages/extension-api/src/extension-api.d.ts:1113"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"description",children:"description?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"description"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"An optional human-readable string which is rendered less prominent in a separate line."}),"\n",(0,i.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L1101",children:"packages/extension-api/src/extension-api.d.ts:1101"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"hideitemsections",children:"hideItemSections"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"hideItemSections"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"If the additional sections of an item should be hidden by default when the dialog opens up.\nThe user can still open them by clicking on the 'show more' button.\nDefaults to false."}),"\n",(0,i.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L1119",children:"packages/extension-api/src/extension-api.d.ts:1119"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"icon",children:"icon?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"icon"}),": ",(0,i.jsx)(n.code,{children:"string"})," | ",(0,i.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"An optional base64 PNG image"}),"\n",(0,i.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L1105",children:"packages/extension-api/src/extension-api.d.ts:1105"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"items",children:"items"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"items"}),": ",(0,i.jsx)(n.code,{children:"T"}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Items to pick from. This can be read and updated by the extension."}),"\n",(0,i.jsx)(n.h4,{id:"source-4",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L1109",children:"packages/extension-api/src/extension-api.d.ts:1109"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"minheight",children:"minHeight?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"minHeight"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"When a custompick is closed (the sections are hidden) it is possible to set a minimum height so to force different items to have the same height.\nIt must be set using pixels or percentage (e.g 100px or 50%)\nUse it carefully as it could break the layout."}),"\n",(0,i.jsx)(n.h4,{id:"source-5",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L1125",children:"packages/extension-api/src/extension-api.d.ts:1125"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"ondidconfirmselection",children:"onDidConfirmSelection"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"readonly"})})," ",(0,i.jsx)(n.strong,{children:"onDidConfirmSelection"}),": ",(0,i.jsx)(n.a,{href:"/api/interfaces/Event",children:(0,i.jsx)(n.code,{children:"Event"})}),"< ",(0,i.jsx)(n.code,{children:"number"}),"[] >"]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"An event signaling when the user indicated confirmation of the selected item(s) index(es)."}),"\n",(0,i.jsx)(n.h4,{id:"source-6",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L1129",children:"packages/extension-api/src/extension-api.d.ts:1129"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"ondidhide",children:"onDidHide"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"readonly"})})," ",(0,i.jsx)(n.strong,{children:"onDidHide"}),": ",(0,i.jsx)(n.a,{href:"/api/interfaces/Event",children:(0,i.jsx)(n.code,{children:"Event"})}),"< ",(0,i.jsx)(n.code,{children:"void"})," >"]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"An event signaling when this input UI is hidden."}),"\n",(0,i.jsx)(n.h4,{id:"source-7",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L1133",children:"packages/extension-api/src/extension-api.d.ts:1133"})}),"\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:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"title"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"An optional human-readable string which is rendered prominent."}),"\n",(0,i.jsx)(n.h4,{id:"source-8",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L1097",children:"packages/extension-api/src/extension-api.d.ts:1097"})}),"\n",(0,i.jsx)(n.h2,{id:"methods",children:"Methods"}),"\n",(0,i.jsx)(n.h3,{id:"dispose",children:"dispose()"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"dispose"}),"(): ",(0,i.jsx)(n.code,{children:"void"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Dispose and free associated resources. Call\n",(0,i.jsx)(n.a,{href:"/api/interfaces/CustomPick#hide",children:"CustomPick.hide"}),"."]}),"\n",(0,i.jsx)(n.h4,{id:"returns",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"void"})}),"\n",(0,i.jsx)(n.h4,{id:"source-9",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L1147",children:"packages/extension-api/src/extension-api.d.ts:1147"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"hide",children:"hide()"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"hide"}),"(): ",(0,i.jsx)(n.code,{children:"void"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Hides the custom pick."}),"\n",(0,i.jsx)(n.h4,{id:"returns-1",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"void"})}),"\n",(0,i.jsx)(n.h4,{id:"source-10",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L1141",children:"packages/extension-api/src/extension-api.d.ts:1141"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"show",children:"show()"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"show"}),"(): ",(0,i.jsx)(n.code,{children:"void"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Shows the custom pick."}),"\n",(0,i.jsx)(n.h4,{id:"returns-2",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"void"})}),"\n",(0,i.jsx)(n.h4,{id:"source-11",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L1137",children:"packages/extension-api/src/extension-api.d.ts:1137"})})]})}function a(e={}){const{wrapper:n}={...(0,c.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(h,{...e})}):h(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>r,a:()=>o});var i=s(27378);const c={},t=i.createContext(c);function o(e){const n=i.useContext(t);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function r(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(c):e.components||c:o(e.components),i.createElement(t.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/ae4a775b.cd9e36d3.js b/assets/js/ae4a775b.839510da.js similarity index 96% rename from assets/js/ae4a775b.cd9e36d3.js rename to assets/js/ae4a775b.839510da.js index a2442db9d20..e07fd11d589 100644 --- a/assets/js/ae4a775b.cd9e36d3.js +++ b/assets/js/ae4a775b.839510da.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[30901],{86001:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>i,contentTitle:()=>r,default:()=>u,frontMatter:()=>o,metadata:()=>a,toc:()=>d});var s=t(24246),c=t(71670);const o={},r="Function: setValue()",a={id:"namespaces/context/functions/setValue",title:"Function: setValue()",description:"setValue(key, value, scope?): void",source:"@site/api/namespaces/context/functions/setValue.md",sourceDirName:"namespaces/context/functions",slug:"/namespaces/context/functions/setValue",permalink:"/api/namespaces/context/functions/setValue",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Namespace: context",permalink:"/api/namespaces/context/"},next:{title:"Namespace: env",permalink:"/api/namespaces/env/"}},i={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,c.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"function-setvalue",children:"Function: setValue()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"setValue"}),"(",(0,s.jsx)(n.code,{children:"key"}),", ",(0,s.jsx)(n.code,{children:"value"}),", ",(0,s.jsx)(n.code,{children:"scope"}),"?): ",(0,s.jsx)(n.code,{children:"void"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:'Store a new value for key in the context.\nThis can be used in enablement of command or with the when property.\nThe key should consists of \'"extension-id"."actual-key"\'.'}),"\n",(0,s.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"key"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n",(0,s.jsx)(n.p,{children:"the key of the key/value pair to be added to the context"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"value"}),": ",(0,s.jsx)(n.code,{children:"any"})]}),"\n",(0,s.jsx)(n.p,{children:"value associated to the key"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"scope?"}),": ",(0,s.jsx)(n.code,{children:'"onboarding"'})]}),"\n",(0,s.jsx)(n.p,{children:"the scope to use to save the value"}),"\n",(0,s.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"void"})}),"\n",(0,s.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L3991",children:"packages/extension-api/src/extension-api.d.ts:3991"})})]})}function u(e={}){const{wrapper:n}={...(0,c.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>a,a:()=>r});var s=t(27378);const c={},o=s.createContext(c);function r(e){const n=s.useContext(o);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function a(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(c):e.components||c:r(e.components),s.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[30901],{86001:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>i,contentTitle:()=>r,default:()=>u,frontMatter:()=>o,metadata:()=>a,toc:()=>d});var s=t(24246),c=t(71670);const o={},r="Function: setValue()",a={id:"namespaces/context/functions/setValue",title:"Function: setValue()",description:"setValue(key, value, scope?): void",source:"@site/api/namespaces/context/functions/setValue.md",sourceDirName:"namespaces/context/functions",slug:"/namespaces/context/functions/setValue",permalink:"/api/namespaces/context/functions/setValue",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Namespace: context",permalink:"/api/namespaces/context/"},next:{title:"Namespace: env",permalink:"/api/namespaces/env/"}},i={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,c.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"function-setvalue",children:"Function: setValue()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"setValue"}),"(",(0,s.jsx)(n.code,{children:"key"}),", ",(0,s.jsx)(n.code,{children:"value"}),", ",(0,s.jsx)(n.code,{children:"scope"}),"?): ",(0,s.jsx)(n.code,{children:"void"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:'Store a new value for key in the context.\nThis can be used in enablement of command or with the when property.\nThe key should consists of \'"extension-id"."actual-key"\'.'}),"\n",(0,s.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"key"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n",(0,s.jsx)(n.p,{children:"the key of the key/value pair to be added to the context"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"value"}),": ",(0,s.jsx)(n.code,{children:"any"})]}),"\n",(0,s.jsx)(n.p,{children:"value associated to the key"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"scope?"}),": ",(0,s.jsx)(n.code,{children:'"onboarding"'})]}),"\n",(0,s.jsx)(n.p,{children:"the scope to use to save the value"}),"\n",(0,s.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"void"})}),"\n",(0,s.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L3991",children:"packages/extension-api/src/extension-api.d.ts:3991"})})]})}function u(e={}){const{wrapper:n}={...(0,c.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>a,a:()=>r});var s=t(27378);const c={},o=s.createContext(c);function r(e){const n=s.useContext(o);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function a(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(c):e.components||c:r(e.components),s.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/b15eeff9.06e2bb8a.js b/assets/js/b15eeff9.3e7fee51.js similarity index 86% rename from assets/js/b15eeff9.06e2bb8a.js rename to assets/js/b15eeff9.3e7fee51.js index 955a36f6cec..fb9fe1dbd85 100644 --- a/assets/js/b15eeff9.06e2bb8a.js +++ b/assets/js/b15eeff9.3e7fee51.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[67411],{9958:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>c,default:()=>l,frontMatter:()=>s,metadata:()=>r,toc:()=>h});var i=t(24246),o=t(71670);const s={},c="Interface: AuthenticationSessionAccountInformation",r={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:"Interface: AuthenticationSession",permalink:"/api/interfaces/AuthenticationSession"},next:{title:"Interface: AuthenticationSessionsChangeEvent",permalink:"/api/interfaces/AuthenticationSessionsChangeEvent"}},a={},h=[{value:"Properties",id:"properties",level:2},{value:"id",id:"id",level:3},{value:"Source",id:"source",level:4},{value:"label",id:"label",level:3},{value:"Source",id:"source-1",level:4}];function d(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,o.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"interface-authenticationsessionaccountinformation",children:"Interface: AuthenticationSessionAccountInformation"}),"\n",(0,i.jsxs)(n.p,{children:["The information of an account associated with an ",(0,i.jsx)(n.a,{href:"#AuthenticationSession",children:"AuthenticationSession"}),"."]}),"\n",(0,i.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(n.h3,{id:"id",children:"id"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"readonly"})})," ",(0,i.jsx)(n.strong,{children:"id"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"The unique identifier of the account."}),"\n",(0,i.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L3422",children:"packages/extension-api/src/extension-api.d.ts:3422"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"label",children:"label"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"readonly"})})," ",(0,i.jsx)(n.strong,{children:"label"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"The human-readable name of the account."}),"\n",(0,i.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L3427",children:"packages/extension-api/src/extension-api.d.ts:3427"})})]})}function l(e={}){const{wrapper:n}={...(0,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:()=>r,a:()=>c});var i=t(27378);const o={},s=i.createContext(o);function c(e){const n=i.useContext(s);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function r(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:c(e.components),i.createElement(s.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[67411],{9958:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>c,default:()=>l,frontMatter:()=>s,metadata:()=>r,toc:()=>d});var i=t(24246),o=t(71670);const s={},c="Interface: AuthenticationSessionAccountInformation",r={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:"Interface: AuthenticationSession",permalink:"/api/interfaces/AuthenticationSession"},next:{title:"Interface: AuthenticationSessionsChangeEvent",permalink:"/api/interfaces/AuthenticationSessionsChangeEvent"}},a={},d=[{value:"Properties",id:"properties",level:2},{value:"id",id:"id",level:3},{value:"Source",id:"source",level:4},{value:"label",id:"label",level:3},{value:"Source",id:"source-1",level:4}];function h(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,o.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"interface-authenticationsessionaccountinformation",children:"Interface: AuthenticationSessionAccountInformation"}),"\n",(0,i.jsxs)(n.p,{children:["The information of an account associated with an ",(0,i.jsx)(n.a,{href:"#AuthenticationSession",children:"AuthenticationSession"}),"."]}),"\n",(0,i.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(n.h3,{id:"id",children:"id"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"readonly"})})," ",(0,i.jsx)(n.strong,{children:"id"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"The unique identifier of the account."}),"\n",(0,i.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L3422",children:"packages/extension-api/src/extension-api.d.ts:3422"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"label",children:"label"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"readonly"})})," ",(0,i.jsx)(n.strong,{children:"label"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"The human-readable name of the account."}),"\n",(0,i.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L3427",children:"packages/extension-api/src/extension-api.d.ts:3427"})})]})}function l(e={}){const{wrapper:n}={...(0,o.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(h,{...e})}):h(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>r,a:()=>c});var i=t(27378);const o={},s=i.createContext(o);function c(e){const n=i.useContext(s);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function r(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:c(e.components),i.createElement(s.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/b3b7dd16.0039922a.js b/assets/js/b3b7dd16.8ae196d0.js similarity index 95% rename from assets/js/b3b7dd16.0039922a.js rename to assets/js/b3b7dd16.8ae196d0.js index 48bc2bd0186..40fe5f44cea 100644 --- a/assets/js/b3b7dd16.0039922a.js +++ b/assets/js/b3b7dd16.8ae196d0.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[84960],{58966:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>a,contentTitle:()=>o,default:()=>p,frontMatter:()=>i,metadata:()=>r,toc:()=>u});var s=n(24246),c=n(71670);const i={},o="Function: createCustomPick()",r={id:"namespaces/window/functions/createCustomPick",title:"Function: createCustomPick()",description:"createCustomPick\\(): CustomPick\\",source:"@site/api/namespaces/window/functions/createCustomPick.md",sourceDirName:"namespaces/window/functions",slug:"/namespaces/window/functions/createCustomPick",permalink:"/api/namespaces/window/functions/createCustomPick",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Namespace: window",permalink:"/api/namespaces/window/"},next:{title:"Function: createStatusBarItem()",permalink:"/api/namespaces/window/functions/createStatusBarItem"}},a={},u=[{value:"Type parameters",id:"type-parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function d(e){const t={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,c.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(t.h1,{id:"function-createcustompick",children:"Function: createCustomPick()"}),"\n",(0,s.jsxs)(t.blockquote,{children:["\n",(0,s.jsxs)(t.p,{children:[(0,s.jsx)(t.strong,{children:"createCustomPick"}),"<",(0,s.jsx)(t.code,{children:"T"}),">(): ",(0,s.jsx)(t.a,{href:"/api/interfaces/CustomPick",children:(0,s.jsx)(t.code,{children:"CustomPick"})}),"< ",(0,s.jsx)(t.code,{children:"T"})," >"]}),"\n"]}),"\n",(0,s.jsx)(t.p,{children:"Creates a CustomPick to let the user pick an item from a list of items of type T using a custom UI."}),"\n",(0,s.jsx)(t.h2,{id:"type-parameters",children:"Type parameters"}),"\n",(0,s.jsxs)(t.p,{children:["\u2022 ",(0,s.jsx)(t.strong,{children:"T"})," extends ",(0,s.jsx)(t.a,{href:"/api/interfaces/CustomPickItem",children:(0,s.jsx)(t.code,{children:"CustomPickItem"})})]}),"\n",(0,s.jsx)(t.h2,{id:"returns",children:"Returns"}),"\n",(0,s.jsxs)(t.p,{children:[(0,s.jsx)(t.a,{href:"/api/interfaces/CustomPick",children:(0,s.jsx)(t.code,{children:"CustomPick"})}),"< ",(0,s.jsx)(t.code,{children:"T"})," >"]}),"\n",(0,s.jsx)(t.p,{children:"A new CustomPick"}),"\n",(0,s.jsx)(t.h2,{id:"source",children:"Source"}),"\n",(0,s.jsx)(t.p,{children:(0,s.jsx)(t.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L1784",children:"packages/extension-api/src/extension-api.d.ts:1784"})})]})}function p(e={}){const{wrapper:t}={...(0,c.a)(),...e.components};return t?(0,s.jsx)(t,{...e,children:(0,s.jsx)(d,{...e})}):d(e)}},71670:(e,t,n)=>{n.d(t,{Z:()=>r,a:()=>o});var s=n(27378);const c={},i=s.createContext(c);function o(e){const t=s.useContext(i);return s.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function r(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(c):e.components||c:o(e.components),s.createElement(i.Provider,{value:t},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[84960],{58966:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>a,contentTitle:()=>o,default:()=>p,frontMatter:()=>i,metadata:()=>r,toc:()=>u});var s=n(24246),c=n(71670);const i={},o="Function: createCustomPick()",r={id:"namespaces/window/functions/createCustomPick",title:"Function: createCustomPick()",description:"createCustomPick\\(): CustomPick\\",source:"@site/api/namespaces/window/functions/createCustomPick.md",sourceDirName:"namespaces/window/functions",slug:"/namespaces/window/functions/createCustomPick",permalink:"/api/namespaces/window/functions/createCustomPick",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Namespace: window",permalink:"/api/namespaces/window/"},next:{title:"Function: createStatusBarItem()",permalink:"/api/namespaces/window/functions/createStatusBarItem"}},a={},u=[{value:"Type parameters",id:"type-parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function d(e){const t={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,c.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(t.h1,{id:"function-createcustompick",children:"Function: createCustomPick()"}),"\n",(0,s.jsxs)(t.blockquote,{children:["\n",(0,s.jsxs)(t.p,{children:[(0,s.jsx)(t.strong,{children:"createCustomPick"}),"<",(0,s.jsx)(t.code,{children:"T"}),">(): ",(0,s.jsx)(t.a,{href:"/api/interfaces/CustomPick",children:(0,s.jsx)(t.code,{children:"CustomPick"})}),"< ",(0,s.jsx)(t.code,{children:"T"})," >"]}),"\n"]}),"\n",(0,s.jsx)(t.p,{children:"Creates a CustomPick to let the user pick an item from a list of items of type T using a custom UI."}),"\n",(0,s.jsx)(t.h2,{id:"type-parameters",children:"Type parameters"}),"\n",(0,s.jsxs)(t.p,{children:["\u2022 ",(0,s.jsx)(t.strong,{children:"T"})," extends ",(0,s.jsx)(t.a,{href:"/api/interfaces/CustomPickItem",children:(0,s.jsx)(t.code,{children:"CustomPickItem"})})]}),"\n",(0,s.jsx)(t.h2,{id:"returns",children:"Returns"}),"\n",(0,s.jsxs)(t.p,{children:[(0,s.jsx)(t.a,{href:"/api/interfaces/CustomPick",children:(0,s.jsx)(t.code,{children:"CustomPick"})}),"< ",(0,s.jsx)(t.code,{children:"T"})," >"]}),"\n",(0,s.jsx)(t.p,{children:"A new CustomPick"}),"\n",(0,s.jsx)(t.h2,{id:"source",children:"Source"}),"\n",(0,s.jsx)(t.p,{children:(0,s.jsx)(t.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L1784",children:"packages/extension-api/src/extension-api.d.ts:1784"})})]})}function p(e={}){const{wrapper:t}={...(0,c.a)(),...e.components};return t?(0,s.jsx)(t,{...e,children:(0,s.jsx)(d,{...e})}):d(e)}},71670:(e,t,n)=>{n.d(t,{Z:()=>r,a:()=>o});var s=n(27378);const c={},i=s.createContext(c);function o(e){const t=s.useContext(i);return s.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function r(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(c):e.components||c:o(e.components),s.createElement(i.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/b4df9b48.cf90335e.js b/assets/js/b4df9b48.49b7253c.js similarity index 84% rename from assets/js/b4df9b48.cf90335e.js rename to assets/js/b4df9b48.49b7253c.js index 62cf4a176ea..2e230430fcc 100644 --- a/assets/js/b4df9b48.cf90335e.js +++ b/assets/js/b4df9b48.49b7253c.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[35425],{16463:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>d,contentTitle:()=>t,default:()=>h,frontMatter:()=>c,metadata:()=>o,toc:()=>a});var s=r(24246),i=r(71670);const c={},t="Interface: Registry",o={id:"interfaces/Registry",title:"Interface: Registry",description:"Extends",source:"@site/api/interfaces/Registry.md",sourceDirName:"interfaces",slug:"/interfaces/Registry",permalink:"/api/interfaces/Registry",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: RegisterKubernetesConnectionEvent",permalink:"/api/interfaces/RegisterKubernetesConnectionEvent"},next:{title:"Interface: RegistryConfig",permalink:"/api/interfaces/RegistryConfig"}},d={},a=[{value:"Extends",id:"extends",level:2},{value:"Properties",id:"properties",level:2},{value:"icon?",id:"icon",level:3},{value:"Source",id:"source",level:4},{value:"insecure?",id:"insecure",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Source",id:"source-1",level:4},{value:"name?",id:"name",level:3},{value:"Source",id:"source-2",level:4},{value:"secret",id:"secret",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Source",id:"source-3",level:4},{value:"serverUrl",id:"serverurl",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Source",id:"source-4",level:4},{value:"source",id:"source-5",level:3},{value:"Source",id:"source-6",level:4},{value:"username",id:"username",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Source",id:"source-7",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",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-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:"icon",children:"icon?"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:(0,s.jsx)(n.code,{children:"optional"})})," ",(0,s.jsx)(n.strong,{children:"icon"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L600",children:"packages/extension-api/src/extension-api.d.ts:600"})}),"\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.strong,{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",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:"source-1",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L607",children:"packages/extension-api/src/extension-api.d.ts:607"})}),"\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:(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:"source-2",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/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:"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-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#secret",children:(0,s.jsx)(n.code,{children:"secret"})})]}),"\n",(0,s.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L606",children:"packages/extension-api/src/extension-api.d.ts:606"})}),"\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-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#serverurl",children:(0,s.jsx)(n.code,{children:"serverUrl"})})]}),"\n",(0,s.jsx)(n.h4,{id:"source-4",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L604",children:"packages/extension-api/src/extension-api.d.ts:604"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"source-5",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:"source-6",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L596",children:"packages/extension-api/src/extension-api.d.ts:596"})}),"\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-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#username",children:(0,s.jsx)(n.code,{children:"username"})})]}),"\n",(0,s.jsx)(n.h4,{id:"source-7",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L605",children:"packages/extension-api/src/extension-api.d.ts:605"})})]})}function h(e={}){const{wrapper:n}={...(0,i.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},71670:(e,n,r)=>{r.d(n,{Z:()=>o,a:()=>t});var s=r(27378);const i={},c=s.createContext(i);function t(e){const n=s.useContext(c);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:t(e.components),s.createElement(c.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[35425],{16463:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>o,contentTitle:()=>t,default:()=>h,frontMatter:()=>c,metadata:()=>d,toc:()=>l});var s=r(24246),i=r(71670);const c={},t="Interface: Registry",d={id:"interfaces/Registry",title:"Interface: Registry",description:"Extends",source:"@site/api/interfaces/Registry.md",sourceDirName:"interfaces",slug:"/interfaces/Registry",permalink:"/api/interfaces/Registry",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: RegisterKubernetesConnectionEvent",permalink:"/api/interfaces/RegisterKubernetesConnectionEvent"},next:{title:"Interface: RegistryConfig",permalink:"/api/interfaces/RegistryConfig"}},o={},l=[{value:"Extends",id:"extends",level:2},{value:"Properties",id:"properties",level:2},{value:"icon?",id:"icon",level:3},{value:"Source",id:"source",level:4},{value:"insecure?",id:"insecure",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Source",id:"source-1",level:4},{value:"name?",id:"name",level:3},{value:"Source",id:"source-2",level:4},{value:"secret",id:"secret",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Source",id:"source-3",level:4},{value:"serverUrl",id:"serverurl",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Source",id:"source-4",level:4},{value:"source",id:"source-5",level:3},{value:"Source",id:"source-6",level:4},{value:"username",id:"username",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Source",id:"source-7",level:4}];function a(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",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-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:"icon",children:"icon?"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:(0,s.jsx)(n.code,{children:"optional"})})," ",(0,s.jsx)(n.strong,{children:"icon"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L600",children:"packages/extension-api/src/extension-api.d.ts:600"})}),"\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.strong,{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",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:"source-1",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L607",children:"packages/extension-api/src/extension-api.d.ts:607"})}),"\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:(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:"source-2",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/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:"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-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#secret",children:(0,s.jsx)(n.code,{children:"secret"})})]}),"\n",(0,s.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L606",children:"packages/extension-api/src/extension-api.d.ts:606"})}),"\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-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#serverurl",children:(0,s.jsx)(n.code,{children:"serverUrl"})})]}),"\n",(0,s.jsx)(n.h4,{id:"source-4",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L604",children:"packages/extension-api/src/extension-api.d.ts:604"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"source-5",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:"source-6",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L596",children:"packages/extension-api/src/extension-api.d.ts:596"})}),"\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-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#username",children:(0,s.jsx)(n.code,{children:"username"})})]}),"\n",(0,s.jsx)(n.h4,{id:"source-7",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L605",children:"packages/extension-api/src/extension-api.d.ts:605"})})]})}function h(e={}){const{wrapper:n}={...(0,i.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(a,{...e})}):a(e)}},71670:(e,n,r)=>{r.d(n,{Z:()=>d,a:()=>t});var s=r(27378);const i={},c=s.createContext(i);function t(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(i):e.components||i:t(e.components),s.createElement(c.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/b5114993.b00af05f.js b/assets/js/b5114993.81d24852.js similarity index 88% rename from assets/js/b5114993.b00af05f.js rename to assets/js/b5114993.81d24852.js index bae22b39be2..33eb8d88266 100644 --- a/assets/js/b5114993.b00af05f.js +++ b/assets/js/b5114993.81d24852.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[54373],{28838:(e,s,n)=>{n.r(s),n.d(s,{assets:()=>o,contentTitle:()=>l,default:()=>h,frontMatter:()=>c,metadata:()=>a,toc:()=>d});var i=n(24246),r=n(71670);const c={},l="Class: Disposable",a={id:"classes/Disposable",title:"Class: Disposable",description:"Extended by",source:"@site/api/classes/Disposable.md",sourceDirName:"classes",slug:"/classes/Disposable",permalink:"/api/classes/Disposable",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Class: CancellationTokenSource",permalink:"/api/classes/CancellationTokenSource"},next:{title:"Class: EventEmitter\\",permalink:"/api/classes/EventEmitter"}},o={},d=[{value:"Extended by",id:"extended-by",level:2},{value:"Constructors",id:"constructors",level:2},{value:"new Disposable(func)",id:"new-disposablefunc",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Source",id:"source",level:4},{value:"new Disposable(callOnDispose)",id:"new-disposablecallondispose",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Source",id:"source-1",level:4},{value:"Methods",id:"methods",level:2},{value:"dispose()",id:"dispose",level:3},{value:"Returns",id:"returns-2",level:4},{value:"Source",id:"source-2",level:4},{value:"create()",id:"create",level:3},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-3",level:4},{value:"Source",id:"source-3",level:4},{value:"from()",id:"from",level:3},{value:"Parameters",id:"parameters-3",level:4},{value:"Returns",id:"returns-4",level:4},{value:"Source",id:"source-4",level:4}];function t(e){const s={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",li:"li",p:"p",strong:"strong",ul:"ul",...(0,r.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(s.h1,{id:"class-disposable",children:"Class: Disposable"}),"\n",(0,i.jsx)(s.h2,{id:"extended-by",children:"Extended by"}),"\n",(0,i.jsxs)(s.ul,{children:["\n",(0,i.jsx)(s.li,{children:(0,i.jsx)(s.a,{href:"/api/interfaces/FileSystemWatcher",children:(0,i.jsx)(s.code,{children:"FileSystemWatcher"})})}),"\n",(0,i.jsx)(s.li,{children:(0,i.jsx)(s.a,{href:"/api/interfaces/CliTool",children:(0,i.jsx)(s.code,{children:"CliTool"})})}),"\n"]}),"\n",(0,i.jsx)(s.h2,{id:"constructors",children:"Constructors"}),"\n",(0,i.jsx)(s.h3,{id:"new-disposablefunc",children:"new Disposable(func)"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"new Disposable"}),"(",(0,i.jsx)(s.code,{children:"func"}),"): ",(0,i.jsx)(s.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(s.code,{children:"Disposable"})})]}),"\n"]}),"\n",(0,i.jsx)(s.h4,{id:"parameters",children:"Parameters"}),"\n",(0,i.jsxs)(s.p,{children:["\u2022 ",(0,i.jsx)(s.strong,{children:"func"})]}),"\n",(0,i.jsx)(s.h4,{id:"returns",children:"Returns"}),"\n",(0,i.jsx)(s.p,{children:(0,i.jsx)(s.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(s.code,{children:"Disposable"})})}),"\n",(0,i.jsx)(s.h4,{id:"source",children:"Source"}),"\n",(0,i.jsx)(s.p,{children:(0,i.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L66",children:"packages/extension-api/src/extension-api.d.ts:66"})}),"\n",(0,i.jsx)(s.h3,{id:"new-disposablecallondispose",children:"new Disposable(callOnDispose)"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"new Disposable"}),"(",(0,i.jsx)(s.code,{children:"callOnDispose"}),"): ",(0,i.jsx)(s.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(s.code,{children:"Disposable"})})]}),"\n"]}),"\n",(0,i.jsx)(s.p,{children:"Creates a new Disposable calling the provided function\non dispose."}),"\n",(0,i.jsx)(s.h4,{id:"parameters-1",children:"Parameters"}),"\n",(0,i.jsxs)(s.p,{children:["\u2022 ",(0,i.jsx)(s.strong,{children:"callOnDispose"}),": ",(0,i.jsx)(s.code,{children:"Function"})]}),"\n",(0,i.jsx)(s.p,{children:"Function that disposes something."}),"\n",(0,i.jsx)(s.h4,{id:"returns-1",children:"Returns"}),"\n",(0,i.jsx)(s.p,{children:(0,i.jsx)(s.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(s.code,{children:"Disposable"})})}),"\n",(0,i.jsx)(s.h4,{id:"source-1",children:"Source"}),"\n",(0,i.jsx)(s.p,{children:(0,i.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L73",children:"packages/extension-api/src/extension-api.d.ts:73"})}),"\n",(0,i.jsx)(s.h2,{id:"methods",children:"Methods"}),"\n",(0,i.jsx)(s.h3,{id:"dispose",children:"dispose()"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"dispose"}),"(): ",(0,i.jsx)(s.code,{children:"void"})]}),"\n"]}),"\n",(0,i.jsx)(s.p,{children:"Dispose this object."}),"\n",(0,i.jsx)(s.h4,{id:"returns-2",children:"Returns"}),"\n",(0,i.jsx)(s.p,{children:(0,i.jsx)(s.code,{children:"void"})}),"\n",(0,i.jsx)(s.h4,{id:"source-2",children:"Source"}),"\n",(0,i.jsx)(s.p,{children:(0,i.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L78",children:"packages/extension-api/src/extension-api.d.ts:78"})}),"\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.strong,{children:(0,i.jsx)(s.code,{children:"static"})})," ",(0,i.jsx)(s.strong,{children:"create"}),"(",(0,i.jsx)(s.code,{children:"func"}),"): ",(0,i.jsx)(s.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(s.code,{children:"Disposable"})})]}),"\n"]}),"\n",(0,i.jsx)(s.h4,{id:"parameters-2",children:"Parameters"}),"\n",(0,i.jsxs)(s.p,{children:["\u2022 ",(0,i.jsx)(s.strong,{children:"func"})]}),"\n",(0,i.jsx)(s.h4,{id:"returns-3",children:"Returns"}),"\n",(0,i.jsx)(s.p,{children:(0,i.jsx)(s.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(s.code,{children:"Disposable"})})}),"\n",(0,i.jsx)(s.h4,{id:"source-3",children:"Source"}),"\n",(0,i.jsx)(s.p,{children:(0,i.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L80",children:"packages/extension-api/src/extension-api.d.ts:80"})}),"\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.strong,{children:(0,i.jsx)(s.code,{children:"static"})})," ",(0,i.jsx)(s.strong,{children:"from"}),"(...",(0,i.jsx)(s.code,{children:"disposableLikes"}),"): ",(0,i.jsx)(s.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(s.code,{children:"Disposable"})})]}),"\n"]}),"\n",(0,i.jsx)(s.p,{children:"Combine many disposable-likes into one. Use this method\nwhen having objects with a dispose function which are not\ninstances of Disposable."}),"\n",(0,i.jsx)(s.h4,{id:"parameters-3",children:"Parameters"}),"\n",(0,i.jsxs)(s.p,{children:["\u2022 ...",(0,i.jsx)(s.strong,{children:"disposableLikes"}),": ",(0,i.jsx)(s.code,{children:"object"}),"[]"]}),"\n",(0,i.jsxs)(s.p,{children:["Objects that have at least a ",(0,i.jsx)(s.code,{children:"dispose"}),"-function member."]}),"\n",(0,i.jsx)(s.h4,{id:"returns-4",children:"Returns"}),"\n",(0,i.jsx)(s.p,{children:(0,i.jsx)(s.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(s.code,{children:"Disposable"})})}),"\n",(0,i.jsx)(s.p,{children:"Returns a new disposable which, upon dispose, will\ndispose all provided disposables."}),"\n",(0,i.jsx)(s.h4,{id:"source-4",children:"Source"}),"\n",(0,i.jsx)(s.p,{children:(0,i.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L92",children:"packages/extension-api/src/extension-api.d.ts:92"})})]})}function h(e={}){const{wrapper:s}={...(0,r.a)(),...e.components};return s?(0,i.jsx)(s,{...e,children:(0,i.jsx)(t,{...e})}):t(e)}},71670:(e,s,n)=>{n.d(s,{Z:()=>a,a:()=>l});var i=n(27378);const r={},c=i.createContext(r);function l(e){const s=i.useContext(c);return i.useMemo((function(){return"function"==typeof e?e(s):{...s,...e}}),[s,e])}function a(e){let s;return s=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:l(e.components),i.createElement(c.Provider,{value:s},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[54373],{28838:(e,s,n)=>{n.r(s),n.d(s,{assets:()=>o,contentTitle:()=>c,default:()=>h,frontMatter:()=>l,metadata:()=>d,toc:()=>a});var i=n(24246),r=n(71670);const l={},c="Class: Disposable",d={id:"classes/Disposable",title:"Class: Disposable",description:"Extended by",source:"@site/api/classes/Disposable.md",sourceDirName:"classes",slug:"/classes/Disposable",permalink:"/api/classes/Disposable",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Class: CancellationTokenSource",permalink:"/api/classes/CancellationTokenSource"},next:{title:"Class: EventEmitter\\",permalink:"/api/classes/EventEmitter"}},o={},a=[{value:"Extended by",id:"extended-by",level:2},{value:"Constructors",id:"constructors",level:2},{value:"new Disposable(func)",id:"new-disposablefunc",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Source",id:"source",level:4},{value:"new Disposable(callOnDispose)",id:"new-disposablecallondispose",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Source",id:"source-1",level:4},{value:"Methods",id:"methods",level:2},{value:"dispose()",id:"dispose",level:3},{value:"Returns",id:"returns-2",level:4},{value:"Source",id:"source-2",level:4},{value:"create()",id:"create",level:3},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-3",level:4},{value:"Source",id:"source-3",level:4},{value:"from()",id:"from",level:3},{value:"Parameters",id:"parameters-3",level:4},{value:"Returns",id:"returns-4",level:4},{value:"Source",id:"source-4",level:4}];function t(e){const s={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",li:"li",p:"p",strong:"strong",ul:"ul",...(0,r.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(s.h1,{id:"class-disposable",children:"Class: Disposable"}),"\n",(0,i.jsx)(s.h2,{id:"extended-by",children:"Extended by"}),"\n",(0,i.jsxs)(s.ul,{children:["\n",(0,i.jsx)(s.li,{children:(0,i.jsx)(s.a,{href:"/api/interfaces/FileSystemWatcher",children:(0,i.jsx)(s.code,{children:"FileSystemWatcher"})})}),"\n",(0,i.jsx)(s.li,{children:(0,i.jsx)(s.a,{href:"/api/interfaces/CliTool",children:(0,i.jsx)(s.code,{children:"CliTool"})})}),"\n"]}),"\n",(0,i.jsx)(s.h2,{id:"constructors",children:"Constructors"}),"\n",(0,i.jsx)(s.h3,{id:"new-disposablefunc",children:"new Disposable(func)"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"new Disposable"}),"(",(0,i.jsx)(s.code,{children:"func"}),"): ",(0,i.jsx)(s.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(s.code,{children:"Disposable"})})]}),"\n"]}),"\n",(0,i.jsx)(s.h4,{id:"parameters",children:"Parameters"}),"\n",(0,i.jsxs)(s.p,{children:["\u2022 ",(0,i.jsx)(s.strong,{children:"func"})]}),"\n",(0,i.jsx)(s.h4,{id:"returns",children:"Returns"}),"\n",(0,i.jsx)(s.p,{children:(0,i.jsx)(s.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(s.code,{children:"Disposable"})})}),"\n",(0,i.jsx)(s.h4,{id:"source",children:"Source"}),"\n",(0,i.jsx)(s.p,{children:(0,i.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L66",children:"packages/extension-api/src/extension-api.d.ts:66"})}),"\n",(0,i.jsx)(s.h3,{id:"new-disposablecallondispose",children:"new Disposable(callOnDispose)"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"new Disposable"}),"(",(0,i.jsx)(s.code,{children:"callOnDispose"}),"): ",(0,i.jsx)(s.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(s.code,{children:"Disposable"})})]}),"\n"]}),"\n",(0,i.jsx)(s.p,{children:"Creates a new Disposable calling the provided function\non dispose."}),"\n",(0,i.jsx)(s.h4,{id:"parameters-1",children:"Parameters"}),"\n",(0,i.jsxs)(s.p,{children:["\u2022 ",(0,i.jsx)(s.strong,{children:"callOnDispose"}),": ",(0,i.jsx)(s.code,{children:"Function"})]}),"\n",(0,i.jsx)(s.p,{children:"Function that disposes something."}),"\n",(0,i.jsx)(s.h4,{id:"returns-1",children:"Returns"}),"\n",(0,i.jsx)(s.p,{children:(0,i.jsx)(s.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(s.code,{children:"Disposable"})})}),"\n",(0,i.jsx)(s.h4,{id:"source-1",children:"Source"}),"\n",(0,i.jsx)(s.p,{children:(0,i.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L73",children:"packages/extension-api/src/extension-api.d.ts:73"})}),"\n",(0,i.jsx)(s.h2,{id:"methods",children:"Methods"}),"\n",(0,i.jsx)(s.h3,{id:"dispose",children:"dispose()"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"dispose"}),"(): ",(0,i.jsx)(s.code,{children:"void"})]}),"\n"]}),"\n",(0,i.jsx)(s.p,{children:"Dispose this object."}),"\n",(0,i.jsx)(s.h4,{id:"returns-2",children:"Returns"}),"\n",(0,i.jsx)(s.p,{children:(0,i.jsx)(s.code,{children:"void"})}),"\n",(0,i.jsx)(s.h4,{id:"source-2",children:"Source"}),"\n",(0,i.jsx)(s.p,{children:(0,i.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L78",children:"packages/extension-api/src/extension-api.d.ts:78"})}),"\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.strong,{children:(0,i.jsx)(s.code,{children:"static"})})," ",(0,i.jsx)(s.strong,{children:"create"}),"(",(0,i.jsx)(s.code,{children:"func"}),"): ",(0,i.jsx)(s.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(s.code,{children:"Disposable"})})]}),"\n"]}),"\n",(0,i.jsx)(s.h4,{id:"parameters-2",children:"Parameters"}),"\n",(0,i.jsxs)(s.p,{children:["\u2022 ",(0,i.jsx)(s.strong,{children:"func"})]}),"\n",(0,i.jsx)(s.h4,{id:"returns-3",children:"Returns"}),"\n",(0,i.jsx)(s.p,{children:(0,i.jsx)(s.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(s.code,{children:"Disposable"})})}),"\n",(0,i.jsx)(s.h4,{id:"source-3",children:"Source"}),"\n",(0,i.jsx)(s.p,{children:(0,i.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L80",children:"packages/extension-api/src/extension-api.d.ts:80"})}),"\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.strong,{children:(0,i.jsx)(s.code,{children:"static"})})," ",(0,i.jsx)(s.strong,{children:"from"}),"(...",(0,i.jsx)(s.code,{children:"disposableLikes"}),"): ",(0,i.jsx)(s.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(s.code,{children:"Disposable"})})]}),"\n"]}),"\n",(0,i.jsx)(s.p,{children:"Combine many disposable-likes into one. Use this method\nwhen having objects with a dispose function which are not\ninstances of Disposable."}),"\n",(0,i.jsx)(s.h4,{id:"parameters-3",children:"Parameters"}),"\n",(0,i.jsxs)(s.p,{children:["\u2022 ...",(0,i.jsx)(s.strong,{children:"disposableLikes"}),": ",(0,i.jsx)(s.code,{children:"object"}),"[]"]}),"\n",(0,i.jsxs)(s.p,{children:["Objects that have at least a ",(0,i.jsx)(s.code,{children:"dispose"}),"-function member."]}),"\n",(0,i.jsx)(s.h4,{id:"returns-4",children:"Returns"}),"\n",(0,i.jsx)(s.p,{children:(0,i.jsx)(s.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(s.code,{children:"Disposable"})})}),"\n",(0,i.jsx)(s.p,{children:"Returns a new disposable which, upon dispose, will\ndispose all provided disposables."}),"\n",(0,i.jsx)(s.h4,{id:"source-4",children:"Source"}),"\n",(0,i.jsx)(s.p,{children:(0,i.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L92",children:"packages/extension-api/src/extension-api.d.ts:92"})})]})}function h(e={}){const{wrapper:s}={...(0,r.a)(),...e.components};return s?(0,i.jsx)(s,{...e,children:(0,i.jsx)(t,{...e})}):t(e)}},71670:(e,s,n)=>{n.d(s,{Z:()=>d,a:()=>c});var i=n(27378);const r={},l=i.createContext(r);function c(e){const s=i.useContext(l);return i.useMemo((function(){return"function"==typeof e?e(s):{...s,...e}}),[s,e])}function d(e){let s;return s=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:c(e.components),i.createElement(l.Provider,{value:s},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/b51a9aee.dd9df57b.js b/assets/js/b51a9aee.7b963828.js similarity index 97% rename from assets/js/b51a9aee.dd9df57b.js rename to assets/js/b51a9aee.7b963828.js index 9503449d4c3..b62ed615241 100644 --- a/assets/js/b51a9aee.dd9df57b.js +++ b/assets/js/b51a9aee.7b963828.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[39620],{64690:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>r,contentTitle:()=>a,default:()=>d,frontMatter:()=>s,metadata:()=>c,toc:()=>u});var o=t(24246),i=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:"Function: navigateToVolume()",permalink:"/api/namespaces/navigation/functions/navigateToVolume"},next:{title:"Function: navigateToWebview()",permalink:"/api/namespaces/navigation/functions/navigateToWebview"}},r={},u=[{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,i.a)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(n.h1,{id:"function-navigatetovolumes",children:"Function: navigateToVolumes()"}),"\n",(0,o.jsxs)(n.blockquote,{children:["\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.strong,{children:"navigateToVolumes"}),"(): ",(0,o.jsx)(n.code,{children:"Promise"}),"< ",(0,o.jsx)(n.code,{children:"void"})," >"]}),"\n"]}),"\n",(0,o.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.code,{children:"Promise"}),"< ",(0,o.jsx)(n.code,{children:"void"})," >"]}),"\n",(0,o.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,o.jsx)(n.p,{children:(0,o.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L4158",children:"packages/extension-api/src/extension-api.d.ts:4158"})})]})}function d(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,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 +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[39620],{64690:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>r,contentTitle:()=>a,default:()=>d,frontMatter:()=>s,metadata:()=>c,toc:()=>u});var o=t(24246),i=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:"Function: navigateToVolume()",permalink:"/api/namespaces/navigation/functions/navigateToVolume"},next:{title:"Function: navigateToWebview()",permalink:"/api/namespaces/navigation/functions/navigateToWebview"}},r={},u=[{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,i.a)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(n.h1,{id:"function-navigatetovolumes",children:"Function: navigateToVolumes()"}),"\n",(0,o.jsxs)(n.blockquote,{children:["\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.strong,{children:"navigateToVolumes"}),"(): ",(0,o.jsx)(n.code,{children:"Promise"}),"< ",(0,o.jsx)(n.code,{children:"void"})," >"]}),"\n"]}),"\n",(0,o.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.code,{children:"Promise"}),"< ",(0,o.jsx)(n.code,{children:"void"})," >"]}),"\n",(0,o.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,o.jsx)(n.p,{children:(0,o.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L4158",children:"packages/extension-api/src/extension-api.d.ts:4158"})})]})}function d(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,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/b52d840d.03dd79ad.js b/assets/js/b52d840d.ffd1d330.js similarity index 86% rename from assets/js/b52d840d.03dd79ad.js rename to assets/js/b52d840d.ffd1d330.js index 8a12b66dbe3..990d8300f40 100644 --- a/assets/js/b52d840d.03dd79ad.js +++ b/assets/js/b52d840d.ffd1d330.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[35584],{50816:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>d,contentTitle:()=>o,default:()=>h,frontMatter:()=>r,metadata:()=>t,toc:()=>a});var i=s(24246),c=s(71670);const r={},o="Interface: VolumeInfo",t={id:"interfaces/VolumeInfo",title:"Interface: VolumeInfo",description:"Properties",source:"@site/api/interfaces/VolumeInfo.md",sourceDirName:"interfaces",slug:"/interfaces/VolumeInfo",permalink:"/api/interfaces/VolumeInfo",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: VolumeDeleteOptions",permalink:"/api/interfaces/VolumeDeleteOptions"},next:{title:"Interface: VolumeListInfo",permalink:"/api/interfaces/VolumeListInfo"}},d={},a=[{value:"Properties",id:"properties",level:2},{value:"CreatedAt",id:"createdat",level:3},{value:"Source",id:"source",level:4},{value:"Driver",id:"driver",level:3},{value:"Source",id:"source-1",level:4},{value:"Labels",id:"labels",level:3},{value:"Index signature",id:"index-signature",level:4},{value:"Source",id:"source-2",level:4},{value:"Mountpoint",id:"mountpoint",level:3},{value:"Source",id:"source-3",level:4},{value:"Name",id:"name",level:3},{value:"Source",id:"source-4",level:4},{value:"Options?",id:"options",level:3},{value:"Source",id:"source-5",level:4},{value:"Scope",id:"scope",level:3},{value:"Source",id:"source-6",level:4},{value:"Status?",id:"status",level:3},{value:"Index signature",id:"index-signature-1",level:4},{value:"Source",id:"source-7",level:4},{value:"UsageData?",id:"usagedata",level:3},{value:"Source",id:"source-8",level:4},{value:"containersUsage",id:"containersusage",level:3},{value:"Source",id:"source-9",level:4},{value:"engineId",id:"engineid",level:3},{value:"Source",id:"source-10",level:4},{value:"engineName",id:"enginename",level:3},{value:"Source",id:"source-11",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,c.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"interface-volumeinfo",children:"Interface: VolumeInfo"}),"\n",(0,i.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(n.h3,{id:"createdat",children:"CreatedAt"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"CreatedAt"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L3098",children:"packages/extension-api/src/extension-api.d.ts:3098"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"driver",children:"Driver"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Driver"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L3101",children:"packages/extension-api/src/extension-api.d.ts:3101"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"labels",children:"Labels"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Labels"}),": ",(0,i.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"index-signature",children:"Index signature"}),"\n",(0,i.jsxs)(n.p,{children:["[",(0,i.jsx)(n.code,{children:"key"}),": ",(0,i.jsx)(n.code,{children:"string"}),"]: ",(0,i.jsx)(n.code,{children:"string"})]}),"\n",(0,i.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L3104",children:"packages/extension-api/src/extension-api.d.ts:3104"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"mountpoint",children:"Mountpoint"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Mountpoint"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L3102",children:"packages/extension-api/src/extension-api.d.ts:3102"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"name",children:"Name"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Name"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-4",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L3100",children:"packages/extension-api/src/extension-api.d.ts:3100"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"options",children:"Options?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"Options"}),": ",(0,i.jsx)(n.code,{children:"null"})," | ",(0,i.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-5",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L3106",children:"packages/extension-api/src/extension-api.d.ts:3106"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"scope",children:"Scope"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Scope"}),": ",(0,i.jsx)(n.code,{children:'"global"'})," | ",(0,i.jsx)(n.code,{children:'"local"'})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-6",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L3105",children:"packages/extension-api/src/extension-api.d.ts:3105"})}),"\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:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"Status"}),": ",(0,i.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"index-signature-1",children:"Index signature"}),"\n",(0,i.jsxs)(n.p,{children:["[",(0,i.jsx)(n.code,{children:"key"}),": ",(0,i.jsx)(n.code,{children:"string"}),"]: ",(0,i.jsx)(n.code,{children:"string"})]}),"\n",(0,i.jsx)(n.h4,{id:"source-7",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L3103",children:"packages/extension-api/src/extension-api.d.ts:3103"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"usagedata",children:"UsageData?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"UsageData"}),": ",(0,i.jsx)(n.code,{children:"null"})," | ",(0,i.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-8",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L3107",children:"packages/extension-api/src/extension-api.d.ts:3107"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"containersusage",children:"containersUsage"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"containersUsage"}),": ",(0,i.jsx)(n.code,{children:"object"}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-9",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L3099",children:"packages/extension-api/src/extension-api.d.ts:3099"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"engineid",children:"engineId"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"engineId"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-10",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L3096",children:"packages/extension-api/src/extension-api.d.ts:3096"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"enginename",children:"engineName"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"engineName"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-11",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L3097",children:"packages/extension-api/src/extension-api.d.ts:3097"})})]})}function h(e={}){const{wrapper:n}={...(0,c.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>t,a:()=>o});var i=s(27378);const c={},r=i.createContext(c);function o(e){const n=i.useContext(r);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function t(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(c):e.components||c:o(e.components),i.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[35584],{50816:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>d,contentTitle:()=>o,default:()=>h,frontMatter:()=>r,metadata:()=>t,toc:()=>l});var i=s(24246),c=s(71670);const r={},o="Interface: VolumeInfo",t={id:"interfaces/VolumeInfo",title:"Interface: VolumeInfo",description:"Properties",source:"@site/api/interfaces/VolumeInfo.md",sourceDirName:"interfaces",slug:"/interfaces/VolumeInfo",permalink:"/api/interfaces/VolumeInfo",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: VolumeDeleteOptions",permalink:"/api/interfaces/VolumeDeleteOptions"},next:{title:"Interface: VolumeListInfo",permalink:"/api/interfaces/VolumeListInfo"}},d={},l=[{value:"Properties",id:"properties",level:2},{value:"CreatedAt",id:"createdat",level:3},{value:"Source",id:"source",level:4},{value:"Driver",id:"driver",level:3},{value:"Source",id:"source-1",level:4},{value:"Labels",id:"labels",level:3},{value:"Index signature",id:"index-signature",level:4},{value:"Source",id:"source-2",level:4},{value:"Mountpoint",id:"mountpoint",level:3},{value:"Source",id:"source-3",level:4},{value:"Name",id:"name",level:3},{value:"Source",id:"source-4",level:4},{value:"Options?",id:"options",level:3},{value:"Source",id:"source-5",level:4},{value:"Scope",id:"scope",level:3},{value:"Source",id:"source-6",level:4},{value:"Status?",id:"status",level:3},{value:"Index signature",id:"index-signature-1",level:4},{value:"Source",id:"source-7",level:4},{value:"UsageData?",id:"usagedata",level:3},{value:"Source",id:"source-8",level:4},{value:"containersUsage",id:"containersusage",level:3},{value:"Source",id:"source-9",level:4},{value:"engineId",id:"engineid",level:3},{value:"Source",id:"source-10",level:4},{value:"engineName",id:"enginename",level:3},{value:"Source",id:"source-11",level:4}];function a(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,c.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"interface-volumeinfo",children:"Interface: VolumeInfo"}),"\n",(0,i.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(n.h3,{id:"createdat",children:"CreatedAt"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"CreatedAt"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L3098",children:"packages/extension-api/src/extension-api.d.ts:3098"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"driver",children:"Driver"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Driver"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L3101",children:"packages/extension-api/src/extension-api.d.ts:3101"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"labels",children:"Labels"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Labels"}),": ",(0,i.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"index-signature",children:"Index signature"}),"\n",(0,i.jsxs)(n.p,{children:["[",(0,i.jsx)(n.code,{children:"key"}),": ",(0,i.jsx)(n.code,{children:"string"}),"]: ",(0,i.jsx)(n.code,{children:"string"})]}),"\n",(0,i.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L3104",children:"packages/extension-api/src/extension-api.d.ts:3104"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"mountpoint",children:"Mountpoint"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Mountpoint"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L3102",children:"packages/extension-api/src/extension-api.d.ts:3102"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"name",children:"Name"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Name"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-4",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L3100",children:"packages/extension-api/src/extension-api.d.ts:3100"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"options",children:"Options?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"Options"}),": ",(0,i.jsx)(n.code,{children:"null"})," | ",(0,i.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-5",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L3106",children:"packages/extension-api/src/extension-api.d.ts:3106"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"scope",children:"Scope"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Scope"}),": ",(0,i.jsx)(n.code,{children:'"global"'})," | ",(0,i.jsx)(n.code,{children:'"local"'})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-6",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L3105",children:"packages/extension-api/src/extension-api.d.ts:3105"})}),"\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:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"Status"}),": ",(0,i.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"index-signature-1",children:"Index signature"}),"\n",(0,i.jsxs)(n.p,{children:["[",(0,i.jsx)(n.code,{children:"key"}),": ",(0,i.jsx)(n.code,{children:"string"}),"]: ",(0,i.jsx)(n.code,{children:"string"})]}),"\n",(0,i.jsx)(n.h4,{id:"source-7",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L3103",children:"packages/extension-api/src/extension-api.d.ts:3103"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"usagedata",children:"UsageData?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"UsageData"}),": ",(0,i.jsx)(n.code,{children:"null"})," | ",(0,i.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-8",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L3107",children:"packages/extension-api/src/extension-api.d.ts:3107"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"containersusage",children:"containersUsage"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"containersUsage"}),": ",(0,i.jsx)(n.code,{children:"object"}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-9",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L3099",children:"packages/extension-api/src/extension-api.d.ts:3099"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"engineid",children:"engineId"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"engineId"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-10",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L3096",children:"packages/extension-api/src/extension-api.d.ts:3096"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"enginename",children:"engineName"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"engineName"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-11",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L3097",children:"packages/extension-api/src/extension-api.d.ts:3097"})})]})}function h(e={}){const{wrapper:n}={...(0,c.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(a,{...e})}):a(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>t,a:()=>o});var i=s(27378);const c={},r=i.createContext(c);function o(e){const n=i.useContext(r);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function t(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(c):e.components||c:o(e.components),i.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/b5b19789.9576f489.js b/assets/js/b5b19789.b8bf6475.js similarity index 97% rename from assets/js/b5b19789.9576f489.js rename to assets/js/b5b19789.b8bf6475.js index 78d02424bc9..1bbede80d39 100644 --- a/assets/js/b5b19789.9576f489.js +++ b/assets/js/b5b19789.b8bf6475.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[80355],{92300:(t,e,n)=>{n.r(e),n.d(e,{assets:()=>c,contentTitle:()=>s,default:()=>d,frontMatter:()=>r,metadata:()=>o,toc:()=>l});var a=n(24246),i=n(71670);const r={},s="Variable: StatusBarAlignRight",o={id:"variables/StatusBarAlignRight",title:"Variable: StatusBarAlignRight",description:"const StatusBarAlignRight: \"RIGHT\" = 'RIGHT'",source:"@site/api/variables/StatusBarAlignRight.md",sourceDirName:"variables",slug:"/variables/StatusBarAlignRight",permalink:"/api/variables/StatusBarAlignRight",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Variable: StatusBarAlignLeft",permalink:"/api/variables/StatusBarAlignLeft"},next:{title:"Variable: StatusBarItemDefaultPriority",permalink:"/api/variables/StatusBarItemDefaultPriority"}},c={},l=[{value:"Source",id:"source",level:2}];function u(t){const e={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,i.a)(),...t.components};return(0,a.jsxs)(a.Fragment,{children:[(0,a.jsx)(e.h1,{id:"variable-statusbaralignright",children:"Variable: StatusBarAlignRight"}),"\n",(0,a.jsxs)(e.blockquote,{children:["\n",(0,a.jsxs)(e.p,{children:[(0,a.jsx)(e.strong,{children:(0,a.jsx)(e.code,{children:"const"})})," ",(0,a.jsx)(e.strong,{children:"StatusBarAlignRight"}),": ",(0,a.jsx)(e.code,{children:'"RIGHT"'})," = ",(0,a.jsx)(e.code,{children:"'RIGHT'"})]}),"\n"]}),"\n",(0,a.jsx)(e.p,{children:"Aligned to the right side."}),"\n",(0,a.jsx)(e.h2,{id:"source",children:"Source"}),"\n",(0,a.jsx)(e.p,{children:(0,a.jsx)(e.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L1186",children:"packages/extension-api/src/extension-api.d.ts:1186"})})]})}function d(t={}){const{wrapper:e}={...(0,i.a)(),...t.components};return e?(0,a.jsx)(e,{...t,children:(0,a.jsx)(u,{...t})}):u(t)}},71670:(t,e,n)=>{n.d(e,{Z:()=>o,a:()=>s});var a=n(27378);const i={},r=a.createContext(i);function s(t){const e=a.useContext(r);return a.useMemo((function(){return"function"==typeof t?t(e):{...e,...t}}),[e,t])}function o(t){let e;return e=t.disableParentContext?"function"==typeof t.components?t.components(i):t.components||i:s(t.components),a.createElement(r.Provider,{value:e},t.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[80355],{92300:(t,e,n)=>{n.r(e),n.d(e,{assets:()=>c,contentTitle:()=>s,default:()=>d,frontMatter:()=>r,metadata:()=>o,toc:()=>l});var a=n(24246),i=n(71670);const r={},s="Variable: StatusBarAlignRight",o={id:"variables/StatusBarAlignRight",title:"Variable: StatusBarAlignRight",description:"const StatusBarAlignRight: \"RIGHT\" = 'RIGHT'",source:"@site/api/variables/StatusBarAlignRight.md",sourceDirName:"variables",slug:"/variables/StatusBarAlignRight",permalink:"/api/variables/StatusBarAlignRight",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Variable: StatusBarAlignLeft",permalink:"/api/variables/StatusBarAlignLeft"},next:{title:"Variable: StatusBarItemDefaultPriority",permalink:"/api/variables/StatusBarItemDefaultPriority"}},c={},l=[{value:"Source",id:"source",level:2}];function u(t){const e={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,i.a)(),...t.components};return(0,a.jsxs)(a.Fragment,{children:[(0,a.jsx)(e.h1,{id:"variable-statusbaralignright",children:"Variable: StatusBarAlignRight"}),"\n",(0,a.jsxs)(e.blockquote,{children:["\n",(0,a.jsxs)(e.p,{children:[(0,a.jsx)(e.strong,{children:(0,a.jsx)(e.code,{children:"const"})})," ",(0,a.jsx)(e.strong,{children:"StatusBarAlignRight"}),": ",(0,a.jsx)(e.code,{children:'"RIGHT"'})," = ",(0,a.jsx)(e.code,{children:"'RIGHT'"})]}),"\n"]}),"\n",(0,a.jsx)(e.p,{children:"Aligned to the right side."}),"\n",(0,a.jsx)(e.h2,{id:"source",children:"Source"}),"\n",(0,a.jsx)(e.p,{children:(0,a.jsx)(e.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L1186",children:"packages/extension-api/src/extension-api.d.ts:1186"})})]})}function d(t={}){const{wrapper:e}={...(0,i.a)(),...t.components};return e?(0,a.jsx)(e,{...t,children:(0,a.jsx)(u,{...t})}):u(t)}},71670:(t,e,n)=>{n.d(e,{Z:()=>o,a:()=>s});var a=n(27378);const i={},r=a.createContext(i);function s(t){const e=a.useContext(r);return a.useMemo((function(){return"function"==typeof t?t(e):{...e,...t}}),[e,t])}function o(t){let e;return e=t.disableParentContext?"function"==typeof t.components?t.components(i):t.components||i:s(t.components),a.createElement(r.Provider,{value:e},t.children)}}}]); \ No newline at end of file diff --git a/assets/js/b5ec5208.688bc9df.js b/assets/js/b5ec5208.0849894e.js similarity index 96% rename from assets/js/b5ec5208.688bc9df.js rename to assets/js/b5ec5208.0849894e.js index c45e3618103..63fef1d7318 100644 --- a/assets/js/b5ec5208.688bc9df.js +++ b/assets/js/b5ec5208.0849894e.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[92514],{53753:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>d,contentTitle:()=>o,default:()=>p,frontMatter:()=>t,metadata:()=>c,toc:()=>a});var i=s(24246),r=s(71670);const t={},o="Function: onDidUpdateProvider()",c={id:"namespaces/provider/functions/onDidUpdateProvider",title:"Function: onDidUpdateProvider()",description:"onDidUpdateProvider(listener, thisArgs?, disposables?): Disposable",source:"@site/api/namespaces/provider/functions/onDidUpdateProvider.md",sourceDirName:"namespaces/provider/functions",slug:"/namespaces/provider/functions/onDidUpdateProvider",permalink:"/api/namespaces/provider/functions/onDidUpdateProvider",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Function: onDidUpdateKubernetesConnection()",permalink:"/api/namespaces/provider/functions/onDidUpdateKubernetesConnection"},next:{title:"Namespace: proxy",permalink:"/api/namespaces/proxy/"}},d={},a=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,r.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"function-ondidupdateprovider",children:"Function: onDidUpdateProvider()"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"onDidUpdateProvider"}),"(",(0,i.jsx)(n.code,{children:"listener"}),", ",(0,i.jsx)(n.code,{children:"thisArgs"}),"?, ",(0,i.jsx)(n.code,{children:"disposables"}),"?): ",(0,i.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(n.code,{children:"Disposable"})})]}),"\n"]}),"\n",(0,i.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"listener"})]}),"\n",(0,i.jsx)(n.p,{children:"The listener function will be called when the event happens."}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"thisArgs?"}),": ",(0,i.jsx)(n.code,{children:"any"})]}),"\n",(0,i.jsxs)(n.p,{children:["The ",(0,i.jsx)(n.code,{children:"this"}),"-argument which will be used when calling the event listener."]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"disposables?"}),": ",(0,i.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(n.code,{children:"Disposable"})}),"[]"]}),"\n",(0,i.jsxs)(n.p,{children:["An array to which a ",(0,i.jsx)(n.a,{href:"/api/classes/Disposable",children:"Disposable"})," will be added."]}),"\n",(0,i.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(n.code,{children:"Disposable"})})}),"\n",(0,i.jsx)(n.p,{children:"A disposable which unsubscribes the event listener."}),"\n",(0,i.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L546",children:"packages/extension-api/src/extension-api.d.ts:546"})})]})}function p(e={}){const{wrapper:n}={...(0,r.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>c,a:()=>o});var i=s(27378);const r={},t=i.createContext(r);function o(e){const n=i.useContext(t);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:o(e.components),i.createElement(t.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[92514],{53753:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>d,contentTitle:()=>o,default:()=>p,frontMatter:()=>t,metadata:()=>c,toc:()=>a});var i=s(24246),r=s(71670);const t={},o="Function: onDidUpdateProvider()",c={id:"namespaces/provider/functions/onDidUpdateProvider",title:"Function: onDidUpdateProvider()",description:"onDidUpdateProvider(listener, thisArgs?, disposables?): Disposable",source:"@site/api/namespaces/provider/functions/onDidUpdateProvider.md",sourceDirName:"namespaces/provider/functions",slug:"/namespaces/provider/functions/onDidUpdateProvider",permalink:"/api/namespaces/provider/functions/onDidUpdateProvider",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Function: onDidUpdateKubernetesConnection()",permalink:"/api/namespaces/provider/functions/onDidUpdateKubernetesConnection"},next:{title:"Namespace: proxy",permalink:"/api/namespaces/proxy/"}},d={},a=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,r.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"function-ondidupdateprovider",children:"Function: onDidUpdateProvider()"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"onDidUpdateProvider"}),"(",(0,i.jsx)(n.code,{children:"listener"}),", ",(0,i.jsx)(n.code,{children:"thisArgs"}),"?, ",(0,i.jsx)(n.code,{children:"disposables"}),"?): ",(0,i.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(n.code,{children:"Disposable"})})]}),"\n"]}),"\n",(0,i.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"listener"})]}),"\n",(0,i.jsx)(n.p,{children:"The listener function will be called when the event happens."}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"thisArgs?"}),": ",(0,i.jsx)(n.code,{children:"any"})]}),"\n",(0,i.jsxs)(n.p,{children:["The ",(0,i.jsx)(n.code,{children:"this"}),"-argument which will be used when calling the event listener."]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"disposables?"}),": ",(0,i.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(n.code,{children:"Disposable"})}),"[]"]}),"\n",(0,i.jsxs)(n.p,{children:["An array to which a ",(0,i.jsx)(n.a,{href:"/api/classes/Disposable",children:"Disposable"})," will be added."]}),"\n",(0,i.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(n.code,{children:"Disposable"})})}),"\n",(0,i.jsx)(n.p,{children:"A disposable which unsubscribes the event listener."}),"\n",(0,i.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L546",children:"packages/extension-api/src/extension-api.d.ts:546"})})]})}function p(e={}){const{wrapper:n}={...(0,r.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>c,a:()=>o});var i=s(27378);const r={},t=i.createContext(r);function o(e){const n=i.useContext(t);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:o(e.components),i.createElement(t.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/b66ca8cf.b3e72ec0.js b/assets/js/b66ca8cf.50cd9fa9.js similarity index 96% rename from assets/js/b66ca8cf.b3e72ec0.js rename to assets/js/b66ca8cf.50cd9fa9.js index 2fcfc36b4eb..47efe4e6439 100644 --- a/assets/js/b66ca8cf.b3e72ec0.js +++ b/assets/js/b66ca8cf.50cd9fa9.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[42205],{35161:(e,s,n)=>{n.r(s),n.d(s,{assets:()=>a,contentTitle:()=>c,default:()=>p,frontMatter:()=>t,metadata:()=>o,toc:()=>d});var i=n(24246),r=n(71670);const t={},c="Function: onDidUnregisterRegistry()",o={id:"namespaces/registry/functions/onDidUnregisterRegistry",title:"Function: onDidUnregisterRegistry()",description:"onDidUnregisterRegistry(listener, thisArgs?, disposables?): Disposable",source:"@site/api/namespaces/registry/functions/onDidUnregisterRegistry.md",sourceDirName:"namespaces/registry/functions",slug:"/namespaces/registry/functions/onDidUnregisterRegistry",permalink:"/api/namespaces/registry/functions/onDidUnregisterRegistry",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Function: onDidRegisterRegistry()",permalink:"/api/namespaces/registry/functions/onDidRegisterRegistry"},next:{title:"Function: onDidUpdateRegistry()",permalink:"/api/namespaces/registry/functions/onDidUpdateRegistry"}},a={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function l(e){const s={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,r.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(s.h1,{id:"function-ondidunregisterregistry",children:"Function: onDidUnregisterRegistry()"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"onDidUnregisterRegistry"}),"(",(0,i.jsx)(s.code,{children:"listener"}),", ",(0,i.jsx)(s.code,{children:"thisArgs"}),"?, ",(0,i.jsx)(s.code,{children:"disposables"}),"?): ",(0,i.jsx)(s.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(s.code,{children:"Disposable"})})]}),"\n"]}),"\n",(0,i.jsx)(s.h2,{id:"parameters",children:"Parameters"}),"\n",(0,i.jsxs)(s.p,{children:["\u2022 ",(0,i.jsx)(s.strong,{children:"listener"})]}),"\n",(0,i.jsx)(s.p,{children:"The listener function will be called when the event happens."}),"\n",(0,i.jsxs)(s.p,{children:["\u2022 ",(0,i.jsx)(s.strong,{children:"thisArgs?"}),": ",(0,i.jsx)(s.code,{children:"any"})]}),"\n",(0,i.jsxs)(s.p,{children:["The ",(0,i.jsx)(s.code,{children:"this"}),"-argument which will be used when calling the event listener."]}),"\n",(0,i.jsxs)(s.p,{children:["\u2022 ",(0,i.jsx)(s.strong,{children:"disposables?"}),": ",(0,i.jsx)(s.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(s.code,{children:"Disposable"})}),"[]"]}),"\n",(0,i.jsxs)(s.p,{children:["An array to which a ",(0,i.jsx)(s.a,{href:"/api/classes/Disposable",children:"Disposable"})," will be added."]}),"\n",(0,i.jsx)(s.h2,{id:"returns",children:"Returns"}),"\n",(0,i.jsx)(s.p,{children:(0,i.jsx)(s.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(s.code,{children:"Disposable"})})}),"\n",(0,i.jsx)(s.p,{children:"A disposable which unsubscribes the event listener."}),"\n",(0,i.jsx)(s.h2,{id:"source",children:"Source"}),"\n",(0,i.jsx)(s.p,{children:(0,i.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L632",children:"packages/extension-api/src/extension-api.d.ts:632"})})]})}function p(e={}){const{wrapper:s}={...(0,r.a)(),...e.components};return s?(0,i.jsx)(s,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},71670:(e,s,n)=>{n.d(s,{Z:()=>o,a:()=>c});var i=n(27378);const r={},t=i.createContext(r);function c(e){const s=i.useContext(t);return i.useMemo((function(){return"function"==typeof e?e(s):{...s,...e}}),[s,e])}function o(e){let s;return s=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:c(e.components),i.createElement(t.Provider,{value:s},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[42205],{35161:(e,s,n)=>{n.r(s),n.d(s,{assets:()=>a,contentTitle:()=>c,default:()=>p,frontMatter:()=>t,metadata:()=>o,toc:()=>d});var i=n(24246),r=n(71670);const t={},c="Function: onDidUnregisterRegistry()",o={id:"namespaces/registry/functions/onDidUnregisterRegistry",title:"Function: onDidUnregisterRegistry()",description:"onDidUnregisterRegistry(listener, thisArgs?, disposables?): Disposable",source:"@site/api/namespaces/registry/functions/onDidUnregisterRegistry.md",sourceDirName:"namespaces/registry/functions",slug:"/namespaces/registry/functions/onDidUnregisterRegistry",permalink:"/api/namespaces/registry/functions/onDidUnregisterRegistry",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Function: onDidRegisterRegistry()",permalink:"/api/namespaces/registry/functions/onDidRegisterRegistry"},next:{title:"Function: onDidUpdateRegistry()",permalink:"/api/namespaces/registry/functions/onDidUpdateRegistry"}},a={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function l(e){const s={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,r.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(s.h1,{id:"function-ondidunregisterregistry",children:"Function: onDidUnregisterRegistry()"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"onDidUnregisterRegistry"}),"(",(0,i.jsx)(s.code,{children:"listener"}),", ",(0,i.jsx)(s.code,{children:"thisArgs"}),"?, ",(0,i.jsx)(s.code,{children:"disposables"}),"?): ",(0,i.jsx)(s.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(s.code,{children:"Disposable"})})]}),"\n"]}),"\n",(0,i.jsx)(s.h2,{id:"parameters",children:"Parameters"}),"\n",(0,i.jsxs)(s.p,{children:["\u2022 ",(0,i.jsx)(s.strong,{children:"listener"})]}),"\n",(0,i.jsx)(s.p,{children:"The listener function will be called when the event happens."}),"\n",(0,i.jsxs)(s.p,{children:["\u2022 ",(0,i.jsx)(s.strong,{children:"thisArgs?"}),": ",(0,i.jsx)(s.code,{children:"any"})]}),"\n",(0,i.jsxs)(s.p,{children:["The ",(0,i.jsx)(s.code,{children:"this"}),"-argument which will be used when calling the event listener."]}),"\n",(0,i.jsxs)(s.p,{children:["\u2022 ",(0,i.jsx)(s.strong,{children:"disposables?"}),": ",(0,i.jsx)(s.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(s.code,{children:"Disposable"})}),"[]"]}),"\n",(0,i.jsxs)(s.p,{children:["An array to which a ",(0,i.jsx)(s.a,{href:"/api/classes/Disposable",children:"Disposable"})," will be added."]}),"\n",(0,i.jsx)(s.h2,{id:"returns",children:"Returns"}),"\n",(0,i.jsx)(s.p,{children:(0,i.jsx)(s.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(s.code,{children:"Disposable"})})}),"\n",(0,i.jsx)(s.p,{children:"A disposable which unsubscribes the event listener."}),"\n",(0,i.jsx)(s.h2,{id:"source",children:"Source"}),"\n",(0,i.jsx)(s.p,{children:(0,i.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L632",children:"packages/extension-api/src/extension-api.d.ts:632"})})]})}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.3eb4919f.js b/assets/js/b678a236.77357544.js similarity index 98% rename from assets/js/b678a236.3eb4919f.js rename to assets/js/b678a236.77357544.js index 1b6781ec2af..d29ac31a99d 100644 --- a/assets/js/b678a236.3eb4919f.js +++ b/assets/js/b678a236.77357544.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[37245],{28506:(n,e,t)=>{t.r(e),t.d(e,{assets:()=>a,contentTitle:()=>r,default:()=>l,frontMatter:()=>o,metadata:()=>c,toc:()=>d});var i=t(24246),s=t(71670);const o={},r="Function: stopContainer()",c={id:"namespaces/containerEngine/functions/stopContainer",title:"Function: stopContainer()",description:"stopContainer(engineId, id): Promise\\",source:"@site/api/namespaces/containerEngine/functions/stopContainer.md",sourceDirName:"namespaces/containerEngine/functions",slug:"/namespaces/containerEngine/functions/stopContainer",permalink:"/api/namespaces/containerEngine/functions/stopContainer",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Function: statsContainer()",permalink:"/api/namespaces/containerEngine/functions/statsContainer"},next:{title:"Function: stopPod()",permalink:"/api/namespaces/containerEngine/functions/stopPod"}},a={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function p(n){const e={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,s.a)(),...n.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(e.h1,{id:"function-stopcontainer",children:"Function: stopContainer()"}),"\n",(0,i.jsxs)(e.blockquote,{children:["\n",(0,i.jsxs)(e.p,{children:[(0,i.jsx)(e.strong,{children:"stopContainer"}),"(",(0,i.jsx)(e.code,{children:"engineId"}),", ",(0,i.jsx)(e.code,{children:"id"}),"): ",(0,i.jsx)(e.code,{children:"Promise"}),"< ",(0,i.jsx)(e.code,{children:"void"})," >"]}),"\n"]}),"\n",(0,i.jsx)(e.p,{children:"Stop an existing container"}),"\n",(0,i.jsx)(e.h2,{id:"parameters",children:"Parameters"}),"\n",(0,i.jsxs)(e.p,{children:["\u2022 ",(0,i.jsx)(e.strong,{children:"engineId"}),": ",(0,i.jsx)(e.code,{children:"string"})]}),"\n",(0,i.jsxs)(e.p,{children:["the id of the engine managing the container, obtained from the result of ",(0,i.jsx)(e.a,{href:"/api/namespaces/containerEngine/functions/listContainers",children:"containerEngine.listContainers"})]}),"\n",(0,i.jsxs)(e.p,{children:["\u2022 ",(0,i.jsx)(e.strong,{children:"id"}),": ",(0,i.jsx)(e.code,{children:"string"})]}),"\n",(0,i.jsxs)(e.p,{children:["the id of the container on this engine, obtained from the result of ",(0,i.jsx)(e.a,{href:"/api/namespaces/containerEngine/functions/listContainers",children:"containerEngine.listContainers"})," or as the result of ",(0,i.jsx)(e.a,{href:"/api/namespaces/containerEngine/functions/createContainer",children:"containerEngine.createContainer"})]}),"\n",(0,i.jsx)(e.h2,{id:"returns",children:"Returns"}),"\n",(0,i.jsxs)(e.p,{children:[(0,i.jsx)(e.code,{children:"Promise"}),"< ",(0,i.jsx)(e.code,{children:"void"})," >"]}),"\n",(0,i.jsx)(e.h2,{id:"source",children:"Source"}),"\n",(0,i.jsx)(e.p,{children:(0,i.jsx)(e.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L3234",children:"packages/extension-api/src/extension-api.d.ts:3234"})})]})}function l(n={}){const{wrapper:e}={...(0,s.a)(),...n.components};return e?(0,i.jsx)(e,{...n,children:(0,i.jsx)(p,{...n})}):p(n)}},71670:(n,e,t)=>{t.d(e,{Z:()=>c,a:()=>r});var i=t(27378);const s={},o=i.createContext(s);function r(n){const e=i.useContext(o);return i.useMemo((function(){return"function"==typeof n?n(e):{...e,...n}}),[e,n])}function c(n){let e;return e=n.disableParentContext?"function"==typeof n.components?n.components(s):n.components||s:r(n.components),i.createElement(o.Provider,{value:e},n.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[37245],{28506:(n,e,t)=>{t.r(e),t.d(e,{assets:()=>a,contentTitle:()=>r,default:()=>l,frontMatter:()=>o,metadata:()=>c,toc:()=>d});var i=t(24246),s=t(71670);const o={},r="Function: stopContainer()",c={id:"namespaces/containerEngine/functions/stopContainer",title:"Function: stopContainer()",description:"stopContainer(engineId, id): Promise\\",source:"@site/api/namespaces/containerEngine/functions/stopContainer.md",sourceDirName:"namespaces/containerEngine/functions",slug:"/namespaces/containerEngine/functions/stopContainer",permalink:"/api/namespaces/containerEngine/functions/stopContainer",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Function: statsContainer()",permalink:"/api/namespaces/containerEngine/functions/statsContainer"},next:{title:"Function: stopPod()",permalink:"/api/namespaces/containerEngine/functions/stopPod"}},a={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function p(n){const e={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,s.a)(),...n.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(e.h1,{id:"function-stopcontainer",children:"Function: stopContainer()"}),"\n",(0,i.jsxs)(e.blockquote,{children:["\n",(0,i.jsxs)(e.p,{children:[(0,i.jsx)(e.strong,{children:"stopContainer"}),"(",(0,i.jsx)(e.code,{children:"engineId"}),", ",(0,i.jsx)(e.code,{children:"id"}),"): ",(0,i.jsx)(e.code,{children:"Promise"}),"< ",(0,i.jsx)(e.code,{children:"void"})," >"]}),"\n"]}),"\n",(0,i.jsx)(e.p,{children:"Stop an existing container"}),"\n",(0,i.jsx)(e.h2,{id:"parameters",children:"Parameters"}),"\n",(0,i.jsxs)(e.p,{children:["\u2022 ",(0,i.jsx)(e.strong,{children:"engineId"}),": ",(0,i.jsx)(e.code,{children:"string"})]}),"\n",(0,i.jsxs)(e.p,{children:["the id of the engine managing the container, obtained from the result of ",(0,i.jsx)(e.a,{href:"/api/namespaces/containerEngine/functions/listContainers",children:"containerEngine.listContainers"})]}),"\n",(0,i.jsxs)(e.p,{children:["\u2022 ",(0,i.jsx)(e.strong,{children:"id"}),": ",(0,i.jsx)(e.code,{children:"string"})]}),"\n",(0,i.jsxs)(e.p,{children:["the id of the container on this engine, obtained from the result of ",(0,i.jsx)(e.a,{href:"/api/namespaces/containerEngine/functions/listContainers",children:"containerEngine.listContainers"})," or as the result of ",(0,i.jsx)(e.a,{href:"/api/namespaces/containerEngine/functions/createContainer",children:"containerEngine.createContainer"})]}),"\n",(0,i.jsx)(e.h2,{id:"returns",children:"Returns"}),"\n",(0,i.jsxs)(e.p,{children:[(0,i.jsx)(e.code,{children:"Promise"}),"< ",(0,i.jsx)(e.code,{children:"void"})," >"]}),"\n",(0,i.jsx)(e.h2,{id:"source",children:"Source"}),"\n",(0,i.jsx)(e.p,{children:(0,i.jsx)(e.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L3234",children:"packages/extension-api/src/extension-api.d.ts:3234"})})]})}function l(n={}){const{wrapper:e}={...(0,s.a)(),...n.components};return e?(0,i.jsx)(e,{...n,children:(0,i.jsx)(p,{...n})}):p(n)}},71670:(n,e,t)=>{t.d(e,{Z:()=>c,a:()=>r});var i=t(27378);const s={},o=i.createContext(s);function r(n){const e=i.useContext(o);return i.useMemo((function(){return"function"==typeof n?n(e):{...e,...n}}),[e,n])}function c(n){let e;return e=n.disableParentContext?"function"==typeof n.components?n.components(s):n.components||s:r(n.components),i.createElement(o.Provider,{value:e},n.children)}}}]); \ No newline at end of file diff --git a/assets/js/b6be2912.7eef4089.js b/assets/js/b6be2912.768365e5.js similarity index 96% rename from assets/js/b6be2912.7eef4089.js rename to assets/js/b6be2912.768365e5.js index 74ec8400d3f..23c48017fd6 100644 --- a/assets/js/b6be2912.7eef4089.js +++ b/assets/js/b6be2912.768365e5.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[82424],{17869:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>a,contentTitle:()=>r,default:()=>h,frontMatter:()=>o,metadata:()=>c,toc:()=>d});var i=s(24246),t=s(71670);const o={},r="Function: showWarningMessage()",c={id:"namespaces/window/functions/showWarningMessage",title:"Function: showWarningMessage()",description:"showWarningMessage(message, ...items): Promise\\",source:"@site/api/namespaces/window/functions/showWarningMessage.md",sourceDirName:"namespaces/window/functions",slug:"/namespaces/window/functions/showWarningMessage",permalink:"/api/namespaces/window/functions/showWarningMessage",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Function: showSaveDialog()",permalink:"/api/namespaces/window/functions/showSaveDialog"},next:{title:"Function: withProgress()",permalink:"/api/namespaces/window/functions/withProgress"}},a={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,t.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"function-showwarningmessage",children:"Function: showWarningMessage()"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"showWarningMessage"}),"(",(0,i.jsx)(n.code,{children:"message"}),", ...",(0,i.jsx)(n.code,{children:"items"}),"): ",(0,i.jsx)(n.code,{children:"Promise"}),"< ",(0,i.jsx)(n.code,{children:"string"})," | ",(0,i.jsx)(n.code,{children:"undefined"})," >"]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Show a warning message. Optionally provide an array of items which will be presented as\nclickable buttons."}),"\n",(0,i.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"message"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n",(0,i.jsx)(n.p,{children:"The message to show."}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ...",(0,i.jsx)(n.strong,{children:"items"}),": ",(0,i.jsx)(n.code,{children:"string"}),"[]"]}),"\n",(0,i.jsx)(n.p,{children:"A set of items that will be rendered as actions in the message."}),"\n",(0,i.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"Promise"}),"< ",(0,i.jsx)(n.code,{children:"string"})," | ",(0,i.jsx)(n.code,{children:"undefined"})," >"]}),"\n",(0,i.jsxs)(n.p,{children:["A promise that resolves to the selected item or ",(0,i.jsx)(n.code,{children:"undefined"})," when being dismissed."]}),"\n",(0,i.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L1602",children:"packages/extension-api/src/extension-api.d.ts:1602"})})]})}function h(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>c,a:()=>r});var i=s(27378);const t={},o=i.createContext(t);function r(e){const n=i.useContext(o);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:r(e.components),i.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[82424],{17869:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>a,contentTitle:()=>r,default:()=>h,frontMatter:()=>o,metadata:()=>c,toc:()=>d});var i=s(24246),t=s(71670);const o={},r="Function: showWarningMessage()",c={id:"namespaces/window/functions/showWarningMessage",title:"Function: showWarningMessage()",description:"showWarningMessage(message, ...items): Promise\\",source:"@site/api/namespaces/window/functions/showWarningMessage.md",sourceDirName:"namespaces/window/functions",slug:"/namespaces/window/functions/showWarningMessage",permalink:"/api/namespaces/window/functions/showWarningMessage",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Function: showSaveDialog()",permalink:"/api/namespaces/window/functions/showSaveDialog"},next:{title:"Function: withProgress()",permalink:"/api/namespaces/window/functions/withProgress"}},a={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,t.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"function-showwarningmessage",children:"Function: showWarningMessage()"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"showWarningMessage"}),"(",(0,i.jsx)(n.code,{children:"message"}),", ...",(0,i.jsx)(n.code,{children:"items"}),"): ",(0,i.jsx)(n.code,{children:"Promise"}),"< ",(0,i.jsx)(n.code,{children:"string"})," | ",(0,i.jsx)(n.code,{children:"undefined"})," >"]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Show a warning message. Optionally provide an array of items which will be presented as\nclickable buttons."}),"\n",(0,i.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"message"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n",(0,i.jsx)(n.p,{children:"The message to show."}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ...",(0,i.jsx)(n.strong,{children:"items"}),": ",(0,i.jsx)(n.code,{children:"string"}),"[]"]}),"\n",(0,i.jsx)(n.p,{children:"A set of items that will be rendered as actions in the message."}),"\n",(0,i.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"Promise"}),"< ",(0,i.jsx)(n.code,{children:"string"})," | ",(0,i.jsx)(n.code,{children:"undefined"})," >"]}),"\n",(0,i.jsxs)(n.p,{children:["A promise that resolves to the selected item or ",(0,i.jsx)(n.code,{children:"undefined"})," when being dismissed."]}),"\n",(0,i.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L1602",children:"packages/extension-api/src/extension-api.d.ts:1602"})})]})}function h(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>c,a:()=>r});var i=s(27378);const t={},o=i.createContext(t);function r(e){const n=i.useContext(o);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:r(e.components),i.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/b6d76a6c.36778ba0.js b/assets/js/b6d76a6c.65995e2c.js similarity index 87% rename from assets/js/b6d76a6c.36778ba0.js rename to assets/js/b6d76a6c.65995e2c.js index 2cd66a0fccc..3e858c25a9f 100644 --- a/assets/js/b6d76a6c.36778ba0.js +++ b/assets/js/b6d76a6c.65995e2c.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[3667],{16327:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>c,contentTitle:()=>r,default:()=>h,frontMatter:()=>a,metadata:()=>o,toc:()=>l});var t=s(24246),i=s(71670);const a={},r="Function: onDidStateChange()",o={id:"namespaces/proxy/functions/onDidStateChange",title:"Function: onDidStateChange()",description:"onDidStateChange(listener, thisArgs?, disposables?): Disposable",source:"@site/api/namespaces/proxy/functions/onDidStateChange.md",sourceDirName:"namespaces/proxy/functions",slug:"/namespaces/proxy/functions/onDidStateChange",permalink:"/api/namespaces/proxy/functions/onDidStateChange",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Function: isEnabled()",permalink:"/api/namespaces/proxy/functions/isEnabled"},next:{title:"Function: onDidUpdateProxy()",permalink:"/api/namespaces/proxy/functions/onDidUpdateProxy"}},c={},l=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function d(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,i.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"function-ondidstatechange",children:"Function: onDidStateChange()"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"onDidStateChange"}),"(",(0,t.jsx)(n.code,{children:"listener"}),", ",(0,t.jsx)(n.code,{children:"thisArgs"}),"?, ",(0,t.jsx)(n.code,{children:"disposables"}),"?): ",(0,t.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,t.jsx)(n.code,{children:"Disposable"})})]}),"\n"]}),"\n",(0,t.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"listener"})]}),"\n",(0,t.jsx)(n.p,{children:"The listener function will be called when the event happens."}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"thisArgs?"}),": ",(0,t.jsx)(n.code,{children:"any"})]}),"\n",(0,t.jsxs)(n.p,{children:["The ",(0,t.jsx)(n.code,{children:"this"}),"-argument which will be used when calling the event listener."]}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"disposables?"}),": ",(0,t.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,t.jsx)(n.code,{children:"Disposable"})}),"[]"]}),"\n",(0,t.jsxs)(n.p,{children:["An array to which a ",(0,t.jsx)(n.a,{href:"/api/classes/Disposable",children:"Disposable"})," will be added."]}),"\n",(0,t.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,t.jsx)(n.code,{children:"Disposable"})})}),"\n",(0,t.jsx)(n.p,{children:"A disposable which unsubscribes the event listener."}),"\n",(0,t.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L581",children:"packages/extension-api/src/extension-api.d.ts:581"})})]})}function h(e={}){const{wrapper:n}={...(0,i.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(d,{...e})}):d(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>o,a:()=>r});var t=s(27378);const i={},a=t.createContext(i);function r(e){const n=t.useContext(a);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:r(e.components),t.createElement(a.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[3667],{16327:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>c,contentTitle:()=>r,default:()=>h,frontMatter:()=>a,metadata:()=>o,toc:()=>d});var t=s(24246),i=s(71670);const a={},r="Function: onDidStateChange()",o={id:"namespaces/proxy/functions/onDidStateChange",title:"Function: onDidStateChange()",description:"onDidStateChange(listener, thisArgs?, disposables?): Disposable",source:"@site/api/namespaces/proxy/functions/onDidStateChange.md",sourceDirName:"namespaces/proxy/functions",slug:"/namespaces/proxy/functions/onDidStateChange",permalink:"/api/namespaces/proxy/functions/onDidStateChange",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Function: isEnabled()",permalink:"/api/namespaces/proxy/functions/isEnabled"},next:{title:"Function: onDidUpdateProxy()",permalink:"/api/namespaces/proxy/functions/onDidUpdateProxy"}},c={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,i.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"function-ondidstatechange",children:"Function: onDidStateChange()"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"onDidStateChange"}),"(",(0,t.jsx)(n.code,{children:"listener"}),", ",(0,t.jsx)(n.code,{children:"thisArgs"}),"?, ",(0,t.jsx)(n.code,{children:"disposables"}),"?): ",(0,t.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,t.jsx)(n.code,{children:"Disposable"})})]}),"\n"]}),"\n",(0,t.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"listener"})]}),"\n",(0,t.jsx)(n.p,{children:"The listener function will be called when the event happens."}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"thisArgs?"}),": ",(0,t.jsx)(n.code,{children:"any"})]}),"\n",(0,t.jsxs)(n.p,{children:["The ",(0,t.jsx)(n.code,{children:"this"}),"-argument which will be used when calling the event listener."]}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"disposables?"}),": ",(0,t.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,t.jsx)(n.code,{children:"Disposable"})}),"[]"]}),"\n",(0,t.jsxs)(n.p,{children:["An array to which a ",(0,t.jsx)(n.a,{href:"/api/classes/Disposable",children:"Disposable"})," will be added."]}),"\n",(0,t.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,t.jsx)(n.code,{children:"Disposable"})})}),"\n",(0,t.jsx)(n.p,{children:"A disposable which unsubscribes the event listener."}),"\n",(0,t.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L581",children:"packages/extension-api/src/extension-api.d.ts:581"})})]})}function h(e={}){const{wrapper:n}={...(0,i.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>o,a:()=>r});var t=s(27378);const i={},a=t.createContext(i);function r(e){const n=t.useContext(a);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:r(e.components),t.createElement(a.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/b7bb2d93.038b3ffc.js b/assets/js/b7bb2d93.60a94deb.js similarity index 96% rename from assets/js/b7bb2d93.038b3ffc.js rename to assets/js/b7bb2d93.60a94deb.js index 29f9de2f115..dd9e1d844b3 100644 --- a/assets/js/b7bb2d93.038b3ffc.js +++ b/assets/js/b7bb2d93.60a94deb.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[16855],{29264:(e,n,o)=>{o.r(n),o.d(n,{assets:()=>c,contentTitle:()=>i,default:()=>u,frontMatter:()=>s,metadata:()=>a,toc:()=>d});var t=o(24246),r=o(71670);const s={},i="Enumeration: ProgressLocation",a={id:"enumerations/ProgressLocation",title:"Enumeration: ProgressLocation",description:"A location in the editor at which progress information can be shown. It depends on the",source:"@site/api/enumerations/ProgressLocation.md",sourceDirName:"enumerations",slug:"/enumerations/ProgressLocation",permalink:"/api/enumerations/ProgressLocation",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Enumeration: InputBoxValidationSeverity",permalink:"/api/enumerations/InputBoxValidationSeverity"},next:{title:"Enumeration: QuickPickItemKind",permalink:"/api/enumerations/QuickPickItemKind"}},c={},d=[{value:"Enumeration Members",id:"enumeration-members",level:2},{value:"APP_ICON",id:"app_icon",level:3},{value:"Deprecated",id:"deprecated",level:4},{value:"See",id:"see",level:4},{value:"Source",id:"source",level:4},{value:"TASK_WIDGET",id:"task_widget",level:3},{value:"Source",id:"source-1",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",del:"del",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,r.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"enumeration-progresslocation",children:"Enumeration: ProgressLocation"}),"\n",(0,t.jsx)(n.p,{children:"A location in the editor at which progress information can be shown. It depends on the\nlocation how progress is visually represented."}),"\n",(0,t.jsx)(n.h2,{id:"enumeration-members",children:"Enumeration Members"}),"\n",(0,t.jsx)(n.h3,{id:"app_icon",children:(0,t.jsx)(n.del,{children:"APP_ICON"})}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"APP_ICON"}),": ",(0,t.jsx)(n.code,{children:"1"})]}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"Show progress bar under app icon in launcher bar."}),"\n",(0,t.jsx)(n.h4,{id:"deprecated",children:"Deprecated"}),"\n",(0,t.jsx)(n.p,{children:"This value is deprecated as it does not render equally on various supported platforms. It will be\nremoved in future versions of Podman Desktop. We strongly encourage to use TASK_WIDGET instead."}),"\n",(0,t.jsx)(n.h4,{id:"see",children:"See"}),"\n",(0,t.jsx)(n.p,{children:"TASK_WIDGET"}),"\n",(0,t.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L742",children:"packages/extension-api/src/extension-api.d.ts:742"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"task_widget",children:"TASK_WIDGET"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"TASK_WIDGET"}),": ",(0,t.jsx)(n.code,{children:"2"})]}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"Show progress in the task manager widget"}),"\n",(0,t.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L747",children:"packages/extension-api/src/extension-api.d.ts:747"})})]})}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,o)=>{o.d(n,{Z:()=>a,a:()=>i});var t=o(27378);const r={},s=t.createContext(r);function i(e){const n=t.useContext(s);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function a(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:i(e.components),t.createElement(s.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[16855],{29264:(e,n,o)=>{o.r(n),o.d(n,{assets:()=>c,contentTitle:()=>i,default:()=>u,frontMatter:()=>s,metadata:()=>a,toc:()=>d});var t=o(24246),r=o(71670);const s={},i="Enumeration: ProgressLocation",a={id:"enumerations/ProgressLocation",title:"Enumeration: ProgressLocation",description:"A location in the editor at which progress information can be shown. It depends on the",source:"@site/api/enumerations/ProgressLocation.md",sourceDirName:"enumerations",slug:"/enumerations/ProgressLocation",permalink:"/api/enumerations/ProgressLocation",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Enumeration: InputBoxValidationSeverity",permalink:"/api/enumerations/InputBoxValidationSeverity"},next:{title:"Enumeration: QuickPickItemKind",permalink:"/api/enumerations/QuickPickItemKind"}},c={},d=[{value:"Enumeration Members",id:"enumeration-members",level:2},{value:"APP_ICON",id:"app_icon",level:3},{value:"Deprecated",id:"deprecated",level:4},{value:"See",id:"see",level:4},{value:"Source",id:"source",level:4},{value:"TASK_WIDGET",id:"task_widget",level:3},{value:"Source",id:"source-1",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",del:"del",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,r.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"enumeration-progresslocation",children:"Enumeration: ProgressLocation"}),"\n",(0,t.jsx)(n.p,{children:"A location in the editor at which progress information can be shown. It depends on the\nlocation how progress is visually represented."}),"\n",(0,t.jsx)(n.h2,{id:"enumeration-members",children:"Enumeration Members"}),"\n",(0,t.jsx)(n.h3,{id:"app_icon",children:(0,t.jsx)(n.del,{children:"APP_ICON"})}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"APP_ICON"}),": ",(0,t.jsx)(n.code,{children:"1"})]}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"Show progress bar under app icon in launcher bar."}),"\n",(0,t.jsx)(n.h4,{id:"deprecated",children:"Deprecated"}),"\n",(0,t.jsx)(n.p,{children:"This value is deprecated as it does not render equally on various supported platforms. It will be\nremoved in future versions of Podman Desktop. We strongly encourage to use TASK_WIDGET instead."}),"\n",(0,t.jsx)(n.h4,{id:"see",children:"See"}),"\n",(0,t.jsx)(n.p,{children:"TASK_WIDGET"}),"\n",(0,t.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L742",children:"packages/extension-api/src/extension-api.d.ts:742"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"task_widget",children:"TASK_WIDGET"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"TASK_WIDGET"}),": ",(0,t.jsx)(n.code,{children:"2"})]}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"Show progress in the task manager widget"}),"\n",(0,t.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L747",children:"packages/extension-api/src/extension-api.d.ts:747"})})]})}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,o)=>{o.d(n,{Z:()=>a,a:()=>i});var t=o(27378);const r={},s=t.createContext(r);function i(e){const n=t.useContext(s);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function a(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:i(e.components),t.createElement(s.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/b8eb0fce.f4f93d82.js b/assets/js/b8eb0fce.8183041a.js similarity index 88% rename from assets/js/b8eb0fce.f4f93d82.js rename to assets/js/b8eb0fce.8183041a.js index e6b3fa1857f..5a78430a273 100644 --- a/assets/js/b8eb0fce.f4f93d82.js +++ b/assets/js/b8eb0fce.8183041a.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[69584],{81189:(e,s,n)=>{n.r(s),n.d(s,{assets:()=>a,contentTitle:()=>c,default:()=>p,frontMatter:()=>t,metadata:()=>o,toc:()=>l});var i=n(24246),r=n(71670);const t={},c="Function: onDidRegisterRegistry()",o={id:"namespaces/registry/functions/onDidRegisterRegistry",title:"Function: onDidRegisterRegistry()",description:"onDidRegisterRegistry(listener, thisArgs?, disposables?): Disposable",source:"@site/api/namespaces/registry/functions/onDidRegisterRegistry.md",sourceDirName:"namespaces/registry/functions",slug:"/namespaces/registry/functions/onDidRegisterRegistry",permalink:"/api/namespaces/registry/functions/onDidRegisterRegistry",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Namespace: registry",permalink:"/api/namespaces/registry/"},next:{title:"Function: onDidUnregisterRegistry()",permalink:"/api/namespaces/registry/functions/onDidUnregisterRegistry"}},a={},l=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function d(e){const s={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,r.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(s.h1,{id:"function-ondidregisterregistry",children:"Function: onDidRegisterRegistry()"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"onDidRegisterRegistry"}),"(",(0,i.jsx)(s.code,{children:"listener"}),", ",(0,i.jsx)(s.code,{children:"thisArgs"}),"?, ",(0,i.jsx)(s.code,{children:"disposables"}),"?): ",(0,i.jsx)(s.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(s.code,{children:"Disposable"})})]}),"\n"]}),"\n",(0,i.jsx)(s.h2,{id:"parameters",children:"Parameters"}),"\n",(0,i.jsxs)(s.p,{children:["\u2022 ",(0,i.jsx)(s.strong,{children:"listener"})]}),"\n",(0,i.jsx)(s.p,{children:"The listener function will be called when the event happens."}),"\n",(0,i.jsxs)(s.p,{children:["\u2022 ",(0,i.jsx)(s.strong,{children:"thisArgs?"}),": ",(0,i.jsx)(s.code,{children:"any"})]}),"\n",(0,i.jsxs)(s.p,{children:["The ",(0,i.jsx)(s.code,{children:"this"}),"-argument which will be used when calling the event listener."]}),"\n",(0,i.jsxs)(s.p,{children:["\u2022 ",(0,i.jsx)(s.strong,{children:"disposables?"}),": ",(0,i.jsx)(s.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(s.code,{children:"Disposable"})}),"[]"]}),"\n",(0,i.jsxs)(s.p,{children:["An array to which a ",(0,i.jsx)(s.a,{href:"/api/classes/Disposable",children:"Disposable"})," will be added."]}),"\n",(0,i.jsx)(s.h2,{id:"returns",children:"Returns"}),"\n",(0,i.jsx)(s.p,{children:(0,i.jsx)(s.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(s.code,{children:"Disposable"})})}),"\n",(0,i.jsx)(s.p,{children:"A disposable which unsubscribes the event listener."}),"\n",(0,i.jsx)(s.h2,{id:"source",children:"Source"}),"\n",(0,i.jsx)(s.p,{children:(0,i.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L630",children:"packages/extension-api/src/extension-api.d.ts:630"})})]})}function p(e={}){const{wrapper:s}={...(0,r.a)(),...e.components};return s?(0,i.jsx)(s,{...e,children:(0,i.jsx)(d,{...e})}):d(e)}},71670:(e,s,n)=>{n.d(s,{Z:()=>o,a:()=>c});var i=n(27378);const r={},t=i.createContext(r);function c(e){const s=i.useContext(t);return i.useMemo((function(){return"function"==typeof e?e(s):{...s,...e}}),[s,e])}function o(e){let s;return s=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:c(e.components),i.createElement(t.Provider,{value:s},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[69584],{81189:(e,s,n)=>{n.r(s),n.d(s,{assets:()=>a,contentTitle:()=>c,default:()=>p,frontMatter:()=>t,metadata:()=>o,toc:()=>d});var i=n(24246),r=n(71670);const t={},c="Function: onDidRegisterRegistry()",o={id:"namespaces/registry/functions/onDidRegisterRegistry",title:"Function: onDidRegisterRegistry()",description:"onDidRegisterRegistry(listener, thisArgs?, disposables?): Disposable",source:"@site/api/namespaces/registry/functions/onDidRegisterRegistry.md",sourceDirName:"namespaces/registry/functions",slug:"/namespaces/registry/functions/onDidRegisterRegistry",permalink:"/api/namespaces/registry/functions/onDidRegisterRegistry",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Namespace: registry",permalink:"/api/namespaces/registry/"},next:{title:"Function: onDidUnregisterRegistry()",permalink:"/api/namespaces/registry/functions/onDidUnregisterRegistry"}},a={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function l(e){const s={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,r.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(s.h1,{id:"function-ondidregisterregistry",children:"Function: onDidRegisterRegistry()"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"onDidRegisterRegistry"}),"(",(0,i.jsx)(s.code,{children:"listener"}),", ",(0,i.jsx)(s.code,{children:"thisArgs"}),"?, ",(0,i.jsx)(s.code,{children:"disposables"}),"?): ",(0,i.jsx)(s.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(s.code,{children:"Disposable"})})]}),"\n"]}),"\n",(0,i.jsx)(s.h2,{id:"parameters",children:"Parameters"}),"\n",(0,i.jsxs)(s.p,{children:["\u2022 ",(0,i.jsx)(s.strong,{children:"listener"})]}),"\n",(0,i.jsx)(s.p,{children:"The listener function will be called when the event happens."}),"\n",(0,i.jsxs)(s.p,{children:["\u2022 ",(0,i.jsx)(s.strong,{children:"thisArgs?"}),": ",(0,i.jsx)(s.code,{children:"any"})]}),"\n",(0,i.jsxs)(s.p,{children:["The ",(0,i.jsx)(s.code,{children:"this"}),"-argument which will be used when calling the event listener."]}),"\n",(0,i.jsxs)(s.p,{children:["\u2022 ",(0,i.jsx)(s.strong,{children:"disposables?"}),": ",(0,i.jsx)(s.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(s.code,{children:"Disposable"})}),"[]"]}),"\n",(0,i.jsxs)(s.p,{children:["An array to which a ",(0,i.jsx)(s.a,{href:"/api/classes/Disposable",children:"Disposable"})," will be added."]}),"\n",(0,i.jsx)(s.h2,{id:"returns",children:"Returns"}),"\n",(0,i.jsx)(s.p,{children:(0,i.jsx)(s.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(s.code,{children:"Disposable"})})}),"\n",(0,i.jsx)(s.p,{children:"A disposable which unsubscribes the event listener."}),"\n",(0,i.jsx)(s.h2,{id:"source",children:"Source"}),"\n",(0,i.jsx)(s.p,{children:(0,i.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L630",children:"packages/extension-api/src/extension-api.d.ts:630"})})]})}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.8536efc6.js b/assets/js/b8ec852b.49cb4e11.js similarity index 92% rename from assets/js/b8ec852b.8536efc6.js rename to assets/js/b8ec852b.49cb4e11.js index b6318793480..b325a209644 100644 --- a/assets/js/b8ec852b.8536efc6.js +++ b/assets/js/b8ec852b.49cb4e11.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[63407],{46801:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>a,contentTitle:()=>i,default:()=>h,frontMatter:()=>t,metadata:()=>c,toc:()=>l});var o=s(24246),r=s(71670);const t={},i="Interface: ProgressOptions",c={id:"interfaces/ProgressOptions",title:"Interface: ProgressOptions",description:"Value-object describing where and how progress should show.",source:"@site/api/interfaces/ProgressOptions.md",sourceDirName:"interfaces",slug:"/interfaces/ProgressOptions",permalink:"/api/interfaces/ProgressOptions",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: Progress\\",permalink:"/api/interfaces/Progress"},next:{title:"Interface: Provider",permalink:"/api/interfaces/Provider"}},a={},l=[{value:"Properties",id:"properties",level:2},{value:"cancellable?",id:"cancellable",level:3},{value:"Source",id:"source",level:4},{value:"location",id:"location",level:3},{value:"Source",id:"source-1",level:4},{value:"title?",id:"title",level:3},{value:"Source",id:"source-2",level:4}];function d(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,r.a)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(n.h1,{id:"interface-progressoptions",children:"Interface: ProgressOptions"}),"\n",(0,o.jsx)(n.p,{children:"Value-object describing where and how progress should show."}),"\n",(0,o.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,o.jsx)(n.h3,{id:"cancellable",children:"cancellable?"}),"\n",(0,o.jsxs)(n.blockquote,{children:["\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.strong,{children:(0,o.jsx)(n.code,{children:"optional"})})," ",(0,o.jsx)(n.strong,{children:"cancellable"}),": ",(0,o.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,o.jsxs)(n.p,{children:["Controls if a cancel button should show to allow the user to\ncancel the long running operation. Note that currently only\n",(0,o.jsx)(n.code,{children:"ProgressLocation.Notification"})," is supporting to show a cancel\nbutton."]}),"\n",(0,o.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,o.jsx)(n.p,{children:(0,o.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L771",children:"packages/extension-api/src/extension-api.d.ts:771"})}),"\n",(0,o.jsx)(n.hr,{}),"\n",(0,o.jsx)(n.h3,{id:"location",children:"location"}),"\n",(0,o.jsxs)(n.blockquote,{children:["\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.strong,{children:"location"}),": ",(0,o.jsx)(n.a,{href:"/api/enumerations/ProgressLocation",children:(0,o.jsx)(n.code,{children:"ProgressLocation"})})]}),"\n"]}),"\n",(0,o.jsx)(n.p,{children:"The location at which progress should show."}),"\n",(0,o.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,o.jsx)(n.p,{children:(0,o.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L757",children:"packages/extension-api/src/extension-api.d.ts:757"})}),"\n",(0,o.jsx)(n.hr,{}),"\n",(0,o.jsx)(n.h3,{id:"title",children:"title?"}),"\n",(0,o.jsxs)(n.blockquote,{children:["\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.strong,{children:(0,o.jsx)(n.code,{children:"optional"})})," ",(0,o.jsx)(n.strong,{children:"title"}),": ",(0,o.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,o.jsx)(n.p,{children:"A human-readable string which will be used to describe the\noperation."}),"\n",(0,o.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,o.jsx)(n.p,{children:(0,o.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L763",children:"packages/extension-api/src/extension-api.d.ts:763"})})]})}function h(e={}){const{wrapper:n}={...(0,r.a)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(d,{...e})}):d(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>c,a:()=>i});var o=s(27378);const r={},t=o.createContext(r);function i(e){const n=o.useContext(t);return o.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:i(e.components),o.createElement(t.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[63407],{46801:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>a,contentTitle:()=>i,default:()=>h,frontMatter:()=>t,metadata:()=>c,toc:()=>l});var o=s(24246),r=s(71670);const t={},i="Interface: ProgressOptions",c={id:"interfaces/ProgressOptions",title:"Interface: ProgressOptions",description:"Value-object describing where and how progress should show.",source:"@site/api/interfaces/ProgressOptions.md",sourceDirName:"interfaces",slug:"/interfaces/ProgressOptions",permalink:"/api/interfaces/ProgressOptions",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: Progress\\",permalink:"/api/interfaces/Progress"},next:{title:"Interface: Provider",permalink:"/api/interfaces/Provider"}},a={},l=[{value:"Properties",id:"properties",level:2},{value:"cancellable?",id:"cancellable",level:3},{value:"Source",id:"source",level:4},{value:"location",id:"location",level:3},{value:"Source",id:"source-1",level:4},{value:"title?",id:"title",level:3},{value:"Source",id:"source-2",level:4}];function d(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,r.a)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(n.h1,{id:"interface-progressoptions",children:"Interface: ProgressOptions"}),"\n",(0,o.jsx)(n.p,{children:"Value-object describing where and how progress should show."}),"\n",(0,o.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,o.jsx)(n.h3,{id:"cancellable",children:"cancellable?"}),"\n",(0,o.jsxs)(n.blockquote,{children:["\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.strong,{children:(0,o.jsx)(n.code,{children:"optional"})})," ",(0,o.jsx)(n.strong,{children:"cancellable"}),": ",(0,o.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,o.jsxs)(n.p,{children:["Controls if a cancel button should show to allow the user to\ncancel the long running operation. Note that currently only\n",(0,o.jsx)(n.code,{children:"ProgressLocation.Notification"})," is supporting to show a cancel\nbutton."]}),"\n",(0,o.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,o.jsx)(n.p,{children:(0,o.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L771",children:"packages/extension-api/src/extension-api.d.ts:771"})}),"\n",(0,o.jsx)(n.hr,{}),"\n",(0,o.jsx)(n.h3,{id:"location",children:"location"}),"\n",(0,o.jsxs)(n.blockquote,{children:["\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.strong,{children:"location"}),": ",(0,o.jsx)(n.a,{href:"/api/enumerations/ProgressLocation",children:(0,o.jsx)(n.code,{children:"ProgressLocation"})})]}),"\n"]}),"\n",(0,o.jsx)(n.p,{children:"The location at which progress should show."}),"\n",(0,o.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,o.jsx)(n.p,{children:(0,o.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L757",children:"packages/extension-api/src/extension-api.d.ts:757"})}),"\n",(0,o.jsx)(n.hr,{}),"\n",(0,o.jsx)(n.h3,{id:"title",children:"title?"}),"\n",(0,o.jsxs)(n.blockquote,{children:["\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.strong,{children:(0,o.jsx)(n.code,{children:"optional"})})," ",(0,o.jsx)(n.strong,{children:"title"}),": ",(0,o.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,o.jsx)(n.p,{children:"A human-readable string which will be used to describe the\noperation."}),"\n",(0,o.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,o.jsx)(n.p,{children:(0,o.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L763",children:"packages/extension-api/src/extension-api.d.ts:763"})})]})}function h(e={}){const{wrapper:n}={...(0,r.a)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(d,{...e})}):d(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>c,a:()=>i});var o=s(27378);const r={},t=o.createContext(r);function i(e){const n=o.useContext(t);return o.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:i(e.components),o.createElement(t.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/b9287eb6.96b5e71c.js b/assets/js/b9287eb6.e2287fd2.js similarity index 73% rename from assets/js/b9287eb6.96b5e71c.js rename to assets/js/b9287eb6.e2287fd2.js index d97a3a5d928..605ff7bb10f 100644 --- a/assets/js/b9287eb6.96b5e71c.js +++ b/assets/js/b9287eb6.e2287fd2.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[89251],{70233:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>o,contentTitle:()=>i,default:()=>u,frontMatter:()=>t,metadata:()=>a,toc:()=>d});var r=s(24246),c=s(71670);const t={},i="Interface: CPUUsage",a={id:"interfaces/CPUUsage",title:"Interface: CPUUsage",description:"Properties",source:"@site/api/interfaces/CPUUsage.md",sourceDirName:"interfaces",slug:"/interfaces/CPUUsage",permalink:"/api/interfaces/CPUUsage",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: CPUStats",permalink:"/api/interfaces/CPUStats"},next:{title:"Interface: CancellationToken",permalink:"/api/interfaces/CancellationToken"}},o={},d=[{value:"Properties",id:"properties",level:2},{value:"percpu_usage",id:"percpu_usage",level:3},{value:"Source",id:"source",level:4},{value:"total_usage",id:"total_usage",level:3},{value:"Source",id:"source-1",level:4},{value:"usage_in_kernelmode",id:"usage_in_kernelmode",level:3},{value:"Source",id:"source-2",level:4},{value:"usage_in_usermode",id:"usage_in_usermode",level:3},{value:"Source",id:"source-3",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,c.a)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.h1,{id:"interface-cpuusage",children:"Interface: CPUUsage"}),"\n",(0,r.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,r.jsx)(n.h3,{id:"percpu_usage",children:"percpu_usage"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"percpu_usage"}),": ",(0,r.jsx)(n.code,{children:"number"}),"[]"]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2848",children:"packages/extension-api/src/extension-api.d.ts:2848"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"total_usage",children:"total_usage"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"total_usage"}),": ",(0,r.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2850",children:"packages/extension-api/src/extension-api.d.ts:2850"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"usage_in_kernelmode",children:"usage_in_kernelmode"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"usage_in_kernelmode"}),": ",(0,r.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2851",children:"packages/extension-api/src/extension-api.d.ts:2851"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"usage_in_usermode",children:"usage_in_usermode"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"usage_in_usermode"}),": ",(0,r.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2849",children:"packages/extension-api/src/extension-api.d.ts:2849"})})]})}function u(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:()=>a,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 a(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([[89251],{70233:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>a,contentTitle:()=>i,default:()=>u,frontMatter:()=>c,metadata:()=>o,toc:()=>d});var r=s(24246),t=s(71670);const c={},i="Interface: CPUUsage",o={id:"interfaces/CPUUsage",title:"Interface: CPUUsage",description:"Properties",source:"@site/api/interfaces/CPUUsage.md",sourceDirName:"interfaces",slug:"/interfaces/CPUUsage",permalink:"/api/interfaces/CPUUsage",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: CPUStats",permalink:"/api/interfaces/CPUStats"},next:{title:"Interface: CancellationToken",permalink:"/api/interfaces/CancellationToken"}},a={},d=[{value:"Properties",id:"properties",level:2},{value:"percpu_usage",id:"percpu_usage",level:3},{value:"Source",id:"source",level:4},{value:"total_usage",id:"total_usage",level:3},{value:"Source",id:"source-1",level:4},{value:"usage_in_kernelmode",id:"usage_in_kernelmode",level:3},{value:"Source",id:"source-2",level:4},{value:"usage_in_usermode",id:"usage_in_usermode",level:3},{value:"Source",id:"source-3",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,t.a)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.h1,{id:"interface-cpuusage",children:"Interface: CPUUsage"}),"\n",(0,r.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,r.jsx)(n.h3,{id:"percpu_usage",children:"percpu_usage"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"percpu_usage"}),": ",(0,r.jsx)(n.code,{children:"number"}),"[]"]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2848",children:"packages/extension-api/src/extension-api.d.ts:2848"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"total_usage",children:"total_usage"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"total_usage"}),": ",(0,r.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2850",children:"packages/extension-api/src/extension-api.d.ts:2850"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"usage_in_kernelmode",children:"usage_in_kernelmode"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"usage_in_kernelmode"}),": ",(0,r.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2851",children:"packages/extension-api/src/extension-api.d.ts:2851"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"usage_in_usermode",children:"usage_in_usermode"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"usage_in_usermode"}),": ",(0,r.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2849",children:"packages/extension-api/src/extension-api.d.ts:2849"})})]})}function u(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(l,{...e})}):l(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>o,a:()=>i});var r=s(27378);const t={},c=r.createContext(t);function i(e){const n=r.useContext(c);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:i(e.components),r.createElement(c.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/b9a87183.9e0dfce3.js b/assets/js/b9a87183.20a8f42b.js similarity index 93% rename from assets/js/b9a87183.9e0dfce3.js rename to assets/js/b9a87183.20a8f42b.js index 6d575ada1a1..535021ae99a 100644 --- a/assets/js/b9a87183.9e0dfce3.js +++ b/assets/js/b9a87183.20a8f42b.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[25821],{76346:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>s,contentTitle:()=>c,default:()=>l,frontMatter:()=>o,metadata:()=>a,toc:()=>d});var i=t(24246),r=t(71670);const o={},c="Interface: AuthenticationProviderInformation",a={id:"interfaces/AuthenticationProviderInformation",title:"Interface: AuthenticationProviderInformation",description:"Basic information about an authenticationProvider",source:"@site/api/interfaces/AuthenticationProviderInformation.md",sourceDirName:"interfaces",slug:"/interfaces/AuthenticationProviderInformation",permalink:"/api/interfaces/AuthenticationProviderInformation",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: AuthenticationProviderAuthenticationSessionsChangeEvent",permalink:"/api/interfaces/AuthenticationProviderAuthenticationSessionsChangeEvent"},next:{title:"Interface: AuthenticationProviderOptions",permalink:"/api/interfaces/AuthenticationProviderOptions"}},s={},d=[{value:"Properties",id:"properties",level:2},{value:"id",id:"id",level:3},{value:"Source",id:"source",level:4},{value:"label",id:"label",level:3},{value:"Source",id:"source-1",level:4}];function h(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,r.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"interface-authenticationproviderinformation",children:"Interface: AuthenticationProviderInformation"}),"\n",(0,i.jsxs)(n.p,{children:["Basic information about an ",(0,i.jsx)(n.a,{href:"#AuthenticationProvider",children:"authenticationProvider"})]}),"\n",(0,i.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(n.h3,{id:"id",children:"id"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"readonly"})})," ",(0,i.jsx)(n.strong,{children:"id"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"The unique identifier of the authentication provider."}),"\n",(0,i.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L3492",children:"packages/extension-api/src/extension-api.d.ts:3492"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"label",children:"label"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"readonly"})})," ",(0,i.jsx)(n.strong,{children:"label"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"The human-readable name of the authentication provider."}),"\n",(0,i.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L3497",children:"packages/extension-api/src/extension-api.d.ts:3497"})})]})}function l(e={}){const{wrapper:n}={...(0,r.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(h,{...e})}):h(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>a,a:()=>c});var i=t(27378);const r={},o=i.createContext(r);function c(e){const n=i.useContext(o);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function a(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:c(e.components),i.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[25821],{76346:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>s,contentTitle:()=>c,default:()=>l,frontMatter:()=>o,metadata:()=>a,toc:()=>d});var i=t(24246),r=t(71670);const o={},c="Interface: AuthenticationProviderInformation",a={id:"interfaces/AuthenticationProviderInformation",title:"Interface: AuthenticationProviderInformation",description:"Basic information about an authenticationProvider",source:"@site/api/interfaces/AuthenticationProviderInformation.md",sourceDirName:"interfaces",slug:"/interfaces/AuthenticationProviderInformation",permalink:"/api/interfaces/AuthenticationProviderInformation",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: AuthenticationProviderAuthenticationSessionsChangeEvent",permalink:"/api/interfaces/AuthenticationProviderAuthenticationSessionsChangeEvent"},next:{title:"Interface: AuthenticationProviderOptions",permalink:"/api/interfaces/AuthenticationProviderOptions"}},s={},d=[{value:"Properties",id:"properties",level:2},{value:"id",id:"id",level:3},{value:"Source",id:"source",level:4},{value:"label",id:"label",level:3},{value:"Source",id:"source-1",level:4}];function h(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,r.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"interface-authenticationproviderinformation",children:"Interface: AuthenticationProviderInformation"}),"\n",(0,i.jsxs)(n.p,{children:["Basic information about an ",(0,i.jsx)(n.a,{href:"#AuthenticationProvider",children:"authenticationProvider"})]}),"\n",(0,i.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(n.h3,{id:"id",children:"id"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"readonly"})})," ",(0,i.jsx)(n.strong,{children:"id"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"The unique identifier of the authentication provider."}),"\n",(0,i.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L3492",children:"packages/extension-api/src/extension-api.d.ts:3492"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"label",children:"label"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"readonly"})})," ",(0,i.jsx)(n.strong,{children:"label"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"The human-readable name of the authentication provider."}),"\n",(0,i.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L3497",children:"packages/extension-api/src/extension-api.d.ts:3497"})})]})}function l(e={}){const{wrapper:n}={...(0,r.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(h,{...e})}):h(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>a,a:()=>c});var i=t(27378);const r={},o=i.createContext(r);function c(e){const n=i.useContext(o);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function a(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:c(e.components),i.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/bab44fba.d360f8a7.js b/assets/js/bab44fba.3d298f80.js similarity index 98% rename from assets/js/bab44fba.d360f8a7.js rename to assets/js/bab44fba.3d298f80.js index f7bcfef6256..5a56f400a22 100644 --- a/assets/js/bab44fba.d360f8a7.js +++ b/assets/js/bab44fba.3d298f80.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[98170],{23989:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>a,contentTitle:()=>c,default:()=>p,frontMatter:()=>t,metadata:()=>o,toc:()=>d});var s=r(24246),i=r(71670);const t={},c="Function: replicatePodmanContainer()",o={id:"namespaces/containerEngine/functions/replicatePodmanContainer",title:"Function: replicatePodmanContainer()",description:"replicatePodmanContainer(source, target, overrideParameters): Promise\\",source:"@site/api/namespaces/containerEngine/functions/replicatePodmanContainer.md",sourceDirName:"namespaces/containerEngine/functions",slug:"/namespaces/containerEngine/functions/replicatePodmanContainer",permalink:"/api/namespaces/containerEngine/functions/replicatePodmanContainer",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Function: removePod()",permalink:"/api/namespaces/containerEngine/functions/removePod"},next:{title:"Function: saveImage()",permalink:"/api/namespaces/containerEngine/functions/saveImage"}},a={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Id",id:"id",level:3},{value:"Warnings",id:"warnings",level:3},{value:"Source",id:"source",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",p:"p",strong:"strong",...(0,i.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"function-replicatepodmancontainer",children:"Function: replicatePodmanContainer()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"replicatePodmanContainer"}),"(",(0,s.jsx)(n.code,{children:"source"}),", ",(0,s.jsx)(n.code,{children:"target"}),", ",(0,s.jsx)(n.code,{children:"overrideParameters"}),"): ",(0,s.jsx)(n.code,{children:"Promise"}),"< ",(0,s.jsx)(n.code,{children:"object"})," >"]}),"\n"]}),"\n",(0,s.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"source"})]}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"source.engineId"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"source.id"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"target"})]}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"target.engineId"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"overrideParameters"}),": ",(0,s.jsx)(n.a,{href:"/api/interfaces/PodmanContainerCreateOptions",children:(0,s.jsx)(n.code,{children:"PodmanContainerCreateOptions"})})]}),"\n",(0,s.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"Promise"}),"< ",(0,s.jsx)(n.code,{children:"object"})," >"]}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsx)(n.h3,{id:"id",children:"Id"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Id"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h3,{id:"warnings",children:"Warnings"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Warnings"}),": ",(0,s.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n"]}),"\n",(0,s.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L3375",children:"packages/extension-api/src/extension-api.d.ts:3375"})})]})}function p(e={}){const{wrapper:n}={...(0,i.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},71670:(e,n,r)=>{r.d(n,{Z:()=>o,a:()=>c});var s=r(27378);const i={},t=s.createContext(i);function c(e){const n=s.useContext(t);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:c(e.components),s.createElement(t.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[98170],{23989:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>a,contentTitle:()=>c,default:()=>p,frontMatter:()=>t,metadata:()=>o,toc:()=>d});var s=r(24246),i=r(71670);const t={},c="Function: replicatePodmanContainer()",o={id:"namespaces/containerEngine/functions/replicatePodmanContainer",title:"Function: replicatePodmanContainer()",description:"replicatePodmanContainer(source, target, overrideParameters): Promise\\",source:"@site/api/namespaces/containerEngine/functions/replicatePodmanContainer.md",sourceDirName:"namespaces/containerEngine/functions",slug:"/namespaces/containerEngine/functions/replicatePodmanContainer",permalink:"/api/namespaces/containerEngine/functions/replicatePodmanContainer",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Function: removePod()",permalink:"/api/namespaces/containerEngine/functions/removePod"},next:{title:"Function: saveImage()",permalink:"/api/namespaces/containerEngine/functions/saveImage"}},a={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Id",id:"id",level:3},{value:"Warnings",id:"warnings",level:3},{value:"Source",id:"source",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",p:"p",strong:"strong",...(0,i.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"function-replicatepodmancontainer",children:"Function: replicatePodmanContainer()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"replicatePodmanContainer"}),"(",(0,s.jsx)(n.code,{children:"source"}),", ",(0,s.jsx)(n.code,{children:"target"}),", ",(0,s.jsx)(n.code,{children:"overrideParameters"}),"): ",(0,s.jsx)(n.code,{children:"Promise"}),"< ",(0,s.jsx)(n.code,{children:"object"})," >"]}),"\n"]}),"\n",(0,s.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"source"})]}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"source.engineId"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"source.id"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"target"})]}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"target.engineId"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"overrideParameters"}),": ",(0,s.jsx)(n.a,{href:"/api/interfaces/PodmanContainerCreateOptions",children:(0,s.jsx)(n.code,{children:"PodmanContainerCreateOptions"})})]}),"\n",(0,s.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"Promise"}),"< ",(0,s.jsx)(n.code,{children:"object"})," >"]}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsx)(n.h3,{id:"id",children:"Id"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Id"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h3,{id:"warnings",children:"Warnings"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Warnings"}),": ",(0,s.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n"]}),"\n",(0,s.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L3375",children:"packages/extension-api/src/extension-api.d.ts:3375"})})]})}function p(e={}){const{wrapper:n}={...(0,i.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},71670:(e,n,r)=>{r.d(n,{Z:()=>o,a:()=>c});var s=r(27378);const i={},t=s.createContext(i);function c(e){const n=s.useContext(t);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:c(e.components),s.createElement(t.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/bb6a5560.7930735c.js b/assets/js/bb6a5560.1a8d7e23.js similarity index 97% rename from assets/js/bb6a5560.7930735c.js rename to assets/js/bb6a5560.1a8d7e23.js index e40f2bf6b33..e97b52b95e3 100644 --- a/assets/js/bb6a5560.7930735c.js +++ b/assets/js/bb6a5560.1a8d7e23.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[2883],{17275:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>i,default:()=>u,frontMatter:()=>r,metadata:()=>c,toc:()=>d});var s=t(24246),o=t(71670);const r={},i="Function: getProxySettings()",c={id:"namespaces/proxy/functions/getProxySettings",title:"Function: getProxySettings()",description:"getProxySettings(): ProxySettings \\| undefined",source:"@site/api/namespaces/proxy/functions/getProxySettings.md",sourceDirName:"namespaces/proxy/functions",slug:"/namespaces/proxy/functions/getProxySettings",permalink:"/api/namespaces/proxy/functions/getProxySettings",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Namespace: proxy",permalink:"/api/namespaces/proxy/"},next:{title:"Function: isEnabled()",permalink:"/api/namespaces/proxy/functions/isEnabled"}},a={},d=[{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function p(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,o.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"function-getproxysettings",children:"Function: getProxySettings()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"getProxySettings"}),"(): ",(0,s.jsx)(n.a,{href:"/api/interfaces/ProxySettings",children:(0,s.jsx)(n.code,{children:"ProxySettings"})})," | ",(0,s.jsx)(n.code,{children:"undefined"})]}),"\n"]}),"\n",(0,s.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.a,{href:"/api/interfaces/ProxySettings",children:(0,s.jsx)(n.code,{children:"ProxySettings"})})," | ",(0,s.jsx)(n.code,{children:"undefined"})]}),"\n",(0,s.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L574",children:"packages/extension-api/src/extension-api.d.ts:574"})})]})}function u(e={}){const{wrapper:n}={...(0,o.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(p,{...e})}):p(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>c,a:()=>i});var s=t(27378);const o={},r=s.createContext(o);function i(e){const n=s.useContext(r);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:i(e.components),s.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[2883],{17275:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>i,default:()=>u,frontMatter:()=>r,metadata:()=>c,toc:()=>d});var s=t(24246),o=t(71670);const r={},i="Function: getProxySettings()",c={id:"namespaces/proxy/functions/getProxySettings",title:"Function: getProxySettings()",description:"getProxySettings(): ProxySettings \\| undefined",source:"@site/api/namespaces/proxy/functions/getProxySettings.md",sourceDirName:"namespaces/proxy/functions",slug:"/namespaces/proxy/functions/getProxySettings",permalink:"/api/namespaces/proxy/functions/getProxySettings",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Namespace: proxy",permalink:"/api/namespaces/proxy/"},next:{title:"Function: isEnabled()",permalink:"/api/namespaces/proxy/functions/isEnabled"}},a={},d=[{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function p(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,o.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"function-getproxysettings",children:"Function: getProxySettings()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"getProxySettings"}),"(): ",(0,s.jsx)(n.a,{href:"/api/interfaces/ProxySettings",children:(0,s.jsx)(n.code,{children:"ProxySettings"})})," | ",(0,s.jsx)(n.code,{children:"undefined"})]}),"\n"]}),"\n",(0,s.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.a,{href:"/api/interfaces/ProxySettings",children:(0,s.jsx)(n.code,{children:"ProxySettings"})})," | ",(0,s.jsx)(n.code,{children:"undefined"})]}),"\n",(0,s.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L574",children:"packages/extension-api/src/extension-api.d.ts:574"})})]})}function u(e={}){const{wrapper:n}={...(0,o.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(p,{...e})}):p(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>c,a:()=>i});var s=t(27378);const o={},r=s.createContext(o);function i(e){const n=s.useContext(r);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:i(e.components),s.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/bd45720e.a98de0bc.js b/assets/js/bd45720e.9b75822c.js similarity index 84% rename from assets/js/bd45720e.a98de0bc.js rename to assets/js/bd45720e.9b75822c.js index ff0ed71fbe3..e6288ae1965 100644 --- a/assets/js/bd45720e.a98de0bc.js +++ b/assets/js/bd45720e.9b75822c.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[13239],{31729:(n,e,t)=>{t.r(e),t.d(e,{assets:()=>r,contentTitle:()=>s,default:()=>l,frontMatter:()=>o,metadata:()=>c,toc:()=>d});var i=t(24246),a=t(71670);const o={},s="Function: navigateToContainer()",c={id:"namespaces/navigation/functions/navigateToContainer",title:"Function: navigateToContainer()",description:"navigateToContainer(id): Promise\\",source:"@site/api/namespaces/navigation/functions/navigateToContainer.md",sourceDirName:"namespaces/navigation/functions",slug:"/namespaces/navigation/functions/navigateToContainer",permalink:"/api/namespaces/navigation/functions/navigateToContainer",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Function: navigateToAuthentication()",permalink:"/api/namespaces/navigation/functions/navigateToAuthentication"},next:{title:"Function: navigateToContainerInspect()",permalink:"/api/namespaces/navigation/functions/navigateToContainerInspect"}},r={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function u(n){const e={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,a.a)(),...n.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(e.h1,{id:"function-navigatetocontainer",children:"Function: navigateToContainer()"}),"\n",(0,i.jsxs)(e.blockquote,{children:["\n",(0,i.jsxs)(e.p,{children:[(0,i.jsx)(e.strong,{children:"navigateToContainer"}),"(",(0,i.jsx)(e.code,{children:"id"}),"): ",(0,i.jsx)(e.code,{children:"Promise"}),"< ",(0,i.jsx)(e.code,{children:"void"})," >"]}),"\n"]}),"\n",(0,i.jsx)(e.h2,{id:"parameters",children:"Parameters"}),"\n",(0,i.jsxs)(e.p,{children:["\u2022 ",(0,i.jsx)(e.strong,{children:"id"}),": ",(0,i.jsx)(e.code,{children:"string"})]}),"\n",(0,i.jsx)(e.h2,{id:"returns",children:"Returns"}),"\n",(0,i.jsxs)(e.p,{children:[(0,i.jsx)(e.code,{children:"Promise"}),"< ",(0,i.jsx)(e.code,{children:"void"})," >"]}),"\n",(0,i.jsx)(e.h2,{id:"source",children:"Source"}),"\n",(0,i.jsx)(e.p,{children:(0,i.jsx)(e.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L4144",children:"packages/extension-api/src/extension-api.d.ts:4144"})})]})}function l(n={}){const{wrapper:e}={...(0,a.a)(),...n.components};return e?(0,i.jsx)(e,{...n,children:(0,i.jsx)(u,{...n})}):u(n)}},71670:(n,e,t)=>{t.d(e,{Z:()=>c,a:()=>s});var i=t(27378);const a={},o=i.createContext(a);function s(n){const e=i.useContext(o);return i.useMemo((function(){return"function"==typeof n?n(e):{...e,...n}}),[e,n])}function c(n){let e;return e=n.disableParentContext?"function"==typeof n.components?n.components(a):n.components||a:s(n.components),i.createElement(o.Provider,{value:e},n.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[13239],{31729:(n,e,t)=>{t.r(e),t.d(e,{assets:()=>c,contentTitle:()=>s,default:()=>l,frontMatter:()=>o,metadata:()=>r,toc:()=>d});var i=t(24246),a=t(71670);const o={},s="Function: navigateToContainer()",r={id:"namespaces/navigation/functions/navigateToContainer",title:"Function: navigateToContainer()",description:"navigateToContainer(id): Promise\\",source:"@site/api/namespaces/navigation/functions/navigateToContainer.md",sourceDirName:"namespaces/navigation/functions",slug:"/namespaces/navigation/functions/navigateToContainer",permalink:"/api/namespaces/navigation/functions/navigateToContainer",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Function: navigateToAuthentication()",permalink:"/api/namespaces/navigation/functions/navigateToAuthentication"},next:{title:"Function: navigateToContainerInspect()",permalink:"/api/namespaces/navigation/functions/navigateToContainerInspect"}},c={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function u(n){const e={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,a.a)(),...n.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(e.h1,{id:"function-navigatetocontainer",children:"Function: navigateToContainer()"}),"\n",(0,i.jsxs)(e.blockquote,{children:["\n",(0,i.jsxs)(e.p,{children:[(0,i.jsx)(e.strong,{children:"navigateToContainer"}),"(",(0,i.jsx)(e.code,{children:"id"}),"): ",(0,i.jsx)(e.code,{children:"Promise"}),"< ",(0,i.jsx)(e.code,{children:"void"})," >"]}),"\n"]}),"\n",(0,i.jsx)(e.h2,{id:"parameters",children:"Parameters"}),"\n",(0,i.jsxs)(e.p,{children:["\u2022 ",(0,i.jsx)(e.strong,{children:"id"}),": ",(0,i.jsx)(e.code,{children:"string"})]}),"\n",(0,i.jsx)(e.h2,{id:"returns",children:"Returns"}),"\n",(0,i.jsxs)(e.p,{children:[(0,i.jsx)(e.code,{children:"Promise"}),"< ",(0,i.jsx)(e.code,{children:"void"})," >"]}),"\n",(0,i.jsx)(e.h2,{id:"source",children:"Source"}),"\n",(0,i.jsx)(e.p,{children:(0,i.jsx)(e.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L4144",children:"packages/extension-api/src/extension-api.d.ts:4144"})})]})}function l(n={}){const{wrapper:e}={...(0,a.a)(),...n.components};return e?(0,i.jsx)(e,{...n,children:(0,i.jsx)(u,{...n})}):u(n)}},71670:(n,e,t)=>{t.d(e,{Z:()=>r,a:()=>s});var i=t(27378);const a={},o=i.createContext(a);function s(n){const e=i.useContext(o);return i.useMemo((function(){return"function"==typeof n?n(e):{...e,...n}}),[e,n])}function r(n){let e;return e=n.disableParentContext?"function"==typeof n.components?n.components(a):n.components||a:s(n.components),i.createElement(o.Provider,{value:e},n.children)}}}]); \ No newline at end of file diff --git a/assets/js/bd65ec7e.3ce21ab1.js b/assets/js/bd65ec7e.964a9392.js similarity index 96% rename from assets/js/bd65ec7e.3ce21ab1.js rename to assets/js/bd65ec7e.964a9392.js index bb15a3c1a73..d0f177b004d 100644 --- a/assets/js/bd65ec7e.3ce21ab1.js +++ b/assets/js/bd65ec7e.964a9392.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[41798],{34224:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>a,contentTitle:()=>o,default:()=>l,frontMatter:()=>c,metadata:()=>i,toc:()=>u});var t=s(24246),r=s(71670);const c={},o="Function: createResources()",i={id:"namespaces/kubernetes/functions/createResources",title:"Function: createResources()",description:"createResources(context, manifests): Promise\\",source:"@site/api/namespaces/kubernetes/functions/createResources.md",sourceDirName:"namespaces/kubernetes/functions",slug:"/namespaces/kubernetes/functions/createResources",permalink:"/api/namespaces/kubernetes/functions/createResources",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Namespace: kubernetes",permalink:"/api/namespaces/kubernetes/"},next:{title:"Function: getKubeconfig()",permalink:"/api/namespaces/kubernetes/functions/getKubeconfig"}},a={},u=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function d(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,r.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"function-createresources",children:"Function: createResources()"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"createResources"}),"(",(0,t.jsx)(n.code,{children:"context"}),", ",(0,t.jsx)(n.code,{children:"manifests"}),"): ",(0,t.jsx)(n.code,{children:"Promise"}),"< ",(0,t.jsx)(n.code,{children:"void"})," >"]}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"Create one or several Kubernetes resources on the Kubernetes contenxt."}),"\n",(0,t.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"context"}),": ",(0,t.jsx)(n.code,{children:"string"})]}),"\n",(0,t.jsx)(n.p,{children:"the Kubernetes context to use"}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"manifests"}),": ",(0,t.jsx)(n.code,{children:"unknown"}),"[]"]}),"\n",(0,t.jsx)(n.p,{children:"the manifests to create as JSON objects"}),"\n",(0,t.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"Promise"}),"< ",(0,t.jsx)(n.code,{children:"void"})," >"]}),"\n",(0,t.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L1812",children:"packages/extension-api/src/extension-api.d.ts:1812"})})]})}function l(e={}){const{wrapper:n}={...(0,r.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(d,{...e})}):d(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>i,a:()=>o});var t=s(27378);const r={},c=t.createContext(r);function o(e){const n=t.useContext(c);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function i(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:o(e.components),t.createElement(c.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[41798],{34224:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>a,contentTitle:()=>o,default:()=>l,frontMatter:()=>c,metadata:()=>i,toc:()=>u});var t=s(24246),r=s(71670);const c={},o="Function: createResources()",i={id:"namespaces/kubernetes/functions/createResources",title:"Function: createResources()",description:"createResources(context, manifests): Promise\\",source:"@site/api/namespaces/kubernetes/functions/createResources.md",sourceDirName:"namespaces/kubernetes/functions",slug:"/namespaces/kubernetes/functions/createResources",permalink:"/api/namespaces/kubernetes/functions/createResources",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Namespace: kubernetes",permalink:"/api/namespaces/kubernetes/"},next:{title:"Function: getKubeconfig()",permalink:"/api/namespaces/kubernetes/functions/getKubeconfig"}},a={},u=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function d(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,r.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"function-createresources",children:"Function: createResources()"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"createResources"}),"(",(0,t.jsx)(n.code,{children:"context"}),", ",(0,t.jsx)(n.code,{children:"manifests"}),"): ",(0,t.jsx)(n.code,{children:"Promise"}),"< ",(0,t.jsx)(n.code,{children:"void"})," >"]}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"Create one or several Kubernetes resources on the Kubernetes contenxt."}),"\n",(0,t.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"context"}),": ",(0,t.jsx)(n.code,{children:"string"})]}),"\n",(0,t.jsx)(n.p,{children:"the Kubernetes context to use"}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"manifests"}),": ",(0,t.jsx)(n.code,{children:"unknown"}),"[]"]}),"\n",(0,t.jsx)(n.p,{children:"the manifests to create as JSON objects"}),"\n",(0,t.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"Promise"}),"< ",(0,t.jsx)(n.code,{children:"void"})," >"]}),"\n",(0,t.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L1812",children:"packages/extension-api/src/extension-api.d.ts:1812"})})]})}function l(e={}){const{wrapper:n}={...(0,r.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(d,{...e})}):d(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>i,a:()=>o});var t=s(27378);const r={},c=t.createContext(r);function o(e){const n=t.useContext(c);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function i(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:o(e.components),t.createElement(c.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/bdb8b81b.c3486276.js b/assets/js/bdb8b81b.c7c6e5e2.js similarity index 83% rename from assets/js/bdb8b81b.c3486276.js rename to assets/js/bdb8b81b.c7c6e5e2.js index 56ddbadfe96..96af8b530df 100644 --- a/assets/js/bdb8b81b.c3486276.js +++ b/assets/js/bdb8b81b.c7c6e5e2.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[57549],{41761:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>c,default:()=>h,frontMatter:()=>i,metadata:()=>o,toc:()=>d});var s=t(24246),r=t(71670);const i={},c="Interface: StorageStats",o={id:"interfaces/StorageStats",title:"Interface: StorageStats",description:"Properties",source:"@site/api/interfaces/StorageStats.md",sourceDirName:"interfaces",slug:"/interfaces/StorageStats",permalink:"/api/interfaces/StorageStats",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: StatusBarItem",permalink:"/api/interfaces/StatusBarItem"},next:{title:"Interface: TelemetryLogger",permalink:"/api/interfaces/TelemetryLogger"}},a={},d=[{value:"Properties",id:"properties",level:2},{value:"read_count_normalized?",id:"read_count_normalized",level:3},{value:"Source",id:"source",level:4},{value:"read_size_bytes?",id:"read_size_bytes",level:3},{value:"Source",id:"source-1",level:4},{value:"write_count_normalized?",id:"write_count_normalized",level:3},{value:"Source",id:"source-2",level:4},{value:"write_size_bytes?",id:"write_size_bytes",level:3},{value:"Source",id:"source-3",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,r.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"interface-storagestats",children:"Interface: StorageStats"}),"\n",(0,s.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,s.jsx)(n.h3,{id:"read_count_normalized",children:"read_count_normalized?"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:(0,s.jsx)(n.code,{children:"optional"})})," ",(0,s.jsx)(n.strong,{children:"read_count_normalized"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/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:"read_size_bytes",children:"read_size_bytes?"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:(0,s.jsx)(n.code,{children:"optional"})})," ",(0,s.jsx)(n.strong,{children:"read_size_bytes"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2783",children:"packages/extension-api/src/extension-api.d.ts:2783"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"write_count_normalized",children:"write_count_normalized?"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:(0,s.jsx)(n.code,{children:"optional"})})," ",(0,s.jsx)(n.strong,{children:"write_count_normalized"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2784",children:"packages/extension-api/src/extension-api.d.ts:2784"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"write_size_bytes",children:"write_size_bytes?"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:(0,s.jsx)(n.code,{children:"optional"})})," ",(0,s.jsx)(n.strong,{children:"write_size_bytes"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2785",children:"packages/extension-api/src/extension-api.d.ts:2785"})})]})}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,t)=>{t.d(n,{Z:()=>o,a:()=>c});var s=t(27378);const r={},i=s.createContext(r);function c(e){const n=s.useContext(i);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:c(e.components),s.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[57549],{41761:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>o,default:()=>h,frontMatter:()=>i,metadata:()=>c,toc:()=>d});var s=t(24246),r=t(71670);const i={},o="Interface: StorageStats",c={id:"interfaces/StorageStats",title:"Interface: StorageStats",description:"Properties",source:"@site/api/interfaces/StorageStats.md",sourceDirName:"interfaces",slug:"/interfaces/StorageStats",permalink:"/api/interfaces/StorageStats",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: StatusBarItem",permalink:"/api/interfaces/StatusBarItem"},next:{title:"Interface: TelemetryLogger",permalink:"/api/interfaces/TelemetryLogger"}},a={},d=[{value:"Properties",id:"properties",level:2},{value:"read_count_normalized?",id:"read_count_normalized",level:3},{value:"Source",id:"source",level:4},{value:"read_size_bytes?",id:"read_size_bytes",level:3},{value:"Source",id:"source-1",level:4},{value:"write_count_normalized?",id:"write_count_normalized",level:3},{value:"Source",id:"source-2",level:4},{value:"write_size_bytes?",id:"write_size_bytes",level:3},{value:"Source",id:"source-3",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,r.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"interface-storagestats",children:"Interface: StorageStats"}),"\n",(0,s.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,s.jsx)(n.h3,{id:"read_count_normalized",children:"read_count_normalized?"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:(0,s.jsx)(n.code,{children:"optional"})})," ",(0,s.jsx)(n.strong,{children:"read_count_normalized"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/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:"read_size_bytes",children:"read_size_bytes?"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:(0,s.jsx)(n.code,{children:"optional"})})," ",(0,s.jsx)(n.strong,{children:"read_size_bytes"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2783",children:"packages/extension-api/src/extension-api.d.ts:2783"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"write_count_normalized",children:"write_count_normalized?"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:(0,s.jsx)(n.code,{children:"optional"})})," ",(0,s.jsx)(n.strong,{children:"write_count_normalized"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2784",children:"packages/extension-api/src/extension-api.d.ts:2784"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"write_size_bytes",children:"write_size_bytes?"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:(0,s.jsx)(n.code,{children:"optional"})})," ",(0,s.jsx)(n.strong,{children:"write_size_bytes"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2785",children:"packages/extension-api/src/extension-api.d.ts:2785"})})]})}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,t)=>{t.d(n,{Z:()=>c,a:()=>o});var s=t(27378);const r={},i=s.createContext(r);function o(e){const n=s.useContext(i);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:o(e.components),s.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/be228752.327cc384.js b/assets/js/be228752.7692fe45.js similarity index 97% rename from assets/js/be228752.327cc384.js rename to assets/js/be228752.7692fe45.js index d05c2be2ec1..e228f03fa7c 100644 --- a/assets/js/be228752.327cc384.js +++ b/assets/js/be228752.7692fe45.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[13573],{6701:(n,e,t)=>{t.r(e),t.d(e,{assets:()=>r,contentTitle:()=>a,default:()=>u,frontMatter:()=>s,metadata:()=>c,toc:()=>d});var i=t(24246),o=t(71670);const s={},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:"Function: navigateToImages()",permalink:"/api/namespaces/navigation/functions/navigateToImages"},next:{title:"Function: navigateToPods()",permalink:"/api/namespaces/navigation/functions/navigateToPods"}},r={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function l(n){const e={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,o.a)(),...n.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(e.h1,{id:"function-navigatetopod",children:"Function: navigateToPod()"}),"\n",(0,i.jsxs)(e.blockquote,{children:["\n",(0,i.jsxs)(e.p,{children:[(0,i.jsx)(e.strong,{children:"navigateToPod"}),"(",(0,i.jsx)(e.code,{children:"kind"}),", ",(0,i.jsx)(e.code,{children:"name"}),", ",(0,i.jsx)(e.code,{children:"engineId"}),"): ",(0,i.jsx)(e.code,{children:"Promise"}),"< ",(0,i.jsx)(e.code,{children:"void"})," >"]}),"\n"]}),"\n",(0,i.jsx)(e.h2,{id:"parameters",children:"Parameters"}),"\n",(0,i.jsxs)(e.p,{children:["\u2022 ",(0,i.jsx)(e.strong,{children:"kind"}),": ",(0,i.jsx)(e.code,{children:"string"})]}),"\n",(0,i.jsxs)(e.p,{children:["\u2022 ",(0,i.jsx)(e.strong,{children:"name"}),": ",(0,i.jsx)(e.code,{children:"string"})]}),"\n",(0,i.jsxs)(e.p,{children:["\u2022 ",(0,i.jsx)(e.strong,{children:"engineId"}),": ",(0,i.jsx)(e.code,{children:"string"})]}),"\n",(0,i.jsx)(e.h2,{id:"returns",children:"Returns"}),"\n",(0,i.jsxs)(e.p,{children:[(0,i.jsx)(e.code,{children:"Promise"}),"< ",(0,i.jsx)(e.code,{children:"void"})," >"]}),"\n",(0,i.jsx)(e.h2,{id:"source",children:"Source"}),"\n",(0,i.jsx)(e.p,{children:(0,i.jsx)(e.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L4165",children:"packages/extension-api/src/extension-api.d.ts:4165"})})]})}function u(n={}){const{wrapper:e}={...(0,o.a)(),...n.components};return e?(0,i.jsx)(e,{...n,children:(0,i.jsx)(l,{...n})}):l(n)}},71670:(n,e,t)=>{t.d(e,{Z:()=>c,a:()=>a});var i=t(27378);const o={},s=i.createContext(o);function a(n){const e=i.useContext(s);return i.useMemo((function(){return"function"==typeof n?n(e):{...e,...n}}),[e,n])}function c(n){let e;return e=n.disableParentContext?"function"==typeof n.components?n.components(o):n.components||o:a(n.components),i.createElement(s.Provider,{value:e},n.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[13573],{6701:(n,e,t)=>{t.r(e),t.d(e,{assets:()=>r,contentTitle:()=>a,default:()=>u,frontMatter:()=>s,metadata:()=>c,toc:()=>d});var i=t(24246),o=t(71670);const s={},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:"Function: navigateToImages()",permalink:"/api/namespaces/navigation/functions/navigateToImages"},next:{title:"Function: navigateToPods()",permalink:"/api/namespaces/navigation/functions/navigateToPods"}},r={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function l(n){const e={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,o.a)(),...n.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(e.h1,{id:"function-navigatetopod",children:"Function: navigateToPod()"}),"\n",(0,i.jsxs)(e.blockquote,{children:["\n",(0,i.jsxs)(e.p,{children:[(0,i.jsx)(e.strong,{children:"navigateToPod"}),"(",(0,i.jsx)(e.code,{children:"kind"}),", ",(0,i.jsx)(e.code,{children:"name"}),", ",(0,i.jsx)(e.code,{children:"engineId"}),"): ",(0,i.jsx)(e.code,{children:"Promise"}),"< ",(0,i.jsx)(e.code,{children:"void"})," >"]}),"\n"]}),"\n",(0,i.jsx)(e.h2,{id:"parameters",children:"Parameters"}),"\n",(0,i.jsxs)(e.p,{children:["\u2022 ",(0,i.jsx)(e.strong,{children:"kind"}),": ",(0,i.jsx)(e.code,{children:"string"})]}),"\n",(0,i.jsxs)(e.p,{children:["\u2022 ",(0,i.jsx)(e.strong,{children:"name"}),": ",(0,i.jsx)(e.code,{children:"string"})]}),"\n",(0,i.jsxs)(e.p,{children:["\u2022 ",(0,i.jsx)(e.strong,{children:"engineId"}),": ",(0,i.jsx)(e.code,{children:"string"})]}),"\n",(0,i.jsx)(e.h2,{id:"returns",children:"Returns"}),"\n",(0,i.jsxs)(e.p,{children:[(0,i.jsx)(e.code,{children:"Promise"}),"< ",(0,i.jsx)(e.code,{children:"void"})," >"]}),"\n",(0,i.jsx)(e.h2,{id:"source",children:"Source"}),"\n",(0,i.jsx)(e.p,{children:(0,i.jsx)(e.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L4165",children:"packages/extension-api/src/extension-api.d.ts:4165"})})]})}function u(n={}){const{wrapper:e}={...(0,o.a)(),...n.components};return e?(0,i.jsx)(e,{...n,children:(0,i.jsx)(l,{...n})}):l(n)}},71670:(n,e,t)=>{t.d(e,{Z:()=>c,a:()=>a});var i=t(27378);const o={},s=i.createContext(o);function a(n){const e=i.useContext(s);return i.useMemo((function(){return"function"==typeof n?n(e):{...e,...n}}),[e,n])}function c(n){let e;return e=n.disableParentContext?"function"==typeof n.components?n.components(o):n.components||o:a(n.components),i.createElement(s.Provider,{value:e},n.children)}}}]); \ No newline at end of file diff --git a/assets/js/bf11c6a2.e6bd0392.js b/assets/js/bf11c6a2.32c6fa76.js similarity index 87% rename from assets/js/bf11c6a2.e6bd0392.js rename to assets/js/bf11c6a2.32c6fa76.js index f7bb830ac69..3628b187763 100644 --- a/assets/js/bf11c6a2.e6bd0392.js +++ b/assets/js/bf11c6a2.32c6fa76.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[75290],{65495:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>a,contentTitle:()=>c,default:()=>p,frontMatter:()=>t,metadata:()=>o,toc:()=>d});var r=s(24246),i=s(71670);const t={},c="Interface: RegistryCreateOptions",o={id:"interfaces/RegistryCreateOptions",title:"Interface: RegistryCreateOptions",description:"Extended by",source:"@site/api/interfaces/RegistryCreateOptions.md",sourceDirName:"interfaces",slug:"/interfaces/RegistryCreateOptions",permalink:"/api/interfaces/RegistryCreateOptions",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: RegistryConfig",permalink:"/api/interfaces/RegistryConfig"},next:{title:"Interface: RegistryProvider",permalink:"/api/interfaces/RegistryProvider"}},a={},d=[{value:"Extended by",id:"extended-by",level:2},{value:"Properties",id:"properties",level:2},{value:"insecure?",id:"insecure",level:3},{value:"Source",id:"source",level:4},{value:"secret",id:"secret",level:3},{value:"Source",id:"source-1",level:4},{value:"serverUrl",id:"serverurl",level:3},{value:"Source",id:"source-2",level:4},{value:"username",id:"username",level:3},{value:"Source",id:"source-3",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",li:"li",p:"p",strong:"strong",ul:"ul",...(0,i.a)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.h1,{id:"interface-registrycreateoptions",children:"Interface: RegistryCreateOptions"}),"\n",(0,r.jsx)(n.h2,{id:"extended-by",children:"Extended by"}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"/api/interfaces/Registry",children:(0,r.jsx)(n.code,{children:"Registry"})})}),"\n"]}),"\n",(0,r.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,r.jsx)(n.h3,{id:"insecure",children:"insecure?"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"optional"})})," ",(0,r.jsx)(n.strong,{children:"insecure"}),": ",(0,r.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L607",children:"packages/extension-api/src/extension-api.d.ts:607"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"secret",children:"secret"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"secret"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L606",children:"packages/extension-api/src/extension-api.d.ts:606"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"serverurl",children:"serverUrl"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"serverUrl"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L604",children:"packages/extension-api/src/extension-api.d.ts:604"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"username",children:"username"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"username"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L605",children:"packages/extension-api/src/extension-api.d.ts:605"})})]})}function p(e={}){const{wrapper:n}={...(0,i.a)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(l,{...e})}):l(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>o,a:()=>c});var r=s(27378);const i={},t=r.createContext(i);function c(e){const n=r.useContext(t);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:c(e.components),r.createElement(t.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[75290],{65495:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>d,contentTitle:()=>c,default:()=>p,frontMatter:()=>t,metadata:()=>o,toc:()=>a});var r=s(24246),i=s(71670);const t={},c="Interface: RegistryCreateOptions",o={id:"interfaces/RegistryCreateOptions",title:"Interface: RegistryCreateOptions",description:"Extended by",source:"@site/api/interfaces/RegistryCreateOptions.md",sourceDirName:"interfaces",slug:"/interfaces/RegistryCreateOptions",permalink:"/api/interfaces/RegistryCreateOptions",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: RegistryConfig",permalink:"/api/interfaces/RegistryConfig"},next:{title:"Interface: RegistryProvider",permalink:"/api/interfaces/RegistryProvider"}},d={},a=[{value:"Extended by",id:"extended-by",level:2},{value:"Properties",id:"properties",level:2},{value:"insecure?",id:"insecure",level:3},{value:"Source",id:"source",level:4},{value:"secret",id:"secret",level:3},{value:"Source",id:"source-1",level:4},{value:"serverUrl",id:"serverurl",level:3},{value:"Source",id:"source-2",level:4},{value:"username",id:"username",level:3},{value:"Source",id:"source-3",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",li:"li",p:"p",strong:"strong",ul:"ul",...(0,i.a)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.h1,{id:"interface-registrycreateoptions",children:"Interface: RegistryCreateOptions"}),"\n",(0,r.jsx)(n.h2,{id:"extended-by",children:"Extended by"}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"/api/interfaces/Registry",children:(0,r.jsx)(n.code,{children:"Registry"})})}),"\n"]}),"\n",(0,r.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,r.jsx)(n.h3,{id:"insecure",children:"insecure?"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"optional"})})," ",(0,r.jsx)(n.strong,{children:"insecure"}),": ",(0,r.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L607",children:"packages/extension-api/src/extension-api.d.ts:607"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"secret",children:"secret"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"secret"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L606",children:"packages/extension-api/src/extension-api.d.ts:606"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"serverurl",children:"serverUrl"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"serverUrl"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L604",children:"packages/extension-api/src/extension-api.d.ts:604"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"username",children:"username"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"username"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L605",children:"packages/extension-api/src/extension-api.d.ts:605"})})]})}function p(e={}){const{wrapper:n}={...(0,i.a)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(l,{...e})}):l(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>o,a:()=>c});var r=s(27378);const i={},t=r.createContext(i);function c(e){const n=r.useContext(t);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:c(e.components),r.createElement(t.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/c09ab32f.748c1836.js b/assets/js/c09ab32f.7151f8bf.js similarity index 94% rename from assets/js/c09ab32f.748c1836.js rename to assets/js/c09ab32f.7151f8bf.js index ecf842d6d31..8bd85ff931f 100644 --- a/assets/js/c09ab32f.748c1836.js +++ b/assets/js/c09ab32f.7151f8bf.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[29112],{88610:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>c,contentTitle:()=>i,default:()=>d,frontMatter:()=>r,metadata:()=>o,toc:()=>l});var a=n(24246),s=n(71670);const r={},i="Variable: StatusBarAlignLeft",o={id:"variables/StatusBarAlignLeft",title:"Variable: StatusBarAlignLeft",description:"const StatusBarAlignLeft: \"LEFT\" = 'LEFT'",source:"@site/api/variables/StatusBarAlignLeft.md",sourceDirName:"variables",slug:"/variables/StatusBarAlignLeft",permalink:"/api/variables/StatusBarAlignLeft",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Type alias: StatusBarAlignment",permalink:"/api/type-aliases/StatusBarAlignment"},next:{title:"Variable: StatusBarAlignRight",permalink:"/api/variables/StatusBarAlignRight"}},c={},l=[{value:"Source",id:"source",level:2}];function u(e){const t={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,a.jsxs)(a.Fragment,{children:[(0,a.jsx)(t.h1,{id:"variable-statusbaralignleft",children:"Variable: StatusBarAlignLeft"}),"\n",(0,a.jsxs)(t.blockquote,{children:["\n",(0,a.jsxs)(t.p,{children:[(0,a.jsx)(t.strong,{children:(0,a.jsx)(t.code,{children:"const"})})," ",(0,a.jsx)(t.strong,{children:"StatusBarAlignLeft"}),": ",(0,a.jsx)(t.code,{children:'"LEFT"'})," = ",(0,a.jsx)(t.code,{children:"'LEFT'"})]}),"\n"]}),"\n",(0,a.jsx)(t.p,{children:"Aligned to the left side."}),"\n",(0,a.jsx)(t.h2,{id:"source",children:"Source"}),"\n",(0,a.jsx)(t.p,{children:(0,a.jsx)(t.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L1182",children:"packages/extension-api/src/extension-api.d.ts:1182"})})]})}function d(e={}){const{wrapper:t}={...(0,s.a)(),...e.components};return t?(0,a.jsx)(t,{...e,children:(0,a.jsx)(u,{...e})}):u(e)}},71670:(e,t,n)=>{n.d(t,{Z:()=>o,a:()=>i});var a=n(27378);const s={},r=a.createContext(s);function i(e){const t=a.useContext(r);return a.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function o(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:i(e.components),a.createElement(r.Provider,{value:t},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[29112],{88610:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>c,contentTitle:()=>i,default:()=>d,frontMatter:()=>r,metadata:()=>o,toc:()=>l});var a=n(24246),s=n(71670);const r={},i="Variable: StatusBarAlignLeft",o={id:"variables/StatusBarAlignLeft",title:"Variable: StatusBarAlignLeft",description:"const StatusBarAlignLeft: \"LEFT\" = 'LEFT'",source:"@site/api/variables/StatusBarAlignLeft.md",sourceDirName:"variables",slug:"/variables/StatusBarAlignLeft",permalink:"/api/variables/StatusBarAlignLeft",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Type alias: StatusBarAlignment",permalink:"/api/type-aliases/StatusBarAlignment"},next:{title:"Variable: StatusBarAlignRight",permalink:"/api/variables/StatusBarAlignRight"}},c={},l=[{value:"Source",id:"source",level:2}];function u(e){const t={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,a.jsxs)(a.Fragment,{children:[(0,a.jsx)(t.h1,{id:"variable-statusbaralignleft",children:"Variable: StatusBarAlignLeft"}),"\n",(0,a.jsxs)(t.blockquote,{children:["\n",(0,a.jsxs)(t.p,{children:[(0,a.jsx)(t.strong,{children:(0,a.jsx)(t.code,{children:"const"})})," ",(0,a.jsx)(t.strong,{children:"StatusBarAlignLeft"}),": ",(0,a.jsx)(t.code,{children:'"LEFT"'})," = ",(0,a.jsx)(t.code,{children:"'LEFT'"})]}),"\n"]}),"\n",(0,a.jsx)(t.p,{children:"Aligned to the left side."}),"\n",(0,a.jsx)(t.h2,{id:"source",children:"Source"}),"\n",(0,a.jsx)(t.p,{children:(0,a.jsx)(t.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L1182",children:"packages/extension-api/src/extension-api.d.ts:1182"})})]})}function d(e={}){const{wrapper:t}={...(0,s.a)(),...e.components};return t?(0,a.jsx)(t,{...e,children:(0,a.jsx)(u,{...e})}):u(e)}},71670:(e,t,n)=>{n.d(t,{Z:()=>o,a:()=>i});var a=n(27378);const s={},r=a.createContext(s);function i(e){const t=a.useContext(r);return a.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function o(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:i(e.components),a.createElement(r.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/c104141c.0e10ecdc.js b/assets/js/c104141c.6dae7802.js similarity index 95% rename from assets/js/c104141c.0e10ecdc.js rename to assets/js/c104141c.6dae7802.js index fc65868107c..3fb464e233f 100644 --- a/assets/js/c104141c.0e10ecdc.js +++ b/assets/js/c104141c.6dae7802.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[26348],{10592:(e,t,r)=>{r.r(t),r.d(t,{assets:()=>c,contentTitle:()=>o,default:()=>h,frontMatter:()=>i,metadata:()=>a,toc:()=>d});var n=r(24246),s=r(71670);const i={},o="Interface: ProviderAutostart",a={id:"interfaces/ProviderAutostart",title:"Interface: ProviderAutostart",description:"By providing this interface, when Podman Desktop is starting",source:"@site/api/interfaces/ProviderAutostart.md",sourceDirName:"interfaces",slug:"/interfaces/ProviderAutostart",permalink:"/api/interfaces/ProviderAutostart",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: Provider",permalink:"/api/interfaces/Provider"},next:{title:"Interface: ProviderCleanup",permalink:"/api/interfaces/ProviderCleanup"}},c={},d=[{value:"Methods",id:"methods",level:2},{value:"start()",id:"start",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Source",id:"source",level:4}];function l(e){const t={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(t.h1,{id:"interface-providerautostart",children:"Interface: ProviderAutostart"}),"\n",(0,n.jsx)(t.p,{children:"By providing this interface, when Podman Desktop is starting\nIt'll start the provider through this interface.\nIt can be turned off/on by the user."}),"\n",(0,n.jsx)(t.h2,{id:"methods",children:"Methods"}),"\n",(0,n.jsx)(t.h3,{id:"start",children:"start()"}),"\n",(0,n.jsxs)(t.blockquote,{children:["\n",(0,n.jsxs)(t.p,{children:[(0,n.jsx)(t.strong,{children:"start"}),"(",(0,n.jsx)(t.code,{children:"logger"}),"): ",(0,n.jsx)(t.code,{children:"Promise"}),"< ",(0,n.jsx)(t.code,{children:"void"})," >"]}),"\n"]}),"\n",(0,n.jsx)(t.h4,{id:"parameters",children:"Parameters"}),"\n",(0,n.jsxs)(t.p,{children:["\u2022 ",(0,n.jsx)(t.strong,{children:"logger"}),": ",(0,n.jsx)(t.a,{href:"/api/interfaces/Logger",children:(0,n.jsx)(t.code,{children:"Logger"})})]}),"\n",(0,n.jsx)(t.h4,{id:"returns",children:"Returns"}),"\n",(0,n.jsxs)(t.p,{children:[(0,n.jsx)(t.code,{children:"Promise"}),"< ",(0,n.jsx)(t.code,{children:"void"})," >"]}),"\n",(0,n.jsx)(t.h4,{id:"source",children:"Source"}),"\n",(0,n.jsx)(t.p,{children:(0,n.jsx)(t.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L396",children:"packages/extension-api/src/extension-api.d.ts:396"})})]})}function h(e={}){const{wrapper:t}={...(0,s.a)(),...e.components};return t?(0,n.jsx)(t,{...e,children:(0,n.jsx)(l,{...e})}):l(e)}},71670:(e,t,r)=>{r.d(t,{Z:()=>a,a:()=>o});var n=r(27378);const s={},i=n.createContext(s);function o(e){const t=n.useContext(i);return n.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function a(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:o(e.components),n.createElement(i.Provider,{value:t},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[26348],{10592:(e,t,r)=>{r.r(t),r.d(t,{assets:()=>c,contentTitle:()=>o,default:()=>h,frontMatter:()=>i,metadata:()=>a,toc:()=>d});var n=r(24246),s=r(71670);const i={},o="Interface: ProviderAutostart",a={id:"interfaces/ProviderAutostart",title:"Interface: ProviderAutostart",description:"By providing this interface, when Podman Desktop is starting",source:"@site/api/interfaces/ProviderAutostart.md",sourceDirName:"interfaces",slug:"/interfaces/ProviderAutostart",permalink:"/api/interfaces/ProviderAutostart",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: Provider",permalink:"/api/interfaces/Provider"},next:{title:"Interface: ProviderCleanup",permalink:"/api/interfaces/ProviderCleanup"}},c={},d=[{value:"Methods",id:"methods",level:2},{value:"start()",id:"start",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Source",id:"source",level:4}];function l(e){const t={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(t.h1,{id:"interface-providerautostart",children:"Interface: ProviderAutostart"}),"\n",(0,n.jsx)(t.p,{children:"By providing this interface, when Podman Desktop is starting\nIt'll start the provider through this interface.\nIt can be turned off/on by the user."}),"\n",(0,n.jsx)(t.h2,{id:"methods",children:"Methods"}),"\n",(0,n.jsx)(t.h3,{id:"start",children:"start()"}),"\n",(0,n.jsxs)(t.blockquote,{children:["\n",(0,n.jsxs)(t.p,{children:[(0,n.jsx)(t.strong,{children:"start"}),"(",(0,n.jsx)(t.code,{children:"logger"}),"): ",(0,n.jsx)(t.code,{children:"Promise"}),"< ",(0,n.jsx)(t.code,{children:"void"})," >"]}),"\n"]}),"\n",(0,n.jsx)(t.h4,{id:"parameters",children:"Parameters"}),"\n",(0,n.jsxs)(t.p,{children:["\u2022 ",(0,n.jsx)(t.strong,{children:"logger"}),": ",(0,n.jsx)(t.a,{href:"/api/interfaces/Logger",children:(0,n.jsx)(t.code,{children:"Logger"})})]}),"\n",(0,n.jsx)(t.h4,{id:"returns",children:"Returns"}),"\n",(0,n.jsxs)(t.p,{children:[(0,n.jsx)(t.code,{children:"Promise"}),"< ",(0,n.jsx)(t.code,{children:"void"})," >"]}),"\n",(0,n.jsx)(t.h4,{id:"source",children:"Source"}),"\n",(0,n.jsx)(t.p,{children:(0,n.jsx)(t.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L396",children:"packages/extension-api/src/extension-api.d.ts:396"})})]})}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.0e9ba5ff.js b/assets/js/c1584a80.99228fe5.js similarity index 90% rename from assets/js/c1584a80.0e9ba5ff.js rename to assets/js/c1584a80.99228fe5.js index d3470a12313..2aabb8a82c0 100644 --- a/assets/js/c1584a80.0e9ba5ff.js +++ b/assets/js/c1584a80.99228fe5.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[19537],{89253:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>a,contentTitle:()=>c,default:()=>h,frontMatter:()=>i,metadata:()=>o,toc:()=>d});var s=r(24246),t=r(71670);const i={},c="Interface: Logger",o={id:"interfaces/Logger",title:"Interface: Logger",description:"Methods",source:"@site/api/interfaces/Logger.md",sourceDirName:"interfaces",slug:"/interfaces/Logger",permalink:"/api/interfaces/Logger",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: ListInfosOptions",permalink:"/api/interfaces/ListInfosOptions"},next:{title:"Interface: ManifestCreateOptions",permalink:"/api/interfaces/ManifestCreateOptions"}},a={},d=[{value:"Methods",id:"methods",level:2},{value:"error()",id:"error",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Source",id:"source",level:4},{value:"log()",id:"log",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Source",id:"source-1",level:4},{value:"warn()",id:"warn",level:3},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-2",level:4},{value:"Source",id:"source-2",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,t.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"interface-logger",children:"Interface: Logger"}),"\n",(0,s.jsx)(n.h2,{id:"methods",children:"Methods"}),"\n",(0,s.jsx)(n.h3,{id:"error",children:"error()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"error"}),"(...",(0,s.jsx)(n.code,{children:"data"}),"): ",(0,s.jsx)(n.code,{children:"void"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"parameters",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ...",(0,s.jsx)(n.strong,{children:"data"}),": ",(0,s.jsx)(n.code,{children:"any"}),"[]"]}),"\n",(0,s.jsx)(n.h4,{id:"returns",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"void"})}),"\n",(0,s.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L238",children:"packages/extension-api/src/extension-api.d.ts:238"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"log",children:"log()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"log"}),"(...",(0,s.jsx)(n.code,{children:"data"}),"): ",(0,s.jsx)(n.code,{children:"void"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"parameters-1",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ...",(0,s.jsx)(n.strong,{children:"data"}),": ",(0,s.jsx)(n.code,{children:"any"}),"[]"]}),"\n",(0,s.jsx)(n.h4,{id:"returns-1",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"void"})}),"\n",(0,s.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L236",children:"packages/extension-api/src/extension-api.d.ts:236"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"warn",children:"warn()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"warn"}),"(...",(0,s.jsx)(n.code,{children:"data"}),"): ",(0,s.jsx)(n.code,{children:"void"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"parameters-2",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ...",(0,s.jsx)(n.strong,{children:"data"}),": ",(0,s.jsx)(n.code,{children:"any"}),"[]"]}),"\n",(0,s.jsx)(n.h4,{id:"returns-2",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"void"})}),"\n",(0,s.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L240",children:"packages/extension-api/src/extension-api.d.ts:240"})})]})}function h(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},71670:(e,n,r)=>{r.d(n,{Z:()=>o,a:()=>c});var s=r(27378);const t={},i=s.createContext(t);function c(e){const n=s.useContext(i);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:c(e.components),s.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[19537],{89253:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>d,contentTitle:()=>c,default:()=>h,frontMatter:()=>i,metadata:()=>o,toc:()=>a});var s=r(24246),t=r(71670);const i={},c="Interface: Logger",o={id:"interfaces/Logger",title:"Interface: Logger",description:"Methods",source:"@site/api/interfaces/Logger.md",sourceDirName:"interfaces",slug:"/interfaces/Logger",permalink:"/api/interfaces/Logger",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: ListInfosOptions",permalink:"/api/interfaces/ListInfosOptions"},next:{title:"Interface: ManifestCreateOptions",permalink:"/api/interfaces/ManifestCreateOptions"}},d={},a=[{value:"Methods",id:"methods",level:2},{value:"error()",id:"error",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Source",id:"source",level:4},{value:"log()",id:"log",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Source",id:"source-1",level:4},{value:"warn()",id:"warn",level:3},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-2",level:4},{value:"Source",id:"source-2",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,t.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"interface-logger",children:"Interface: Logger"}),"\n",(0,s.jsx)(n.h2,{id:"methods",children:"Methods"}),"\n",(0,s.jsx)(n.h3,{id:"error",children:"error()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"error"}),"(...",(0,s.jsx)(n.code,{children:"data"}),"): ",(0,s.jsx)(n.code,{children:"void"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"parameters",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ...",(0,s.jsx)(n.strong,{children:"data"}),": ",(0,s.jsx)(n.code,{children:"any"}),"[]"]}),"\n",(0,s.jsx)(n.h4,{id:"returns",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"void"})}),"\n",(0,s.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L238",children:"packages/extension-api/src/extension-api.d.ts:238"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"log",children:"log()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"log"}),"(...",(0,s.jsx)(n.code,{children:"data"}),"): ",(0,s.jsx)(n.code,{children:"void"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"parameters-1",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ...",(0,s.jsx)(n.strong,{children:"data"}),": ",(0,s.jsx)(n.code,{children:"any"}),"[]"]}),"\n",(0,s.jsx)(n.h4,{id:"returns-1",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"void"})}),"\n",(0,s.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L236",children:"packages/extension-api/src/extension-api.d.ts:236"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"warn",children:"warn()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"warn"}),"(...",(0,s.jsx)(n.code,{children:"data"}),"): ",(0,s.jsx)(n.code,{children:"void"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"parameters-2",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ...",(0,s.jsx)(n.strong,{children:"data"}),": ",(0,s.jsx)(n.code,{children:"any"}),"[]"]}),"\n",(0,s.jsx)(n.h4,{id:"returns-2",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"void"})}),"\n",(0,s.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L240",children:"packages/extension-api/src/extension-api.d.ts:240"})})]})}function h(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},71670:(e,n,r)=>{r.d(n,{Z:()=>o,a:()=>c});var s=r(27378);const t={},i=s.createContext(t);function c(e){const n=s.useContext(i);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:c(e.components),s.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/c1ca9e21.ceb9c413.js b/assets/js/c1ca9e21.e5e26d6f.js similarity index 92% rename from assets/js/c1ca9e21.ceb9c413.js rename to assets/js/c1ca9e21.e5e26d6f.js index 44d330a5c4d..00bc94cd67d 100644 --- a/assets/js/c1ca9e21.ceb9c413.js +++ b/assets/js/c1ca9e21.e5e26d6f.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[17285],{74783:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>o,default:()=>p,frontMatter:()=>i,metadata:()=>s,toc:()=>d});var c=t(24246),r=t(71670);const i={},o="Interface: KubeconfigUpdateEvent",s={id:"interfaces/KubeconfigUpdateEvent",title:"Interface: KubeconfigUpdateEvent",description:"An event describing the update in kubeconfig location",source:"@site/api/interfaces/KubeconfigUpdateEvent.md",sourceDirName:"interfaces",slug:"/interfaces/KubeconfigUpdateEvent",permalink:"/api/interfaces/KubeconfigUpdateEvent",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: InstallCheck",permalink:"/api/interfaces/InstallCheck"},next:{title:"Interface: KubernetesGeneratorProvider",permalink:"/api/interfaces/KubernetesGeneratorProvider"}},a={},d=[{value:"Properties",id:"properties",level:2},{value:"location",id:"location",level:3},{value:"Source",id:"source",level:4},{value:"type",id:"type",level:3},{value:"Source",id:"source-1",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,r.a)(),...e.components};return(0,c.jsxs)(c.Fragment,{children:[(0,c.jsx)(n.h1,{id:"interface-kubeconfigupdateevent",children:"Interface: KubeconfigUpdateEvent"}),"\n",(0,c.jsx)(n.p,{children:"An event describing the update in kubeconfig location"}),"\n",(0,c.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,c.jsx)(n.h3,{id:"location",children:"location"}),"\n",(0,c.jsxs)(n.blockquote,{children:["\n",(0,c.jsxs)(n.p,{children:[(0,c.jsx)(n.strong,{children:(0,c.jsx)(n.code,{children:"readonly"})})," ",(0,c.jsx)(n.strong,{children:"location"}),": ",(0,c.jsx)(n.a,{href:"/api/classes/Uri",children:(0,c.jsx)(n.code,{children:"Uri"})})]}),"\n"]}),"\n",(0,c.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,c.jsx)(n.p,{children:(0,c.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L1826",children:"packages/extension-api/src/extension-api.d.ts:1826"})}),"\n",(0,c.jsx)(n.hr,{}),"\n",(0,c.jsx)(n.h3,{id:"type",children:"type"}),"\n",(0,c.jsxs)(n.blockquote,{children:["\n",(0,c.jsxs)(n.p,{children:[(0,c.jsx)(n.strong,{children:(0,c.jsx)(n.code,{children:"readonly"})})," ",(0,c.jsx)(n.strong,{children:"type"}),": ",(0,c.jsx)(n.code,{children:'"CREATE"'})," | ",(0,c.jsx)(n.code,{children:'"UPDATE"'})," | ",(0,c.jsx)(n.code,{children:'"DELETE"'})]}),"\n"]}),"\n",(0,c.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,c.jsx)(n.p,{children:(0,c.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L1825",children:"packages/extension-api/src/extension-api.d.ts:1825"})})]})}function p(e={}){const{wrapper:n}={...(0,r.a)(),...e.components};return n?(0,c.jsx)(n,{...e,children:(0,c.jsx)(l,{...e})}):l(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>s,a:()=>o});var c=t(27378);const r={},i=c.createContext(r);function o(e){const n=c.useContext(i);return c.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function s(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:o(e.components),c.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[17285],{74783:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>o,default:()=>p,frontMatter:()=>i,metadata:()=>s,toc:()=>d});var c=t(24246),r=t(71670);const i={},o="Interface: KubeconfigUpdateEvent",s={id:"interfaces/KubeconfigUpdateEvent",title:"Interface: KubeconfigUpdateEvent",description:"An event describing the update in kubeconfig location",source:"@site/api/interfaces/KubeconfigUpdateEvent.md",sourceDirName:"interfaces",slug:"/interfaces/KubeconfigUpdateEvent",permalink:"/api/interfaces/KubeconfigUpdateEvent",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: InstallCheck",permalink:"/api/interfaces/InstallCheck"},next:{title:"Interface: KubernetesGeneratorProvider",permalink:"/api/interfaces/KubernetesGeneratorProvider"}},a={},d=[{value:"Properties",id:"properties",level:2},{value:"location",id:"location",level:3},{value:"Source",id:"source",level:4},{value:"type",id:"type",level:3},{value:"Source",id:"source-1",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,r.a)(),...e.components};return(0,c.jsxs)(c.Fragment,{children:[(0,c.jsx)(n.h1,{id:"interface-kubeconfigupdateevent",children:"Interface: KubeconfigUpdateEvent"}),"\n",(0,c.jsx)(n.p,{children:"An event describing the update in kubeconfig location"}),"\n",(0,c.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,c.jsx)(n.h3,{id:"location",children:"location"}),"\n",(0,c.jsxs)(n.blockquote,{children:["\n",(0,c.jsxs)(n.p,{children:[(0,c.jsx)(n.strong,{children:(0,c.jsx)(n.code,{children:"readonly"})})," ",(0,c.jsx)(n.strong,{children:"location"}),": ",(0,c.jsx)(n.a,{href:"/api/classes/Uri",children:(0,c.jsx)(n.code,{children:"Uri"})})]}),"\n"]}),"\n",(0,c.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,c.jsx)(n.p,{children:(0,c.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L1826",children:"packages/extension-api/src/extension-api.d.ts:1826"})}),"\n",(0,c.jsx)(n.hr,{}),"\n",(0,c.jsx)(n.h3,{id:"type",children:"type"}),"\n",(0,c.jsxs)(n.blockquote,{children:["\n",(0,c.jsxs)(n.p,{children:[(0,c.jsx)(n.strong,{children:(0,c.jsx)(n.code,{children:"readonly"})})," ",(0,c.jsx)(n.strong,{children:"type"}),": ",(0,c.jsx)(n.code,{children:'"CREATE"'})," | ",(0,c.jsx)(n.code,{children:'"UPDATE"'})," | ",(0,c.jsx)(n.code,{children:'"DELETE"'})]}),"\n"]}),"\n",(0,c.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,c.jsx)(n.p,{children:(0,c.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L1825",children:"packages/extension-api/src/extension-api.d.ts:1825"})})]})}function p(e={}){const{wrapper:n}={...(0,r.a)(),...e.components};return n?(0,c.jsx)(n,{...e,children:(0,c.jsx)(l,{...e})}):l(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>s,a:()=>o});var c=t(27378);const r={},i=c.createContext(r);function o(e){const n=c.useContext(i);return c.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function s(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:o(e.components),c.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/c239db97.73bc5659.js b/assets/js/c239db97.ccd7100d.js similarity index 84% rename from assets/js/c239db97.73bc5659.js rename to assets/js/c239db97.ccd7100d.js index 47068fd3da6..134174ea45e 100644 --- a/assets/js/c239db97.73bc5659.js +++ b/assets/js/c239db97.ccd7100d.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[62789],{95783:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>o,contentTitle:()=>c,default:()=>h,frontMatter:()=>a,metadata:()=>r,toc:()=>d});var s=i(24246),t=i(71670);const a={},c="Function: saveImage()",r={id:"namespaces/containerEngine/functions/saveImage",title:"Function: saveImage()",description:"saveImage(engineId, id, filename): Promise\\",source:"@site/api/namespaces/containerEngine/functions/saveImage.md",sourceDirName:"namespaces/containerEngine/functions",slug:"/namespaces/containerEngine/functions/saveImage",permalink:"/api/namespaces/containerEngine/functions/saveImage",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Function: replicatePodmanContainer()",permalink:"/api/namespaces/containerEngine/functions/replicatePodmanContainer"},next:{title:"Function: startContainer()",permalink:"/api/namespaces/containerEngine/functions/startContainer"}},o={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,t.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"function-saveimage",children:"Function: saveImage()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"saveImage"}),"(",(0,s.jsx)(n.code,{children:"engineId"}),", ",(0,s.jsx)(n.code,{children:"id"}),", ",(0,s.jsx)(n.code,{children:"filename"}),"): ",(0,s.jsx)(n.code,{children:"Promise"}),"< ",(0,s.jsx)(n.code,{children:"void"})," >"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Save on disk a tarball containing the image and its metadata."}),"\n",(0,s.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"engineId"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n",(0,s.jsxs)(n.p,{children:["the id of the engine managing the image, obtained from the result of ",(0,s.jsx)(n.a,{href:"/api/namespaces/containerEngine/functions/listImages",children:"containerEngine.listImages"})]}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"id"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n",(0,s.jsxs)(n.p,{children:["the id or name of the image on this engine, obtained from the result of ",(0,s.jsx)(n.a,{href:"/api/namespaces/containerEngine/functions/listImages",children:"containerEngine.listImages"})]}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"filename"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n",(0,s.jsx)(n.p,{children:"the file on which to save the container image content"}),"\n",(0,s.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"Promise"}),"< ",(0,s.jsx)(n.code,{children:"void"})," >"]}),"\n",(0,s.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L3264",children:"packages/extension-api/src/extension-api.d.ts:3264"})})]})}function h(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>r,a:()=>c});var s=i(27378);const t={},a=s.createContext(t);function c(e){const n=s.useContext(a);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function r(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:c(e.components),s.createElement(a.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[62789],{95783:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>o,contentTitle:()=>r,default:()=>h,frontMatter:()=>a,metadata:()=>c,toc:()=>d});var s=i(24246),t=i(71670);const a={},r="Function: saveImage()",c={id:"namespaces/containerEngine/functions/saveImage",title:"Function: saveImage()",description:"saveImage(engineId, id, filename): Promise\\",source:"@site/api/namespaces/containerEngine/functions/saveImage.md",sourceDirName:"namespaces/containerEngine/functions",slug:"/namespaces/containerEngine/functions/saveImage",permalink:"/api/namespaces/containerEngine/functions/saveImage",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Function: replicatePodmanContainer()",permalink:"/api/namespaces/containerEngine/functions/replicatePodmanContainer"},next:{title:"Function: startContainer()",permalink:"/api/namespaces/containerEngine/functions/startContainer"}},o={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,t.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"function-saveimage",children:"Function: saveImage()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"saveImage"}),"(",(0,s.jsx)(n.code,{children:"engineId"}),", ",(0,s.jsx)(n.code,{children:"id"}),", ",(0,s.jsx)(n.code,{children:"filename"}),"): ",(0,s.jsx)(n.code,{children:"Promise"}),"< ",(0,s.jsx)(n.code,{children:"void"})," >"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Save on disk a tarball containing the image and its metadata."}),"\n",(0,s.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"engineId"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n",(0,s.jsxs)(n.p,{children:["the id of the engine managing the image, obtained from the result of ",(0,s.jsx)(n.a,{href:"/api/namespaces/containerEngine/functions/listImages",children:"containerEngine.listImages"})]}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"id"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n",(0,s.jsxs)(n.p,{children:["the id or name of the image on this engine, obtained from the result of ",(0,s.jsx)(n.a,{href:"/api/namespaces/containerEngine/functions/listImages",children:"containerEngine.listImages"})]}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"filename"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n",(0,s.jsx)(n.p,{children:"the file on which to save the container image content"}),"\n",(0,s.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"Promise"}),"< ",(0,s.jsx)(n.code,{children:"void"})," >"]}),"\n",(0,s.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L3264",children:"packages/extension-api/src/extension-api.d.ts:3264"})})]})}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.948f1162.js b/assets/js/c25913f3.bc57616e.js similarity index 88% rename from assets/js/c25913f3.948f1162.js rename to assets/js/c25913f3.bc57616e.js index 32de8167c06..81dd81e1a95 100644 --- a/assets/js/c25913f3.948f1162.js +++ b/assets/js/c25913f3.bc57616e.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[16311],{4069:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>c,contentTitle:()=>r,default:()=>p,frontMatter:()=>o,metadata:()=>a,toc:()=>l});var s=t(24246),i=t(71670);const o={},r="Interface: InputBoxValidationMessage",a={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:"Interface: InputBoxOptions",permalink:"/api/interfaces/InputBoxOptions"},next:{title:"Interface: InstallCheck",permalink:"/api/interfaces/InstallCheck"}},c={},l=[{value:"Properties",id:"properties",level:2},{value:"message",id:"message",level:3},{value:"Source",id:"source",level:4},{value:"severity",id:"severity",level:3},{value:"Source",id:"source-1",level:4}];function d(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,i.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"interface-inputboxvalidationmessage",children:"Interface: InputBoxValidationMessage"}),"\n",(0,s.jsx)(n.p,{children:"Object to configure the behavior of the validation message."}),"\n",(0,s.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,s.jsx)(n.h3,{id:"message",children:"message"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:(0,s.jsx)(n.code,{children:"readonly"})})," ",(0,s.jsx)(n.strong,{children:"message"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The validation message to display."}),"\n",(0,s.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L824",children:"packages/extension-api/src/extension-api.d.ts:824"})}),"\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.strong,{children:(0,s.jsx)(n.code,{children:"readonly"})})," ",(0,s.jsx)(n.strong,{children:"severity"}),": ",(0,s.jsx)(n.a,{href:"/api/enumerations/InputBoxValidationSeverity",children:(0,s.jsx)(n.code,{children:"InputBoxValidationSeverity"})})]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:["The severity of the validation message.\nNOTE: When using ",(0,s.jsx)(n.code,{children:"InputBoxValidationSeverity.Error"}),", the user will not be allowed to accept (hit ENTER) the input.\n",(0,s.jsx)(n.code,{children:"Info"})," and ",(0,s.jsx)(n.code,{children:"Warning"})," will still allow the InputBox to accept the input."]}),"\n",(0,s.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L831",children:"packages/extension-api/src/extension-api.d.ts:831"})})]})}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:()=>a,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 a(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([[16311],{4069:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>c,contentTitle:()=>r,default:()=>p,frontMatter:()=>o,metadata:()=>a,toc:()=>d});var s=t(24246),i=t(71670);const o={},r="Interface: InputBoxValidationMessage",a={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:"Interface: InputBoxOptions",permalink:"/api/interfaces/InputBoxOptions"},next:{title:"Interface: InstallCheck",permalink:"/api/interfaces/InstallCheck"}},c={},d=[{value:"Properties",id:"properties",level:2},{value:"message",id:"message",level:3},{value:"Source",id:"source",level:4},{value:"severity",id:"severity",level:3},{value:"Source",id:"source-1",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,i.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"interface-inputboxvalidationmessage",children:"Interface: InputBoxValidationMessage"}),"\n",(0,s.jsx)(n.p,{children:"Object to configure the behavior of the validation message."}),"\n",(0,s.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,s.jsx)(n.h3,{id:"message",children:"message"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:(0,s.jsx)(n.code,{children:"readonly"})})," ",(0,s.jsx)(n.strong,{children:"message"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The validation message to display."}),"\n",(0,s.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L824",children:"packages/extension-api/src/extension-api.d.ts:824"})}),"\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.strong,{children:(0,s.jsx)(n.code,{children:"readonly"})})," ",(0,s.jsx)(n.strong,{children:"severity"}),": ",(0,s.jsx)(n.a,{href:"/api/enumerations/InputBoxValidationSeverity",children:(0,s.jsx)(n.code,{children:"InputBoxValidationSeverity"})})]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:["The severity of the validation message.\nNOTE: When using ",(0,s.jsx)(n.code,{children:"InputBoxValidationSeverity.Error"}),", the user will not be allowed to accept (hit ENTER) the input.\n",(0,s.jsx)(n.code,{children:"Info"})," and ",(0,s.jsx)(n.code,{children:"Warning"})," will still allow the InputBox to accept the input."]}),"\n",(0,s.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L831",children:"packages/extension-api/src/extension-api.d.ts:831"})})]})}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:()=>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 a(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/c2865a15.0372eac0.js b/assets/js/c2865a15.fed21e58.js similarity index 76% rename from assets/js/c2865a15.0372eac0.js rename to assets/js/c2865a15.fed21e58.js index b60eb8d84b9..5c91e8c920c 100644 --- a/assets/js/c2865a15.0372eac0.js +++ b/assets/js/c2865a15.fed21e58.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[93401],{39122:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>r,contentTitle:()=>i,default:()=>u,frontMatter:()=>a,metadata:()=>c,toc:()=>p});var o=n(24246),s=n(71670);const a={},i="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:"Type alias: MountPropagation",permalink:"/api/type-aliases/MountPropagation"},next:{title:"Type alias: NotificationType",permalink:"/api/type-aliases/NotificationType"}},r={},p=[{value:"Source",id:"source",level:2}];function l(e){const t={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(t.h1,{id:"type-alias-mounttype",children:"Type alias: MountType"}),"\n",(0,o.jsxs)(t.blockquote,{children:["\n",(0,o.jsxs)(t.p,{children:[(0,o.jsx)(t.strong,{children:"MountType"}),": ",(0,o.jsx)(t.code,{children:'"bind"'})," | ",(0,o.jsx)(t.code,{children:'"volume"'})," | ",(0,o.jsx)(t.code,{children:'"tmpfs"'})]}),"\n"]}),"\n",(0,o.jsx)(t.h2,{id:"source",children:"Source"}),"\n",(0,o.jsx)(t.p,{children:(0,o.jsx)(t.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2088",children:"packages/extension-api/src/extension-api.d.ts:2088"})})]})}function u(e={}){const{wrapper:t}={...(0,s.a)(),...e.components};return t?(0,o.jsx)(t,{...e,children:(0,o.jsx)(l,{...e})}):l(e)}},71670:(e,t,n)=>{n.d(t,{Z:()=>c,a:()=>i});var o=n(27378);const s={},a=o.createContext(s);function i(e){const t=o.useContext(a);return o.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function c(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:i(e.components),o.createElement(a.Provider,{value:t},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[93401],{39122:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>r,contentTitle:()=>a,default:()=>u,frontMatter:()=>i,metadata:()=>c,toc:()=>p});var o=n(24246),s=n(71670);const i={},a="Type alias: MountType",c={id:"type-aliases/MountType",title:"Type alias: MountType",description:'MountType: "bind" \\| "volume" \\| "tmpfs"',source:"@site/api/type-aliases/MountType.md",sourceDirName:"type-aliases",slug:"/type-aliases/MountType",permalink:"/api/type-aliases/MountType",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Type alias: MountPropagation",permalink:"/api/type-aliases/MountPropagation"},next:{title:"Type alias: NotificationType",permalink:"/api/type-aliases/NotificationType"}},r={},p=[{value:"Source",id:"source",level:2}];function l(e){const t={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(t.h1,{id:"type-alias-mounttype",children:"Type alias: MountType"}),"\n",(0,o.jsxs)(t.blockquote,{children:["\n",(0,o.jsxs)(t.p,{children:[(0,o.jsx)(t.strong,{children:"MountType"}),": ",(0,o.jsx)(t.code,{children:'"bind"'})," | ",(0,o.jsx)(t.code,{children:'"volume"'})," | ",(0,o.jsx)(t.code,{children:'"tmpfs"'})]}),"\n"]}),"\n",(0,o.jsx)(t.h2,{id:"source",children:"Source"}),"\n",(0,o.jsx)(t.p,{children:(0,o.jsx)(t.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2088",children:"packages/extension-api/src/extension-api.d.ts:2088"})})]})}function u(e={}){const{wrapper:t}={...(0,s.a)(),...e.components};return t?(0,o.jsx)(t,{...e,children:(0,o.jsx)(l,{...e})}):l(e)}},71670:(e,t,n)=>{n.d(t,{Z:()=>c,a:()=>a});var o=n(27378);const s={},i=o.createContext(s);function a(e){const t=o.useContext(i);return o.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function c(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:a(e.components),o.createElement(i.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/c358ebbc.1005b64f.js b/assets/js/c358ebbc.8906be27.js similarity index 94% rename from assets/js/c358ebbc.1005b64f.js rename to assets/js/c358ebbc.8906be27.js index cfcfb08b977..ea0a08cd575 100644 --- a/assets/js/c358ebbc.1005b64f.js +++ b/assets/js/c358ebbc.8906be27.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[27910],{1885:(e,s,n)=>{n.r(s),n.d(s,{assets:()=>a,contentTitle:()=>o,default:()=>l,frontMatter:()=>t,metadata:()=>c,toc:()=>d});var i=n(24246),r=n(71670);const t={},o="Interface: AuthenticationProvider",c={id:"interfaces/AuthenticationProvider",title:"Interface: AuthenticationProvider",description:"A provider for performing authentication to a service.",source:"@site/api/interfaces/AuthenticationProvider.md",sourceDirName:"interfaces",slug:"/interfaces/AuthenticationProvider",permalink:"/api/interfaces/AuthenticationProvider",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: AuthenticationGetSessionOptions",permalink:"/api/interfaces/AuthenticationGetSessionOptions"},next:{title:"Interface: AuthenticationProviderAuthenticationSessionsChangeEvent",permalink:"/api/interfaces/AuthenticationProviderAuthenticationSessionsChangeEvent"}},a={},d=[{value:"Properties",id:"properties",level:2},{value:"onDidChangeSessions",id:"ondidchangesessions",level:3},{value:"Source",id:"source",level:4},{value:"Methods",id:"methods",level:2},{value:"createSession()",id:"createsession",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Source",id:"source-1",level:4},{value:"getSessions()",id:"getsessions",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Source",id:"source-2",level:4},{value:"removeSession()",id:"removesession",level:3},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-2",level:4},{value:"Source",id:"source-3",level:4}];function h(e){const s={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,r.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(s.h1,{id:"interface-authenticationprovider",children:"Interface: AuthenticationProvider"}),"\n",(0,i.jsx)(s.p,{children:"A provider for performing authentication to a service."}),"\n",(0,i.jsx)(s.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(s.h3,{id:"ondidchangesessions",children:"onDidChangeSessions"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:(0,i.jsx)(s.code,{children:"readonly"})})," ",(0,i.jsx)(s.strong,{children:"onDidChangeSessions"}),": ",(0,i.jsx)(s.a,{href:"/api/interfaces/Event",children:(0,i.jsx)(s.code,{children:"Event"})}),"< ",(0,i.jsx)(s.a,{href:"/api/interfaces/AuthenticationProviderAuthenticationSessionsChangeEvent",children:(0,i.jsx)(s.code,{children:"AuthenticationProviderAuthenticationSessionsChangeEvent"})})," >"]}),"\n"]}),"\n",(0,i.jsxs)(s.p,{children:["An ",(0,i.jsx)(s.a,{href:"#Event",children:"event"})," which fires when the array of sessions has changed, or data\nwithin a session has changed."]}),"\n",(0,i.jsx)(s.h4,{id:"source",children:"Source"}),"\n",(0,i.jsx)(s.p,{children:(0,i.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L3553",children:"packages/extension-api/src/extension-api.d.ts:3553"})}),"\n",(0,i.jsx)(s.h2,{id:"methods",children:"Methods"}),"\n",(0,i.jsx)(s.h3,{id:"createsession",children:"createSession()"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"createSession"}),"(",(0,i.jsx)(s.code,{children:"scopes"}),"): ",(0,i.jsx)(s.code,{children:"Promise"}),"< ",(0,i.jsx)(s.a,{href:"/api/interfaces/AuthenticationSession",children:(0,i.jsx)(s.code,{children:"AuthenticationSession"})})," >"]}),"\n"]}),"\n",(0,i.jsx)(s.p,{children:"Prompts a user to login."}),"\n",(0,i.jsx)(s.p,{children:"If login is successful, the onDidChangeSessions event should be fired."}),"\n",(0,i.jsx)(s.p,{children:"If login fails, a rejected promise should be returned."}),"\n",(0,i.jsx)(s.p,{children:"If the provider has specified that it does not support multiple accounts,\nthen this should never be called if there is already an existing session matching these\nscopes."}),"\n",(0,i.jsx)(s.h4,{id:"parameters",children:"Parameters"}),"\n",(0,i.jsxs)(s.p,{children:["\u2022 ",(0,i.jsx)(s.strong,{children:"scopes"}),": ",(0,i.jsx)(s.code,{children:"string"}),"[]"]}),"\n",(0,i.jsx)(s.p,{children:"A list of scopes, permissions, that the new session should be created with."}),"\n",(0,i.jsx)(s.h4,{id:"returns",children:"Returns"}),"\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.code,{children:"Promise"}),"< ",(0,i.jsx)(s.a,{href:"/api/interfaces/AuthenticationSession",children:(0,i.jsx)(s.code,{children:"AuthenticationSession"})})," >"]}),"\n",(0,i.jsx)(s.p,{children:"A promise that resolves to an authentication session."}),"\n",(0,i.jsx)(s.h4,{id:"source-1",children:"Source"}),"\n",(0,i.jsx)(s.p,{children:(0,i.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L3576",children:"packages/extension-api/src/extension-api.d.ts:3576"})}),"\n",(0,i.jsx)(s.hr,{}),"\n",(0,i.jsx)(s.h3,{id:"getsessions",children:"getSessions()"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"getSessions"}),"(",(0,i.jsx)(s.code,{children:"scopes"}),"?): ",(0,i.jsx)(s.code,{children:"Promise"}),"< readonly ",(0,i.jsx)(s.a,{href:"/api/interfaces/AuthenticationSession",children:(0,i.jsx)(s.code,{children:"AuthenticationSession"})}),"[] >"]}),"\n"]}),"\n",(0,i.jsx)(s.p,{children:"Get a list of sessions."}),"\n",(0,i.jsx)(s.h4,{id:"parameters-1",children:"Parameters"}),"\n",(0,i.jsxs)(s.p,{children:["\u2022 ",(0,i.jsx)(s.strong,{children:"scopes?"}),": ",(0,i.jsx)(s.code,{children:"string"}),"[]"]}),"\n",(0,i.jsx)(s.p,{children:"An optional list of scopes. If provided, the sessions returned should match\nthese permissions, otherwise all sessions should be returned."}),"\n",(0,i.jsx)(s.h4,{id:"returns-1",children:"Returns"}),"\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.code,{children:"Promise"}),"< readonly ",(0,i.jsx)(s.a,{href:"/api/interfaces/AuthenticationSession",children:(0,i.jsx)(s.code,{children:"AuthenticationSession"})}),"[] >"]}),"\n",(0,i.jsx)(s.p,{children:"A promise that resolves to an array of authentication sessions."}),"\n",(0,i.jsx)(s.h4,{id:"source-2",children:"Source"}),"\n",(0,i.jsx)(s.p,{children:(0,i.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L3561",children:"packages/extension-api/src/extension-api.d.ts:3561"})}),"\n",(0,i.jsx)(s.hr,{}),"\n",(0,i.jsx)(s.h3,{id:"removesession",children:"removeSession()"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"removeSession"}),"(",(0,i.jsx)(s.code,{children:"sessionId"}),"): ",(0,i.jsx)(s.code,{children:"Promise"}),"< ",(0,i.jsx)(s.code,{children:"void"})," >"]}),"\n"]}),"\n",(0,i.jsx)(s.p,{children:"Removes the session corresponding to session id."}),"\n",(0,i.jsx)(s.p,{children:"If the removal is successful, the onDidChangeSessions event should be fired."}),"\n",(0,i.jsx)(s.p,{children:"If a session cannot be removed, the provider should reject with an error message."}),"\n",(0,i.jsx)(s.h4,{id:"parameters-2",children:"Parameters"}),"\n",(0,i.jsxs)(s.p,{children:["\u2022 ",(0,i.jsx)(s.strong,{children:"sessionId"}),": ",(0,i.jsx)(s.code,{children:"string"})]}),"\n",(0,i.jsx)(s.p,{children:"The id of the session to remove."}),"\n",(0,i.jsx)(s.h4,{id:"returns-2",children:"Returns"}),"\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.code,{children:"Promise"}),"< ",(0,i.jsx)(s.code,{children:"void"})," >"]}),"\n",(0,i.jsx)(s.h4,{id:"source-3",children:"Source"}),"\n",(0,i.jsx)(s.p,{children:(0,i.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L3586",children:"packages/extension-api/src/extension-api.d.ts:3586"})})]})}function l(e={}){const{wrapper:s}={...(0,r.a)(),...e.components};return s?(0,i.jsx)(s,{...e,children:(0,i.jsx)(h,{...e})}):h(e)}},71670:(e,s,n)=>{n.d(s,{Z:()=>c,a:()=>o});var i=n(27378);const r={},t=i.createContext(r);function o(e){const s=i.useContext(t);return i.useMemo((function(){return"function"==typeof e?e(s):{...s,...e}}),[s,e])}function c(e){let s;return s=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:o(e.components),i.createElement(t.Provider,{value:s},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[27910],{1885:(e,s,n)=>{n.r(s),n.d(s,{assets:()=>d,contentTitle:()=>o,default:()=>l,frontMatter:()=>t,metadata:()=>c,toc:()=>a});var i=n(24246),r=n(71670);const t={},o="Interface: AuthenticationProvider",c={id:"interfaces/AuthenticationProvider",title:"Interface: AuthenticationProvider",description:"A provider for performing authentication to a service.",source:"@site/api/interfaces/AuthenticationProvider.md",sourceDirName:"interfaces",slug:"/interfaces/AuthenticationProvider",permalink:"/api/interfaces/AuthenticationProvider",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: AuthenticationGetSessionOptions",permalink:"/api/interfaces/AuthenticationGetSessionOptions"},next:{title:"Interface: AuthenticationProviderAuthenticationSessionsChangeEvent",permalink:"/api/interfaces/AuthenticationProviderAuthenticationSessionsChangeEvent"}},d={},a=[{value:"Properties",id:"properties",level:2},{value:"onDidChangeSessions",id:"ondidchangesessions",level:3},{value:"Source",id:"source",level:4},{value:"Methods",id:"methods",level:2},{value:"createSession()",id:"createsession",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Source",id:"source-1",level:4},{value:"getSessions()",id:"getsessions",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Source",id:"source-2",level:4},{value:"removeSession()",id:"removesession",level:3},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-2",level:4},{value:"Source",id:"source-3",level:4}];function h(e){const s={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,r.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(s.h1,{id:"interface-authenticationprovider",children:"Interface: AuthenticationProvider"}),"\n",(0,i.jsx)(s.p,{children:"A provider for performing authentication to a service."}),"\n",(0,i.jsx)(s.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(s.h3,{id:"ondidchangesessions",children:"onDidChangeSessions"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:(0,i.jsx)(s.code,{children:"readonly"})})," ",(0,i.jsx)(s.strong,{children:"onDidChangeSessions"}),": ",(0,i.jsx)(s.a,{href:"/api/interfaces/Event",children:(0,i.jsx)(s.code,{children:"Event"})}),"< ",(0,i.jsx)(s.a,{href:"/api/interfaces/AuthenticationProviderAuthenticationSessionsChangeEvent",children:(0,i.jsx)(s.code,{children:"AuthenticationProviderAuthenticationSessionsChangeEvent"})})," >"]}),"\n"]}),"\n",(0,i.jsxs)(s.p,{children:["An ",(0,i.jsx)(s.a,{href:"#Event",children:"event"})," which fires when the array of sessions has changed, or data\nwithin a session has changed."]}),"\n",(0,i.jsx)(s.h4,{id:"source",children:"Source"}),"\n",(0,i.jsx)(s.p,{children:(0,i.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L3553",children:"packages/extension-api/src/extension-api.d.ts:3553"})}),"\n",(0,i.jsx)(s.h2,{id:"methods",children:"Methods"}),"\n",(0,i.jsx)(s.h3,{id:"createsession",children:"createSession()"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"createSession"}),"(",(0,i.jsx)(s.code,{children:"scopes"}),"): ",(0,i.jsx)(s.code,{children:"Promise"}),"< ",(0,i.jsx)(s.a,{href:"/api/interfaces/AuthenticationSession",children:(0,i.jsx)(s.code,{children:"AuthenticationSession"})})," >"]}),"\n"]}),"\n",(0,i.jsx)(s.p,{children:"Prompts a user to login."}),"\n",(0,i.jsx)(s.p,{children:"If login is successful, the onDidChangeSessions event should be fired."}),"\n",(0,i.jsx)(s.p,{children:"If login fails, a rejected promise should be returned."}),"\n",(0,i.jsx)(s.p,{children:"If the provider has specified that it does not support multiple accounts,\nthen this should never be called if there is already an existing session matching these\nscopes."}),"\n",(0,i.jsx)(s.h4,{id:"parameters",children:"Parameters"}),"\n",(0,i.jsxs)(s.p,{children:["\u2022 ",(0,i.jsx)(s.strong,{children:"scopes"}),": ",(0,i.jsx)(s.code,{children:"string"}),"[]"]}),"\n",(0,i.jsx)(s.p,{children:"A list of scopes, permissions, that the new session should be created with."}),"\n",(0,i.jsx)(s.h4,{id:"returns",children:"Returns"}),"\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.code,{children:"Promise"}),"< ",(0,i.jsx)(s.a,{href:"/api/interfaces/AuthenticationSession",children:(0,i.jsx)(s.code,{children:"AuthenticationSession"})})," >"]}),"\n",(0,i.jsx)(s.p,{children:"A promise that resolves to an authentication session."}),"\n",(0,i.jsx)(s.h4,{id:"source-1",children:"Source"}),"\n",(0,i.jsx)(s.p,{children:(0,i.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L3576",children:"packages/extension-api/src/extension-api.d.ts:3576"})}),"\n",(0,i.jsx)(s.hr,{}),"\n",(0,i.jsx)(s.h3,{id:"getsessions",children:"getSessions()"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"getSessions"}),"(",(0,i.jsx)(s.code,{children:"scopes"}),"?): ",(0,i.jsx)(s.code,{children:"Promise"}),"< readonly ",(0,i.jsx)(s.a,{href:"/api/interfaces/AuthenticationSession",children:(0,i.jsx)(s.code,{children:"AuthenticationSession"})}),"[] >"]}),"\n"]}),"\n",(0,i.jsx)(s.p,{children:"Get a list of sessions."}),"\n",(0,i.jsx)(s.h4,{id:"parameters-1",children:"Parameters"}),"\n",(0,i.jsxs)(s.p,{children:["\u2022 ",(0,i.jsx)(s.strong,{children:"scopes?"}),": ",(0,i.jsx)(s.code,{children:"string"}),"[]"]}),"\n",(0,i.jsx)(s.p,{children:"An optional list of scopes. If provided, the sessions returned should match\nthese permissions, otherwise all sessions should be returned."}),"\n",(0,i.jsx)(s.h4,{id:"returns-1",children:"Returns"}),"\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.code,{children:"Promise"}),"< readonly ",(0,i.jsx)(s.a,{href:"/api/interfaces/AuthenticationSession",children:(0,i.jsx)(s.code,{children:"AuthenticationSession"})}),"[] >"]}),"\n",(0,i.jsx)(s.p,{children:"A promise that resolves to an array of authentication sessions."}),"\n",(0,i.jsx)(s.h4,{id:"source-2",children:"Source"}),"\n",(0,i.jsx)(s.p,{children:(0,i.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L3561",children:"packages/extension-api/src/extension-api.d.ts:3561"})}),"\n",(0,i.jsx)(s.hr,{}),"\n",(0,i.jsx)(s.h3,{id:"removesession",children:"removeSession()"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"removeSession"}),"(",(0,i.jsx)(s.code,{children:"sessionId"}),"): ",(0,i.jsx)(s.code,{children:"Promise"}),"< ",(0,i.jsx)(s.code,{children:"void"})," >"]}),"\n"]}),"\n",(0,i.jsx)(s.p,{children:"Removes the session corresponding to session id."}),"\n",(0,i.jsx)(s.p,{children:"If the removal is successful, the onDidChangeSessions event should be fired."}),"\n",(0,i.jsx)(s.p,{children:"If a session cannot be removed, the provider should reject with an error message."}),"\n",(0,i.jsx)(s.h4,{id:"parameters-2",children:"Parameters"}),"\n",(0,i.jsxs)(s.p,{children:["\u2022 ",(0,i.jsx)(s.strong,{children:"sessionId"}),": ",(0,i.jsx)(s.code,{children:"string"})]}),"\n",(0,i.jsx)(s.p,{children:"The id of the session to remove."}),"\n",(0,i.jsx)(s.h4,{id:"returns-2",children:"Returns"}),"\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.code,{children:"Promise"}),"< ",(0,i.jsx)(s.code,{children:"void"})," >"]}),"\n",(0,i.jsx)(s.h4,{id:"source-3",children:"Source"}),"\n",(0,i.jsx)(s.p,{children:(0,i.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L3586",children:"packages/extension-api/src/extension-api.d.ts:3586"})})]})}function l(e={}){const{wrapper:s}={...(0,r.a)(),...e.components};return s?(0,i.jsx)(s,{...e,children:(0,i.jsx)(h,{...e})}):h(e)}},71670:(e,s,n)=>{n.d(s,{Z:()=>c,a:()=>o});var i=n(27378);const r={},t=i.createContext(r);function o(e){const s=i.useContext(t);return i.useMemo((function(){return"function"==typeof e?e(s):{...s,...e}}),[s,e])}function c(e){let s;return s=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:o(e.components),i.createElement(t.Provider,{value:s},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/c544b2d7.a0a4ae19.js b/assets/js/c544b2d7.fecd5a8d.js similarity index 88% rename from assets/js/c544b2d7.a0a4ae19.js rename to assets/js/c544b2d7.fecd5a8d.js index d97e3e9c859..43b084d4f85 100644 --- a/assets/js/c544b2d7.a0a4ae19.js +++ b/assets/js/c544b2d7.fecd5a8d.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[75689],{53683:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>c,contentTitle:()=>o,default:()=>p,frontMatter:()=>r,metadata:()=>a,toc:()=>l});var i=t(24246),s=t(71670);const r={},o="Interface: ListImagesOptions",a={id:"interfaces/ListImagesOptions",title:"Interface: ListImagesOptions",description:"Properties",source:"@site/api/interfaces/ListImagesOptions.md",sourceDirName:"interfaces",slug:"/interfaces/ListImagesOptions",permalink:"/api/interfaces/ListImagesOptions",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: Link",permalink:"/api/interfaces/Link"},next:{title:"Interface: ListInfosOptions",permalink:"/api/interfaces/ListInfosOptions"}},c={},l=[{value:"Properties",id:"properties",level:2},{value:"provider?",id:"provider",level:3},{value:"Default Value",id:"default-value",level:4},{value:"Source",id:"source",level:4}];function d(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",p:"p",pre:"pre",strong:"strong",...(0,s.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"interface-listimagesoptions",children:"Interface: ListImagesOptions"}),"\n",(0,i.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(n.h3,{id:"provider",children:"provider?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"provider"}),": ",(0,i.jsx)(n.a,{href:"/api/interfaces/ContainerProviderConnection",children:(0,i.jsx)(n.code,{children:"ContainerProviderConnection"})})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"The provider we want to list the images. If not provided, will return all container images across all container engines."}),"\n",(0,i.jsx)(n.h4,{id:"default-value",children:"Default Value"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-ts",children:"undefined\n"})}),"\n",(0,i.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L3042",children:"packages/extension-api/src/extension-api.d.ts:3042"})})]})}function p(e={}){const{wrapper:n}={...(0,s.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(d,{...e})}):d(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>a,a:()=>o});var i=t(27378);const s={},r=i.createContext(s);function o(e){const n=i.useContext(r);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function a(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:o(e.components),i.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[75689],{53683:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>c,contentTitle:()=>o,default:()=>p,frontMatter:()=>r,metadata:()=>a,toc:()=>d});var i=t(24246),s=t(71670);const r={},o="Interface: ListImagesOptions",a={id:"interfaces/ListImagesOptions",title:"Interface: ListImagesOptions",description:"Properties",source:"@site/api/interfaces/ListImagesOptions.md",sourceDirName:"interfaces",slug:"/interfaces/ListImagesOptions",permalink:"/api/interfaces/ListImagesOptions",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: Link",permalink:"/api/interfaces/Link"},next:{title:"Interface: ListInfosOptions",permalink:"/api/interfaces/ListInfosOptions"}},c={},d=[{value:"Properties",id:"properties",level:2},{value:"provider?",id:"provider",level:3},{value:"Default Value",id:"default-value",level:4},{value:"Source",id:"source",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",p:"p",pre:"pre",strong:"strong",...(0,s.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"interface-listimagesoptions",children:"Interface: ListImagesOptions"}),"\n",(0,i.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(n.h3,{id:"provider",children:"provider?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"provider"}),": ",(0,i.jsx)(n.a,{href:"/api/interfaces/ContainerProviderConnection",children:(0,i.jsx)(n.code,{children:"ContainerProviderConnection"})})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"The provider we want to list the images. If not provided, will return all container images across all container engines."}),"\n",(0,i.jsx)(n.h4,{id:"default-value",children:"Default Value"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-ts",children:"undefined\n"})}),"\n",(0,i.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L3042",children:"packages/extension-api/src/extension-api.d.ts:3042"})})]})}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.068bcd08.js b/assets/js/c7cac05f.4f3bb4ed.js similarity index 87% rename from assets/js/c7cac05f.068bcd08.js rename to assets/js/c7cac05f.4f3bb4ed.js index d796ddbf99b..e92f9673a8b 100644 --- a/assets/js/c7cac05f.068bcd08.js +++ b/assets/js/c7cac05f.4f3bb4ed.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[73867],{88517:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>l,contentTitle:()=>r,default:()=>p,frontMatter:()=>o,metadata:()=>c,toc:()=>a});var i=s(24246),t=s(71670);const o={},r="Interface: OpenDialogOptions",c={id:"interfaces/OpenDialogOptions",title:"Interface: OpenDialogOptions",description:"Options to configure the behaviour of a file open dialog.",source:"@site/api/interfaces/OpenDialogOptions.md",sourceDirName:"interfaces",slug:"/interfaces/OpenDialogOptions",permalink:"/api/interfaces/OpenDialogOptions",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: NotificationOptions",permalink:"/api/interfaces/NotificationOptions"},next:{title:"Interface: PidsStats",permalink:"/api/interfaces/PidsStats"}},l={},a=[{value:"Properties",id:"properties",level:2},{value:"defaultUri?",id:"defaulturi",level:3},{value:"Source",id:"source",level:4},{value:"filters?",id:"filters",level:3},{value:"Source",id:"source-1",level:4},{value:"openLabel?",id:"openlabel",level:3},{value:"Source",id:"source-2",level:4},{value:"selectors?",id:"selectors",level:3},{value:"Source",id:"source-3",level:4},{value:"title?",id:"title",level:3},{value:"Source",id:"source-4",level:4}];function d(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,t.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"interface-opendialogoptions",children:"Interface: OpenDialogOptions"}),"\n",(0,i.jsx)(n.p,{children:"Options to configure the behaviour of a file open dialog."}),"\n",(0,i.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(n.h3,{id:"defaulturi",children:"defaultUri?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"defaultUri"}),": ",(0,i.jsx)(n.a,{href:"/api/classes/Uri",children:(0,i.jsx)(n.code,{children:"Uri"})})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"The resource the dialog shows when opened."}),"\n",(0,i.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L1518",children:"packages/extension-api/src/extension-api.d.ts:1518"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"filters",children:"filters?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"filters"}),": ",(0,i.jsx)(n.code,{children:"object"}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"A set of file filters that are used by the dialog."}),"\n",(0,i.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L1534",children:"packages/extension-api/src/extension-api.d.ts:1534"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"openlabel",children:"openLabel?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"openLabel"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"A human-readable string for the open button."}),"\n",(0,i.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L1523",children:"packages/extension-api/src/extension-api.d.ts:1523"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"selectors",children:"selectors?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"selectors"}),": (",(0,i.jsx)(n.code,{children:'"openFile"'})," | ",(0,i.jsx)(n.code,{children:'"openDirectory"'})," | ",(0,i.jsx)(n.code,{children:'"multiSelections"'})," | ",(0,i.jsx)(n.code,{children:'"showHiddenFiles"'}),")[]"]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Contains which features the dialog should use. The following values are\nsupported:"}),"\n",(0,i.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L1529",children:"packages/extension-api/src/extension-api.d.ts:1529"})}),"\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:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"title"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Dialog title."}),"\n",(0,i.jsx)(n.h4,{id:"source-4",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L1542",children:"packages/extension-api/src/extension-api.d.ts:1542"})})]})}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:()=>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([[73867],{88517:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>l,contentTitle:()=>r,default:()=>p,frontMatter:()=>o,metadata:()=>c,toc:()=>d});var i=s(24246),t=s(71670);const o={},r="Interface: OpenDialogOptions",c={id:"interfaces/OpenDialogOptions",title:"Interface: OpenDialogOptions",description:"Options to configure the behaviour of a file open dialog.",source:"@site/api/interfaces/OpenDialogOptions.md",sourceDirName:"interfaces",slug:"/interfaces/OpenDialogOptions",permalink:"/api/interfaces/OpenDialogOptions",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: NotificationOptions",permalink:"/api/interfaces/NotificationOptions"},next:{title:"Interface: PidsStats",permalink:"/api/interfaces/PidsStats"}},l={},d=[{value:"Properties",id:"properties",level:2},{value:"defaultUri?",id:"defaulturi",level:3},{value:"Source",id:"source",level:4},{value:"filters?",id:"filters",level:3},{value:"Source",id:"source-1",level:4},{value:"openLabel?",id:"openlabel",level:3},{value:"Source",id:"source-2",level:4},{value:"selectors?",id:"selectors",level:3},{value:"Source",id:"source-3",level:4},{value:"title?",id:"title",level:3},{value:"Source",id:"source-4",level:4}];function a(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,t.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"interface-opendialogoptions",children:"Interface: OpenDialogOptions"}),"\n",(0,i.jsx)(n.p,{children:"Options to configure the behaviour of a file open dialog."}),"\n",(0,i.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(n.h3,{id:"defaulturi",children:"defaultUri?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"defaultUri"}),": ",(0,i.jsx)(n.a,{href:"/api/classes/Uri",children:(0,i.jsx)(n.code,{children:"Uri"})})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"The resource the dialog shows when opened."}),"\n",(0,i.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L1518",children:"packages/extension-api/src/extension-api.d.ts:1518"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"filters",children:"filters?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"filters"}),": ",(0,i.jsx)(n.code,{children:"object"}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"A set of file filters that are used by the dialog."}),"\n",(0,i.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L1534",children:"packages/extension-api/src/extension-api.d.ts:1534"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"openlabel",children:"openLabel?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"openLabel"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"A human-readable string for the open button."}),"\n",(0,i.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L1523",children:"packages/extension-api/src/extension-api.d.ts:1523"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"selectors",children:"selectors?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"selectors"}),": (",(0,i.jsx)(n.code,{children:'"openFile"'})," | ",(0,i.jsx)(n.code,{children:'"openDirectory"'})," | ",(0,i.jsx)(n.code,{children:'"multiSelections"'})," | ",(0,i.jsx)(n.code,{children:'"showHiddenFiles"'}),")[]"]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Contains which features the dialog should use. The following values are\nsupported:"}),"\n",(0,i.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L1529",children:"packages/extension-api/src/extension-api.d.ts:1529"})}),"\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:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"title"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Dialog title."}),"\n",(0,i.jsx)(n.h4,{id:"source-4",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L1542",children:"packages/extension-api/src/extension-api.d.ts:1542"})})]})}function p(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(a,{...e})}):a(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>c,a:()=>r});var i=s(27378);const 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/c813bd67.26a3edcf.js b/assets/js/c813bd67.14b66b49.js similarity index 86% rename from assets/js/c813bd67.26a3edcf.js rename to assets/js/c813bd67.14b66b49.js index 625e67a79ca..72215941f84 100644 --- a/assets/js/c813bd67.26a3edcf.js +++ b/assets/js/c813bd67.14b66b49.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[82163],{57150:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>a,contentTitle:()=>c,default:()=>p,frontMatter:()=>t,metadata:()=>o,toc:()=>d});var i=s(24246),r=s(71670);const t={},c="Interface: 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:"Interface: HostRestartPolicy",permalink:"/api/interfaces/HostRestartPolicy"},next:{title:"Interface: ImageCheck",permalink:"/api/interfaces/ImageCheck"}},a={},d=[{value:"Properties",id:"properties",level:2},{value:"Config?",id:"config",level:3},{value:"Source",id:"source",level:4},{value:"Driver",id:"driver",level:3},{value:"Source",id:"source-1",level:4},{value:"Options?",id:"options",level:3},{value:"Index signature",id:"index-signature",level:4},{value:"Source",id:"source-2",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,r.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"interface-ipam",children:"Interface: IPAM"}),"\n",(0,i.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(n.h3,{id:"config",children:"Config?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"Config"}),": ",(0,i.jsx)(n.code,{children:"object"}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L1959",children:"packages/extension-api/src/extension-api.d.ts:1959"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"driver",children:"Driver"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Driver"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L1958",children:"packages/extension-api/src/extension-api.d.ts:1958"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"options",children:"Options?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"Options"}),": ",(0,i.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"index-signature",children:"Index signature"}),"\n",(0,i.jsxs)(n.p,{children:["[",(0,i.jsx)(n.code,{children:"key"}),": ",(0,i.jsx)(n.code,{children:"string"}),"]: ",(0,i.jsx)(n.code,{children:"string"})]}),"\n",(0,i.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L1960",children:"packages/extension-api/src/extension-api.d.ts:1960"})})]})}function p(e={}){const{wrapper:n}={...(0,r.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>o,a:()=>c});var i=s(27378);const r={},t=i.createContext(r);function c(e){const n=i.useContext(t);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:c(e.components),i.createElement(t.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[82163],{57150:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>d,contentTitle:()=>c,default:()=>p,frontMatter:()=>t,metadata:()=>o,toc:()=>a});var i=s(24246),r=s(71670);const t={},c="Interface: IPAM",o={id:"interfaces/IPAM",title:"Interface: IPAM",description:"Properties",source:"@site/api/interfaces/IPAM.md",sourceDirName:"interfaces",slug:"/interfaces/IPAM",permalink:"/api/interfaces/IPAM",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: HostRestartPolicy",permalink:"/api/interfaces/HostRestartPolicy"},next:{title:"Interface: ImageCheck",permalink:"/api/interfaces/ImageCheck"}},d={},a=[{value:"Properties",id:"properties",level:2},{value:"Config?",id:"config",level:3},{value:"Source",id:"source",level:4},{value:"Driver",id:"driver",level:3},{value:"Source",id:"source-1",level:4},{value:"Options?",id:"options",level:3},{value:"Index signature",id:"index-signature",level:4},{value:"Source",id:"source-2",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,r.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"interface-ipam",children:"Interface: IPAM"}),"\n",(0,i.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(n.h3,{id:"config",children:"Config?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"Config"}),": ",(0,i.jsx)(n.code,{children:"object"}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L1959",children:"packages/extension-api/src/extension-api.d.ts:1959"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"driver",children:"Driver"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Driver"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L1958",children:"packages/extension-api/src/extension-api.d.ts:1958"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"options",children:"Options?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"Options"}),": ",(0,i.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"index-signature",children:"Index signature"}),"\n",(0,i.jsxs)(n.p,{children:["[",(0,i.jsx)(n.code,{children:"key"}),": ",(0,i.jsx)(n.code,{children:"string"}),"]: ",(0,i.jsx)(n.code,{children:"string"})]}),"\n",(0,i.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L1960",children:"packages/extension-api/src/extension-api.d.ts:1960"})})]})}function p(e={}){const{wrapper:n}={...(0,r.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>o,a:()=>c});var i=s(27378);const r={},t=i.createContext(r);function c(e){const n=i.useContext(t);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:c(e.components),i.createElement(t.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/ca1234c1.265b8267.js b/assets/js/ca1234c1.08eea4e3.js similarity index 92% rename from assets/js/ca1234c1.265b8267.js rename to assets/js/ca1234c1.08eea4e3.js index e906f56bff1..d0c10b98c9b 100644 --- a/assets/js/ca1234c1.265b8267.js +++ b/assets/js/ca1234c1.08eea4e3.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[77401],{33160:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>d,contentTitle:()=>s,default:()=>h,frontMatter:()=>i,metadata:()=>c,toc:()=>l});var o=r(24246),t=r(71670);const i={},s="Interface: TelemetryLoggerOptions",c={id:"interfaces/TelemetryLoggerOptions",title:"Interface: TelemetryLoggerOptions",description:"Options for creating a TelemetryLogger",source:"@site/api/interfaces/TelemetryLoggerOptions.md",sourceDirName:"interfaces",slug:"/interfaces/TelemetryLoggerOptions",permalink:"/api/interfaces/TelemetryLoggerOptions",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: TelemetryLogger",permalink:"/api/interfaces/TelemetryLogger"},next:{title:"Interface: TelemetrySender",permalink:"/api/interfaces/TelemetrySender"}},d={},l=[{value:"Properties",id:"properties",level:2},{value:"additionalCommonProperties?",id:"additionalcommonproperties",level:3},{value:"Source",id:"source",level:4},{value:"ignoreBuiltInCommonProperties?",id:"ignorebuiltincommonproperties",level:3},{value:"Source",id:"source-1",level:4},{value:"ignoreUnhandledErrors?",id:"ignoreunhandlederrors",level:3},{value:"Source",id:"source-2",level:4}];function a(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,t.a)(),...e.components};return(0,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.strong,{children:(0,o.jsx)(n.code,{children:"optional"})})," ",(0,o.jsx)(n.strong,{children:(0,o.jsx)(n.code,{children:"readonly"})})," ",(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:"source",children:"Source"}),"\n",(0,o.jsx)(n.p,{children:(0,o.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L3957",children:"packages/extension-api/src/extension-api.d.ts:3957"})}),"\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.strong,{children:(0,o.jsx)(n.code,{children:"optional"})})," ",(0,o.jsx)(n.strong,{children:(0,o.jsx)(n.code,{children:"readonly"})})," ",(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:"source-1",children:"Source"}),"\n",(0,o.jsx)(n.p,{children:(0,o.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L3945",children:"packages/extension-api/src/extension-api.d.ts:3945"})}),"\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.strong,{children:(0,o.jsx)(n.code,{children:"optional"})})," ",(0,o.jsx)(n.strong,{children:(0,o.jsx)(n.code,{children:"readonly"})})," ",(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:"source-2",children:"Source"}),"\n",(0,o.jsx)(n.p,{children:(0,o.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L3951",children:"packages/extension-api/src/extension-api.d.ts:3951"})})]})}function h(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(a,{...e})}):a(e)}},71670:(e,n,r)=>{r.d(n,{Z:()=>c,a:()=>s});var o=r(27378);const t={},i=o.createContext(t);function s(e){const n=o.useContext(i);return o.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:s(e.components),o.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[77401],{33160:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>d,contentTitle:()=>s,default:()=>h,frontMatter:()=>i,metadata:()=>c,toc:()=>l});var o=r(24246),t=r(71670);const i={},s="Interface: TelemetryLoggerOptions",c={id:"interfaces/TelemetryLoggerOptions",title:"Interface: TelemetryLoggerOptions",description:"Options for creating a TelemetryLogger",source:"@site/api/interfaces/TelemetryLoggerOptions.md",sourceDirName:"interfaces",slug:"/interfaces/TelemetryLoggerOptions",permalink:"/api/interfaces/TelemetryLoggerOptions",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: TelemetryLogger",permalink:"/api/interfaces/TelemetryLogger"},next:{title:"Interface: TelemetrySender",permalink:"/api/interfaces/TelemetrySender"}},d={},l=[{value:"Properties",id:"properties",level:2},{value:"additionalCommonProperties?",id:"additionalcommonproperties",level:3},{value:"Source",id:"source",level:4},{value:"ignoreBuiltInCommonProperties?",id:"ignorebuiltincommonproperties",level:3},{value:"Source",id:"source-1",level:4},{value:"ignoreUnhandledErrors?",id:"ignoreunhandlederrors",level:3},{value:"Source",id:"source-2",level:4}];function a(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,t.a)(),...e.components};return(0,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.strong,{children:(0,o.jsx)(n.code,{children:"optional"})})," ",(0,o.jsx)(n.strong,{children:(0,o.jsx)(n.code,{children:"readonly"})})," ",(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:"source",children:"Source"}),"\n",(0,o.jsx)(n.p,{children:(0,o.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L3957",children:"packages/extension-api/src/extension-api.d.ts:3957"})}),"\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.strong,{children:(0,o.jsx)(n.code,{children:"optional"})})," ",(0,o.jsx)(n.strong,{children:(0,o.jsx)(n.code,{children:"readonly"})})," ",(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:"source-1",children:"Source"}),"\n",(0,o.jsx)(n.p,{children:(0,o.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L3945",children:"packages/extension-api/src/extension-api.d.ts:3945"})}),"\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.strong,{children:(0,o.jsx)(n.code,{children:"optional"})})," ",(0,o.jsx)(n.strong,{children:(0,o.jsx)(n.code,{children:"readonly"})})," ",(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:"source-2",children:"Source"}),"\n",(0,o.jsx)(n.p,{children:(0,o.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L3951",children:"packages/extension-api/src/extension-api.d.ts:3951"})})]})}function h(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(a,{...e})}):a(e)}},71670:(e,n,r)=>{r.d(n,{Z:()=>c,a:()=>s});var o=r(27378);const t={},i=o.createContext(t);function s(e){const n=o.useContext(i);return o.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:s(e.components),o.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/ca165b51.ce22804e.js b/assets/js/ca165b51.a474b20a.js similarity index 86% rename from assets/js/ca165b51.ce22804e.js rename to assets/js/ca165b51.a474b20a.js index 648fbb68340..ef45bbe7b66 100644 --- a/assets/js/ca165b51.ce22804e.js +++ b/assets/js/ca165b51.a474b20a.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[68059],{88751:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>i,default:()=>l,frontMatter:()=>o,metadata:()=>c,toc:()=>d});var r=t(24246),s=t(71670);const o={},i="Interface: ProxySettings",c={id:"interfaces/ProxySettings",title:"Interface: ProxySettings",description:"Properties",source:"@site/api/interfaces/ProxySettings.md",sourceDirName:"interfaces",slug:"/interfaces/ProxySettings",permalink:"/api/interfaces/ProxySettings",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: ProviderUpdate",permalink:"/api/interfaces/ProviderUpdate"},next:{title:"Interface: PullEvent",permalink:"/api/interfaces/PullEvent"}},a={},d=[{value:"Properties",id:"properties",level:2},{value:"httpProxy",id:"httpproxy",level:3},{value:"Source",id:"source",level:4},{value:"httpsProxy",id:"httpsproxy",level:3},{value:"Source",id:"source-1",level:4},{value:"noProxy",id:"noproxy",level:3},{value:"Source",id:"source-2",level:4}];function p(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.h1,{id:"interface-proxysettings",children:"Interface: ProxySettings"}),"\n",(0,r.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,r.jsx)(n.h3,{id:"httpproxy",children:"httpProxy"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"httpProxy"}),": ",(0,r.jsx)(n.code,{children:"undefined"})," | ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L568",children:"packages/extension-api/src/extension-api.d.ts:568"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"httpsproxy",children:"httpsProxy"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"httpsProxy"}),": ",(0,r.jsx)(n.code,{children:"undefined"})," | ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L569",children:"packages/extension-api/src/extension-api.d.ts:569"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"noproxy",children:"noProxy"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"noProxy"}),": ",(0,r.jsx)(n.code,{children:"undefined"})," | ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L570",children:"packages/extension-api/src/extension-api.d.ts:570"})})]})}function l(e={}){const{wrapper:n}={...(0,s.a)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(p,{...e})}):p(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>c,a:()=>i});var r=t(27378);const s={},o=r.createContext(s);function i(e){const n=r.useContext(o);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:i(e.components),r.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[68059],{88751:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>d,contentTitle:()=>i,default:()=>l,frontMatter:()=>o,metadata:()=>c,toc:()=>a});var r=t(24246),s=t(71670);const o={},i="Interface: ProxySettings",c={id:"interfaces/ProxySettings",title:"Interface: ProxySettings",description:"Properties",source:"@site/api/interfaces/ProxySettings.md",sourceDirName:"interfaces",slug:"/interfaces/ProxySettings",permalink:"/api/interfaces/ProxySettings",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: ProviderUpdate",permalink:"/api/interfaces/ProviderUpdate"},next:{title:"Interface: PullEvent",permalink:"/api/interfaces/PullEvent"}},d={},a=[{value:"Properties",id:"properties",level:2},{value:"httpProxy",id:"httpproxy",level:3},{value:"Source",id:"source",level:4},{value:"httpsProxy",id:"httpsproxy",level:3},{value:"Source",id:"source-1",level:4},{value:"noProxy",id:"noproxy",level:3},{value:"Source",id:"source-2",level:4}];function p(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.h1,{id:"interface-proxysettings",children:"Interface: ProxySettings"}),"\n",(0,r.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,r.jsx)(n.h3,{id:"httpproxy",children:"httpProxy"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"httpProxy"}),": ",(0,r.jsx)(n.code,{children:"undefined"})," | ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L568",children:"packages/extension-api/src/extension-api.d.ts:568"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"httpsproxy",children:"httpsProxy"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"httpsProxy"}),": ",(0,r.jsx)(n.code,{children:"undefined"})," | ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L569",children:"packages/extension-api/src/extension-api.d.ts:569"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"noproxy",children:"noProxy"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"noProxy"}),": ",(0,r.jsx)(n.code,{children:"undefined"})," | ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L570",children:"packages/extension-api/src/extension-api.d.ts:570"})})]})}function l(e={}){const{wrapper:n}={...(0,s.a)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(p,{...e})}):p(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>c,a:()=>i});var r=t(27378);const s={},o=r.createContext(s);function i(e){const n=r.useContext(o);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:i(e.components),r.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/caddb1c0.b5ad6069.js b/assets/js/caddb1c0.130ef5f8.js similarity index 89% rename from assets/js/caddb1c0.b5ad6069.js rename to assets/js/caddb1c0.130ef5f8.js index 54d23e11051..3a35ff09754 100644 --- a/assets/js/caddb1c0.b5ad6069.js +++ b/assets/js/caddb1c0.130ef5f8.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[96987],{85879:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>d,contentTitle:()=>o,default:()=>h,frontMatter:()=>i,metadata:()=>t,toc:()=>l});var s=r(24246),c=r(71670);const i={},o="Interface: ProviderConnectionLifecycle",t={id:"interfaces/ProviderConnectionLifecycle",title:"Interface: ProviderConnectionLifecycle",description:"Methods",source:"@site/api/interfaces/ProviderConnectionLifecycle.md",sourceDirName:"interfaces",slug:"/interfaces/ProviderConnectionLifecycle",permalink:"/api/interfaces/ProviderConnectionLifecycle",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: ProviderConnectionFactory",permalink:"/api/interfaces/ProviderConnectionFactory"},next:{title:"Interface: ProviderContainerConnection",permalink:"/api/interfaces/ProviderContainerConnection"}},d={},l=[{value:"Methods",id:"methods",level:2},{value:"delete()?",id:"delete",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Source",id:"source",level:4},{value:"edit()?",id:"edit",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Source",id:"source-1",level:4},{value:"start()?",id:"start",level:3},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-2",level:4},{value:"Source",id:"source-2",level:4},{value:"stop()?",id:"stop",level:3},{value:"Parameters",id:"parameters-3",level:4},{value:"Returns",id:"returns-3",level:4},{value:"Source",id:"source-3",level:4}];function a(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,c.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"interface-providerconnectionlifecycle",children:"Interface: ProviderConnectionLifecycle"}),"\n",(0,s.jsx)(n.h2,{id:"methods",children:"Methods"}),"\n",(0,s.jsx)(n.h3,{id:"delete",children:"delete()?"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:(0,s.jsx)(n.code,{children:"optional"})})," ",(0,s.jsx)(n.strong,{children:"delete"}),"(",(0,s.jsx)(n.code,{children:"logger"}),"?): ",(0,s.jsx)(n.code,{children:"Promise"}),"< ",(0,s.jsx)(n.code,{children:"void"})," >"]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"parameters",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"logger?"}),": ",(0,s.jsx)(n.a,{href:"/api/interfaces/Logger",children:(0,s.jsx)(n.code,{children:"Logger"})})]}),"\n",(0,s.jsx)(n.h4,{id:"returns",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"Promise"}),"< ",(0,s.jsx)(n.code,{children:"void"})," >"]}),"\n",(0,s.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L250",children:"packages/extension-api/src/extension-api.d.ts:250"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"edit",children:"edit()?"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:(0,s.jsx)(n.code,{children:"optional"})})," ",(0,s.jsx)(n.strong,{children:"edit"}),"(",(0,s.jsx)(n.code,{children:"editContext"}),", ",(0,s.jsx)(n.code,{children:"params"}),", ",(0,s.jsx)(n.code,{children:"logger"}),"?, ",(0,s.jsx)(n.code,{children:"token"}),"?): ",(0,s.jsx)(n.code,{children:"Promise"}),"< ",(0,s.jsx)(n.code,{children:"void"})," >"]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"parameters-1",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"editContext"}),": ",(0,s.jsx)(n.a,{href:"/api/interfaces/LifecycleContext",children:(0,s.jsx)(n.code,{children:"LifecycleContext"})})]}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"params"})]}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"logger?"}),": ",(0,s.jsx)(n.a,{href:"/api/interfaces/Logger",children:(0,s.jsx)(n.code,{children:"Logger"})})]}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"token?"}),": ",(0,s.jsx)(n.a,{href:"/api/interfaces/CancellationToken",children:(0,s.jsx)(n.code,{children:"CancellationToken"})})]}),"\n",(0,s.jsx)(n.h4,{id:"returns-1",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"Promise"}),"< ",(0,s.jsx)(n.code,{children:"void"})," >"]}),"\n",(0,s.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L251",children:"packages/extension-api/src/extension-api.d.ts:251"})}),"\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:(0,s.jsx)(n.code,{children:"optional"})})," ",(0,s.jsx)(n.strong,{children:"start"}),"(",(0,s.jsx)(n.code,{children:"startContext"}),", ",(0,s.jsx)(n.code,{children:"logger"}),"?): ",(0,s.jsx)(n.code,{children:"Promise"}),"< ",(0,s.jsx)(n.code,{children:"void"})," >"]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"parameters-2",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"startContext"}),": ",(0,s.jsx)(n.a,{href:"/api/interfaces/LifecycleContext",children:(0,s.jsx)(n.code,{children:"LifecycleContext"})})]}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"logger?"}),": ",(0,s.jsx)(n.a,{href:"/api/interfaces/Logger",children:(0,s.jsx)(n.code,{children:"Logger"})})]}),"\n",(0,s.jsx)(n.h4,{id:"returns-2",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"Promise"}),"< ",(0,s.jsx)(n.code,{children:"void"})," >"]}),"\n",(0,s.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L248",children:"packages/extension-api/src/extension-api.d.ts:248"})}),"\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:(0,s.jsx)(n.code,{children:"optional"})})," ",(0,s.jsx)(n.strong,{children:"stop"}),"(",(0,s.jsx)(n.code,{children:"stopContext"}),", ",(0,s.jsx)(n.code,{children:"logger"}),"?): ",(0,s.jsx)(n.code,{children:"Promise"}),"< ",(0,s.jsx)(n.code,{children:"void"})," >"]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"parameters-3",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"stopContext"}),": ",(0,s.jsx)(n.a,{href:"/api/interfaces/LifecycleContext",children:(0,s.jsx)(n.code,{children:"LifecycleContext"})})]}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"logger?"}),": ",(0,s.jsx)(n.a,{href:"/api/interfaces/Logger",children:(0,s.jsx)(n.code,{children:"Logger"})})]}),"\n",(0,s.jsx)(n.h4,{id:"returns-3",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"Promise"}),"< ",(0,s.jsx)(n.code,{children:"void"})," >"]}),"\n",(0,s.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L249",children:"packages/extension-api/src/extension-api.d.ts:249"})})]})}function h(e={}){const{wrapper:n}={...(0,c.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(a,{...e})}):a(e)}},71670:(e,n,r)=>{r.d(n,{Z:()=>t,a:()=>o});var s=r(27378);const c={},i=s.createContext(c);function o(e){const n=s.useContext(i);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function t(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(c):e.components||c:o(e.components),s.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[96987],{85879:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>d,contentTitle:()=>o,default:()=>h,frontMatter:()=>c,metadata:()=>t,toc:()=>l});var s=r(24246),i=r(71670);const c={},o="Interface: ProviderConnectionLifecycle",t={id:"interfaces/ProviderConnectionLifecycle",title:"Interface: ProviderConnectionLifecycle",description:"Methods",source:"@site/api/interfaces/ProviderConnectionLifecycle.md",sourceDirName:"interfaces",slug:"/interfaces/ProviderConnectionLifecycle",permalink:"/api/interfaces/ProviderConnectionLifecycle",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: ProviderConnectionFactory",permalink:"/api/interfaces/ProviderConnectionFactory"},next:{title:"Interface: ProviderContainerConnection",permalink:"/api/interfaces/ProviderContainerConnection"}},d={},l=[{value:"Methods",id:"methods",level:2},{value:"delete()?",id:"delete",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Source",id:"source",level:4},{value:"edit()?",id:"edit",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Source",id:"source-1",level:4},{value:"start()?",id:"start",level:3},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-2",level:4},{value:"Source",id:"source-2",level:4},{value:"stop()?",id:"stop",level:3},{value:"Parameters",id:"parameters-3",level:4},{value:"Returns",id:"returns-3",level:4},{value:"Source",id:"source-3",level:4}];function a(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,i.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"interface-providerconnectionlifecycle",children:"Interface: ProviderConnectionLifecycle"}),"\n",(0,s.jsx)(n.h2,{id:"methods",children:"Methods"}),"\n",(0,s.jsx)(n.h3,{id:"delete",children:"delete()?"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:(0,s.jsx)(n.code,{children:"optional"})})," ",(0,s.jsx)(n.strong,{children:"delete"}),"(",(0,s.jsx)(n.code,{children:"logger"}),"?): ",(0,s.jsx)(n.code,{children:"Promise"}),"< ",(0,s.jsx)(n.code,{children:"void"})," >"]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"parameters",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"logger?"}),": ",(0,s.jsx)(n.a,{href:"/api/interfaces/Logger",children:(0,s.jsx)(n.code,{children:"Logger"})})]}),"\n",(0,s.jsx)(n.h4,{id:"returns",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"Promise"}),"< ",(0,s.jsx)(n.code,{children:"void"})," >"]}),"\n",(0,s.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L250",children:"packages/extension-api/src/extension-api.d.ts:250"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"edit",children:"edit()?"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:(0,s.jsx)(n.code,{children:"optional"})})," ",(0,s.jsx)(n.strong,{children:"edit"}),"(",(0,s.jsx)(n.code,{children:"editContext"}),", ",(0,s.jsx)(n.code,{children:"params"}),", ",(0,s.jsx)(n.code,{children:"logger"}),"?, ",(0,s.jsx)(n.code,{children:"token"}),"?): ",(0,s.jsx)(n.code,{children:"Promise"}),"< ",(0,s.jsx)(n.code,{children:"void"})," >"]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"parameters-1",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"editContext"}),": ",(0,s.jsx)(n.a,{href:"/api/interfaces/LifecycleContext",children:(0,s.jsx)(n.code,{children:"LifecycleContext"})})]}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"params"})]}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"logger?"}),": ",(0,s.jsx)(n.a,{href:"/api/interfaces/Logger",children:(0,s.jsx)(n.code,{children:"Logger"})})]}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"token?"}),": ",(0,s.jsx)(n.a,{href:"/api/interfaces/CancellationToken",children:(0,s.jsx)(n.code,{children:"CancellationToken"})})]}),"\n",(0,s.jsx)(n.h4,{id:"returns-1",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"Promise"}),"< ",(0,s.jsx)(n.code,{children:"void"})," >"]}),"\n",(0,s.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L251",children:"packages/extension-api/src/extension-api.d.ts:251"})}),"\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:(0,s.jsx)(n.code,{children:"optional"})})," ",(0,s.jsx)(n.strong,{children:"start"}),"(",(0,s.jsx)(n.code,{children:"startContext"}),", ",(0,s.jsx)(n.code,{children:"logger"}),"?): ",(0,s.jsx)(n.code,{children:"Promise"}),"< ",(0,s.jsx)(n.code,{children:"void"})," >"]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"parameters-2",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"startContext"}),": ",(0,s.jsx)(n.a,{href:"/api/interfaces/LifecycleContext",children:(0,s.jsx)(n.code,{children:"LifecycleContext"})})]}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"logger?"}),": ",(0,s.jsx)(n.a,{href:"/api/interfaces/Logger",children:(0,s.jsx)(n.code,{children:"Logger"})})]}),"\n",(0,s.jsx)(n.h4,{id:"returns-2",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"Promise"}),"< ",(0,s.jsx)(n.code,{children:"void"})," >"]}),"\n",(0,s.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L248",children:"packages/extension-api/src/extension-api.d.ts:248"})}),"\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:(0,s.jsx)(n.code,{children:"optional"})})," ",(0,s.jsx)(n.strong,{children:"stop"}),"(",(0,s.jsx)(n.code,{children:"stopContext"}),", ",(0,s.jsx)(n.code,{children:"logger"}),"?): ",(0,s.jsx)(n.code,{children:"Promise"}),"< ",(0,s.jsx)(n.code,{children:"void"})," >"]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"parameters-3",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"stopContext"}),": ",(0,s.jsx)(n.a,{href:"/api/interfaces/LifecycleContext",children:(0,s.jsx)(n.code,{children:"LifecycleContext"})})]}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"logger?"}),": ",(0,s.jsx)(n.a,{href:"/api/interfaces/Logger",children:(0,s.jsx)(n.code,{children:"Logger"})})]}),"\n",(0,s.jsx)(n.h4,{id:"returns-3",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"Promise"}),"< ",(0,s.jsx)(n.code,{children:"void"})," >"]}),"\n",(0,s.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L249",children:"packages/extension-api/src/extension-api.d.ts:249"})})]})}function h(e={}){const{wrapper:n}={...(0,i.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(a,{...e})}):a(e)}},71670:(e,n,r)=>{r.d(n,{Z:()=>t,a:()=>o});var s=r(27378);const i={},c=s.createContext(i);function o(e){const n=s.useContext(c);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function t(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:o(e.components),s.createElement(c.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/cb0f21df.d3ba4f77.js b/assets/js/cb0f21df.b31ab9f5.js similarity index 95% rename from assets/js/cb0f21df.d3ba4f77.js rename to assets/js/cb0f21df.b31ab9f5.js index 729ab81b35a..b6f95de3524 100644 --- a/assets/js/cb0f21df.d3ba4f77.js +++ b/assets/js/cb0f21df.b31ab9f5.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[6098],{16989:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>i,default:()=>l,frontMatter:()=>o,metadata:()=>c,toc:()=>d});var s=t(24246),r=t(71670);const o={},i="Interface: UpdateKubernetesConnectionEvent",c={id:"interfaces/UpdateKubernetesConnectionEvent",title:"Interface: UpdateKubernetesConnectionEvent",description:"Properties",source:"@site/api/interfaces/UpdateKubernetesConnectionEvent.md",sourceDirName:"interfaces",slug:"/interfaces/UpdateKubernetesConnectionEvent",permalink:"/api/interfaces/UpdateKubernetesConnectionEvent",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: UpdateContainerConnectionEvent",permalink:"/api/interfaces/UpdateContainerConnectionEvent"},next:{title:"Interface: VolumeCreateOptions",permalink:"/api/interfaces/VolumeCreateOptions"}},a={},d=[{value:"Properties",id:"properties",level:2},{value:"connection",id:"connection",level:3},{value:"Source",id:"source",level:4},{value:"providerId",id:"providerid",level:3},{value:"Source",id:"source-1",level:4},{value:"status",id:"status",level:3},{value:"Source",id:"source-2",level:4}];function p(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,r.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"interface-updatekubernetesconnectionevent",children:"Interface: UpdateKubernetesConnectionEvent"}),"\n",(0,s.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,s.jsx)(n.h3,{id:"connection",children:"connection"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"connection"}),": ",(0,s.jsx)(n.a,{href:"/api/interfaces/KubernetesProviderConnection",children:(0,s.jsx)(n.code,{children:"KubernetesProviderConnection"})})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L522",children:"packages/extension-api/src/extension-api.d.ts:522"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"providerid",children:"providerId"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"providerId"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L521",children:"packages/extension-api/src/extension-api.d.ts:521"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"status",children:"status"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"status"}),": ",(0,s.jsx)(n.a,{href:"/api/type-aliases/ProviderConnectionStatus",children:(0,s.jsx)(n.code,{children:"ProviderConnectionStatus"})})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L523",children:"packages/extension-api/src/extension-api.d.ts:523"})})]})}function l(e={}){const{wrapper:n}={...(0,r.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(p,{...e})}):p(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>c,a:()=>i});var s=t(27378);const r={},o=s.createContext(r);function i(e){const n=s.useContext(o);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:i(e.components),s.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[6098],{16989:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>i,default:()=>l,frontMatter:()=>o,metadata:()=>c,toc:()=>d});var s=t(24246),r=t(71670);const o={},i="Interface: UpdateKubernetesConnectionEvent",c={id:"interfaces/UpdateKubernetesConnectionEvent",title:"Interface: UpdateKubernetesConnectionEvent",description:"Properties",source:"@site/api/interfaces/UpdateKubernetesConnectionEvent.md",sourceDirName:"interfaces",slug:"/interfaces/UpdateKubernetesConnectionEvent",permalink:"/api/interfaces/UpdateKubernetesConnectionEvent",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: UpdateContainerConnectionEvent",permalink:"/api/interfaces/UpdateContainerConnectionEvent"},next:{title:"Interface: VolumeCreateOptions",permalink:"/api/interfaces/VolumeCreateOptions"}},a={},d=[{value:"Properties",id:"properties",level:2},{value:"connection",id:"connection",level:3},{value:"Source",id:"source",level:4},{value:"providerId",id:"providerid",level:3},{value:"Source",id:"source-1",level:4},{value:"status",id:"status",level:3},{value:"Source",id:"source-2",level:4}];function p(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,r.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"interface-updatekubernetesconnectionevent",children:"Interface: UpdateKubernetesConnectionEvent"}),"\n",(0,s.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,s.jsx)(n.h3,{id:"connection",children:"connection"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"connection"}),": ",(0,s.jsx)(n.a,{href:"/api/interfaces/KubernetesProviderConnection",children:(0,s.jsx)(n.code,{children:"KubernetesProviderConnection"})})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L522",children:"packages/extension-api/src/extension-api.d.ts:522"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"providerid",children:"providerId"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"providerId"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L521",children:"packages/extension-api/src/extension-api.d.ts:521"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"status",children:"status"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"status"}),": ",(0,s.jsx)(n.a,{href:"/api/type-aliases/ProviderConnectionStatus",children:(0,s.jsx)(n.code,{children:"ProviderConnectionStatus"})})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L523",children:"packages/extension-api/src/extension-api.d.ts:523"})})]})}function l(e={}){const{wrapper:n}={...(0,r.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(p,{...e})}):p(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>c,a:()=>i});var s=t(27378);const r={},o=s.createContext(r);function i(e){const n=s.useContext(o);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:i(e.components),s.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/cc6d9416.bb85ac72.js b/assets/js/cc6d9416.77f78036.js similarity index 83% rename from assets/js/cc6d9416.bb85ac72.js rename to assets/js/cc6d9416.77f78036.js index 67e6699ee2b..1d2d995ab46 100644 --- a/assets/js/cc6d9416.bb85ac72.js +++ b/assets/js/cc6d9416.77f78036.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[71874],{66687:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>a,contentTitle:()=>c,default:()=>h,frontMatter:()=>t,metadata:()=>o,toc:()=>d});var r=s(24246),i=s(71670);const t={},c="Interface: AuthConfig",o={id:"interfaces/AuthConfig",title:"Interface: AuthConfig",description:"Properties",source:"@site/api/interfaces/AuthConfig.md",sourceDirName:"interfaces",slug:"/interfaces/AuthConfig",permalink:"/api/interfaces/AuthConfig",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: Auditor",permalink:"/api/interfaces/Auditor"},next:{title:"Interface: AuthenticationGetSessionOptions",permalink:"/api/interfaces/AuthenticationGetSessionOptions"}},a={},d=[{value:"Properties",id:"properties",level:2},{value:"email?",id:"email",level:3},{value:"Source",id:"source",level:4},{value:"password",id:"password",level:3},{value:"Source",id:"source-1",level:4},{value:"serveraddress",id:"serveraddress",level:3},{value:"Source",id:"source-2",level:4},{value:"username",id:"username",level:3},{value:"Source",id:"source-3",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,i.a)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.h1,{id:"interface-authconfig",children:"Interface: AuthConfig"}),"\n",(0,r.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,r.jsx)(n.h3,{id:"email",children:"email?"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"optional"})})," ",(0,r.jsx)(n.strong,{children:"email"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2064",children:"packages/extension-api/src/extension-api.d.ts:2064"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"password",children:"password"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"password"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2062",children:"packages/extension-api/src/extension-api.d.ts:2062"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"serveraddress",children:"serveraddress"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"serveraddress"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2063",children:"packages/extension-api/src/extension-api.d.ts:2063"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"username",children:"username"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"username"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2061",children:"packages/extension-api/src/extension-api.d.ts:2061"})})]})}function h(e={}){const{wrapper:n}={...(0,i.a)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(l,{...e})}):l(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>o,a:()=>c});var r=s(27378);const i={},t=r.createContext(i);function c(e){const n=r.useContext(t);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:c(e.components),r.createElement(t.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[71874],{66687:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>d,contentTitle:()=>c,default:()=>h,frontMatter:()=>t,metadata:()=>o,toc:()=>a});var r=s(24246),i=s(71670);const t={},c="Interface: 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:"Interface: Auditor",permalink:"/api/interfaces/Auditor"},next:{title:"Interface: AuthenticationGetSessionOptions",permalink:"/api/interfaces/AuthenticationGetSessionOptions"}},d={},a=[{value:"Properties",id:"properties",level:2},{value:"email?",id:"email",level:3},{value:"Source",id:"source",level:4},{value:"password",id:"password",level:3},{value:"Source",id:"source-1",level:4},{value:"serveraddress",id:"serveraddress",level:3},{value:"Source",id:"source-2",level:4},{value:"username",id:"username",level:3},{value:"Source",id:"source-3",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,i.a)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.h1,{id:"interface-authconfig",children:"Interface: AuthConfig"}),"\n",(0,r.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,r.jsx)(n.h3,{id:"email",children:"email?"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"optional"})})," ",(0,r.jsx)(n.strong,{children:"email"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2064",children:"packages/extension-api/src/extension-api.d.ts:2064"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"password",children:"password"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"password"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2062",children:"packages/extension-api/src/extension-api.d.ts:2062"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"serveraddress",children:"serveraddress"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"serveraddress"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2063",children:"packages/extension-api/src/extension-api.d.ts:2063"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"username",children:"username"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"username"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2061",children:"packages/extension-api/src/extension-api.d.ts:2061"})})]})}function h(e={}){const{wrapper:n}={...(0,i.a)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(l,{...e})}):l(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>o,a:()=>c});var r=s(27378);const i={},t=r.createContext(i);function c(e){const n=r.useContext(t);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:c(e.components),r.createElement(t.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/cc922df3.1b0315bd.js b/assets/js/cc922df3.a4836f17.js similarity index 93% rename from assets/js/cc922df3.1b0315bd.js rename to assets/js/cc922df3.a4836f17.js index 49429b59c63..f176082969b 100644 --- a/assets/js/cc922df3.1b0315bd.js +++ b/assets/js/cc922df3.a4836f17.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[53273],{47449:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>a,contentTitle:()=>r,default:()=>d,frontMatter:()=>o,metadata:()=>c,toc:()=>l});var t=s(24246),i=s(71670);const o={},r="Interface: AuthenticationGetSessionOptions",c={id:"interfaces/AuthenticationGetSessionOptions",title:"Interface: AuthenticationGetSessionOptions",description:"Options to be used when getting an AuthenticationSession from an AuthenticationProvider.",source:"@site/api/interfaces/AuthenticationGetSessionOptions.md",sourceDirName:"interfaces",slug:"/interfaces/AuthenticationGetSessionOptions",permalink:"/api/interfaces/AuthenticationGetSessionOptions",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: AuthConfig",permalink:"/api/interfaces/AuthConfig"},next:{title:"Interface: AuthenticationProvider",permalink:"/api/interfaces/AuthenticationProvider"}},a={},l=[{value:"Properties",id:"properties",level:2},{value:"clearSessionPreference?",id:"clearsessionpreference",level:3},{value:"Source",id:"source",level:4},{value:"createIfNone?",id:"createifnone",level:3},{value:"Source",id:"source-1",level:4},{value:"forceNewSession?",id:"forcenewsession",level:3},{value:"Source",id:"source-2",level:4},{value:"silent?",id:"silent",level:3},{value:"Source",id:"source-3",level:4}];function h(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,i.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.strong,{children:(0,t.jsx)(n.code,{children:"optional"})})," ",(0,t.jsx)(n.strong,{children:"clearSessionPreference"}),": ",(0,t.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"Whether the existing user session preference should be cleared."}),"\n",(0,t.jsxs)(n.p,{children:["For authentication providers that support being signed into multiple accounts at once, the user will be\nprompted to select an account to use when ",(0,t.jsx)(n.a,{href:"#authentication.getSession",children:"getSession"})," is called. This preference\nis remembered until ",(0,t.jsx)(n.a,{href:"#authentication.getSession",children:"getSession"})," is called with this flag."]}),"\n",(0,t.jsx)(n.p,{children:"Defaults to false."}),"\n",(0,t.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L3457",children:"packages/extension-api/src/extension-api.d.ts:3457"})}),"\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.strong,{children:(0,t.jsx)(n.code,{children:"optional"})})," ",(0,t.jsx)(n.strong,{children:"createIfNone"}),": ",(0,t.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"Whether login should be performed if there is no matching session."}),"\n",(0,t.jsx)(n.p,{children:"If true, a modal dialog will be shown asking the user to sign in. If false, a numbered badge will be shown\non the accounts activity bar icon. An entry for the extension will be added under the menu to sign in. This\nallows quietly prompting the user to sign in."}),"\n",(0,t.jsx)(n.p,{children:"If there is a matching session but the extension has not been granted access to it, setting this to true\nwill also result in an immediate modal dialog, and false will add a numbered badge to the accounts icon."}),"\n",(0,t.jsx)(n.p,{children:"Defaults to false."}),"\n",(0,t.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L3446",children:"packages/extension-api/src/extension-api.d.ts:3446"})}),"\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.strong,{children:(0,t.jsx)(n.code,{children:"optional"})})," ",(0,t.jsx)(n.strong,{children:"forceNewSession"}),": ",(0,t.jsx)(n.code,{children:"boolean"})," | ",(0,t.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"Whether we should attempt to reauthenticate even if there is already a session available."}),"\n",(0,t.jsx)(n.p,{children:"If true, a modal dialog will be shown asking the user to sign in again. This is mostly used for scenarios\nwhere the token needs to be re minted because it has lost some authorization."}),"\n",(0,t.jsxs)(n.p,{children:["If there are no existing sessions and forceNewSession is true, it will behave identically to\n",(0,t.jsx)(n.a,{href:"/api/interfaces/AuthenticationGetSessionOptions#createifnone",children:"createIfNone"}),"."]}),"\n",(0,t.jsx)(n.p,{children:"This defaults to false."}),"\n",(0,t.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L3470",children:"packages/extension-api/src/extension-api.d.ts:3470"})}),"\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.strong,{children:(0,t.jsx)(n.code,{children:"optional"})})," ",(0,t.jsx)(n.strong,{children:"silent"}),": ",(0,t.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"Whether we should show the indication to sign in in the Accounts menu."}),"\n",(0,t.jsx)(n.p,{children:"If false, the user will be shown a badge on the Accounts menu with an option to sign in for the extension.\nIf true, no indication will be shown."}),"\n",(0,t.jsx)(n.p,{children:"Defaults to false."}),"\n",(0,t.jsxs)(n.p,{children:["Note: you cannot use this option with any other options that prompt the user like ",(0,t.jsx)(n.a,{href:"/api/interfaces/AuthenticationGetSessionOptions#createifnone",children:"createIfNone"}),"."]}),"\n",(0,t.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L3482",children:"packages/extension-api/src/extension-api.d.ts:3482"})})]})}function d(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,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([[53273],{47449:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>a,contentTitle:()=>r,default:()=>d,frontMatter:()=>o,metadata:()=>c,toc:()=>l});var t=s(24246),i=s(71670);const o={},r="Interface: AuthenticationGetSessionOptions",c={id:"interfaces/AuthenticationGetSessionOptions",title:"Interface: AuthenticationGetSessionOptions",description:"Options to be used when getting an AuthenticationSession from an AuthenticationProvider.",source:"@site/api/interfaces/AuthenticationGetSessionOptions.md",sourceDirName:"interfaces",slug:"/interfaces/AuthenticationGetSessionOptions",permalink:"/api/interfaces/AuthenticationGetSessionOptions",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: AuthConfig",permalink:"/api/interfaces/AuthConfig"},next:{title:"Interface: AuthenticationProvider",permalink:"/api/interfaces/AuthenticationProvider"}},a={},l=[{value:"Properties",id:"properties",level:2},{value:"clearSessionPreference?",id:"clearsessionpreference",level:3},{value:"Source",id:"source",level:4},{value:"createIfNone?",id:"createifnone",level:3},{value:"Source",id:"source-1",level:4},{value:"forceNewSession?",id:"forcenewsession",level:3},{value:"Source",id:"source-2",level:4},{value:"silent?",id:"silent",level:3},{value:"Source",id:"source-3",level:4}];function h(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,i.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.strong,{children:(0,t.jsx)(n.code,{children:"optional"})})," ",(0,t.jsx)(n.strong,{children:"clearSessionPreference"}),": ",(0,t.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"Whether the existing user session preference should be cleared."}),"\n",(0,t.jsxs)(n.p,{children:["For authentication providers that support being signed into multiple accounts at once, the user will be\nprompted to select an account to use when ",(0,t.jsx)(n.a,{href:"#authentication.getSession",children:"getSession"})," is called. This preference\nis remembered until ",(0,t.jsx)(n.a,{href:"#authentication.getSession",children:"getSession"})," is called with this flag."]}),"\n",(0,t.jsx)(n.p,{children:"Defaults to false."}),"\n",(0,t.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L3457",children:"packages/extension-api/src/extension-api.d.ts:3457"})}),"\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.strong,{children:(0,t.jsx)(n.code,{children:"optional"})})," ",(0,t.jsx)(n.strong,{children:"createIfNone"}),": ",(0,t.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"Whether login should be performed if there is no matching session."}),"\n",(0,t.jsx)(n.p,{children:"If true, a modal dialog will be shown asking the user to sign in. If false, a numbered badge will be shown\non the accounts activity bar icon. An entry for the extension will be added under the menu to sign in. This\nallows quietly prompting the user to sign in."}),"\n",(0,t.jsx)(n.p,{children:"If there is a matching session but the extension has not been granted access to it, setting this to true\nwill also result in an immediate modal dialog, and false will add a numbered badge to the accounts icon."}),"\n",(0,t.jsx)(n.p,{children:"Defaults to false."}),"\n",(0,t.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L3446",children:"packages/extension-api/src/extension-api.d.ts:3446"})}),"\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.strong,{children:(0,t.jsx)(n.code,{children:"optional"})})," ",(0,t.jsx)(n.strong,{children:"forceNewSession"}),": ",(0,t.jsx)(n.code,{children:"boolean"})," | ",(0,t.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"Whether we should attempt to reauthenticate even if there is already a session available."}),"\n",(0,t.jsx)(n.p,{children:"If true, a modal dialog will be shown asking the user to sign in again. This is mostly used for scenarios\nwhere the token needs to be re minted because it has lost some authorization."}),"\n",(0,t.jsxs)(n.p,{children:["If there are no existing sessions and forceNewSession is true, it will behave identically to\n",(0,t.jsx)(n.a,{href:"/api/interfaces/AuthenticationGetSessionOptions#createifnone",children:"createIfNone"}),"."]}),"\n",(0,t.jsx)(n.p,{children:"This defaults to false."}),"\n",(0,t.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L3470",children:"packages/extension-api/src/extension-api.d.ts:3470"})}),"\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.strong,{children:(0,t.jsx)(n.code,{children:"optional"})})," ",(0,t.jsx)(n.strong,{children:"silent"}),": ",(0,t.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"Whether we should show the indication to sign in in the Accounts menu."}),"\n",(0,t.jsx)(n.p,{children:"If false, the user will be shown a badge on the Accounts menu with an option to sign in for the extension.\nIf true, no indication will be shown."}),"\n",(0,t.jsx)(n.p,{children:"Defaults to false."}),"\n",(0,t.jsxs)(n.p,{children:["Note: you cannot use this option with any other options that prompt the user like ",(0,t.jsx)(n.a,{href:"/api/interfaces/AuthenticationGetSessionOptions#createifnone",children:"createIfNone"}),"."]}),"\n",(0,t.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L3482",children:"packages/extension-api/src/extension-api.d.ts:3482"})})]})}function d(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,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/cdf64ea9.17a540d0.js b/assets/js/cdf64ea9.cb4bb158.js similarity index 93% rename from assets/js/cdf64ea9.17a540d0.js rename to assets/js/cdf64ea9.cb4bb158.js index 070276fce91..ddf052ce85c 100644 --- a/assets/js/cdf64ea9.17a540d0.js +++ b/assets/js/cdf64ea9.cb4bb158.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[90681],{36533:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>t,contentTitle:()=>d,default:()=>h,frontMatter:()=>i,metadata:()=>o,toc:()=>l});var r=s(24246),c=s(71670);const i={},d="Interface: RunError",o={id:"interfaces/RunError",title:"Interface: RunError",description:"Represents an error that occurred during the execution of a command.",source:"@site/api/interfaces/RunError.md",sourceDirName:"interfaces",slug:"/interfaces/RunError",permalink:"/api/interfaces/RunError",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: RegistrySuggestedProvider",permalink:"/api/interfaces/RegistrySuggestedProvider"},next:{title:"Interface: RunOptions",permalink:"/api/interfaces/RunOptions"}},t={},l=[{value:"Extends",id:"extends",level:2},{value:"Properties",id:"properties",level:2},{value:"cancelled",id:"cancelled",level:3},{value:"Source",id:"source",level:4},{value:"cause?",id:"cause",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Source",id:"source-1",level:4},{value:"command",id:"command",level:3},{value:"Source",id:"source-2",level:4},{value:"exitCode",id:"exitcode",level:3},{value:"Source",id:"source-3",level:4},{value:"killed",id:"killed",level:3},{value:"Source",id:"source-4",level:4},{value:"message",id:"message",level:3},{value:"Overrides",id:"overrides",level:4},{value:"Source",id:"source-5",level:4},{value:"name",id:"name",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Source",id:"source-6",level:4},{value:"stack?",id:"stack",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Source",id:"source-7",level:4},{value:"stderr",id:"stderr",level:3},{value:"Source",id:"source-8",level:4},{value:"stdout",id:"stdout",level:3},{value:"Source",id:"source-9",level:4}];function a(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",li:"li",p:"p",strong:"strong",ul:"ul",...(0,c.a)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.h1,{id:"interface-runerror",children:"Interface: RunError"}),"\n",(0,r.jsx)(n.p,{children:"Represents an error that occurred during the execution of a command."}),"\n",(0,r.jsx)(n.h2,{id:"extends",children:"Extends"}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.code,{children:"Error"})}),"\n"]}),"\n",(0,r.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,r.jsx)(n.h3,{id:"cancelled",children:"cancelled"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"cancelled"}),": ",(0,r.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"Indicates whether the execution was cancelled."}),"\n",(0,r.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L3807",children:"packages/extension-api/src/extension-api.d.ts:3807"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"cause",children:"cause?"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"optional"})})," ",(0,r.jsx)(n.strong,{children:"cause"}),": ",(0,r.jsx)(n.code,{children:"unknown"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"inherited-from",children:"Inherited from"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.code,{children:"Error.cause"})}),"\n",(0,r.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:"node_modules/typescript/lib/lib.es2022.error.d.ts:24"}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"command",children:"command"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"command"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"The command that was executed."}),"\n",(0,r.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L3792",children:"packages/extension-api/src/extension-api.d.ts:3792"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"exitcode",children:"exitCode"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"exitCode"}),": ",(0,r.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"The exit code of the command."}),"\n",(0,r.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L3787",children:"packages/extension-api/src/extension-api.d.ts:3787"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"killed",children:"killed"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"killed"}),": ",(0,r.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"Indicates whether the process was forcefully killed."}),"\n",(0,r.jsx)(n.h4,{id:"source-4",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L3812",children:"packages/extension-api/src/extension-api.d.ts:3812"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"message",children:"message"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"message"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"The error message."}),"\n",(0,r.jsx)(n.h4,{id:"overrides",children:"Overrides"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.code,{children:"Error.message"})}),"\n",(0,r.jsx)(n.h4,{id:"source-5",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L3782",children:"packages/extension-api/src/extension-api.d.ts:3782"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"name",children:"name"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"name"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"inherited-from-1",children:"Inherited from"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.code,{children:"Error.name"})}),"\n",(0,r.jsx)(n.h4,{id:"source-6",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:"node_modules/typescript/lib/lib.es5.d.ts:1076"}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"stack",children:"stack?"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"optional"})})," ",(0,r.jsx)(n.strong,{children:"stack"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"inherited-from-2",children:"Inherited from"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.code,{children:"Error.stack"})}),"\n",(0,r.jsx)(n.h4,{id:"source-7",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:"node_modules/typescript/lib/lib.es5.d.ts:1078"}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"stderr",children:"stderr"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"stderr"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"The standard error (stderr) content of the command."}),"\n",(0,r.jsx)(n.h4,{id:"source-8",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L3802",children:"packages/extension-api/src/extension-api.d.ts:3802"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"stdout",children:"stdout"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"stdout"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"The standard output (stdout) content of the command."}),"\n",(0,r.jsx)(n.h4,{id:"source-9",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L3797",children:"packages/extension-api/src/extension-api.d.ts:3797"})})]})}function h(e={}){const{wrapper:n}={...(0,c.a)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(a,{...e})}):a(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>o,a:()=>d});var r=s(27378);const c={},i=r.createContext(c);function d(e){const n=r.useContext(i);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(c):e.components||c:d(e.components),r.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[90681],{36533:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>t,contentTitle:()=>d,default:()=>h,frontMatter:()=>i,metadata:()=>o,toc:()=>l});var r=s(24246),c=s(71670);const i={},d="Interface: RunError",o={id:"interfaces/RunError",title:"Interface: RunError",description:"Represents an error that occurred during the execution of a command.",source:"@site/api/interfaces/RunError.md",sourceDirName:"interfaces",slug:"/interfaces/RunError",permalink:"/api/interfaces/RunError",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: RegistrySuggestedProvider",permalink:"/api/interfaces/RegistrySuggestedProvider"},next:{title:"Interface: RunOptions",permalink:"/api/interfaces/RunOptions"}},t={},l=[{value:"Extends",id:"extends",level:2},{value:"Properties",id:"properties",level:2},{value:"cancelled",id:"cancelled",level:3},{value:"Source",id:"source",level:4},{value:"cause?",id:"cause",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Source",id:"source-1",level:4},{value:"command",id:"command",level:3},{value:"Source",id:"source-2",level:4},{value:"exitCode",id:"exitcode",level:3},{value:"Source",id:"source-3",level:4},{value:"killed",id:"killed",level:3},{value:"Source",id:"source-4",level:4},{value:"message",id:"message",level:3},{value:"Overrides",id:"overrides",level:4},{value:"Source",id:"source-5",level:4},{value:"name",id:"name",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Source",id:"source-6",level:4},{value:"stack?",id:"stack",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Source",id:"source-7",level:4},{value:"stderr",id:"stderr",level:3},{value:"Source",id:"source-8",level:4},{value:"stdout",id:"stdout",level:3},{value:"Source",id:"source-9",level:4}];function a(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",li:"li",p:"p",strong:"strong",ul:"ul",...(0,c.a)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.h1,{id:"interface-runerror",children:"Interface: RunError"}),"\n",(0,r.jsx)(n.p,{children:"Represents an error that occurred during the execution of a command."}),"\n",(0,r.jsx)(n.h2,{id:"extends",children:"Extends"}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.code,{children:"Error"})}),"\n"]}),"\n",(0,r.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,r.jsx)(n.h3,{id:"cancelled",children:"cancelled"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"cancelled"}),": ",(0,r.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"Indicates whether the execution was cancelled."}),"\n",(0,r.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L3807",children:"packages/extension-api/src/extension-api.d.ts:3807"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"cause",children:"cause?"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"optional"})})," ",(0,r.jsx)(n.strong,{children:"cause"}),": ",(0,r.jsx)(n.code,{children:"unknown"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"inherited-from",children:"Inherited from"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.code,{children:"Error.cause"})}),"\n",(0,r.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:"node_modules/typescript/lib/lib.es2022.error.d.ts:24"}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"command",children:"command"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"command"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"The command that was executed."}),"\n",(0,r.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L3792",children:"packages/extension-api/src/extension-api.d.ts:3792"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"exitcode",children:"exitCode"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"exitCode"}),": ",(0,r.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"The exit code of the command."}),"\n",(0,r.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L3787",children:"packages/extension-api/src/extension-api.d.ts:3787"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"killed",children:"killed"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"killed"}),": ",(0,r.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"Indicates whether the process was forcefully killed."}),"\n",(0,r.jsx)(n.h4,{id:"source-4",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L3812",children:"packages/extension-api/src/extension-api.d.ts:3812"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"message",children:"message"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"message"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"The error message."}),"\n",(0,r.jsx)(n.h4,{id:"overrides",children:"Overrides"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.code,{children:"Error.message"})}),"\n",(0,r.jsx)(n.h4,{id:"source-5",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L3782",children:"packages/extension-api/src/extension-api.d.ts:3782"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"name",children:"name"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"name"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"inherited-from-1",children:"Inherited from"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.code,{children:"Error.name"})}),"\n",(0,r.jsx)(n.h4,{id:"source-6",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:"node_modules/typescript/lib/lib.es5.d.ts:1076"}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"stack",children:"stack?"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"optional"})})," ",(0,r.jsx)(n.strong,{children:"stack"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"inherited-from-2",children:"Inherited from"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.code,{children:"Error.stack"})}),"\n",(0,r.jsx)(n.h4,{id:"source-7",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:"node_modules/typescript/lib/lib.es5.d.ts:1078"}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"stderr",children:"stderr"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"stderr"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"The standard error (stderr) content of the command."}),"\n",(0,r.jsx)(n.h4,{id:"source-8",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L3802",children:"packages/extension-api/src/extension-api.d.ts:3802"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"stdout",children:"stdout"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"stdout"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"The standard output (stdout) content of the command."}),"\n",(0,r.jsx)(n.h4,{id:"source-9",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L3797",children:"packages/extension-api/src/extension-api.d.ts:3797"})})]})}function h(e={}){const{wrapper:n}={...(0,c.a)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(a,{...e})}):a(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>o,a:()=>d});var r=s(27378);const c={},i=r.createContext(c);function d(e){const n=r.useContext(i);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(c):e.components||c:d(e.components),r.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/cfdfe126.509157cc.js b/assets/js/cfdfe126.cf276977.js similarity index 98% rename from assets/js/cfdfe126.509157cc.js rename to assets/js/cfdfe126.cf276977.js index cbbf3ac8708..33be8b75d11 100644 --- a/assets/js/cfdfe126.509157cc.js +++ b/assets/js/cfdfe126.cf276977.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[64471],{5900:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>a,contentTitle:()=>r,default:()=>h,frontMatter:()=>i,metadata:()=>c,toc:()=>d});var o=s(24246),t=s(71670);const i={},r="Function: showInformationMessage()",c={id:"namespaces/window/functions/showInformationMessage",title:"Function: showInformationMessage()",description:"showInformationMessage(message, ...items): Promise\\",source:"@site/api/namespaces/window/functions/showInformationMessage.md",sourceDirName:"namespaces/window/functions",slug:"/namespaces/window/functions/showInformationMessage",permalink:"/api/namespaces/window/functions/showInformationMessage",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Function: showErrorMessage()",permalink:"/api/namespaces/window/functions/showErrorMessage"},next:{title:"Function: showInputBox()",permalink:"/api/namespaces/window/functions/showInputBox"}},a={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,t.a)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(n.h1,{id:"function-showinformationmessage",children:"Function: showInformationMessage()"}),"\n",(0,o.jsxs)(n.blockquote,{children:["\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.strong,{children:"showInformationMessage"}),"(",(0,o.jsx)(n.code,{children:"message"}),", ...",(0,o.jsx)(n.code,{children:"items"}),"): ",(0,o.jsx)(n.code,{children:"Promise"}),"< ",(0,o.jsx)(n.code,{children:"string"})," | ",(0,o.jsx)(n.code,{children:"undefined"})," >"]}),"\n"]}),"\n",(0,o.jsx)(n.p,{children:"Show an information message. Optionally provide an array of items which will be presented as\nclickable buttons."}),"\n",(0,o.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,o.jsxs)(n.p,{children:["\u2022 ",(0,o.jsx)(n.strong,{children:"message"}),": ",(0,o.jsx)(n.code,{children:"string"})]}),"\n",(0,o.jsx)(n.p,{children:"The message to show."}),"\n",(0,o.jsxs)(n.p,{children:["\u2022 ...",(0,o.jsx)(n.strong,{children:"items"}),": ",(0,o.jsx)(n.code,{children:"string"}),"[]"]}),"\n",(0,o.jsx)(n.p,{children:"A set of items that will be rendered as actions in the message."}),"\n",(0,o.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.code,{children:"Promise"}),"< ",(0,o.jsx)(n.code,{children:"string"})," | ",(0,o.jsx)(n.code,{children:"undefined"})," >"]}),"\n",(0,o.jsxs)(n.p,{children:["A promise that resolves to the selected item or ",(0,o.jsx)(n.code,{children:"undefined"})," when being dismissed."]}),"\n",(0,o.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,o.jsx)(n.p,{children:(0,o.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L1592",children:"packages/extension-api/src/extension-api.d.ts:1592"})})]})}function h(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(l,{...e})}):l(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>c,a:()=>r});var o=s(27378);const t={},i=o.createContext(t);function r(e){const n=o.useContext(i);return o.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:r(e.components),o.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[64471],{5900:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>a,contentTitle:()=>r,default:()=>h,frontMatter:()=>i,metadata:()=>c,toc:()=>d});var o=s(24246),t=s(71670);const i={},r="Function: showInformationMessage()",c={id:"namespaces/window/functions/showInformationMessage",title:"Function: showInformationMessage()",description:"showInformationMessage(message, ...items): Promise\\",source:"@site/api/namespaces/window/functions/showInformationMessage.md",sourceDirName:"namespaces/window/functions",slug:"/namespaces/window/functions/showInformationMessage",permalink:"/api/namespaces/window/functions/showInformationMessage",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Function: showErrorMessage()",permalink:"/api/namespaces/window/functions/showErrorMessage"},next:{title:"Function: showInputBox()",permalink:"/api/namespaces/window/functions/showInputBox"}},a={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,t.a)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(n.h1,{id:"function-showinformationmessage",children:"Function: showInformationMessage()"}),"\n",(0,o.jsxs)(n.blockquote,{children:["\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.strong,{children:"showInformationMessage"}),"(",(0,o.jsx)(n.code,{children:"message"}),", ...",(0,o.jsx)(n.code,{children:"items"}),"): ",(0,o.jsx)(n.code,{children:"Promise"}),"< ",(0,o.jsx)(n.code,{children:"string"})," | ",(0,o.jsx)(n.code,{children:"undefined"})," >"]}),"\n"]}),"\n",(0,o.jsx)(n.p,{children:"Show an information message. Optionally provide an array of items which will be presented as\nclickable buttons."}),"\n",(0,o.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,o.jsxs)(n.p,{children:["\u2022 ",(0,o.jsx)(n.strong,{children:"message"}),": ",(0,o.jsx)(n.code,{children:"string"})]}),"\n",(0,o.jsx)(n.p,{children:"The message to show."}),"\n",(0,o.jsxs)(n.p,{children:["\u2022 ...",(0,o.jsx)(n.strong,{children:"items"}),": ",(0,o.jsx)(n.code,{children:"string"}),"[]"]}),"\n",(0,o.jsx)(n.p,{children:"A set of items that will be rendered as actions in the message."}),"\n",(0,o.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.code,{children:"Promise"}),"< ",(0,o.jsx)(n.code,{children:"string"})," | ",(0,o.jsx)(n.code,{children:"undefined"})," >"]}),"\n",(0,o.jsxs)(n.p,{children:["A promise that resolves to the selected item or ",(0,o.jsx)(n.code,{children:"undefined"})," when being dismissed."]}),"\n",(0,o.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,o.jsx)(n.p,{children:(0,o.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L1592",children:"packages/extension-api/src/extension-api.d.ts:1592"})})]})}function h(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(l,{...e})}):l(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>c,a:()=>r});var o=s(27378);const t={},i=o.createContext(t);function r(e){const n=o.useContext(i);return o.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:r(e.components),o.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/d103759a.8077d5ff.js b/assets/js/d103759a.d028e56e.js similarity index 96% rename from assets/js/d103759a.8077d5ff.js rename to assets/js/d103759a.d028e56e.js index 7f2c0e38fbf..d0bb7b5c4b0 100644 --- a/assets/js/d103759a.8077d5ff.js +++ b/assets/js/d103759a.d028e56e.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[65191],{2650:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>o,contentTitle:()=>i,default:()=>l,frontMatter:()=>a,metadata:()=>c,toc:()=>u});var r=n(24246),s=n(71670);const a={},i="Function: createStatusBarItem()",c={id:"namespaces/window/functions/createStatusBarItem",title:"Function: createStatusBarItem()",description:"createStatusBarItem(alignment?, priority?): StatusBarItem",source:"@site/api/namespaces/window/functions/createStatusBarItem.md",sourceDirName:"namespaces/window/functions",slug:"/namespaces/window/functions/createStatusBarItem",permalink:"/api/namespaces/window/functions/createStatusBarItem",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Function: createCustomPick()",permalink:"/api/namespaces/window/functions/createCustomPick"},next:{title:"Function: createWebviewPanel()",permalink:"/api/namespaces/window/functions/createWebviewPanel"}},o={},u=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function d(e){const t={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(t.h1,{id:"function-createstatusbaritem",children:"Function: createStatusBarItem()"}),"\n",(0,r.jsxs)(t.blockquote,{children:["\n",(0,r.jsxs)(t.p,{children:[(0,r.jsx)(t.strong,{children:"createStatusBarItem"}),"(",(0,r.jsx)(t.code,{children:"alignment"}),"?, ",(0,r.jsx)(t.code,{children:"priority"}),"?): ",(0,r.jsx)(t.a,{href:"/api/interfaces/StatusBarItem",children:(0,r.jsx)(t.code,{children:"StatusBarItem"})})]}),"\n"]}),"\n",(0,r.jsxs)(t.p,{children:["Creates a status bar ",(0,r.jsx)(t.a,{href:"/api/interfaces/StatusBarItem",children:"StatusBarItem"})," item."]}),"\n",(0,r.jsx)(t.h2,{id:"parameters",children:"Parameters"}),"\n",(0,r.jsxs)(t.p,{children:["\u2022 ",(0,r.jsx)(t.strong,{children:"alignment?"}),": ",(0,r.jsx)(t.a,{href:"/api/type-aliases/StatusBarAlignment",children:(0,r.jsx)(t.code,{children:"StatusBarAlignment"})})]}),"\n",(0,r.jsx)(t.p,{children:"The alignment of the item."}),"\n",(0,r.jsxs)(t.p,{children:["\u2022 ",(0,r.jsx)(t.strong,{children:"priority?"}),": ",(0,r.jsx)(t.code,{children:"number"})]}),"\n",(0,r.jsx)(t.p,{children:"The priority of the item. Higher values mean more to the left or more to the right."}),"\n",(0,r.jsx)(t.h2,{id:"returns",children:"Returns"}),"\n",(0,r.jsx)(t.p,{children:(0,r.jsx)(t.a,{href:"/api/interfaces/StatusBarItem",children:(0,r.jsx)(t.code,{children:"StatusBarItem"})})}),"\n",(0,r.jsx)(t.p,{children:"A new status bar item."}),"\n",(0,r.jsx)(t.h2,{id:"source",children:"Source"}),"\n",(0,r.jsx)(t.p,{children:(0,r.jsx)(t.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L1691",children:"packages/extension-api/src/extension-api.d.ts:1691"})})]})}function l(e={}){const{wrapper:t}={...(0,s.a)(),...e.components};return t?(0,r.jsx)(t,{...e,children:(0,r.jsx)(d,{...e})}):d(e)}},71670:(e,t,n)=>{n.d(t,{Z:()=>c,a:()=>i});var r=n(27378);const s={},a=r.createContext(s);function i(e){const t=r.useContext(a);return r.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function c(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:i(e.components),r.createElement(a.Provider,{value:t},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[65191],{2650:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>o,contentTitle:()=>i,default:()=>l,frontMatter:()=>a,metadata:()=>c,toc:()=>u});var r=n(24246),s=n(71670);const a={},i="Function: createStatusBarItem()",c={id:"namespaces/window/functions/createStatusBarItem",title:"Function: createStatusBarItem()",description:"createStatusBarItem(alignment?, priority?): StatusBarItem",source:"@site/api/namespaces/window/functions/createStatusBarItem.md",sourceDirName:"namespaces/window/functions",slug:"/namespaces/window/functions/createStatusBarItem",permalink:"/api/namespaces/window/functions/createStatusBarItem",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Function: createCustomPick()",permalink:"/api/namespaces/window/functions/createCustomPick"},next:{title:"Function: createWebviewPanel()",permalink:"/api/namespaces/window/functions/createWebviewPanel"}},o={},u=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function d(e){const t={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(t.h1,{id:"function-createstatusbaritem",children:"Function: createStatusBarItem()"}),"\n",(0,r.jsxs)(t.blockquote,{children:["\n",(0,r.jsxs)(t.p,{children:[(0,r.jsx)(t.strong,{children:"createStatusBarItem"}),"(",(0,r.jsx)(t.code,{children:"alignment"}),"?, ",(0,r.jsx)(t.code,{children:"priority"}),"?): ",(0,r.jsx)(t.a,{href:"/api/interfaces/StatusBarItem",children:(0,r.jsx)(t.code,{children:"StatusBarItem"})})]}),"\n"]}),"\n",(0,r.jsxs)(t.p,{children:["Creates a status bar ",(0,r.jsx)(t.a,{href:"/api/interfaces/StatusBarItem",children:"StatusBarItem"})," item."]}),"\n",(0,r.jsx)(t.h2,{id:"parameters",children:"Parameters"}),"\n",(0,r.jsxs)(t.p,{children:["\u2022 ",(0,r.jsx)(t.strong,{children:"alignment?"}),": ",(0,r.jsx)(t.a,{href:"/api/type-aliases/StatusBarAlignment",children:(0,r.jsx)(t.code,{children:"StatusBarAlignment"})})]}),"\n",(0,r.jsx)(t.p,{children:"The alignment of the item."}),"\n",(0,r.jsxs)(t.p,{children:["\u2022 ",(0,r.jsx)(t.strong,{children:"priority?"}),": ",(0,r.jsx)(t.code,{children:"number"})]}),"\n",(0,r.jsx)(t.p,{children:"The priority of the item. Higher values mean more to the left or more to the right."}),"\n",(0,r.jsx)(t.h2,{id:"returns",children:"Returns"}),"\n",(0,r.jsx)(t.p,{children:(0,r.jsx)(t.a,{href:"/api/interfaces/StatusBarItem",children:(0,r.jsx)(t.code,{children:"StatusBarItem"})})}),"\n",(0,r.jsx)(t.p,{children:"A new status bar item."}),"\n",(0,r.jsx)(t.h2,{id:"source",children:"Source"}),"\n",(0,r.jsx)(t.p,{children:(0,r.jsx)(t.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L1691",children:"packages/extension-api/src/extension-api.d.ts:1691"})})]})}function l(e={}){const{wrapper:t}={...(0,s.a)(),...e.components};return t?(0,r.jsx)(t,{...e,children:(0,r.jsx)(d,{...e})}):d(e)}},71670:(e,t,n)=>{n.d(t,{Z:()=>c,a:()=>i});var r=n(27378);const s={},a=r.createContext(s);function i(e){const t=r.useContext(a);return r.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function c(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:i(e.components),r.createElement(a.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/d1163e47.f83b2fc3.js b/assets/js/d1163e47.42aa0e91.js similarity index 97% rename from assets/js/d1163e47.f83b2fc3.js rename to assets/js/d1163e47.42aa0e91.js index 41376b6a8ed..1eaa07711a1 100644 --- a/assets/js/d1163e47.f83b2fc3.js +++ b/assets/js/d1163e47.42aa0e91.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[59860],{95237:(e,r,t)=>{t.r(r),t.d(r,{assets:()=>s,contentTitle:()=>i,default:()=>h,frontMatter:()=>c,metadata:()=>o,toc:()=>d});var n=t(24246),a=t(71670);const c={},i="Interface: ImageCheckerProviderMetadata",o={id:"interfaces/ImageCheckerProviderMetadata",title:"Interface: ImageCheckerProviderMetadata",description:"Properties",source:"@site/api/interfaces/ImageCheckerProviderMetadata.md",sourceDirName:"interfaces",slug:"/interfaces/ImageCheckerProviderMetadata",permalink:"/api/interfaces/ImageCheckerProviderMetadata",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: ImageCheckerProvider",permalink:"/api/interfaces/ImageCheckerProvider"},next:{title:"Interface: ImageChecks",permalink:"/api/interfaces/ImageChecks"}},s={},d=[{value:"Properties",id:"properties",level:2},{value:"label",id:"label",level:3},{value:"Source",id:"source",level:4}];function l(e){const r={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",p:"p",strong:"strong",...(0,a.a)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(r.h1,{id:"interface-imagecheckerprovidermetadata",children:"Interface: ImageCheckerProviderMetadata"}),"\n",(0,n.jsx)(r.h2,{id:"properties",children:"Properties"}),"\n",(0,n.jsx)(r.h3,{id:"label",children:"label"}),"\n",(0,n.jsxs)(r.blockquote,{children:["\n",(0,n.jsxs)(r.p,{children:[(0,n.jsx)(r.strong,{children:(0,n.jsx)(r.code,{children:"readonly"})})," ",(0,n.jsx)(r.strong,{children:"label"}),": ",(0,n.jsx)(r.code,{children:"string"})]}),"\n"]}),"\n",(0,n.jsx)(r.h4,{id:"source",children:"Source"}),"\n",(0,n.jsx)(r.p,{children:(0,n.jsx)(r.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L4113",children:"packages/extension-api/src/extension-api.d.ts:4113"})})]})}function h(e={}){const{wrapper:r}={...(0,a.a)(),...e.components};return r?(0,n.jsx)(r,{...e,children:(0,n.jsx)(l,{...e})}):l(e)}},71670:(e,r,t)=>{t.d(r,{Z:()=>o,a:()=>i});var n=t(27378);const a={},c=n.createContext(a);function i(e){const r=n.useContext(c);return n.useMemo((function(){return"function"==typeof e?e(r):{...r,...e}}),[r,e])}function o(e){let r;return r=e.disableParentContext?"function"==typeof e.components?e.components(a):e.components||a:i(e.components),n.createElement(c.Provider,{value:r},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[59860],{95237:(e,r,t)=>{t.r(r),t.d(r,{assets:()=>s,contentTitle:()=>i,default:()=>h,frontMatter:()=>c,metadata:()=>o,toc:()=>d});var n=t(24246),a=t(71670);const c={},i="Interface: ImageCheckerProviderMetadata",o={id:"interfaces/ImageCheckerProviderMetadata",title:"Interface: ImageCheckerProviderMetadata",description:"Properties",source:"@site/api/interfaces/ImageCheckerProviderMetadata.md",sourceDirName:"interfaces",slug:"/interfaces/ImageCheckerProviderMetadata",permalink:"/api/interfaces/ImageCheckerProviderMetadata",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: ImageCheckerProvider",permalink:"/api/interfaces/ImageCheckerProvider"},next:{title:"Interface: ImageChecks",permalink:"/api/interfaces/ImageChecks"}},s={},d=[{value:"Properties",id:"properties",level:2},{value:"label",id:"label",level:3},{value:"Source",id:"source",level:4}];function l(e){const r={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",p:"p",strong:"strong",...(0,a.a)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(r.h1,{id:"interface-imagecheckerprovidermetadata",children:"Interface: ImageCheckerProviderMetadata"}),"\n",(0,n.jsx)(r.h2,{id:"properties",children:"Properties"}),"\n",(0,n.jsx)(r.h3,{id:"label",children:"label"}),"\n",(0,n.jsxs)(r.blockquote,{children:["\n",(0,n.jsxs)(r.p,{children:[(0,n.jsx)(r.strong,{children:(0,n.jsx)(r.code,{children:"readonly"})})," ",(0,n.jsx)(r.strong,{children:"label"}),": ",(0,n.jsx)(r.code,{children:"string"})]}),"\n"]}),"\n",(0,n.jsx)(r.h4,{id:"source",children:"Source"}),"\n",(0,n.jsx)(r.p,{children:(0,n.jsx)(r.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L4113",children:"packages/extension-api/src/extension-api.d.ts:4113"})})]})}function h(e={}){const{wrapper:r}={...(0,a.a)(),...e.components};return r?(0,n.jsx)(r,{...e,children:(0,n.jsx)(l,{...e})}):l(e)}},71670:(e,r,t)=>{t.d(r,{Z:()=>o,a:()=>i});var n=t(27378);const a={},c=n.createContext(a);function i(e){const r=n.useContext(c);return n.useMemo((function(){return"function"==typeof e?e(r):{...r,...e}}),[r,e])}function o(e){let r;return r=e.disableParentContext?"function"==typeof e.components?e.components(a):e.components||a:i(e.components),n.createElement(c.Provider,{value:r},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/d46ef83d.c5bf987b.js b/assets/js/d46ef83d.a65e59af.js similarity index 97% rename from assets/js/d46ef83d.c5bf987b.js rename to assets/js/d46ef83d.a65e59af.js index c3b666a4be9..1dd69431185 100644 --- a/assets/js/d46ef83d.c5bf987b.js +++ b/assets/js/d46ef83d.a65e59af.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[10579],{96129:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>c,contentTitle:()=>r,default:()=>d,frontMatter:()=>s,metadata:()=>i,toc:()=>p});var o=n(24246),a=n(71670);const s={},r="Type alias: MountPropagation",i={id:"type-aliases/MountPropagation",title:"Type alias: MountPropagation",description:'MountPropagation: "private" \\| "rprivate" \\| "shared" \\| "rshared" \\| "slave" \\| "rslave"',source:"@site/api/type-aliases/MountPropagation.md",sourceDirName:"type-aliases",slug:"/type-aliases/MountPropagation",permalink:"/api/type-aliases/MountPropagation",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Type alias: MountConsistency",permalink:"/api/type-aliases/MountConsistency"},next:{title:"Type alias: MountType",permalink:"/api/type-aliases/MountType"}},c={},p=[{value:"Source",id:"source",level:2}];function l(e){const t={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,a.a)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(t.h1,{id:"type-alias-mountpropagation",children:"Type alias: MountPropagation"}),"\n",(0,o.jsxs)(t.blockquote,{children:["\n",(0,o.jsxs)(t.p,{children:[(0,o.jsx)(t.strong,{children:"MountPropagation"}),": ",(0,o.jsx)(t.code,{children:'"private"'})," | ",(0,o.jsx)(t.code,{children:'"rprivate"'})," | ",(0,o.jsx)(t.code,{children:'"shared"'})," | ",(0,o.jsx)(t.code,{children:'"rshared"'})," | ",(0,o.jsx)(t.code,{children:'"slave"'})," | ",(0,o.jsx)(t.code,{children:'"rslave"'})]}),"\n"]}),"\n",(0,o.jsx)(t.h2,{id:"source",children:"Source"}),"\n",(0,o.jsx)(t.p,{children:(0,o.jsx)(t.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2092",children:"packages/extension-api/src/extension-api.d.ts:2092"})})]})}function d(e={}){const{wrapper:t}={...(0,a.a)(),...e.components};return t?(0,o.jsx)(t,{...e,children:(0,o.jsx)(l,{...e})}):l(e)}},71670:(e,t,n)=>{n.d(t,{Z:()=>i,a:()=>r});var o=n(27378);const a={},s=o.createContext(a);function r(e){const t=o.useContext(s);return o.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function i(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(a):e.components||a:r(e.components),o.createElement(s.Provider,{value:t},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[10579],{96129:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>c,contentTitle:()=>r,default:()=>d,frontMatter:()=>s,metadata:()=>i,toc:()=>p});var o=n(24246),a=n(71670);const s={},r="Type alias: MountPropagation",i={id:"type-aliases/MountPropagation",title:"Type alias: MountPropagation",description:'MountPropagation: "private" \\| "rprivate" \\| "shared" \\| "rshared" \\| "slave" \\| "rslave"',source:"@site/api/type-aliases/MountPropagation.md",sourceDirName:"type-aliases",slug:"/type-aliases/MountPropagation",permalink:"/api/type-aliases/MountPropagation",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Type alias: MountConsistency",permalink:"/api/type-aliases/MountConsistency"},next:{title:"Type alias: MountType",permalink:"/api/type-aliases/MountType"}},c={},p=[{value:"Source",id:"source",level:2}];function l(e){const t={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,a.a)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(t.h1,{id:"type-alias-mountpropagation",children:"Type alias: MountPropagation"}),"\n",(0,o.jsxs)(t.blockquote,{children:["\n",(0,o.jsxs)(t.p,{children:[(0,o.jsx)(t.strong,{children:"MountPropagation"}),": ",(0,o.jsx)(t.code,{children:'"private"'})," | ",(0,o.jsx)(t.code,{children:'"rprivate"'})," | ",(0,o.jsx)(t.code,{children:'"shared"'})," | ",(0,o.jsx)(t.code,{children:'"rshared"'})," | ",(0,o.jsx)(t.code,{children:'"slave"'})," | ",(0,o.jsx)(t.code,{children:'"rslave"'})]}),"\n"]}),"\n",(0,o.jsx)(t.h2,{id:"source",children:"Source"}),"\n",(0,o.jsx)(t.p,{children:(0,o.jsx)(t.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2092",children:"packages/extension-api/src/extension-api.d.ts:2092"})})]})}function d(e={}){const{wrapper:t}={...(0,a.a)(),...e.components};return t?(0,o.jsx)(t,{...e,children:(0,o.jsx)(l,{...e})}):l(e)}},71670:(e,t,n)=>{n.d(t,{Z:()=>i,a:()=>r});var o=n(27378);const a={},s=o.createContext(a);function r(e){const t=o.useContext(s);return o.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function i(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(a):e.components||a:r(e.components),o.createElement(s.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/d496897e.9944ccdd.js b/assets/js/d496897e.653492b3.js similarity index 90% rename from assets/js/d496897e.9944ccdd.js rename to assets/js/d496897e.653492b3.js index 5129e45abef..f5ba77ec744 100644 --- a/assets/js/d496897e.9944ccdd.js +++ b/assets/js/d496897e.653492b3.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[25211],{65290:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>o,default:()=>u,frontMatter:()=>i,metadata:()=>r,toc:()=>d});var c=t(24246),s=t(71670);const i={},o="Function: createPod()",r={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:"Function: createNetwork()",permalink:"/api/namespaces/containerEngine/functions/createNetwork"},next:{title:"Function: createVolume()",permalink:"/api/namespaces/containerEngine/functions/createVolume"}},a={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Id",id:"id",level:3},{value:"engineId",id:"engineid",level:3},{value:"Source",id:"source",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,c.jsxs)(c.Fragment,{children:[(0,c.jsx)(n.h1,{id:"function-createpod",children:"Function: createPod()"}),"\n",(0,c.jsxs)(n.blockquote,{children:["\n",(0,c.jsxs)(n.p,{children:[(0,c.jsx)(n.strong,{children:"createPod"}),"(",(0,c.jsx)(n.code,{children:"podOptions"}),"): ",(0,c.jsx)(n.code,{children:"Promise"}),"< ",(0,c.jsx)(n.code,{children:"object"})," >"]}),"\n"]}),"\n",(0,c.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,c.jsxs)(n.p,{children:["\u2022 ",(0,c.jsx)(n.strong,{children:"podOptions"}),": ",(0,c.jsx)(n.a,{href:"/api/interfaces/PodCreateOptions",children:(0,c.jsx)(n.code,{children:"PodCreateOptions"})})]}),"\n",(0,c.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,c.jsxs)(n.p,{children:[(0,c.jsx)(n.code,{children:"Promise"}),"< ",(0,c.jsx)(n.code,{children:"object"})," >"]}),"\n",(0,c.jsxs)(n.blockquote,{children:["\n",(0,c.jsx)(n.h3,{id:"id",children:"Id"}),"\n",(0,c.jsxs)(n.blockquote,{children:["\n",(0,c.jsxs)(n.p,{children:[(0,c.jsx)(n.strong,{children:"Id"}),": ",(0,c.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,c.jsx)(n.h3,{id:"engineid",children:"engineId"}),"\n",(0,c.jsxs)(n.blockquote,{children:["\n",(0,c.jsxs)(n.p,{children:[(0,c.jsx)(n.strong,{children:"engineId"}),": ",(0,c.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n"]}),"\n",(0,c.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,c.jsx)(n.p,{children:(0,c.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L3374",children:"packages/extension-api/src/extension-api.d.ts:3374"})})]})}function u(e={}){const{wrapper:n}={...(0,s.a)(),...e.components};return n?(0,c.jsx)(n,{...e,children:(0,c.jsx)(l,{...e})}):l(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>r,a:()=>o});var c=t(27378);const s={},i=c.createContext(s);function o(e){const n=c.useContext(i);return c.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function r(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:o(e.components),c.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[25211],{65290:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>d,contentTitle:()=>o,default:()=>u,frontMatter:()=>i,metadata:()=>r,toc:()=>a});var c=t(24246),s=t(71670);const i={},o="Function: createPod()",r={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:"Function: createNetwork()",permalink:"/api/namespaces/containerEngine/functions/createNetwork"},next:{title:"Function: createVolume()",permalink:"/api/namespaces/containerEngine/functions/createVolume"}},d={},a=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Id",id:"id",level:3},{value:"engineId",id:"engineid",level:3},{value:"Source",id:"source",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,c.jsxs)(c.Fragment,{children:[(0,c.jsx)(n.h1,{id:"function-createpod",children:"Function: createPod()"}),"\n",(0,c.jsxs)(n.blockquote,{children:["\n",(0,c.jsxs)(n.p,{children:[(0,c.jsx)(n.strong,{children:"createPod"}),"(",(0,c.jsx)(n.code,{children:"podOptions"}),"): ",(0,c.jsx)(n.code,{children:"Promise"}),"< ",(0,c.jsx)(n.code,{children:"object"})," >"]}),"\n"]}),"\n",(0,c.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,c.jsxs)(n.p,{children:["\u2022 ",(0,c.jsx)(n.strong,{children:"podOptions"}),": ",(0,c.jsx)(n.a,{href:"/api/interfaces/PodCreateOptions",children:(0,c.jsx)(n.code,{children:"PodCreateOptions"})})]}),"\n",(0,c.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,c.jsxs)(n.p,{children:[(0,c.jsx)(n.code,{children:"Promise"}),"< ",(0,c.jsx)(n.code,{children:"object"})," >"]}),"\n",(0,c.jsxs)(n.blockquote,{children:["\n",(0,c.jsx)(n.h3,{id:"id",children:"Id"}),"\n",(0,c.jsxs)(n.blockquote,{children:["\n",(0,c.jsxs)(n.p,{children:[(0,c.jsx)(n.strong,{children:"Id"}),": ",(0,c.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,c.jsx)(n.h3,{id:"engineid",children:"engineId"}),"\n",(0,c.jsxs)(n.blockquote,{children:["\n",(0,c.jsxs)(n.p,{children:[(0,c.jsx)(n.strong,{children:"engineId"}),": ",(0,c.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n"]}),"\n",(0,c.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,c.jsx)(n.p,{children:(0,c.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L3374",children:"packages/extension-api/src/extension-api.d.ts:3374"})})]})}function u(e={}){const{wrapper:n}={...(0,s.a)(),...e.components};return n?(0,c.jsx)(n,{...e,children:(0,c.jsx)(l,{...e})}):l(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>r,a:()=>o});var c=t(27378);const s={},i=c.createContext(s);function o(e){const n=c.useContext(i);return c.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function r(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:o(e.components),c.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/d66cbd9e.730740ec.js b/assets/js/d66cbd9e.fd5078df.js similarity index 89% rename from assets/js/d66cbd9e.730740ec.js rename to assets/js/d66cbd9e.fd5078df.js index 06a1e6f0f32..d166108b2bf 100644 --- a/assets/js/d66cbd9e.730740ec.js +++ b/assets/js/d66cbd9e.fd5078df.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[20044],{85385:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>a,contentTitle:()=>c,default:()=>p,frontMatter:()=>i,metadata:()=>o,toc:()=>d});var t=r(24246),s=r(71670);const i={},c="Interface: Port",o={id:"interfaces/Port",title:"Interface: Port",description:"Properties",source:"@site/api/interfaces/Port.md",sourceDirName:"interfaces",slug:"/interfaces/Port",permalink:"/api/interfaces/Port",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: PodmanContainerCreateOptions",permalink:"/api/interfaces/PodmanContainerCreateOptions"},next:{title:"Interface: PortBinding",permalink:"/api/interfaces/PortBinding"}},a={},d=[{value:"Properties",id:"properties",level:2},{value:"IP",id:"ip",level:3},{value:"Source",id:"source",level:4},{value:"PrivatePort",id:"privateport",level:3},{value:"Source",id:"source-1",level:4},{value:"PublicPort",id:"publicport",level:3},{value:"Source",id:"source-2",level:4},{value:"Type",id:"type",level:3},{value:"Source",id:"source-3",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"interface-port",children:"Interface: Port"}),"\n",(0,t.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,t.jsx)(n.h3,{id:"ip",children:"IP"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"IP"}),": ",(0,t.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2017",children:"packages/extension-api/src/extension-api.d.ts:2017"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"privateport",children:"PrivatePort"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"PrivatePort"}),": ",(0,t.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2018",children:"packages/extension-api/src/extension-api.d.ts:2018"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"publicport",children:"PublicPort"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"PublicPort"}),": ",(0,t.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2019",children:"packages/extension-api/src/extension-api.d.ts:2019"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"type",children:"Type"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"Type"}),": ",(0,t.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2020",children:"packages/extension-api/src/extension-api.d.ts:2020"})})]})}function p(e={}){const{wrapper:n}={...(0,s.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},71670:(e,n,r)=>{r.d(n,{Z:()=>o,a:()=>c});var t=r(27378);const s={},i=t.createContext(s);function c(e){const n=t.useContext(i);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:c(e.components),t.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[20044],{85385:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>a,contentTitle:()=>c,default:()=>p,frontMatter:()=>i,metadata:()=>o,toc:()=>d});var t=r(24246),s=r(71670);const i={},c="Interface: Port",o={id:"interfaces/Port",title:"Interface: Port",description:"Properties",source:"@site/api/interfaces/Port.md",sourceDirName:"interfaces",slug:"/interfaces/Port",permalink:"/api/interfaces/Port",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: PodmanContainerCreateOptions",permalink:"/api/interfaces/PodmanContainerCreateOptions"},next:{title:"Interface: PortBinding",permalink:"/api/interfaces/PortBinding"}},a={},d=[{value:"Properties",id:"properties",level:2},{value:"IP",id:"ip",level:3},{value:"Source",id:"source",level:4},{value:"PrivatePort",id:"privateport",level:3},{value:"Source",id:"source-1",level:4},{value:"PublicPort",id:"publicport",level:3},{value:"Source",id:"source-2",level:4},{value:"Type",id:"type",level:3},{value:"Source",id:"source-3",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"interface-port",children:"Interface: Port"}),"\n",(0,t.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,t.jsx)(n.h3,{id:"ip",children:"IP"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"IP"}),": ",(0,t.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2017",children:"packages/extension-api/src/extension-api.d.ts:2017"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"privateport",children:"PrivatePort"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"PrivatePort"}),": ",(0,t.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2018",children:"packages/extension-api/src/extension-api.d.ts:2018"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"publicport",children:"PublicPort"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"PublicPort"}),": ",(0,t.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2019",children:"packages/extension-api/src/extension-api.d.ts:2019"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"type",children:"Type"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"Type"}),": ",(0,t.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2020",children:"packages/extension-api/src/extension-api.d.ts:2020"})})]})}function p(e={}){const{wrapper:n}={...(0,s.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},71670:(e,n,r)=>{r.d(n,{Z:()=>o,a:()=>c});var t=r(27378);const s={},i=t.createContext(s);function c(e){const n=t.useContext(i);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:c(e.components),t.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/d739767a.fe28638e.js b/assets/js/d739767a.15a11c1a.js similarity index 98% rename from assets/js/d739767a.fe28638e.js rename to assets/js/d739767a.15a11c1a.js index 1e0c4c903b6..8e6a5ae7f94 100644 --- a/assets/js/d739767a.fe28638e.js +++ b/assets/js/d739767a.15a11c1a.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[64389],{58043:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>o,contentTitle:()=>a,default:()=>h,frontMatter:()=>i,metadata:()=>c,toc:()=>l});var t=s(24246),r=s(71670);const i={},a="Function: onDidChangeTelemetryEnabled()",c={id:"namespaces/env/functions/onDidChangeTelemetryEnabled",title:"Function: onDidChangeTelemetryEnabled()",description:"onDidChangeTelemetryEnabled(listener, thisArgs?, disposables?): Disposable",source:"@site/api/namespaces/env/functions/onDidChangeTelemetryEnabled.md",sourceDirName:"namespaces/env/functions",slug:"/namespaces/env/functions/onDidChangeTelemetryEnabled",permalink:"/api/namespaces/env/functions/onDidChangeTelemetryEnabled",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Function: createTelemetryLogger()",permalink:"/api/namespaces/env/functions/createTelemetryLogger"},next:{title:"Function: openExternal()",permalink:"/api/namespaces/env/functions/openExternal"}},o={},l=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function d(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,r.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"function-ondidchangetelemetryenabled",children:"Function: onDidChangeTelemetryEnabled()"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"onDidChangeTelemetryEnabled"}),"(",(0,t.jsx)(n.code,{children:"listener"}),", ",(0,t.jsx)(n.code,{children:"thisArgs"}),"?, ",(0,t.jsx)(n.code,{children:"disposables"}),"?): ",(0,t.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,t.jsx)(n.code,{children:"Disposable"})})]}),"\n"]}),"\n",(0,t.jsxs)(n.p,{children:["An ",(0,t.jsx)(n.a,{href:"/api/interfaces/Event",children:"Event"})," which fires when the user enabled or disables telemetry.\n",(0,t.jsx)(n.code,{children:"true"})," if the user has enabled telemetry or ",(0,t.jsx)(n.code,{children:"false"})," if the user has disabled telemetry."]}),"\n",(0,t.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"listener"})]}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"thisArgs?"}),": ",(0,t.jsx)(n.code,{children:"any"})]}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"disposables?"}),": ",(0,t.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,t.jsx)(n.code,{children:"Disposable"})}),"[]"]}),"\n",(0,t.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,t.jsx)(n.code,{children:"Disposable"})})}),"\n",(0,t.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L3695",children:"packages/extension-api/src/extension-api.d.ts:3695"})})]})}function h(e={}){const{wrapper:n}={...(0,r.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(d,{...e})}):d(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>c,a:()=>a});var t=s(27378);const r={},i=t.createContext(r);function a(e){const n=t.useContext(i);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:a(e.components),t.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[64389],{58043:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>o,contentTitle:()=>a,default:()=>h,frontMatter:()=>i,metadata:()=>c,toc:()=>l});var t=s(24246),r=s(71670);const i={},a="Function: onDidChangeTelemetryEnabled()",c={id:"namespaces/env/functions/onDidChangeTelemetryEnabled",title:"Function: onDidChangeTelemetryEnabled()",description:"onDidChangeTelemetryEnabled(listener, thisArgs?, disposables?): Disposable",source:"@site/api/namespaces/env/functions/onDidChangeTelemetryEnabled.md",sourceDirName:"namespaces/env/functions",slug:"/namespaces/env/functions/onDidChangeTelemetryEnabled",permalink:"/api/namespaces/env/functions/onDidChangeTelemetryEnabled",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Function: createTelemetryLogger()",permalink:"/api/namespaces/env/functions/createTelemetryLogger"},next:{title:"Function: openExternal()",permalink:"/api/namespaces/env/functions/openExternal"}},o={},l=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function d(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,r.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"function-ondidchangetelemetryenabled",children:"Function: onDidChangeTelemetryEnabled()"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"onDidChangeTelemetryEnabled"}),"(",(0,t.jsx)(n.code,{children:"listener"}),", ",(0,t.jsx)(n.code,{children:"thisArgs"}),"?, ",(0,t.jsx)(n.code,{children:"disposables"}),"?): ",(0,t.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,t.jsx)(n.code,{children:"Disposable"})})]}),"\n"]}),"\n",(0,t.jsxs)(n.p,{children:["An ",(0,t.jsx)(n.a,{href:"/api/interfaces/Event",children:"Event"})," which fires when the user enabled or disables telemetry.\n",(0,t.jsx)(n.code,{children:"true"})," if the user has enabled telemetry or ",(0,t.jsx)(n.code,{children:"false"})," if the user has disabled telemetry."]}),"\n",(0,t.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"listener"})]}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"thisArgs?"}),": ",(0,t.jsx)(n.code,{children:"any"})]}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"disposables?"}),": ",(0,t.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,t.jsx)(n.code,{children:"Disposable"})}),"[]"]}),"\n",(0,t.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,t.jsx)(n.code,{children:"Disposable"})})}),"\n",(0,t.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L3695",children:"packages/extension-api/src/extension-api.d.ts:3695"})})]})}function h(e={}){const{wrapper:n}={...(0,r.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(d,{...e})}):d(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>c,a:()=>a});var t=s(27378);const r={},i=t.createContext(r);function a(e){const n=t.useContext(i);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:a(e.components),t.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/d83f208d.f05356f8.js b/assets/js/d83f208d.d9a894b1.js similarity index 91% rename from assets/js/d83f208d.f05356f8.js rename to assets/js/d83f208d.d9a894b1.js index 315391e0ed0..2476c11d1cc 100644 --- a/assets/js/d83f208d.f05356f8.js +++ b/assets/js/d83f208d.d9a894b1.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[13317],{30245:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>d,contentTitle:()=>o,default:()=>h,frontMatter:()=>r,metadata:()=>t,toc:()=>l});var i=s(24246),c=s(71670);const r={},o="Interface: RunOptions",t={id:"interfaces/RunOptions",title:"Interface: RunOptions",description:"Options for running a command.",source:"@site/api/interfaces/RunOptions.md",sourceDirName:"interfaces",slug:"/interfaces/RunOptions",permalink:"/api/interfaces/RunOptions",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: RunError",permalink:"/api/interfaces/RunError"},next:{title:"Interface: RunResult",permalink:"/api/interfaces/RunResult"}},d={},l=[{value:"Properties",id:"properties",level:2},{value:"cwd?",id:"cwd",level:3},{value:"Source",id:"source",level:4},{value:"encoding?",id:"encoding",level:3},{value:"Source",id:"source-1",level:4},{value:"env?",id:"env",level:3},{value:"Index signature",id:"index-signature",level:4},{value:"Source",id:"source-2",level:4},{value:"isAdmin?",id:"isadmin",level:3},{value:"Source",id:"source-3",level:4},{value:"logger?",id:"logger",level:3},{value:"Source",id:"source-4",level:4},{value:"token?",id:"token",level:3},{value:"Source",id:"source-5",level:4}];function a(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,c.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"interface-runoptions",children:"Interface: RunOptions"}),"\n",(0,i.jsx)(n.p,{children:"Options for running a command."}),"\n",(0,i.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(n.h3,{id:"cwd",children:"cwd?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"cwd"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"custom directory"}),"\n",(0,i.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L3742",children:"packages/extension-api/src/extension-api.d.ts:3742"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"encoding",children:"encoding?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"encoding"}),": ",(0,i.jsx)(n.code,{children:"BufferEncoding"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"The encoding to use. Default utf8"}),"\n",(0,i.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L3752",children:"packages/extension-api/src/extension-api.d.ts:3752"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"env",children:"env?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"env"}),": ",(0,i.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Environment variables to set for the command."}),"\n",(0,i.jsx)(n.h4,{id:"index-signature",children:"Index signature"}),"\n",(0,i.jsxs)(n.p,{children:["[",(0,i.jsx)(n.code,{children:"key"}),": ",(0,i.jsx)(n.code,{children:"string"}),"]: ",(0,i.jsx)(n.code,{children:"string"})]}),"\n",(0,i.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L3727",children:"packages/extension-api/src/extension-api.d.ts:3727"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"isadmin",children:"isAdmin?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"isAdmin"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"admin privileges required"}),"\n",(0,i.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L3747",children:"packages/extension-api/src/extension-api.d.ts:3747"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"logger",children:"logger?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"logger"}),": ",(0,i.jsx)(n.a,{href:"/api/interfaces/Logger",children:(0,i.jsx)(n.code,{children:"Logger"})})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"A logger used to track execution events."}),"\n",(0,i.jsx)(n.h4,{id:"source-4",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L3737",children:"packages/extension-api/src/extension-api.d.ts:3737"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"token",children:"token?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"token"}),": ",(0,i.jsx)(n.a,{href:"/api/interfaces/CancellationToken",children:(0,i.jsx)(n.code,{children:"CancellationToken"})})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"A cancellation token used to request cancellation."}),"\n",(0,i.jsx)(n.h4,{id:"source-5",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L3732",children:"packages/extension-api/src/extension-api.d.ts:3732"})})]})}function h(e={}){const{wrapper:n}={...(0,c.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(a,{...e})}):a(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>t,a:()=>o});var i=s(27378);const c={},r=i.createContext(c);function o(e){const n=i.useContext(r);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function t(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(c):e.components||c:o(e.components),i.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[13317],{30245:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>d,contentTitle:()=>o,default:()=>h,frontMatter:()=>r,metadata:()=>t,toc:()=>l});var i=s(24246),c=s(71670);const r={},o="Interface: RunOptions",t={id:"interfaces/RunOptions",title:"Interface: RunOptions",description:"Options for running a command.",source:"@site/api/interfaces/RunOptions.md",sourceDirName:"interfaces",slug:"/interfaces/RunOptions",permalink:"/api/interfaces/RunOptions",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: RunError",permalink:"/api/interfaces/RunError"},next:{title:"Interface: RunResult",permalink:"/api/interfaces/RunResult"}},d={},l=[{value:"Properties",id:"properties",level:2},{value:"cwd?",id:"cwd",level:3},{value:"Source",id:"source",level:4},{value:"encoding?",id:"encoding",level:3},{value:"Source",id:"source-1",level:4},{value:"env?",id:"env",level:3},{value:"Index signature",id:"index-signature",level:4},{value:"Source",id:"source-2",level:4},{value:"isAdmin?",id:"isadmin",level:3},{value:"Source",id:"source-3",level:4},{value:"logger?",id:"logger",level:3},{value:"Source",id:"source-4",level:4},{value:"token?",id:"token",level:3},{value:"Source",id:"source-5",level:4}];function a(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,c.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"interface-runoptions",children:"Interface: RunOptions"}),"\n",(0,i.jsx)(n.p,{children:"Options for running a command."}),"\n",(0,i.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(n.h3,{id:"cwd",children:"cwd?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"cwd"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"custom directory"}),"\n",(0,i.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L3742",children:"packages/extension-api/src/extension-api.d.ts:3742"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"encoding",children:"encoding?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"encoding"}),": ",(0,i.jsx)(n.code,{children:"BufferEncoding"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"The encoding to use. Default utf8"}),"\n",(0,i.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L3752",children:"packages/extension-api/src/extension-api.d.ts:3752"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"env",children:"env?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"env"}),": ",(0,i.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Environment variables to set for the command."}),"\n",(0,i.jsx)(n.h4,{id:"index-signature",children:"Index signature"}),"\n",(0,i.jsxs)(n.p,{children:["[",(0,i.jsx)(n.code,{children:"key"}),": ",(0,i.jsx)(n.code,{children:"string"}),"]: ",(0,i.jsx)(n.code,{children:"string"})]}),"\n",(0,i.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L3727",children:"packages/extension-api/src/extension-api.d.ts:3727"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"isadmin",children:"isAdmin?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"isAdmin"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"admin privileges required"}),"\n",(0,i.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L3747",children:"packages/extension-api/src/extension-api.d.ts:3747"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"logger",children:"logger?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"logger"}),": ",(0,i.jsx)(n.a,{href:"/api/interfaces/Logger",children:(0,i.jsx)(n.code,{children:"Logger"})})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"A logger used to track execution events."}),"\n",(0,i.jsx)(n.h4,{id:"source-4",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L3737",children:"packages/extension-api/src/extension-api.d.ts:3737"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"token",children:"token?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"token"}),": ",(0,i.jsx)(n.a,{href:"/api/interfaces/CancellationToken",children:(0,i.jsx)(n.code,{children:"CancellationToken"})})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"A cancellation token used to request cancellation."}),"\n",(0,i.jsx)(n.h4,{id:"source-5",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L3732",children:"packages/extension-api/src/extension-api.d.ts:3732"})})]})}function h(e={}){const{wrapper:n}={...(0,c.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(a,{...e})}):a(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>t,a:()=>o});var i=s(27378);const c={},r=i.createContext(c);function o(e){const n=i.useContext(r);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function t(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(c):e.components||c:o(e.components),i.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/d9407a00.b266d8d2.js b/assets/js/d9407a00.7a6b235f.js similarity index 97% rename from assets/js/d9407a00.b266d8d2.js rename to assets/js/d9407a00.7a6b235f.js index 744a784c864..40ea2fbbe14 100644 --- a/assets/js/d9407a00.b266d8d2.js +++ b/assets/js/d9407a00.7a6b235f.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[16728],{70554:(n,e,o)=>{o.r(e),o.d(e,{assets:()=>r,contentTitle:()=>c,default:()=>l,frontMatter:()=>t,metadata:()=>a,toc:()=>d});var i=o(24246),s=o(71670);const t={},c="Function: showNotification()",a={id:"namespaces/window/functions/showNotification",title:"Function: showNotification()",description:"showNotification(options): Disposable",source:"@site/api/namespaces/window/functions/showNotification.md",sourceDirName:"namespaces/window/functions",slug:"/namespaces/window/functions/showNotification",permalink:"/api/namespaces/window/functions/showNotification",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Function: showInputBox()",permalink:"/api/namespaces/window/functions/showInputBox"},next:{title:"Function: showOpenDialog()",permalink:"/api/namespaces/window/functions/showOpenDialog"}},r={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function p(n){const e={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,s.a)(),...n.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(e.h1,{id:"function-shownotification",children:"Function: showNotification()"}),"\n",(0,i.jsxs)(e.blockquote,{children:["\n",(0,i.jsxs)(e.p,{children:[(0,i.jsx)(e.strong,{children:"showNotification"}),"(",(0,i.jsx)(e.code,{children:"options"}),"): ",(0,i.jsx)(e.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(e.code,{children:"Disposable"})})]}),"\n"]}),"\n",(0,i.jsx)(e.p,{children:"Show notification on different area of Podman Desktop based on its options (Dashboard, bell icon list, OS notification)"}),"\n",(0,i.jsx)(e.h2,{id:"parameters",children:"Parameters"}),"\n",(0,i.jsxs)(e.p,{children:["\u2022 ",(0,i.jsx)(e.strong,{children:"options"}),": ",(0,i.jsx)(e.a,{href:"/api/interfaces/NotificationOptions",children:(0,i.jsx)(e.code,{children:"NotificationOptions"})})]}),"\n",(0,i.jsx)(e.p,{children:"define how the notification must be created."}),"\n",(0,i.jsx)(e.h2,{id:"returns",children:"Returns"}),"\n",(0,i.jsx)(e.p,{children:(0,i.jsx)(e.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(e.code,{children:"Disposable"})})}),"\n",(0,i.jsx)(e.h2,{id:"source",children:"Source"}),"\n",(0,i.jsx)(e.p,{children:(0,i.jsx)(e.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L1682",children:"packages/extension-api/src/extension-api.d.ts:1682"})})]})}function l(n={}){const{wrapper:e}={...(0,s.a)(),...n.components};return e?(0,i.jsx)(e,{...n,children:(0,i.jsx)(p,{...n})}):p(n)}},71670:(n,e,o)=>{o.d(e,{Z:()=>a,a:()=>c});var i=o(27378);const s={},t=i.createContext(s);function c(n){const e=i.useContext(t);return i.useMemo((function(){return"function"==typeof n?n(e):{...e,...n}}),[e,n])}function a(n){let e;return e=n.disableParentContext?"function"==typeof n.components?n.components(s):n.components||s:c(n.components),i.createElement(t.Provider,{value:e},n.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[16728],{70554:(n,e,o)=>{o.r(e),o.d(e,{assets:()=>r,contentTitle:()=>c,default:()=>l,frontMatter:()=>t,metadata:()=>a,toc:()=>d});var i=o(24246),s=o(71670);const t={},c="Function: showNotification()",a={id:"namespaces/window/functions/showNotification",title:"Function: showNotification()",description:"showNotification(options): Disposable",source:"@site/api/namespaces/window/functions/showNotification.md",sourceDirName:"namespaces/window/functions",slug:"/namespaces/window/functions/showNotification",permalink:"/api/namespaces/window/functions/showNotification",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Function: showInputBox()",permalink:"/api/namespaces/window/functions/showInputBox"},next:{title:"Function: showOpenDialog()",permalink:"/api/namespaces/window/functions/showOpenDialog"}},r={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function p(n){const e={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,s.a)(),...n.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(e.h1,{id:"function-shownotification",children:"Function: showNotification()"}),"\n",(0,i.jsxs)(e.blockquote,{children:["\n",(0,i.jsxs)(e.p,{children:[(0,i.jsx)(e.strong,{children:"showNotification"}),"(",(0,i.jsx)(e.code,{children:"options"}),"): ",(0,i.jsx)(e.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(e.code,{children:"Disposable"})})]}),"\n"]}),"\n",(0,i.jsx)(e.p,{children:"Show notification on different area of Podman Desktop based on its options (Dashboard, bell icon list, OS notification)"}),"\n",(0,i.jsx)(e.h2,{id:"parameters",children:"Parameters"}),"\n",(0,i.jsxs)(e.p,{children:["\u2022 ",(0,i.jsx)(e.strong,{children:"options"}),": ",(0,i.jsx)(e.a,{href:"/api/interfaces/NotificationOptions",children:(0,i.jsx)(e.code,{children:"NotificationOptions"})})]}),"\n",(0,i.jsx)(e.p,{children:"define how the notification must be created."}),"\n",(0,i.jsx)(e.h2,{id:"returns",children:"Returns"}),"\n",(0,i.jsx)(e.p,{children:(0,i.jsx)(e.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(e.code,{children:"Disposable"})})}),"\n",(0,i.jsx)(e.h2,{id:"source",children:"Source"}),"\n",(0,i.jsx)(e.p,{children:(0,i.jsx)(e.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L1682",children:"packages/extension-api/src/extension-api.d.ts:1682"})})]})}function l(n={}){const{wrapper:e}={...(0,s.a)(),...n.components};return e?(0,i.jsx)(e,{...n,children:(0,i.jsx)(p,{...n})}):p(n)}},71670:(n,e,o)=>{o.d(e,{Z:()=>a,a:()=>c});var i=o(27378);const s={},t=i.createContext(s);function c(n){const e=i.useContext(t);return i.useMemo((function(){return"function"==typeof n?n(e):{...e,...n}}),[e,n])}function a(n){let e;return e=n.disableParentContext?"function"==typeof n.components?n.components(s):n.components||s:c(n.components),i.createElement(t.Provider,{value:e},n.children)}}}]); \ No newline at end of file diff --git a/assets/js/d9673b17.82ee7398.js b/assets/js/d9673b17.e4cec172.js similarity index 87% rename from assets/js/d9673b17.82ee7398.js rename to assets/js/d9673b17.e4cec172.js index 7b14ad43b18..c1b91203fc9 100644 --- a/assets/js/d9673b17.82ee7398.js +++ b/assets/js/d9673b17.e4cec172.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[58673],{91590:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>a,contentTitle:()=>c,default:()=>h,frontMatter:()=>o,metadata:()=>r,toc:()=>l});var t=i(24246),s=i(71670);const o={},c="Interface: NotificationOptions",r={id:"interfaces/NotificationOptions",title:"Interface: NotificationOptions",description:"Properties",source:"@site/api/interfaces/NotificationOptions.md",sourceDirName:"interfaces",slug:"/interfaces/NotificationOptions",permalink:"/api/interfaces/NotificationOptions",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: NetworkingConfig",permalink:"/api/interfaces/NetworkingConfig"},next:{title:"Interface: OpenDialogOptions",permalink:"/api/interfaces/OpenDialogOptions"}},a={},l=[{value:"Properties",id:"properties",level:2},{value:"body?",id:"body",level:3},{value:"Source",id:"source",level:4},{value:"highlight?",id:"highlight",level:3},{value:"Source",id:"source-1",level:4},{value:"markdownActions?",id:"markdownactions",level:3},{value:"Source",id:"source-2",level:4},{value:"silent?",id:"silent",level:3},{value:"Source",id:"source-3",level:4},{value:"title?",id:"title",level:3},{value:"Source",id:"source-4",level:4},{value:"type?",id:"type",level:3},{value:"Source",id:"source-5",level:4}];function d(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,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.strong,{children:(0,t.jsx)(n.code,{children:"optional"})})," ",(0,t.jsx)(n.strong,{children:"body"}),": ",(0,t.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"The body text of the notification, which will be displayed below the title."}),"\n",(0,t.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L1160",children:"packages/extension-api/src/extension-api.d.ts:1160"})}),"\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.strong,{children:(0,t.jsx)(n.code,{children:"optional"})})," ",(0,t.jsx)(n.strong,{children:"highlight"}),": ",(0,t.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"this notification will be highlighted to the user so it draws attention"}),"\n",(0,t.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L1176",children:"packages/extension-api/src/extension-api.d.ts:1176"})}),"\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.strong,{children:(0,t.jsx)(n.code,{children:"optional"})})," ",(0,t.jsx)(n.strong,{children:"markdownActions"}),": ",(0,t.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"displayed below the description. It contains actions (like markdown commands/buttons and links)"}),"\n",(0,t.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L1172",children:"packages/extension-api/src/extension-api.d.ts:1172"})}),"\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.strong,{children:(0,t.jsx)(n.code,{children:"optional"})})," ",(0,t.jsx)(n.strong,{children:"silent"}),": ",(0,t.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"Whether or not to emit an OS notification noise when showing the notification."}),"\n",(0,t.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L1164",children:"packages/extension-api/src/extension-api.d.ts:1164"})}),"\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:(0,t.jsx)(n.code,{children:"optional"})})," ",(0,t.jsx)(n.strong,{children:"title"}),": ",(0,t.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"A title for the notification, which will be shown at the top of the notification window when it is shown."}),"\n",(0,t.jsx)(n.h4,{id:"source-4",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L1156",children:"packages/extension-api/src/extension-api.d.ts:1156"})}),"\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:(0,t.jsx)(n.code,{children:"optional"})})," ",(0,t.jsx)(n.strong,{children:"type"}),": ",(0,t.jsx)(n.a,{href:"/api/type-aliases/NotificationType",children:(0,t.jsx)(n.code,{children:"NotificationType"})})]}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"The type of the notification. Default value: info"}),"\n",(0,t.jsx)(n.h4,{id:"source-5",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L1168",children:"packages/extension-api/src/extension-api.d.ts:1168"})})]})}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:()=>r,a:()=>c});var t=i(27378);const s={},o=t.createContext(s);function c(e){const n=t.useContext(o);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function r(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:c(e.components),t.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[58673],{91590:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>d,contentTitle:()=>c,default:()=>h,frontMatter:()=>o,metadata:()=>r,toc:()=>l});var t=i(24246),s=i(71670);const o={},c="Interface: NotificationOptions",r={id:"interfaces/NotificationOptions",title:"Interface: NotificationOptions",description:"Properties",source:"@site/api/interfaces/NotificationOptions.md",sourceDirName:"interfaces",slug:"/interfaces/NotificationOptions",permalink:"/api/interfaces/NotificationOptions",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: NetworkingConfig",permalink:"/api/interfaces/NetworkingConfig"},next:{title:"Interface: OpenDialogOptions",permalink:"/api/interfaces/OpenDialogOptions"}},d={},l=[{value:"Properties",id:"properties",level:2},{value:"body?",id:"body",level:3},{value:"Source",id:"source",level:4},{value:"highlight?",id:"highlight",level:3},{value:"Source",id:"source-1",level:4},{value:"markdownActions?",id:"markdownactions",level:3},{value:"Source",id:"source-2",level:4},{value:"silent?",id:"silent",level:3},{value:"Source",id:"source-3",level:4},{value:"title?",id:"title",level:3},{value:"Source",id:"source-4",level:4},{value:"type?",id:"type",level:3},{value:"Source",id:"source-5",level:4}];function 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-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.strong,{children:(0,t.jsx)(n.code,{children:"optional"})})," ",(0,t.jsx)(n.strong,{children:"body"}),": ",(0,t.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"The body text of the notification, which will be displayed below the title."}),"\n",(0,t.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L1160",children:"packages/extension-api/src/extension-api.d.ts:1160"})}),"\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.strong,{children:(0,t.jsx)(n.code,{children:"optional"})})," ",(0,t.jsx)(n.strong,{children:"highlight"}),": ",(0,t.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"this notification will be highlighted to the user so it draws attention"}),"\n",(0,t.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L1176",children:"packages/extension-api/src/extension-api.d.ts:1176"})}),"\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.strong,{children:(0,t.jsx)(n.code,{children:"optional"})})," ",(0,t.jsx)(n.strong,{children:"markdownActions"}),": ",(0,t.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"displayed below the description. It contains actions (like markdown commands/buttons and links)"}),"\n",(0,t.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L1172",children:"packages/extension-api/src/extension-api.d.ts:1172"})}),"\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.strong,{children:(0,t.jsx)(n.code,{children:"optional"})})," ",(0,t.jsx)(n.strong,{children:"silent"}),": ",(0,t.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"Whether or not to emit an OS notification noise when showing the notification."}),"\n",(0,t.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L1164",children:"packages/extension-api/src/extension-api.d.ts:1164"})}),"\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:(0,t.jsx)(n.code,{children:"optional"})})," ",(0,t.jsx)(n.strong,{children:"title"}),": ",(0,t.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"A title for the notification, which will be shown at the top of the notification window when it is shown."}),"\n",(0,t.jsx)(n.h4,{id:"source-4",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L1156",children:"packages/extension-api/src/extension-api.d.ts:1156"})}),"\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:(0,t.jsx)(n.code,{children:"optional"})})," ",(0,t.jsx)(n.strong,{children:"type"}),": ",(0,t.jsx)(n.a,{href:"/api/type-aliases/NotificationType",children:(0,t.jsx)(n.code,{children:"NotificationType"})})]}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"The type of the notification. Default value: info"}),"\n",(0,t.jsx)(n.h4,{id:"source-5",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L1168",children:"packages/extension-api/src/extension-api.d.ts:1168"})})]})}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:()=>r,a:()=>c});var t=i(27378);const s={},o=t.createContext(s);function c(e){const n=t.useContext(o);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function r(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:c(e.components),t.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/d9b4ee1e.8f64d6ef.js b/assets/js/d9b4ee1e.d50edb80.js similarity index 97% rename from assets/js/d9b4ee1e.8f64d6ef.js rename to assets/js/d9b4ee1e.d50edb80.js index 30875737200..7914a76e1f4 100644 --- a/assets/js/d9b4ee1e.8f64d6ef.js +++ b/assets/js/d9b4ee1e.d50edb80.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[19841],{41607:(e,t,r)=>{r.r(t),r.d(t,{assets:()=>i,contentTitle:()=>o,default:()=>u,frontMatter:()=>a,metadata:()=>c,toc:()=>l});var n=r(24246),s=r(71670);const a={},o="Type alias: KubernetesGeneratorSelector",c={id:"type-aliases/KubernetesGeneratorSelector",title:"Type alias: KubernetesGeneratorSelector",description:"KubernetesGeneratorSelector: KubernetesGeneratorType \\| ReadonlyArray\\",source:"@site/api/type-aliases/KubernetesGeneratorSelector.md",sourceDirName:"type-aliases",slug:"/type-aliases/KubernetesGeneratorSelector",permalink:"/api/type-aliases/KubernetesGeneratorSelector",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Type alias: KubernetesGeneratorArgument",permalink:"/api/type-aliases/KubernetesGeneratorArgument"},next:{title:"Type alias: KubernetesGeneratorType",permalink:"/api/type-aliases/KubernetesGeneratorType"}},i={},l=[{value:"Source",id:"source",level:2}];function p(e){const t={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(t.h1,{id:"type-alias-kubernetesgeneratorselector",children:"Type alias: KubernetesGeneratorSelector"}),"\n",(0,n.jsxs)(t.blockquote,{children:["\n",(0,n.jsxs)(t.p,{children:[(0,n.jsx)(t.strong,{children:"KubernetesGeneratorSelector"}),": ",(0,n.jsx)(t.a,{href:"/api/type-aliases/KubernetesGeneratorType",children:(0,n.jsx)(t.code,{children:"KubernetesGeneratorType"})})," | ",(0,n.jsx)(t.code,{children:"ReadonlyArray"}),"< ",(0,n.jsx)(t.a,{href:"/api/type-aliases/KubernetesGeneratorType",children:(0,n.jsx)(t.code,{children:"KubernetesGeneratorType"})})," >"]}),"\n"]}),"\n",(0,n.jsx)(t.h2,{id:"source",children:"Source"}),"\n",(0,n.jsx)(t.p,{children:(0,n.jsx)(t.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L1829",children:"packages/extension-api/src/extension-api.d.ts:1829"})})]})}function u(e={}){const{wrapper:t}={...(0,s.a)(),...e.components};return t?(0,n.jsx)(t,{...e,children:(0,n.jsx)(p,{...e})}):p(e)}},71670:(e,t,r)=>{r.d(t,{Z:()=>c,a:()=>o});var n=r(27378);const s={},a=n.createContext(s);function o(e){const t=n.useContext(a);return n.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function c(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:o(e.components),n.createElement(a.Provider,{value:t},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[19841],{41607:(e,t,r)=>{r.r(t),r.d(t,{assets:()=>i,contentTitle:()=>o,default:()=>u,frontMatter:()=>a,metadata:()=>c,toc:()=>l});var n=r(24246),s=r(71670);const a={},o="Type alias: KubernetesGeneratorSelector",c={id:"type-aliases/KubernetesGeneratorSelector",title:"Type alias: KubernetesGeneratorSelector",description:"KubernetesGeneratorSelector: KubernetesGeneratorType \\| ReadonlyArray\\",source:"@site/api/type-aliases/KubernetesGeneratorSelector.md",sourceDirName:"type-aliases",slug:"/type-aliases/KubernetesGeneratorSelector",permalink:"/api/type-aliases/KubernetesGeneratorSelector",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Type alias: KubernetesGeneratorArgument",permalink:"/api/type-aliases/KubernetesGeneratorArgument"},next:{title:"Type alias: KubernetesGeneratorType",permalink:"/api/type-aliases/KubernetesGeneratorType"}},i={},l=[{value:"Source",id:"source",level:2}];function p(e){const t={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(t.h1,{id:"type-alias-kubernetesgeneratorselector",children:"Type alias: KubernetesGeneratorSelector"}),"\n",(0,n.jsxs)(t.blockquote,{children:["\n",(0,n.jsxs)(t.p,{children:[(0,n.jsx)(t.strong,{children:"KubernetesGeneratorSelector"}),": ",(0,n.jsx)(t.a,{href:"/api/type-aliases/KubernetesGeneratorType",children:(0,n.jsx)(t.code,{children:"KubernetesGeneratorType"})})," | ",(0,n.jsx)(t.code,{children:"ReadonlyArray"}),"< ",(0,n.jsx)(t.a,{href:"/api/type-aliases/KubernetesGeneratorType",children:(0,n.jsx)(t.code,{children:"KubernetesGeneratorType"})})," >"]}),"\n"]}),"\n",(0,n.jsx)(t.h2,{id:"source",children:"Source"}),"\n",(0,n.jsx)(t.p,{children:(0,n.jsx)(t.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L1829",children:"packages/extension-api/src/extension-api.d.ts:1829"})})]})}function u(e={}){const{wrapper:t}={...(0,s.a)(),...e.components};return t?(0,n.jsx)(t,{...e,children:(0,n.jsx)(p,{...e})}):p(e)}},71670:(e,t,r)=>{r.d(t,{Z:()=>c,a:()=>o});var n=r(27378);const s={},a=n.createContext(s);function o(e){const t=n.useContext(a);return n.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function c(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:o(e.components),n.createElement(a.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/db22fd17.f6898ba5.js b/assets/js/db22fd17.d6e67f67.js similarity index 72% rename from assets/js/db22fd17.f6898ba5.js rename to assets/js/db22fd17.d6e67f67.js index 4b833569fca..c03d09a0c8d 100644 --- a/assets/js/db22fd17.f6898ba5.js +++ b/assets/js/db22fd17.d6e67f67.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[43474],{15947:(e,t,o)=>{o.r(t),o.d(t,{assets:()=>c,contentTitle:()=>i,default:()=>d,frontMatter:()=>a,metadata:()=>l,toc:()=>r});var n=o(24246),s=o(71670);const a={},i="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:"Type alias: CheckResultLink",permalink:"/api/type-aliases/CheckResultLink"},next:{title:"Type alias: ConfigurationScope",permalink:"/api/type-aliases/ConfigurationScope"}},c={},r=[{value:"Source",id:"source",level:2}];function p(e){const t={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(t.h1,{id:"type-alias-clitoolstate",children:"Type alias: CliToolState"}),"\n",(0,n.jsxs)(t.blockquote,{children:["\n",(0,n.jsxs)(t.p,{children:[(0,n.jsx)(t.strong,{children:"CliToolState"}),": ",(0,n.jsx)(t.code,{children:'"registered"'})]}),"\n"]}),"\n",(0,n.jsx)(t.h2,{id:"source",children:"Source"}),"\n",(0,n.jsx)(t.p,{children:(0,n.jsx)(t.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L4031",children:"packages/extension-api/src/extension-api.d.ts:4031"})})]})}function d(e={}){const{wrapper:t}={...(0,s.a)(),...e.components};return t?(0,n.jsx)(t,{...e,children:(0,n.jsx)(p,{...e})}):p(e)}},71670:(e,t,o)=>{o.d(t,{Z:()=>l,a:()=>i});var n=o(27378);const s={},a=n.createContext(s);function i(e){const t=n.useContext(a);return n.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:i(e.components),n.createElement(a.Provider,{value:t},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[43474],{15947:(e,t,o)=>{o.r(t),o.d(t,{assets:()=>r,contentTitle:()=>a,default:()=>d,frontMatter:()=>i,metadata:()=>l,toc:()=>c});var n=o(24246),s=o(71670);const i={},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:"Type alias: CheckResultLink",permalink:"/api/type-aliases/CheckResultLink"},next:{title:"Type alias: ConfigurationScope",permalink:"/api/type-aliases/ConfigurationScope"}},r={},c=[{value:"Source",id:"source",level:2}];function p(e){const t={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(t.h1,{id:"type-alias-clitoolstate",children:"Type alias: CliToolState"}),"\n",(0,n.jsxs)(t.blockquote,{children:["\n",(0,n.jsxs)(t.p,{children:[(0,n.jsx)(t.strong,{children:"CliToolState"}),": ",(0,n.jsx)(t.code,{children:'"registered"'})]}),"\n"]}),"\n",(0,n.jsx)(t.h2,{id:"source",children:"Source"}),"\n",(0,n.jsx)(t.p,{children:(0,n.jsx)(t.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L4031",children:"packages/extension-api/src/extension-api.d.ts:4031"})})]})}function d(e={}){const{wrapper:t}={...(0,s.a)(),...e.components};return t?(0,n.jsx)(t,{...e,children:(0,n.jsx)(p,{...e})}):p(e)}},71670:(e,t,o)=>{o.d(t,{Z:()=>l,a:()=>a});var n=o(27378);const s={},i=n.createContext(s);function a(e){const t=n.useContext(i);return n.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function l(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:a(e.components),n.createElement(i.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/dc23cd40.5525d066.js b/assets/js/dc23cd40.cdc36a02.js similarity index 88% rename from assets/js/dc23cd40.5525d066.js rename to assets/js/dc23cd40.cdc36a02.js index 97bc62648fa..14e14371482 100644 --- a/assets/js/dc23cd40.5525d066.js +++ b/assets/js/dc23cd40.cdc36a02.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[99124],{19206:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>a,contentTitle:()=>o,default:()=>p,frontMatter:()=>t,metadata:()=>c,toc:()=>d});var s=r(24246),i=r(71670);const t={},o="Interface: PodCreateOptions",c={id:"interfaces/PodCreateOptions",title:"Interface: PodCreateOptions",description:"Properties",source:"@site/api/interfaces/PodCreateOptions.md",sourceDirName:"interfaces",slug:"/interfaces/PodCreateOptions",permalink:"/api/interfaces/PodCreateOptions",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: PodContainerInfo",permalink:"/api/interfaces/PodContainerInfo"},next:{title:"Interface: PodCreatePortOptions",permalink:"/api/interfaces/PodCreatePortOptions"}},a={},d=[{value:"Properties",id:"properties",level:2},{value:"labels?",id:"labels",level:3},{value:"Index signature",id:"index-signature",level:4},{value:"Source",id:"source",level:4},{value:"name",id:"name",level:3},{value:"Source",id:"source-1",level:4},{value:"portmappings?",id:"portmappings",level:3},{value:"Source",id:"source-2",level:4},{value:"provider?",id:"provider",level:3},{value:"Source",id:"source-3",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,i.a)(),...e.components};return(0,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:"labels",children:"labels?"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{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",children:"Index signature"}),"\n",(0,s.jsxs)(n.p,{children:["[",(0,s.jsx)(n.code,{children:"key"}),": ",(0,s.jsx)(n.code,{children:"string"}),"]: ",(0,s.jsx)(n.code,{children:"string"})]}),"\n",(0,s.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L283",children:"packages/extension-api/src/extension-api.d.ts:283"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"name",children:"name"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"name"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L281",children:"packages/extension-api/src/extension-api.d.ts:281"})}),"\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.strong,{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.h4,{id:"source-2",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L282",children:"packages/extension-api/src/extension-api.d.ts:282"})}),"\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.strong,{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:"source-3",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L285",children:"packages/extension-api/src/extension-api.d.ts:285"})})]})}function p(e={}){const{wrapper:n}={...(0,i.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},71670:(e,n,r)=>{r.d(n,{Z:()=>c,a:()=>o});var s=r(27378);const i={},t=s.createContext(i);function o(e){const n=s.useContext(t);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:o(e.components),s.createElement(t.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[99124],{19206:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>d,contentTitle:()=>o,default:()=>p,frontMatter:()=>t,metadata:()=>c,toc:()=>a});var s=r(24246),i=r(71670);const t={},o="Interface: PodCreateOptions",c={id:"interfaces/PodCreateOptions",title:"Interface: PodCreateOptions",description:"Properties",source:"@site/api/interfaces/PodCreateOptions.md",sourceDirName:"interfaces",slug:"/interfaces/PodCreateOptions",permalink:"/api/interfaces/PodCreateOptions",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: PodContainerInfo",permalink:"/api/interfaces/PodContainerInfo"},next:{title:"Interface: PodCreatePortOptions",permalink:"/api/interfaces/PodCreatePortOptions"}},d={},a=[{value:"Properties",id:"properties",level:2},{value:"labels?",id:"labels",level:3},{value:"Index signature",id:"index-signature",level:4},{value:"Source",id:"source",level:4},{value:"name",id:"name",level:3},{value:"Source",id:"source-1",level:4},{value:"portmappings?",id:"portmappings",level:3},{value:"Source",id:"source-2",level:4},{value:"provider?",id:"provider",level:3},{value:"Source",id:"source-3",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,i.a)(),...e.components};return(0,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:"labels",children:"labels?"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{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",children:"Index signature"}),"\n",(0,s.jsxs)(n.p,{children:["[",(0,s.jsx)(n.code,{children:"key"}),": ",(0,s.jsx)(n.code,{children:"string"}),"]: ",(0,s.jsx)(n.code,{children:"string"})]}),"\n",(0,s.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L283",children:"packages/extension-api/src/extension-api.d.ts:283"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"name",children:"name"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"name"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L281",children:"packages/extension-api/src/extension-api.d.ts:281"})}),"\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.strong,{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.h4,{id:"source-2",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L282",children:"packages/extension-api/src/extension-api.d.ts:282"})}),"\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.strong,{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:"source-3",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L285",children:"packages/extension-api/src/extension-api.d.ts:285"})})]})}function p(e={}){const{wrapper:n}={...(0,i.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},71670:(e,n,r)=>{r.d(n,{Z:()=>c,a:()=>o});var s=r(27378);const i={},t=s.createContext(i);function o(e){const n=s.useContext(t);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:o(e.components),s.createElement(t.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/dec87402.2816995e.js b/assets/js/dec87402.2599a454.js similarity index 98% rename from assets/js/dec87402.2816995e.js rename to assets/js/dec87402.2599a454.js index a62a021dccb..874f9e265aa 100644 --- a/assets/js/dec87402.2816995e.js +++ b/assets/js/dec87402.2599a454.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[1837],{43570:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>a,contentTitle:()=>o,default:()=>g,frontMatter:()=>r,metadata:()=>c,toc:()=>d});var t=s(24246),i=s(71670);const r={},o="Function: tagImage()",c={id:"namespaces/containerEngine/functions/tagImage",title:"Function: tagImage()",description:"tagImage(engineId, imageId, repo, tag?): Promise\\",source:"@site/api/namespaces/containerEngine/functions/tagImage.md",sourceDirName:"namespaces/containerEngine/functions",slug:"/namespaces/containerEngine/functions/tagImage",permalink:"/api/namespaces/containerEngine/functions/tagImage",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Function: stopPod()",permalink:"/api/namespaces/containerEngine/functions/stopPod"},next:{title:"Namespace: context",permalink:"/api/namespaces/context/"}},a={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,i.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"function-tagimage",children:"Function: tagImage()"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"tagImage"}),"(",(0,t.jsx)(n.code,{children:"engineId"}),", ",(0,t.jsx)(n.code,{children:"imageId"}),", ",(0,t.jsx)(n.code,{children:"repo"}),", ",(0,t.jsx)(n.code,{children:"tag"}),"?): ",(0,t.jsx)(n.code,{children:"Promise"}),"< ",(0,t.jsx)(n.code,{children:"void"})," >"]}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"Tag an image so that it becomes part of a repository"}),"\n",(0,t.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"engineId"}),": ",(0,t.jsx)(n.code,{children:"string"})]}),"\n",(0,t.jsxs)(n.p,{children:["the id of the engine managing the image, obtained from the result of ",(0,t.jsx)(n.a,{href:"/api/namespaces/containerEngine/functions/listImages",children:"containerEngine.listImages"})]}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"imageId"}),": ",(0,t.jsx)(n.code,{children:"string"})]}),"\n",(0,t.jsxs)(n.p,{children:["the id of the image on this engine, obtained from the result of ",(0,t.jsx)(n.a,{href:"/api/namespaces/containerEngine/functions/listImages",children:"containerEngine.listImages"})]}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"repo"}),": ",(0,t.jsx)(n.code,{children:"string"})]}),"\n",(0,t.jsxs)(n.p,{children:["The repository to tag in. For example, ",(0,t.jsx)(n.code,{children:"someuser/someimage"})]}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"tag?"}),": ",(0,t.jsx)(n.code,{children:"string"})]}),"\n",(0,t.jsx)(n.p,{children:"The name of the new tag"}),"\n",(0,t.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"Promise"}),"< ",(0,t.jsx)(n.code,{children:"void"})," >"]}),"\n",(0,t.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L3293",children:"packages/extension-api/src/extension-api.d.ts:3293"})})]})}function g(e={}){const{wrapper:n}={...(0,i.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>c,a:()=>o});var t=s(27378);const i={},r=t.createContext(i);function o(e){const n=t.useContext(r);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:o(e.components),t.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[1837],{43570:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>a,contentTitle:()=>o,default:()=>g,frontMatter:()=>r,metadata:()=>c,toc:()=>d});var t=s(24246),i=s(71670);const r={},o="Function: tagImage()",c={id:"namespaces/containerEngine/functions/tagImage",title:"Function: tagImage()",description:"tagImage(engineId, imageId, repo, tag?): Promise\\",source:"@site/api/namespaces/containerEngine/functions/tagImage.md",sourceDirName:"namespaces/containerEngine/functions",slug:"/namespaces/containerEngine/functions/tagImage",permalink:"/api/namespaces/containerEngine/functions/tagImage",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Function: stopPod()",permalink:"/api/namespaces/containerEngine/functions/stopPod"},next:{title:"Namespace: context",permalink:"/api/namespaces/context/"}},a={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,i.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"function-tagimage",children:"Function: tagImage()"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"tagImage"}),"(",(0,t.jsx)(n.code,{children:"engineId"}),", ",(0,t.jsx)(n.code,{children:"imageId"}),", ",(0,t.jsx)(n.code,{children:"repo"}),", ",(0,t.jsx)(n.code,{children:"tag"}),"?): ",(0,t.jsx)(n.code,{children:"Promise"}),"< ",(0,t.jsx)(n.code,{children:"void"})," >"]}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"Tag an image so that it becomes part of a repository"}),"\n",(0,t.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"engineId"}),": ",(0,t.jsx)(n.code,{children:"string"})]}),"\n",(0,t.jsxs)(n.p,{children:["the id of the engine managing the image, obtained from the result of ",(0,t.jsx)(n.a,{href:"/api/namespaces/containerEngine/functions/listImages",children:"containerEngine.listImages"})]}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"imageId"}),": ",(0,t.jsx)(n.code,{children:"string"})]}),"\n",(0,t.jsxs)(n.p,{children:["the id of the image on this engine, obtained from the result of ",(0,t.jsx)(n.a,{href:"/api/namespaces/containerEngine/functions/listImages",children:"containerEngine.listImages"})]}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"repo"}),": ",(0,t.jsx)(n.code,{children:"string"})]}),"\n",(0,t.jsxs)(n.p,{children:["The repository to tag in. For example, ",(0,t.jsx)(n.code,{children:"someuser/someimage"})]}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"tag?"}),": ",(0,t.jsx)(n.code,{children:"string"})]}),"\n",(0,t.jsx)(n.p,{children:"The name of the new tag"}),"\n",(0,t.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"Promise"}),"< ",(0,t.jsx)(n.code,{children:"void"})," >"]}),"\n",(0,t.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L3293",children:"packages/extension-api/src/extension-api.d.ts:3293"})})]})}function g(e={}){const{wrapper:n}={...(0,i.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>c,a:()=>o});var t=s(27378);const i={},r=t.createContext(i);function o(e){const n=t.useContext(r);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:o(e.components),t.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/deccabf3.45fab54b.js b/assets/js/deccabf3.122e00d9.js similarity index 91% rename from assets/js/deccabf3.45fab54b.js rename to assets/js/deccabf3.122e00d9.js index 9c53ae3ecbc..655ab99be2f 100644 --- a/assets/js/deccabf3.45fab54b.js +++ b/assets/js/deccabf3.122e00d9.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[18880],{50761:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>c,contentTitle:()=>s,default:()=>u,frontMatter:()=>o,metadata:()=>a,toc:()=>d});var 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:"Function: withProgress()",permalink:"/api/namespaces/window/functions/withProgress"},next:{title:"Enumeration: ProgressLocation",permalink:"/api/enumerations/ProgressLocation"}},c={},d=[{value:"Enumeration Members",id:"enumeration-members",level:2},{value:"Error",id:"error",level:3},{value:"Source",id:"source",level:4},{value:"Info",id:"info",level:3},{value:"Source",id:"source-1",level:4},{value:"Warning",id:"warning",level:3},{value:"Source",id:"source-2",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,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:"source",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L814",children:"packages/extension-api/src/extension-api.d.ts:814"})}),"\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:"source-1",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L812",children:"packages/extension-api/src/extension-api.d.ts:812"})}),"\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:"source-2",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L813",children:"packages/extension-api/src/extension-api.d.ts:813"})})]})}function u(e={}){const{wrapper:n}={...(0,r.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>a,a:()=>s});var t=i(27378);const r={},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],{50761:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>c,contentTitle:()=>s,default:()=>u,frontMatter:()=>o,metadata:()=>a,toc:()=>d});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:"Function: withProgress()",permalink:"/api/namespaces/window/functions/withProgress"},next:{title:"Enumeration: ProgressLocation",permalink:"/api/enumerations/ProgressLocation"}},c={},d=[{value:"Enumeration Members",id:"enumeration-members",level:2},{value:"Error",id:"error",level:3},{value:"Source",id:"source",level:4},{value:"Info",id:"info",level:3},{value:"Source",id:"source-1",level:4},{value:"Warning",id:"warning",level:3},{value:"Source",id:"source-2",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,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:"source",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L814",children:"packages/extension-api/src/extension-api.d.ts:814"})}),"\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:"source-1",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L812",children:"packages/extension-api/src/extension-api.d.ts:812"})}),"\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:"source-2",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L813",children:"packages/extension-api/src/extension-api.d.ts:813"})})]})}function u(e={}){const{wrapper:n}={...(0,r.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>a,a:()=>s});var t=i(27378);const r={},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.eac9161d.js b/assets/js/df2a6e58.5de9dabd.js similarity index 98% rename from assets/js/df2a6e58.eac9161d.js rename to assets/js/df2a6e58.5de9dabd.js index d3d22ce684f..d3c4bfccaf2 100644 --- a/assets/js/df2a6e58.eac9161d.js +++ b/assets/js/df2a6e58.5de9dabd.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[37683],{95823:(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:"Function: listImages()",permalink:"/api/namespaces/containerEngine/functions/listImages"},next:{title:"Function: listNetworks()",permalink:"/api/namespaces/containerEngine/functions/listNetworks"}},a={},l=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Example",id:"example",level:2},{value:"Example",id:"example-1",level:2},{value:"Source",id:"source",level:2}];function d(n){const e={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",pre:"pre",strong:"strong",...(0,o.a)(),...n.components};return(0,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:"example",children:"Example"}),"\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.h2,{id:"example-1",children:"Example"}),"\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:"source",children:"Source"}),"\n",(0,s.jsx)(e.p,{children:(0,s.jsx)(e.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L3361",children:"packages/extension-api/src/extension-api.d.ts:3361"})})]})}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],{95823:(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:"Function: listImages()",permalink:"/api/namespaces/containerEngine/functions/listImages"},next:{title:"Function: listNetworks()",permalink:"/api/namespaces/containerEngine/functions/listNetworks"}},a={},l=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Example",id:"example",level:2},{value:"Example",id:"example-1",level:2},{value:"Source",id:"source",level:2}];function d(n){const e={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",pre:"pre",strong:"strong",...(0,o.a)(),...n.components};return(0,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:"example",children:"Example"}),"\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.h2,{id:"example-1",children:"Example"}),"\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:"source",children:"Source"}),"\n",(0,s.jsx)(e.p,{children:(0,s.jsx)(e.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L3361",children:"packages/extension-api/src/extension-api.d.ts:3361"})})]})}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.2c9b2a78.js b/assets/js/df4d464e.afbd410d.js similarity index 95% rename from assets/js/df4d464e.2c9b2a78.js rename to assets/js/df4d464e.afbd410d.js index 526a8169073..8dcca12ce29 100644 --- a/assets/js/df4d464e.2c9b2a78.js +++ b/assets/js/df4d464e.afbd410d.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[82409],{73050:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>a,contentTitle:()=>i,default:()=>l,frontMatter:()=>r,metadata:()=>o,toc:()=>u});var t=s(24246),c=s(71670);const r={},i="Function: setKubeconfig()",o={id:"namespaces/kubernetes/functions/setKubeconfig",title:"Function: setKubeconfig()",description:"setKubeconfig(kubeconfig): Promise\\",source:"@site/api/namespaces/kubernetes/functions/setKubeconfig.md",sourceDirName:"namespaces/kubernetes/functions",slug:"/namespaces/kubernetes/functions/setKubeconfig",permalink:"/api/namespaces/kubernetes/functions/setKubeconfig",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Function: registerKubernetesGenerator()",permalink:"/api/namespaces/kubernetes/functions/registerKubernetesGenerator"},next:{title:"Namespace: navigation",permalink:"/api/namespaces/navigation/"}},a={},u=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function d(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,c.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"function-setkubeconfig",children:"Function: setKubeconfig()"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"setKubeconfig"}),"(",(0,t.jsx)(n.code,{children:"kubeconfig"}),"): ",(0,t.jsx)(n.code,{children:"Promise"}),"< ",(0,t.jsx)(n.code,{children:"void"})," >"]}),"\n"]}),"\n",(0,t.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"kubeconfig"}),": ",(0,t.jsx)(n.a,{href:"/api/classes/Uri",children:(0,t.jsx)(n.code,{children:"Uri"})})]}),"\n",(0,t.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"Promise"}),"< ",(0,t.jsx)(n.code,{children:"void"})," >"]}),"\n",(0,t.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L1804",children:"packages/extension-api/src/extension-api.d.ts:1804"})})]})}function l(e={}){const{wrapper:n}={...(0,c.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(d,{...e})}):d(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>o,a:()=>i});var t=s(27378);const c={},r=t.createContext(c);function i(e){const n=t.useContext(r);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(c):e.components||c:i(e.components),t.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[82409],{73050:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>a,contentTitle:()=>i,default:()=>l,frontMatter:()=>r,metadata:()=>o,toc:()=>u});var t=s(24246),c=s(71670);const r={},i="Function: setKubeconfig()",o={id:"namespaces/kubernetes/functions/setKubeconfig",title:"Function: setKubeconfig()",description:"setKubeconfig(kubeconfig): Promise\\",source:"@site/api/namespaces/kubernetes/functions/setKubeconfig.md",sourceDirName:"namespaces/kubernetes/functions",slug:"/namespaces/kubernetes/functions/setKubeconfig",permalink:"/api/namespaces/kubernetes/functions/setKubeconfig",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Function: registerKubernetesGenerator()",permalink:"/api/namespaces/kubernetes/functions/registerKubernetesGenerator"},next:{title:"Namespace: navigation",permalink:"/api/namespaces/navigation/"}},a={},u=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function d(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,c.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"function-setkubeconfig",children:"Function: setKubeconfig()"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"setKubeconfig"}),"(",(0,t.jsx)(n.code,{children:"kubeconfig"}),"): ",(0,t.jsx)(n.code,{children:"Promise"}),"< ",(0,t.jsx)(n.code,{children:"void"})," >"]}),"\n"]}),"\n",(0,t.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"kubeconfig"}),": ",(0,t.jsx)(n.a,{href:"/api/classes/Uri",children:(0,t.jsx)(n.code,{children:"Uri"})})]}),"\n",(0,t.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"Promise"}),"< ",(0,t.jsx)(n.code,{children:"void"})," >"]}),"\n",(0,t.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L1804",children:"packages/extension-api/src/extension-api.d.ts:1804"})})]})}function l(e={}){const{wrapper:n}={...(0,c.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(d,{...e})}):d(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>o,a:()=>i});var t=s(27378);const c={},r=t.createContext(c);function i(e){const n=t.useContext(r);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(c):e.components||c:i(e.components),t.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/e064f6d4.5f434384.js b/assets/js/e064f6d4.8252e773.js similarity index 92% rename from assets/js/e064f6d4.5f434384.js rename to assets/js/e064f6d4.8252e773.js index 27415184171..de95a6696c3 100644 --- a/assets/js/e064f6d4.5f434384.js +++ b/assets/js/e064f6d4.8252e773.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[2866],{62854:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>o,contentTitle:()=>c,default:()=>a,frontMatter:()=>r,metadata:()=>l,toc:()=>t});var i=s(24246),d=s(71670);const r={},c="Interface: ContainerInspectInfo",l={id:"interfaces/ContainerInspectInfo",title:"Interface: ContainerInspectInfo",description:"Properties",source:"@site/api/interfaces/ContainerInspectInfo.md",sourceDirName:"interfaces",slug:"/interfaces/ContainerInspectInfo",permalink:"/api/interfaces/ContainerInspectInfo",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: ContainerInfo",permalink:"/api/interfaces/ContainerInfo"},next:{title:"Interface: ContainerJSONEvent",permalink:"/api/interfaces/ContainerJSONEvent"}},o={},t=[{value:"Properties",id:"properties",level:2},{value:"AppArmorProfile",id:"apparmorprofile",level:3},{value:"Source",id:"source",level:4},{value:"Args",id:"args",level:3},{value:"Source",id:"source-1",level:4},{value:"Config",id:"config",level:3},{value:"AttachStderr",id:"attachstderr",level:4},{value:"AttachStdin",id:"attachstdin",level:4},{value:"AttachStdout",id:"attachstdout",level:4},{value:"Cmd",id:"cmd",level:4},{value:"Domainname",id:"domainname",level:4},{value:"Entrypoint?",id:"entrypoint",level:4},{value:"Env",id:"env",level:4},{value:"ExposedPorts",id:"exposedports",level:4},{value:"Index signature",id:"index-signature",level:5},{value:"Hostname",id:"hostname",level:4},{value:"Image",id:"image",level:4},{value:"Labels",id:"labels",level:4},{value:"Index signature",id:"index-signature-1",level:5},{value:"OnBuild?",id:"onbuild",level:4},{value:"OpenStdin",id:"openstdin",level:4},{value:"StdinOnce",id:"stdinonce",level:4},{value:"Tty",id:"tty",level:4},{value:"User",id:"user",level:4},{value:"Volumes",id:"volumes",level:4},{value:"Index signature",id:"index-signature-2",level:5},{value:"WorkingDir",id:"workingdir",level:4},{value:"Source",id:"source-2",level:4},{value:"Created",id:"created",level:3},{value:"Source",id:"source-3",level:4},{value:"Driver",id:"driver",level:3},{value:"Source",id:"source-4",level:4},{value:"ExecIDs?",id:"execids",level:3},{value:"Source",id:"source-5",level:4},{value:"GraphDriver",id:"graphdriver",level:3},{value:"Data",id:"data",level:4},{value:"Data.DeviceId",id:"datadeviceid",level:4},{value:"Data.DeviceName",id:"datadevicename",level:4},{value:"Data.DeviceSize",id:"datadevicesize",level:4},{value:"Name",id:"name",level:4},{value:"Source",id:"source-6",level:4},{value:"HostConfig",id:"hostconfig",level:3},{value:"Source",id:"source-7",level:4},{value:"HostnamePath",id:"hostnamepath",level:3},{value:"Source",id:"source-8",level:4},{value:"HostsPath",id:"hostspath",level:3},{value:"Source",id:"source-9",level:4},{value:"Id",id:"id",level:3},{value:"Source",id:"source-10",level:4},{value:"Image",id:"image-1",level:3},{value:"Source",id:"source-11",level:4},{value:"LogPath",id:"logpath",level:3},{value:"Source",id:"source-12",level:4},{value:"MountLabel",id:"mountlabel",level:3},{value:"Source",id:"source-13",level:4},{value:"Mounts",id:"mounts",level:3},{value:"Source",id:"source-14",level:4},{value:"Name",id:"name-1",level:3},{value:"Source",id:"source-15",level:4},{value:"NetworkSettings",id:"networksettings",level:3},{value:"Bridge",id:"bridge",level:4},{value:"EndpointID",id:"endpointid",level:4},{value:"Gateway",id:"gateway",level:4},{value:"GlobalIPv6Address",id:"globalipv6address",level:4},{value:"GlobalIPv6PrefixLen",id:"globalipv6prefixlen",level:4},{value:"HairpinMode",id:"hairpinmode",level:4},{value:"IPAddress",id:"ipaddress",level:4},{value:"IPPrefixLen",id:"ipprefixlen",level:4},{value:"IPv6Gateway",id:"ipv6gateway",level:4},{value:"LinkLocalIPv6Address",id:"linklocalipv6address",level:4},{value:"LinkLocalIPv6PrefixLen",id:"linklocalipv6prefixlen",level:4},{value:"MacAddress",id:"macaddress",level:4},{value:"Networks",id:"networks",level:4},{value:"Index signature",id:"index-signature-3",level:5},{value:"Node?",id:"node",level:4},{value:"Node.Addr",id:"nodeaddr",level:4},{value:"Node.Cpus",id:"nodecpus",level:4},{value:"Node.ID",id:"nodeid",level:4},{value:"Node.IP",id:"nodeip",level:4},{value:"Node.Labels",id:"nodelabels",level:4},{value:"Node.Memory",id:"nodememory",level:4},{value:"Node.Name",id:"nodename",level:4},{value:"Ports",id:"ports",level:4},{value:"Index signature",id:"index-signature-4",level:5},{value:"SandboxID",id:"sandboxid",level:4},{value:"SandboxKey",id:"sandboxkey",level:4},{value:"SecondaryIPAddresses?",id:"secondaryipaddresses",level:4},{value:"SecondaryIPv6Addresses?",id:"secondaryipv6addresses",level:4},{value:"Source",id:"source-16",level:4},{value:"Path",id:"path",level:3},{value:"Source",id:"source-17",level:4},{value:"Platform",id:"platform",level:3},{value:"Source",id:"source-18",level:4},{value:"ProcessLabel",id:"processlabel",level:3},{value:"Source",id:"source-19",level:4},{value:"ResolvConfPath",id:"resolvconfpath",level:3},{value:"Source",id:"source-20",level:4},{value:"RestartCount",id:"restartcount",level:3},{value:"Source",id:"source-21",level:4},{value:"State",id:"state",level:3},{value:"Dead",id:"dead",level:4},{value:"Error",id:"error",level:4},{value:"ExitCode",id:"exitcode",level:4},{value:"FinishedAt",id:"finishedat",level:4},{value:"Health?",id:"health",level:4},{value:"OOMKilled",id:"oomkilled",level:4},{value:"Paused",id:"paused",level:4},{value:"Pid",id:"pid",level:4},{value:"Restarting",id:"restarting",level:4},{value:"Running",id:"running",level:4},{value:"StartedAt",id:"startedat",level:4},{value:"Status",id:"status",level:4},{value:"Source",id:"source-22",level:4},{value:"engineId",id:"engineid",level:3},{value:"Source",id:"source-23",level:4},{value:"engineName",id:"enginename",level:3},{value:"Source",id:"source-24",level:4}];function h(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",h5:"h5",hr:"hr",p:"p",strong:"strong",...(0,d.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"interface-containerinspectinfo",children:"Interface: ContainerInspectInfo"}),"\n",(0,i.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(n.h3,{id:"apparmorprofile",children:"AppArmorProfile"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"AppArmorProfile"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2273",children:"packages/extension-api/src/extension-api.d.ts:2273"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"args",children:"Args"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Args"}),": ",(0,i.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2247",children:"packages/extension-api/src/extension-api.d.ts:2247"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"config",children:"Config"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Config"}),": ",(0,i.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"attachstderr",children:"AttachStderr"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"AttachStderr"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"attachstdin",children:"AttachStdin"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"AttachStdin"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"attachstdout",children:"AttachStdout"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"AttachStdout"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"cmd",children:"Cmd"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Cmd"}),": ",(0,i.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"domainname",children:"Domainname"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Domainname"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"entrypoint",children:"Entrypoint?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"Entrypoint"}),": ",(0,i.jsx)(n.code,{children:"string"})," | ",(0,i.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"env",children:"Env"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Env"}),": ",(0,i.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"exposedports",children:"ExposedPorts"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"ExposedPorts"}),": ",(0,i.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsx)(n.h5,{id:"index-signature",children:"Index signature"}),"\n",(0,i.jsxs)(n.p,{children:["[",(0,i.jsx)(n.code,{children:"portAndProtocol"}),": ",(0,i.jsx)(n.code,{children:"string"}),"]: ",(0,i.jsx)(n.code,{children:"unknown"})]}),"\n",(0,i.jsx)(n.h4,{id:"hostname",children:"Hostname"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Hostname"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"image",children:"Image"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Image"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"labels",children:"Labels"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Labels"}),": ",(0,i.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsx)(n.h5,{id:"index-signature-1",children:"Index signature"}),"\n",(0,i.jsxs)(n.p,{children:["[",(0,i.jsx)(n.code,{children:"label"}),": ",(0,i.jsx)(n.code,{children:"string"}),"]: ",(0,i.jsx)(n.code,{children:"string"})]}),"\n",(0,i.jsx)(n.h4,{id:"onbuild",children:"OnBuild?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"OnBuild"}),": ",(0,i.jsx)(n.code,{children:"unknown"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"openstdin",children:"OpenStdin"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"OpenStdin"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"stdinonce",children:"StdinOnce"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"StdinOnce"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"tty",children:"Tty"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Tty"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"user",children:"User"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"User"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"volumes",children:"Volumes"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Volumes"}),": ",(0,i.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsx)(n.h5,{id:"index-signature-2",children:"Index signature"}),"\n",(0,i.jsxs)(n.p,{children:["[",(0,i.jsx)(n.code,{children:"volume"}),": ",(0,i.jsx)(n.code,{children:"string"}),"]: ",(0,i.jsx)(n.code,{children:"unknown"})]}),"\n",(0,i.jsx)(n.h4,{id:"workingdir",children:"WorkingDir"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"WorkingDir"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2292",children:"packages/extension-api/src/extension-api.d.ts:2292"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"created",children:"Created"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Created"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2245",children:"packages/extension-api/src/extension-api.d.ts:2245"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"driver",children:"Driver"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Driver"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-4",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2269",children:"packages/extension-api/src/extension-api.d.ts:2269"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"execids",children:"ExecIDs?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"ExecIDs"}),": ",(0,i.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-5",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2274",children:"packages/extension-api/src/extension-api.d.ts:2274"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"graphdriver",children:"GraphDriver"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"GraphDriver"}),": ",(0,i.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"data",children:"Data"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Data"}),": ",(0,i.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"datadeviceid",children:"Data.DeviceId"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"DeviceId"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"datadevicename",children:"Data.DeviceName"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"DeviceName"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"datadevicesize",children:"Data.DeviceSize"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"DeviceSize"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"name",children:"Name"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Name"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-6",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2276",children:"packages/extension-api/src/extension-api.d.ts:2276"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"hostconfig",children:"HostConfig"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"HostConfig"}),": ",(0,i.jsx)(n.a,{href:"/api/interfaces/HostConfig",children:(0,i.jsx)(n.code,{children:"HostConfig"})})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-7",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2275",children:"packages/extension-api/src/extension-api.d.ts:2275"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"hostnamepath",children:"HostnamePath"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"HostnamePath"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-8",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2264",children:"packages/extension-api/src/extension-api.d.ts:2264"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"hostspath",children:"HostsPath"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"HostsPath"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-9",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2265",children:"packages/extension-api/src/extension-api.d.ts:2265"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"id",children:"Id"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Id"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-10",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2244",children:"packages/extension-api/src/extension-api.d.ts:2244"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"image-1",children:"Image"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Image"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-11",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2262",children:"packages/extension-api/src/extension-api.d.ts:2262"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"logpath",children:"LogPath"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"LogPath"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-12",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2266",children:"packages/extension-api/src/extension-api.d.ts:2266"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"mountlabel",children:"MountLabel"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"MountLabel"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-13",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2271",children:"packages/extension-api/src/extension-api.d.ts:2271"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"mounts",children:"Mounts"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Mounts"}),": ",(0,i.jsx)(n.code,{children:"object"}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-14",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2284",children:"packages/extension-api/src/extension-api.d.ts:2284"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"name-1",children:"Name"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Name"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-15",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2267",children:"packages/extension-api/src/extension-api.d.ts:2267"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"networksettings",children:"NetworkSettings"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"NetworkSettings"}),": ",(0,i.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"bridge",children:"Bridge"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Bridge"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"endpointid",children:"EndpointID"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"EndpointID"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"gateway",children:"Gateway"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Gateway"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"globalipv6address",children:"GlobalIPv6Address"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"GlobalIPv6Address"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"globalipv6prefixlen",children:"GlobalIPv6PrefixLen"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"GlobalIPv6PrefixLen"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"hairpinmode",children:"HairpinMode"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"HairpinMode"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"ipaddress",children:"IPAddress"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"IPAddress"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"ipprefixlen",children:"IPPrefixLen"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"IPPrefixLen"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"ipv6gateway",children:"IPv6Gateway"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"IPv6Gateway"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"linklocalipv6address",children:"LinkLocalIPv6Address"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"LinkLocalIPv6Address"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"linklocalipv6prefixlen",children:"LinkLocalIPv6PrefixLen"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"LinkLocalIPv6PrefixLen"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"macaddress",children:"MacAddress"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"MacAddress"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"networks",children:"Networks"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Networks"}),": ",(0,i.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsx)(n.h5,{id:"index-signature-3",children:"Index signature"}),"\n",(0,i.jsxs)(n.p,{children:["[",(0,i.jsx)(n.code,{children:"type"}),": ",(0,i.jsx)(n.code,{children:"string"}),"]: ",(0,i.jsx)(n.code,{children:"object"})]}),"\n",(0,i.jsx)(n.h4,{id:"node",children:"Node?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"Node"}),": ",(0,i.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"nodeaddr",children:"Node.Addr"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Addr"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"nodecpus",children:"Node.Cpus"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Cpus"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"nodeid",children:"Node.ID"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"ID"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"nodeip",children:"Node.IP"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"IP"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"nodelabels",children:"Node.Labels"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Labels"}),": ",(0,i.jsx)(n.code,{children:"unknown"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"nodememory",children:"Node.Memory"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Memory"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"nodename",children:"Node.Name"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Name"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"ports",children:"Ports"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Ports"}),": ",(0,i.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsx)(n.h5,{id:"index-signature-4",children:"Index signature"}),"\n",(0,i.jsxs)(n.p,{children:["[",(0,i.jsx)(n.code,{children:"portAndProtocol"}),": ",(0,i.jsx)(n.code,{children:"string"}),"]: ",(0,i.jsx)(n.code,{children:"object"}),"[]"]}),"\n",(0,i.jsx)(n.h4,{id:"sandboxid",children:"SandboxID"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"SandboxID"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"sandboxkey",children:"SandboxKey"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"SandboxKey"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"secondaryipaddresses",children:"SecondaryIPAddresses?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"SecondaryIPAddresses"}),": ",(0,i.jsx)(n.code,{children:"unknown"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"secondaryipv6addresses",children:"SecondaryIPv6Addresses?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"SecondaryIPv6Addresses"}),": ",(0,i.jsx)(n.code,{children:"unknown"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-16",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2312",children:"packages/extension-api/src/extension-api.d.ts:2312"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"path",children:"Path"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Path"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-17",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2246",children:"packages/extension-api/src/extension-api.d.ts:2246"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"platform",children:"Platform"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Platform"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-18",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2270",children:"packages/extension-api/src/extension-api.d.ts:2270"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"processlabel",children:"ProcessLabel"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"ProcessLabel"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-19",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2272",children:"packages/extension-api/src/extension-api.d.ts:2272"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"resolvconfpath",children:"ResolvConfPath"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"ResolvConfPath"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-20",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2263",children:"packages/extension-api/src/extension-api.d.ts:2263"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"restartcount",children:"RestartCount"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"RestartCount"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-21",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2268",children:"packages/extension-api/src/extension-api.d.ts:2268"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"state",children:"State"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"State"}),": ",(0,i.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"dead",children:"Dead"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Dead"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"error",children:"Error"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Error"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"exitcode",children:"ExitCode"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"ExitCode"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"finishedat",children:"FinishedAt"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"FinishedAt"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"health",children:"Health?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"Health"}),": ",(0,i.jsx)(n.a,{href:"/api/interfaces/HealthCheckResults",children:(0,i.jsx)(n.code,{children:"HealthCheckResults"})})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"oomkilled",children:"OOMKilled"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"OOMKilled"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"paused",children:"Paused"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Paused"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"pid",children:"Pid"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Pid"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"restarting",children:"Restarting"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Restarting"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"running",children:"Running"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Running"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"startedat",children:"StartedAt"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"StartedAt"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"status",children:"Status"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Status"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-22",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2248",children:"packages/extension-api/src/extension-api.d.ts:2248"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"engineid",children:"engineId"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"engineId"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-23",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2242",children:"packages/extension-api/src/extension-api.d.ts:2242"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"enginename",children:"engineName"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"engineName"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-24",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2243",children:"packages/extension-api/src/extension-api.d.ts:2243"})})]})}function a(e={}){const{wrapper:n}={...(0,d.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(h,{...e})}):h(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>l,a:()=>c});var i=s(27378);const d={},r=i.createContext(d);function c(e){const n=i.useContext(r);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function l(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(d):e.components||d:c(e.components),i.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[2866],{62854:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>o,contentTitle:()=>c,default:()=>a,frontMatter:()=>r,metadata:()=>l,toc:()=>t});var i=s(24246),d=s(71670);const r={},c="Interface: ContainerInspectInfo",l={id:"interfaces/ContainerInspectInfo",title:"Interface: ContainerInspectInfo",description:"Properties",source:"@site/api/interfaces/ContainerInspectInfo.md",sourceDirName:"interfaces",slug:"/interfaces/ContainerInspectInfo",permalink:"/api/interfaces/ContainerInspectInfo",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: ContainerInfo",permalink:"/api/interfaces/ContainerInfo"},next:{title:"Interface: ContainerJSONEvent",permalink:"/api/interfaces/ContainerJSONEvent"}},o={},t=[{value:"Properties",id:"properties",level:2},{value:"AppArmorProfile",id:"apparmorprofile",level:3},{value:"Source",id:"source",level:4},{value:"Args",id:"args",level:3},{value:"Source",id:"source-1",level:4},{value:"Config",id:"config",level:3},{value:"AttachStderr",id:"attachstderr",level:4},{value:"AttachStdin",id:"attachstdin",level:4},{value:"AttachStdout",id:"attachstdout",level:4},{value:"Cmd",id:"cmd",level:4},{value:"Domainname",id:"domainname",level:4},{value:"Entrypoint?",id:"entrypoint",level:4},{value:"Env",id:"env",level:4},{value:"ExposedPorts",id:"exposedports",level:4},{value:"Index signature",id:"index-signature",level:5},{value:"Hostname",id:"hostname",level:4},{value:"Image",id:"image",level:4},{value:"Labels",id:"labels",level:4},{value:"Index signature",id:"index-signature-1",level:5},{value:"OnBuild?",id:"onbuild",level:4},{value:"OpenStdin",id:"openstdin",level:4},{value:"StdinOnce",id:"stdinonce",level:4},{value:"Tty",id:"tty",level:4},{value:"User",id:"user",level:4},{value:"Volumes",id:"volumes",level:4},{value:"Index signature",id:"index-signature-2",level:5},{value:"WorkingDir",id:"workingdir",level:4},{value:"Source",id:"source-2",level:4},{value:"Created",id:"created",level:3},{value:"Source",id:"source-3",level:4},{value:"Driver",id:"driver",level:3},{value:"Source",id:"source-4",level:4},{value:"ExecIDs?",id:"execids",level:3},{value:"Source",id:"source-5",level:4},{value:"GraphDriver",id:"graphdriver",level:3},{value:"Data",id:"data",level:4},{value:"Data.DeviceId",id:"datadeviceid",level:4},{value:"Data.DeviceName",id:"datadevicename",level:4},{value:"Data.DeviceSize",id:"datadevicesize",level:4},{value:"Name",id:"name",level:4},{value:"Source",id:"source-6",level:4},{value:"HostConfig",id:"hostconfig",level:3},{value:"Source",id:"source-7",level:4},{value:"HostnamePath",id:"hostnamepath",level:3},{value:"Source",id:"source-8",level:4},{value:"HostsPath",id:"hostspath",level:3},{value:"Source",id:"source-9",level:4},{value:"Id",id:"id",level:3},{value:"Source",id:"source-10",level:4},{value:"Image",id:"image-1",level:3},{value:"Source",id:"source-11",level:4},{value:"LogPath",id:"logpath",level:3},{value:"Source",id:"source-12",level:4},{value:"MountLabel",id:"mountlabel",level:3},{value:"Source",id:"source-13",level:4},{value:"Mounts",id:"mounts",level:3},{value:"Source",id:"source-14",level:4},{value:"Name",id:"name-1",level:3},{value:"Source",id:"source-15",level:4},{value:"NetworkSettings",id:"networksettings",level:3},{value:"Bridge",id:"bridge",level:4},{value:"EndpointID",id:"endpointid",level:4},{value:"Gateway",id:"gateway",level:4},{value:"GlobalIPv6Address",id:"globalipv6address",level:4},{value:"GlobalIPv6PrefixLen",id:"globalipv6prefixlen",level:4},{value:"HairpinMode",id:"hairpinmode",level:4},{value:"IPAddress",id:"ipaddress",level:4},{value:"IPPrefixLen",id:"ipprefixlen",level:4},{value:"IPv6Gateway",id:"ipv6gateway",level:4},{value:"LinkLocalIPv6Address",id:"linklocalipv6address",level:4},{value:"LinkLocalIPv6PrefixLen",id:"linklocalipv6prefixlen",level:4},{value:"MacAddress",id:"macaddress",level:4},{value:"Networks",id:"networks",level:4},{value:"Index signature",id:"index-signature-3",level:5},{value:"Node?",id:"node",level:4},{value:"Node.Addr",id:"nodeaddr",level:4},{value:"Node.Cpus",id:"nodecpus",level:4},{value:"Node.ID",id:"nodeid",level:4},{value:"Node.IP",id:"nodeip",level:4},{value:"Node.Labels",id:"nodelabels",level:4},{value:"Node.Memory",id:"nodememory",level:4},{value:"Node.Name",id:"nodename",level:4},{value:"Ports",id:"ports",level:4},{value:"Index signature",id:"index-signature-4",level:5},{value:"SandboxID",id:"sandboxid",level:4},{value:"SandboxKey",id:"sandboxkey",level:4},{value:"SecondaryIPAddresses?",id:"secondaryipaddresses",level:4},{value:"SecondaryIPv6Addresses?",id:"secondaryipv6addresses",level:4},{value:"Source",id:"source-16",level:4},{value:"Path",id:"path",level:3},{value:"Source",id:"source-17",level:4},{value:"Platform",id:"platform",level:3},{value:"Source",id:"source-18",level:4},{value:"ProcessLabel",id:"processlabel",level:3},{value:"Source",id:"source-19",level:4},{value:"ResolvConfPath",id:"resolvconfpath",level:3},{value:"Source",id:"source-20",level:4},{value:"RestartCount",id:"restartcount",level:3},{value:"Source",id:"source-21",level:4},{value:"State",id:"state",level:3},{value:"Dead",id:"dead",level:4},{value:"Error",id:"error",level:4},{value:"ExitCode",id:"exitcode",level:4},{value:"FinishedAt",id:"finishedat",level:4},{value:"Health?",id:"health",level:4},{value:"OOMKilled",id:"oomkilled",level:4},{value:"Paused",id:"paused",level:4},{value:"Pid",id:"pid",level:4},{value:"Restarting",id:"restarting",level:4},{value:"Running",id:"running",level:4},{value:"StartedAt",id:"startedat",level:4},{value:"Status",id:"status",level:4},{value:"Source",id:"source-22",level:4},{value:"engineId",id:"engineid",level:3},{value:"Source",id:"source-23",level:4},{value:"engineName",id:"enginename",level:3},{value:"Source",id:"source-24",level:4}];function h(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",h5:"h5",hr:"hr",p:"p",strong:"strong",...(0,d.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"interface-containerinspectinfo",children:"Interface: ContainerInspectInfo"}),"\n",(0,i.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(n.h3,{id:"apparmorprofile",children:"AppArmorProfile"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"AppArmorProfile"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2273",children:"packages/extension-api/src/extension-api.d.ts:2273"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"args",children:"Args"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Args"}),": ",(0,i.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2247",children:"packages/extension-api/src/extension-api.d.ts:2247"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"config",children:"Config"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Config"}),": ",(0,i.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"attachstderr",children:"AttachStderr"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"AttachStderr"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"attachstdin",children:"AttachStdin"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"AttachStdin"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"attachstdout",children:"AttachStdout"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"AttachStdout"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"cmd",children:"Cmd"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Cmd"}),": ",(0,i.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"domainname",children:"Domainname"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Domainname"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"entrypoint",children:"Entrypoint?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"Entrypoint"}),": ",(0,i.jsx)(n.code,{children:"string"})," | ",(0,i.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"env",children:"Env"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Env"}),": ",(0,i.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"exposedports",children:"ExposedPorts"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"ExposedPorts"}),": ",(0,i.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsx)(n.h5,{id:"index-signature",children:"Index signature"}),"\n",(0,i.jsxs)(n.p,{children:["[",(0,i.jsx)(n.code,{children:"portAndProtocol"}),": ",(0,i.jsx)(n.code,{children:"string"}),"]: ",(0,i.jsx)(n.code,{children:"unknown"})]}),"\n",(0,i.jsx)(n.h4,{id:"hostname",children:"Hostname"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Hostname"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"image",children:"Image"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Image"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"labels",children:"Labels"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Labels"}),": ",(0,i.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsx)(n.h5,{id:"index-signature-1",children:"Index signature"}),"\n",(0,i.jsxs)(n.p,{children:["[",(0,i.jsx)(n.code,{children:"label"}),": ",(0,i.jsx)(n.code,{children:"string"}),"]: ",(0,i.jsx)(n.code,{children:"string"})]}),"\n",(0,i.jsx)(n.h4,{id:"onbuild",children:"OnBuild?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"OnBuild"}),": ",(0,i.jsx)(n.code,{children:"unknown"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"openstdin",children:"OpenStdin"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"OpenStdin"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"stdinonce",children:"StdinOnce"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"StdinOnce"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"tty",children:"Tty"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Tty"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"user",children:"User"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"User"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"volumes",children:"Volumes"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Volumes"}),": ",(0,i.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsx)(n.h5,{id:"index-signature-2",children:"Index signature"}),"\n",(0,i.jsxs)(n.p,{children:["[",(0,i.jsx)(n.code,{children:"volume"}),": ",(0,i.jsx)(n.code,{children:"string"}),"]: ",(0,i.jsx)(n.code,{children:"unknown"})]}),"\n",(0,i.jsx)(n.h4,{id:"workingdir",children:"WorkingDir"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"WorkingDir"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2292",children:"packages/extension-api/src/extension-api.d.ts:2292"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"created",children:"Created"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Created"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2245",children:"packages/extension-api/src/extension-api.d.ts:2245"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"driver",children:"Driver"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Driver"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-4",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2269",children:"packages/extension-api/src/extension-api.d.ts:2269"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"execids",children:"ExecIDs?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"ExecIDs"}),": ",(0,i.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-5",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2274",children:"packages/extension-api/src/extension-api.d.ts:2274"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"graphdriver",children:"GraphDriver"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"GraphDriver"}),": ",(0,i.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"data",children:"Data"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Data"}),": ",(0,i.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"datadeviceid",children:"Data.DeviceId"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"DeviceId"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"datadevicename",children:"Data.DeviceName"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"DeviceName"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"datadevicesize",children:"Data.DeviceSize"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"DeviceSize"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"name",children:"Name"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Name"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-6",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2276",children:"packages/extension-api/src/extension-api.d.ts:2276"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"hostconfig",children:"HostConfig"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"HostConfig"}),": ",(0,i.jsx)(n.a,{href:"/api/interfaces/HostConfig",children:(0,i.jsx)(n.code,{children:"HostConfig"})})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-7",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2275",children:"packages/extension-api/src/extension-api.d.ts:2275"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"hostnamepath",children:"HostnamePath"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"HostnamePath"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-8",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2264",children:"packages/extension-api/src/extension-api.d.ts:2264"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"hostspath",children:"HostsPath"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"HostsPath"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-9",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2265",children:"packages/extension-api/src/extension-api.d.ts:2265"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"id",children:"Id"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Id"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-10",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2244",children:"packages/extension-api/src/extension-api.d.ts:2244"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"image-1",children:"Image"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Image"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-11",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2262",children:"packages/extension-api/src/extension-api.d.ts:2262"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"logpath",children:"LogPath"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"LogPath"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-12",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2266",children:"packages/extension-api/src/extension-api.d.ts:2266"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"mountlabel",children:"MountLabel"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"MountLabel"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-13",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2271",children:"packages/extension-api/src/extension-api.d.ts:2271"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"mounts",children:"Mounts"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Mounts"}),": ",(0,i.jsx)(n.code,{children:"object"}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-14",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2284",children:"packages/extension-api/src/extension-api.d.ts:2284"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"name-1",children:"Name"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Name"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-15",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2267",children:"packages/extension-api/src/extension-api.d.ts:2267"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"networksettings",children:"NetworkSettings"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"NetworkSettings"}),": ",(0,i.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"bridge",children:"Bridge"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Bridge"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"endpointid",children:"EndpointID"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"EndpointID"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"gateway",children:"Gateway"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Gateway"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"globalipv6address",children:"GlobalIPv6Address"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"GlobalIPv6Address"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"globalipv6prefixlen",children:"GlobalIPv6PrefixLen"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"GlobalIPv6PrefixLen"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"hairpinmode",children:"HairpinMode"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"HairpinMode"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"ipaddress",children:"IPAddress"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"IPAddress"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"ipprefixlen",children:"IPPrefixLen"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"IPPrefixLen"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"ipv6gateway",children:"IPv6Gateway"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"IPv6Gateway"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"linklocalipv6address",children:"LinkLocalIPv6Address"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"LinkLocalIPv6Address"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"linklocalipv6prefixlen",children:"LinkLocalIPv6PrefixLen"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"LinkLocalIPv6PrefixLen"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"macaddress",children:"MacAddress"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"MacAddress"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"networks",children:"Networks"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Networks"}),": ",(0,i.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsx)(n.h5,{id:"index-signature-3",children:"Index signature"}),"\n",(0,i.jsxs)(n.p,{children:["[",(0,i.jsx)(n.code,{children:"type"}),": ",(0,i.jsx)(n.code,{children:"string"}),"]: ",(0,i.jsx)(n.code,{children:"object"})]}),"\n",(0,i.jsx)(n.h4,{id:"node",children:"Node?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"Node"}),": ",(0,i.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"nodeaddr",children:"Node.Addr"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Addr"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"nodecpus",children:"Node.Cpus"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Cpus"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"nodeid",children:"Node.ID"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"ID"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"nodeip",children:"Node.IP"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"IP"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"nodelabels",children:"Node.Labels"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Labels"}),": ",(0,i.jsx)(n.code,{children:"unknown"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"nodememory",children:"Node.Memory"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Memory"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"nodename",children:"Node.Name"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Name"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"ports",children:"Ports"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Ports"}),": ",(0,i.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsx)(n.h5,{id:"index-signature-4",children:"Index signature"}),"\n",(0,i.jsxs)(n.p,{children:["[",(0,i.jsx)(n.code,{children:"portAndProtocol"}),": ",(0,i.jsx)(n.code,{children:"string"}),"]: ",(0,i.jsx)(n.code,{children:"object"}),"[]"]}),"\n",(0,i.jsx)(n.h4,{id:"sandboxid",children:"SandboxID"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"SandboxID"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"sandboxkey",children:"SandboxKey"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"SandboxKey"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"secondaryipaddresses",children:"SecondaryIPAddresses?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"SecondaryIPAddresses"}),": ",(0,i.jsx)(n.code,{children:"unknown"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"secondaryipv6addresses",children:"SecondaryIPv6Addresses?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"SecondaryIPv6Addresses"}),": ",(0,i.jsx)(n.code,{children:"unknown"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-16",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2312",children:"packages/extension-api/src/extension-api.d.ts:2312"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"path",children:"Path"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Path"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-17",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2246",children:"packages/extension-api/src/extension-api.d.ts:2246"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"platform",children:"Platform"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Platform"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-18",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2270",children:"packages/extension-api/src/extension-api.d.ts:2270"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"processlabel",children:"ProcessLabel"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"ProcessLabel"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-19",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2272",children:"packages/extension-api/src/extension-api.d.ts:2272"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"resolvconfpath",children:"ResolvConfPath"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"ResolvConfPath"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-20",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2263",children:"packages/extension-api/src/extension-api.d.ts:2263"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"restartcount",children:"RestartCount"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"RestartCount"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-21",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2268",children:"packages/extension-api/src/extension-api.d.ts:2268"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"state",children:"State"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"State"}),": ",(0,i.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"dead",children:"Dead"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Dead"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"error",children:"Error"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Error"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"exitcode",children:"ExitCode"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"ExitCode"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"finishedat",children:"FinishedAt"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"FinishedAt"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"health",children:"Health?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"Health"}),": ",(0,i.jsx)(n.a,{href:"/api/interfaces/HealthCheckResults",children:(0,i.jsx)(n.code,{children:"HealthCheckResults"})})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"oomkilled",children:"OOMKilled"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"OOMKilled"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"paused",children:"Paused"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Paused"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"pid",children:"Pid"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Pid"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"restarting",children:"Restarting"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Restarting"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"running",children:"Running"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Running"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"startedat",children:"StartedAt"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"StartedAt"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"status",children:"Status"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Status"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-22",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2248",children:"packages/extension-api/src/extension-api.d.ts:2248"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"engineid",children:"engineId"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"engineId"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-23",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2242",children:"packages/extension-api/src/extension-api.d.ts:2242"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"enginename",children:"engineName"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"engineName"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-24",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2243",children:"packages/extension-api/src/extension-api.d.ts:2243"})})]})}function a(e={}){const{wrapper:n}={...(0,d.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(h,{...e})}):h(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>l,a:()=>c});var i=s(27378);const d={},r=i.createContext(d);function c(e){const n=i.useContext(r);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function l(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(d):e.components||d:c(e.components),i.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/e1a2ab10.e4c6b390.js b/assets/js/e1a2ab10.5778db0c.js similarity index 95% rename from assets/js/e1a2ab10.e4c6b390.js rename to assets/js/e1a2ab10.5778db0c.js index 4ef6ba436d6..a62cb7c9bb5 100644 --- a/assets/js/e1a2ab10.e4c6b390.js +++ b/assets/js/e1a2ab10.5778db0c.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[70225],{85699:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>l,contentTitle:()=>c,default:()=>h,frontMatter:()=>i,metadata:()=>o,toc:()=>a});var s=r(24246),t=r(71670);const i={},c="Interface: ProviderInstallation",o={id:"interfaces/ProviderInstallation",title:"Interface: ProviderInstallation",description:"Methods",source:"@site/api/interfaces/ProviderInstallation.md",sourceDirName:"interfaces",slug:"/interfaces/ProviderInstallation",permalink:"/api/interfaces/ProviderInstallation",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: ProviderInformation",permalink:"/api/interfaces/ProviderInformation"},next:{title:"Interface: ProviderLifecycle",permalink:"/api/interfaces/ProviderLifecycle"}},l={},a=[{value:"Methods",id:"methods",level:2},{value:"install()",id:"install",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Source",id:"source",level:4},{value:"preflightChecks()?",id:"preflightchecks",level:3},{value:"Returns",id:"returns-1",level:4},{value:"Source",id:"source-1",level:4}];function d(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,t.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"interface-providerinstallation",children:"Interface: ProviderInstallation"}),"\n",(0,s.jsx)(n.h2,{id:"methods",children:"Methods"}),"\n",(0,s.jsx)(n.h3,{id:"install",children:"install()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"install"}),"(",(0,s.jsx)(n.code,{children:"logger"}),"): ",(0,s.jsx)(n.code,{children:"Promise"}),"< ",(0,s.jsx)(n.code,{children:"void"})," >"]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"parameters",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"logger"}),": ",(0,s.jsx)(n.a,{href:"/api/interfaces/Logger",children:(0,s.jsx)(n.code,{children:"Logger"})})]}),"\n",(0,s.jsx)(n.h4,{id:"returns",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"Promise"}),"< ",(0,s.jsx)(n.code,{children:"void"})," >"]}),"\n",(0,s.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/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:"preflightchecks",children:"preflightChecks()?"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:(0,s.jsx)(n.code,{children:"optional"})})," ",(0,s.jsx)(n.strong,{children:"preflightChecks"}),"(): ",(0,s.jsx)(n.a,{href:"/api/interfaces/InstallCheck",children:(0,s.jsx)(n.code,{children:"InstallCheck"})}),"[]"]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"returns-1",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.a,{href:"/api/interfaces/InstallCheck",children:(0,s.jsx)(n.code,{children:"InstallCheck"})}),"[]"]}),"\n",(0,s.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L377",children:"packages/extension-api/src/extension-api.d.ts:377"})})]})}function h(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(d,{...e})}):d(e)}},71670:(e,n,r)=>{r.d(n,{Z:()=>o,a:()=>c});var s=r(27378);const t={},i=s.createContext(t);function c(e){const n=s.useContext(i);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:c(e.components),s.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[70225],{85699:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>l,contentTitle:()=>c,default:()=>h,frontMatter:()=>i,metadata:()=>o,toc:()=>a});var s=r(24246),t=r(71670);const i={},c="Interface: ProviderInstallation",o={id:"interfaces/ProviderInstallation",title:"Interface: ProviderInstallation",description:"Methods",source:"@site/api/interfaces/ProviderInstallation.md",sourceDirName:"interfaces",slug:"/interfaces/ProviderInstallation",permalink:"/api/interfaces/ProviderInstallation",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: ProviderInformation",permalink:"/api/interfaces/ProviderInformation"},next:{title:"Interface: ProviderLifecycle",permalink:"/api/interfaces/ProviderLifecycle"}},l={},a=[{value:"Methods",id:"methods",level:2},{value:"install()",id:"install",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Source",id:"source",level:4},{value:"preflightChecks()?",id:"preflightchecks",level:3},{value:"Returns",id:"returns-1",level:4},{value:"Source",id:"source-1",level:4}];function d(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,t.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"interface-providerinstallation",children:"Interface: ProviderInstallation"}),"\n",(0,s.jsx)(n.h2,{id:"methods",children:"Methods"}),"\n",(0,s.jsx)(n.h3,{id:"install",children:"install()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"install"}),"(",(0,s.jsx)(n.code,{children:"logger"}),"): ",(0,s.jsx)(n.code,{children:"Promise"}),"< ",(0,s.jsx)(n.code,{children:"void"})," >"]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"parameters",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"logger"}),": ",(0,s.jsx)(n.a,{href:"/api/interfaces/Logger",children:(0,s.jsx)(n.code,{children:"Logger"})})]}),"\n",(0,s.jsx)(n.h4,{id:"returns",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"Promise"}),"< ",(0,s.jsx)(n.code,{children:"void"})," >"]}),"\n",(0,s.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/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:"preflightchecks",children:"preflightChecks()?"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:(0,s.jsx)(n.code,{children:"optional"})})," ",(0,s.jsx)(n.strong,{children:"preflightChecks"}),"(): ",(0,s.jsx)(n.a,{href:"/api/interfaces/InstallCheck",children:(0,s.jsx)(n.code,{children:"InstallCheck"})}),"[]"]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"returns-1",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.a,{href:"/api/interfaces/InstallCheck",children:(0,s.jsx)(n.code,{children:"InstallCheck"})}),"[]"]}),"\n",(0,s.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L377",children:"packages/extension-api/src/extension-api.d.ts:377"})})]})}function h(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(d,{...e})}):d(e)}},71670:(e,n,r)=>{r.d(n,{Z:()=>o,a:()=>c});var s=r(27378);const t={},i=s.createContext(t);function c(e){const n=s.useContext(i);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:c(e.components),s.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/e1c8d71f.26d3cbfc.js b/assets/js/e1c8d71f.e4137a89.js similarity index 94% rename from assets/js/e1c8d71f.26d3cbfc.js rename to assets/js/e1c8d71f.e4137a89.js index b13b863fdcb..e53afa862af 100644 --- a/assets/js/e1c8d71f.26d3cbfc.js +++ b/assets/js/e1c8d71f.e4137a89.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[34884],{26461:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>r,contentTitle:()=>a,default:()=>d,frontMatter:()=>s,metadata:()=>c,toc:()=>p});var i=n(24246),o=n(71670);const s={},a="Type alias: NotificationType",c={id:"type-aliases/NotificationType",title:"Type alias: NotificationType",description:'NotificationType: "info" \\| "warn" \\| "error"',source:"@site/api/type-aliases/NotificationType.md",sourceDirName:"type-aliases",slug:"/type-aliases/NotificationType",permalink:"/api/type-aliases/NotificationType",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Type alias: MountType",permalink:"/api/type-aliases/MountType"},next:{title:"Type alias: ProviderConnectionStatus",permalink:"/api/type-aliases/ProviderConnectionStatus"}},r={},p=[{value:"Source",id:"source",level:2}];function l(e){const t={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,o.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(t.h1,{id:"type-alias-notificationtype",children:"Type alias: NotificationType"}),"\n",(0,i.jsxs)(t.blockquote,{children:["\n",(0,i.jsxs)(t.p,{children:[(0,i.jsx)(t.strong,{children:"NotificationType"}),": ",(0,i.jsx)(t.code,{children:'"info"'})," | ",(0,i.jsx)(t.code,{children:'"warn"'})," | ",(0,i.jsx)(t.code,{children:'"error"'})]}),"\n"]}),"\n",(0,i.jsx)(t.h2,{id:"source",children:"Source"}),"\n",(0,i.jsx)(t.p,{children:(0,i.jsx)(t.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L1150",children:"packages/extension-api/src/extension-api.d.ts:1150"})})]})}function d(e={}){const{wrapper:t}={...(0,o.a)(),...e.components};return t?(0,i.jsx)(t,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},71670:(e,t,n)=>{n.d(t,{Z:()=>c,a:()=>a});var i=n(27378);const o={},s=i.createContext(o);function a(e){const t=i.useContext(s);return i.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function c(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:a(e.components),i.createElement(s.Provider,{value:t},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[34884],{26461:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>r,contentTitle:()=>a,default:()=>d,frontMatter:()=>s,metadata:()=>c,toc:()=>p});var i=n(24246),o=n(71670);const s={},a="Type alias: NotificationType",c={id:"type-aliases/NotificationType",title:"Type alias: NotificationType",description:'NotificationType: "info" \\| "warn" \\| "error"',source:"@site/api/type-aliases/NotificationType.md",sourceDirName:"type-aliases",slug:"/type-aliases/NotificationType",permalink:"/api/type-aliases/NotificationType",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Type alias: MountType",permalink:"/api/type-aliases/MountType"},next:{title:"Type alias: ProviderConnectionStatus",permalink:"/api/type-aliases/ProviderConnectionStatus"}},r={},p=[{value:"Source",id:"source",level:2}];function l(e){const t={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,o.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(t.h1,{id:"type-alias-notificationtype",children:"Type alias: NotificationType"}),"\n",(0,i.jsxs)(t.blockquote,{children:["\n",(0,i.jsxs)(t.p,{children:[(0,i.jsx)(t.strong,{children:"NotificationType"}),": ",(0,i.jsx)(t.code,{children:'"info"'})," | ",(0,i.jsx)(t.code,{children:'"warn"'})," | ",(0,i.jsx)(t.code,{children:'"error"'})]}),"\n"]}),"\n",(0,i.jsx)(t.h2,{id:"source",children:"Source"}),"\n",(0,i.jsx)(t.p,{children:(0,i.jsx)(t.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L1150",children:"packages/extension-api/src/extension-api.d.ts:1150"})})]})}function d(e={}){const{wrapper:t}={...(0,o.a)(),...e.components};return t?(0,i.jsx)(t,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},71670:(e,t,n)=>{n.d(t,{Z:()=>c,a:()=>a});var i=n(27378);const o={},s=i.createContext(o);function a(e){const t=i.useContext(s);return i.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function c(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:a(e.components),i.createElement(s.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/e35d7c3e.ba8cfce9.js b/assets/js/e35d7c3e.f7bb8c4c.js similarity index 66% rename from assets/js/e35d7c3e.ba8cfce9.js rename to assets/js/e35d7c3e.f7bb8c4c.js index 6023f0bf56b..808d923955c 100644 --- a/assets/js/e35d7c3e.ba8cfce9.js +++ b/assets/js/e35d7c3e.f7bb8c4c.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[5697],{72873:(e,t,r)=>{r.r(t),r.d(t,{assets:()=>a,contentTitle:()=>c,default:()=>p,frontMatter:()=>o,metadata:()=>i,toc:()=>l});var n=r(24246),s=r(71670);const o={},c="Interface: NetworkCreateResult",i={id:"interfaces/NetworkCreateResult",title:"Interface: NetworkCreateResult",description:"Properties",source:"@site/api/interfaces/NetworkCreateResult.md",sourceDirName:"interfaces",slug:"/interfaces/NetworkCreateResult",permalink:"/api/interfaces/NetworkCreateResult",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: NetworkCreateOptions",permalink:"/api/interfaces/NetworkCreateOptions"},next:{title:"Interface: NetworkInfo",permalink:"/api/interfaces/NetworkInfo"}},a={},l=[{value:"Properties",id:"properties",level:2},{value:"Id",id:"id",level:3},{value:"Source",id:"source",level:4}];function d(e){const t={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(t.h1,{id:"interface-networkcreateresult",children:"Interface: NetworkCreateResult"}),"\n",(0,n.jsx)(t.h2,{id:"properties",children:"Properties"}),"\n",(0,n.jsx)(t.h3,{id:"id",children:"Id"}),"\n",(0,n.jsxs)(t.blockquote,{children:["\n",(0,n.jsxs)(t.p,{children:[(0,n.jsx)(t.strong,{children:"Id"}),": ",(0,n.jsx)(t.code,{children:"string"})]}),"\n"]}),"\n",(0,n.jsx)(t.h4,{id:"source",children:"Source"}),"\n",(0,n.jsx)(t.p,{children:(0,n.jsx)(t.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L3050",children:"packages/extension-api/src/extension-api.d.ts:3050"})})]})}function p(e={}){const{wrapper:t}={...(0,s.a)(),...e.components};return t?(0,n.jsx)(t,{...e,children:(0,n.jsx)(d,{...e})}):d(e)}},71670:(e,t,r)=>{r.d(t,{Z:()=>i,a:()=>c});var n=r(27378);const s={},o=n.createContext(s);function c(e){const t=n.useContext(o);return n.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function i(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:c(e.components),n.createElement(o.Provider,{value:t},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[5697],{72873:(e,t,r)=>{r.r(t),r.d(t,{assets:()=>a,contentTitle:()=>i,default:()=>p,frontMatter:()=>o,metadata:()=>c,toc:()=>d});var n=r(24246),s=r(71670);const o={},i="Interface: NetworkCreateResult",c={id:"interfaces/NetworkCreateResult",title:"Interface: NetworkCreateResult",description:"Properties",source:"@site/api/interfaces/NetworkCreateResult.md",sourceDirName:"interfaces",slug:"/interfaces/NetworkCreateResult",permalink:"/api/interfaces/NetworkCreateResult",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: NetworkCreateOptions",permalink:"/api/interfaces/NetworkCreateOptions"},next:{title:"Interface: NetworkInfo",permalink:"/api/interfaces/NetworkInfo"}},a={},d=[{value:"Properties",id:"properties",level:2},{value:"Id",id:"id",level:3},{value:"Source",id:"source",level:4}];function l(e){const t={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(t.h1,{id:"interface-networkcreateresult",children:"Interface: NetworkCreateResult"}),"\n",(0,n.jsx)(t.h2,{id:"properties",children:"Properties"}),"\n",(0,n.jsx)(t.h3,{id:"id",children:"Id"}),"\n",(0,n.jsxs)(t.blockquote,{children:["\n",(0,n.jsxs)(t.p,{children:[(0,n.jsx)(t.strong,{children:"Id"}),": ",(0,n.jsx)(t.code,{children:"string"})]}),"\n"]}),"\n",(0,n.jsx)(t.h4,{id:"source",children:"Source"}),"\n",(0,n.jsx)(t.p,{children:(0,n.jsx)(t.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L3050",children:"packages/extension-api/src/extension-api.d.ts:3050"})})]})}function p(e={}){const{wrapper:t}={...(0,s.a)(),...e.components};return t?(0,n.jsx)(t,{...e,children:(0,n.jsx)(l,{...e})}):l(e)}},71670:(e,t,r)=>{r.d(t,{Z:()=>c,a:()=>i});var n=r(27378);const s={},o=n.createContext(s);function i(e){const t=n.useContext(o);return n.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function c(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:i(e.components),n.createElement(o.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/e38c422a.93fd0ffe.js b/assets/js/e38c422a.674e4b74.js similarity index 91% rename from assets/js/e38c422a.93fd0ffe.js rename to assets/js/e38c422a.674e4b74.js index 06f1e15baa4..9f5a3ad2ab5 100644 --- a/assets/js/e38c422a.93fd0ffe.js +++ b/assets/js/e38c422a.674e4b74.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[94331],{10097:(n,e,i)=>{i.r(e),i.d(e,{assets:()=>a,contentTitle:()=>s,default:()=>p,frontMatter:()=>r,metadata:()=>c,toc:()=>u});var o=i(24246),t=i(71670);const r={},s="Function: getConfiguration()",c={id:"namespaces/configuration/functions/getConfiguration",title:"Function: getConfiguration()",description:"getConfiguration(section?, scope?): Configuration",source:"@site/api/namespaces/configuration/functions/getConfiguration.md",sourceDirName:"namespaces/configuration/functions",slug:"/namespaces/configuration/functions/getConfiguration",permalink:"/api/namespaces/configuration/functions/getConfiguration",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Namespace: configuration",permalink:"/api/namespaces/configuration/"},next:{title:"Function: onDidChangeConfiguration()",permalink:"/api/namespaces/configuration/functions/onDidChangeConfiguration"}},a={},u=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function d(n){const e={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,t.a)(),...n.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(e.h1,{id:"function-getconfiguration",children:"Function: getConfiguration()"}),"\n",(0,o.jsxs)(e.blockquote,{children:["\n",(0,o.jsxs)(e.p,{children:[(0,o.jsx)(e.strong,{children:"getConfiguration"}),"(",(0,o.jsx)(e.code,{children:"section"}),"?, ",(0,o.jsx)(e.code,{children:"scope"}),"?): ",(0,o.jsx)(e.a,{href:"/api/interfaces/Configuration",children:(0,o.jsx)(e.code,{children:"Configuration"})})]}),"\n"]}),"\n",(0,o.jsx)(e.h2,{id:"parameters",children:"Parameters"}),"\n",(0,o.jsxs)(e.p,{children:["\u2022 ",(0,o.jsx)(e.strong,{children:"section?"}),": ",(0,o.jsx)(e.code,{children:"string"})]}),"\n",(0,o.jsxs)(e.p,{children:["\u2022 ",(0,o.jsx)(e.strong,{children:"scope?"}),": ",(0,o.jsx)(e.a,{href:"/api/type-aliases/ConfigurationScope",children:(0,o.jsx)(e.code,{children:"ConfigurationScope"})})]}),"\n",(0,o.jsx)(e.h2,{id:"returns",children:"Returns"}),"\n",(0,o.jsx)(e.p,{children:(0,o.jsx)(e.a,{href:"/api/interfaces/Configuration",children:(0,o.jsx)(e.code,{children:"Configuration"})})}),"\n",(0,o.jsx)(e.h2,{id:"source",children:"Source"}),"\n",(0,o.jsx)(e.p,{children:(0,o.jsx)(e.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L651",children:"packages/extension-api/src/extension-api.d.ts:651"})})]})}function p(n={}){const{wrapper:e}={...(0,t.a)(),...n.components};return e?(0,o.jsx)(e,{...n,children:(0,o.jsx)(d,{...n})}):d(n)}},71670:(n,e,i)=>{i.d(e,{Z:()=>c,a:()=>s});var o=i(27378);const t={},r=o.createContext(t);function s(n){const e=o.useContext(r);return o.useMemo((function(){return"function"==typeof n?n(e):{...e,...n}}),[e,n])}function c(n){let e;return e=n.disableParentContext?"function"==typeof n.components?n.components(t):n.components||t:s(n.components),o.createElement(r.Provider,{value:e},n.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[94331],{10097:(n,e,i)=>{i.r(e),i.d(e,{assets:()=>a,contentTitle:()=>s,default:()=>f,frontMatter:()=>r,metadata:()=>c,toc:()=>u});var o=i(24246),t=i(71670);const r={},s="Function: getConfiguration()",c={id:"namespaces/configuration/functions/getConfiguration",title:"Function: getConfiguration()",description:"getConfiguration(section?, scope?): Configuration",source:"@site/api/namespaces/configuration/functions/getConfiguration.md",sourceDirName:"namespaces/configuration/functions",slug:"/namespaces/configuration/functions/getConfiguration",permalink:"/api/namespaces/configuration/functions/getConfiguration",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Namespace: configuration",permalink:"/api/namespaces/configuration/"},next:{title:"Function: onDidChangeConfiguration()",permalink:"/api/namespaces/configuration/functions/onDidChangeConfiguration"}},a={},u=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function d(n){const e={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,t.a)(),...n.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(e.h1,{id:"function-getconfiguration",children:"Function: getConfiguration()"}),"\n",(0,o.jsxs)(e.blockquote,{children:["\n",(0,o.jsxs)(e.p,{children:[(0,o.jsx)(e.strong,{children:"getConfiguration"}),"(",(0,o.jsx)(e.code,{children:"section"}),"?, ",(0,o.jsx)(e.code,{children:"scope"}),"?): ",(0,o.jsx)(e.a,{href:"/api/interfaces/Configuration",children:(0,o.jsx)(e.code,{children:"Configuration"})})]}),"\n"]}),"\n",(0,o.jsx)(e.h2,{id:"parameters",children:"Parameters"}),"\n",(0,o.jsxs)(e.p,{children:["\u2022 ",(0,o.jsx)(e.strong,{children:"section?"}),": ",(0,o.jsx)(e.code,{children:"string"})]}),"\n",(0,o.jsxs)(e.p,{children:["\u2022 ",(0,o.jsx)(e.strong,{children:"scope?"}),": ",(0,o.jsx)(e.a,{href:"/api/type-aliases/ConfigurationScope",children:(0,o.jsx)(e.code,{children:"ConfigurationScope"})})]}),"\n",(0,o.jsx)(e.h2,{id:"returns",children:"Returns"}),"\n",(0,o.jsx)(e.p,{children:(0,o.jsx)(e.a,{href:"/api/interfaces/Configuration",children:(0,o.jsx)(e.code,{children:"Configuration"})})}),"\n",(0,o.jsx)(e.h2,{id:"source",children:"Source"}),"\n",(0,o.jsx)(e.p,{children:(0,o.jsx)(e.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L651",children:"packages/extension-api/src/extension-api.d.ts:651"})})]})}function f(n={}){const{wrapper:e}={...(0,t.a)(),...n.components};return e?(0,o.jsx)(e,{...n,children:(0,o.jsx)(d,{...n})}):d(n)}},71670:(n,e,i)=>{i.d(e,{Z:()=>c,a:()=>s});var o=i(27378);const t={},r=o.createContext(t);function s(n){const e=o.useContext(r);return o.useMemo((function(){return"function"==typeof n?n(e):{...e,...n}}),[e,n])}function c(n){let e;return e=n.disableParentContext?"function"==typeof n.components?n.components(t):n.components||t:s(n.components),o.createElement(r.Provider,{value:e},n.children)}}}]); \ No newline at end of file diff --git a/assets/js/e3f28bf9.15423e05.js b/assets/js/e3f28bf9.d055211d.js similarity index 97% rename from assets/js/e3f28bf9.15423e05.js rename to assets/js/e3f28bf9.d055211d.js index c472240f82f..fd5737a6928 100644 --- a/assets/js/e3f28bf9.15423e05.js +++ b/assets/js/e3f28bf9.d055211d.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[36248],{33712:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>o,default:()=>u,frontMatter:()=>s,metadata:()=>c,toc:()=>d});var r=t(24246),i=t(71670);const s={},o="Interface: RegisterKubernetesConnectionEvent",c={id:"interfaces/RegisterKubernetesConnectionEvent",title:"Interface: RegisterKubernetesConnectionEvent",description:"Properties",source:"@site/api/interfaces/RegisterKubernetesConnectionEvent.md",sourceDirName:"interfaces",slug:"/interfaces/RegisterKubernetesConnectionEvent",permalink:"/api/interfaces/RegisterKubernetesConnectionEvent",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: RegisterContainerConnectionEvent",permalink:"/api/interfaces/RegisterContainerConnectionEvent"},next:{title:"Interface: Registry",permalink:"/api/interfaces/Registry"}},a={},d=[{value:"Properties",id:"properties",level:2},{value:"providerId",id:"providerid",level:3},{value:"Source",id:"source",level:4}];function p(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",p:"p",strong:"strong",...(0,i.a)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.h1,{id:"interface-registerkubernetesconnectionevent",children:"Interface: RegisterKubernetesConnectionEvent"}),"\n",(0,r.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,r.jsx)(n.h3,{id:"providerid",children:"providerId"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"providerId"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L533",children:"packages/extension-api/src/extension-api.d.ts:533"})})]})}function u(e={}){const{wrapper:n}={...(0,i.a)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(p,{...e})}):p(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>c,a:()=>o});var r=t(27378);const i={},s=r.createContext(i);function o(e){const n=r.useContext(s);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:o(e.components),r.createElement(s.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[36248],{33712:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>o,default:()=>u,frontMatter:()=>s,metadata:()=>c,toc:()=>d});var r=t(24246),i=t(71670);const s={},o="Interface: RegisterKubernetesConnectionEvent",c={id:"interfaces/RegisterKubernetesConnectionEvent",title:"Interface: RegisterKubernetesConnectionEvent",description:"Properties",source:"@site/api/interfaces/RegisterKubernetesConnectionEvent.md",sourceDirName:"interfaces",slug:"/interfaces/RegisterKubernetesConnectionEvent",permalink:"/api/interfaces/RegisterKubernetesConnectionEvent",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: RegisterContainerConnectionEvent",permalink:"/api/interfaces/RegisterContainerConnectionEvent"},next:{title:"Interface: Registry",permalink:"/api/interfaces/Registry"}},a={},d=[{value:"Properties",id:"properties",level:2},{value:"providerId",id:"providerid",level:3},{value:"Source",id:"source",level:4}];function p(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",p:"p",strong:"strong",...(0,i.a)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.h1,{id:"interface-registerkubernetesconnectionevent",children:"Interface: RegisterKubernetesConnectionEvent"}),"\n",(0,r.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,r.jsx)(n.h3,{id:"providerid",children:"providerId"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"providerId"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L533",children:"packages/extension-api/src/extension-api.d.ts:533"})})]})}function u(e={}){const{wrapper:n}={...(0,i.a)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(p,{...e})}):p(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>c,a:()=>o});var r=t(27378);const i={},s=r.createContext(i);function o(e){const n=r.useContext(s);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:o(e.components),r.createElement(s.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/e546fc5a.59353cfa.js b/assets/js/e546fc5a.e8f570b5.js similarity index 96% rename from assets/js/e546fc5a.59353cfa.js rename to assets/js/e546fc5a.e8f570b5.js index fe6d9354338..a2825261476 100644 --- a/assets/js/e546fc5a.59353cfa.js +++ b/assets/js/e546fc5a.e8f570b5.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[63190],{47037:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>a,contentTitle:()=>o,default:()=>p,frontMatter:()=>r,metadata:()=>c,toc:()=>d});var i=s(24246),t=s(71670);const r={},o="Function: onDidUpdateProxy()",c={id:"namespaces/proxy/functions/onDidUpdateProxy",title:"Function: onDidUpdateProxy()",description:"onDidUpdateProxy(listener, thisArgs?, disposables?): Disposable",source:"@site/api/namespaces/proxy/functions/onDidUpdateProxy.md",sourceDirName:"namespaces/proxy/functions",slug:"/namespaces/proxy/functions/onDidUpdateProxy",permalink:"/api/namespaces/proxy/functions/onDidUpdateProxy",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Function: onDidStateChange()",permalink:"/api/namespaces/proxy/functions/onDidStateChange"},next:{title:"Function: setProxy()",permalink:"/api/namespaces/proxy/functions/setProxy"}},a={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,t.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"function-ondidupdateproxy",children:"Function: onDidUpdateProxy()"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"onDidUpdateProxy"}),"(",(0,i.jsx)(n.code,{children:"listener"}),", ",(0,i.jsx)(n.code,{children:"thisArgs"}),"?, ",(0,i.jsx)(n.code,{children:"disposables"}),"?): ",(0,i.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(n.code,{children:"Disposable"})})]}),"\n"]}),"\n",(0,i.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"listener"})]}),"\n",(0,i.jsx)(n.p,{children:"The listener function will be called when the event happens."}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"thisArgs?"}),": ",(0,i.jsx)(n.code,{children:"any"})]}),"\n",(0,i.jsxs)(n.p,{children:["The ",(0,i.jsx)(n.code,{children:"this"}),"-argument which will be used when calling the event listener."]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"disposables?"}),": ",(0,i.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(n.code,{children:"Disposable"})}),"[]"]}),"\n",(0,i.jsxs)(n.p,{children:["An array to which a ",(0,i.jsx)(n.a,{href:"/api/classes/Disposable",children:"Disposable"})," will be added."]}),"\n",(0,i.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(n.code,{children:"Disposable"})})}),"\n",(0,i.jsx)(n.p,{children:"A disposable which unsubscribes the event listener."}),"\n",(0,i.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/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,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>c,a:()=>o});var i=s(27378);const t={},r=i.createContext(t);function o(e){const n=i.useContext(r);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:o(e.components),i.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[63190],{47037:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>a,contentTitle:()=>o,default:()=>p,frontMatter:()=>r,metadata:()=>c,toc:()=>d});var i=s(24246),t=s(71670);const r={},o="Function: onDidUpdateProxy()",c={id:"namespaces/proxy/functions/onDidUpdateProxy",title:"Function: onDidUpdateProxy()",description:"onDidUpdateProxy(listener, thisArgs?, disposables?): Disposable",source:"@site/api/namespaces/proxy/functions/onDidUpdateProxy.md",sourceDirName:"namespaces/proxy/functions",slug:"/namespaces/proxy/functions/onDidUpdateProxy",permalink:"/api/namespaces/proxy/functions/onDidUpdateProxy",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Function: onDidStateChange()",permalink:"/api/namespaces/proxy/functions/onDidStateChange"},next:{title:"Function: setProxy()",permalink:"/api/namespaces/proxy/functions/setProxy"}},a={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,t.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"function-ondidupdateproxy",children:"Function: onDidUpdateProxy()"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"onDidUpdateProxy"}),"(",(0,i.jsx)(n.code,{children:"listener"}),", ",(0,i.jsx)(n.code,{children:"thisArgs"}),"?, ",(0,i.jsx)(n.code,{children:"disposables"}),"?): ",(0,i.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(n.code,{children:"Disposable"})})]}),"\n"]}),"\n",(0,i.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"listener"})]}),"\n",(0,i.jsx)(n.p,{children:"The listener function will be called when the event happens."}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"thisArgs?"}),": ",(0,i.jsx)(n.code,{children:"any"})]}),"\n",(0,i.jsxs)(n.p,{children:["The ",(0,i.jsx)(n.code,{children:"this"}),"-argument which will be used when calling the event listener."]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"disposables?"}),": ",(0,i.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(n.code,{children:"Disposable"})}),"[]"]}),"\n",(0,i.jsxs)(n.p,{children:["An array to which a ",(0,i.jsx)(n.a,{href:"/api/classes/Disposable",children:"Disposable"})," will be added."]}),"\n",(0,i.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(n.code,{children:"Disposable"})})}),"\n",(0,i.jsx)(n.p,{children:"A disposable which unsubscribes the event listener."}),"\n",(0,i.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/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,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>c,a:()=>o});var i=s(27378);const t={},r=i.createContext(t);function o(e){const n=i.useContext(r);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:o(e.components),i.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/e6412603.62be0a1e.js b/assets/js/e6412603.0551d01b.js similarity index 96% rename from assets/js/e6412603.62be0a1e.js rename to assets/js/e6412603.0551d01b.js index c0fc0eeb389..bf9b568dad2 100644 --- a/assets/js/e6412603.62be0a1e.js +++ b/assets/js/e6412603.0551d01b.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[92955],{3631:(e,s,n)=>{n.r(s),n.d(s,{assets:()=>a,contentTitle:()=>c,default:()=>p,frontMatter:()=>r,metadata:()=>o,toc:()=>d});var i=n(24246),t=n(71670);const r={},c="Function: onDidUpdateRegistry()",o={id:"namespaces/registry/functions/onDidUpdateRegistry",title:"Function: onDidUpdateRegistry()",description:"onDidUpdateRegistry(listener, thisArgs?, disposables?): Disposable",source:"@site/api/namespaces/registry/functions/onDidUpdateRegistry.md",sourceDirName:"namespaces/registry/functions",slug:"/namespaces/registry/functions/onDidUpdateRegistry",permalink:"/api/namespaces/registry/functions/onDidUpdateRegistry",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Function: onDidUnregisterRegistry()",permalink:"/api/namespaces/registry/functions/onDidUnregisterRegistry"},next:{title:"Function: registerRegistry()",permalink:"/api/namespaces/registry/functions/registerRegistry"}},a={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function l(e){const s={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,t.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(s.h1,{id:"function-ondidupdateregistry",children:"Function: onDidUpdateRegistry()"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"onDidUpdateRegistry"}),"(",(0,i.jsx)(s.code,{children:"listener"}),", ",(0,i.jsx)(s.code,{children:"thisArgs"}),"?, ",(0,i.jsx)(s.code,{children:"disposables"}),"?): ",(0,i.jsx)(s.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(s.code,{children:"Disposable"})})]}),"\n"]}),"\n",(0,i.jsx)(s.h2,{id:"parameters",children:"Parameters"}),"\n",(0,i.jsxs)(s.p,{children:["\u2022 ",(0,i.jsx)(s.strong,{children:"listener"})]}),"\n",(0,i.jsx)(s.p,{children:"The listener function will be called when the event happens."}),"\n",(0,i.jsxs)(s.p,{children:["\u2022 ",(0,i.jsx)(s.strong,{children:"thisArgs?"}),": ",(0,i.jsx)(s.code,{children:"any"})]}),"\n",(0,i.jsxs)(s.p,{children:["The ",(0,i.jsx)(s.code,{children:"this"}),"-argument which will be used when calling the event listener."]}),"\n",(0,i.jsxs)(s.p,{children:["\u2022 ",(0,i.jsx)(s.strong,{children:"disposables?"}),": ",(0,i.jsx)(s.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(s.code,{children:"Disposable"})}),"[]"]}),"\n",(0,i.jsxs)(s.p,{children:["An array to which a ",(0,i.jsx)(s.a,{href:"/api/classes/Disposable",children:"Disposable"})," will be added."]}),"\n",(0,i.jsx)(s.h2,{id:"returns",children:"Returns"}),"\n",(0,i.jsx)(s.p,{children:(0,i.jsx)(s.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(s.code,{children:"Disposable"})})}),"\n",(0,i.jsx)(s.p,{children:"A disposable which unsubscribes the event listener."}),"\n",(0,i.jsx)(s.h2,{id:"source",children:"Source"}),"\n",(0,i.jsx)(s.p,{children:(0,i.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L631",children:"packages/extension-api/src/extension-api.d.ts:631"})})]})}function p(e={}){const{wrapper:s}={...(0,t.a)(),...e.components};return s?(0,i.jsx)(s,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},71670:(e,s,n)=>{n.d(s,{Z:()=>o,a:()=>c});var i=n(27378);const t={},r=i.createContext(t);function c(e){const s=i.useContext(r);return i.useMemo((function(){return"function"==typeof e?e(s):{...s,...e}}),[s,e])}function o(e){let s;return s=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:c(e.components),i.createElement(r.Provider,{value:s},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[92955],{3631:(e,s,n)=>{n.r(s),n.d(s,{assets:()=>a,contentTitle:()=>c,default:()=>p,frontMatter:()=>r,metadata:()=>o,toc:()=>d});var i=n(24246),t=n(71670);const r={},c="Function: onDidUpdateRegistry()",o={id:"namespaces/registry/functions/onDidUpdateRegistry",title:"Function: onDidUpdateRegistry()",description:"onDidUpdateRegistry(listener, thisArgs?, disposables?): Disposable",source:"@site/api/namespaces/registry/functions/onDidUpdateRegistry.md",sourceDirName:"namespaces/registry/functions",slug:"/namespaces/registry/functions/onDidUpdateRegistry",permalink:"/api/namespaces/registry/functions/onDidUpdateRegistry",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Function: onDidUnregisterRegistry()",permalink:"/api/namespaces/registry/functions/onDidUnregisterRegistry"},next:{title:"Function: registerRegistry()",permalink:"/api/namespaces/registry/functions/registerRegistry"}},a={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function l(e){const s={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,t.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(s.h1,{id:"function-ondidupdateregistry",children:"Function: onDidUpdateRegistry()"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"onDidUpdateRegistry"}),"(",(0,i.jsx)(s.code,{children:"listener"}),", ",(0,i.jsx)(s.code,{children:"thisArgs"}),"?, ",(0,i.jsx)(s.code,{children:"disposables"}),"?): ",(0,i.jsx)(s.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(s.code,{children:"Disposable"})})]}),"\n"]}),"\n",(0,i.jsx)(s.h2,{id:"parameters",children:"Parameters"}),"\n",(0,i.jsxs)(s.p,{children:["\u2022 ",(0,i.jsx)(s.strong,{children:"listener"})]}),"\n",(0,i.jsx)(s.p,{children:"The listener function will be called when the event happens."}),"\n",(0,i.jsxs)(s.p,{children:["\u2022 ",(0,i.jsx)(s.strong,{children:"thisArgs?"}),": ",(0,i.jsx)(s.code,{children:"any"})]}),"\n",(0,i.jsxs)(s.p,{children:["The ",(0,i.jsx)(s.code,{children:"this"}),"-argument which will be used when calling the event listener."]}),"\n",(0,i.jsxs)(s.p,{children:["\u2022 ",(0,i.jsx)(s.strong,{children:"disposables?"}),": ",(0,i.jsx)(s.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(s.code,{children:"Disposable"})}),"[]"]}),"\n",(0,i.jsxs)(s.p,{children:["An array to which a ",(0,i.jsx)(s.a,{href:"/api/classes/Disposable",children:"Disposable"})," will be added."]}),"\n",(0,i.jsx)(s.h2,{id:"returns",children:"Returns"}),"\n",(0,i.jsx)(s.p,{children:(0,i.jsx)(s.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(s.code,{children:"Disposable"})})}),"\n",(0,i.jsx)(s.p,{children:"A disposable which unsubscribes the event listener."}),"\n",(0,i.jsx)(s.h2,{id:"source",children:"Source"}),"\n",(0,i.jsx)(s.p,{children:(0,i.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L631",children:"packages/extension-api/src/extension-api.d.ts:631"})})]})}function p(e={}){const{wrapper:s}={...(0,t.a)(),...e.components};return s?(0,i.jsx)(s,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},71670:(e,s,n)=>{n.d(s,{Z:()=>o,a:()=>c});var i=n(27378);const t={},r=i.createContext(t);function c(e){const s=i.useContext(r);return i.useMemo((function(){return"function"==typeof e?e(s):{...s,...e}}),[s,e])}function o(e){let s;return s=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:c(e.components),i.createElement(r.Provider,{value:s},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/e69dadab.bbc7b49b.js b/assets/js/e69dadab.0288ce06.js similarity index 81% rename from assets/js/e69dadab.bbc7b49b.js rename to assets/js/e69dadab.0288ce06.js index cfd3c0e8af1..19f00115229 100644 --- a/assets/js/e69dadab.bbc7b49b.js +++ b/assets/js/e69dadab.0288ce06.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[75273],{56168:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>d,contentTitle:()=>r,default:()=>h,frontMatter:()=>o,metadata:()=>t,toc:()=>a});var i=s(24246),c=s(71670);const o={},r="Interface: PodmanContainerCreateOptions",t={id:"interfaces/PodmanContainerCreateOptions",title:"Interface: PodmanContainerCreateOptions",description:"Properties",source:"@site/api/interfaces/PodmanContainerCreateOptions.md",sourceDirName:"interfaces",slug:"/interfaces/PodmanContainerCreateOptions",permalink:"/api/interfaces/PodmanContainerCreateOptions",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: PodInfo",permalink:"/api/interfaces/PodInfo"},next:{title:"Interface: Port",permalink:"/api/interfaces/Port"}},d={},a=[{value:"Properties",id:"properties",level:2},{value:"command?",id:"command",level:3},{value:"Source",id:"source",level:4},{value:"entrypoint?",id:"entrypoint",level:3},{value:"Source",id:"source-1",level:4},{value:"env?",id:"env",level:3},{value:"Index signature",id:"index-signature",level:4},{value:"Source",id:"source-2",level:4},{value:"hostname?",id:"hostname",level:3},{value:"Source",id:"source-3",level:4},{value:"image?",id:"image",level:3},{value:"Source",id:"source-4",level:4},{value:"mounts?",id:"mounts",level:3},{value:"Source",id:"source-5",level:4},{value:"name?",id:"name",level:3},{value:"Source",id:"source-6",level:4},{value:"pod?",id:"pod",level:3},{value:"Source",id:"source-7",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,c.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"interface-podmancontainercreateoptions",children:"Interface: PodmanContainerCreateOptions"}),"\n",(0,i.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(n.h3,{id:"command",children:"command?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"command"}),": ",(0,i.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2539",children:"packages/extension-api/src/extension-api.d.ts:2539"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"entrypoint",children:"entrypoint?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"entrypoint"}),": ",(0,i.jsx)(n.code,{children:"string"})," | ",(0,i.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2540",children:"packages/extension-api/src/extension-api.d.ts:2540"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"env",children:"env?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"env"}),": ",(0,i.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"index-signature",children:"Index signature"}),"\n",(0,i.jsxs)(n.p,{children:["[",(0,i.jsx)(n.code,{children:"key"}),": ",(0,i.jsx)(n.code,{children:"string"}),"]: ",(0,i.jsx)(n.code,{children:"string"})]}),"\n",(0,i.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2541",children:"packages/extension-api/src/extension-api.d.ts:2541"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"hostname",children:"hostname?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"hostname"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2543",children:"packages/extension-api/src/extension-api.d.ts:2543"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"image",children:"image?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"image"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-4",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2544",children:"packages/extension-api/src/extension-api.d.ts:2544"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"mounts",children:"mounts?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"mounts"}),": ",(0,i.jsx)(n.code,{children:"object"}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-5",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2546",children:"packages/extension-api/src/extension-api.d.ts:2546"})}),"\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:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"name"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-6",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2545",children:"packages/extension-api/src/extension-api.d.ts:2545"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"pod",children:"pod?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"pod"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-7",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2542",children:"packages/extension-api/src/extension-api.d.ts:2542"})})]})}function h(e={}){const{wrapper:n}={...(0,c.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>t,a:()=>r});var i=s(27378);const c={},o=i.createContext(c);function r(e){const n=i.useContext(o);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function t(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(c):e.components||c:r(e.components),i.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[75273],{56168:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>d,contentTitle:()=>r,default:()=>h,frontMatter:()=>c,metadata:()=>t,toc:()=>a});var i=s(24246),o=s(71670);const c={},r="Interface: PodmanContainerCreateOptions",t={id:"interfaces/PodmanContainerCreateOptions",title:"Interface: PodmanContainerCreateOptions",description:"Properties",source:"@site/api/interfaces/PodmanContainerCreateOptions.md",sourceDirName:"interfaces",slug:"/interfaces/PodmanContainerCreateOptions",permalink:"/api/interfaces/PodmanContainerCreateOptions",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: PodInfo",permalink:"/api/interfaces/PodInfo"},next:{title:"Interface: Port",permalink:"/api/interfaces/Port"}},d={},a=[{value:"Properties",id:"properties",level:2},{value:"command?",id:"command",level:3},{value:"Source",id:"source",level:4},{value:"entrypoint?",id:"entrypoint",level:3},{value:"Source",id:"source-1",level:4},{value:"env?",id:"env",level:3},{value:"Index signature",id:"index-signature",level:4},{value:"Source",id:"source-2",level:4},{value:"hostname?",id:"hostname",level:3},{value:"Source",id:"source-3",level:4},{value:"image?",id:"image",level:3},{value:"Source",id:"source-4",level:4},{value:"mounts?",id:"mounts",level:3},{value:"Source",id:"source-5",level:4},{value:"name?",id:"name",level:3},{value:"Source",id:"source-6",level:4},{value:"pod?",id:"pod",level:3},{value:"Source",id:"source-7",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,o.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"interface-podmancontainercreateoptions",children:"Interface: PodmanContainerCreateOptions"}),"\n",(0,i.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(n.h3,{id:"command",children:"command?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"command"}),": ",(0,i.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2539",children:"packages/extension-api/src/extension-api.d.ts:2539"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"entrypoint",children:"entrypoint?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"entrypoint"}),": ",(0,i.jsx)(n.code,{children:"string"})," | ",(0,i.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2540",children:"packages/extension-api/src/extension-api.d.ts:2540"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"env",children:"env?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"env"}),": ",(0,i.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"index-signature",children:"Index signature"}),"\n",(0,i.jsxs)(n.p,{children:["[",(0,i.jsx)(n.code,{children:"key"}),": ",(0,i.jsx)(n.code,{children:"string"}),"]: ",(0,i.jsx)(n.code,{children:"string"})]}),"\n",(0,i.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2541",children:"packages/extension-api/src/extension-api.d.ts:2541"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"hostname",children:"hostname?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"hostname"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2543",children:"packages/extension-api/src/extension-api.d.ts:2543"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"image",children:"image?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"image"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-4",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2544",children:"packages/extension-api/src/extension-api.d.ts:2544"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"mounts",children:"mounts?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"mounts"}),": ",(0,i.jsx)(n.code,{children:"object"}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-5",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2546",children:"packages/extension-api/src/extension-api.d.ts:2546"})}),"\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:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"name"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-6",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2545",children:"packages/extension-api/src/extension-api.d.ts:2545"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"pod",children:"pod?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"pod"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-7",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2542",children:"packages/extension-api/src/extension-api.d.ts:2542"})})]})}function h(e={}){const{wrapper:n}={...(0,o.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>t,a:()=>r});var i=s(27378);const o={},c=i.createContext(o);function r(e){const n=i.useContext(c);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function t(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:r(e.components),i.createElement(c.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/e6c31e60.31d339aa.js b/assets/js/e6c31e60.c452f930.js similarity index 84% rename from assets/js/e6c31e60.31d339aa.js rename to assets/js/e6c31e60.c452f930.js index 95c1cff369f..f3e095e44ed 100644 --- a/assets/js/e6c31e60.31d339aa.js +++ b/assets/js/e6c31e60.c452f930.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[72931],{32589:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>d,contentTitle:()=>c,default:()=>h,frontMatter:()=>t,metadata:()=>o,toc:()=>a});var s=r(24246),i=r(71670);const t={},c="Interface: ProviderUpdate",o={id:"interfaces/ProviderUpdate",title:"Interface: ProviderUpdate",description:"Properties",source:"@site/api/interfaces/ProviderUpdate.md",sourceDirName:"interfaces",slug:"/interfaces/ProviderUpdate",permalink:"/api/interfaces/ProviderUpdate",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: ProviderOptions",permalink:"/api/interfaces/ProviderOptions"},next:{title:"Interface: ProxySettings",permalink:"/api/interfaces/ProxySettings"}},d={},a=[{value:"Properties",id:"properties",level:2},{value:"version",id:"version",level:3},{value:"Source",id:"source",level:4},{value:"Methods",id:"methods",level:2},{value:"preflightChecks()?",id:"preflightchecks",level:3},{value:"Returns",id:"returns",level:4},{value:"Source",id:"source-1",level:4},{value:"update()",id:"update",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Source",id:"source-2",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,i.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"interface-providerupdate",children:"Interface: ProviderUpdate"}),"\n",(0,s.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,s.jsx)(n.h3,{id:"version",children:"version"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"version"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L383",children:"packages/extension-api/src/extension-api.d.ts:383"})}),"\n",(0,s.jsx)(n.h2,{id:"methods",children:"Methods"}),"\n",(0,s.jsx)(n.h3,{id:"preflightchecks",children:"preflightChecks()?"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:(0,s.jsx)(n.code,{children:"optional"})})," ",(0,s.jsx)(n.strong,{children:"preflightChecks"}),"(): ",(0,s.jsx)(n.a,{href:"/api/interfaces/InstallCheck",children:(0,s.jsx)(n.code,{children:"InstallCheck"})}),"[]"]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"returns",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.a,{href:"/api/interfaces/InstallCheck",children:(0,s.jsx)(n.code,{children:"InstallCheck"})}),"[]"]}),"\n",(0,s.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L387",children:"packages/extension-api/src/extension-api.d.ts:387"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"update",children:"update()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"update"}),"(",(0,s.jsx)(n.code,{children:"logger"}),"): ",(0,s.jsx)(n.code,{children:"Promise"}),"< ",(0,s.jsx)(n.code,{children:"void"})," >"]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"parameters",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"logger"}),": ",(0,s.jsx)(n.a,{href:"/api/interfaces/Logger",children:(0,s.jsx)(n.code,{children:"Logger"})})]}),"\n",(0,s.jsx)(n.h4,{id:"returns-1",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"Promise"}),"< ",(0,s.jsx)(n.code,{children:"void"})," >"]}),"\n",(0,s.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L385",children:"packages/extension-api/src/extension-api.d.ts:385"})})]})}function h(e={}){const{wrapper:n}={...(0,i.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},71670:(e,n,r)=>{r.d(n,{Z:()=>o,a:()=>c});var s=r(27378);const i={},t=s.createContext(i);function c(e){const n=s.useContext(t);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:c(e.components),s.createElement(t.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[72931],{32589:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>o,contentTitle:()=>c,default:()=>h,frontMatter:()=>t,metadata:()=>d,toc:()=>a});var s=r(24246),i=r(71670);const t={},c="Interface: ProviderUpdate",d={id:"interfaces/ProviderUpdate",title:"Interface: ProviderUpdate",description:"Properties",source:"@site/api/interfaces/ProviderUpdate.md",sourceDirName:"interfaces",slug:"/interfaces/ProviderUpdate",permalink:"/api/interfaces/ProviderUpdate",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: ProviderOptions",permalink:"/api/interfaces/ProviderOptions"},next:{title:"Interface: ProxySettings",permalink:"/api/interfaces/ProxySettings"}},o={},a=[{value:"Properties",id:"properties",level:2},{value:"version",id:"version",level:3},{value:"Source",id:"source",level:4},{value:"Methods",id:"methods",level:2},{value:"preflightChecks()?",id:"preflightchecks",level:3},{value:"Returns",id:"returns",level:4},{value:"Source",id:"source-1",level:4},{value:"update()",id:"update",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Source",id:"source-2",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,i.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"interface-providerupdate",children:"Interface: ProviderUpdate"}),"\n",(0,s.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,s.jsx)(n.h3,{id:"version",children:"version"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"version"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L383",children:"packages/extension-api/src/extension-api.d.ts:383"})}),"\n",(0,s.jsx)(n.h2,{id:"methods",children:"Methods"}),"\n",(0,s.jsx)(n.h3,{id:"preflightchecks",children:"preflightChecks()?"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:(0,s.jsx)(n.code,{children:"optional"})})," ",(0,s.jsx)(n.strong,{children:"preflightChecks"}),"(): ",(0,s.jsx)(n.a,{href:"/api/interfaces/InstallCheck",children:(0,s.jsx)(n.code,{children:"InstallCheck"})}),"[]"]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"returns",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.a,{href:"/api/interfaces/InstallCheck",children:(0,s.jsx)(n.code,{children:"InstallCheck"})}),"[]"]}),"\n",(0,s.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L387",children:"packages/extension-api/src/extension-api.d.ts:387"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"update",children:"update()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"update"}),"(",(0,s.jsx)(n.code,{children:"logger"}),"): ",(0,s.jsx)(n.code,{children:"Promise"}),"< ",(0,s.jsx)(n.code,{children:"void"})," >"]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"parameters",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"logger"}),": ",(0,s.jsx)(n.a,{href:"/api/interfaces/Logger",children:(0,s.jsx)(n.code,{children:"Logger"})})]}),"\n",(0,s.jsx)(n.h4,{id:"returns-1",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"Promise"}),"< ",(0,s.jsx)(n.code,{children:"void"})," >"]}),"\n",(0,s.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L385",children:"packages/extension-api/src/extension-api.d.ts:385"})})]})}function h(e={}){const{wrapper:n}={...(0,i.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},71670:(e,n,r)=>{r.d(n,{Z:()=>d,a:()=>c});var s=r(27378);const i={},t=s.createContext(i);function c(e){const n=s.useContext(t);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function d(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:c(e.components),s.createElement(t.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/e7477a94.633316ab.js b/assets/js/e7477a94.eabd4d09.js similarity index 85% rename from assets/js/e7477a94.633316ab.js rename to assets/js/e7477a94.eabd4d09.js index 27409d55483..56f1fa7a8e3 100644 --- a/assets/js/e7477a94.633316ab.js +++ b/assets/js/e7477a94.eabd4d09.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[12864],{46617:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>l,contentTitle:()=>r,default:()=>h,frontMatter:()=>c,metadata:()=>o,toc:()=>a});var t=s(24246),i=s(71670);const c={},r="Interface: InstallCheck",o={id:"interfaces/InstallCheck",title:"Interface: InstallCheck",description:"Properties",source:"@site/api/interfaces/InstallCheck.md",sourceDirName:"interfaces",slug:"/interfaces/InstallCheck",permalink:"/api/interfaces/InstallCheck",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: InputBoxValidationMessage",permalink:"/api/interfaces/InputBoxValidationMessage"},next:{title:"Interface: KubeconfigUpdateEvent",permalink:"/api/interfaces/KubeconfigUpdateEvent"}},l={},a=[{value:"Properties",id:"properties",level:2},{value:"title",id:"title",level:3},{value:"Source",id:"source",level:4},{value:"Methods",id:"methods",level:2},{value:"execute()",id:"execute",level:3},{value:"Returns",id:"returns",level:4},{value:"Source",id:"source-1",level:4},{value:"init()?",id:"init",level:3},{value:"Returns",id:"returns-1",level:4},{value:"Source",id:"source-2",level:4}];function d(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,i.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"interface-installcheck",children:"Interface: InstallCheck"}),"\n",(0,t.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,t.jsx)(n.h3,{id:"title",children:"title"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"title"}),": ",(0,t.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L371",children:"packages/extension-api/src/extension-api.d.ts:371"})}),"\n",(0,t.jsx)(n.h2,{id:"methods",children:"Methods"}),"\n",(0,t.jsx)(n.h3,{id:"execute",children:"execute()"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"execute"}),"(): ",(0,t.jsx)(n.code,{children:"Promise"}),"< ",(0,t.jsx)(n.a,{href:"/api/interfaces/CheckResult",children:(0,t.jsx)(n.code,{children:"CheckResult"})})," >"]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"returns",children:"Returns"}),"\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"Promise"}),"< ",(0,t.jsx)(n.a,{href:"/api/interfaces/CheckResult",children:(0,t.jsx)(n.code,{children:"CheckResult"})})," >"]}),"\n",(0,t.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L372",children:"packages/extension-api/src/extension-api.d.ts:372"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"init",children:"init()?"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:(0,t.jsx)(n.code,{children:"optional"})})," ",(0,t.jsx)(n.strong,{children:"init"}),"(): ",(0,t.jsx)(n.code,{children:"Promise"}),"< ",(0,t.jsx)(n.code,{children:"void"})," >"]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"returns-1",children:"Returns"}),"\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"Promise"}),"< ",(0,t.jsx)(n.code,{children:"void"})," >"]}),"\n",(0,t.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L373",children:"packages/extension-api/src/extension-api.d.ts:373"})})]})}function h(e={}){const{wrapper:n}={...(0,i.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(d,{...e})}):d(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>o,a:()=>r});var t=s(27378);const i={},c=t.createContext(i);function r(e){const n=t.useContext(c);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:r(e.components),t.createElement(c.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[12864],{46617:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>l,contentTitle:()=>r,default:()=>h,frontMatter:()=>c,metadata:()=>o,toc:()=>d});var t=s(24246),i=s(71670);const c={},r="Interface: InstallCheck",o={id:"interfaces/InstallCheck",title:"Interface: InstallCheck",description:"Properties",source:"@site/api/interfaces/InstallCheck.md",sourceDirName:"interfaces",slug:"/interfaces/InstallCheck",permalink:"/api/interfaces/InstallCheck",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: InputBoxValidationMessage",permalink:"/api/interfaces/InputBoxValidationMessage"},next:{title:"Interface: KubeconfigUpdateEvent",permalink:"/api/interfaces/KubeconfigUpdateEvent"}},l={},d=[{value:"Properties",id:"properties",level:2},{value:"title",id:"title",level:3},{value:"Source",id:"source",level:4},{value:"Methods",id:"methods",level:2},{value:"execute()",id:"execute",level:3},{value:"Returns",id:"returns",level:4},{value:"Source",id:"source-1",level:4},{value:"init()?",id:"init",level:3},{value:"Returns",id:"returns-1",level:4},{value:"Source",id:"source-2",level:4}];function a(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,i.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"interface-installcheck",children:"Interface: InstallCheck"}),"\n",(0,t.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,t.jsx)(n.h3,{id:"title",children:"title"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"title"}),": ",(0,t.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L371",children:"packages/extension-api/src/extension-api.d.ts:371"})}),"\n",(0,t.jsx)(n.h2,{id:"methods",children:"Methods"}),"\n",(0,t.jsx)(n.h3,{id:"execute",children:"execute()"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"execute"}),"(): ",(0,t.jsx)(n.code,{children:"Promise"}),"< ",(0,t.jsx)(n.a,{href:"/api/interfaces/CheckResult",children:(0,t.jsx)(n.code,{children:"CheckResult"})})," >"]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"returns",children:"Returns"}),"\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"Promise"}),"< ",(0,t.jsx)(n.a,{href:"/api/interfaces/CheckResult",children:(0,t.jsx)(n.code,{children:"CheckResult"})})," >"]}),"\n",(0,t.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L372",children:"packages/extension-api/src/extension-api.d.ts:372"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"init",children:"init()?"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:(0,t.jsx)(n.code,{children:"optional"})})," ",(0,t.jsx)(n.strong,{children:"init"}),"(): ",(0,t.jsx)(n.code,{children:"Promise"}),"< ",(0,t.jsx)(n.code,{children:"void"})," >"]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"returns-1",children:"Returns"}),"\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"Promise"}),"< ",(0,t.jsx)(n.code,{children:"void"})," >"]}),"\n",(0,t.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L373",children:"packages/extension-api/src/extension-api.d.ts:373"})})]})}function h(e={}){const{wrapper:n}={...(0,i.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(a,{...e})}):a(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>o,a:()=>r});var t=s(27378);const i={},c=t.createContext(i);function r(e){const n=t.useContext(c);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:r(e.components),t.createElement(c.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/e7923b27.83e4a55f.js b/assets/js/e7923b27.e35876bd.js similarity index 98% rename from assets/js/e7923b27.83e4a55f.js rename to assets/js/e7923b27.e35876bd.js index 067743a9362..7a5d000f811 100644 --- a/assets/js/e7923b27.83e4a55f.js +++ b/assets/js/e7923b27.e35876bd.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[9055],{87335:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>l,contentTitle:()=>c,default:()=>h,frontMatter:()=>i,metadata:()=>a,toc:()=>o});var t=s(24246),r=s(71670);const i={},c="Interface: Event()",a={id:"interfaces/Event",title:"Interface: Event()\\",description:"Event to subscribe",source:"@site/api/interfaces/Event.md",sourceDirName:"interfaces",slug:"/interfaces/Event",permalink:"/api/interfaces/Event",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: EndpointSettings",permalink:"/api/interfaces/EndpointSettings"},next:{title:"Interface: ExtensionContext",permalink:"/api/interfaces/ExtensionContext"}},l={},o=[{value:"Type parameters",id:"type-parameters",level:2},{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function d(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,r.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"interface-eventt",children:"Interface: Event()"}),"\n",(0,t.jsx)(n.p,{children:"Event to subscribe"}),"\n",(0,t.jsx)(n.h2,{id:"type-parameters",children:"Type parameters"}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"T"})]}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"Event"}),"(",(0,t.jsx)(n.code,{children:"listener"}),", ",(0,t.jsx)(n.code,{children:"thisArgs"}),"?, ",(0,t.jsx)(n.code,{children:"disposables"}),"?): ",(0,t.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,t.jsx)(n.code,{children:"Disposable"})})]}),"\n"]}),"\n",(0,t.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"listener"})]}),"\n",(0,t.jsx)(n.p,{children:"The listener function will be called when the event happens."}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"thisArgs?"}),": ",(0,t.jsx)(n.code,{children:"any"})]}),"\n",(0,t.jsxs)(n.p,{children:["The ",(0,t.jsx)(n.code,{children:"this"}),"-argument which will be used when calling the event listener."]}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"disposables?"}),": ",(0,t.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,t.jsx)(n.code,{children:"Disposable"})}),"[]"]}),"\n",(0,t.jsxs)(n.p,{children:["An array to which a ",(0,t.jsx)(n.a,{href:"/api/classes/Disposable",children:"Disposable"})," will be added."]}),"\n",(0,t.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,t.jsx)(n.code,{children:"Disposable"})})}),"\n",(0,t.jsx)(n.p,{children:"A disposable which unsubscribes the event listener."}),"\n",(0,t.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L106",children:"packages/extension-api/src/extension-api.d.ts:106"})})]})}function h(e={}){const{wrapper:n}={...(0,r.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(d,{...e})}):d(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>a,a:()=>c});var t=s(27378);const r={},i=t.createContext(r);function c(e){const n=t.useContext(i);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function a(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:c(e.components),t.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[9055],{87335:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>l,contentTitle:()=>c,default:()=>h,frontMatter:()=>i,metadata:()=>a,toc:()=>o});var t=s(24246),r=s(71670);const i={},c="Interface: Event()",a={id:"interfaces/Event",title:"Interface: Event()\\",description:"Event to subscribe",source:"@site/api/interfaces/Event.md",sourceDirName:"interfaces",slug:"/interfaces/Event",permalink:"/api/interfaces/Event",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: EndpointSettings",permalink:"/api/interfaces/EndpointSettings"},next:{title:"Interface: ExtensionContext",permalink:"/api/interfaces/ExtensionContext"}},l={},o=[{value:"Type parameters",id:"type-parameters",level:2},{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function d(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,r.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"interface-eventt",children:"Interface: Event()"}),"\n",(0,t.jsx)(n.p,{children:"Event to subscribe"}),"\n",(0,t.jsx)(n.h2,{id:"type-parameters",children:"Type parameters"}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"T"})]}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"Event"}),"(",(0,t.jsx)(n.code,{children:"listener"}),", ",(0,t.jsx)(n.code,{children:"thisArgs"}),"?, ",(0,t.jsx)(n.code,{children:"disposables"}),"?): ",(0,t.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,t.jsx)(n.code,{children:"Disposable"})})]}),"\n"]}),"\n",(0,t.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"listener"})]}),"\n",(0,t.jsx)(n.p,{children:"The listener function will be called when the event happens."}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"thisArgs?"}),": ",(0,t.jsx)(n.code,{children:"any"})]}),"\n",(0,t.jsxs)(n.p,{children:["The ",(0,t.jsx)(n.code,{children:"this"}),"-argument which will be used when calling the event listener."]}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"disposables?"}),": ",(0,t.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,t.jsx)(n.code,{children:"Disposable"})}),"[]"]}),"\n",(0,t.jsxs)(n.p,{children:["An array to which a ",(0,t.jsx)(n.a,{href:"/api/classes/Disposable",children:"Disposable"})," will be added."]}),"\n",(0,t.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,t.jsx)(n.code,{children:"Disposable"})})}),"\n",(0,t.jsx)(n.p,{children:"A disposable which unsubscribes the event listener."}),"\n",(0,t.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L106",children:"packages/extension-api/src/extension-api.d.ts:106"})})]})}function h(e={}){const{wrapper:n}={...(0,r.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(d,{...e})}):d(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>a,a:()=>c});var t=s(27378);const r={},i=t.createContext(r);function c(e){const n=t.useContext(i);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function a(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:c(e.components),t.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/e84cabb0.8495bcb0.js b/assets/js/e84cabb0.9acc24b5.js similarity index 95% rename from assets/js/e84cabb0.8495bcb0.js rename to assets/js/e84cabb0.9acc24b5.js index e0b9e33fef5..00a44cb7f5d 100644 --- a/assets/js/e84cabb0.8495bcb0.js +++ b/assets/js/e84cabb0.9acc24b5.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[81145],{59040:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>a,contentTitle:()=>c,default:()=>x,frontMatter:()=>o,metadata:()=>i,toc:()=>d});var t=s(24246),r=s(71670);const o={},c="Function: setProxy()",i={id:"namespaces/proxy/functions/setProxy",title:"Function: setProxy()",description:"setProxy(proxySettings): Promise\\",source:"@site/api/namespaces/proxy/functions/setProxy.md",sourceDirName:"namespaces/proxy/functions",slug:"/namespaces/proxy/functions/setProxy",permalink:"/api/namespaces/proxy/functions/setProxy",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Function: onDidUpdateProxy()",permalink:"/api/namespaces/proxy/functions/onDidUpdateProxy"},next:{title:"Namespace: registry",permalink:"/api/namespaces/registry/"}},a={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function p(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,r.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"function-setproxy",children:"Function: setProxy()"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"setProxy"}),"(",(0,t.jsx)(n.code,{children:"proxySettings"}),"): ",(0,t.jsx)(n.code,{children:"Promise"}),"< ",(0,t.jsx)(n.code,{children:"void"})," >"]}),"\n"]}),"\n",(0,t.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"proxySettings"}),": ",(0,t.jsx)(n.a,{href:"/api/interfaces/ProxySettings",children:(0,t.jsx)(n.code,{children:"ProxySettings"})})]}),"\n",(0,t.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"Promise"}),"< ",(0,t.jsx)(n.code,{children:"void"})," >"]}),"\n",(0,t.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L575",children:"packages/extension-api/src/extension-api.d.ts:575"})})]})}function x(e={}){const{wrapper:n}={...(0,r.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(p,{...e})}):p(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>i,a:()=>c});var t=s(27378);const r={},o=t.createContext(r);function c(e){const n=t.useContext(o);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function i(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:c(e.components),t.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[81145],{59040:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>a,contentTitle:()=>c,default:()=>x,frontMatter:()=>o,metadata:()=>i,toc:()=>d});var t=s(24246),r=s(71670);const o={},c="Function: setProxy()",i={id:"namespaces/proxy/functions/setProxy",title:"Function: setProxy()",description:"setProxy(proxySettings): Promise\\",source:"@site/api/namespaces/proxy/functions/setProxy.md",sourceDirName:"namespaces/proxy/functions",slug:"/namespaces/proxy/functions/setProxy",permalink:"/api/namespaces/proxy/functions/setProxy",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Function: onDidUpdateProxy()",permalink:"/api/namespaces/proxy/functions/onDidUpdateProxy"},next:{title:"Namespace: registry",permalink:"/api/namespaces/registry/"}},a={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function p(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,r.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"function-setproxy",children:"Function: setProxy()"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"setProxy"}),"(",(0,t.jsx)(n.code,{children:"proxySettings"}),"): ",(0,t.jsx)(n.code,{children:"Promise"}),"< ",(0,t.jsx)(n.code,{children:"void"})," >"]}),"\n"]}),"\n",(0,t.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"proxySettings"}),": ",(0,t.jsx)(n.a,{href:"/api/interfaces/ProxySettings",children:(0,t.jsx)(n.code,{children:"ProxySettings"})})]}),"\n",(0,t.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"Promise"}),"< ",(0,t.jsx)(n.code,{children:"void"})," >"]}),"\n",(0,t.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L575",children:"packages/extension-api/src/extension-api.d.ts:575"})})]})}function x(e={}){const{wrapper:n}={...(0,r.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(p,{...e})}):p(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>i,a:()=>c});var t=s(27378);const r={},o=t.createContext(r);function c(e){const n=t.useContext(o);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function i(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:c(e.components),t.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/e88443f3.27a3c2d1.js b/assets/js/e88443f3.27a3c2d1.js deleted file mode 100644 index 2b555b0dae3..00000000000 --- a/assets/js/e88443f3.27a3c2d1.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[97953],{70678:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>c,default:()=>l,frontMatter:()=>i,metadata:()=>r,toc:()=>d});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:"Function: stopContainer()",permalink:"/api/namespaces/containerEngine/functions/stopContainer"},next:{title:"Function: tagImage()",permalink:"/api/namespaces/containerEngine/functions/tagImage"}},a={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function p(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,o.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"function-stoppod",children:"Function: stopPod()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"stopPod"}),"(",(0,s.jsx)(n.code,{children:"engineId"}),", ",(0,s.jsx)(n.code,{children:"podId"}),"): ",(0,s.jsx)(n.code,{children:"Promise"}),"< ",(0,s.jsx)(n.code,{children:"void"})," >"]}),"\n"]}),"\n",(0,s.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"engineId"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"podId"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n",(0,s.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"Promise"}),"< ",(0,s.jsx)(n.code,{children:"void"})," >"]}),"\n",(0,s.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L3382",children:"packages/extension-api/src/extension-api.d.ts:3382"})})]})}function l(e={}){const{wrapper:n}={...(0,o.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(p,{...e})}):p(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>r,a:()=>c});var s=t(27378);const o={},i=s.createContext(o);function c(e){const n=s.useContext(i);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function r(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:c(e.components),s.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/e88443f3.5a00b1f0.js b/assets/js/e88443f3.5a00b1f0.js new file mode 100644 index 00000000000..f0fd3a140f2 --- /dev/null +++ b/assets/js/e88443f3.5a00b1f0.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[97953],{70678:(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:"Function: stopContainer()",permalink:"/api/namespaces/containerEngine/functions/stopContainer"},next:{title:"Function: tagImage()",permalink:"/api/namespaces/containerEngine/functions/tagImage"}},d={},a=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function p(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:"source",children:"Source"}),"\n",(0,s.jsx)(e.p,{children:(0,s.jsx)(e.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L3382",children:"packages/extension-api/src/extension-api.d.ts:3382"})})]})}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.d1657e7a.js b/assets/js/e983a6d7.83a88cd3.js similarity index 81% rename from assets/js/e983a6d7.d1657e7a.js rename to assets/js/e983a6d7.83a88cd3.js index e46e94161e1..ae700cbdbd3 100644 --- a/assets/js/e983a6d7.d1657e7a.js +++ b/assets/js/e983a6d7.83a88cd3.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[61281],{3532:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>o,contentTitle:()=>c,default:()=>d,frontMatter:()=>i,metadata:()=>r,toc:()=>l});var a=s(24246),t=s(71670);const i={},c="Variable: isMac",r={id:"namespaces/env/variables/isMac",title:"Variable: isMac",description:"const isMac: boolean",source:"@site/api/namespaces/env/variables/isMac.md",sourceDirName:"namespaces/env/variables",slug:"/namespaces/env/variables/isMac",permalink:"/api/namespaces/env/variables/isMac",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Variable: isLinux",permalink:"/api/namespaces/env/variables/isLinux"},next:{title:"Variable: isTelemetryEnabled",permalink:"/api/namespaces/env/variables/isTelemetryEnabled"}},o={},l=[{value:"Source",id:"source",level:2}];function p(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,t.a)(),...e.components};return(0,a.jsxs)(a.Fragment,{children:[(0,a.jsx)(n.h1,{id:"variable-ismac",children:"Variable: isMac"}),"\n",(0,a.jsxs)(n.blockquote,{children:["\n",(0,a.jsxs)(n.p,{children:[(0,a.jsx)(n.strong,{children:(0,a.jsx)(n.code,{children:"const"})})," ",(0,a.jsx)(n.strong,{children:"isMac"}),": ",(0,a.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,a.jsx)(n.p,{children:"Flag indicating whether we are running on macOS (Mac OS X) operating system."}),"\n",(0,a.jsx)(n.p,{children:"If the value of this flag is true, it means the current system is macOS.\nIf the value is false, it means the current system is not macOS."}),"\n",(0,a.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,a.jsx)(n.p,{children:(0,a.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L3667",children:"packages/extension-api/src/extension-api.d.ts:3667"})})]})}function d(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,a.jsx)(n,{...e,children:(0,a.jsx)(p,{...e})}):p(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>r,a:()=>c});var a=s(27378);const t={},i=a.createContext(t);function c(e){const n=a.useContext(i);return a.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function r(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:c(e.components),a.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[61281],{3532:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>o,contentTitle:()=>c,default:()=>p,frontMatter:()=>i,metadata:()=>r,toc:()=>l});var a=s(24246),t=s(71670);const i={},c="Variable: isMac",r={id:"namespaces/env/variables/isMac",title:"Variable: isMac",description:"const isMac: boolean",source:"@site/api/namespaces/env/variables/isMac.md",sourceDirName:"namespaces/env/variables",slug:"/namespaces/env/variables/isMac",permalink:"/api/namespaces/env/variables/isMac",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Variable: isLinux",permalink:"/api/namespaces/env/variables/isLinux"},next:{title:"Variable: isTelemetryEnabled",permalink:"/api/namespaces/env/variables/isTelemetryEnabled"}},o={},l=[{value:"Source",id:"source",level:2}];function d(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,t.a)(),...e.components};return(0,a.jsxs)(a.Fragment,{children:[(0,a.jsx)(n.h1,{id:"variable-ismac",children:"Variable: isMac"}),"\n",(0,a.jsxs)(n.blockquote,{children:["\n",(0,a.jsxs)(n.p,{children:[(0,a.jsx)(n.strong,{children:(0,a.jsx)(n.code,{children:"const"})})," ",(0,a.jsx)(n.strong,{children:"isMac"}),": ",(0,a.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,a.jsx)(n.p,{children:"Flag indicating whether we are running on macOS (Mac OS X) operating system."}),"\n",(0,a.jsx)(n.p,{children:"If the value of this flag is true, it means the current system is macOS.\nIf the value is false, it means the current system is not macOS."}),"\n",(0,a.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,a.jsx)(n.p,{children:(0,a.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L3667",children:"packages/extension-api/src/extension-api.d.ts:3667"})})]})}function p(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,a.jsx)(n,{...e,children:(0,a.jsx)(d,{...e})}):d(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>r,a:()=>c});var a=s(27378);const t={},i=a.createContext(t);function c(e){const n=a.useContext(i);return a.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function r(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:c(e.components),a.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/ea3ffc82.c20de2c2.js b/assets/js/ea3ffc82.50414916.js similarity index 91% rename from assets/js/ea3ffc82.c20de2c2.js rename to assets/js/ea3ffc82.50414916.js index 2f0f930b11a..0ff53d400a6 100644 --- a/assets/js/ea3ffc82.c20de2c2.js +++ b/assets/js/ea3ffc82.50414916.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[21181],{65268:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>a,contentTitle:()=>c,default:()=>h,frontMatter:()=>i,metadata:()=>o,toc:()=>d});var t=s(24246),r=s(71670);const i={},c="Interface: ExtensionContext",o={id:"interfaces/ExtensionContext",title:"Interface: ExtensionContext",description:"Properties",source:"@site/api/interfaces/ExtensionContext.md",sourceDirName:"interfaces",slug:"/interfaces/ExtensionContext",permalink:"/api/interfaces/ExtensionContext",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: Event()\\",permalink:"/api/interfaces/Event"},next:{title:"Interface: FileSystemWatcher",permalink:"/api/interfaces/FileSystemWatcher"}},a={},d=[{value:"Properties",id:"properties",level:2},{value:"extensionUri",id:"extensionuri",level:3},{value:"Source",id:"source",level:4},{value:"secrets",id:"secrets",level:3},{value:"Source",id:"source-1",level:4},{value:"storagePath",id:"storagepath",level:3},{value:"Source",id:"source-2",level:4},{value:"subscriptions",id:"subscriptions",level:3},{value:"Source",id:"source-3",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,r.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"interface-extensioncontext",children:"Interface: ExtensionContext"}),"\n",(0,t.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,t.jsx)(n.h3,{id:"extensionuri",children:"extensionUri"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:(0,t.jsx)(n.code,{children:"readonly"})})," ",(0,t.jsx)(n.strong,{children:"extensionUri"}),": ",(0,t.jsx)(n.a,{href:"/api/classes/Uri",children:(0,t.jsx)(n.code,{children:"Uri"})})]}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"The uri of the directory containing the extension."}),"\n",(0,t.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L146",children:"packages/extension-api/src/extension-api.d.ts:146"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"secrets",children:"secrets"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:(0,t.jsx)(n.code,{children:"readonly"})})," ",(0,t.jsx)(n.strong,{children:"secrets"}),": ",(0,t.jsx)(n.a,{href:"/api/interfaces/SecretStorage",children:(0,t.jsx)(n.code,{children:"SecretStorage"})})]}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"A storage utility for secrets. Secrets are persisted across reloads."}),"\n",(0,t.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L151",children:"packages/extension-api/src/extension-api.d.ts:151"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"storagepath",children:"storagePath"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:(0,t.jsx)(n.code,{children:"readonly"})})," ",(0,t.jsx)(n.strong,{children:"storagePath"}),": ",(0,t.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"An absolute file path in which the extension can store state.\nThe directory might not exist on disk and creation is\nup to the extension."}),"\n",(0,t.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L141",children:"packages/extension-api/src/extension-api.d.ts:141"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"subscriptions",children:"subscriptions"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:(0,t.jsx)(n.code,{children:"readonly"})})," ",(0,t.jsx)(n.strong,{children:"subscriptions"}),": ",(0,t.jsx)(n.code,{children:"object"}),"[]"]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L134",children:"packages/extension-api/src/extension-api.d.ts:134"})})]})}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,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([[21181],{65268:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>a,contentTitle:()=>c,default:()=>h,frontMatter:()=>i,metadata:()=>o,toc:()=>d});var t=s(24246),r=s(71670);const i={},c="Interface: ExtensionContext",o={id:"interfaces/ExtensionContext",title:"Interface: ExtensionContext",description:"Properties",source:"@site/api/interfaces/ExtensionContext.md",sourceDirName:"interfaces",slug:"/interfaces/ExtensionContext",permalink:"/api/interfaces/ExtensionContext",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: Event()\\",permalink:"/api/interfaces/Event"},next:{title:"Interface: FileSystemWatcher",permalink:"/api/interfaces/FileSystemWatcher"}},a={},d=[{value:"Properties",id:"properties",level:2},{value:"extensionUri",id:"extensionuri",level:3},{value:"Source",id:"source",level:4},{value:"secrets",id:"secrets",level:3},{value:"Source",id:"source-1",level:4},{value:"storagePath",id:"storagepath",level:3},{value:"Source",id:"source-2",level:4},{value:"subscriptions",id:"subscriptions",level:3},{value:"Source",id:"source-3",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,r.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"interface-extensioncontext",children:"Interface: ExtensionContext"}),"\n",(0,t.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,t.jsx)(n.h3,{id:"extensionuri",children:"extensionUri"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:(0,t.jsx)(n.code,{children:"readonly"})})," ",(0,t.jsx)(n.strong,{children:"extensionUri"}),": ",(0,t.jsx)(n.a,{href:"/api/classes/Uri",children:(0,t.jsx)(n.code,{children:"Uri"})})]}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"The uri of the directory containing the extension."}),"\n",(0,t.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L146",children:"packages/extension-api/src/extension-api.d.ts:146"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"secrets",children:"secrets"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:(0,t.jsx)(n.code,{children:"readonly"})})," ",(0,t.jsx)(n.strong,{children:"secrets"}),": ",(0,t.jsx)(n.a,{href:"/api/interfaces/SecretStorage",children:(0,t.jsx)(n.code,{children:"SecretStorage"})})]}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"A storage utility for secrets. Secrets are persisted across reloads."}),"\n",(0,t.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L151",children:"packages/extension-api/src/extension-api.d.ts:151"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"storagepath",children:"storagePath"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:(0,t.jsx)(n.code,{children:"readonly"})})," ",(0,t.jsx)(n.strong,{children:"storagePath"}),": ",(0,t.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"An absolute file path in which the extension can store state.\nThe directory might not exist on disk and creation is\nup to the extension."}),"\n",(0,t.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L141",children:"packages/extension-api/src/extension-api.d.ts:141"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"subscriptions",children:"subscriptions"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:(0,t.jsx)(n.code,{children:"readonly"})})," ",(0,t.jsx)(n.strong,{children:"subscriptions"}),": ",(0,t.jsx)(n.code,{children:"object"}),"[]"]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L134",children:"packages/extension-api/src/extension-api.d.ts:134"})})]})}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,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/ed2a4846.94dc99f5.js b/assets/js/ed2a4846.06d649a8.js similarity index 97% rename from assets/js/ed2a4846.94dc99f5.js rename to assets/js/ed2a4846.06d649a8.js index 19fb0059778..34104775614 100644 --- a/assets/js/ed2a4846.94dc99f5.js +++ b/assets/js/ed2a4846.06d649a8.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[40486],{1427:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>o,contentTitle:()=>i,default:()=>d,frontMatter:()=>c,metadata:()=>a,toc:()=>l});var r=n(24246),s=n(71670);const c={},i="Interface: GenerateKubeResult",a={id:"interfaces/GenerateKubeResult",title:"Interface: GenerateKubeResult",description:"The result containing a Kubernetes config files",source:"@site/api/interfaces/GenerateKubeResult.md",sourceDirName:"interfaces",slug:"/interfaces/GenerateKubeResult",permalink:"/api/interfaces/GenerateKubeResult",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: FileSystemWatcher",permalink:"/api/interfaces/FileSystemWatcher"},next:{title:"Interface: HealthCheckLog",permalink:"/api/interfaces/HealthCheckLog"}},o={},l=[{value:"Properties",id:"properties",level:2},{value:"yaml",id:"yaml",level:3},{value:"Source",id:"source",level:4}];function u(e){const t={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(t.h1,{id:"interface-generatekuberesult",children:"Interface: GenerateKubeResult"}),"\n",(0,r.jsx)(t.p,{children:"The result containing a Kubernetes config files"}),"\n",(0,r.jsx)(t.h2,{id:"properties",children:"Properties"}),"\n",(0,r.jsx)(t.h3,{id:"yaml",children:"yaml"}),"\n",(0,r.jsxs)(t.blockquote,{children:["\n",(0,r.jsxs)(t.p,{children:[(0,r.jsx)(t.strong,{children:"yaml"}),": ",(0,r.jsx)(t.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(t.h4,{id:"source",children:"Source"}),"\n",(0,r.jsx)(t.p,{children:(0,r.jsx)(t.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L1837",children:"packages/extension-api/src/extension-api.d.ts:1837"})})]})}function d(e={}){const{wrapper:t}={...(0,s.a)(),...e.components};return t?(0,r.jsx)(t,{...e,children:(0,r.jsx)(u,{...e})}):u(e)}},71670:(e,t,n)=>{n.d(t,{Z:()=>a,a:()=>i});var r=n(27378);const s={},c=r.createContext(s);function i(e){const t=r.useContext(c);return r.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function a(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:i(e.components),r.createElement(c.Provider,{value:t},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[40486],{1427:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>o,contentTitle:()=>i,default:()=>d,frontMatter:()=>c,metadata:()=>a,toc:()=>l});var r=n(24246),s=n(71670);const c={},i="Interface: GenerateKubeResult",a={id:"interfaces/GenerateKubeResult",title:"Interface: GenerateKubeResult",description:"The result containing a Kubernetes config files",source:"@site/api/interfaces/GenerateKubeResult.md",sourceDirName:"interfaces",slug:"/interfaces/GenerateKubeResult",permalink:"/api/interfaces/GenerateKubeResult",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: FileSystemWatcher",permalink:"/api/interfaces/FileSystemWatcher"},next:{title:"Interface: HealthCheckLog",permalink:"/api/interfaces/HealthCheckLog"}},o={},l=[{value:"Properties",id:"properties",level:2},{value:"yaml",id:"yaml",level:3},{value:"Source",id:"source",level:4}];function u(e){const t={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(t.h1,{id:"interface-generatekuberesult",children:"Interface: GenerateKubeResult"}),"\n",(0,r.jsx)(t.p,{children:"The result containing a Kubernetes config files"}),"\n",(0,r.jsx)(t.h2,{id:"properties",children:"Properties"}),"\n",(0,r.jsx)(t.h3,{id:"yaml",children:"yaml"}),"\n",(0,r.jsxs)(t.blockquote,{children:["\n",(0,r.jsxs)(t.p,{children:[(0,r.jsx)(t.strong,{children:"yaml"}),": ",(0,r.jsx)(t.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(t.h4,{id:"source",children:"Source"}),"\n",(0,r.jsx)(t.p,{children:(0,r.jsx)(t.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L1837",children:"packages/extension-api/src/extension-api.d.ts:1837"})})]})}function d(e={}){const{wrapper:t}={...(0,s.a)(),...e.components};return t?(0,r.jsx)(t,{...e,children:(0,r.jsx)(u,{...e})}):u(e)}},71670:(e,t,n)=>{n.d(t,{Z:()=>a,a:()=>i});var r=n(27378);const s={},c=r.createContext(s);function i(e){const t=r.useContext(c);return r.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function a(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:i(e.components),r.createElement(c.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/ed603d23.5da37b94.js b/assets/js/ed603d23.9b191ba4.js similarity index 93% rename from assets/js/ed603d23.5da37b94.js rename to assets/js/ed603d23.9b191ba4.js index 214b43356bc..b80e2d39456 100644 --- a/assets/js/ed603d23.5da37b94.js +++ b/assets/js/ed603d23.9b191ba4.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[73285],{65669:(e,r,n)=>{n.r(r),n.d(r,{assets:()=>a,contentTitle:()=>o,default:()=>u,frontMatter:()=>i,metadata:()=>c,toc:()=>d});var t=n(24246),s=n(71670);const i={},o="Interface: KubernetesGeneratorProvider",c={id:"interfaces/KubernetesGeneratorProvider",title:"Interface: KubernetesGeneratorProvider",description:"The KubernetesGeneratorProvider allows an extension to register a custom Kube Generator for a specific",source:"@site/api/interfaces/KubernetesGeneratorProvider.md",sourceDirName:"interfaces",slug:"/interfaces/KubernetesGeneratorProvider",permalink:"/api/interfaces/KubernetesGeneratorProvider",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: KubeconfigUpdateEvent",permalink:"/api/interfaces/KubeconfigUpdateEvent"},next:{title:"Interface: KubernetesProviderConnection",permalink:"/api/interfaces/KubernetesProviderConnection"}},a={},d=[{value:"Properties",id:"properties",level:2},{value:"name",id:"name",level:3},{value:"Source",id:"source",level:4},{value:"types",id:"types",level:3},{value:"Source",id:"source-1",level:4},{value:"Methods",id:"methods",level:2},{value:"generate()",id:"generate",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Source",id:"source-2",level:4}];function l(e){const r={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(r.h1,{id:"interface-kubernetesgeneratorprovider",children:"Interface: KubernetesGeneratorProvider"}),"\n",(0,t.jsx)(r.p,{children:"The KubernetesGeneratorProvider allows an extension to register a custom Kube Generator for a specific\nKubernetesGeneratorType."}),"\n",(0,t.jsx)(r.h2,{id:"properties",children:"Properties"}),"\n",(0,t.jsx)(r.h3,{id:"name",children:"name"}),"\n",(0,t.jsxs)(r.blockquote,{children:["\n",(0,t.jsxs)(r.p,{children:[(0,t.jsx)(r.strong,{children:"name"}),": ",(0,t.jsx)(r.code,{children:"string"})]}),"\n"]}),"\n",(0,t.jsx)(r.h4,{id:"source",children:"Source"}),"\n",(0,t.jsx)(r.p,{children:(0,t.jsx)(r.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L1852",children:"packages/extension-api/src/extension-api.d.ts:1852"})}),"\n",(0,t.jsx)(r.hr,{}),"\n",(0,t.jsx)(r.h3,{id:"types",children:"types"}),"\n",(0,t.jsxs)(r.blockquote,{children:["\n",(0,t.jsxs)(r.p,{children:[(0,t.jsx)(r.strong,{children:"types"}),": ",(0,t.jsx)(r.a,{href:"/api/type-aliases/KubernetesGeneratorSelector",children:(0,t.jsx)(r.code,{children:"KubernetesGeneratorSelector"})})]}),"\n"]}),"\n",(0,t.jsx)(r.h4,{id:"source-1",children:"Source"}),"\n",(0,t.jsx)(r.p,{children:(0,t.jsx)(r.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L1853",children:"packages/extension-api/src/extension-api.d.ts:1853"})}),"\n",(0,t.jsx)(r.h2,{id:"methods",children:"Methods"}),"\n",(0,t.jsx)(r.h3,{id:"generate",children:"generate()"}),"\n",(0,t.jsxs)(r.blockquote,{children:["\n",(0,t.jsxs)(r.p,{children:[(0,t.jsx)(r.strong,{children:"generate"}),"(",(0,t.jsx)(r.code,{children:"kubernetesGeneratorArguments"}),"): ",(0,t.jsx)(r.code,{children:"Promise"}),"< ",(0,t.jsx)(r.a,{href:"/api/interfaces/GenerateKubeResult",children:(0,t.jsx)(r.code,{children:"GenerateKubeResult"})})," >"]}),"\n"]}),"\n",(0,t.jsx)(r.h4,{id:"parameters",children:"Parameters"}),"\n",(0,t.jsxs)(r.p,{children:["\u2022 ",(0,t.jsx)(r.strong,{children:"kubernetesGeneratorArguments"}),": ",(0,t.jsx)(r.a,{href:"/api/type-aliases/KubernetesGeneratorArgument",children:(0,t.jsx)(r.code,{children:"KubernetesGeneratorArgument"})}),"[]"]}),"\n",(0,t.jsx)(r.h4,{id:"returns",children:"Returns"}),"\n",(0,t.jsxs)(r.p,{children:[(0,t.jsx)(r.code,{children:"Promise"}),"< ",(0,t.jsx)(r.a,{href:"/api/interfaces/GenerateKubeResult",children:(0,t.jsx)(r.code,{children:"GenerateKubeResult"})})," >"]}),"\n",(0,t.jsx)(r.h4,{id:"source-2",children:"Source"}),"\n",(0,t.jsx)(r.p,{children:(0,t.jsx)(r.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L1854",children:"packages/extension-api/src/extension-api.d.ts:1854"})})]})}function u(e={}){const{wrapper:r}={...(0,s.a)(),...e.components};return r?(0,t.jsx)(r,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},71670:(e,r,n)=>{n.d(r,{Z:()=>c,a:()=>o});var t=n(27378);const s={},i=t.createContext(s);function o(e){const r=t.useContext(i);return t.useMemo((function(){return"function"==typeof e?e(r):{...r,...e}}),[r,e])}function c(e){let r;return r=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:o(e.components),t.createElement(i.Provider,{value:r},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[73285],{65669:(e,r,n)=>{n.r(r),n.d(r,{assets:()=>a,contentTitle:()=>o,default:()=>u,frontMatter:()=>i,metadata:()=>c,toc:()=>d});var t=n(24246),s=n(71670);const i={},o="Interface: KubernetesGeneratorProvider",c={id:"interfaces/KubernetesGeneratorProvider",title:"Interface: KubernetesGeneratorProvider",description:"The KubernetesGeneratorProvider allows an extension to register a custom Kube Generator for a specific",source:"@site/api/interfaces/KubernetesGeneratorProvider.md",sourceDirName:"interfaces",slug:"/interfaces/KubernetesGeneratorProvider",permalink:"/api/interfaces/KubernetesGeneratorProvider",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: KubeconfigUpdateEvent",permalink:"/api/interfaces/KubeconfigUpdateEvent"},next:{title:"Interface: KubernetesProviderConnection",permalink:"/api/interfaces/KubernetesProviderConnection"}},a={},d=[{value:"Properties",id:"properties",level:2},{value:"name",id:"name",level:3},{value:"Source",id:"source",level:4},{value:"types",id:"types",level:3},{value:"Source",id:"source-1",level:4},{value:"Methods",id:"methods",level:2},{value:"generate()",id:"generate",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Source",id:"source-2",level:4}];function l(e){const r={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(r.h1,{id:"interface-kubernetesgeneratorprovider",children:"Interface: KubernetesGeneratorProvider"}),"\n",(0,t.jsx)(r.p,{children:"The KubernetesGeneratorProvider allows an extension to register a custom Kube Generator for a specific\nKubernetesGeneratorType."}),"\n",(0,t.jsx)(r.h2,{id:"properties",children:"Properties"}),"\n",(0,t.jsx)(r.h3,{id:"name",children:"name"}),"\n",(0,t.jsxs)(r.blockquote,{children:["\n",(0,t.jsxs)(r.p,{children:[(0,t.jsx)(r.strong,{children:"name"}),": ",(0,t.jsx)(r.code,{children:"string"})]}),"\n"]}),"\n",(0,t.jsx)(r.h4,{id:"source",children:"Source"}),"\n",(0,t.jsx)(r.p,{children:(0,t.jsx)(r.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L1852",children:"packages/extension-api/src/extension-api.d.ts:1852"})}),"\n",(0,t.jsx)(r.hr,{}),"\n",(0,t.jsx)(r.h3,{id:"types",children:"types"}),"\n",(0,t.jsxs)(r.blockquote,{children:["\n",(0,t.jsxs)(r.p,{children:[(0,t.jsx)(r.strong,{children:"types"}),": ",(0,t.jsx)(r.a,{href:"/api/type-aliases/KubernetesGeneratorSelector",children:(0,t.jsx)(r.code,{children:"KubernetesGeneratorSelector"})})]}),"\n"]}),"\n",(0,t.jsx)(r.h4,{id:"source-1",children:"Source"}),"\n",(0,t.jsx)(r.p,{children:(0,t.jsx)(r.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L1853",children:"packages/extension-api/src/extension-api.d.ts:1853"})}),"\n",(0,t.jsx)(r.h2,{id:"methods",children:"Methods"}),"\n",(0,t.jsx)(r.h3,{id:"generate",children:"generate()"}),"\n",(0,t.jsxs)(r.blockquote,{children:["\n",(0,t.jsxs)(r.p,{children:[(0,t.jsx)(r.strong,{children:"generate"}),"(",(0,t.jsx)(r.code,{children:"kubernetesGeneratorArguments"}),"): ",(0,t.jsx)(r.code,{children:"Promise"}),"< ",(0,t.jsx)(r.a,{href:"/api/interfaces/GenerateKubeResult",children:(0,t.jsx)(r.code,{children:"GenerateKubeResult"})})," >"]}),"\n"]}),"\n",(0,t.jsx)(r.h4,{id:"parameters",children:"Parameters"}),"\n",(0,t.jsxs)(r.p,{children:["\u2022 ",(0,t.jsx)(r.strong,{children:"kubernetesGeneratorArguments"}),": ",(0,t.jsx)(r.a,{href:"/api/type-aliases/KubernetesGeneratorArgument",children:(0,t.jsx)(r.code,{children:"KubernetesGeneratorArgument"})}),"[]"]}),"\n",(0,t.jsx)(r.h4,{id:"returns",children:"Returns"}),"\n",(0,t.jsxs)(r.p,{children:[(0,t.jsx)(r.code,{children:"Promise"}),"< ",(0,t.jsx)(r.a,{href:"/api/interfaces/GenerateKubeResult",children:(0,t.jsx)(r.code,{children:"GenerateKubeResult"})})," >"]}),"\n",(0,t.jsx)(r.h4,{id:"source-2",children:"Source"}),"\n",(0,t.jsx)(r.p,{children:(0,t.jsx)(r.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L1854",children:"packages/extension-api/src/extension-api.d.ts:1854"})})]})}function u(e={}){const{wrapper:r}={...(0,s.a)(),...e.components};return r?(0,t.jsx)(r,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},71670:(e,r,n)=>{n.d(r,{Z:()=>c,a:()=>o});var t=n(27378);const s={},i=t.createContext(s);function o(e){const r=t.useContext(i);return t.useMemo((function(){return"function"==typeof e?e(r):{...r,...e}}),[r,e])}function c(e){let r;return r=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:o(e.components),t.createElement(i.Provider,{value:r},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/edb40f78.f17db715.js b/assets/js/edb40f78.211eec30.js similarity index 95% rename from assets/js/edb40f78.f17db715.js rename to assets/js/edb40f78.211eec30.js index 99134a43079..4fbeddb9327 100644 --- a/assets/js/edb40f78.f17db715.js +++ b/assets/js/edb40f78.211eec30.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[54632],{7453:(e,r,s)=>{s.r(r),s.d(r,{assets:()=>c,contentTitle:()=>i,default:()=>l,frontMatter:()=>o,metadata:()=>a,toc:()=>d});var n=s(24246),t=s(71670);const o={},i="Interface: Progress",a={id:"interfaces/Progress",title:"Interface: Progress\\",description:"Defines a generalized way of reporting progress updates.",source:"@site/api/interfaces/Progress.md",sourceDirName:"interfaces",slug:"/interfaces/Progress",permalink:"/api/interfaces/Progress",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: PortMap",permalink:"/api/interfaces/PortMap"},next:{title:"Interface: ProgressOptions",permalink:"/api/interfaces/ProgressOptions"}},c={},d=[{value:"Type parameters",id:"type-parameters",level:2},{value:"Methods",id:"methods",level:2},{value:"report()",id:"report",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Source",id:"source",level:4}];function p(e){const r={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",p:"p",strong:"strong",...(0,t.a)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(r.h1,{id:"interface-progresst",children:"Interface: Progress"}),"\n",(0,n.jsx)(r.p,{children:"Defines a generalized way of reporting progress updates."}),"\n",(0,n.jsx)(r.h2,{id:"type-parameters",children:"Type parameters"}),"\n",(0,n.jsxs)(r.p,{children:["\u2022 ",(0,n.jsx)(r.strong,{children:"T"})]}),"\n",(0,n.jsx)(r.h2,{id:"methods",children:"Methods"}),"\n",(0,n.jsx)(r.h3,{id:"report",children:"report()"}),"\n",(0,n.jsxs)(r.blockquote,{children:["\n",(0,n.jsxs)(r.p,{children:[(0,n.jsx)(r.strong,{children:"report"}),"(",(0,n.jsx)(r.code,{children:"value"}),"): ",(0,n.jsx)(r.code,{children:"void"})]}),"\n"]}),"\n",(0,n.jsx)(r.p,{children:"Report a progress update."}),"\n",(0,n.jsx)(r.h4,{id:"parameters",children:"Parameters"}),"\n",(0,n.jsxs)(r.p,{children:["\u2022 ",(0,n.jsx)(r.strong,{children:"value"}),": ",(0,n.jsx)(r.code,{children:"T"})]}),"\n",(0,n.jsx)(r.p,{children:"A progress item, like a message and/or an\nreport on how much work finished"}),"\n",(0,n.jsx)(r.h4,{id:"returns",children:"Returns"}),"\n",(0,n.jsx)(r.p,{children:(0,n.jsx)(r.code,{children:"void"})}),"\n",(0,n.jsx)(r.h4,{id:"source",children:"Source"}),"\n",(0,n.jsx)(r.p,{children:(0,n.jsx)(r.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L727",children:"packages/extension-api/src/extension-api.d.ts:727"})})]})}function l(e={}){const{wrapper:r}={...(0,t.a)(),...e.components};return r?(0,n.jsx)(r,{...e,children:(0,n.jsx)(p,{...e})}):p(e)}},71670:(e,r,s)=>{s.d(r,{Z:()=>a,a:()=>i});var n=s(27378);const t={},o=n.createContext(t);function i(e){const r=n.useContext(o);return n.useMemo((function(){return"function"==typeof e?e(r):{...r,...e}}),[r,e])}function a(e){let r;return r=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:i(e.components),n.createElement(o.Provider,{value:r},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[54632],{7453:(e,r,s)=>{s.r(r),s.d(r,{assets:()=>c,contentTitle:()=>i,default:()=>l,frontMatter:()=>o,metadata:()=>a,toc:()=>d});var n=s(24246),t=s(71670);const o={},i="Interface: Progress",a={id:"interfaces/Progress",title:"Interface: Progress\\",description:"Defines a generalized way of reporting progress updates.",source:"@site/api/interfaces/Progress.md",sourceDirName:"interfaces",slug:"/interfaces/Progress",permalink:"/api/interfaces/Progress",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: PortMap",permalink:"/api/interfaces/PortMap"},next:{title:"Interface: ProgressOptions",permalink:"/api/interfaces/ProgressOptions"}},c={},d=[{value:"Type parameters",id:"type-parameters",level:2},{value:"Methods",id:"methods",level:2},{value:"report()",id:"report",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Source",id:"source",level:4}];function p(e){const r={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",p:"p",strong:"strong",...(0,t.a)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(r.h1,{id:"interface-progresst",children:"Interface: Progress"}),"\n",(0,n.jsx)(r.p,{children:"Defines a generalized way of reporting progress updates."}),"\n",(0,n.jsx)(r.h2,{id:"type-parameters",children:"Type parameters"}),"\n",(0,n.jsxs)(r.p,{children:["\u2022 ",(0,n.jsx)(r.strong,{children:"T"})]}),"\n",(0,n.jsx)(r.h2,{id:"methods",children:"Methods"}),"\n",(0,n.jsx)(r.h3,{id:"report",children:"report()"}),"\n",(0,n.jsxs)(r.blockquote,{children:["\n",(0,n.jsxs)(r.p,{children:[(0,n.jsx)(r.strong,{children:"report"}),"(",(0,n.jsx)(r.code,{children:"value"}),"): ",(0,n.jsx)(r.code,{children:"void"})]}),"\n"]}),"\n",(0,n.jsx)(r.p,{children:"Report a progress update."}),"\n",(0,n.jsx)(r.h4,{id:"parameters",children:"Parameters"}),"\n",(0,n.jsxs)(r.p,{children:["\u2022 ",(0,n.jsx)(r.strong,{children:"value"}),": ",(0,n.jsx)(r.code,{children:"T"})]}),"\n",(0,n.jsx)(r.p,{children:"A progress item, like a message and/or an\nreport on how much work finished"}),"\n",(0,n.jsx)(r.h4,{id:"returns",children:"Returns"}),"\n",(0,n.jsx)(r.p,{children:(0,n.jsx)(r.code,{children:"void"})}),"\n",(0,n.jsx)(r.h4,{id:"source",children:"Source"}),"\n",(0,n.jsx)(r.p,{children:(0,n.jsx)(r.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L727",children:"packages/extension-api/src/extension-api.d.ts:727"})})]})}function l(e={}){const{wrapper:r}={...(0,t.a)(),...e.components};return r?(0,n.jsx)(r,{...e,children:(0,n.jsx)(p,{...e})}):p(e)}},71670:(e,r,s)=>{s.d(r,{Z:()=>a,a:()=>i});var n=s(27378);const t={},o=n.createContext(t);function i(e){const r=n.useContext(o);return n.useMemo((function(){return"function"==typeof e?e(r):{...r,...e}}),[r,e])}function a(e){let r;return r=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:i(e.components),n.createElement(o.Provider,{value:r},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/f1ad83b2.2358ae4e.js b/assets/js/f1ad83b2.d50b3f1d.js similarity index 91% rename from assets/js/f1ad83b2.2358ae4e.js rename to assets/js/f1ad83b2.d50b3f1d.js index 26d5a18b963..18f66402ee0 100644 --- a/assets/js/f1ad83b2.2358ae4e.js +++ b/assets/js/f1ad83b2.d50b3f1d.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[22182],{19376:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>d,contentTitle:()=>o,default:()=>h,frontMatter:()=>s,metadata:()=>c,toc:()=>a});var i=r(24246),t=r(71670);const s={},o="Interface: KubernetesProviderConnection",c={id:"interfaces/KubernetesProviderConnection",title:"Interface: KubernetesProviderConnection",description:"Properties",source:"@site/api/interfaces/KubernetesProviderConnection.md",sourceDirName:"interfaces",slug:"/interfaces/KubernetesProviderConnection",permalink:"/api/interfaces/KubernetesProviderConnection",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: KubernetesGeneratorProvider",permalink:"/api/interfaces/KubernetesGeneratorProvider"},next:{title:"Interface: KubernetesProviderConnectionEndpoint",permalink:"/api/interfaces/KubernetesProviderConnectionEndpoint"}},d={},a=[{value:"Properties",id:"properties",level:2},{value:"endpoint",id:"endpoint",level:3},{value:"Source",id:"source",level:4},{value:"lifecycle?",id:"lifecycle",level:3},{value:"Source",id:"source-1",level:4},{value:"name",id:"name",level:3},{value:"Source",id:"source-2",level:4},{value:"Methods",id:"methods",level:2},{value:"status()",id:"status",level:3},{value:"Returns",id:"returns",level:4},{value:"Source",id:"source-3",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,t.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"interface-kubernetesproviderconnection",children:"Interface: KubernetesProviderConnection"}),"\n",(0,i.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(n.h3,{id:"endpoint",children:"endpoint"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"endpoint"}),": ",(0,i.jsx)(n.a,{href:"/api/interfaces/KubernetesProviderConnectionEndpoint",children:(0,i.jsx)(n.code,{children:"KubernetesProviderConnectionEndpoint"})})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L303",children:"packages/extension-api/src/extension-api.d.ts:303"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"lifecycle",children:"lifecycle?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"lifecycle"}),": ",(0,i.jsx)(n.a,{href:"/api/interfaces/ProviderConnectionLifecycle",children:(0,i.jsx)(n.code,{children:"ProviderConnectionLifecycle"})})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L304",children:"packages/extension-api/src/extension-api.d.ts:304"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"name",children:"name"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"name"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L302",children:"packages/extension-api/src/extension-api.d.ts:302"})}),"\n",(0,i.jsx)(n.h2,{id:"methods",children:"Methods"}),"\n",(0,i.jsx)(n.h3,{id:"status",children:"status()"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"status"}),"(): ",(0,i.jsx)(n.a,{href:"/api/type-aliases/ProviderConnectionStatus",children:(0,i.jsx)(n.code,{children:"ProviderConnectionStatus"})})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"returns",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"/api/type-aliases/ProviderConnectionStatus",children:(0,i.jsx)(n.code,{children:"ProviderConnectionStatus"})})}),"\n",(0,i.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L305",children:"packages/extension-api/src/extension-api.d.ts:305"})})]})}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,r)=>{r.d(n,{Z:()=>c,a:()=>o});var i=r(27378);const t={},s=i.createContext(t);function o(e){const n=i.useContext(s);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:o(e.components),i.createElement(s.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[22182],{19376:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>d,contentTitle:()=>o,default:()=>h,frontMatter:()=>s,metadata:()=>c,toc:()=>a});var i=r(24246),t=r(71670);const s={},o="Interface: KubernetesProviderConnection",c={id:"interfaces/KubernetesProviderConnection",title:"Interface: KubernetesProviderConnection",description:"Properties",source:"@site/api/interfaces/KubernetesProviderConnection.md",sourceDirName:"interfaces",slug:"/interfaces/KubernetesProviderConnection",permalink:"/api/interfaces/KubernetesProviderConnection",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: KubernetesGeneratorProvider",permalink:"/api/interfaces/KubernetesGeneratorProvider"},next:{title:"Interface: KubernetesProviderConnectionEndpoint",permalink:"/api/interfaces/KubernetesProviderConnectionEndpoint"}},d={},a=[{value:"Properties",id:"properties",level:2},{value:"endpoint",id:"endpoint",level:3},{value:"Source",id:"source",level:4},{value:"lifecycle?",id:"lifecycle",level:3},{value:"Source",id:"source-1",level:4},{value:"name",id:"name",level:3},{value:"Source",id:"source-2",level:4},{value:"Methods",id:"methods",level:2},{value:"status()",id:"status",level:3},{value:"Returns",id:"returns",level:4},{value:"Source",id:"source-3",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,t.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"interface-kubernetesproviderconnection",children:"Interface: KubernetesProviderConnection"}),"\n",(0,i.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(n.h3,{id:"endpoint",children:"endpoint"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"endpoint"}),": ",(0,i.jsx)(n.a,{href:"/api/interfaces/KubernetesProviderConnectionEndpoint",children:(0,i.jsx)(n.code,{children:"KubernetesProviderConnectionEndpoint"})})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L303",children:"packages/extension-api/src/extension-api.d.ts:303"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"lifecycle",children:"lifecycle?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"lifecycle"}),": ",(0,i.jsx)(n.a,{href:"/api/interfaces/ProviderConnectionLifecycle",children:(0,i.jsx)(n.code,{children:"ProviderConnectionLifecycle"})})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L304",children:"packages/extension-api/src/extension-api.d.ts:304"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"name",children:"name"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"name"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L302",children:"packages/extension-api/src/extension-api.d.ts:302"})}),"\n",(0,i.jsx)(n.h2,{id:"methods",children:"Methods"}),"\n",(0,i.jsx)(n.h3,{id:"status",children:"status()"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"status"}),"(): ",(0,i.jsx)(n.a,{href:"/api/type-aliases/ProviderConnectionStatus",children:(0,i.jsx)(n.code,{children:"ProviderConnectionStatus"})})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"returns",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"/api/type-aliases/ProviderConnectionStatus",children:(0,i.jsx)(n.code,{children:"ProviderConnectionStatus"})})}),"\n",(0,i.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L305",children:"packages/extension-api/src/extension-api.d.ts:305"})})]})}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,r)=>{r.d(n,{Z:()=>c,a:()=>o});var i=r(27378);const t={},s=i.createContext(t);function o(e){const n=i.useContext(s);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:o(e.components),i.createElement(s.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/f20efc55.22bbdcbd.js b/assets/js/f20efc55.71218c42.js similarity index 94% rename from assets/js/f20efc55.22bbdcbd.js rename to assets/js/f20efc55.71218c42.js index 6279b25e275..53b90fbe9e1 100644 --- a/assets/js/f20efc55.22bbdcbd.js +++ b/assets/js/f20efc55.71218c42.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[64438],{18646:(t,e,r)=>{r.r(e),r.d(e,{assets:()=>c,contentTitle:()=>s,default:()=>d,frontMatter:()=>n,metadata:()=>o,toc:()=>l});var a=r(24246),i=r(71670);const n={},s="Variable: StatusBarItemDefaultPriority",o={id:"variables/StatusBarItemDefaultPriority",title:"Variable: StatusBarItemDefaultPriority",description:"const StatusBarItemDefaultPriority: 0 = 0",source:"@site/api/variables/StatusBarItemDefaultPriority.md",sourceDirName:"variables",slug:"/variables/StatusBarItemDefaultPriority",permalink:"/api/variables/StatusBarItemDefaultPriority",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Variable: StatusBarAlignRight",permalink:"/api/variables/StatusBarAlignRight"},next:{title:"Variable: version",permalink:"/api/variables/version"}},c={},l=[{value:"Source",id:"source",level:2}];function u(t){const e={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,i.a)(),...t.components};return(0,a.jsxs)(a.Fragment,{children:[(0,a.jsx)(e.h1,{id:"variable-statusbaritemdefaultpriority",children:"Variable: StatusBarItemDefaultPriority"}),"\n",(0,a.jsxs)(e.blockquote,{children:["\n",(0,a.jsxs)(e.p,{children:[(0,a.jsx)(e.strong,{children:(0,a.jsx)(e.code,{children:"const"})})," ",(0,a.jsx)(e.strong,{children:"StatusBarItemDefaultPriority"}),": ",(0,a.jsx)(e.code,{children:"0"})," = ",(0,a.jsx)(e.code,{children:"0"})]}),"\n"]}),"\n",(0,a.jsx)(e.p,{children:"Default priority for the status bar items."}),"\n",(0,a.jsx)(e.h2,{id:"source",children:"Source"}),"\n",(0,a.jsx)(e.p,{children:(0,a.jsx)(e.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L1195",children:"packages/extension-api/src/extension-api.d.ts:1195"})})]})}function d(t={}){const{wrapper:e}={...(0,i.a)(),...t.components};return e?(0,a.jsx)(e,{...t,children:(0,a.jsx)(u,{...t})}):u(t)}},71670:(t,e,r)=>{r.d(e,{Z:()=>o,a:()=>s});var a=r(27378);const i={},n=a.createContext(i);function s(t){const e=a.useContext(n);return a.useMemo((function(){return"function"==typeof t?t(e):{...e,...t}}),[e,t])}function o(t){let e;return e=t.disableParentContext?"function"==typeof t.components?t.components(i):t.components||i:s(t.components),a.createElement(n.Provider,{value:e},t.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[64438],{18646:(t,e,r)=>{r.r(e),r.d(e,{assets:()=>c,contentTitle:()=>s,default:()=>d,frontMatter:()=>n,metadata:()=>o,toc:()=>l});var a=r(24246),i=r(71670);const n={},s="Variable: StatusBarItemDefaultPriority",o={id:"variables/StatusBarItemDefaultPriority",title:"Variable: StatusBarItemDefaultPriority",description:"const StatusBarItemDefaultPriority: 0 = 0",source:"@site/api/variables/StatusBarItemDefaultPriority.md",sourceDirName:"variables",slug:"/variables/StatusBarItemDefaultPriority",permalink:"/api/variables/StatusBarItemDefaultPriority",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Variable: StatusBarAlignRight",permalink:"/api/variables/StatusBarAlignRight"},next:{title:"Variable: version",permalink:"/api/variables/version"}},c={},l=[{value:"Source",id:"source",level:2}];function u(t){const e={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,i.a)(),...t.components};return(0,a.jsxs)(a.Fragment,{children:[(0,a.jsx)(e.h1,{id:"variable-statusbaritemdefaultpriority",children:"Variable: StatusBarItemDefaultPriority"}),"\n",(0,a.jsxs)(e.blockquote,{children:["\n",(0,a.jsxs)(e.p,{children:[(0,a.jsx)(e.strong,{children:(0,a.jsx)(e.code,{children:"const"})})," ",(0,a.jsx)(e.strong,{children:"StatusBarItemDefaultPriority"}),": ",(0,a.jsx)(e.code,{children:"0"})," = ",(0,a.jsx)(e.code,{children:"0"})]}),"\n"]}),"\n",(0,a.jsx)(e.p,{children:"Default priority for the status bar items."}),"\n",(0,a.jsx)(e.h2,{id:"source",children:"Source"}),"\n",(0,a.jsx)(e.p,{children:(0,a.jsx)(e.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L1195",children:"packages/extension-api/src/extension-api.d.ts:1195"})})]})}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.c736f69d.js b/assets/js/f27eaf88.c736f69d.js deleted file mode 100644 index 40ceea3361e..00000000000 --- a/assets/js/f27eaf88.c736f69d.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[75741],{44677:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>r,contentTitle:()=>i,default:()=>h,frontMatter:()=>o,metadata:()=>a,toc:()=>l});var c=t(24246),s=t(71670);const o={},i="Interface: CancellationToken",a={id:"interfaces/CancellationToken",title:"Interface: CancellationToken",description:"A cancellation token is passed to an asynchronous or long running",source:"@site/api/interfaces/CancellationToken.md",sourceDirName:"interfaces",slug:"/interfaces/CancellationToken",permalink:"/api/interfaces/CancellationToken",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: CPUUsage",permalink:"/api/interfaces/CPUUsage"},next:{title:"Interface: CheckResult",permalink:"/api/interfaces/CheckResult"}},r={},l=[{value:"Properties",id:"properties",level:2},{value:"isCancellationRequested",id:"iscancellationrequested",level:3},{value:"Source",id:"source",level:4},{value:"onCancellationRequested",id:"oncancellationrequested",level:3},{value:"Source",id:"source-1",level:4}];function d(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,c.jsxs)(c.Fragment,{children:[(0,c.jsx)(n.h1,{id:"interface-cancellationtoken",children:"Interface: CancellationToken"}),"\n",(0,c.jsx)(n.p,{children:"A cancellation token is passed to an asynchronous or long running\noperation to request cancellation."}),"\n",(0,c.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,c.jsx)(n.h3,{id:"iscancellationrequested",children:"isCancellationRequested"}),"\n",(0,c.jsxs)(n.blockquote,{children:["\n",(0,c.jsxs)(n.p,{children:[(0,c.jsx)(n.strong,{children:"isCancellationRequested"}),": ",(0,c.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,c.jsxs)(n.p,{children:["Is ",(0,c.jsx)(n.code,{children:"true"})," when the token has been cancelled, ",(0,c.jsx)(n.code,{children:"false"})," otherwise."]}),"\n",(0,c.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,c.jsx)(n.p,{children:(0,c.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L782",children:"packages/extension-api/src/extension-api.d.ts:782"})}),"\n",(0,c.jsx)(n.hr,{}),"\n",(0,c.jsx)(n.h3,{id:"oncancellationrequested",children:"onCancellationRequested"}),"\n",(0,c.jsxs)(n.blockquote,{children:["\n",(0,c.jsxs)(n.p,{children:[(0,c.jsx)(n.strong,{children:"onCancellationRequested"}),": ",(0,c.jsx)(n.a,{href:"/api/interfaces/Event",children:(0,c.jsx)(n.code,{children:"Event"})}),"< ",(0,c.jsx)(n.code,{children:"any"})," >"]}),"\n"]}),"\n",(0,c.jsxs)(n.p,{children:["An ",(0,c.jsx)(n.a,{href:"/api/interfaces/Event",children:"Event"})," which fires upon cancellation."]}),"\n",(0,c.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,c.jsx)(n.p,{children:(0,c.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L788",children:"packages/extension-api/src/extension-api.d.ts:788"})})]})}function h(e={}){const{wrapper:n}={...(0,s.a)(),...e.components};return n?(0,c.jsx)(n,{...e,children:(0,c.jsx)(d,{...e})}):d(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>a,a:()=>i});var c=t(27378);const s={},o=c.createContext(s);function i(e){const n=c.useContext(o);return c.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function a(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:i(e.components),c.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/f27eaf88.dc3e64e4.js b/assets/js/f27eaf88.dc3e64e4.js new file mode 100644 index 00000000000..815a40d60ff --- /dev/null +++ b/assets/js/f27eaf88.dc3e64e4.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[75741],{44677:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>r,contentTitle:()=>i,default:()=>h,frontMatter:()=>o,metadata:()=>a,toc:()=>l});var s=t(24246),c=t(71670);const o={},i="Interface: CancellationToken",a={id:"interfaces/CancellationToken",title:"Interface: CancellationToken",description:"A cancellation token is passed to an asynchronous or long running",source:"@site/api/interfaces/CancellationToken.md",sourceDirName:"interfaces",slug:"/interfaces/CancellationToken",permalink:"/api/interfaces/CancellationToken",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: CPUUsage",permalink:"/api/interfaces/CPUUsage"},next:{title:"Interface: CheckResult",permalink:"/api/interfaces/CheckResult"}},r={},l=[{value:"Properties",id:"properties",level:2},{value:"isCancellationRequested",id:"iscancellationrequested",level:3},{value:"Source",id:"source",level:4},{value:"onCancellationRequested",id:"oncancellationrequested",level:3},{value:"Source",id:"source-1",level:4}];function d(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,c.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"interface-cancellationtoken",children:"Interface: CancellationToken"}),"\n",(0,s.jsx)(n.p,{children:"A cancellation token is passed to an asynchronous or long running\noperation to request cancellation."}),"\n",(0,s.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,s.jsx)(n.h3,{id:"iscancellationrequested",children:"isCancellationRequested"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"isCancellationRequested"}),": ",(0,s.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:["Is ",(0,s.jsx)(n.code,{children:"true"})," when the token has been cancelled, ",(0,s.jsx)(n.code,{children:"false"})," otherwise."]}),"\n",(0,s.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L782",children:"packages/extension-api/src/extension-api.d.ts:782"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"oncancellationrequested",children:"onCancellationRequested"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"onCancellationRequested"}),": ",(0,s.jsx)(n.a,{href:"/api/interfaces/Event",children:(0,s.jsx)(n.code,{children:"Event"})}),"< ",(0,s.jsx)(n.code,{children:"any"})," >"]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:["An ",(0,s.jsx)(n.a,{href:"/api/interfaces/Event",children:"Event"})," which fires upon cancellation."]}),"\n",(0,s.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L788",children:"packages/extension-api/src/extension-api.d.ts:788"})})]})}function h(e={}){const{wrapper:n}={...(0,c.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(d,{...e})}):d(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>a,a:()=>i});var s=t(27378);const c={},o=s.createContext(c);function i(e){const n=s.useContext(o);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function a(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(c):e.components||c:i(e.components),s.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/f4271232.819ea1d3.js b/assets/js/f4271232.65f13e39.js similarity index 95% rename from assets/js/f4271232.819ea1d3.js rename to assets/js/f4271232.65f13e39.js index 5ee4ceaecf8..3cac02ccf88 100644 --- a/assets/js/f4271232.819ea1d3.js +++ b/assets/js/f4271232.65f13e39.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[85799],{64336:(n,e,t)=>{t.r(e),t.d(e,{assets:()=>c,contentTitle:()=>s,default:()=>l,frontMatter:()=>a,metadata:()=>r,toc:()=>d});var o=t(24246),i=t(71670);const a={},s="Function: navigateToContainerLogs()",r={id:"namespaces/navigation/functions/navigateToContainerLogs",title:"Function: navigateToContainerLogs()",description:"navigateToContainerLogs(id): Promise\\",source:"@site/api/namespaces/navigation/functions/navigateToContainerLogs.md",sourceDirName:"namespaces/navigation/functions",slug:"/namespaces/navigation/functions/navigateToContainerLogs",permalink:"/api/namespaces/navigation/functions/navigateToContainerLogs",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Function: navigateToContainerInspect()",permalink:"/api/namespaces/navigation/functions/navigateToContainerInspect"},next:{title:"Function: navigateToContainerTerminal()",permalink:"/api/namespaces/navigation/functions/navigateToContainerTerminal"}},c={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function 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-navigatetocontainerlogs",children:"Function: navigateToContainerLogs()"}),"\n",(0,o.jsxs)(e.blockquote,{children:["\n",(0,o.jsxs)(e.p,{children:[(0,o.jsx)(e.strong,{children:"navigateToContainerLogs"}),"(",(0,o.jsx)(e.code,{children:"id"}),"): ",(0,o.jsx)(e.code,{children:"Promise"}),"< ",(0,o.jsx)(e.code,{children:"void"})," >"]}),"\n"]}),"\n",(0,o.jsx)(e.h2,{id:"parameters",children:"Parameters"}),"\n",(0,o.jsxs)(e.p,{children:["\u2022 ",(0,o.jsx)(e.strong,{children:"id"}),": ",(0,o.jsx)(e.code,{children:"string"})]}),"\n",(0,o.jsx)(e.h2,{id:"returns",children:"Returns"}),"\n",(0,o.jsxs)(e.p,{children:[(0,o.jsx)(e.code,{children:"Promise"}),"< ",(0,o.jsx)(e.code,{children:"void"})," >"]}),"\n",(0,o.jsx)(e.h2,{id:"source",children:"Source"}),"\n",(0,o.jsx)(e.p,{children:(0,o.jsx)(e.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L4146",children:"packages/extension-api/src/extension-api.d.ts:4146"})})]})}function l(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:()=>r,a:()=>s});var o=t(27378);const i={},a=o.createContext(i);function s(n){const e=o.useContext(a);return o.useMemo((function(){return"function"==typeof n?n(e):{...e,...n}}),[e,n])}function r(n){let e;return e=n.disableParentContext?"function"==typeof n.components?n.components(i):n.components||i:s(n.components),o.createElement(a.Provider,{value:e},n.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[85799],{64336:(n,e,t)=>{t.r(e),t.d(e,{assets:()=>c,contentTitle:()=>s,default:()=>l,frontMatter:()=>a,metadata:()=>r,toc:()=>d});var o=t(24246),i=t(71670);const a={},s="Function: navigateToContainerLogs()",r={id:"namespaces/navigation/functions/navigateToContainerLogs",title:"Function: navigateToContainerLogs()",description:"navigateToContainerLogs(id): Promise\\",source:"@site/api/namespaces/navigation/functions/navigateToContainerLogs.md",sourceDirName:"namespaces/navigation/functions",slug:"/namespaces/navigation/functions/navigateToContainerLogs",permalink:"/api/namespaces/navigation/functions/navigateToContainerLogs",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Function: navigateToContainerInspect()",permalink:"/api/namespaces/navigation/functions/navigateToContainerInspect"},next:{title:"Function: navigateToContainerTerminal()",permalink:"/api/namespaces/navigation/functions/navigateToContainerTerminal"}},c={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function 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-navigatetocontainerlogs",children:"Function: navigateToContainerLogs()"}),"\n",(0,o.jsxs)(e.blockquote,{children:["\n",(0,o.jsxs)(e.p,{children:[(0,o.jsx)(e.strong,{children:"navigateToContainerLogs"}),"(",(0,o.jsx)(e.code,{children:"id"}),"): ",(0,o.jsx)(e.code,{children:"Promise"}),"< ",(0,o.jsx)(e.code,{children:"void"})," >"]}),"\n"]}),"\n",(0,o.jsx)(e.h2,{id:"parameters",children:"Parameters"}),"\n",(0,o.jsxs)(e.p,{children:["\u2022 ",(0,o.jsx)(e.strong,{children:"id"}),": ",(0,o.jsx)(e.code,{children:"string"})]}),"\n",(0,o.jsx)(e.h2,{id:"returns",children:"Returns"}),"\n",(0,o.jsxs)(e.p,{children:[(0,o.jsx)(e.code,{children:"Promise"}),"< ",(0,o.jsx)(e.code,{children:"void"})," >"]}),"\n",(0,o.jsx)(e.h2,{id:"source",children:"Source"}),"\n",(0,o.jsx)(e.p,{children:(0,o.jsx)(e.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L4146",children:"packages/extension-api/src/extension-api.d.ts:4146"})})]})}function l(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:()=>r,a:()=>s});var o=t(27378);const i={},a=o.createContext(i);function s(n){const e=o.useContext(a);return o.useMemo((function(){return"function"==typeof n?n(e):{...e,...n}}),[e,n])}function r(n){let e;return e=n.disableParentContext?"function"==typeof n.components?n.components(i):n.components||i:s(n.components),o.createElement(a.Provider,{value:e},n.children)}}}]); \ No newline at end of file diff --git a/assets/js/f6cd0d3d.44684c87.js b/assets/js/f6cd0d3d.e9026238.js similarity index 94% rename from assets/js/f6cd0d3d.44684c87.js rename to assets/js/f6cd0d3d.e9026238.js index 2aea6ed5911..cc25ed7e8d3 100644 --- a/assets/js/f6cd0d3d.44684c87.js +++ b/assets/js/f6cd0d3d.e9026238.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[75208],{7072:(e,r,t)=>{t.r(r),t.d(r,{assets:()=>a,contentTitle:()=>c,default:()=>h,frontMatter:()=>i,metadata:()=>o,toc:()=>d});var n=t(24246),s=t(71670);const i={},c="Interface: RegistryProvider",o={id:"interfaces/RegistryProvider",title:"Interface: RegistryProvider",description:"Properties",source:"@site/api/interfaces/RegistryProvider.md",sourceDirName:"interfaces",slug:"/interfaces/RegistryProvider",permalink:"/api/interfaces/RegistryProvider",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: RegistryCreateOptions",permalink:"/api/interfaces/RegistryCreateOptions"},next:{title:"Interface: RegistrySuggestedProvider",permalink:"/api/interfaces/RegistrySuggestedProvider"}},a={},d=[{value:"Properties",id:"properties",level:2},{value:"name",id:"name",level:3},{value:"Source",id:"source",level:4},{value:"Methods",id:"methods",level:2},{value:"create()",id:"create",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Source",id:"source-1",level:4}];function l(e){const r={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(r.h1,{id:"interface-registryprovider",children:"Interface: RegistryProvider"}),"\n",(0,n.jsx)(r.h2,{id:"properties",children:"Properties"}),"\n",(0,n.jsx)(r.h3,{id:"name",children:"name"}),"\n",(0,n.jsxs)(r.blockquote,{children:["\n",(0,n.jsxs)(r.p,{children:[(0,n.jsx)(r.strong,{children:(0,n.jsx)(r.code,{children:"readonly"})})," ",(0,n.jsx)(r.strong,{children:"name"}),": ",(0,n.jsx)(r.code,{children:"string"})]}),"\n"]}),"\n",(0,n.jsx)(r.h4,{id:"source",children:"Source"}),"\n",(0,n.jsx)(r.p,{children:(0,n.jsx)(r.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L611",children:"packages/extension-api/src/extension-api.d.ts:611"})}),"\n",(0,n.jsx)(r.h2,{id:"methods",children:"Methods"}),"\n",(0,n.jsx)(r.h3,{id:"create",children:"create()"}),"\n",(0,n.jsxs)(r.blockquote,{children:["\n",(0,n.jsxs)(r.p,{children:[(0,n.jsx)(r.strong,{children:"create"}),"(",(0,n.jsx)(r.code,{children:"registryCreateOptions"}),"): ",(0,n.jsx)(r.a,{href:"/api/interfaces/Registry",children:(0,n.jsx)(r.code,{children:"Registry"})})]}),"\n"]}),"\n",(0,n.jsx)(r.h4,{id:"parameters",children:"Parameters"}),"\n",(0,n.jsxs)(r.p,{children:["\u2022 ",(0,n.jsx)(r.strong,{children:"registryCreateOptions"}),": ",(0,n.jsx)(r.a,{href:"/api/interfaces/RegistryCreateOptions",children:(0,n.jsx)(r.code,{children:"RegistryCreateOptions"})})]}),"\n",(0,n.jsx)(r.h4,{id:"returns",children:"Returns"}),"\n",(0,n.jsx)(r.p,{children:(0,n.jsx)(r.a,{href:"/api/interfaces/Registry",children:(0,n.jsx)(r.code,{children:"Registry"})})}),"\n",(0,n.jsx)(r.h4,{id:"source-1",children:"Source"}),"\n",(0,n.jsx)(r.p,{children:(0,n.jsx)(r.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L612",children:"packages/extension-api/src/extension-api.d.ts:612"})})]})}function h(e={}){const{wrapper:r}={...(0,s.a)(),...e.components};return r?(0,n.jsx)(r,{...e,children:(0,n.jsx)(l,{...e})}):l(e)}},71670:(e,r,t)=>{t.d(r,{Z:()=>o,a:()=>c});var n=t(27378);const s={},i=n.createContext(s);function c(e){const r=n.useContext(i);return n.useMemo((function(){return"function"==typeof e?e(r):{...r,...e}}),[r,e])}function o(e){let r;return r=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:c(e.components),n.createElement(i.Provider,{value:r},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[75208],{7072:(e,r,t)=>{t.r(r),t.d(r,{assets:()=>a,contentTitle:()=>c,default:()=>h,frontMatter:()=>i,metadata:()=>o,toc:()=>d});var n=t(24246),s=t(71670);const i={},c="Interface: RegistryProvider",o={id:"interfaces/RegistryProvider",title:"Interface: RegistryProvider",description:"Properties",source:"@site/api/interfaces/RegistryProvider.md",sourceDirName:"interfaces",slug:"/interfaces/RegistryProvider",permalink:"/api/interfaces/RegistryProvider",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: RegistryCreateOptions",permalink:"/api/interfaces/RegistryCreateOptions"},next:{title:"Interface: RegistrySuggestedProvider",permalink:"/api/interfaces/RegistrySuggestedProvider"}},a={},d=[{value:"Properties",id:"properties",level:2},{value:"name",id:"name",level:3},{value:"Source",id:"source",level:4},{value:"Methods",id:"methods",level:2},{value:"create()",id:"create",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Source",id:"source-1",level:4}];function l(e){const r={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(r.h1,{id:"interface-registryprovider",children:"Interface: RegistryProvider"}),"\n",(0,n.jsx)(r.h2,{id:"properties",children:"Properties"}),"\n",(0,n.jsx)(r.h3,{id:"name",children:"name"}),"\n",(0,n.jsxs)(r.blockquote,{children:["\n",(0,n.jsxs)(r.p,{children:[(0,n.jsx)(r.strong,{children:(0,n.jsx)(r.code,{children:"readonly"})})," ",(0,n.jsx)(r.strong,{children:"name"}),": ",(0,n.jsx)(r.code,{children:"string"})]}),"\n"]}),"\n",(0,n.jsx)(r.h4,{id:"source",children:"Source"}),"\n",(0,n.jsx)(r.p,{children:(0,n.jsx)(r.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L611",children:"packages/extension-api/src/extension-api.d.ts:611"})}),"\n",(0,n.jsx)(r.h2,{id:"methods",children:"Methods"}),"\n",(0,n.jsx)(r.h3,{id:"create",children:"create()"}),"\n",(0,n.jsxs)(r.blockquote,{children:["\n",(0,n.jsxs)(r.p,{children:[(0,n.jsx)(r.strong,{children:"create"}),"(",(0,n.jsx)(r.code,{children:"registryCreateOptions"}),"): ",(0,n.jsx)(r.a,{href:"/api/interfaces/Registry",children:(0,n.jsx)(r.code,{children:"Registry"})})]}),"\n"]}),"\n",(0,n.jsx)(r.h4,{id:"parameters",children:"Parameters"}),"\n",(0,n.jsxs)(r.p,{children:["\u2022 ",(0,n.jsx)(r.strong,{children:"registryCreateOptions"}),": ",(0,n.jsx)(r.a,{href:"/api/interfaces/RegistryCreateOptions",children:(0,n.jsx)(r.code,{children:"RegistryCreateOptions"})})]}),"\n",(0,n.jsx)(r.h4,{id:"returns",children:"Returns"}),"\n",(0,n.jsx)(r.p,{children:(0,n.jsx)(r.a,{href:"/api/interfaces/Registry",children:(0,n.jsx)(r.code,{children:"Registry"})})}),"\n",(0,n.jsx)(r.h4,{id:"source-1",children:"Source"}),"\n",(0,n.jsx)(r.p,{children:(0,n.jsx)(r.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L612",children:"packages/extension-api/src/extension-api.d.ts:612"})})]})}function h(e={}){const{wrapper:r}={...(0,s.a)(),...e.components};return r?(0,n.jsx)(r,{...e,children:(0,n.jsx)(l,{...e})}):l(e)}},71670:(e,r,t)=>{t.d(r,{Z:()=>o,a:()=>c});var n=t(27378);const s={},i=n.createContext(s);function c(e){const r=n.useContext(i);return n.useMemo((function(){return"function"==typeof e?e(r):{...r,...e}}),[r,e])}function o(e){let r;return r=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:c(e.components),n.createElement(i.Provider,{value:r},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/f6cf66bc.c8ab5809.js b/assets/js/f6cf66bc.9cd66d41.js similarity index 86% rename from assets/js/f6cf66bc.c8ab5809.js rename to assets/js/f6cf66bc.9cd66d41.js index 46245b68748..cd59308589b 100644 --- a/assets/js/f6cf66bc.c8ab5809.js +++ b/assets/js/f6cf66bc.9cd66d41.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[65619],{74577:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>a,contentTitle:()=>r,default:()=>p,frontMatter:()=>c,metadata:()=>o,toc:()=>d});var i=s(24246),t=s(71670);const c={},r="Function: onDidUpdateKubeconfig()",o={id:"namespaces/kubernetes/functions/onDidUpdateKubeconfig",title:"Function: onDidUpdateKubeconfig()",description:"onDidUpdateKubeconfig(listener, thisArgs?, disposables?): Disposable",source:"@site/api/namespaces/kubernetes/functions/onDidUpdateKubeconfig.md",sourceDirName:"namespaces/kubernetes/functions",slug:"/namespaces/kubernetes/functions/onDidUpdateKubeconfig",permalink:"/api/namespaces/kubernetes/functions/onDidUpdateKubeconfig",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Function: getKubeconfig()",permalink:"/api/namespaces/kubernetes/functions/getKubeconfig"},next:{title:"Function: registerKubernetesGenerator()",permalink:"/api/namespaces/kubernetes/functions/registerKubernetesGenerator"}},a={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,t.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"function-ondidupdatekubeconfig",children:"Function: onDidUpdateKubeconfig()"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"onDidUpdateKubeconfig"}),"(",(0,i.jsx)(n.code,{children:"listener"}),", ",(0,i.jsx)(n.code,{children:"thisArgs"}),"?, ",(0,i.jsx)(n.code,{children:"disposables"}),"?): ",(0,i.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(n.code,{children:"Disposable"})})]}),"\n"]}),"\n",(0,i.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"listener"})]}),"\n",(0,i.jsx)(n.p,{children:"The listener function will be called when the event happens."}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"thisArgs?"}),": ",(0,i.jsx)(n.code,{children:"any"})]}),"\n",(0,i.jsxs)(n.p,{children:["The ",(0,i.jsx)(n.code,{children:"this"}),"-argument which will be used when calling the event listener."]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"disposables?"}),": ",(0,i.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(n.code,{children:"Disposable"})}),"[]"]}),"\n",(0,i.jsxs)(n.p,{children:["An array to which a ",(0,i.jsx)(n.a,{href:"/api/classes/Disposable",children:"Disposable"})," will be added."]}),"\n",(0,i.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(n.code,{children:"Disposable"})})}),"\n",(0,i.jsx)(n.p,{children:"A disposable which unsubscribes the event listener."}),"\n",(0,i.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L1803",children:"packages/extension-api/src/extension-api.d.ts:1803"})})]})}function p(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>o,a:()=>r});var i=s(27378);const t={},c=i.createContext(t);function r(e){const n=i.useContext(c);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:r(e.components),i.createElement(c.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[65619],{74577:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>a,contentTitle:()=>c,default:()=>p,frontMatter:()=>r,metadata:()=>o,toc:()=>d});var i=s(24246),t=s(71670);const r={},c="Function: onDidUpdateKubeconfig()",o={id:"namespaces/kubernetes/functions/onDidUpdateKubeconfig",title:"Function: onDidUpdateKubeconfig()",description:"onDidUpdateKubeconfig(listener, thisArgs?, disposables?): Disposable",source:"@site/api/namespaces/kubernetes/functions/onDidUpdateKubeconfig.md",sourceDirName:"namespaces/kubernetes/functions",slug:"/namespaces/kubernetes/functions/onDidUpdateKubeconfig",permalink:"/api/namespaces/kubernetes/functions/onDidUpdateKubeconfig",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Function: getKubeconfig()",permalink:"/api/namespaces/kubernetes/functions/getKubeconfig"},next:{title:"Function: registerKubernetesGenerator()",permalink:"/api/namespaces/kubernetes/functions/registerKubernetesGenerator"}},a={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,t.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"function-ondidupdatekubeconfig",children:"Function: onDidUpdateKubeconfig()"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"onDidUpdateKubeconfig"}),"(",(0,i.jsx)(n.code,{children:"listener"}),", ",(0,i.jsx)(n.code,{children:"thisArgs"}),"?, ",(0,i.jsx)(n.code,{children:"disposables"}),"?): ",(0,i.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(n.code,{children:"Disposable"})})]}),"\n"]}),"\n",(0,i.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"listener"})]}),"\n",(0,i.jsx)(n.p,{children:"The listener function will be called when the event happens."}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"thisArgs?"}),": ",(0,i.jsx)(n.code,{children:"any"})]}),"\n",(0,i.jsxs)(n.p,{children:["The ",(0,i.jsx)(n.code,{children:"this"}),"-argument which will be used when calling the event listener."]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"disposables?"}),": ",(0,i.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(n.code,{children:"Disposable"})}),"[]"]}),"\n",(0,i.jsxs)(n.p,{children:["An array to which a ",(0,i.jsx)(n.a,{href:"/api/classes/Disposable",children:"Disposable"})," will be added."]}),"\n",(0,i.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(n.code,{children:"Disposable"})})}),"\n",(0,i.jsx)(n.p,{children:"A disposable which unsubscribes the event listener."}),"\n",(0,i.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L1803",children:"packages/extension-api/src/extension-api.d.ts:1803"})})]})}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.651fdac2.js b/assets/js/f7197f43.fca65cde.js similarity index 95% rename from assets/js/f7197f43.651fdac2.js rename to assets/js/f7197f43.fca65cde.js index dec3937c804..bf52d295486 100644 --- a/assets/js/f7197f43.651fdac2.js +++ b/assets/js/f7197f43.fca65cde.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[56805],{59308:(e,s,r)=>{r.r(s),r.d(s,{assets:()=>c,contentTitle:()=>a,default:()=>u,frontMatter:()=>l,metadata:()=>i,toc:()=>d});var t=r(24246),n=r(71670);const l={},a="Class: TelemetryTrustedValue",i={id:"classes/TelemetryTrustedValue",title:"Class: TelemetryTrustedValue\\",description:"A special value wrapper denoting a value that is safe to not clean.",source:"@site/api/classes/TelemetryTrustedValue.md",sourceDirName:"classes",slug:"/classes/TelemetryTrustedValue",permalink:"/api/classes/TelemetryTrustedValue",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Class: EventEmitter\\",permalink:"/api/classes/EventEmitter"},next:{title:"Class: Uri",permalink:"/api/classes/Uri"}},c={},d=[{value:"Type parameters",id:"type-parameters",level:2},{value:"Constructors",id:"constructors",level:2},{value:"new TelemetryTrustedValue(value)",id:"new-telemetrytrustedvaluevalue",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Source",id:"source",level:4},{value:"Properties",id:"properties",level:2},{value:"value",id:"value",level:3},{value:"Source",id:"source-1",level:4}];function o(e){const s={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",p:"p",strong:"strong",...(0,n.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(s.h1,{id:"class-telemetrytrustedvaluet",children:"Class: TelemetryTrustedValue"}),"\n",(0,t.jsx)(s.p,{children:"A special value wrapper denoting a value that is safe to not clean.\nThis is to be used when you can guarantee no identifiable information is contained in the value and the cleaning is improperly redacting it."}),"\n",(0,t.jsx)(s.h2,{id:"type-parameters",children:"Type parameters"}),"\n",(0,t.jsxs)(s.p,{children:["\u2022 ",(0,t.jsx)(s.strong,{children:"T"})," = ",(0,t.jsx)(s.code,{children:"any"})]}),"\n",(0,t.jsx)(s.h2,{id:"constructors",children:"Constructors"}),"\n",(0,t.jsx)(s.h3,{id:"new-telemetrytrustedvaluevalue",children:"new TelemetryTrustedValue(value)"}),"\n",(0,t.jsxs)(s.blockquote,{children:["\n",(0,t.jsxs)(s.p,{children:[(0,t.jsx)(s.strong,{children:"new TelemetryTrustedValue"}),"<",(0,t.jsx)(s.code,{children:"T"}),">(",(0,t.jsx)(s.code,{children:"value"}),"): ",(0,t.jsx)(s.a,{href:"/api/classes/TelemetryTrustedValue",children:(0,t.jsx)(s.code,{children:"TelemetryTrustedValue"})}),"< ",(0,t.jsx)(s.code,{children:"T"})," >"]}),"\n"]}),"\n",(0,t.jsx)(s.h4,{id:"parameters",children:"Parameters"}),"\n",(0,t.jsxs)(s.p,{children:["\u2022 ",(0,t.jsx)(s.strong,{children:"value"}),": ",(0,t.jsx)(s.code,{children:"T"})]}),"\n",(0,t.jsx)(s.h4,{id:"returns",children:"Returns"}),"\n",(0,t.jsxs)(s.p,{children:[(0,t.jsx)(s.a,{href:"/api/classes/TelemetryTrustedValue",children:(0,t.jsx)(s.code,{children:"TelemetryTrustedValue"})}),"< ",(0,t.jsx)(s.code,{children:"T"})," >"]}),"\n",(0,t.jsx)(s.h4,{id:"source",children:"Source"}),"\n",(0,t.jsx)(s.p,{children:(0,t.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L3839",children:"packages/extension-api/src/extension-api.d.ts:3839"})}),"\n",(0,t.jsx)(s.h2,{id:"properties",children:"Properties"}),"\n",(0,t.jsx)(s.h3,{id:"value",children:"value"}),"\n",(0,t.jsxs)(s.blockquote,{children:["\n",(0,t.jsxs)(s.p,{children:[(0,t.jsx)(s.strong,{children:(0,t.jsx)(s.code,{children:"readonly"})})," ",(0,t.jsx)(s.strong,{children:"value"}),": ",(0,t.jsx)(s.code,{children:"T"})]}),"\n"]}),"\n",(0,t.jsx)(s.h4,{id:"source-1",children:"Source"}),"\n",(0,t.jsx)(s.p,{children:(0,t.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L3837",children:"packages/extension-api/src/extension-api.d.ts:3837"})})]})}function u(e={}){const{wrapper:s}={...(0,n.a)(),...e.components};return s?(0,t.jsx)(s,{...e,children:(0,t.jsx)(o,{...e})}):o(e)}},71670:(e,s,r)=>{r.d(s,{Z:()=>i,a:()=>a});var t=r(27378);const n={},l=t.createContext(n);function a(e){const s=t.useContext(l);return t.useMemo((function(){return"function"==typeof e?e(s):{...s,...e}}),[s,e])}function i(e){let s;return s=e.disableParentContext?"function"==typeof e.components?e.components(n):e.components||n:a(e.components),t.createElement(l.Provider,{value:s},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[56805],{59308:(e,s,r)=>{r.r(s),r.d(s,{assets:()=>c,contentTitle:()=>a,default:()=>u,frontMatter:()=>l,metadata:()=>i,toc:()=>d});var t=r(24246),n=r(71670);const l={},a="Class: TelemetryTrustedValue",i={id:"classes/TelemetryTrustedValue",title:"Class: TelemetryTrustedValue\\",description:"A special value wrapper denoting a value that is safe to not clean.",source:"@site/api/classes/TelemetryTrustedValue.md",sourceDirName:"classes",slug:"/classes/TelemetryTrustedValue",permalink:"/api/classes/TelemetryTrustedValue",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Class: EventEmitter\\",permalink:"/api/classes/EventEmitter"},next:{title:"Class: Uri",permalink:"/api/classes/Uri"}},c={},d=[{value:"Type parameters",id:"type-parameters",level:2},{value:"Constructors",id:"constructors",level:2},{value:"new TelemetryTrustedValue(value)",id:"new-telemetrytrustedvaluevalue",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Source",id:"source",level:4},{value:"Properties",id:"properties",level:2},{value:"value",id:"value",level:3},{value:"Source",id:"source-1",level:4}];function o(e){const s={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",p:"p",strong:"strong",...(0,n.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(s.h1,{id:"class-telemetrytrustedvaluet",children:"Class: TelemetryTrustedValue"}),"\n",(0,t.jsx)(s.p,{children:"A special value wrapper denoting a value that is safe to not clean.\nThis is to be used when you can guarantee no identifiable information is contained in the value and the cleaning is improperly redacting it."}),"\n",(0,t.jsx)(s.h2,{id:"type-parameters",children:"Type parameters"}),"\n",(0,t.jsxs)(s.p,{children:["\u2022 ",(0,t.jsx)(s.strong,{children:"T"})," = ",(0,t.jsx)(s.code,{children:"any"})]}),"\n",(0,t.jsx)(s.h2,{id:"constructors",children:"Constructors"}),"\n",(0,t.jsx)(s.h3,{id:"new-telemetrytrustedvaluevalue",children:"new TelemetryTrustedValue(value)"}),"\n",(0,t.jsxs)(s.blockquote,{children:["\n",(0,t.jsxs)(s.p,{children:[(0,t.jsx)(s.strong,{children:"new TelemetryTrustedValue"}),"<",(0,t.jsx)(s.code,{children:"T"}),">(",(0,t.jsx)(s.code,{children:"value"}),"): ",(0,t.jsx)(s.a,{href:"/api/classes/TelemetryTrustedValue",children:(0,t.jsx)(s.code,{children:"TelemetryTrustedValue"})}),"< ",(0,t.jsx)(s.code,{children:"T"})," >"]}),"\n"]}),"\n",(0,t.jsx)(s.h4,{id:"parameters",children:"Parameters"}),"\n",(0,t.jsxs)(s.p,{children:["\u2022 ",(0,t.jsx)(s.strong,{children:"value"}),": ",(0,t.jsx)(s.code,{children:"T"})]}),"\n",(0,t.jsx)(s.h4,{id:"returns",children:"Returns"}),"\n",(0,t.jsxs)(s.p,{children:[(0,t.jsx)(s.a,{href:"/api/classes/TelemetryTrustedValue",children:(0,t.jsx)(s.code,{children:"TelemetryTrustedValue"})}),"< ",(0,t.jsx)(s.code,{children:"T"})," >"]}),"\n",(0,t.jsx)(s.h4,{id:"source",children:"Source"}),"\n",(0,t.jsx)(s.p,{children:(0,t.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L3839",children:"packages/extension-api/src/extension-api.d.ts:3839"})}),"\n",(0,t.jsx)(s.h2,{id:"properties",children:"Properties"}),"\n",(0,t.jsx)(s.h3,{id:"value",children:"value"}),"\n",(0,t.jsxs)(s.blockquote,{children:["\n",(0,t.jsxs)(s.p,{children:[(0,t.jsx)(s.strong,{children:(0,t.jsx)(s.code,{children:"readonly"})})," ",(0,t.jsx)(s.strong,{children:"value"}),": ",(0,t.jsx)(s.code,{children:"T"})]}),"\n"]}),"\n",(0,t.jsx)(s.h4,{id:"source-1",children:"Source"}),"\n",(0,t.jsx)(s.p,{children:(0,t.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L3837",children:"packages/extension-api/src/extension-api.d.ts:3837"})})]})}function u(e={}){const{wrapper:s}={...(0,n.a)(),...e.components};return s?(0,t.jsx)(s,{...e,children:(0,t.jsx)(o,{...e})}):o(e)}},71670:(e,s,r)=>{r.d(s,{Z:()=>i,a:()=>a});var t=r(27378);const n={},l=t.createContext(n);function a(e){const s=t.useContext(l);return t.useMemo((function(){return"function"==typeof e?e(s):{...s,...e}}),[s,e])}function i(e){let s;return s=e.disableParentContext?"function"==typeof e.components?e.components(n):e.components||n:a(e.components),t.createElement(l.Provider,{value:s},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/f771dec1.fe89e267.js b/assets/js/f771dec1.e744a9ff.js similarity index 84% rename from assets/js/f771dec1.fe89e267.js rename to assets/js/f771dec1.e744a9ff.js index 4d9065570d6..e7731734bac 100644 --- a/assets/js/f771dec1.fe89e267.js +++ b/assets/js/f771dec1.e744a9ff.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[63863],{29150:(e,n,o)=>{o.r(n),o.d(n,{assets:()=>l,contentTitle:()=>c,default:()=>d,frontMatter:()=>i,metadata:()=>r,toc:()=>a});var s=o(24246),t=o(71670);const i={},c="Function: createCliTool()",r={id:"namespaces/cli/functions/createCliTool",title:"Function: createCliTool()",description:"createCliTool(options): CliTool",source:"@site/api/namespaces/cli/functions/createCliTool.md",sourceDirName:"namespaces/cli/functions",slug:"/namespaces/cli/functions/createCliTool",permalink:"/api/namespaces/cli/functions/createCliTool",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Namespace: cli",permalink:"/api/namespaces/cli/"},next:{title:"Namespace: commands",permalink:"/api/namespaces/commands/"}},l={},a=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function p(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,t.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"function-createclitool",children:"Function: createCliTool()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"createCliTool"}),"(",(0,s.jsx)(n.code,{children:"options"}),"): ",(0,s.jsx)(n.a,{href:"/api/interfaces/CliTool",children:(0,s.jsx)(n.code,{children:"CliTool"})})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Register new CLI Tool"}),"\n",(0,s.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"options"}),": ",(0,s.jsx)(n.a,{href:"/api/interfaces/CliToolOptions",children:(0,s.jsx)(n.code,{children:"CliToolOptions"})})]}),"\n",(0,s.jsx)(n.p,{children:"CliToolsOptions instance to configure new instance of CliTool"}),"\n",(0,s.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"/api/interfaces/CliTool",children:(0,s.jsx)(n.code,{children:"CliTool"})})}),"\n",(0,s.jsx)(n.p,{children:"CliTool instance"}),"\n",(0,s.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L4064",children:"packages/extension-api/src/extension-api.d.ts:4064"})})]})}function d(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(p,{...e})}):p(e)}},71670:(e,n,o)=>{o.d(n,{Z:()=>r,a:()=>c});var s=o(27378);const t={},i=s.createContext(t);function c(e){const n=s.useContext(i);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function r(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:c(e.components),s.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[63863],{29150:(e,n,o)=>{o.r(n),o.d(n,{assets:()=>l,contentTitle:()=>c,default:()=>p,frontMatter:()=>i,metadata:()=>r,toc:()=>a});var s=o(24246),t=o(71670);const i={},c="Function: createCliTool()",r={id:"namespaces/cli/functions/createCliTool",title:"Function: createCliTool()",description:"createCliTool(options): CliTool",source:"@site/api/namespaces/cli/functions/createCliTool.md",sourceDirName:"namespaces/cli/functions",slug:"/namespaces/cli/functions/createCliTool",permalink:"/api/namespaces/cli/functions/createCliTool",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Namespace: cli",permalink:"/api/namespaces/cli/"},next:{title:"Namespace: commands",permalink:"/api/namespaces/commands/"}},l={},a=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function d(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,t.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"function-createclitool",children:"Function: createCliTool()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"createCliTool"}),"(",(0,s.jsx)(n.code,{children:"options"}),"): ",(0,s.jsx)(n.a,{href:"/api/interfaces/CliTool",children:(0,s.jsx)(n.code,{children:"CliTool"})})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Register new CLI Tool"}),"\n",(0,s.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"options"}),": ",(0,s.jsx)(n.a,{href:"/api/interfaces/CliToolOptions",children:(0,s.jsx)(n.code,{children:"CliToolOptions"})})]}),"\n",(0,s.jsx)(n.p,{children:"CliToolsOptions instance to configure new instance of CliTool"}),"\n",(0,s.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"/api/interfaces/CliTool",children:(0,s.jsx)(n.code,{children:"CliTool"})})}),"\n",(0,s.jsx)(n.p,{children:"CliTool instance"}),"\n",(0,s.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L4064",children:"packages/extension-api/src/extension-api.d.ts:4064"})})]})}function p(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(d,{...e})}):d(e)}},71670:(e,n,o)=>{o.d(n,{Z:()=>r,a:()=>c});var s=o(27378);const t={},i=s.createContext(t);function c(e){const n=s.useContext(i);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function r(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:c(e.components),s.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/f7c9e078.6ca3691b.js b/assets/js/f7c9e078.f0651411.js similarity index 87% rename from assets/js/f7c9e078.6ca3691b.js rename to assets/js/f7c9e078.f0651411.js index c654dadeb99..f73ad558b2b 100644 --- a/assets/js/f7c9e078.6ca3691b.js +++ b/assets/js/f7c9e078.f0651411.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[21364],{9196:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>a,contentTitle:()=>o,default:()=>h,frontMatter:()=>s,metadata:()=>c,toc:()=>d});var r=n(24246),i=n(71670);const s={},o="Interface: ThrottlingData",c={id:"interfaces/ThrottlingData",title:"Interface: ThrottlingData",description:"Properties",source:"@site/api/interfaces/ThrottlingData.md",sourceDirName:"interfaces",slug:"/interfaces/ThrottlingData",permalink:"/api/interfaces/ThrottlingData",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: TelemetrySender",permalink:"/api/interfaces/TelemetrySender"},next:{title:"Interface: UnregisterContainerConnectionEvent",permalink:"/api/interfaces/UnregisterContainerConnectionEvent"}},a={},d=[{value:"Properties",id:"properties",level:2},{value:"periods",id:"periods",level:3},{value:"Source",id:"source",level:4},{value:"throttled_periods",id:"throttled_periods",level:3},{value:"Source",id:"source-1",level:4},{value:"throttled_time",id:"throttled_time",level:3},{value:"Source",id:"source-2",level:4}];function l(e){const t={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,i.a)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(t.h1,{id:"interface-throttlingdata",children:"Interface: ThrottlingData"}),"\n",(0,r.jsx)(t.h2,{id:"properties",children:"Properties"}),"\n",(0,r.jsx)(t.h3,{id:"periods",children:"periods"}),"\n",(0,r.jsxs)(t.blockquote,{children:["\n",(0,r.jsxs)(t.p,{children:[(0,r.jsx)(t.strong,{children:"periods"}),": ",(0,r.jsx)(t.code,{children:"number"})]}),"\n"]}),"\n",(0,r.jsx)(t.h4,{id:"source",children:"Source"}),"\n",(0,r.jsx)(t.p,{children:(0,r.jsx)(t.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2855",children:"packages/extension-api/src/extension-api.d.ts:2855"})}),"\n",(0,r.jsx)(t.hr,{}),"\n",(0,r.jsx)(t.h3,{id:"throttled_periods",children:"throttled_periods"}),"\n",(0,r.jsxs)(t.blockquote,{children:["\n",(0,r.jsxs)(t.p,{children:[(0,r.jsx)(t.strong,{children:"throttled_periods"}),": ",(0,r.jsx)(t.code,{children:"number"})]}),"\n"]}),"\n",(0,r.jsx)(t.h4,{id:"source-1",children:"Source"}),"\n",(0,r.jsx)(t.p,{children:(0,r.jsx)(t.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2856",children:"packages/extension-api/src/extension-api.d.ts:2856"})}),"\n",(0,r.jsx)(t.hr,{}),"\n",(0,r.jsx)(t.h3,{id:"throttled_time",children:"throttled_time"}),"\n",(0,r.jsxs)(t.blockquote,{children:["\n",(0,r.jsxs)(t.p,{children:[(0,r.jsx)(t.strong,{children:"throttled_time"}),": ",(0,r.jsx)(t.code,{children:"number"})]}),"\n"]}),"\n",(0,r.jsx)(t.h4,{id:"source-2",children:"Source"}),"\n",(0,r.jsx)(t.p,{children:(0,r.jsx)(t.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2857",children:"packages/extension-api/src/extension-api.d.ts:2857"})})]})}function h(e={}){const{wrapper:t}={...(0,i.a)(),...e.components};return t?(0,r.jsx)(t,{...e,children:(0,r.jsx)(l,{...e})}):l(e)}},71670:(e,t,n)=>{n.d(t,{Z:()=>c,a:()=>o});var r=n(27378);const i={},s=r.createContext(i);function o(e){const t=r.useContext(s);return r.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function c(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:o(e.components),r.createElement(s.Provider,{value:t},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[21364],{9196:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>d,contentTitle:()=>o,default:()=>h,frontMatter:()=>s,metadata:()=>c,toc:()=>a});var r=n(24246),i=n(71670);const s={},o="Interface: ThrottlingData",c={id:"interfaces/ThrottlingData",title:"Interface: ThrottlingData",description:"Properties",source:"@site/api/interfaces/ThrottlingData.md",sourceDirName:"interfaces",slug:"/interfaces/ThrottlingData",permalink:"/api/interfaces/ThrottlingData",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: TelemetrySender",permalink:"/api/interfaces/TelemetrySender"},next:{title:"Interface: UnregisterContainerConnectionEvent",permalink:"/api/interfaces/UnregisterContainerConnectionEvent"}},d={},a=[{value:"Properties",id:"properties",level:2},{value:"periods",id:"periods",level:3},{value:"Source",id:"source",level:4},{value:"throttled_periods",id:"throttled_periods",level:3},{value:"Source",id:"source-1",level:4},{value:"throttled_time",id:"throttled_time",level:3},{value:"Source",id:"source-2",level:4}];function l(e){const t={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,i.a)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(t.h1,{id:"interface-throttlingdata",children:"Interface: ThrottlingData"}),"\n",(0,r.jsx)(t.h2,{id:"properties",children:"Properties"}),"\n",(0,r.jsx)(t.h3,{id:"periods",children:"periods"}),"\n",(0,r.jsxs)(t.blockquote,{children:["\n",(0,r.jsxs)(t.p,{children:[(0,r.jsx)(t.strong,{children:"periods"}),": ",(0,r.jsx)(t.code,{children:"number"})]}),"\n"]}),"\n",(0,r.jsx)(t.h4,{id:"source",children:"Source"}),"\n",(0,r.jsx)(t.p,{children:(0,r.jsx)(t.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2855",children:"packages/extension-api/src/extension-api.d.ts:2855"})}),"\n",(0,r.jsx)(t.hr,{}),"\n",(0,r.jsx)(t.h3,{id:"throttled_periods",children:"throttled_periods"}),"\n",(0,r.jsxs)(t.blockquote,{children:["\n",(0,r.jsxs)(t.p,{children:[(0,r.jsx)(t.strong,{children:"throttled_periods"}),": ",(0,r.jsx)(t.code,{children:"number"})]}),"\n"]}),"\n",(0,r.jsx)(t.h4,{id:"source-1",children:"Source"}),"\n",(0,r.jsx)(t.p,{children:(0,r.jsx)(t.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2856",children:"packages/extension-api/src/extension-api.d.ts:2856"})}),"\n",(0,r.jsx)(t.hr,{}),"\n",(0,r.jsx)(t.h3,{id:"throttled_time",children:"throttled_time"}),"\n",(0,r.jsxs)(t.blockquote,{children:["\n",(0,r.jsxs)(t.p,{children:[(0,r.jsx)(t.strong,{children:"throttled_time"}),": ",(0,r.jsx)(t.code,{children:"number"})]}),"\n"]}),"\n",(0,r.jsx)(t.h4,{id:"source-2",children:"Source"}),"\n",(0,r.jsx)(t.p,{children:(0,r.jsx)(t.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2857",children:"packages/extension-api/src/extension-api.d.ts:2857"})})]})}function h(e={}){const{wrapper:t}={...(0,i.a)(),...e.components};return t?(0,r.jsx)(t,{...e,children:(0,r.jsx)(l,{...e})}):l(e)}},71670:(e,t,n)=>{n.d(t,{Z:()=>c,a:()=>o});var r=n(27378);const i={},s=r.createContext(i);function o(e){const t=r.useContext(s);return r.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function c(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:o(e.components),r.createElement(s.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/f86eb50f.8afe0a58.js b/assets/js/f86eb50f.1d740de9.js similarity index 94% rename from assets/js/f86eb50f.8afe0a58.js rename to assets/js/f86eb50f.1d740de9.js index e849d93933a..c664026e38d 100644 --- a/assets/js/f86eb50f.8afe0a58.js +++ b/assets/js/f86eb50f.1d740de9.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[48123],{67108:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>d,contentTitle:()=>c,default:()=>h,frontMatter:()=>t,metadata:()=>s,toc:()=>a});var r=i(24246),o=i(71670);const t={},c="Interface: ContainerProviderConnectionFactory",s={id:"interfaces/ContainerProviderConnectionFactory",title:"Interface: ContainerProviderConnectionFactory",description:"Extends",source:"@site/api/interfaces/ContainerProviderConnectionFactory.md",sourceDirName:"interfaces",slug:"/interfaces/ContainerProviderConnectionFactory",permalink:"/api/interfaces/ContainerProviderConnectionFactory",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: ContainerProviderConnectionEndpoint",permalink:"/api/interfaces/ContainerProviderConnectionEndpoint"},next:{title:"Interface: ContainerStatsInfo",permalink:"/api/interfaces/ContainerStatsInfo"}},d={},a=[{value:"Extends",id:"extends",level:2},{value:"Properties",id:"properties",level:2},{value:"creationButtonTitle?",id:"creationbuttontitle",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Source",id:"source",level:4},{value:"creationDisplayName?",id:"creationdisplayname",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Source",id:"source-1",level:4},{value:"Methods",id:"methods",level:2},{value:"create()",id:"create",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Source",id:"source-2",level:4},{value:"initialize()?",id:"initialize",level:3},{value:"Returns",id:"returns-1",level:4},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Source",id:"source-3",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",li:"li",p:"p",strong:"strong",ul:"ul",...(0,o.a)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.h1,{id:"interface-containerproviderconnectionfactory",children:"Interface: ContainerProviderConnectionFactory"}),"\n",(0,r.jsx)(n.h2,{id:"extends",children:"Extends"}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"/api/interfaces/ProviderConnectionFactory",children:(0,r.jsx)(n.code,{children:"ProviderConnectionFactory"})})}),"\n"]}),"\n",(0,r.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,r.jsx)(n.h3,{id:"creationbuttontitle",children:"creationButtonTitle?"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"optional"})})," ",(0,r.jsx)(n.strong,{children:"creationButtonTitle"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"inherited-from",children:"Inherited from"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.a,{href:"/api/interfaces/ProviderConnectionFactory",children:(0,r.jsx)(n.code,{children:"ProviderConnectionFactory"})}),".",(0,r.jsx)(n.a,{href:"/api/interfaces/ProviderConnectionFactory#creationbuttontitle",children:(0,r.jsx)(n.code,{children:"creationButtonTitle"})})]}),"\n",(0,r.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L317",children:"packages/extension-api/src/extension-api.d.ts:317"})}),"\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.strong,{children:(0,r.jsx)(n.code,{children:"optional"})})," ",(0,r.jsx)(n.strong,{children:"creationDisplayName"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"inherited-from-1",children:"Inherited from"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.a,{href:"/api/interfaces/ProviderConnectionFactory",children:(0,r.jsx)(n.code,{children:"ProviderConnectionFactory"})}),".",(0,r.jsx)(n.a,{href:"/api/interfaces/ProviderConnectionFactory#creationdisplayname",children:(0,r.jsx)(n.code,{children:"creationDisplayName"})})]}),"\n",(0,r.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L314",children:"packages/extension-api/src/extension-api.d.ts:314"})}),"\n",(0,r.jsx)(n.h2,{id:"methods",children:"Methods"}),"\n",(0,r.jsx)(n.h3,{id:"create",children:"create()"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"create"}),"(",(0,r.jsx)(n.code,{children:"params"}),", ",(0,r.jsx)(n.code,{children:"logger"}),"?, ",(0,r.jsx)(n.code,{children:"token"}),"?): ",(0,r.jsx)(n.code,{children:"Promise"}),"< ",(0,r.jsx)(n.code,{children:"void"})," >"]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"parameters",children:"Parameters"}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"params"})]}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"logger?"}),": ",(0,r.jsx)(n.a,{href:"/api/interfaces/Logger",children:(0,r.jsx)(n.code,{children:"Logger"})})]}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"token?"}),": ",(0,r.jsx)(n.a,{href:"/api/interfaces/CancellationToken",children:(0,r.jsx)(n.code,{children:"CancellationToken"})})]}),"\n",(0,r.jsx)(n.h4,{id:"returns",children:"Returns"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"Promise"}),"< ",(0,r.jsx)(n.code,{children:"void"})," >"]}),"\n",(0,r.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L323",children:"packages/extension-api/src/extension-api.d.ts:323"})}),"\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.strong,{children:(0,r.jsx)(n.code,{children:"optional"})})," ",(0,r.jsx)(n.strong,{children:"initialize"}),"(): ",(0,r.jsx)(n.code,{children:"Promise"}),"< ",(0,r.jsx)(n.code,{children:"void"})," >"]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"returns-1",children:"Returns"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"Promise"}),"< ",(0,r.jsx)(n.code,{children:"void"})," >"]}),"\n",(0,r.jsx)(n.h4,{id:"inherited-from-2",children:"Inherited from"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.a,{href:"/api/interfaces/ProviderConnectionFactory",children:(0,r.jsx)(n.code,{children:"ProviderConnectionFactory"})}),".",(0,r.jsx)(n.a,{href:"/api/interfaces/ProviderConnectionFactory#initialize",children:(0,r.jsx)(n.code,{children:"initialize"})})]}),"\n",(0,r.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L311",children:"packages/extension-api/src/extension-api.d.ts:311"})})]})}function h(e={}){const{wrapper:n}={...(0,o.a)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(l,{...e})}):l(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>s,a:()=>c});var r=i(27378);const o={},t=r.createContext(o);function c(e){const n=r.useContext(t);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function s(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:c(e.components),r.createElement(t.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[48123],{67108:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>d,contentTitle:()=>c,default:()=>h,frontMatter:()=>t,metadata:()=>s,toc:()=>a});var r=i(24246),o=i(71670);const t={},c="Interface: ContainerProviderConnectionFactory",s={id:"interfaces/ContainerProviderConnectionFactory",title:"Interface: ContainerProviderConnectionFactory",description:"Extends",source:"@site/api/interfaces/ContainerProviderConnectionFactory.md",sourceDirName:"interfaces",slug:"/interfaces/ContainerProviderConnectionFactory",permalink:"/api/interfaces/ContainerProviderConnectionFactory",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: ContainerProviderConnectionEndpoint",permalink:"/api/interfaces/ContainerProviderConnectionEndpoint"},next:{title:"Interface: ContainerStatsInfo",permalink:"/api/interfaces/ContainerStatsInfo"}},d={},a=[{value:"Extends",id:"extends",level:2},{value:"Properties",id:"properties",level:2},{value:"creationButtonTitle?",id:"creationbuttontitle",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Source",id:"source",level:4},{value:"creationDisplayName?",id:"creationdisplayname",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Source",id:"source-1",level:4},{value:"Methods",id:"methods",level:2},{value:"create()",id:"create",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Source",id:"source-2",level:4},{value:"initialize()?",id:"initialize",level:3},{value:"Returns",id:"returns-1",level:4},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Source",id:"source-3",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",li:"li",p:"p",strong:"strong",ul:"ul",...(0,o.a)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.h1,{id:"interface-containerproviderconnectionfactory",children:"Interface: ContainerProviderConnectionFactory"}),"\n",(0,r.jsx)(n.h2,{id:"extends",children:"Extends"}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"/api/interfaces/ProviderConnectionFactory",children:(0,r.jsx)(n.code,{children:"ProviderConnectionFactory"})})}),"\n"]}),"\n",(0,r.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,r.jsx)(n.h3,{id:"creationbuttontitle",children:"creationButtonTitle?"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"optional"})})," ",(0,r.jsx)(n.strong,{children:"creationButtonTitle"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"inherited-from",children:"Inherited from"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.a,{href:"/api/interfaces/ProviderConnectionFactory",children:(0,r.jsx)(n.code,{children:"ProviderConnectionFactory"})}),".",(0,r.jsx)(n.a,{href:"/api/interfaces/ProviderConnectionFactory#creationbuttontitle",children:(0,r.jsx)(n.code,{children:"creationButtonTitle"})})]}),"\n",(0,r.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L317",children:"packages/extension-api/src/extension-api.d.ts:317"})}),"\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.strong,{children:(0,r.jsx)(n.code,{children:"optional"})})," ",(0,r.jsx)(n.strong,{children:"creationDisplayName"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"inherited-from-1",children:"Inherited from"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.a,{href:"/api/interfaces/ProviderConnectionFactory",children:(0,r.jsx)(n.code,{children:"ProviderConnectionFactory"})}),".",(0,r.jsx)(n.a,{href:"/api/interfaces/ProviderConnectionFactory#creationdisplayname",children:(0,r.jsx)(n.code,{children:"creationDisplayName"})})]}),"\n",(0,r.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L314",children:"packages/extension-api/src/extension-api.d.ts:314"})}),"\n",(0,r.jsx)(n.h2,{id:"methods",children:"Methods"}),"\n",(0,r.jsx)(n.h3,{id:"create",children:"create()"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"create"}),"(",(0,r.jsx)(n.code,{children:"params"}),", ",(0,r.jsx)(n.code,{children:"logger"}),"?, ",(0,r.jsx)(n.code,{children:"token"}),"?): ",(0,r.jsx)(n.code,{children:"Promise"}),"< ",(0,r.jsx)(n.code,{children:"void"})," >"]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"parameters",children:"Parameters"}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"params"})]}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"logger?"}),": ",(0,r.jsx)(n.a,{href:"/api/interfaces/Logger",children:(0,r.jsx)(n.code,{children:"Logger"})})]}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"token?"}),": ",(0,r.jsx)(n.a,{href:"/api/interfaces/CancellationToken",children:(0,r.jsx)(n.code,{children:"CancellationToken"})})]}),"\n",(0,r.jsx)(n.h4,{id:"returns",children:"Returns"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"Promise"}),"< ",(0,r.jsx)(n.code,{children:"void"})," >"]}),"\n",(0,r.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L323",children:"packages/extension-api/src/extension-api.d.ts:323"})}),"\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.strong,{children:(0,r.jsx)(n.code,{children:"optional"})})," ",(0,r.jsx)(n.strong,{children:"initialize"}),"(): ",(0,r.jsx)(n.code,{children:"Promise"}),"< ",(0,r.jsx)(n.code,{children:"void"})," >"]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"returns-1",children:"Returns"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"Promise"}),"< ",(0,r.jsx)(n.code,{children:"void"})," >"]}),"\n",(0,r.jsx)(n.h4,{id:"inherited-from-2",children:"Inherited from"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.a,{href:"/api/interfaces/ProviderConnectionFactory",children:(0,r.jsx)(n.code,{children:"ProviderConnectionFactory"})}),".",(0,r.jsx)(n.a,{href:"/api/interfaces/ProviderConnectionFactory#initialize",children:(0,r.jsx)(n.code,{children:"initialize"})})]}),"\n",(0,r.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L311",children:"packages/extension-api/src/extension-api.d.ts:311"})})]})}function h(e={}){const{wrapper:n}={...(0,o.a)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(l,{...e})}):l(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>s,a:()=>c});var r=i(27378);const o={},t=r.createContext(o);function c(e){const n=r.useContext(t);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function s(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:c(e.components),r.createElement(t.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/fb8cd692.eb9397b4.js b/assets/js/fb8cd692.d16ceec6.js similarity index 87% rename from assets/js/fb8cd692.eb9397b4.js rename to assets/js/fb8cd692.d16ceec6.js index 15adfecba74..bd32f179e5b 100644 --- a/assets/js/fb8cd692.eb9397b4.js +++ b/assets/js/fb8cd692.d16ceec6.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[80511],{92985:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>l,contentTitle:()=>r,default:()=>h,frontMatter:()=>o,metadata:()=>d,toc:()=>t});var i=s(24246),c=s(71670);const o={},r="Interface: HostConfig",d={id:"interfaces/HostConfig",title:"Interface: HostConfig",description:"Properties",source:"@site/api/interfaces/HostConfig.md",sourceDirName:"interfaces",slug:"/interfaces/HostConfig",permalink:"/api/interfaces/HostConfig",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: HealthConfig",permalink:"/api/interfaces/HealthConfig"},next:{title:"Interface: HostRestartPolicy",permalink:"/api/interfaces/HostRestartPolicy"}},l={},t=[{value:"Properties",id:"properties",level:2},{value:"AutoRemove?",id:"autoremove",level:3},{value:"Source",id:"source",level:4},{value:"Binds?",id:"binds",level:3},{value:"Source",id:"source-1",level:4},{value:"BlkioDeviceReadBps?",id:"blkiodevicereadbps",level:3},{value:"Source",id:"source-2",level:4},{value:"BlkioDeviceReadIOps?",id:"blkiodevicereadiops",level:3},{value:"Source",id:"source-3",level:4},{value:"BlkioDeviceWriteBps?",id:"blkiodevicewritebps",level:3},{value:"Source",id:"source-4",level:4},{value:"BlkioDeviceWriteIOps?",id:"blkiodevicewriteiops",level:3},{value:"Source",id:"source-5",level:4},{value:"BlkioWeight?",id:"blkioweight",level:3},{value:"Source",id:"source-6",level:4},{value:"BlkioWeightDevice?",id:"blkioweightdevice",level:3},{value:"Source",id:"source-7",level:4},{value:"CapAdd?",id:"capadd",level:3},{value:"Source",id:"source-8",level:4},{value:"CapDrop?",id:"capdrop",level:3},{value:"Source",id:"source-9",level:4},{value:"Cgroup?",id:"cgroup",level:3},{value:"Source",id:"source-10",level:4},{value:"CgroupParent?",id:"cgroupparent",level:3},{value:"Source",id:"source-11",level:4},{value:"ConsoleSize?",id:"consolesize",level:3},{value:"Source",id:"source-12",level:4},{value:"ContainerIDFile?",id:"containeridfile",level:3},{value:"Source",id:"source-13",level:4},{value:"CpuCount?",id:"cpucount",level:3},{value:"Source",id:"source-14",level:4},{value:"CpuPercent?",id:"cpupercent",level:3},{value:"Source",id:"source-15",level:4},{value:"CpuPeriod?",id:"cpuperiod",level:3},{value:"Source",id:"source-16",level:4},{value:"CpuQuota?",id:"cpuquota",level:3},{value:"Source",id:"source-17",level:4},{value:"CpuRealtimePeriod?",id:"cpurealtimeperiod",level:3},{value:"Source",id:"source-18",level:4},{value:"CpuRealtimeRuntime?",id:"cpurealtimeruntime",level:3},{value:"Source",id:"source-19",level:4},{value:"CpuShares?",id:"cpushares",level:3},{value:"Source",id:"source-20",level:4},{value:"CpusetCpus?",id:"cpusetcpus",level:3},{value:"Source",id:"source-21",level:4},{value:"CpusetMems?",id:"cpusetmems",level:3},{value:"Source",id:"source-22",level:4},{value:"DeviceCgroupRules?",id:"devicecgrouprules",level:3},{value:"Source",id:"source-23",level:4},{value:"DeviceRequests?",id:"devicerequests",level:3},{value:"Source",id:"source-24",level:4},{value:"Devices?",id:"devices",level:3},{value:"Source",id:"source-25",level:4},{value:"DiskQuota?",id:"diskquota",level:3},{value:"Source",id:"source-26",level:4},{value:"Dns?",id:"dns",level:3},{value:"Source",id:"source-27",level:4},{value:"DnsOptions?",id:"dnsoptions",level:3},{value:"Source",id:"source-28",level:4},{value:"DnsSearch?",id:"dnssearch",level:3},{value:"Source",id:"source-29",level:4},{value:"ExtraHosts?",id:"extrahosts",level:3},{value:"Source",id:"source-30",level:4},{value:"GroupAdd?",id:"groupadd",level:3},{value:"Source",id:"source-31",level:4},{value:"Init?",id:"init",level:3},{value:"Source",id:"source-32",level:4},{value:"IpcMode?",id:"ipcmode",level:3},{value:"Source",id:"source-33",level:4},{value:"Isolation?",id:"isolation",level:3},{value:"Source",id:"source-34",level:4},{value:"KernelMemory?",id:"kernelmemory",level:3},{value:"Source",id:"source-35",level:4},{value:"Links?",id:"links",level:3},{value:"Source",id:"source-36",level:4},{value:"LogConfig?",id:"logconfig",level:3},{value:"Config",id:"config",level:4},{value:"Type",id:"type",level:4},{value:"Source",id:"source-37",level:4},{value:"MaskedPaths?",id:"maskedpaths",level:3},{value:"Source",id:"source-38",level:4},{value:"Memory?",id:"memory",level:3},{value:"Source",id:"source-39",level:4},{value:"MemoryReservation?",id:"memoryreservation",level:3},{value:"Source",id:"source-40",level:4},{value:"MemorySwap?",id:"memoryswap",level:3},{value:"Source",id:"source-41",level:4},{value:"MemorySwappiness?",id:"memoryswappiness",level:3},{value:"Source",id:"source-42",level:4},{value:"Mounts?",id:"mounts",level:3},{value:"Source",id:"source-43",level:4},{value:"NanoCpus?",id:"nanocpus",level:3},{value:"Source",id:"source-44",level:4},{value:"NetworkMode?",id:"networkmode",level:3},{value:"Source",id:"source-45",level:4},{value:"OomKillDisable?",id:"oomkilldisable",level:3},{value:"Source",id:"source-46",level:4},{value:"OomScoreAdj?",id:"oomscoreadj",level:3},{value:"Source",id:"source-47",level:4},{value:"PidMode?",id:"pidmode",level:3},{value:"Source",id:"source-48",level:4},{value:"PidsLimit?",id:"pidslimit",level:3},{value:"Source",id:"source-49",level:4},{value:"PortBindings?",id:"portbindings",level:3},{value:"Source",id:"source-50",level:4},{value:"Privileged?",id:"privileged",level:3},{value:"Source",id:"source-51",level:4},{value:"PublishAllPorts?",id:"publishallports",level:3},{value:"Source",id:"source-52",level:4},{value:"ReadonlyPaths?",id:"readonlypaths",level:3},{value:"Source",id:"source-53",level:4},{value:"ReadonlyRootfs?",id:"readonlyrootfs",level:3},{value:"Source",id:"source-54",level:4},{value:"RestartPolicy?",id:"restartpolicy",level:3},{value:"Source",id:"source-55",level:4},{value:"Runtime?",id:"runtime",level:3},{value:"Source",id:"source-56",level:4},{value:"SecurityOpt?",id:"securityopt",level:3},{value:"Source",id:"source-57",level:4},{value:"ShmSize?",id:"shmsize",level:3},{value:"Source",id:"source-58",level:4},{value:"StorageOpt?",id:"storageopt",level:3},{value:"Index signature",id:"index-signature",level:4},{value:"Source",id:"source-59",level:4},{value:"Sysctls?",id:"sysctls",level:3},{value:"Index signature",id:"index-signature-1",level:4},{value:"Source",id:"source-60",level:4},{value:"Tmpfs?",id:"tmpfs",level:3},{value:"Index signature",id:"index-signature-2",level:4},{value:"Source",id:"source-61",level:4},{value:"UTSMode?",id:"utsmode",level:3},{value:"Source",id:"source-62",level:4},{value:"Ulimits?",id:"ulimits",level:3},{value:"Source",id:"source-63",level:4},{value:"UsernsMode?",id:"usernsmode",level:3},{value:"Source",id:"source-64",level:4},{value:"VolumeDriver?",id:"volumedriver",level:3},{value:"Source",id:"source-65",level:4},{value:"VolumesFrom?",id:"volumesfrom",level:3},{value:"Source",id:"source-66",level:4}];function a(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,c.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"interface-hostconfig",children:"Interface: HostConfig"}),"\n",(0,i.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(n.h3,{id:"autoremove",children:"AutoRemove?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"AutoRemove"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2129",children:"packages/extension-api/src/extension-api.d.ts:2129"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"binds",children:"Binds?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"Binds"}),": ",(0,i.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2130",children:"packages/extension-api/src/extension-api.d.ts:2130"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"blkiodevicereadbps",children:"BlkioDeviceReadBps?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"BlkioDeviceReadBps"}),": ",(0,i.jsx)(n.code,{children:"unknown"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2173",children:"packages/extension-api/src/extension-api.d.ts:2173"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"blkiodevicereadiops",children:"BlkioDeviceReadIOps?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"BlkioDeviceReadIOps"}),": ",(0,i.jsx)(n.code,{children:"unknown"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2175",children:"packages/extension-api/src/extension-api.d.ts:2175"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"blkiodevicewritebps",children:"BlkioDeviceWriteBps?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"BlkioDeviceWriteBps"}),": ",(0,i.jsx)(n.code,{children:"unknown"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-4",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2174",children:"packages/extension-api/src/extension-api.d.ts:2174"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"blkiodevicewriteiops",children:"BlkioDeviceWriteIOps?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"BlkioDeviceWriteIOps"}),": ",(0,i.jsx)(n.code,{children:"unknown"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-5",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2176",children:"packages/extension-api/src/extension-api.d.ts:2176"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"blkioweight",children:"BlkioWeight?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"BlkioWeight"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-6",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2171",children:"packages/extension-api/src/extension-api.d.ts:2171"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"blkioweightdevice",children:"BlkioWeightDevice?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"BlkioWeightDevice"}),": ",(0,i.jsx)(n.code,{children:"unknown"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-7",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2172",children:"packages/extension-api/src/extension-api.d.ts:2172"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"capadd",children:"CapAdd?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"CapAdd"}),": ",(0,i.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-8",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2142",children:"packages/extension-api/src/extension-api.d.ts:2142"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"capdrop",children:"CapDrop?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"CapDrop"}),": ",(0,i.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-9",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2143",children:"packages/extension-api/src/extension-api.d.ts:2143"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"cgroup",children:"Cgroup?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"Cgroup"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-10",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2150",children:"packages/extension-api/src/extension-api.d.ts:2150"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"cgroupparent",children:"CgroupParent?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"CgroupParent"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-11",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2170",children:"packages/extension-api/src/extension-api.d.ts:2170"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"consolesize",children:"ConsoleSize?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"ConsoleSize"}),": ",(0,i.jsx)(n.code,{children:"number"}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-12",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2165",children:"packages/extension-api/src/extension-api.d.ts:2165"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"containeridfile",children:"ContainerIDFile?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"ContainerIDFile"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-13",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2131",children:"packages/extension-api/src/extension-api.d.ts:2131"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"cpucount",children:"CpuCount?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"CpuCount"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-14",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2195",children:"packages/extension-api/src/extension-api.d.ts:2195"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"cpupercent",children:"CpuPercent?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"CpuPercent"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-15",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2196",children:"packages/extension-api/src/extension-api.d.ts:2196"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"cpuperiod",children:"CpuPeriod?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"CpuPeriod"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-16",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2177",children:"packages/extension-api/src/extension-api.d.ts:2177"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"cpuquota",children:"CpuQuota?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"CpuQuota"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-17",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2178",children:"packages/extension-api/src/extension-api.d.ts:2178"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"cpurealtimeperiod",children:"CpuRealtimePeriod?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"CpuRealtimePeriod"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-18",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2197",children:"packages/extension-api/src/extension-api.d.ts:2197"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"cpurealtimeruntime",children:"CpuRealtimeRuntime?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"CpuRealtimeRuntime"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-19",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2198",children:"packages/extension-api/src/extension-api.d.ts:2198"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"cpushares",children:"CpuShares?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"CpuShares"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-20",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2169",children:"packages/extension-api/src/extension-api.d.ts:2169"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"cpusetcpus",children:"CpusetCpus?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"CpusetCpus"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-21",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2179",children:"packages/extension-api/src/extension-api.d.ts:2179"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"cpusetmems",children:"CpusetMems?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"CpusetMems"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-22",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2180",children:"packages/extension-api/src/extension-api.d.ts:2180"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"devicecgrouprules",children:"DeviceCgroupRules?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"DeviceCgroupRules"}),": ",(0,i.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-23",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2182",children:"packages/extension-api/src/extension-api.d.ts:2182"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"devicerequests",children:"DeviceRequests?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"DeviceRequests"}),": ",(0,i.jsx)(n.a,{href:"/api/interfaces/DeviceRequest",children:(0,i.jsx)(n.code,{children:"DeviceRequest"})}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-24",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2183",children:"packages/extension-api/src/extension-api.d.ts:2183"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"devices",children:"Devices?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"Devices"}),": ",(0,i.jsx)(n.code,{children:"unknown"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-25",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2181",children:"packages/extension-api/src/extension-api.d.ts:2181"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"diskquota",children:"DiskQuota?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"DiskQuota"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-26",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2184",children:"packages/extension-api/src/extension-api.d.ts:2184"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"dns",children:"Dns?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"Dns"}),": ",(0,i.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-27",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2144",children:"packages/extension-api/src/extension-api.d.ts:2144"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"dnsoptions",children:"DnsOptions?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"DnsOptions"}),": ",(0,i.jsx)(n.code,{children:"unknown"}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-28",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2145",children:"packages/extension-api/src/extension-api.d.ts:2145"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"dnssearch",children:"DnsSearch?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"DnsSearch"}),": ",(0,i.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-29",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2146",children:"packages/extension-api/src/extension-api.d.ts:2146"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"extrahosts",children:"ExtraHosts?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"ExtraHosts"}),": ",(0,i.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-30",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2147",children:"packages/extension-api/src/extension-api.d.ts:2147"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"groupadd",children:"GroupAdd?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"GroupAdd"}),": ",(0,i.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-31",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2148",children:"packages/extension-api/src/extension-api.d.ts:2148"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"init",children:"Init?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"Init"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-32",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2192",children:"packages/extension-api/src/extension-api.d.ts:2192"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"ipcmode",children:"IpcMode?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"IpcMode"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-33",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2149",children:"packages/extension-api/src/extension-api.d.ts:2149"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"isolation",children:"Isolation?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"Isolation"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-34",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2166",children:"packages/extension-api/src/extension-api.d.ts:2166"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"kernelmemory",children:"KernelMemory?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"KernelMemory"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-35",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2185",children:"packages/extension-api/src/extension-api.d.ts:2185"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"links",children:"Links?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"Links"}),": ",(0,i.jsx)(n.code,{children:"unknown"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-36",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2151",children:"packages/extension-api/src/extension-api.d.ts:2151"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"logconfig",children:"LogConfig?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"LogConfig"}),": ",(0,i.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"config",children:"Config"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Config"}),": ",(0,i.jsx)(n.code,{children:"unknown"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"type",children:"Type"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Type"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-37",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2132",children:"packages/extension-api/src/extension-api.d.ts:2132"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"maskedpaths",children:"MaskedPaths?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"MaskedPaths"}),": ",(0,i.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-38",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2167",children:"packages/extension-api/src/extension-api.d.ts:2167"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"memory",children:"Memory?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"Memory"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-39",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2186",children:"packages/extension-api/src/extension-api.d.ts:2186"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"memoryreservation",children:"MemoryReservation?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"MemoryReservation"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-40",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2187",children:"packages/extension-api/src/extension-api.d.ts:2187"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"memoryswap",children:"MemorySwap?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"MemorySwap"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-41",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2188",children:"packages/extension-api/src/extension-api.d.ts:2188"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"memoryswappiness",children:"MemorySwappiness?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"MemorySwappiness"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-42",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2189",children:"packages/extension-api/src/extension-api.d.ts:2189"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"mounts",children:"Mounts?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"Mounts"}),": ",(0,i.jsx)(n.a,{href:"/api/type-aliases/MountConfig",children:(0,i.jsx)(n.code,{children:"MountConfig"})})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-43",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2141",children:"packages/extension-api/src/extension-api.d.ts:2141"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"nanocpus",children:"NanoCpus?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"NanoCpus"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-44",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2190",children:"packages/extension-api/src/extension-api.d.ts:2190"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"networkmode",children:"NetworkMode?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"NetworkMode"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-45",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2136",children:"packages/extension-api/src/extension-api.d.ts:2136"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"oomkilldisable",children:"OomKillDisable?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"OomKillDisable"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-46",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2191",children:"packages/extension-api/src/extension-api.d.ts:2191"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"oomscoreadj",children:"OomScoreAdj?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"OomScoreAdj"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-47",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2152",children:"packages/extension-api/src/extension-api.d.ts:2152"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"pidmode",children:"PidMode?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"PidMode"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-48",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2153",children:"packages/extension-api/src/extension-api.d.ts:2153"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"pidslimit",children:"PidsLimit?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"PidsLimit"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-49",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2193",children:"packages/extension-api/src/extension-api.d.ts:2193"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"portbindings",children:"PortBindings?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"PortBindings"}),": ",(0,i.jsx)(n.code,{children:"unknown"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-50",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2137",children:"packages/extension-api/src/extension-api.d.ts:2137"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"privileged",children:"Privileged?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"Privileged"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-51",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2154",children:"packages/extension-api/src/extension-api.d.ts:2154"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"publishallports",children:"PublishAllPorts?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"PublishAllPorts"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-52",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2155",children:"packages/extension-api/src/extension-api.d.ts:2155"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"readonlypaths",children:"ReadonlyPaths?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"ReadonlyPaths"}),": ",(0,i.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-53",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2168",children:"packages/extension-api/src/extension-api.d.ts:2168"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"readonlyrootfs",children:"ReadonlyRootfs?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"ReadonlyRootfs"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-54",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2156",children:"packages/extension-api/src/extension-api.d.ts:2156"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"restartpolicy",children:"RestartPolicy?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"RestartPolicy"}),": ",(0,i.jsx)(n.a,{href:"/api/interfaces/HostRestartPolicy",children:(0,i.jsx)(n.code,{children:"HostRestartPolicy"})})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-55",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2138",children:"packages/extension-api/src/extension-api.d.ts:2138"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"runtime",children:"Runtime?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"Runtime"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-56",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2164",children:"packages/extension-api/src/extension-api.d.ts:2164"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"securityopt",children:"SecurityOpt?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"SecurityOpt"}),": ",(0,i.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-57",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2157",children:"packages/extension-api/src/extension-api.d.ts:2157"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"shmsize",children:"ShmSize?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"ShmSize"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-58",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2162",children:"packages/extension-api/src/extension-api.d.ts:2162"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"storageopt",children:"StorageOpt?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"StorageOpt"}),": ",(0,i.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"index-signature",children:"Index signature"}),"\n",(0,i.jsxs)(n.p,{children:["[",(0,i.jsx)(n.code,{children:"option"}),": ",(0,i.jsx)(n.code,{children:"string"}),"]: ",(0,i.jsx)(n.code,{children:"string"})]}),"\n",(0,i.jsx)(n.h4,{id:"source-59",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2158",children:"packages/extension-api/src/extension-api.d.ts:2158"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"sysctls",children:"Sysctls?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"Sysctls"}),": ",(0,i.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"index-signature-1",children:"Index signature"}),"\n",(0,i.jsxs)(n.p,{children:["[",(0,i.jsx)(n.code,{children:"index"}),": ",(0,i.jsx)(n.code,{children:"string"}),"]: ",(0,i.jsx)(n.code,{children:"string"})]}),"\n",(0,i.jsx)(n.h4,{id:"source-60",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2163",children:"packages/extension-api/src/extension-api.d.ts:2163"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"tmpfs",children:"Tmpfs?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"Tmpfs"}),": ",(0,i.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"index-signature-2",children:"Index signature"}),"\n",(0,i.jsxs)(n.p,{children:["[",(0,i.jsx)(n.code,{children:"dir"}),": ",(0,i.jsx)(n.code,{children:"string"}),"]: ",(0,i.jsx)(n.code,{children:"string"})]}),"\n",(0,i.jsx)(n.h4,{id:"source-61",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2159",children:"packages/extension-api/src/extension-api.d.ts:2159"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"utsmode",children:"UTSMode?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"UTSMode"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-62",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2160",children:"packages/extension-api/src/extension-api.d.ts:2160"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"ulimits",children:"Ulimits?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"Ulimits"}),": ",(0,i.jsx)(n.code,{children:"unknown"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-63",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2194",children:"packages/extension-api/src/extension-api.d.ts:2194"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"usernsmode",children:"UsernsMode?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"UsernsMode"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-64",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2161",children:"packages/extension-api/src/extension-api.d.ts:2161"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"volumedriver",children:"VolumeDriver?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"VolumeDriver"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-65",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2139",children:"packages/extension-api/src/extension-api.d.ts:2139"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"volumesfrom",children:"VolumesFrom?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"VolumesFrom"}),": ",(0,i.jsx)(n.code,{children:"unknown"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-66",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L2140",children:"packages/extension-api/src/extension-api.d.ts:2140"})})]})}function h(e={}){const{wrapper:n}={...(0,c.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(a,{...e})}):a(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>d,a:()=>r});var i=s(27378);const c={},o=i.createContext(c);function r(e){const n=i.useContext(o);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function d(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(c):e.components||c:r(e.components),i.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[80511],{92985:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>l,contentTitle:()=>r,default:()=>a,frontMatter:()=>o,metadata:()=>d,toc:()=>t});var i=s(24246),c=s(71670);const o={},r="Interface: HostConfig",d={id:"interfaces/HostConfig",title:"Interface: HostConfig",description:"Properties",source:"@site/api/interfaces/HostConfig.md",sourceDirName:"interfaces",slug:"/interfaces/HostConfig",permalink:"/api/interfaces/HostConfig",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: HealthConfig",permalink:"/api/interfaces/HealthConfig"},next:{title:"Interface: HostRestartPolicy",permalink:"/api/interfaces/HostRestartPolicy"}},l={},t=[{value:"Properties",id:"properties",level:2},{value:"AutoRemove?",id:"autoremove",level:3},{value:"Source",id:"source",level:4},{value:"Binds?",id:"binds",level:3},{value:"Source",id:"source-1",level:4},{value:"BlkioDeviceReadBps?",id:"blkiodevicereadbps",level:3},{value:"Source",id:"source-2",level:4},{value:"BlkioDeviceReadIOps?",id:"blkiodevicereadiops",level:3},{value:"Source",id:"source-3",level:4},{value:"BlkioDeviceWriteBps?",id:"blkiodevicewritebps",level:3},{value:"Source",id:"source-4",level:4},{value:"BlkioDeviceWriteIOps?",id:"blkiodevicewriteiops",level:3},{value:"Source",id:"source-5",level:4},{value:"BlkioWeight?",id:"blkioweight",level:3},{value:"Source",id:"source-6",level:4},{value:"BlkioWeightDevice?",id:"blkioweightdevice",level:3},{value:"Source",id:"source-7",level:4},{value:"CapAdd?",id:"capadd",level:3},{value:"Source",id:"source-8",level:4},{value:"CapDrop?",id:"capdrop",level:3},{value:"Source",id:"source-9",level:4},{value:"Cgroup?",id:"cgroup",level:3},{value:"Source",id:"source-10",level:4},{value:"CgroupParent?",id:"cgroupparent",level:3},{value:"Source",id:"source-11",level:4},{value:"ConsoleSize?",id:"consolesize",level:3},{value:"Source",id:"source-12",level:4},{value:"ContainerIDFile?",id:"containeridfile",level:3},{value:"Source",id:"source-13",level:4},{value:"CpuCount?",id:"cpucount",level:3},{value:"Source",id:"source-14",level:4},{value:"CpuPercent?",id:"cpupercent",level:3},{value:"Source",id:"source-15",level:4},{value:"CpuPeriod?",id:"cpuperiod",level:3},{value:"Source",id:"source-16",level:4},{value:"CpuQuota?",id:"cpuquota",level:3},{value:"Source",id:"source-17",level:4},{value:"CpuRealtimePeriod?",id:"cpurealtimeperiod",level:3},{value:"Source",id:"source-18",level:4},{value:"CpuRealtimeRuntime?",id:"cpurealtimeruntime",level:3},{value:"Source",id:"source-19",level:4},{value:"CpuShares?",id:"cpushares",level:3},{value:"Source",id:"source-20",level:4},{value:"CpusetCpus?",id:"cpusetcpus",level:3},{value:"Source",id:"source-21",level:4},{value:"CpusetMems?",id:"cpusetmems",level:3},{value:"Source",id:"source-22",level:4},{value:"DeviceCgroupRules?",id:"devicecgrouprules",level:3},{value:"Source",id:"source-23",level:4},{value:"DeviceRequests?",id:"devicerequests",level:3},{value:"Source",id:"source-24",level:4},{value:"Devices?",id:"devices",level:3},{value:"Source",id:"source-25",level:4},{value:"DiskQuota?",id:"diskquota",level:3},{value:"Source",id:"source-26",level:4},{value:"Dns?",id:"dns",level:3},{value:"Source",id:"source-27",level:4},{value:"DnsOptions?",id:"dnsoptions",level:3},{value:"Source",id:"source-28",level:4},{value:"DnsSearch?",id:"dnssearch",level:3},{value:"Source",id:"source-29",level:4},{value:"ExtraHosts?",id:"extrahosts",level:3},{value:"Source",id:"source-30",level:4},{value:"GroupAdd?",id:"groupadd",level:3},{value:"Source",id:"source-31",level:4},{value:"Init?",id:"init",level:3},{value:"Source",id:"source-32",level:4},{value:"IpcMode?",id:"ipcmode",level:3},{value:"Source",id:"source-33",level:4},{value:"Isolation?",id:"isolation",level:3},{value:"Source",id:"source-34",level:4},{value:"KernelMemory?",id:"kernelmemory",level:3},{value:"Source",id:"source-35",level:4},{value:"Links?",id:"links",level:3},{value:"Source",id:"source-36",level:4},{value:"LogConfig?",id:"logconfig",level:3},{value:"Config",id:"config",level:4},{value:"Type",id:"type",level:4},{value:"Source",id:"source-37",level:4},{value:"MaskedPaths?",id:"maskedpaths",level:3},{value:"Source",id:"source-38",level:4},{value:"Memory?",id:"memory",level:3},{value:"Source",id:"source-39",level:4},{value:"MemoryReservation?",id:"memoryreservation",level:3},{value:"Source",id:"source-40",level:4},{value:"MemorySwap?",id:"memoryswap",level:3},{value:"Source",id:"source-41",level:4},{value:"MemorySwappiness?",id:"memoryswappiness",level:3},{value:"Source",id:"source-42",level:4},{value:"Mounts?",id:"mounts",level:3},{value:"Source",id:"source-43",level:4},{value:"NanoCpus?",id:"nanocpus",level:3},{value:"Source",id:"source-44",level:4},{value:"NetworkMode?",id:"networkmode",level:3},{value:"Source",id:"source-45",level:4},{value:"OomKillDisable?",id:"oomkilldisable",level:3},{value:"Source",id:"source-46",level:4},{value:"OomScoreAdj?",id:"oomscoreadj",level:3},{value:"Source",id:"source-47",level:4},{value:"PidMode?",id:"pidmode",level:3},{value:"Source",id:"source-48",level:4},{value:"PidsLimit?",id:"pidslimit",level:3},{value:"Source",id:"source-49",level:4},{value:"PortBindings?",id:"portbindings",level:3},{value:"Source",id:"source-50",level:4},{value:"Privileged?",id:"privileged",level:3},{value:"Source",id:"source-51",level:4},{value:"PublishAllPorts?",id:"publishallports",level:3},{value:"Source",id:"source-52",level:4},{value:"ReadonlyPaths?",id:"readonlypaths",level:3},{value:"Source",id:"source-53",level:4},{value:"ReadonlyRootfs?",id:"readonlyrootfs",level:3},{value:"Source",id:"source-54",level:4},{value:"RestartPolicy?",id:"restartpolicy",level:3},{value:"Source",id:"source-55",level:4},{value:"Runtime?",id:"runtime",level:3},{value:"Source",id:"source-56",level:4},{value:"SecurityOpt?",id:"securityopt",level:3},{value:"Source",id:"source-57",level:4},{value:"ShmSize?",id:"shmsize",level:3},{value:"Source",id:"source-58",level:4},{value:"StorageOpt?",id:"storageopt",level:3},{value:"Index signature",id:"index-signature",level:4},{value:"Source",id:"source-59",level:4},{value:"Sysctls?",id:"sysctls",level:3},{value:"Index signature",id:"index-signature-1",level:4},{value:"Source",id:"source-60",level:4},{value:"Tmpfs?",id:"tmpfs",level:3},{value:"Index signature",id:"index-signature-2",level:4},{value:"Source",id:"source-61",level:4},{value:"UTSMode?",id:"utsmode",level:3},{value:"Source",id:"source-62",level:4},{value:"Ulimits?",id:"ulimits",level:3},{value:"Source",id:"source-63",level:4},{value:"UsernsMode?",id:"usernsmode",level:3},{value:"Source",id:"source-64",level:4},{value:"VolumeDriver?",id:"volumedriver",level:3},{value:"Source",id:"source-65",level:4},{value:"VolumesFrom?",id:"volumesfrom",level:3},{value:"Source",id:"source-66",level:4}];function 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,c.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"interface-hostconfig",children:"Interface: HostConfig"}),"\n",(0,i.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(n.h3,{id:"autoremove",children:"AutoRemove?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"AutoRemove"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2129",children:"packages/extension-api/src/extension-api.d.ts:2129"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"binds",children:"Binds?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"Binds"}),": ",(0,i.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2130",children:"packages/extension-api/src/extension-api.d.ts:2130"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"blkiodevicereadbps",children:"BlkioDeviceReadBps?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"BlkioDeviceReadBps"}),": ",(0,i.jsx)(n.code,{children:"unknown"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2173",children:"packages/extension-api/src/extension-api.d.ts:2173"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"blkiodevicereadiops",children:"BlkioDeviceReadIOps?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"BlkioDeviceReadIOps"}),": ",(0,i.jsx)(n.code,{children:"unknown"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2175",children:"packages/extension-api/src/extension-api.d.ts:2175"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"blkiodevicewritebps",children:"BlkioDeviceWriteBps?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"BlkioDeviceWriteBps"}),": ",(0,i.jsx)(n.code,{children:"unknown"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-4",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2174",children:"packages/extension-api/src/extension-api.d.ts:2174"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"blkiodevicewriteiops",children:"BlkioDeviceWriteIOps?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"BlkioDeviceWriteIOps"}),": ",(0,i.jsx)(n.code,{children:"unknown"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-5",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2176",children:"packages/extension-api/src/extension-api.d.ts:2176"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"blkioweight",children:"BlkioWeight?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"BlkioWeight"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-6",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2171",children:"packages/extension-api/src/extension-api.d.ts:2171"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"blkioweightdevice",children:"BlkioWeightDevice?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"BlkioWeightDevice"}),": ",(0,i.jsx)(n.code,{children:"unknown"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-7",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2172",children:"packages/extension-api/src/extension-api.d.ts:2172"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"capadd",children:"CapAdd?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"CapAdd"}),": ",(0,i.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-8",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2142",children:"packages/extension-api/src/extension-api.d.ts:2142"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"capdrop",children:"CapDrop?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"CapDrop"}),": ",(0,i.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-9",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2143",children:"packages/extension-api/src/extension-api.d.ts:2143"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"cgroup",children:"Cgroup?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"Cgroup"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-10",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2150",children:"packages/extension-api/src/extension-api.d.ts:2150"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"cgroupparent",children:"CgroupParent?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"CgroupParent"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-11",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2170",children:"packages/extension-api/src/extension-api.d.ts:2170"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"consolesize",children:"ConsoleSize?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"ConsoleSize"}),": ",(0,i.jsx)(n.code,{children:"number"}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-12",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2165",children:"packages/extension-api/src/extension-api.d.ts:2165"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"containeridfile",children:"ContainerIDFile?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"ContainerIDFile"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-13",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2131",children:"packages/extension-api/src/extension-api.d.ts:2131"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"cpucount",children:"CpuCount?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"CpuCount"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-14",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2195",children:"packages/extension-api/src/extension-api.d.ts:2195"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"cpupercent",children:"CpuPercent?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"CpuPercent"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-15",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2196",children:"packages/extension-api/src/extension-api.d.ts:2196"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"cpuperiod",children:"CpuPeriod?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"CpuPeriod"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-16",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2177",children:"packages/extension-api/src/extension-api.d.ts:2177"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"cpuquota",children:"CpuQuota?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"CpuQuota"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-17",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2178",children:"packages/extension-api/src/extension-api.d.ts:2178"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"cpurealtimeperiod",children:"CpuRealtimePeriod?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"CpuRealtimePeriod"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-18",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2197",children:"packages/extension-api/src/extension-api.d.ts:2197"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"cpurealtimeruntime",children:"CpuRealtimeRuntime?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"CpuRealtimeRuntime"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-19",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2198",children:"packages/extension-api/src/extension-api.d.ts:2198"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"cpushares",children:"CpuShares?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"CpuShares"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-20",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2169",children:"packages/extension-api/src/extension-api.d.ts:2169"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"cpusetcpus",children:"CpusetCpus?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"CpusetCpus"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-21",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2179",children:"packages/extension-api/src/extension-api.d.ts:2179"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"cpusetmems",children:"CpusetMems?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"CpusetMems"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-22",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2180",children:"packages/extension-api/src/extension-api.d.ts:2180"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"devicecgrouprules",children:"DeviceCgroupRules?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"DeviceCgroupRules"}),": ",(0,i.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-23",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2182",children:"packages/extension-api/src/extension-api.d.ts:2182"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"devicerequests",children:"DeviceRequests?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"DeviceRequests"}),": ",(0,i.jsx)(n.a,{href:"/api/interfaces/DeviceRequest",children:(0,i.jsx)(n.code,{children:"DeviceRequest"})}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-24",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2183",children:"packages/extension-api/src/extension-api.d.ts:2183"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"devices",children:"Devices?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"Devices"}),": ",(0,i.jsx)(n.code,{children:"unknown"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-25",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2181",children:"packages/extension-api/src/extension-api.d.ts:2181"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"diskquota",children:"DiskQuota?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"DiskQuota"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-26",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2184",children:"packages/extension-api/src/extension-api.d.ts:2184"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"dns",children:"Dns?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"Dns"}),": ",(0,i.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-27",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2144",children:"packages/extension-api/src/extension-api.d.ts:2144"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"dnsoptions",children:"DnsOptions?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"DnsOptions"}),": ",(0,i.jsx)(n.code,{children:"unknown"}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-28",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2145",children:"packages/extension-api/src/extension-api.d.ts:2145"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"dnssearch",children:"DnsSearch?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"DnsSearch"}),": ",(0,i.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-29",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2146",children:"packages/extension-api/src/extension-api.d.ts:2146"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"extrahosts",children:"ExtraHosts?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"ExtraHosts"}),": ",(0,i.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-30",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2147",children:"packages/extension-api/src/extension-api.d.ts:2147"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"groupadd",children:"GroupAdd?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"GroupAdd"}),": ",(0,i.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-31",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2148",children:"packages/extension-api/src/extension-api.d.ts:2148"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"init",children:"Init?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"Init"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-32",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2192",children:"packages/extension-api/src/extension-api.d.ts:2192"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"ipcmode",children:"IpcMode?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"IpcMode"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-33",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2149",children:"packages/extension-api/src/extension-api.d.ts:2149"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"isolation",children:"Isolation?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"Isolation"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-34",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2166",children:"packages/extension-api/src/extension-api.d.ts:2166"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"kernelmemory",children:"KernelMemory?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"KernelMemory"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-35",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2185",children:"packages/extension-api/src/extension-api.d.ts:2185"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"links",children:"Links?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"Links"}),": ",(0,i.jsx)(n.code,{children:"unknown"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-36",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2151",children:"packages/extension-api/src/extension-api.d.ts:2151"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"logconfig",children:"LogConfig?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"LogConfig"}),": ",(0,i.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"config",children:"Config"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Config"}),": ",(0,i.jsx)(n.code,{children:"unknown"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"type",children:"Type"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Type"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-37",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2132",children:"packages/extension-api/src/extension-api.d.ts:2132"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"maskedpaths",children:"MaskedPaths?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"MaskedPaths"}),": ",(0,i.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-38",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2167",children:"packages/extension-api/src/extension-api.d.ts:2167"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"memory",children:"Memory?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"Memory"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-39",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2186",children:"packages/extension-api/src/extension-api.d.ts:2186"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"memoryreservation",children:"MemoryReservation?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"MemoryReservation"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-40",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2187",children:"packages/extension-api/src/extension-api.d.ts:2187"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"memoryswap",children:"MemorySwap?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"MemorySwap"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-41",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2188",children:"packages/extension-api/src/extension-api.d.ts:2188"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"memoryswappiness",children:"MemorySwappiness?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"MemorySwappiness"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-42",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2189",children:"packages/extension-api/src/extension-api.d.ts:2189"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"mounts",children:"Mounts?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"Mounts"}),": ",(0,i.jsx)(n.a,{href:"/api/type-aliases/MountConfig",children:(0,i.jsx)(n.code,{children:"MountConfig"})})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-43",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2141",children:"packages/extension-api/src/extension-api.d.ts:2141"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"nanocpus",children:"NanoCpus?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"NanoCpus"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-44",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2190",children:"packages/extension-api/src/extension-api.d.ts:2190"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"networkmode",children:"NetworkMode?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"NetworkMode"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-45",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2136",children:"packages/extension-api/src/extension-api.d.ts:2136"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"oomkilldisable",children:"OomKillDisable?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"OomKillDisable"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-46",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2191",children:"packages/extension-api/src/extension-api.d.ts:2191"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"oomscoreadj",children:"OomScoreAdj?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"OomScoreAdj"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-47",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2152",children:"packages/extension-api/src/extension-api.d.ts:2152"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"pidmode",children:"PidMode?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"PidMode"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-48",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2153",children:"packages/extension-api/src/extension-api.d.ts:2153"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"pidslimit",children:"PidsLimit?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"PidsLimit"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-49",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2193",children:"packages/extension-api/src/extension-api.d.ts:2193"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"portbindings",children:"PortBindings?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"PortBindings"}),": ",(0,i.jsx)(n.code,{children:"unknown"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-50",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2137",children:"packages/extension-api/src/extension-api.d.ts:2137"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"privileged",children:"Privileged?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"Privileged"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-51",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2154",children:"packages/extension-api/src/extension-api.d.ts:2154"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"publishallports",children:"PublishAllPorts?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"PublishAllPorts"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-52",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2155",children:"packages/extension-api/src/extension-api.d.ts:2155"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"readonlypaths",children:"ReadonlyPaths?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"ReadonlyPaths"}),": ",(0,i.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-53",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2168",children:"packages/extension-api/src/extension-api.d.ts:2168"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"readonlyrootfs",children:"ReadonlyRootfs?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"ReadonlyRootfs"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-54",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2156",children:"packages/extension-api/src/extension-api.d.ts:2156"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"restartpolicy",children:"RestartPolicy?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"RestartPolicy"}),": ",(0,i.jsx)(n.a,{href:"/api/interfaces/HostRestartPolicy",children:(0,i.jsx)(n.code,{children:"HostRestartPolicy"})})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-55",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2138",children:"packages/extension-api/src/extension-api.d.ts:2138"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"runtime",children:"Runtime?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"Runtime"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-56",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2164",children:"packages/extension-api/src/extension-api.d.ts:2164"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"securityopt",children:"SecurityOpt?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"SecurityOpt"}),": ",(0,i.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-57",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2157",children:"packages/extension-api/src/extension-api.d.ts:2157"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"shmsize",children:"ShmSize?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"ShmSize"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-58",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2162",children:"packages/extension-api/src/extension-api.d.ts:2162"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"storageopt",children:"StorageOpt?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"StorageOpt"}),": ",(0,i.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"index-signature",children:"Index signature"}),"\n",(0,i.jsxs)(n.p,{children:["[",(0,i.jsx)(n.code,{children:"option"}),": ",(0,i.jsx)(n.code,{children:"string"}),"]: ",(0,i.jsx)(n.code,{children:"string"})]}),"\n",(0,i.jsx)(n.h4,{id:"source-59",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2158",children:"packages/extension-api/src/extension-api.d.ts:2158"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"sysctls",children:"Sysctls?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"Sysctls"}),": ",(0,i.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"index-signature-1",children:"Index signature"}),"\n",(0,i.jsxs)(n.p,{children:["[",(0,i.jsx)(n.code,{children:"index"}),": ",(0,i.jsx)(n.code,{children:"string"}),"]: ",(0,i.jsx)(n.code,{children:"string"})]}),"\n",(0,i.jsx)(n.h4,{id:"source-60",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2163",children:"packages/extension-api/src/extension-api.d.ts:2163"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"tmpfs",children:"Tmpfs?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"Tmpfs"}),": ",(0,i.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"index-signature-2",children:"Index signature"}),"\n",(0,i.jsxs)(n.p,{children:["[",(0,i.jsx)(n.code,{children:"dir"}),": ",(0,i.jsx)(n.code,{children:"string"}),"]: ",(0,i.jsx)(n.code,{children:"string"})]}),"\n",(0,i.jsx)(n.h4,{id:"source-61",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2159",children:"packages/extension-api/src/extension-api.d.ts:2159"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"utsmode",children:"UTSMode?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"UTSMode"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-62",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2160",children:"packages/extension-api/src/extension-api.d.ts:2160"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"ulimits",children:"Ulimits?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"Ulimits"}),": ",(0,i.jsx)(n.code,{children:"unknown"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-63",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2194",children:"packages/extension-api/src/extension-api.d.ts:2194"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"usernsmode",children:"UsernsMode?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"UsernsMode"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-64",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2161",children:"packages/extension-api/src/extension-api.d.ts:2161"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"volumedriver",children:"VolumeDriver?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"VolumeDriver"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-65",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2139",children:"packages/extension-api/src/extension-api.d.ts:2139"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"volumesfrom",children:"VolumesFrom?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"optional"})})," ",(0,i.jsx)(n.strong,{children:"VolumesFrom"}),": ",(0,i.jsx)(n.code,{children:"unknown"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-66",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L2140",children:"packages/extension-api/src/extension-api.d.ts:2140"})})]})}function a(e={}){const{wrapper:n}={...(0,c.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(h,{...e})}):h(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>d,a:()=>r});var i=s(27378);const c={},o=i.createContext(c);function r(e){const n=i.useContext(o);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function d(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(c):e.components||c:r(e.components),i.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/fbfd390f.beb7dad5.js b/assets/js/fbfd390f.9219e308.js similarity index 86% rename from assets/js/fbfd390f.beb7dad5.js rename to assets/js/fbfd390f.9219e308.js index 92f51b10f52..1ed45324b9a 100644 --- a/assets/js/fbfd390f.beb7dad5.js +++ b/assets/js/fbfd390f.9219e308.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[95921],{83930:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>a,contentTitle:()=>c,default:()=>l,frontMatter:()=>i,metadata:()=>o,toc:()=>d});var r=n(24246),s=n(71670);const i={},c="Interface: AuditResult",o={id:"interfaces/AuditResult",title:"Interface: AuditResult",description:"Properties",source:"@site/api/interfaces/AuditResult.md",sourceDirName:"interfaces",slug:"/interfaces/AuditResult",permalink:"/api/interfaces/AuditResult",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: AuditRequestItems",permalink:"/api/interfaces/AuditRequestItems"},next:{title:"Interface: Auditor",permalink:"/api/interfaces/Auditor"}},a={},d=[{value:"Properties",id:"properties",level:2},{value:"records",id:"records",level:3},{value:"Source",id:"source",level:4}];function u(e){const t={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(t.h1,{id:"interface-auditresult",children:"Interface: AuditResult"}),"\n",(0,r.jsx)(t.h2,{id:"properties",children:"Properties"}),"\n",(0,r.jsx)(t.h3,{id:"records",children:"records"}),"\n",(0,r.jsxs)(t.blockquote,{children:["\n",(0,r.jsxs)(t.p,{children:[(0,r.jsx)(t.strong,{children:"records"}),": ",(0,r.jsx)(t.a,{href:"/api/interfaces/AuditRecord",children:(0,r.jsx)(t.code,{children:"AuditRecord"})}),"[]"]}),"\n"]}),"\n",(0,r.jsx)(t.h4,{id:"source",children:"Source"}),"\n",(0,r.jsx)(t.p,{children:(0,r.jsx)(t.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L338",children:"packages/extension-api/src/extension-api.d.ts:338"})})]})}function l(e={}){const{wrapper:t}={...(0,s.a)(),...e.components};return t?(0,r.jsx)(t,{...e,children:(0,r.jsx)(u,{...e})}):u(e)}},71670:(e,t,n)=>{n.d(t,{Z:()=>o,a:()=>c});var r=n(27378);const s={},i=r.createContext(s);function c(e){const t=r.useContext(i);return r.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function o(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:c(e.components),r.createElement(i.Provider,{value:t},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[95921],{83930:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>d,contentTitle:()=>c,default:()=>l,frontMatter:()=>i,metadata:()=>o,toc:()=>a});var r=n(24246),s=n(71670);const i={},c="Interface: AuditResult",o={id:"interfaces/AuditResult",title:"Interface: AuditResult",description:"Properties",source:"@site/api/interfaces/AuditResult.md",sourceDirName:"interfaces",slug:"/interfaces/AuditResult",permalink:"/api/interfaces/AuditResult",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: AuditRequestItems",permalink:"/api/interfaces/AuditRequestItems"},next:{title:"Interface: Auditor",permalink:"/api/interfaces/Auditor"}},d={},a=[{value:"Properties",id:"properties",level:2},{value:"records",id:"records",level:3},{value:"Source",id:"source",level:4}];function u(e){const t={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(t.h1,{id:"interface-auditresult",children:"Interface: AuditResult"}),"\n",(0,r.jsx)(t.h2,{id:"properties",children:"Properties"}),"\n",(0,r.jsx)(t.h3,{id:"records",children:"records"}),"\n",(0,r.jsxs)(t.blockquote,{children:["\n",(0,r.jsxs)(t.p,{children:[(0,r.jsx)(t.strong,{children:"records"}),": ",(0,r.jsx)(t.a,{href:"/api/interfaces/AuditRecord",children:(0,r.jsx)(t.code,{children:"AuditRecord"})}),"[]"]}),"\n"]}),"\n",(0,r.jsx)(t.h4,{id:"source",children:"Source"}),"\n",(0,r.jsx)(t.p,{children:(0,r.jsx)(t.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L338",children:"packages/extension-api/src/extension-api.d.ts:338"})})]})}function l(e={}){const{wrapper:t}={...(0,s.a)(),...e.components};return t?(0,r.jsx)(t,{...e,children:(0,r.jsx)(u,{...e})}):u(e)}},71670:(e,t,n)=>{n.d(t,{Z:()=>o,a:()=>c});var r=n(27378);const s={},i=r.createContext(s);function c(e){const t=r.useContext(i);return r.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function o(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:c(e.components),r.createElement(i.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/fc923f19.cfe1fa4b.js b/assets/js/fc923f19.c804119f.js similarity index 79% rename from assets/js/fc923f19.cfe1fa4b.js rename to assets/js/fc923f19.c804119f.js index 9fe0c567d99..f34836d0c12 100644 --- a/assets/js/fc923f19.cfe1fa4b.js +++ b/assets/js/fc923f19.c804119f.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[73177],{84974:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>a,contentTitle:()=>t,default:()=>h,frontMatter:()=>i,metadata:()=>o,toc:()=>d});var r=s(24246),c=s(71670);const i={},t="Interface: ImageCheck",o={id:"interfaces/ImageCheck",title:"Interface: ImageCheck",description:"a specific error/recommendation found during an image check",source:"@site/api/interfaces/ImageCheck.md",sourceDirName:"interfaces",slug:"/interfaces/ImageCheck",permalink:"/api/interfaces/ImageCheck",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: IPAM",permalink:"/api/interfaces/IPAM"},next:{title:"Interface: ImageCheckerProvider",permalink:"/api/interfaces/ImageCheckerProvider"}},a={},d=[{value:"Properties",id:"properties",level:2},{value:"markdownDescription?",id:"markdowndescription",level:3},{value:"Source",id:"source",level:4},{value:"name",id:"name",level:3},{value:"Source",id:"source-1",level:4},{value:"severity?",id:"severity",level:3},{value:"Source",id:"source-2",level:4},{value:"status",id:"status",level:3},{value:"Source",id:"source-3",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,c.a)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.h1,{id:"interface-imagecheck",children:"Interface: ImageCheck"}),"\n",(0,r.jsx)(n.p,{children:"a specific error/recommendation found during an image check"}),"\n",(0,r.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,r.jsx)(n.h3,{id:"markdowndescription",children:"markdownDescription?"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"optional"})})," ",(0,r.jsx)(n.strong,{children:"markdownDescription"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"full description of the error/recommendation"}),"\n",(0,r.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L4086",children:"packages/extension-api/src/extension-api.d.ts:4086"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"name",children:"name"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"name"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"a short and descriptive name for the error/recommendation"}),"\n",(0,r.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L4074",children:"packages/extension-api/src/extension-api.d.ts:4074"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"severity",children:"severity?"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"optional"})})," ",(0,r.jsx)(n.strong,{children:"severity"}),": ",(0,r.jsx)(n.code,{children:'"high"'})," | ",(0,r.jsx)(n.code,{children:'"low"'})," | ",(0,r.jsx)(n.code,{children:'"medium"'})," | ",(0,r.jsx)(n.code,{children:'"critical"'})]}),"\n"]}),"\n",(0,r.jsxs)(n.p,{children:["severity of the error/recommendation, when the status is ",(0,r.jsx)(n.code,{children:"failed"})]}),"\n",(0,r.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L4082",children:"packages/extension-api/src/extension-api.d.ts:4082"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"status",children:"status"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"status"}),": ",(0,r.jsx)(n.code,{children:'"failed"'})," | ",(0,r.jsx)(n.code,{children:'"success"'})]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"either the feedback is positive or negative"}),"\n",(0,r.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L4078",children:"packages/extension-api/src/extension-api.d.ts:4078"})})]})}function h(e={}){const{wrapper:n}={...(0,c.a)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(l,{...e})}):l(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>o,a:()=>t});var r=s(27378);const c={},i=r.createContext(c);function t(e){const n=r.useContext(i);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(c):e.components||c:t(e.components),r.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[73177],{84974:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>d,contentTitle:()=>t,default:()=>h,frontMatter:()=>c,metadata:()=>o,toc:()=>a});var r=s(24246),i=s(71670);const c={},t="Interface: ImageCheck",o={id:"interfaces/ImageCheck",title:"Interface: ImageCheck",description:"a specific error/recommendation found during an image check",source:"@site/api/interfaces/ImageCheck.md",sourceDirName:"interfaces",slug:"/interfaces/ImageCheck",permalink:"/api/interfaces/ImageCheck",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: IPAM",permalink:"/api/interfaces/IPAM"},next:{title:"Interface: ImageCheckerProvider",permalink:"/api/interfaces/ImageCheckerProvider"}},d={},a=[{value:"Properties",id:"properties",level:2},{value:"markdownDescription?",id:"markdowndescription",level:3},{value:"Source",id:"source",level:4},{value:"name",id:"name",level:3},{value:"Source",id:"source-1",level:4},{value:"severity?",id:"severity",level:3},{value:"Source",id:"source-2",level:4},{value:"status",id:"status",level:3},{value:"Source",id:"source-3",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,i.a)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.h1,{id:"interface-imagecheck",children:"Interface: ImageCheck"}),"\n",(0,r.jsx)(n.p,{children:"a specific error/recommendation found during an image check"}),"\n",(0,r.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,r.jsx)(n.h3,{id:"markdowndescription",children:"markdownDescription?"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"optional"})})," ",(0,r.jsx)(n.strong,{children:"markdownDescription"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"full description of the error/recommendation"}),"\n",(0,r.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L4086",children:"packages/extension-api/src/extension-api.d.ts:4086"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"name",children:"name"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"name"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"a short and descriptive name for the error/recommendation"}),"\n",(0,r.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L4074",children:"packages/extension-api/src/extension-api.d.ts:4074"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"severity",children:"severity?"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"optional"})})," ",(0,r.jsx)(n.strong,{children:"severity"}),": ",(0,r.jsx)(n.code,{children:'"high"'})," | ",(0,r.jsx)(n.code,{children:'"low"'})," | ",(0,r.jsx)(n.code,{children:'"medium"'})," | ",(0,r.jsx)(n.code,{children:'"critical"'})]}),"\n"]}),"\n",(0,r.jsxs)(n.p,{children:["severity of the error/recommendation, when the status is ",(0,r.jsx)(n.code,{children:"failed"})]}),"\n",(0,r.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L4082",children:"packages/extension-api/src/extension-api.d.ts:4082"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"status",children:"status"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"status"}),": ",(0,r.jsx)(n.code,{children:'"failed"'})," | ",(0,r.jsx)(n.code,{children:'"success"'})]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"either the feedback is positive or negative"}),"\n",(0,r.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L4078",children:"packages/extension-api/src/extension-api.d.ts:4078"})})]})}function h(e={}){const{wrapper:n}={...(0,i.a)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(l,{...e})}):l(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>o,a:()=>t});var r=s(27378);const i={},c=r.createContext(i);function t(e){const n=r.useContext(c);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:t(e.components),r.createElement(c.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/fd702dc7.31ea96ca.js b/assets/js/fd702dc7.3ba9d8f5.js similarity index 95% rename from assets/js/fd702dc7.31ea96ca.js rename to assets/js/fd702dc7.3ba9d8f5.js index 0d3c44308fd..3716c31a446 100644 --- a/assets/js/fd702dc7.31ea96ca.js +++ b/assets/js/fd702dc7.3ba9d8f5.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[57694],{81583:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>i,default:()=>p,frontMatter:()=>r,metadata:()=>c,toc:()=>l});var s=t(24246),o=t(71670);const r={},i="Interface: WebviewOptions",c={id:"interfaces/WebviewOptions",title:"Interface: WebviewOptions",description:"Content settings for a webview.",source:"@site/api/interfaces/WebviewOptions.md",sourceDirName:"interfaces",slug:"/interfaces/WebviewOptions",permalink:"/api/interfaces/WebviewOptions",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: WebviewInfo",permalink:"/api/interfaces/WebviewInfo"},next:{title:"Interface: WebviewPanel",permalink:"/api/interfaces/WebviewPanel"}},a={},l=[{value:"Properties",id:"properties",level:2},{value:"localResourceRoots?",id:"localresourceroots",level:3},{value:"Source",id:"source",level:4}];function d(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",p:"p",strong:"strong",...(0,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.strong,{children:(0,s.jsx)(n.code,{children:"optional"})})," ",(0,s.jsx)(n.strong,{children:(0,s.jsx)(n.code,{children:"readonly"})})," ",(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:"source",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L1391",children:"packages/extension-api/src/extension-api.d.ts:1391"})})]})}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:()=>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([[57694],{81583:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>i,default:()=>p,frontMatter:()=>r,metadata:()=>c,toc:()=>l});var s=t(24246),o=t(71670);const r={},i="Interface: WebviewOptions",c={id:"interfaces/WebviewOptions",title:"Interface: WebviewOptions",description:"Content settings for a webview.",source:"@site/api/interfaces/WebviewOptions.md",sourceDirName:"interfaces",slug:"/interfaces/WebviewOptions",permalink:"/api/interfaces/WebviewOptions",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: WebviewInfo",permalink:"/api/interfaces/WebviewInfo"},next:{title:"Interface: WebviewPanel",permalink:"/api/interfaces/WebviewPanel"}},a={},l=[{value:"Properties",id:"properties",level:2},{value:"localResourceRoots?",id:"localresourceroots",level:3},{value:"Source",id:"source",level:4}];function d(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",p:"p",strong:"strong",...(0,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.strong,{children:(0,s.jsx)(n.code,{children:"optional"})})," ",(0,s.jsx)(n.strong,{children:(0,s.jsx)(n.code,{children:"readonly"})})," ",(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:"source",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L1391",children:"packages/extension-api/src/extension-api.d.ts:1391"})})]})}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:()=>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/fe1a05e2.e35c611b.js b/assets/js/fe1a05e2.7e1fe783.js similarity index 98% rename from assets/js/fe1a05e2.e35c611b.js rename to assets/js/fe1a05e2.7e1fe783.js index f64aa5d4a2d..fcc23b7b6a2 100644 --- a/assets/js/fe1a05e2.e35c611b.js +++ b/assets/js/fe1a05e2.7e1fe783.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[70900],{22826:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>a,contentTitle:()=>o,default:()=>p,frontMatter:()=>i,metadata:()=>c,toc:()=>d});var t=r(24246),s=r(71670);const i={},o="Function: registerProviderMenuItem()",c={id:"namespaces/tray/functions/registerProviderMenuItem",title:"Function: registerProviderMenuItem()",description:"registerProviderMenuItem(providerId, item): Disposable",source:"@site/api/namespaces/tray/functions/registerProviderMenuItem.md",sourceDirName:"namespaces/tray/functions",slug:"/namespaces/tray/functions/registerProviderMenuItem",permalink:"/api/namespaces/tray/functions/registerProviderMenuItem",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Function: registerMenuItem()",permalink:"/api/namespaces/tray/functions/registerMenuItem"},next:{title:"Namespace: window",permalink:"/api/namespaces/window/"}},a={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function u(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"function-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:"source",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L647",children:"packages/extension-api/src/extension-api.d.ts:647"})})]})}function p(e={}){const{wrapper:n}={...(0,s.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(u,{...e})}):u(e)}},71670:(e,n,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([[70900],{22826:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>a,contentTitle:()=>o,default:()=>p,frontMatter:()=>i,metadata:()=>c,toc:()=>d});var t=r(24246),s=r(71670);const i={},o="Function: registerProviderMenuItem()",c={id:"namespaces/tray/functions/registerProviderMenuItem",title:"Function: registerProviderMenuItem()",description:"registerProviderMenuItem(providerId, item): Disposable",source:"@site/api/namespaces/tray/functions/registerProviderMenuItem.md",sourceDirName:"namespaces/tray/functions",slug:"/namespaces/tray/functions/registerProviderMenuItem",permalink:"/api/namespaces/tray/functions/registerProviderMenuItem",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Function: registerMenuItem()",permalink:"/api/namespaces/tray/functions/registerMenuItem"},next:{title:"Namespace: window",permalink:"/api/namespaces/window/"}},a={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function u(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"function-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:"source",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L647",children:"packages/extension-api/src/extension-api.d.ts:647"})})]})}function p(e={}){const{wrapper:n}={...(0,s.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(u,{...e})}):u(e)}},71670:(e,n,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/fe716911.946349dd.js b/assets/js/fe716911.7099efb4.js similarity index 90% rename from assets/js/fe716911.946349dd.js rename to assets/js/fe716911.7099efb4.js index 8cd09c32d51..e87a0390c35 100644 --- a/assets/js/fe716911.946349dd.js +++ b/assets/js/fe716911.7099efb4.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[33940],{36151:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>d,contentTitle:()=>r,default:()=>h,frontMatter:()=>o,metadata:()=>t,toc:()=>l});var c=s(24246),i=s(71670);const o={},r="Interface: CheckResult",t={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:"Interface: CancellationToken",permalink:"/api/interfaces/CancellationToken"},next:{title:"Interface: CheckResultFixCommand",permalink:"/api/interfaces/CheckResultFixCommand"}},d={},l=[{value:"Properties",id:"properties",level:2},{value:"description?",id:"description",level:3},{value:"Source",id:"source",level:4},{value:"docLinks?",id:"doclinks",level:3},{value:"Source",id:"source-1",level:4},{value:"docLinksDescription?",id:"doclinksdescription",level:3},{value:"Source",id:"source-2",level:4},{value:"fixCommand?",id:"fixcommand",level:3},{value:"Source",id:"source-3",level:4},{value:"successful",id:"successful",level:3},{value:"Source",id:"source-4",level:4}];function a(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,i.a)(),...e.components};return(0,c.jsxs)(c.Fragment,{children:[(0,c.jsx)(n.h1,{id:"interface-checkresult",children:"Interface: CheckResult"}),"\n",(0,c.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,c.jsx)(n.h3,{id:"description",children:"description?"}),"\n",(0,c.jsxs)(n.blockquote,{children:["\n",(0,c.jsxs)(n.p,{children:[(0,c.jsx)(n.strong,{children:(0,c.jsx)(n.code,{children:"optional"})})," ",(0,c.jsx)(n.strong,{children:"description"}),": ",(0,c.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,c.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,c.jsx)(n.p,{children:(0,c.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L364",children:"packages/extension-api/src/extension-api.d.ts:364"})}),"\n",(0,c.jsx)(n.hr,{}),"\n",(0,c.jsx)(n.h3,{id:"doclinks",children:"docLinks?"}),"\n",(0,c.jsxs)(n.blockquote,{children:["\n",(0,c.jsxs)(n.p,{children:[(0,c.jsx)(n.strong,{children:(0,c.jsx)(n.code,{children:"optional"})})," ",(0,c.jsx)(n.strong,{children:"docLinks"}),": ",(0,c.jsx)(n.a,{href:"/api/interfaces/Link",children:(0,c.jsx)(n.code,{children:"Link"})}),"[]"]}),"\n"]}),"\n",(0,c.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,c.jsx)(n.p,{children:(0,c.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L366",children:"packages/extension-api/src/extension-api.d.ts:366"})}),"\n",(0,c.jsx)(n.hr,{}),"\n",(0,c.jsx)(n.h3,{id:"doclinksdescription",children:"docLinksDescription?"}),"\n",(0,c.jsxs)(n.blockquote,{children:["\n",(0,c.jsxs)(n.p,{children:[(0,c.jsx)(n.strong,{children:(0,c.jsx)(n.code,{children:"optional"})})," ",(0,c.jsx)(n.strong,{children:"docLinksDescription"}),": ",(0,c.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,c.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,c.jsx)(n.p,{children:(0,c.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L365",children:"packages/extension-api/src/extension-api.d.ts:365"})}),"\n",(0,c.jsx)(n.hr,{}),"\n",(0,c.jsx)(n.h3,{id:"fixcommand",children:"fixCommand?"}),"\n",(0,c.jsxs)(n.blockquote,{children:["\n",(0,c.jsxs)(n.p,{children:[(0,c.jsx)(n.strong,{children:(0,c.jsx)(n.code,{children:"optional"})})," ",(0,c.jsx)(n.strong,{children:"fixCommand"}),": ",(0,c.jsx)(n.a,{href:"/api/interfaces/CheckResultFixCommand",children:(0,c.jsx)(n.code,{children:"CheckResultFixCommand"})})]}),"\n"]}),"\n",(0,c.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,c.jsx)(n.p,{children:(0,c.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L367",children:"packages/extension-api/src/extension-api.d.ts:367"})}),"\n",(0,c.jsx)(n.hr,{}),"\n",(0,c.jsx)(n.h3,{id:"successful",children:"successful"}),"\n",(0,c.jsxs)(n.blockquote,{children:["\n",(0,c.jsxs)(n.p,{children:[(0,c.jsx)(n.strong,{children:"successful"}),": ",(0,c.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,c.jsx)(n.h4,{id:"source-4",children:"Source"}),"\n",(0,c.jsx)(n.p,{children:(0,c.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L363",children:"packages/extension-api/src/extension-api.d.ts:363"})})]})}function h(e={}){const{wrapper:n}={...(0,i.a)(),...e.components};return n?(0,c.jsx)(n,{...e,children:(0,c.jsx)(a,{...e})}):a(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>t,a:()=>r});var c=s(27378);const i={},o=c.createContext(i);function r(e){const n=c.useContext(o);return c.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function t(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:r(e.components),c.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[33940],{36151:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>d,contentTitle:()=>r,default:()=>h,frontMatter:()=>o,metadata:()=>t,toc:()=>l});var c=s(24246),i=s(71670);const o={},r="Interface: CheckResult",t={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:"Interface: CancellationToken",permalink:"/api/interfaces/CancellationToken"},next:{title:"Interface: CheckResultFixCommand",permalink:"/api/interfaces/CheckResultFixCommand"}},d={},l=[{value:"Properties",id:"properties",level:2},{value:"description?",id:"description",level:3},{value:"Source",id:"source",level:4},{value:"docLinks?",id:"doclinks",level:3},{value:"Source",id:"source-1",level:4},{value:"docLinksDescription?",id:"doclinksdescription",level:3},{value:"Source",id:"source-2",level:4},{value:"fixCommand?",id:"fixcommand",level:3},{value:"Source",id:"source-3",level:4},{value:"successful",id:"successful",level:3},{value:"Source",id:"source-4",level:4}];function a(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,i.a)(),...e.components};return(0,c.jsxs)(c.Fragment,{children:[(0,c.jsx)(n.h1,{id:"interface-checkresult",children:"Interface: CheckResult"}),"\n",(0,c.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,c.jsx)(n.h3,{id:"description",children:"description?"}),"\n",(0,c.jsxs)(n.blockquote,{children:["\n",(0,c.jsxs)(n.p,{children:[(0,c.jsx)(n.strong,{children:(0,c.jsx)(n.code,{children:"optional"})})," ",(0,c.jsx)(n.strong,{children:"description"}),": ",(0,c.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,c.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,c.jsx)(n.p,{children:(0,c.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L364",children:"packages/extension-api/src/extension-api.d.ts:364"})}),"\n",(0,c.jsx)(n.hr,{}),"\n",(0,c.jsx)(n.h3,{id:"doclinks",children:"docLinks?"}),"\n",(0,c.jsxs)(n.blockquote,{children:["\n",(0,c.jsxs)(n.p,{children:[(0,c.jsx)(n.strong,{children:(0,c.jsx)(n.code,{children:"optional"})})," ",(0,c.jsx)(n.strong,{children:"docLinks"}),": ",(0,c.jsx)(n.a,{href:"/api/interfaces/Link",children:(0,c.jsx)(n.code,{children:"Link"})}),"[]"]}),"\n"]}),"\n",(0,c.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,c.jsx)(n.p,{children:(0,c.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L366",children:"packages/extension-api/src/extension-api.d.ts:366"})}),"\n",(0,c.jsx)(n.hr,{}),"\n",(0,c.jsx)(n.h3,{id:"doclinksdescription",children:"docLinksDescription?"}),"\n",(0,c.jsxs)(n.blockquote,{children:["\n",(0,c.jsxs)(n.p,{children:[(0,c.jsx)(n.strong,{children:(0,c.jsx)(n.code,{children:"optional"})})," ",(0,c.jsx)(n.strong,{children:"docLinksDescription"}),": ",(0,c.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,c.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,c.jsx)(n.p,{children:(0,c.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L365",children:"packages/extension-api/src/extension-api.d.ts:365"})}),"\n",(0,c.jsx)(n.hr,{}),"\n",(0,c.jsx)(n.h3,{id:"fixcommand",children:"fixCommand?"}),"\n",(0,c.jsxs)(n.blockquote,{children:["\n",(0,c.jsxs)(n.p,{children:[(0,c.jsx)(n.strong,{children:(0,c.jsx)(n.code,{children:"optional"})})," ",(0,c.jsx)(n.strong,{children:"fixCommand"}),": ",(0,c.jsx)(n.a,{href:"/api/interfaces/CheckResultFixCommand",children:(0,c.jsx)(n.code,{children:"CheckResultFixCommand"})})]}),"\n"]}),"\n",(0,c.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,c.jsx)(n.p,{children:(0,c.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L367",children:"packages/extension-api/src/extension-api.d.ts:367"})}),"\n",(0,c.jsx)(n.hr,{}),"\n",(0,c.jsx)(n.h3,{id:"successful",children:"successful"}),"\n",(0,c.jsxs)(n.blockquote,{children:["\n",(0,c.jsxs)(n.p,{children:[(0,c.jsx)(n.strong,{children:"successful"}),": ",(0,c.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,c.jsx)(n.h4,{id:"source-4",children:"Source"}),"\n",(0,c.jsx)(n.p,{children:(0,c.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L363",children:"packages/extension-api/src/extension-api.d.ts:363"})})]})}function h(e={}){const{wrapper:n}={...(0,i.a)(),...e.components};return n?(0,c.jsx)(n,{...e,children:(0,c.jsx)(a,{...e})}):a(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>t,a:()=>r});var c=s(27378);const i={},o=c.createContext(i);function r(e){const n=c.useContext(o);return c.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function t(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:r(e.components),c.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/fee0a0be.22163b57.js b/assets/js/fee0a0be.9c93ed65.js similarity index 80% rename from assets/js/fee0a0be.22163b57.js rename to assets/js/fee0a0be.9c93ed65.js index 28032409670..9c5c55e6602 100644 --- a/assets/js/fee0a0be.22163b57.js +++ b/assets/js/fee0a0be.9c93ed65.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[81580],{97294:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>d,contentTitle:()=>o,default:()=>h,frontMatter:()=>r,metadata:()=>t,toc:()=>a});var s=i(24246),c=i(71670);const r={},o="Interface: ContainerEngineInfo",t={id:"interfaces/ContainerEngineInfo",title:"Interface: ContainerEngineInfo",description:"Resources information about a container engine",source:"@site/api/interfaces/ContainerEngineInfo.md",sourceDirName:"interfaces",slug:"/interfaces/ContainerEngineInfo",permalink:"/api/interfaces/ContainerEngineInfo",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: ContainerCreateResult",permalink:"/api/interfaces/ContainerCreateResult"},next:{title:"Interface: ContainerInfo",permalink:"/api/interfaces/ContainerInfo"}},d={},a=[{value:"Properties",id:"properties",level:2},{value:"cpuIdle?",id:"cpuidle",level:3},{value:"Source",id:"source",level:4},{value:"cpus?",id:"cpus",level:3},{value:"Source",id:"source-1",level:4},{value:"diskSize?",id:"disksize",level:3},{value:"Source",id:"source-2",level:4},{value:"diskUsed?",id:"diskused",level:3},{value:"Source",id:"source-3",level:4},{value:"engineId",id:"engineid",level:3},{value:"Source",id:"source-4",level:4},{value:"engineName",id:"enginename",level:3},{value:"Source",id:"source-5",level:4},{value:"engineType",id:"enginetype",level:3},{value:"Source",id:"source-6",level:4},{value:"memory?",id:"memory",level:3},{value:"Source",id:"source-7",level:4},{value:"memoryUsed?",id:"memoryused",level:3},{value:"Source",id:"source-8",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,c.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"interface-containerengineinfo",children:"Interface: ContainerEngineInfo"}),"\n",(0,s.jsx)(n.p,{children:"Resources information about a container engine"}),"\n",(0,s.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,s.jsx)(n.h3,{id:"cpuidle",children:"cpuIdle?"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:(0,s.jsx)(n.code,{children:"optional"})})," ",(0,s.jsx)(n.strong,{children:"cpuIdle"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Percentage of idle CPUs (for Podman engines only)"}),"\n",(0,s.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L3076",children:"packages/extension-api/src/extension-api.d.ts:3076"})}),"\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.strong,{children:(0,s.jsx)(n.code,{children:"optional"})})," ",(0,s.jsx)(n.strong,{children:"cpus"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"number of CPUs available for the container engine"}),"\n",(0,s.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L3072",children:"packages/extension-api/src/extension-api.d.ts:3072"})}),"\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.strong,{children:(0,s.jsx)(n.code,{children:"optional"})})," ",(0,s.jsx)(n.strong,{children:"diskSize"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Quantity of disk space available for the container engine (for Podman engines only)"}),"\n",(0,s.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L3088",children:"packages/extension-api/src/extension-api.d.ts:3088"})}),"\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.strong,{children:(0,s.jsx)(n.code,{children:"optional"})})," ",(0,s.jsx)(n.strong,{children:"diskUsed"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Quantity of disk space used by the container engine (for Podman engines only)"}),"\n",(0,s.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L3092",children:"packages/extension-api/src/extension-api.d.ts:3092"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"engineid",children:"engineId"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"engineId"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"unique id identifying the container engine"}),"\n",(0,s.jsx)(n.h4,{id:"source-4",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L3060",children:"packages/extension-api/src/extension-api.d.ts:3060"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"enginename",children:"engineName"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"engineName"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"name of the container engine"}),"\n",(0,s.jsx)(n.h4,{id:"source-5",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L3064",children:"packages/extension-api/src/extension-api.d.ts:3064"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"enginetype",children:"engineType"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"engineType"}),": ",(0,s.jsx)(n.code,{children:'"docker"'})," | ",(0,s.jsx)(n.code,{children:'"podman"'})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"engine type, either 'podman' or 'docker'"}),"\n",(0,s.jsx)(n.h4,{id:"source-6",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L3068",children:"packages/extension-api/src/extension-api.d.ts:3068"})}),"\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.strong,{children:(0,s.jsx)(n.code,{children:"optional"})})," ",(0,s.jsx)(n.strong,{children:"memory"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Quantity of memory available for the container engine"}),"\n",(0,s.jsx)(n.h4,{id:"source-7",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L3080",children:"packages/extension-api/src/extension-api.d.ts:3080"})}),"\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.strong,{children:(0,s.jsx)(n.code,{children:"optional"})})," ",(0,s.jsx)(n.strong,{children:"memoryUsed"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Quantity of memory used by the container engine (for Podman engines only)"}),"\n",(0,s.jsx)(n.h4,{id:"source-8",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L3084",children:"packages/extension-api/src/extension-api.d.ts:3084"})})]})}function h(e={}){const{wrapper:n}={...(0,c.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>t,a:()=>o});var s=i(27378);const c={},r=s.createContext(c);function o(e){const n=s.useContext(r);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function t(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(c):e.components||c:o(e.components),s.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[81580],{97294:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>t,contentTitle:()=>o,default:()=>h,frontMatter:()=>c,metadata:()=>d,toc:()=>a});var s=i(24246),r=i(71670);const c={},o="Interface: ContainerEngineInfo",d={id:"interfaces/ContainerEngineInfo",title:"Interface: ContainerEngineInfo",description:"Resources information about a container engine",source:"@site/api/interfaces/ContainerEngineInfo.md",sourceDirName:"interfaces",slug:"/interfaces/ContainerEngineInfo",permalink:"/api/interfaces/ContainerEngineInfo",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: ContainerCreateResult",permalink:"/api/interfaces/ContainerCreateResult"},next:{title:"Interface: ContainerInfo",permalink:"/api/interfaces/ContainerInfo"}},t={},a=[{value:"Properties",id:"properties",level:2},{value:"cpuIdle?",id:"cpuidle",level:3},{value:"Source",id:"source",level:4},{value:"cpus?",id:"cpus",level:3},{value:"Source",id:"source-1",level:4},{value:"diskSize?",id:"disksize",level:3},{value:"Source",id:"source-2",level:4},{value:"diskUsed?",id:"diskused",level:3},{value:"Source",id:"source-3",level:4},{value:"engineId",id:"engineid",level:3},{value:"Source",id:"source-4",level:4},{value:"engineName",id:"enginename",level:3},{value:"Source",id:"source-5",level:4},{value:"engineType",id:"enginetype",level:3},{value:"Source",id:"source-6",level:4},{value:"memory?",id:"memory",level:3},{value:"Source",id:"source-7",level:4},{value:"memoryUsed?",id:"memoryused",level:3},{value:"Source",id:"source-8",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,r.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"interface-containerengineinfo",children:"Interface: ContainerEngineInfo"}),"\n",(0,s.jsx)(n.p,{children:"Resources information about a container engine"}),"\n",(0,s.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,s.jsx)(n.h3,{id:"cpuidle",children:"cpuIdle?"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:(0,s.jsx)(n.code,{children:"optional"})})," ",(0,s.jsx)(n.strong,{children:"cpuIdle"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Percentage of idle CPUs (for Podman engines only)"}),"\n",(0,s.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L3076",children:"packages/extension-api/src/extension-api.d.ts:3076"})}),"\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.strong,{children:(0,s.jsx)(n.code,{children:"optional"})})," ",(0,s.jsx)(n.strong,{children:"cpus"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"number of CPUs available for the container engine"}),"\n",(0,s.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L3072",children:"packages/extension-api/src/extension-api.d.ts:3072"})}),"\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.strong,{children:(0,s.jsx)(n.code,{children:"optional"})})," ",(0,s.jsx)(n.strong,{children:"diskSize"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Quantity of disk space available for the container engine (for Podman engines only)"}),"\n",(0,s.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L3088",children:"packages/extension-api/src/extension-api.d.ts:3088"})}),"\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.strong,{children:(0,s.jsx)(n.code,{children:"optional"})})," ",(0,s.jsx)(n.strong,{children:"diskUsed"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Quantity of disk space used by the container engine (for Podman engines only)"}),"\n",(0,s.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L3092",children:"packages/extension-api/src/extension-api.d.ts:3092"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"engineid",children:"engineId"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"engineId"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"unique id identifying the container engine"}),"\n",(0,s.jsx)(n.h4,{id:"source-4",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L3060",children:"packages/extension-api/src/extension-api.d.ts:3060"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"enginename",children:"engineName"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"engineName"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"name of the container engine"}),"\n",(0,s.jsx)(n.h4,{id:"source-5",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L3064",children:"packages/extension-api/src/extension-api.d.ts:3064"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"enginetype",children:"engineType"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"engineType"}),": ",(0,s.jsx)(n.code,{children:'"docker"'})," | ",(0,s.jsx)(n.code,{children:'"podman"'})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"engine type, either 'podman' or 'docker'"}),"\n",(0,s.jsx)(n.h4,{id:"source-6",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L3068",children:"packages/extension-api/src/extension-api.d.ts:3068"})}),"\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.strong,{children:(0,s.jsx)(n.code,{children:"optional"})})," ",(0,s.jsx)(n.strong,{children:"memory"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Quantity of memory available for the container engine"}),"\n",(0,s.jsx)(n.h4,{id:"source-7",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L3080",children:"packages/extension-api/src/extension-api.d.ts:3080"})}),"\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.strong,{children:(0,s.jsx)(n.code,{children:"optional"})})," ",(0,s.jsx)(n.strong,{children:"memoryUsed"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Quantity of memory used by the container engine (for Podman engines only)"}),"\n",(0,s.jsx)(n.h4,{id:"source-8",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L3084",children:"packages/extension-api/src/extension-api.d.ts:3084"})})]})}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:()=>o});var s=i(27378);const r={},c=s.createContext(r);function o(e){const n=s.useContext(c);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function d(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:o(e.components),s.createElement(c.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/ff2f63f6.fde6fbda.js b/assets/js/ff2f63f6.50c9ef93.js similarity index 95% rename from assets/js/ff2f63f6.fde6fbda.js rename to assets/js/ff2f63f6.50c9ef93.js index 86107e5b93e..dbc3fcb56f7 100644 --- a/assets/js/ff2f63f6.fde6fbda.js +++ b/assets/js/ff2f63f6.50c9ef93.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[68097],{53251:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>i,contentTitle:()=>s,default:()=>l,frontMatter:()=>c,metadata:()=>o,toc:()=>d});var r=n(24246),a=n(71670);const c={},s="Interface: SecretStorageChangeEvent",o={id:"interfaces/SecretStorageChangeEvent",title:"Interface: SecretStorageChangeEvent",description:"The event data that is fired when a secret is added or removed.",source:"@site/api/interfaces/SecretStorageChangeEvent.md",sourceDirName:"interfaces",slug:"/interfaces/SecretStorageChangeEvent",permalink:"/api/interfaces/SecretStorageChangeEvent",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: SecretStorage",permalink:"/api/interfaces/SecretStorage"},next:{title:"Interface: StatusBarItem",permalink:"/api/interfaces/StatusBarItem"}},i={},d=[{value:"Properties",id:"properties",level:2},{value:"key",id:"key",level:3},{value:"Source",id:"source",level:4}];function h(e){const t={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",p:"p",strong:"strong",...(0,a.a)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(t.h1,{id:"interface-secretstoragechangeevent",children:"Interface: SecretStorageChangeEvent"}),"\n",(0,r.jsx)(t.p,{children:"The event data that is fired when a secret is added or removed."}),"\n",(0,r.jsx)(t.h2,{id:"properties",children:"Properties"}),"\n",(0,r.jsx)(t.h3,{id:"key",children:"key"}),"\n",(0,r.jsxs)(t.blockquote,{children:["\n",(0,r.jsxs)(t.p,{children:[(0,r.jsx)(t.strong,{children:(0,r.jsx)(t.code,{children:"readonly"})})," ",(0,r.jsx)(t.strong,{children:"key"}),": ",(0,r.jsx)(t.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(t.p,{children:"The key of the secret that has changed."}),"\n",(0,r.jsx)(t.h4,{id:"source",children:"Source"}),"\n",(0,r.jsx)(t.p,{children:(0,r.jsx)(t.a,{href:"https://github.com/containers/podman-desktop/blob/80a122cc91c7bb36b7952cee2eb11f9e816b3295/packages/extension-api/src/extension-api.d.ts#L4200",children:"packages/extension-api/src/extension-api.d.ts:4200"})})]})}function l(e={}){const{wrapper:t}={...(0,a.a)(),...e.components};return t?(0,r.jsx)(t,{...e,children:(0,r.jsx)(h,{...e})}):h(e)}},71670:(e,t,n)=>{n.d(t,{Z:()=>o,a:()=>s});var r=n(27378);const a={},c=r.createContext(a);function s(e){const t=r.useContext(c);return r.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function o(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(a):e.components||a:s(e.components),r.createElement(c.Provider,{value:t},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[68097],{53251:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>i,contentTitle:()=>s,default:()=>l,frontMatter:()=>c,metadata:()=>o,toc:()=>d});var r=n(24246),a=n(71670);const c={},s="Interface: SecretStorageChangeEvent",o={id:"interfaces/SecretStorageChangeEvent",title:"Interface: SecretStorageChangeEvent",description:"The event data that is fired when a secret is added or removed.",source:"@site/api/interfaces/SecretStorageChangeEvent.md",sourceDirName:"interfaces",slug:"/interfaces/SecretStorageChangeEvent",permalink:"/api/interfaces/SecretStorageChangeEvent",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Interface: SecretStorage",permalink:"/api/interfaces/SecretStorage"},next:{title:"Interface: StatusBarItem",permalink:"/api/interfaces/StatusBarItem"}},i={},d=[{value:"Properties",id:"properties",level:2},{value:"key",id:"key",level:3},{value:"Source",id:"source",level:4}];function h(e){const t={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",p:"p",strong:"strong",...(0,a.a)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(t.h1,{id:"interface-secretstoragechangeevent",children:"Interface: SecretStorageChangeEvent"}),"\n",(0,r.jsx)(t.p,{children:"The event data that is fired when a secret is added or removed."}),"\n",(0,r.jsx)(t.h2,{id:"properties",children:"Properties"}),"\n",(0,r.jsx)(t.h3,{id:"key",children:"key"}),"\n",(0,r.jsxs)(t.blockquote,{children:["\n",(0,r.jsxs)(t.p,{children:[(0,r.jsx)(t.strong,{children:(0,r.jsx)(t.code,{children:"readonly"})})," ",(0,r.jsx)(t.strong,{children:"key"}),": ",(0,r.jsx)(t.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(t.p,{children:"The key of the secret that has changed."}),"\n",(0,r.jsx)(t.h4,{id:"source",children:"Source"}),"\n",(0,r.jsx)(t.p,{children:(0,r.jsx)(t.a,{href:"https://github.com/containers/podman-desktop/blob/f068631650816dc547581dcfb6cd86714f5f90b2/packages/extension-api/src/extension-api.d.ts#L4200",children:"packages/extension-api/src/extension-api.d.ts:4200"})})]})}function l(e={}){const{wrapper:t}={...(0,a.a)(),...e.components};return t?(0,r.jsx)(t,{...e,children:(0,r.jsx)(h,{...e})}):h(e)}},71670:(e,t,n)=>{n.d(t,{Z:()=>o,a:()=>s});var r=n(27378);const a={},c=r.createContext(a);function s(e){const t=r.useContext(c);return r.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function o(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(a):e.components||a:s(e.components),r.createElement(c.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/runtime~main.2fed3aba.js b/assets/js/runtime~main.59037fa1.js similarity index 64% rename from assets/js/runtime~main.2fed3aba.js rename to assets/js/runtime~main.59037fa1.js index 26e5e757e5c..59f3a133bc7 100644 --- a/assets/js/runtime~main.2fed3aba.js +++ b/assets/js/runtime~main.59037fa1.js @@ -1 +1 @@ -(()=>{"use strict";var e,a,f,c,d,b={},r={};function t(e){var a=r[e];if(void 0!==a)return a.exports;var f=r[e]={exports:{}};return b[e].call(f.exports,f,f.exports,t),f.exports}t.m=b,e=[],t.O=(a,f,c,d)=>{if(!f){var b=1/0;for(n=0;n=d)&&Object.keys(t.O).every((e=>t.O[e](f[o])))?f.splice(o--,1):(r=!1,d0&&e[n-1][2]>d;n--)e[n]=e[n-1];e[n]=[f,c,d]},t.n=e=>{var a=e&&e.__esModule?()=>e.default:()=>e;return t.d(a,{a:a}),a},f=Object.getPrototypeOf?e=>Object.getPrototypeOf(e):e=>e.__proto__,t.t=function(e,c){if(1&c&&(e=this(e)),8&c)return e;if("object"==typeof e&&e){if(4&c&&e.__esModule)return e;if(16&c&&"function"==typeof e.then)return e}var d=Object.create(null);t.r(d);var b={};a=a||[null,f({}),f([]),f(f)];for(var r=2&c&&e;"object"==typeof r&&!~a.indexOf(r);r=f(r))Object.getOwnPropertyNames(r).forEach((a=>b[a]=()=>e[a]));return b.default=()=>e,t.d(d,b),d},t.d=(e,a)=>{for(var f in a)t.o(a,f)&&!t.o(e,f)&&Object.defineProperty(e,f,{enumerable:!0,get:a[f]})},t.f={},t.e=e=>Promise.all(Object.keys(t.f).reduce(((a,f)=>(t.f[f](e,a),a)),[])),t.u=e=>"assets/js/"+({125:"814d49b7",523:"a0323d9f",648:"714e70d1",743:"61d4c13a",745:"64abd3af",822:"a00af9f0",886:"7aa856d6",899:"b985118d",955:"39ae3791",1074:"9e8f4e9c",1516:"8abd0ba5",1837:"dec87402",1868:"46b3c144",2193:"c5b2f0f9",2221:"827765d9",2281:"920c2ac2",2353:"92d7df62",2866:"e064f6d4",2883:"bb6a5560",3102:"3462068c",3207:"6603ef13",3408:"3ba80b69",3537:"3819c331",3584:"ed75cfcb",3667:"b6d76a6c",3745:"3109d9d2",3879:"2d629ea6",3984:"160cb329",4004:"a334b453",4117:"fd684bd6",4220:"2bbe04e6",4459:"19eded63",4918:"24bda87b",4929:"330dfcdb",5018:"cd509849",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",7371:"786fee93",7377:"708d858d",7809:"07305c4a",8039:"927c84a6",9055:"e7923b27",9973:"4213e5b1",10038:"bc873533",10114:"e665718d",10138:"6269f1c0",10235:"5ee1b5d8",10261:"reactPlayerKaltura",10347:"bc816bf2",10379:"a943bcee",10485:"8873cf50",10579:"d46ef83d",10588:"7afa6340",10921:"c37b4a03",11077:"49d9416a",11161:"a4794f2e",11297:"34cf6fc7",11477:"b2f554cd",11713:"a7023ddc",11724:"5087625a",11859:"2295be0e",11981:"b799648a",12121:"reactPlayerFacebook",12323:"6c80b6fe",12864:"e7477a94",13100:"f0e279fe",13239:"bd45720e",13317:"d83f208d",13573:"be228752",13751:"3720c009",13826:"01a1d0f4",14026:"9c540f0b",14077:"40d377be",14142:"17d2ebc8",14356:"a9a76bf7",14499:"73f18a6f",14824:"06a27da2",15150:"732d4d9b",15554:"1dfee34e",16311:"c25913f3",16467:"878aa0e7",16586:"183053be",16696:"6477cdc2",16728:"d9407a00",16855:"b7bb2d93",17134:"0b40a488",17194:"9f2f2cb3",17285:"c1ca9e21",17329:"04a546a4",17708:"688ee267",17741:"7d88b63f",18518:"a7bd4aaa",18649:"49a2e93c",18768:"524ce9a0",18880:"deccabf3",19043:"473de3ed",19093:"0029a336",19492:"92496324",19536:"0e72c11a",19537:"c1584a80",19841:"d9b4ee1e",20044:"d66cbd9e",20138:"54590fd2",20205:"2340b3ee",20406:"67386898",20873:"cabda5f8",21046:"4cb6c19a",21181:"ea3ffc82",21342:"a766a857",21360:"9286a297",21364:"f7c9e078",21534:"8ae04122",22182:"f1ad83b2",22228:"125d93c1",22938:"c95aa39f",23259:"03ccf92d",23324:"1ce91f4c",23427:"bd80aa65",23840:"562ca3e9",23937:"610f2c47",24260:"22e2140b",24386:"ae79aff5",24498:"7bef3f04",24726:"280646e4",24904:"9d887a11",24907:"31bc5d88",25204:"33f367df",25211:"d496897e",25314:"ab69fe56",25817:"70e3b13c",25821:"b9a87183",26011:"reactPlayerFilePlayer",26026:"51dec273",26348:"c104141c",26536:"3ed6e2e9",26557:"5e486140",26690:"4816649b",27135:"5e30269e",27168:"4ec4c6cd",27177:"4f9e8711",27268:"57a8015d",27328:"423842d7",27449:"0e4ec2e4",27722:"213182ef",27806:"fab06caf",27910:"c358ebbc",27918:"17896441",28143:"7e2ae3df",28145:"006e489c",28263:"82170cf7",28437:"5b10a003",28682:"8eeedb31",29112:"c09ab32f",29234:"86f8c256",29579:"09b168a7",29661:"5e95c892",29693:"123a454a",29709:"838cf899",30027:"3353503a",30060:"0547cb65",30397:"6194ac84",30466:"0e3a398f",30808:"271a7b09",30901:"ae4a775b",31441:"382c5d2b",31512:"7fa133e1",31647:"3b5edcc4",32472:"65a10ffa",32778:"608238a8",33067:"62e21724",33233:"59a6f192",33279:"456c0e28",33356:"54d805e4",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",36088:"88efc5aa",36248:"e3f28bf9",36424:"a3002291",37007:"8593ff01",37073:"0f54081d",37245:"b678a236",37437:"3d8d8999",37438:"9c021584",37573:"48b6ff5f",37683:"df2a6e58",37698:"cd23aec9",37836:"7cde3c49",37918:"10ce918d",38056:"905702d2",38134:"1515c895",38290:"3fe48f60",38860:"0d040286",39179:"79551407",39558:"f41c0109",39613:"1fbe0675",39620:"b51a9aee",40070:"86f2a982",40486:"ed2a4846",40569:"8519c2b0",40592:"b39cdcf9",40683:"3e2b82eb",40816:"4d71dffe",41032:"a67ca768",41169:"a2d1ff94",41619:"6494b798",41644:"9db962b6",41705:"94fb813f",41798:"bd65ec7e",41838:"6108ac41",41976:"0c4fad6b",42205:"b66ca8cf",42326:"7b477840",42423:"91008145",43010:"56c3a9b2",43163:"232c546d",43274:"23a8e291",43474:"db22fd17",43505:"72486833",43546:"57e01cd5",43871:"065365b3",44157:"83e10f72",44422:"416d4fcf",44619:"a9fa5b1f",44781:"12f1535e",45033:"9af13eab",45255:"71c11e3b",45326:"af231220",45346:"7f0476bd",45708:"97d49594",45765:"d18d294a",45835:"7547d3bb",46103:"ccc49370",46623:"b104dd1e",46738:"8dbb6800",47389:"612345e6",47596:"reactPlayerDailyMotion",47679:"83245ae6",47875:"021eaa84",48123:"f86eb50f",48176:"5660752d",48215:"1cfced13",48610:"6875c492",48901:"640277b9",48926:"60c82955",49076:"494e8e75",49867:"44287967",50465:"f7b7f9b7",50649:"512fbd77",51051:"107d77e6",51171:"7e5a2776",51320:"46669adc",51499:"180d0c5f",51843:"a2ffcc0f",51978:"fe0d4a0f",52343:"97c7db18",52525:"1a906644",52535:"814f3328",52546:"reactPlayerStreamable",52920:"e0277333",52950:"67eba1be",53237:"1df93b7f",53273:"cc922df3",53479:"883e2c3c",53604:"cd7fa15a",53608:"9e4087bc",53691:"7be672a3",53800:"97eb992d",54063:"0fa6e9bf",54175:"dfdb391e",54194:"1d31e443",54373:"b5114993",54632:"edb40f78",54672:"03685665",54766:"2f238e8e",54774:"42b67a8e",55029:"04c3832a",55904:"931e3b0a",56805:"f7197f43",56843:"9f97f9d1",56870:"5a3b561f",57034:"3e03f778",57138:"38a042e4",57149:"822c343e",57220:"7591d420",57321:"92b08985",57366:"75281220",57368:"6e30ac7b",57549:"bdb8b81b",57694:"fd702dc7",57881:"2658ced2",58216:"874690d0",58221:"6af14956",58262:"059d1c6a",58673:"d9673b17",58739:"7a957b04",58792:"5db8318c",58800:"e6fb1369",58989:"d4bf7e47",59081:"5a7aef43",59341:"a35cf155",59671:"0e384e19",59860:"d1163e47",60203:"c6aad055",60205:"83d480e9",60334:"a3f8794a",60563:"c685778b",60564:"8b4ba22f",60574:"14ae68e7",60637:"91392348",60810:"254d0ff5",61021:"901c37e5",61281:"e983a6d7",61305:"73f9658e",61425:"fc8a94e3",61573:"87a5fc8a",61866:"1369aff7",61896:"25622900",62283:"74b658de",62789:"c239db97",62871:"604e05e4",63154:"c6346fcf",63190:"e546fc5a",63407:"b8ec852b",63652:"6e92edd9",63707:"8c6c72f9",63863:"f771dec1",64013:"01a85c17",64258:"reactPlayerMux",64315:"16914cba",64389:"d739767a",64438:"f20efc55",64439:"reactPlayerYouTube",64471:"cfdfe126",64651:"94f3d131",64891:"a30c0d44",65144:"1ee92283",65191:"d103759a",65248:"6101b3fc",65375:"97615df2",65619:"f6cf66bc",65776:"f0e3a130",66e3:"95646edb",66464:"adcef0a2",66521:"014457dd",67141:"b5abacaa",67363:"583db3ef",67411:"b15eeff9",67480:"eb17771c",67539:"5c25e6fa",67622:"dbbb982f",67690:"030ccfd9",67739:"efc2a09d",68059:"ca165b51",68097:"ff2f63f6",68445:"99245987",68732:"3132913e",68811:"3289a752",68888:"reactPlayerVidyard",68893:"ba1dc56d",68974:"8a864d1e",69006:"a08dfa31",69133:"02e265ea",69469:"3b85f227",69584:"b8eb0fce",69845:"a7b96653",70010:"33942509",70225:"e1a2ab10",70406:"0cbb83d7",70534:"4b8121dd",70595:"24dadce3",70633:"1fc83a28",70900:"fe1a05e2",70985:"814402d7",71625:"de311ed4",71796:"64134c03",71869:"c2ccf160",71874:"cc6d9416",71970:"adfdec4a",72079:"1a16e8bf",72092:"148448cb",72179:"34767260",72491:"c71cae97",72896:"abc85917",72931:"e6c31e60",72996:"7a21ccb0",73177:"fc923f19",73285:"ed603d23",73636:"8b4dd820",73714:"894e67a6",73743:"reactPlayerVimeo",73867:"c7cac05f",74121:"55960ee5",74340:"2bb2c1cd",74961:"4c5becac",75167:"5046ea8f",75208:"f6cd0d3d",75247:"3c39daba",75273:"e69dadab",75290:"bf11c6a2",75542:"0102eb3e",75689:"c544b2d7",75741:"f27eaf88",75862:"ada86621",76091:"19e69ccd",76158:"51e516cc",76240:"cb49f262",76267:"94324b0e",76518:"9dd60997",76721:"654eb3dd",76932:"aaabcfd8",77060:"7c7a772e",77319:"67fccd64",77401:"ca1234c1",77536:"f6e0e63c",77683:"01821883",78514:"d651e2ee",79106:"d4840880",79649:"5bc09a53",80053:"935f2afb",80161:"3f66023b",80171:"c925d092",80182:"c276ecb2",80325:"98ced590",80355:"b5b19789",80448:"49bee2be",80511:"fb8cd692",80900:"4ec76dfa",80945:"df322e14",80954:"8c8ef21f",81145:"e84cabb0",81580:"fee0a0be",81676:"819ef483",81900:"4c217c25",82144:"09788c0c",82163:"c813bd67",82178:"ba322490",82388:"bbf561d5",82409:"df4d464e",82424:"b6be2912",82451:"fb50ea3a",82667:"368cce37",83039:"825ec378",83152:"33a21d7d",83672:"8785b74d",83868:"1b2af15e",83870:"5df556a2",83973:"f523fb3f",84059:"9cb03f5d",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",86272:"7500e360",86335:"271ff0d1",86477:"a38d285e",86528:"2cb13d6d",86661:"43be69c9",87213:"0877aebd",87664:"reactPlayerPreview",87714:"7bdcd7a7",87759:"ff38b1ce",88055:"reactPlayerWistia",88089:"6eafe0c7",88566:"9dce5486",89106:"72dd8f7e",89251:"b9287eb6",89372:"07f59c2a",89472:"5a9a7a02",89626:"81e486a8",89731:"9d2d4743",89799:"4f425ff4",89944:"08570680",89950:"12eb386e",90051:"185c52e7",90125:"7d9edfb8",90522:"308aae28",90533:"b2b675dd",90681:"cdf64ea9",91447:"4974f5d2",91721:"3a38a610",91893:"871ce139",92082:"e85ba0e6",92111:"79665d43",92217:"d7fbbe43",92423:"7258860f",92514:"b5ec5208",92599:"e44de27e",92786:"81b69ac7",92916:"91fe1403",92955:"e6412603",92958:"86063cd3",93089:"a6aa9e1f",93317:"846a5e19",93401:"c2865a15",94331:"e38c422a",94368:"a94703ab",95594:"f6360934",95625:"657ac0bc",95921:"fbfd390f",96017:"6a1fe514",96049:"f213dd13",96120:"35300761",96514:"a826efc5",96590:"bb8cfc40",96987:"caddb1c0",97159:"a8ce95ee",97227:"71748509",97251:"ba5b9f11",97586:"ac353d25",97767:"17612ae7",97847:"43b416ef",97920:"1a4e3797",97953:"e88443f3",98170:"bab44fba",98532:"d1b15a6d",98960:"6bf124c2",99124:"dc23cd40",99387:"b0f1c099",99494:"93e05602",99924:"df203c0f",99979:"987564cc"}[e]||e)+"."+{125:"f35d1c27",523:"562a43f2",648:"e8aa7547",743:"b6bef3d2",745:"597852b8",822:"77eef700",886:"8cadbd75",899:"3759a417",955:"a43fc0cc",1074:"fd3d60f8",1516:"c3076744",1837:"2816995e",1868:"b6032b59",2193:"e0ae080f",2221:"6c6b2315",2281:"5a9797d9",2353:"224182d5",2866:"5f434384",2883:"7930735c",3102:"1196e28e",3207:"06460fe8",3408:"6a2248b1",3537:"57441f53",3584:"edec704e",3667:"36778ba0",3745:"b988a45f",3879:"772bbb02",3984:"b697a9ed",4004:"1ef49b1d",4117:"0ed50e42",4220:"867fda2c",4459:"72e55476",4918:"22642899",4929:"aa554ec9",5018:"076affc0",5240:"69fe84b9",5414:"c0e2876c",5417:"521014a7",5477:"b8ed4032",5674:"18d7fdbf",5697:"ba8cfce9",5886:"654997fe",6082:"c2fd7ce4",6098:"d3ba4f77",6102:"682886b9",6125:"b843d475",6266:"3f84d72b",6639:"cd5305ea",7371:"d444be09",7377:"01db6196",7809:"8b5ab072",7849:"1994a464",8039:"f30be07f",9055:"83e4a55f",9500:"8bb8cb2a",9973:"df3f1309",10038:"50f87830",10114:"8e5d4d62",10138:"201dc12d",10235:"5253edff",10261:"91ba2584",10347:"522378b8",10349:"7d28f7e4",10379:"212d2b1f",10449:"ae04e529",10485:"d159372a",10579:"c5bf987b",10588:"a577bd65",10921:"c7612966",11077:"9c1c7d1c",11161:"81494862",11297:"a4df4b1e",11477:"da6afc79",11713:"41b89384",11724:"0be29d98",11856:"5c00e7a3",11859:"a8454d3d",11981:"19428fa3",12121:"99398064",12323:"1e784e4c",12864:"633316ab",13100:"9b3e485a",13239:"a98de0bc",13317:"f05356f8",13573:"327cc384",13751:"2834334f",13826:"ba9ae5ce",14026:"354b35e1",14069:"263ec6c5",14077:"f82b3048",14094:"98140877",14142:"52d258b6",14356:"24792eaf",14499:"9ecd316f",14824:"d66ed147",15150:"abb98eed",15554:"dfca0ffb",16311:"948f1162",16467:"6f1b7c68",16586:"e38ca1f7",16696:"40c887b4",16728:"b266d8d2",16855:"038b3ffc",17134:"9a920315",17194:"95f2e3a7",17285:"ceb9c413",17329:"9cbb3615",17708:"9fc5aec0",17741:"d04a108b",18315:"57e4ce2c",18518:"74ea80fc",18649:"72975580",18768:"142353e8",18880:"45fab54b",19043:"c222b4d1",19093:"92f134a4",19492:"44b401b0",19536:"40b87b3a",19537:"0e9ba5ff",19841:"8f64d6ef",20044:"730740ec",20138:"b4e44632",20205:"25f180af",20406:"7394d6c9",20873:"003efd71",21046:"d7eed07e",21181:"c20de2c2",21342:"30b260b0",21360:"bc6850d2",21364:"6ca3691b",21534:"5d030365",22182:"2358ae4e",22228:"a5a33191",22938:"0d4d7006",23259:"7be24bb2",23324:"772ecb17",23427:"07a29926",23840:"12ea908e",23937:"b383cecf",24260:"e38943cf",24386:"a02b0b95",24498:"c8701684",24726:"189c0e50",24904:"42b6bc62",24907:"fa6a5f0e",25204:"c05326f5",25211:"9944ccdd",25314:"af3fffe6",25817:"86b953f4",25821:"9e0dfce3",26011:"55e8cd60",26026:"b9067a03",26070:"4d45da95",26348:"0e10ecdc",26536:"5ce1080c",26557:"e0dda424",26690:"f11e59cb",27135:"b8232d0d",27168:"b7831e25",27177:"62877687",27268:"97495d30",27328:"acf693fd",27449:"94277040",27722:"5d3cadad",27806:"41515d02",27910:"1005b64f",27918:"9524d19b",28143:"a7deb713",28145:"6621468b",28263:"ef992965",28437:"4567b66d",28682:"7e594d7c",29112:"748c1836",29234:"3690581c",29579:"c9c98e87",29661:"a8c5c3e9",29693:"c7fc15b7",29709:"3715a5e9",30027:"600ace6f",30060:"c85f6a89",30397:"6415f904",30466:"41910b52",30808:"a77b281e",30901:"cd9e36d3",31441:"175a58cb",31512:"962898de",31647:"9a853bf3",32472:"9ee441da",32778:"c3b4a521",33067:"e85152be",33233:"bdf41c70",33279:"d959dd31",33356:"20c0735c",33940:"946349dd",34322:"d3e9af23",34479:"81af500f",34617:"916fe218",34670:"60f01632",34770:"c5ad9b81",34884:"26d3cbfc",35137:"e153f008",35281:"6fffbe36",35425:"cf90335e",35572:"93c6fe56",35584:"03dd79ad",35711:"f33aa64e",36006:"3fe305ab",36075:"8612b05d",36088:"99334aee",36166:"ae8d5da7",36248:"15423e05",36274:"3999e913",36424:"4e03a42c",37007:"4481ecf7",37073:"93573599",37245:"3eb4919f",37437:"18784825",37438:"11a67353",37573:"973515e0",37683:"eac9161d",37698:"bb549ff3",37737:"5704e252",37836:"c7a15492",37918:"b99573a9",38056:"392ffcd7",38134:"b4fc0e7a",38290:"69c46f65",38860:"984f694e",39179:"9c02c2f1",39558:"ca55a7d0",39613:"423a5b51",39620:"dd9df57b",40070:"772b8eef",40486:"94dc99f5",40569:"6837a6bf",40592:"b51a6136",40683:"67b26f21",40816:"4140b82b",41032:"e65e1418",41169:"cd42370c",41619:"542dea5b",41644:"e52a7b2c",41705:"eb015864",41798:"3ce21ab1",41838:"6b564fbb",41976:"d4930aaf",42205:"b3e72ec0",42326:"046ec119",42423:"92c7330d",43010:"57b0b164",43163:"a002687f",43274:"4c4a4c64",43474:"f6898ba5",43505:"11faca4a",43546:"02acec70",43871:"f497ef4d",44157:"6d2d45ae",44366:"ac8e857d",44422:"1c0e95c6",44619:"a33a2883",44781:"62107737",45033:"8da8ec28",45255:"e33ee667",45326:"c0091348",45346:"20f2374d",45708:"c2ee2107",45760:"518ecc83",45765:"7567b0f7",45835:"9f44d157",46103:"58dc5a5e",46623:"253f6d4b",46738:"53547e7f",47389:"955e4166",47596:"23612a4e",47679:"a3a8ea10",47875:"9b24192f",48123:"8afe0a58",48176:"a6691a3d",48215:"299c257f",48610:"f2fc0d53",48901:"4daaabe9",48926:"a0d0937b",49076:"ff6efc1f",49867:"935386d3",50465:"4979375d",50649:"ed12ebe0",51051:"4c4887bd",51171:"b7d8320e",51320:"7ef9ccbf",51499:"f9a48f81",51843:"53e8c703",51978:"c0fe8ef4",52343:"890c0ba6",52525:"21eb35f6",52535:"95122141",52546:"04c929f6",52920:"a556bd3b",52950:"5ae1a8ca",53237:"86bb93c8",53273:"1b0315bd",53479:"c30481f9",53604:"ddeb4938",53608:"a538e352",53691:"b49551db",53800:"9b0c29a1",54063:"8176967b",54175:"87ab6b06",54191:"8c190567",54194:"9ec124f0",54373:"b00af05f",54632:"f17db715",54672:"6162a7d2",54766:"5c132030",54774:"ae8f374d",54854:"be433bea",55029:"6651a368",55904:"7cdaf6bb",56805:"651fdac2",56843:"7b647ccc",56870:"13e81fd0",57034:"614e0d73",57076:"e0be15c4",57138:"784fdd6b",57149:"cd1a641f",57220:"5d3b07a6",57321:"9df6d360",57366:"6066919e",57368:"8545b1d6",57549:"c3486276",57694:"31ea96ca",57881:"a7f9e4d8",58216:"c4989b3b",58221:"1f9f3dfd",58262:"af56993b",58673:"82ee7398",58739:"2a7c0f37",58792:"69caefe3",58800:"0b6a0c6b",58989:"b7ba0274",59081:"78593a3e",59341:"e324817d",59671:"1fce19a0",59812:"747fd838",59860:"f83b2fc3",60055:"47d63b75",60203:"555a74ca",60205:"bcd01292",60334:"d031425c",60563:"b56125f4",60564:"382b0a90",60574:"8e966750",60637:"f5cb6f27",60810:"2442ecbb",61021:"1ced2fd9",61281:"d1657e7a",61305:"8e2732f7",61425:"c63568f9",61573:"544c883c",61866:"f757bd1d",61896:"4c7314c3",62283:"9477da39",62789:"73bc5659",62871:"7681f7c1",63154:"44dde863",63190:"59353cfa",63407:"8536efc6",63652:"74f06cbe",63707:"31adf943",63863:"fe89e267",64013:"1a6fdbcd",64258:"98bf19a2",64315:"9101c7ce",64389:"fe28638e",64438:"22bbdcbd",64439:"545b7965",64471:"509157cc",64651:"83484b26",64891:"e51907d0",65144:"5647ff83",65191:"8077d5ff",65248:"15726df6",65375:"ffd4e048",65619:"c8ab5809",65776:"bfc7e258",65909:"6f4a66dd",66e3:"d2a6155b",66464:"6d1248c1",66521:"9f7d80bb",67141:"632ed7c1",67363:"94996820",67411:"06e2bb8a",67480:"27114010",67539:"0f2c4f44",67622:"c2389c88",67690:"6af5542e",67739:"f155baf5",68059:"ce22804e",68097:"fde6fbda",68445:"cf318a20",68732:"83a3dc68",68811:"d62612ef",68888:"19f0621a",68893:"c3b6574d",68974:"81975c62",69006:"61512d3e",69133:"ad9275bb",69469:"f0e72ec7",69584:"f4f93d82",69845:"2d642c31",70010:"1130bc9f",70225:"e4c6b390",70335:"eb92c593",70406:"aae45e88",70534:"591638a7",70595:"853597a2",70633:"d12148e2",70900:"e35c611b",70985:"168ecaa5",71625:"30cc2127",71796:"97f21a99",71869:"012c2d06",71874:"bb85ac72",71970:"f70bb652",72079:"a69416ae",72092:"1c3ea32f",72179:"d1aa2cb8",72491:"1151b393",72896:"770b956c",72931:"31d339aa",72996:"f92ed0dc",73177:"cfe1fa4b",73285:"5da37b94",73313:"3477b0dc",73636:"0b13ed1c",73714:"0f599071",73743:"b8146bc5",73867:"068bcd08",74121:"0cf5f978",74340:"82fb5fa6",74961:"3618ce01",74988:"2c75a852",75167:"5cdba6a6",75208:"44684c87",75247:"7403678c",75273:"bbc7b49b",75290:"e6bd0392",75542:"570ca7d7",75689:"a0a4ae19",75741:"c736f69d",75862:"c3602068",76091:"d71a6bd7",76158:"ea14e931",76240:"12625b18",76267:"7d30de25",76518:"9874c0f0",76721:"0c77501b",76932:"35a658b1",77060:"3175a757",77319:"93652144",77401:"265b8267",77536:"c4c34141",77683:"a60e5b32",78514:"9b52cf76",79106:"ee644da5",79649:"fd285884",80053:"871626e5",80161:"17485265",80171:"c1eb3c81",80182:"41214a75",80299:"6c9cc63a",80325:"8c808427",80355:"9576f489",80448:"f2002d66",80511:"eb9397b4",80900:"136bc8a2",80945:"cde0433d",80954:"1b7d7278",81145:"8495bcb0",81580:"22163b57",81676:"24de4cc2",81900:"480c06c7",82144:"411cc9b7",82163:"26a3edcf",82178:"5e6c0628",82388:"a996de8b",82409:"2c9b2a78",82424:"7eef4089",82451:"ebd7b23f",82667:"58a7c4be",83039:"4d60eb6d",83152:"d32438bd",83672:"1940120b",83868:"51cc6247",83870:"42bd8ed9",83973:"136bac57",84059:"297978cb",84413:"e8792067",84507:"22a2843d",84513:"fd7e99c8",84573:"74575088",84667:"ec612995",84940:"7aedef41",84960:"0039922a",85067:"511c9e62",85210:"e66536f0",85240:"87dc9608",85376:"eb70aa8e",85632:"14381b38",85714:"d0a1f8f9",85799:"819ea1d3",86112:"efa9bcd8",86216:"42cf6854",86272:"f1814908",86335:"f84e17f8",86477:"c7d79b25",86528:"6c544606",86661:"5cc7765f",86730:"ad9e2eb6",87213:"678da894",87430:"f97de055",87664:"0aa437ad",87714:"72e3436d",87759:"4815ef1c",88055:"fef9a984",88089:"304211a7",88566:"47fd3bfa",89106:"5fab4320",89127:"77dc02e4",89251:"96b5e71c",89372:"a8a22719",89472:"39f1c3c1",89626:"72fe0ae6",89731:"2d36c3d3",89799:"31bb7041",89944:"51882b32",89950:"987442d4",90051:"872aa714",90125:"481f6f48",90522:"23870609",90533:"c6a598f6",90681:"17a540d0",91447:"03fc55d5",91721:"d8ef876e",91893:"6ae88921",92082:"10234da7",92111:"d9e8a59e",92217:"940c3f0f",92423:"68820e48",92514:"688bc9df",92599:"ae2b1a86",92786:"12bfd79d",92916:"3ca595fb",92955:"62be0a1e",92958:"e902e9b7",93041:"3bde6a31",93089:"816fd652",93317:"7ebede6a",93401:"0372eac0",94331:"93fd0ffe",94368:"34c5df8a",94875:"1f649e1a",95594:"60b6a643",95625:"8def3e87",95628:"42c1eef6",95921:"beb7dad5",96017:"085c2aa8",96049:"e453c09e",96120:"b8007215",96514:"bd821785",96590:"0da3827f",96987:"b5ad6069",97159:"37700053",97227:"e56064a2",97251:"f942b3df",97586:"18021336",97767:"84bb1e5e",97847:"d9bd67f8",97920:"d2061f7d",97953:"27a3c2d1",98170:"d360f8a7",98327:"12f5691c",98532:"451ee39f",98960:"d4225910",99124:"5525d066",99387:"b5652495",99494:"587c5eda",99924:"bd589dbb",99964:"1414e8fb",99979:"dbded3c8"}[e]+".js",t.miniCssF=e=>{},t.g=function(){if("object"==typeof globalThis)return globalThis;try{return this||new Function("return this")()}catch(e){if("object"==typeof window)return window}}(),t.o=(e,a)=>Object.prototype.hasOwnProperty.call(e,a),c={},d="docs:",t.l=(e,a,f,b)=>{if(c[e])c[e].push(a);else{var r,o;if(void 0!==f)for(var l=document.getElementsByTagName("script"),n=0;n{r.onerror=r.onload=null,clearTimeout(s);var d=c[e];if(delete c[e],r.parentNode&&r.parentNode.removeChild(r),d&&d.forEach((e=>e(f))),a)return a(f)},s=setTimeout(u.bind(null,void 0,{type:"timeout",target:r}),12e4);r.onerror=u.bind(null,r.onerror),r.onload=u.bind(null,r.onload),o&&document.head.appendChild(r)}},t.r=e=>{"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(e,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(e,"__esModule",{value:!0})},t.p="/",t.gca=function(e){return e={17896441:"27918",25622900:"61896",33942509:"70010",34767260:"72179",35300761:"96120",44287967:"49867",67386898:"20406",71748509:"97227",72486833:"43505",75281220:"57366",79551407:"39179",91008145:"42423",91392348:"60637",92496324:"19492",95366386:"34617",99245987:"68445","814d49b7":"125",a0323d9f:"523","714e70d1":"648","61d4c13a":"743","64abd3af":"745",a00af9f0:"822","7aa856d6":"886",b985118d:"899","39ae3791":"955","9e8f4e9c":"1074","8abd0ba5":"1516",dec87402:"1837","46b3c144":"1868",c5b2f0f9:"2193","827765d9":"2221","920c2ac2":"2281","92d7df62":"2353",e064f6d4:"2866",bb6a5560:"2883","3462068c":"3102","6603ef13":"3207","3ba80b69":"3408","3819c331":"3537",ed75cfcb:"3584",b6d76a6c:"3667","3109d9d2":"3745","2d629ea6":"3879","160cb329":"3984",a334b453:"4004",fd684bd6:"4117","2bbe04e6":"4220","19eded63":"4459","24bda87b":"4918","330dfcdb":"4929",cd509849:"5018","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","786fee93":"7371","708d858d":"7377","07305c4a":"7809","927c84a6":"8039",e7923b27:"9055","4213e5b1":"9973",bc873533:"10038",e665718d:"10114","6269f1c0":"10138","5ee1b5d8":"10235",reactPlayerKaltura:"10261",bc816bf2:"10347",a943bcee:"10379","8873cf50":"10485",d46ef83d:"10579","7afa6340":"10588",c37b4a03:"10921","49d9416a":"11077",a4794f2e:"11161","34cf6fc7":"11297",b2f554cd:"11477",a7023ddc:"11713","5087625a":"11724","2295be0e":"11859",b799648a:"11981",reactPlayerFacebook:"12121","6c80b6fe":"12323",e7477a94:"12864",f0e279fe:"13100",bd45720e:"13239",d83f208d:"13317",be228752:"13573","3720c009":"13751","01a1d0f4":"13826","9c540f0b":"14026","40d377be":"14077","17d2ebc8":"14142",a9a76bf7:"14356","73f18a6f":"14499","06a27da2":"14824","732d4d9b":"15150","1dfee34e":"15554",c25913f3:"16311","878aa0e7":"16467","183053be":"16586","6477cdc2":"16696",d9407a00:"16728",b7bb2d93:"16855","0b40a488":"17134","9f2f2cb3":"17194",c1ca9e21:"17285","04a546a4":"17329","688ee267":"17708","7d88b63f":"17741",a7bd4aaa:"18518","49a2e93c":"18649","524ce9a0":"18768",deccabf3:"18880","473de3ed":"19043","0029a336":"19093","0e72c11a":"19536",c1584a80:"19537",d9b4ee1e:"19841",d66cbd9e:"20044","54590fd2":"20138","2340b3ee":"20205",cabda5f8:"20873","4cb6c19a":"21046",ea3ffc82:"21181",a766a857:"21342","9286a297":"21360",f7c9e078:"21364","8ae04122":"21534",f1ad83b2:"22182","125d93c1":"22228",c95aa39f:"22938","03ccf92d":"23259","1ce91f4c":"23324",bd80aa65:"23427","562ca3e9":"23840","610f2c47":"23937","22e2140b":"24260",ae79aff5:"24386","7bef3f04":"24498","280646e4":"24726","9d887a11":"24904","31bc5d88":"24907","33f367df":"25204",d496897e:"25211",ab69fe56:"25314","70e3b13c":"25817",b9a87183:"25821",reactPlayerFilePlayer:"26011","51dec273":"26026",c104141c:"26348","3ed6e2e9":"26536","5e486140":"26557","4816649b":"26690","5e30269e":"27135","4ec4c6cd":"27168","4f9e8711":"27177","57a8015d":"27268","423842d7":"27328","0e4ec2e4":"27449","213182ef":"27722",fab06caf:"27806",c358ebbc:"27910","7e2ae3df":"28143","006e489c":"28145","82170cf7":"28263","5b10a003":"28437","8eeedb31":"28682",c09ab32f:"29112","86f8c256":"29234","09b168a7":"29579","5e95c892":"29661","123a454a":"29693","838cf899":"29709","3353503a":"30027","0547cb65":"30060","6194ac84":"30397","0e3a398f":"30466","271a7b09":"30808",ae4a775b:"30901","382c5d2b":"31441","7fa133e1":"31512","3b5edcc4":"31647","65a10ffa":"32472","608238a8":"32778","62e21724":"33067","59a6f192":"33233","456c0e28":"33279","54d805e4":"33356",fe716911:"33940","69c5f318":"34322","0c14b239":"34479","450c2e30":"34770",e1c8d71f:"34884","41b2e801":"35137","8cb0269b":"35281",b4df9b48:"35425","6774f806":"35572",b52d840d:"35584","79f18c88":"36006","86e64757":"36075","88efc5aa":"36088",e3f28bf9:"36248",a3002291:"36424","8593ff01":"37007","0f54081d":"37073",b678a236:"37245","3d8d8999":"37437","9c021584":"37438","48b6ff5f":"37573",df2a6e58:"37683",cd23aec9:"37698","7cde3c49":"37836","10ce918d":"37918","905702d2":"38056","1515c895":"38134","3fe48f60":"38290","0d040286":"38860",f41c0109:"39558","1fbe0675":"39613",b51a9aee:"39620","86f2a982":"40070",ed2a4846:"40486","8519c2b0":"40569",b39cdcf9:"40592","3e2b82eb":"40683","4d71dffe":"40816",a67ca768:"41032",a2d1ff94:"41169","6494b798":"41619","9db962b6":"41644","94fb813f":"41705",bd65ec7e:"41798","6108ac41":"41838","0c4fad6b":"41976",b66ca8cf:"42205","7b477840":"42326","56c3a9b2":"43010","232c546d":"43163","23a8e291":"43274",db22fd17:"43474","57e01cd5":"43546","065365b3":"43871","83e10f72":"44157","416d4fcf":"44422",a9fa5b1f:"44619","12f1535e":"44781","9af13eab":"45033","71c11e3b":"45255",af231220:"45326","7f0476bd":"45346","97d49594":"45708",d18d294a:"45765","7547d3bb":"45835",ccc49370:"46103",b104dd1e:"46623","8dbb6800":"46738","612345e6":"47389",reactPlayerDailyMotion:"47596","83245ae6":"47679","021eaa84":"47875",f86eb50f:"48123","5660752d":"48176","1cfced13":"48215","6875c492":"48610","640277b9":"48901","60c82955":"48926","494e8e75":"49076",f7b7f9b7:"50465","512fbd77":"50649","107d77e6":"51051","7e5a2776":"51171","46669adc":"51320","180d0c5f":"51499",a2ffcc0f:"51843",fe0d4a0f:"51978","97c7db18":"52343","1a906644":"52525","814f3328":"52535",reactPlayerStreamable:"52546",e0277333:"52920","67eba1be":"52950","1df93b7f":"53237",cc922df3:"53273","883e2c3c":"53479",cd7fa15a:"53604","9e4087bc":"53608","7be672a3":"53691","97eb992d":"53800","0fa6e9bf":"54063",dfdb391e:"54175","1d31e443":"54194",b5114993:"54373",edb40f78:"54632","03685665":"54672","2f238e8e":"54766","42b67a8e":"54774","04c3832a":"55029","931e3b0a":"55904",f7197f43:"56805","9f97f9d1":"56843","5a3b561f":"56870","3e03f778":"57034","38a042e4":"57138","822c343e":"57149","7591d420":"57220","92b08985":"57321","6e30ac7b":"57368",bdb8b81b:"57549",fd702dc7:"57694","2658ced2":"57881","874690d0":"58216","6af14956":"58221","059d1c6a":"58262",d9673b17:"58673","7a957b04":"58739","5db8318c":"58792",e6fb1369:"58800",d4bf7e47:"58989","5a7aef43":"59081",a35cf155:"59341","0e384e19":"59671",d1163e47:"59860",c6aad055:"60203","83d480e9":"60205",a3f8794a:"60334",c685778b:"60563","8b4ba22f":"60564","14ae68e7":"60574","254d0ff5":"60810","901c37e5":"61021",e983a6d7:"61281","73f9658e":"61305",fc8a94e3:"61425","87a5fc8a":"61573","1369aff7":"61866","74b658de":"62283",c239db97:"62789","604e05e4":"62871",c6346fcf:"63154",e546fc5a:"63190",b8ec852b:"63407","6e92edd9":"63652","8c6c72f9":"63707",f771dec1:"63863","01a85c17":"64013",reactPlayerMux:"64258","16914cba":"64315",d739767a:"64389",f20efc55:"64438",reactPlayerYouTube:"64439",cfdfe126:"64471","94f3d131":"64651",a30c0d44:"64891","1ee92283":"65144",d103759a:"65191","6101b3fc":"65248","97615df2":"65375",f6cf66bc:"65619",f0e3a130:"65776","95646edb":"66000",adcef0a2:"66464","014457dd":"66521",b5abacaa:"67141","583db3ef":"67363",b15eeff9:"67411",eb17771c:"67480","5c25e6fa":"67539",dbbb982f:"67622","030ccfd9":"67690",efc2a09d:"67739",ca165b51:"68059",ff2f63f6:"68097","3132913e":"68732","3289a752":"68811",reactPlayerVidyard:"68888",ba1dc56d:"68893","8a864d1e":"68974",a08dfa31:"69006","02e265ea":"69133","3b85f227":"69469",b8eb0fce:"69584",a7b96653:"69845",e1a2ab10:"70225","0cbb83d7":"70406","4b8121dd":"70534","24dadce3":"70595","1fc83a28":"70633",fe1a05e2:"70900","814402d7":"70985",de311ed4:"71625","64134c03":"71796",c2ccf160:"71869",cc6d9416:"71874",adfdec4a:"71970","1a16e8bf":"72079","148448cb":"72092",c71cae97:"72491",abc85917:"72896",e6c31e60:"72931","7a21ccb0":"72996",fc923f19:"73177",ed603d23:"73285","8b4dd820":"73636","894e67a6":"73714",reactPlayerVimeo:"73743",c7cac05f:"73867","55960ee5":"74121","2bb2c1cd":"74340","4c5becac":"74961","5046ea8f":"75167",f6cd0d3d:"75208","3c39daba":"75247",e69dadab:"75273",bf11c6a2:"75290","0102eb3e":"75542",c544b2d7:"75689",f27eaf88:"75741",ada86621:"75862","19e69ccd":"76091","51e516cc":"76158",cb49f262:"76240","94324b0e":"76267","9dd60997":"76518","654eb3dd":"76721",aaabcfd8:"76932","7c7a772e":"77060","67fccd64":"77319",ca1234c1:"77401",f6e0e63c:"77536","01821883":"77683",d651e2ee:"78514",d4840880:"79106","5bc09a53":"79649","935f2afb":"80053","3f66023b":"80161",c925d092:"80171",c276ecb2:"80182","98ced590":"80325",b5b19789:"80355","49bee2be":"80448",fb8cd692:"80511","4ec76dfa":"80900",df322e14:"80945","8c8ef21f":"80954",e84cabb0:"81145",fee0a0be:"81580","819ef483":"81676","4c217c25":"81900","09788c0c":"82144",c813bd67:"82163",ba322490:"82178",bbf561d5:"82388",df4d464e:"82409",b6be2912:"82424",fb50ea3a:"82451","368cce37":"82667","825ec378":"83039","33a21d7d":"83152","8785b74d":"83672","1b2af15e":"83868","5df556a2":"83870",f523fb3f:"83973","9cb03f5d":"84059",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","7500e360":"86272","271ff0d1":"86335",a38d285e:"86477","2cb13d6d":"86528","43be69c9":"86661","0877aebd":"87213",reactPlayerPreview:"87664","7bdcd7a7":"87714",ff38b1ce:"87759",reactPlayerWistia:"88055","6eafe0c7":"88089","9dce5486":"88566","72dd8f7e":"89106",b9287eb6:"89251","07f59c2a":"89372","5a9a7a02":"89472","81e486a8":"89626","9d2d4743":"89731","4f425ff4":"89799","08570680":"89944","12eb386e":"89950","185c52e7":"90051","7d9edfb8":"90125","308aae28":"90522",b2b675dd:"90533",cdf64ea9:"90681","4974f5d2":"91447","3a38a610":"91721","871ce139":"91893",e85ba0e6:"92082","79665d43":"92111",d7fbbe43:"92217","7258860f":"92423",b5ec5208:"92514",e44de27e:"92599","81b69ac7":"92786","91fe1403":"92916",e6412603:"92955","86063cd3":"92958",a6aa9e1f:"93089","846a5e19":"93317",c2865a15:"93401",e38c422a:"94331",a94703ab:"94368",f6360934:"95594","657ac0bc":"95625",fbfd390f:"95921","6a1fe514":"96017",f213dd13:"96049",a826efc5:"96514",bb8cfc40:"96590",caddb1c0:"96987",a8ce95ee:"97159",ba5b9f11:"97251",ac353d25:"97586","17612ae7":"97767","43b416ef":"97847","1a4e3797":"97920",e88443f3:"97953",bab44fba:"98170",d1b15a6d:"98532","6bf124c2":"98960",dc23cd40:"99124",b0f1c099:"99387","93e05602":"99494",df203c0f:"99924","987564cc":"99979"}[e]||e,t.p+t.u(e)},(()=>{var e={51303:0,40532:0};t.f.j=(a,f)=>{var c=t.o(e,a)?e[a]:void 0;if(0!==c)if(c)f.push(c[2]);else if(/^(40532|51303)$/.test(a))e[a]=0;else{var d=new Promise(((f,d)=>c=e[a]=[f,d]));f.push(c[2]=d);var b=t.p+t.u(a),r=new Error;t.l(b,(f=>{if(t.o(e,a)&&(0!==(c=e[a])&&(e[a]=void 0),c)){var d=f&&("load"===f.type?"missing":f.type),b=f&&f.target&&f.target.src;r.message="Loading chunk "+a+" failed.\n("+d+": "+b+")",r.name="ChunkLoadError",r.type=d,r.request=b,c[1](r)}}),"chunk-"+a,a)}},t.O.j=a=>0===e[a];var a=(a,f)=>{var c,d,b=f[0],r=f[1],o=f[2],l=0;if(b.some((a=>0!==e[a]))){for(c in r)t.o(r,c)&&(t.m[c]=r[c]);if(o)var n=o(t)}for(a&&a(f);l{"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",523:"a0323d9f",648:"714e70d1",743:"61d4c13a",745:"64abd3af",822:"a00af9f0",886:"7aa856d6",899:"b985118d",955:"39ae3791",1074:"9e8f4e9c",1516:"8abd0ba5",1837:"dec87402",1868:"46b3c144",2193:"c5b2f0f9",2221:"827765d9",2281:"920c2ac2",2353:"92d7df62",2866:"e064f6d4",2883:"bb6a5560",3102:"3462068c",3207:"6603ef13",3408:"3ba80b69",3537:"3819c331",3584:"ed75cfcb",3667:"b6d76a6c",3745:"3109d9d2",3879:"2d629ea6",3984:"160cb329",4004:"a334b453",4117:"fd684bd6",4220:"2bbe04e6",4459:"19eded63",4918:"24bda87b",4929:"330dfcdb",5018:"cd509849",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",7371:"786fee93",7377:"708d858d",7809:"07305c4a",8039:"927c84a6",9055:"e7923b27",9973:"4213e5b1",10038:"bc873533",10114:"e665718d",10138:"6269f1c0",10235:"5ee1b5d8",10261:"reactPlayerKaltura",10347:"bc816bf2",10379:"a943bcee",10485:"8873cf50",10579:"d46ef83d",10588:"7afa6340",10921:"c37b4a03",11077:"49d9416a",11161:"a4794f2e",11297:"34cf6fc7",11477:"b2f554cd",11713:"a7023ddc",11724:"5087625a",11859:"2295be0e",11981:"b799648a",12121:"reactPlayerFacebook",12323:"6c80b6fe",12864:"e7477a94",13100:"f0e279fe",13239:"bd45720e",13317:"d83f208d",13573:"be228752",13751:"3720c009",13826:"01a1d0f4",14026:"9c540f0b",14077:"40d377be",14142:"17d2ebc8",14356:"a9a76bf7",14499:"73f18a6f",14824:"06a27da2",15150:"732d4d9b",15554:"1dfee34e",16311:"c25913f3",16467:"878aa0e7",16586:"183053be",16696:"6477cdc2",16728:"d9407a00",16855:"b7bb2d93",17134:"0b40a488",17194:"9f2f2cb3",17285:"c1ca9e21",17329:"04a546a4",17708:"688ee267",17741:"7d88b63f",18518:"a7bd4aaa",18649:"49a2e93c",18768:"524ce9a0",18880:"deccabf3",19043:"473de3ed",19093:"0029a336",19492:"92496324",19536:"0e72c11a",19537:"c1584a80",19841:"d9b4ee1e",20044:"d66cbd9e",20138:"54590fd2",20205:"2340b3ee",20406:"67386898",20873:"cabda5f8",21046:"4cb6c19a",21181:"ea3ffc82",21342:"a766a857",21360:"9286a297",21364:"f7c9e078",21534:"8ae04122",22182:"f1ad83b2",22228:"125d93c1",22938:"c95aa39f",23259:"03ccf92d",23324:"1ce91f4c",23427:"bd80aa65",23840:"562ca3e9",23937:"610f2c47",24260:"22e2140b",24386:"ae79aff5",24498:"7bef3f04",24726:"280646e4",24904:"9d887a11",24907:"31bc5d88",25204:"33f367df",25211:"d496897e",25314:"ab69fe56",25817:"70e3b13c",25821:"b9a87183",26011:"reactPlayerFilePlayer",26026:"51dec273",26348:"c104141c",26536:"3ed6e2e9",26557:"5e486140",26690:"4816649b",27135:"5e30269e",27168:"4ec4c6cd",27177:"4f9e8711",27268:"57a8015d",27328:"423842d7",27449:"0e4ec2e4",27722:"213182ef",27806:"fab06caf",27910:"c358ebbc",27918:"17896441",28143:"7e2ae3df",28145:"006e489c",28263:"82170cf7",28437:"5b10a003",28682:"8eeedb31",29112:"c09ab32f",29234:"86f8c256",29579:"09b168a7",29661:"5e95c892",29693:"123a454a",29709:"838cf899",30027:"3353503a",30060:"0547cb65",30397:"6194ac84",30466:"0e3a398f",30808:"271a7b09",30901:"ae4a775b",31441:"382c5d2b",31512:"7fa133e1",31647:"3b5edcc4",32472:"65a10ffa",32778:"608238a8",33067:"62e21724",33233:"59a6f192",33279:"456c0e28",33356:"54d805e4",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",36088:"88efc5aa",36248:"e3f28bf9",36424:"a3002291",37007:"8593ff01",37073:"0f54081d",37245:"b678a236",37437:"3d8d8999",37438:"9c021584",37573:"48b6ff5f",37683:"df2a6e58",37698:"cd23aec9",37836:"7cde3c49",37918:"10ce918d",38056:"905702d2",38134:"1515c895",38290:"3fe48f60",38860:"0d040286",39179:"79551407",39558:"f41c0109",39613:"1fbe0675",39620:"b51a9aee",40070:"86f2a982",40486:"ed2a4846",40569:"8519c2b0",40592:"b39cdcf9",40683:"3e2b82eb",40816:"4d71dffe",41032:"a67ca768",41169:"a2d1ff94",41619:"6494b798",41644:"9db962b6",41705:"94fb813f",41798:"bd65ec7e",41838:"6108ac41",41976:"0c4fad6b",42205:"b66ca8cf",42326:"7b477840",42423:"91008145",43010:"56c3a9b2",43163:"232c546d",43274:"23a8e291",43474:"db22fd17",43505:"72486833",43546:"57e01cd5",43871:"065365b3",44157:"83e10f72",44422:"416d4fcf",44619:"a9fa5b1f",44781:"12f1535e",45033:"9af13eab",45255:"71c11e3b",45326:"af231220",45346:"7f0476bd",45708:"97d49594",45765:"d18d294a",45835:"7547d3bb",46103:"ccc49370",46623:"b104dd1e",46738:"8dbb6800",47389:"612345e6",47596:"reactPlayerDailyMotion",47679:"83245ae6",47875:"021eaa84",48123:"f86eb50f",48176:"5660752d",48215:"1cfced13",48610:"6875c492",48901:"640277b9",48926:"60c82955",49076:"494e8e75",49867:"44287967",50465:"f7b7f9b7",50649:"512fbd77",51051:"107d77e6",51171:"7e5a2776",51320:"46669adc",51499:"180d0c5f",51843:"a2ffcc0f",51978:"fe0d4a0f",52343:"97c7db18",52525:"1a906644",52535:"814f3328",52546:"reactPlayerStreamable",52920:"e0277333",52950:"67eba1be",53237:"1df93b7f",53273:"cc922df3",53479:"883e2c3c",53604:"cd7fa15a",53608:"9e4087bc",53691:"7be672a3",53800:"97eb992d",54063:"0fa6e9bf",54175:"dfdb391e",54194:"1d31e443",54373:"b5114993",54632:"edb40f78",54672:"03685665",54766:"2f238e8e",54774:"42b67a8e",55029:"04c3832a",55904:"931e3b0a",56805:"f7197f43",56843:"9f97f9d1",56870:"5a3b561f",57034:"3e03f778",57138:"38a042e4",57149:"822c343e",57220:"7591d420",57321:"92b08985",57366:"75281220",57368:"6e30ac7b",57549:"bdb8b81b",57694:"fd702dc7",57881:"2658ced2",58216:"874690d0",58221:"6af14956",58262:"059d1c6a",58673:"d9673b17",58739:"7a957b04",58792:"5db8318c",58800:"e6fb1369",58989:"d4bf7e47",59081:"5a7aef43",59341:"a35cf155",59671:"0e384e19",59860:"d1163e47",60203:"c6aad055",60205:"83d480e9",60334:"a3f8794a",60563:"c685778b",60564:"8b4ba22f",60574:"14ae68e7",60637:"91392348",60810:"254d0ff5",61021:"901c37e5",61281:"e983a6d7",61305:"73f9658e",61425:"fc8a94e3",61573:"87a5fc8a",61866:"1369aff7",61896:"25622900",62283:"74b658de",62789:"c239db97",62871:"604e05e4",63154:"c6346fcf",63190:"e546fc5a",63407:"b8ec852b",63652:"6e92edd9",63707:"8c6c72f9",63863:"f771dec1",64013:"01a85c17",64258:"reactPlayerMux",64315:"16914cba",64389:"d739767a",64438:"f20efc55",64439:"reactPlayerYouTube",64471:"cfdfe126",64651:"94f3d131",64891:"a30c0d44",65144:"1ee92283",65191:"d103759a",65248:"6101b3fc",65375:"97615df2",65619:"f6cf66bc",65776:"f0e3a130",66e3:"95646edb",66464:"adcef0a2",66521:"014457dd",67141:"b5abacaa",67363:"583db3ef",67411:"b15eeff9",67480:"eb17771c",67539:"5c25e6fa",67622:"dbbb982f",67690:"030ccfd9",67739:"efc2a09d",68059:"ca165b51",68097:"ff2f63f6",68445:"99245987",68732:"3132913e",68811:"3289a752",68888:"reactPlayerVidyard",68893:"ba1dc56d",68974:"8a864d1e",69006:"a08dfa31",69133:"02e265ea",69469:"3b85f227",69584:"b8eb0fce",69845:"a7b96653",70010:"33942509",70225:"e1a2ab10",70406:"0cbb83d7",70534:"4b8121dd",70595:"24dadce3",70633:"1fc83a28",70900:"fe1a05e2",70985:"814402d7",71625:"de311ed4",71796:"64134c03",71869:"c2ccf160",71874:"cc6d9416",71970:"adfdec4a",72079:"1a16e8bf",72092:"148448cb",72179:"34767260",72491:"c71cae97",72896:"abc85917",72931:"e6c31e60",72996:"7a21ccb0",73177:"fc923f19",73285:"ed603d23",73636:"8b4dd820",73714:"894e67a6",73743:"reactPlayerVimeo",73867:"c7cac05f",74121:"55960ee5",74340:"2bb2c1cd",74961:"4c5becac",75167:"5046ea8f",75208:"f6cd0d3d",75247:"3c39daba",75273:"e69dadab",75290:"bf11c6a2",75542:"0102eb3e",75689:"c544b2d7",75741:"f27eaf88",75862:"ada86621",76091:"19e69ccd",76158:"51e516cc",76240:"cb49f262",76267:"94324b0e",76518:"9dd60997",76721:"654eb3dd",76932:"aaabcfd8",77060:"7c7a772e",77319:"67fccd64",77401:"ca1234c1",77536:"f6e0e63c",77683:"01821883",78514:"d651e2ee",79106:"d4840880",79649:"5bc09a53",80053:"935f2afb",80161:"3f66023b",80171:"c925d092",80182:"c276ecb2",80325:"98ced590",80355:"b5b19789",80448:"49bee2be",80511:"fb8cd692",80900:"4ec76dfa",80945:"df322e14",80954:"8c8ef21f",81145:"e84cabb0",81580:"fee0a0be",81676:"819ef483",81900:"4c217c25",82144:"09788c0c",82163:"c813bd67",82178:"ba322490",82388:"bbf561d5",82409:"df4d464e",82424:"b6be2912",82451:"fb50ea3a",82667:"368cce37",83039:"825ec378",83152:"33a21d7d",83672:"8785b74d",83868:"1b2af15e",83870:"5df556a2",83973:"f523fb3f",84059:"9cb03f5d",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",86272:"7500e360",86335:"271ff0d1",86477:"a38d285e",86528:"2cb13d6d",86661:"43be69c9",87213:"0877aebd",87664:"reactPlayerPreview",87714:"7bdcd7a7",87759:"ff38b1ce",88055:"reactPlayerWistia",88089:"6eafe0c7",88566:"9dce5486",89106:"72dd8f7e",89251:"b9287eb6",89372:"07f59c2a",89472:"5a9a7a02",89626:"81e486a8",89731:"9d2d4743",89799:"4f425ff4",89944:"08570680",89950:"12eb386e",90051:"185c52e7",90125:"7d9edfb8",90522:"308aae28",90533:"b2b675dd",90681:"cdf64ea9",91447:"4974f5d2",91721:"3a38a610",91893:"871ce139",92082:"e85ba0e6",92111:"79665d43",92217:"d7fbbe43",92423:"7258860f",92514:"b5ec5208",92599:"e44de27e",92786:"81b69ac7",92916:"91fe1403",92955:"e6412603",92958:"86063cd3",93089:"a6aa9e1f",93317:"846a5e19",93401:"c2865a15",94331:"e38c422a",94368:"a94703ab",95594:"f6360934",95625:"657ac0bc",95921:"fbfd390f",96017:"6a1fe514",96049:"f213dd13",96120:"35300761",96514:"a826efc5",96590:"bb8cfc40",96987:"caddb1c0",97159:"a8ce95ee",97227:"71748509",97251:"ba5b9f11",97586:"ac353d25",97767:"17612ae7",97847:"43b416ef",97920:"1a4e3797",97953:"e88443f3",98170:"bab44fba",98532:"d1b15a6d",98960:"6bf124c2",99124:"dc23cd40",99387:"b0f1c099",99494:"93e05602",99924:"df203c0f",99979:"987564cc"}[e]||e)+"."+{125:"d64be048",523:"562a43f2",648:"9b5a36d6",743:"b6bef3d2",745:"597852b8",822:"77eef700",886:"0c28b7a8",899:"3759a417",955:"7666bfbb",1074:"fd3d60f8",1516:"0438e79c",1837:"2599a454",1868:"1e68703a",2193:"e0ae080f",2221:"6c6b2315",2281:"c947655c",2353:"97d668e1",2866:"8252e773",2883:"1a8d7e23",3102:"1196e28e",3207:"06460fe8",3408:"b9e2e547",3537:"57441f53",3584:"edec704e",3667:"65995e2c",3745:"91d5e17b",3879:"772bbb02",3984:"e6d0fc05",4004:"159a6a62",4117:"0ed50e42",4220:"867fda2c",4459:"72e55476",4918:"22642899",4929:"aa554ec9",5018:"076affc0",5240:"69fe84b9",5414:"c0e2876c",5417:"8d05d07e",5477:"5328b998",5674:"4e66892c",5697:"f7bb8c4c",5886:"54764f63",6082:"9582348f",6098:"b31ab9f5",6102:"682886b9",6125:"b843d475",6266:"85586986",6639:"6dd4865a",7371:"dba84eb4",7377:"01db6196",7809:"8b5ab072",7849:"1994a464",8039:"5f4f85e0",9055:"e35876bd",9500:"8bb8cb2a",9973:"df3f1309",10038:"50f87830",10114:"8e5d4d62",10138:"201dc12d",10235:"5253edff",10261:"91ba2584",10347:"522378b8",10349:"7d28f7e4",10379:"212d2b1f",10449:"ae04e529",10485:"d159372a",10579:"a65e59af",10588:"a577bd65",10921:"c7612966",11077:"e1d5d91d",11161:"0a97aa4c",11297:"a4df4b1e",11477:"da6afc79",11713:"41b89384",11724:"0be29d98",11856:"5c00e7a3",11859:"a8454d3d",11981:"19428fa3",12121:"99398064",12323:"1e784e4c",12864:"eabd4d09",13100:"9b3e485a",13239:"9b75822c",13317:"d9a894b1",13573:"7692fe45",13751:"2834334f",13826:"cfacb70c",14026:"cfa53ebb",14069:"263ec6c5",14077:"555a9011",14094:"98140877",14142:"fb8007b9",14356:"24792eaf",14499:"5462fb52",14824:"d6352c85",15150:"abb98eed",15554:"dbcae126",16311:"bc57616e",16467:"239ec341",16586:"e38ca1f7",16696:"f8ec3a84",16728:"7a6b235f",16855:"60a94deb",17134:"9a920315",17194:"95f2e3a7",17285:"e5e26d6f",17329:"cc60c712",17708:"8f8d5f25",17741:"d04a108b",18315:"57e4ce2c",18518:"74ea80fc",18649:"72975580",18768:"142353e8",18880:"122e00d9",19043:"c222b4d1",19093:"b6586be4",19492:"44b401b0",19536:"d764a4f4",19537:"99228fe5",19841:"d50edb80",20044:"fd5078df",20138:"b4e44632",20205:"bcd754dd",20406:"c2a2c38c",20873:"003efd71",21046:"d7eed07e",21181:"50414916",21342:"30b260b0",21360:"84365624",21364:"f0651411",21534:"5d030365",22182:"d50b3f1d",22228:"62423075",22938:"0d4d7006",23259:"7be24bb2",23324:"772ecb17",23427:"07a29926",23840:"12ea908e",23937:"0d2aa192",24260:"be32d1c9",24386:"a02b0b95",24498:"2a0b9418",24726:"44065112",24904:"139663b0",24907:"fa6a5f0e",25204:"c05326f5",25211:"653492b3",25314:"d7d08ca0",25817:"2034da55",25821:"20a8f42b",26011:"55e8cd60",26026:"b9067a03",26070:"4d45da95",26348:"6dae7802",26536:"5ce1080c",26557:"8fe86923",26690:"f11e59cb",27135:"34c618e1",27168:"b7831e25",27177:"bbd18f66",27268:"7d826a7d",27328:"c3922d88",27449:"94277040",27722:"5d3cadad",27806:"41515d02",27910:"8906be27",27918:"9524d19b",28143:"4280abc5",28145:"6621468b",28263:"da09643d",28437:"e57f7289",28682:"844b4391",29112:"7151f8bf",29234:"466d0ae2",29579:"c9c98e87",29661:"a8c5c3e9",29693:"18a2679b",29709:"3715a5e9",30027:"600ace6f",30060:"9966a371",30397:"6415f904",30466:"983c8ec6",30808:"a77b281e",30901:"839510da",31441:"175a58cb",31512:"bd68b85a",31647:"9a853bf3",32472:"9ee441da",32778:"c3b4a521",33067:"82dcbf9f",33233:"bdf41c70",33279:"27dcf5a9",33356:"a5d47a8f",33940:"7099efb4",34322:"d3e9af23",34479:"43bce9c3",34617:"916fe218",34670:"60f01632",34770:"c5ad9b81",34884:"e4137a89",35137:"b724f400",35281:"7d259e69",35425:"49b7253c",35572:"9ee49dd1",35584:"ffd1d330",35711:"f33aa64e",36006:"d71a505f",36075:"51c888a4",36088:"99334aee",36166:"ae8d5da7",36248:"d055211d",36274:"3999e913",36424:"b3dadeca",37007:"4481ecf7",37073:"789a7dd1",37245:"77357544",37437:"18784825",37438:"11a67353",37573:"973515e0",37683:"5de9dabd",37698:"bb549ff3",37737:"5704e252",37836:"006b7055",37918:"b99573a9",38056:"04a3dd7a",38134:"6929d8ee",38290:"69c46f65",38860:"984f694e",39179:"9c02c2f1",39558:"ca55a7d0",39613:"ccd83d73",39620:"7b963828",40070:"772b8eef",40486:"06d649a8",40569:"151d6303",40592:"b51a6136",40683:"bc92317e",40816:"4140b82b",41032:"e65e1418",41169:"02a3412b",41619:"25e58aff",41644:"3dc46992",41705:"eb015864",41798:"964a9392",41838:"6b564fbb",41976:"a3c675d8",42205:"50cd9fa9",42326:"046ec119",42423:"81ffd509",43010:"57b0b164",43163:"a002687f",43274:"53f0f9ff",43474:"d6e67f67",43505:"11faca4a",43546:"8635c150",43871:"17d68896",44157:"6d2d45ae",44366:"ac8e857d",44422:"12805bec",44619:"619c6397",44781:"62107737",45033:"156822f7",45255:"e33ee667",45326:"c0091348",45346:"e7165f51",45708:"6213b55f",45760:"518ecc83",45765:"7567b0f7",45835:"fffbdd9e",46103:"58dc5a5e",46623:"253f6d4b",46738:"33f9cde6",47389:"7d26d63e",47596:"23612a4e",47679:"a3a8ea10",47875:"9b24192f",48123:"1d740de9",48176:"a6691a3d",48215:"299c257f",48610:"f2fc0d53",48901:"c441a0a4",48926:"c82ac906",49076:"64e87537",49867:"e926313c",50465:"4979375d",50649:"ed12ebe0",51051:"e3726056",51171:"4405dd1f",51320:"c54854c8",51499:"472b25a6",51843:"fa69250d",51978:"c0fe8ef4",52343:"ff81a9aa",52525:"4287c938",52535:"95122141",52546:"04c929f6",52920:"a556bd3b",52950:"86b64c58",53237:"86bb93c8",53273:"a4836f17",53479:"87b41090",53604:"ddeb4938",53608:"a538e352",53691:"b49551db",53800:"b86d82bb",54063:"e677d805",54175:"87ab6b06",54191:"8c190567",54194:"9ec124f0",54373:"81d24852",54632:"211eec30",54672:"6162a7d2",54766:"5c132030",54774:"1d462849",54854:"be433bea",55029:"6651a368",55904:"e529feb3",56805:"fca65cde",56843:"7b647ccc",56870:"13e81fd0",57034:"614e0d73",57076:"e0be15c4",57138:"784fdd6b",57149:"cd1a641f",57220:"5d3b07a6",57321:"3381bcd2",57366:"6066919e",57368:"a0526b47",57549:"c7c6e5e2",57694:"3ba9d8f5",57881:"a7f9e4d8",58216:"087af6c1",58221:"1f9f3dfd",58262:"af56993b",58673:"e4cec172",58739:"2a7c0f37",58792:"5b84086f",58800:"0b6a0c6b",58989:"b7ba0274",59081:"39e50b6c",59341:"e324817d",59671:"1fce19a0",59812:"747fd838",59860:"42aa0e91",60055:"47d63b75",60203:"555a74ca",60205:"bcd01292",60334:"66644bd9",60563:"b56125f4",60564:"354e65d0",60574:"563eb837",60637:"249ac3d9",60810:"0cfbe8c9",61021:"1ced2fd9",61281:"83a88cd3",61305:"55449af1",61425:"c63568f9",61573:"e2b44fde",61866:"f757bd1d",61896:"4c7314c3",62283:"0a0f47e0",62789:"ccd7100d",62871:"01d5de6a",63154:"44dde863",63190:"e8f570b5",63407:"49cb4e11",63652:"c9596b0e",63707:"5f8a72f5",63863:"e744a9ff",64013:"1a6fdbcd",64258:"98bf19a2",64315:"22f20107",64389:"15a11c1a",64438:"71218c42",64439:"545b7965",64471:"cf276977",64651:"83484b26",64891:"9dae885d",65144:"5ea9394d",65191:"d028e56e",65248:"15726df6",65375:"ffd4e048",65619:"9cd66d41",65776:"bfc7e258",65909:"6f4a66dd",66e3:"0cab0632",66464:"b0e2c17e",66521:"9f7d80bb",67141:"632ed7c1",67363:"94996820",67411:"3e7fee51",67480:"27114010",67539:"0f2c4f44",67622:"c2389c88",67690:"6701e3f5",67739:"f155baf5",68059:"a474b20a",68097:"50c9ef93",68445:"cf318a20",68732:"f39d3682",68811:"d62612ef",68888:"19f0621a",68893:"c3b6574d",68974:"2ec45b44",69006:"b783495f",69133:"ad9275bb",69469:"f0e72ec7",69584:"8183041a",69845:"2d642c31",70010:"1130bc9f",70225:"5778db0c",70335:"eb92c593",70406:"aae45e88",70534:"591638a7",70595:"cfee6fc8",70633:"8bbe08a8",70900:"7e1fe783",70985:"4b3642f5",71625:"30cc2127",71796:"0c1b6feb",71869:"012c2d06",71874:"77f78036",71970:"9cd2751b",72079:"a69416ae",72092:"cd99b6a9",72179:"d1aa2cb8",72491:"1151b393",72896:"770b956c",72931:"c452f930",72996:"f92ed0dc",73177:"c804119f",73285:"9b191ba4",73313:"3477b0dc",73636:"0b13ed1c",73714:"0f599071",73743:"b8146bc5",73867:"4f3bb4ed",74121:"0cf5f978",74340:"5a1566a9",74961:"0f710a8d",74988:"2c75a852",75167:"9a75988c",75208:"e9026238",75247:"7403678c",75273:"0288ce06",75290:"32c6fa76",75542:"ec2383d1",75689:"fecd5a8d",75741:"dc3e64e4",75862:"c3602068",76091:"579209e3",76158:"ea14e931",76240:"12625b18",76267:"b1164170",76518:"245c5ffe",76721:"0c77501b",76932:"35a658b1",77060:"8c0ceae2",77319:"3f6541ed",77401:"08eea4e3",77536:"c4c34141",77683:"af5c3e62",78514:"9b52cf76",79106:"ee644da5",79649:"d139a151",80053:"871626e5",80161:"6b74b140",80171:"c1eb3c81",80182:"41214a75",80299:"6c9cc63a",80325:"ea0aabec",80355:"b8bf6475",80448:"a456763c",80511:"d16ceec6",80900:"136bc8a2",80945:"cde0433d",80954:"1e58e7ca",81145:"9acc24b5",81580:"9c93ed65",81676:"24de4cc2",81900:"8f39ef22",82144:"411cc9b7",82163:"14b66b49",82178:"5e6c0628",82388:"a996de8b",82409:"afbd410d",82424:"768365e5",82451:"ebd7b23f",82667:"58a7c4be",83039:"6b40b5e1",83152:"d32438bd",83672:"7bda79f2",83868:"51cc6247",83870:"42bd8ed9",83973:"136bac57",84059:"297978cb",84413:"e8792067",84507:"67706045",84513:"67e59d17",84573:"74575088",84667:"ec612995",84940:"7aedef41",84960:"8ae196d0",85067:"511c9e62",85210:"e66536f0",85240:"87dc9608",85376:"eb70aa8e",85632:"9695e3da",85714:"0f34acb7",85799:"65f13e39",86112:"b16878c3",86216:"42cf6854",86272:"e298db0a",86335:"a6cdce94",86477:"efa86be3",86528:"4bd23de0",86661:"9e2f4325",86730:"ad9e2eb6",87213:"3d19e135",87430:"f97de055",87664:"0aa437ad",87714:"72e3436d",87759:"4815ef1c",88055:"fef9a984",88089:"80d11545",88566:"47fd3bfa",89106:"5fab4320",89127:"77dc02e4",89251:"e2287fd2",89372:"a8a22719",89472:"a8f5f98e",89626:"72fe0ae6",89731:"6470cd8c",89799:"f22994fc",89944:"51882b32",89950:"8cd4f506",90051:"81fc27f9",90125:"19b21b61",90522:"23870609",90533:"c6a598f6",90681:"cb4bb158",91447:"03fc55d5",91721:"c2f3b4bc",91893:"91af4629",92082:"10234da7",92111:"d9e8a59e",92217:"940c3f0f",92423:"306f4d7e",92514:"0849894e",92599:"ae2b1a86",92786:"e88b3c8e",92916:"a5eec8d0",92955:"0551d01b",92958:"e902e9b7",93041:"3bde6a31",93089:"816fd652",93317:"7ebede6a",93401:"fed21e58",94331:"674e4b74",94368:"34c5df8a",94875:"1f649e1a",95594:"60b6a643",95625:"8def3e87",95628:"42c1eef6",95921:"9219e308",96017:"ba067b5b",96049:"e453c09e",96120:"2078a56d",96514:"bd821785",96590:"0da3827f",96987:"130ef5f8",97159:"37700053",97227:"ed3b7894",97251:"f942b3df",97586:"18021336",97767:"8a1f3e26",97847:"d9bd67f8",97920:"d2061f7d",97953:"5a00b1f0",98170:"3d298f80",98327:"12f5691c",98532:"451ee39f",98960:"d4225910",99124:"cdc36a02",99387:"b5652495",99494:"587c5eda",99924:"bd589dbb",99964:"1414e8fb",99979:"dbded3c8"}[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={17896441:"27918",25622900:"61896",33942509:"70010",34767260:"72179",35300761:"96120",44287967:"49867",67386898:"20406",71748509:"97227",72486833:"43505",75281220:"57366",79551407:"39179",91008145:"42423",91392348:"60637",92496324:"19492",95366386:"34617",99245987:"68445","814d49b7":"125",a0323d9f:"523","714e70d1":"648","61d4c13a":"743","64abd3af":"745",a00af9f0:"822","7aa856d6":"886",b985118d:"899","39ae3791":"955","9e8f4e9c":"1074","8abd0ba5":"1516",dec87402:"1837","46b3c144":"1868",c5b2f0f9:"2193","827765d9":"2221","920c2ac2":"2281","92d7df62":"2353",e064f6d4:"2866",bb6a5560:"2883","3462068c":"3102","6603ef13":"3207","3ba80b69":"3408","3819c331":"3537",ed75cfcb:"3584",b6d76a6c:"3667","3109d9d2":"3745","2d629ea6":"3879","160cb329":"3984",a334b453:"4004",fd684bd6:"4117","2bbe04e6":"4220","19eded63":"4459","24bda87b":"4918","330dfcdb":"4929",cd509849:"5018","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","786fee93":"7371","708d858d":"7377","07305c4a":"7809","927c84a6":"8039",e7923b27:"9055","4213e5b1":"9973",bc873533:"10038",e665718d:"10114","6269f1c0":"10138","5ee1b5d8":"10235",reactPlayerKaltura:"10261",bc816bf2:"10347",a943bcee:"10379","8873cf50":"10485",d46ef83d:"10579","7afa6340":"10588",c37b4a03:"10921","49d9416a":"11077",a4794f2e:"11161","34cf6fc7":"11297",b2f554cd:"11477",a7023ddc:"11713","5087625a":"11724","2295be0e":"11859",b799648a:"11981",reactPlayerFacebook:"12121","6c80b6fe":"12323",e7477a94:"12864",f0e279fe:"13100",bd45720e:"13239",d83f208d:"13317",be228752:"13573","3720c009":"13751","01a1d0f4":"13826","9c540f0b":"14026","40d377be":"14077","17d2ebc8":"14142",a9a76bf7:"14356","73f18a6f":"14499","06a27da2":"14824","732d4d9b":"15150","1dfee34e":"15554",c25913f3:"16311","878aa0e7":"16467","183053be":"16586","6477cdc2":"16696",d9407a00:"16728",b7bb2d93:"16855","0b40a488":"17134","9f2f2cb3":"17194",c1ca9e21:"17285","04a546a4":"17329","688ee267":"17708","7d88b63f":"17741",a7bd4aaa:"18518","49a2e93c":"18649","524ce9a0":"18768",deccabf3:"18880","473de3ed":"19043","0029a336":"19093","0e72c11a":"19536",c1584a80:"19537",d9b4ee1e:"19841",d66cbd9e:"20044","54590fd2":"20138","2340b3ee":"20205",cabda5f8:"20873","4cb6c19a":"21046",ea3ffc82:"21181",a766a857:"21342","9286a297":"21360",f7c9e078:"21364","8ae04122":"21534",f1ad83b2:"22182","125d93c1":"22228",c95aa39f:"22938","03ccf92d":"23259","1ce91f4c":"23324",bd80aa65:"23427","562ca3e9":"23840","610f2c47":"23937","22e2140b":"24260",ae79aff5:"24386","7bef3f04":"24498","280646e4":"24726","9d887a11":"24904","31bc5d88":"24907","33f367df":"25204",d496897e:"25211",ab69fe56:"25314","70e3b13c":"25817",b9a87183:"25821",reactPlayerFilePlayer:"26011","51dec273":"26026",c104141c:"26348","3ed6e2e9":"26536","5e486140":"26557","4816649b":"26690","5e30269e":"27135","4ec4c6cd":"27168","4f9e8711":"27177","57a8015d":"27268","423842d7":"27328","0e4ec2e4":"27449","213182ef":"27722",fab06caf:"27806",c358ebbc:"27910","7e2ae3df":"28143","006e489c":"28145","82170cf7":"28263","5b10a003":"28437","8eeedb31":"28682",c09ab32f:"29112","86f8c256":"29234","09b168a7":"29579","5e95c892":"29661","123a454a":"29693","838cf899":"29709","3353503a":"30027","0547cb65":"30060","6194ac84":"30397","0e3a398f":"30466","271a7b09":"30808",ae4a775b:"30901","382c5d2b":"31441","7fa133e1":"31512","3b5edcc4":"31647","65a10ffa":"32472","608238a8":"32778","62e21724":"33067","59a6f192":"33233","456c0e28":"33279","54d805e4":"33356",fe716911:"33940","69c5f318":"34322","0c14b239":"34479","450c2e30":"34770",e1c8d71f:"34884","41b2e801":"35137","8cb0269b":"35281",b4df9b48:"35425","6774f806":"35572",b52d840d:"35584","79f18c88":"36006","86e64757":"36075","88efc5aa":"36088",e3f28bf9:"36248",a3002291:"36424","8593ff01":"37007","0f54081d":"37073",b678a236:"37245","3d8d8999":"37437","9c021584":"37438","48b6ff5f":"37573",df2a6e58:"37683",cd23aec9:"37698","7cde3c49":"37836","10ce918d":"37918","905702d2":"38056","1515c895":"38134","3fe48f60":"38290","0d040286":"38860",f41c0109:"39558","1fbe0675":"39613",b51a9aee:"39620","86f2a982":"40070",ed2a4846:"40486","8519c2b0":"40569",b39cdcf9:"40592","3e2b82eb":"40683","4d71dffe":"40816",a67ca768:"41032",a2d1ff94:"41169","6494b798":"41619","9db962b6":"41644","94fb813f":"41705",bd65ec7e:"41798","6108ac41":"41838","0c4fad6b":"41976",b66ca8cf:"42205","7b477840":"42326","56c3a9b2":"43010","232c546d":"43163","23a8e291":"43274",db22fd17:"43474","57e01cd5":"43546","065365b3":"43871","83e10f72":"44157","416d4fcf":"44422",a9fa5b1f:"44619","12f1535e":"44781","9af13eab":"45033","71c11e3b":"45255",af231220:"45326","7f0476bd":"45346","97d49594":"45708",d18d294a:"45765","7547d3bb":"45835",ccc49370:"46103",b104dd1e:"46623","8dbb6800":"46738","612345e6":"47389",reactPlayerDailyMotion:"47596","83245ae6":"47679","021eaa84":"47875",f86eb50f:"48123","5660752d":"48176","1cfced13":"48215","6875c492":"48610","640277b9":"48901","60c82955":"48926","494e8e75":"49076",f7b7f9b7:"50465","512fbd77":"50649","107d77e6":"51051","7e5a2776":"51171","46669adc":"51320","180d0c5f":"51499",a2ffcc0f:"51843",fe0d4a0f:"51978","97c7db18":"52343","1a906644":"52525","814f3328":"52535",reactPlayerStreamable:"52546",e0277333:"52920","67eba1be":"52950","1df93b7f":"53237",cc922df3:"53273","883e2c3c":"53479",cd7fa15a:"53604","9e4087bc":"53608","7be672a3":"53691","97eb992d":"53800","0fa6e9bf":"54063",dfdb391e:"54175","1d31e443":"54194",b5114993:"54373",edb40f78:"54632","03685665":"54672","2f238e8e":"54766","42b67a8e":"54774","04c3832a":"55029","931e3b0a":"55904",f7197f43:"56805","9f97f9d1":"56843","5a3b561f":"56870","3e03f778":"57034","38a042e4":"57138","822c343e":"57149","7591d420":"57220","92b08985":"57321","6e30ac7b":"57368",bdb8b81b:"57549",fd702dc7:"57694","2658ced2":"57881","874690d0":"58216","6af14956":"58221","059d1c6a":"58262",d9673b17:"58673","7a957b04":"58739","5db8318c":"58792",e6fb1369:"58800",d4bf7e47:"58989","5a7aef43":"59081",a35cf155:"59341","0e384e19":"59671",d1163e47:"59860",c6aad055:"60203","83d480e9":"60205",a3f8794a:"60334",c685778b:"60563","8b4ba22f":"60564","14ae68e7":"60574","254d0ff5":"60810","901c37e5":"61021",e983a6d7:"61281","73f9658e":"61305",fc8a94e3:"61425","87a5fc8a":"61573","1369aff7":"61866","74b658de":"62283",c239db97:"62789","604e05e4":"62871",c6346fcf:"63154",e546fc5a:"63190",b8ec852b:"63407","6e92edd9":"63652","8c6c72f9":"63707",f771dec1:"63863","01a85c17":"64013",reactPlayerMux:"64258","16914cba":"64315",d739767a:"64389",f20efc55:"64438",reactPlayerYouTube:"64439",cfdfe126:"64471","94f3d131":"64651",a30c0d44:"64891","1ee92283":"65144",d103759a:"65191","6101b3fc":"65248","97615df2":"65375",f6cf66bc:"65619",f0e3a130:"65776","95646edb":"66000",adcef0a2:"66464","014457dd":"66521",b5abacaa:"67141","583db3ef":"67363",b15eeff9:"67411",eb17771c:"67480","5c25e6fa":"67539",dbbb982f:"67622","030ccfd9":"67690",efc2a09d:"67739",ca165b51:"68059",ff2f63f6:"68097","3132913e":"68732","3289a752":"68811",reactPlayerVidyard:"68888",ba1dc56d:"68893","8a864d1e":"68974",a08dfa31:"69006","02e265ea":"69133","3b85f227":"69469",b8eb0fce:"69584",a7b96653:"69845",e1a2ab10:"70225","0cbb83d7":"70406","4b8121dd":"70534","24dadce3":"70595","1fc83a28":"70633",fe1a05e2:"70900","814402d7":"70985",de311ed4:"71625","64134c03":"71796",c2ccf160:"71869",cc6d9416:"71874",adfdec4a:"71970","1a16e8bf":"72079","148448cb":"72092",c71cae97:"72491",abc85917:"72896",e6c31e60:"72931","7a21ccb0":"72996",fc923f19:"73177",ed603d23:"73285","8b4dd820":"73636","894e67a6":"73714",reactPlayerVimeo:"73743",c7cac05f:"73867","55960ee5":"74121","2bb2c1cd":"74340","4c5becac":"74961","5046ea8f":"75167",f6cd0d3d:"75208","3c39daba":"75247",e69dadab:"75273",bf11c6a2:"75290","0102eb3e":"75542",c544b2d7:"75689",f27eaf88:"75741",ada86621:"75862","19e69ccd":"76091","51e516cc":"76158",cb49f262:"76240","94324b0e":"76267","9dd60997":"76518","654eb3dd":"76721",aaabcfd8:"76932","7c7a772e":"77060","67fccd64":"77319",ca1234c1:"77401",f6e0e63c:"77536","01821883":"77683",d651e2ee:"78514",d4840880:"79106","5bc09a53":"79649","935f2afb":"80053","3f66023b":"80161",c925d092:"80171",c276ecb2:"80182","98ced590":"80325",b5b19789:"80355","49bee2be":"80448",fb8cd692:"80511","4ec76dfa":"80900",df322e14:"80945","8c8ef21f":"80954",e84cabb0:"81145",fee0a0be:"81580","819ef483":"81676","4c217c25":"81900","09788c0c":"82144",c813bd67:"82163",ba322490:"82178",bbf561d5:"82388",df4d464e:"82409",b6be2912:"82424",fb50ea3a:"82451","368cce37":"82667","825ec378":"83039","33a21d7d":"83152","8785b74d":"83672","1b2af15e":"83868","5df556a2":"83870",f523fb3f:"83973","9cb03f5d":"84059",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","7500e360":"86272","271ff0d1":"86335",a38d285e:"86477","2cb13d6d":"86528","43be69c9":"86661","0877aebd":"87213",reactPlayerPreview:"87664","7bdcd7a7":"87714",ff38b1ce:"87759",reactPlayerWistia:"88055","6eafe0c7":"88089","9dce5486":"88566","72dd8f7e":"89106",b9287eb6:"89251","07f59c2a":"89372","5a9a7a02":"89472","81e486a8":"89626","9d2d4743":"89731","4f425ff4":"89799","08570680":"89944","12eb386e":"89950","185c52e7":"90051","7d9edfb8":"90125","308aae28":"90522",b2b675dd:"90533",cdf64ea9:"90681","4974f5d2":"91447","3a38a610":"91721","871ce139":"91893",e85ba0e6:"92082","79665d43":"92111",d7fbbe43:"92217","7258860f":"92423",b5ec5208:"92514",e44de27e:"92599","81b69ac7":"92786","91fe1403":"92916",e6412603:"92955","86063cd3":"92958",a6aa9e1f:"93089","846a5e19":"93317",c2865a15:"93401",e38c422a:"94331",a94703ab:"94368",f6360934:"95594","657ac0bc":"95625",fbfd390f:"95921","6a1fe514":"96017",f213dd13:"96049",a826efc5:"96514",bb8cfc40:"96590",caddb1c0:"96987",a8ce95ee:"97159",ba5b9f11:"97251",ac353d25:"97586","17612ae7":"97767","43b416ef":"97847","1a4e3797":"97920",e88443f3:"97953",bab44fba:"98170",d1b15a6d:"98532","6bf124c2":"98960",dc23cd40:"99124",b0f1c099:"99387","93e05602":"99494",df203c0f:"99924","987564cc":"99979"}[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 8596c4fcff3..0d6c6a62547 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 4685ea40a64..0415f820982 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 419bbdd3ca8..35645b11931 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 186bd8d9fb8..bc7af012a3a 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 b976896ac8d..d54732eee1b 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 9dcd25178d9..1cb7185b7b0 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 b94ddcf299e..5d67b0d0018 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 49af4b13c53..df64816b984 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 8d47c363b6e..410bbaf7115 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 f0c0c4cdd6f..591f27f184b 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 a711d7b2124..4e81e4b2f79 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 8a3b8652bab..8e353d5ca53 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.2.html b/blog/podman-desktop-release-1.2.html index d75a46a0d1e..71647240cc3 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 af7cbd31b7a..64eabad2303 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 9997a6dfbe8..a86630f89c3 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 8110f57f4cc..8c1dc0edfaf 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 0f22306719d..89f4e82926e 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 57de50ec85f..b21e757a68e 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 8bd323d574e..e70f42f40ab 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 f5bc8f2b68e..819b2a47629 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 9c964237e8d..08cba99c972 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 2694461079f..c1def838b4f 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 5b06d47d3ce..2166867f5f0 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 cef0185ecdd..7cc9a7db8b3 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 4d2de716012..30b49c686e1 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 18270dc56d7..7c781c91bf2 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 80c74eb7c71..d038dcbad2c 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 6850d0c558f..db865b8e595 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 69cd367cc83..71c0fce34ea 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 102ea511fd4..a7b60cd530b 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 95e7b35764b..054afd6b65a 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 6305d122068..1a5116d968a 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 a8da85e4b45..4892965ab1b 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 385f8732d72..0e2ff4ae7f3 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 647515b7d63..49d5776bc58 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 ceb2898f361..338a97e72b1 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 a5bbdec3b25..eb306d97c8e 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 9c8ac68b39d..62f9154bfcb 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 279b8a52b27..dfd8b56a522 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 eafb7ecb12b..3871427bf58 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 07be8a4fdc1..2413e208042 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 08fe930357a..218eab7f60d 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 242093711f7..87486c388b2 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 833ed0dca44..fb7d651b823 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 1bd9322a854..23f2a5d8623 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 6990fd6d472..5107085e309 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 d9a0ed7c3e0..bf4f06678c7 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 38f83dfc93a..130bf2878a2 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 cd02f01f50c..3ddc761e6da 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 ee974536a46..4aefb21bf39 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 2aa72d2d10c..cd959b80cf6 100644 --- a/core-values.html +++ b/core-values.html @@ -13,7 +13,7 @@ - + diff --git a/docs/compose.html b/docs/compose.html index 6ca9a43183b..a0bc2d96ef0 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 70bb17ab035..14abd63a6fe 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 d74cff3b3aa..0bb6beb7647 100644 --- a/docs/compose/setting-up-compose.html +++ b/docs/compose/setting-up-compose.html @@ -13,7 +13,7 @@ - + diff --git a/docs/containers.html b/docs/containers.html index f63acaa4d33..0b1b168ebfc 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 9d73f2f6458..d948a777f47 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 10e10db5762..3b33620dedc 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 ee405263fa3..dabb97ddb87 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 ff4b65934fa..794a74ee0e1 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 9c66b501469..2c3744770d8 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 f0e7bc844b0..4457d703a4f 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 ca422fb23ec..45ed14a8a87 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 65736bd3ac4..93d88f4628a 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 d8af94d00ba..ef97f561bcc 100644 --- a/docs/extensions.html +++ b/docs/extensions.html @@ -13,7 +13,7 @@ - + diff --git a/docs/extensions/install.html b/docs/extensions/install.html index ed1242e1641..30b01097b79 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 572e35f4af8..d4a0b4cc6b0 100644 --- a/docs/extensions/publish.html +++ b/docs/extensions/publish.html @@ -13,7 +13,7 @@ - + diff --git a/docs/extensions/write.html b/docs/extensions/write.html index e2b047f68a7..1dde061f670 100644 --- a/docs/extensions/write.html +++ b/docs/extensions/write.html @@ -13,7 +13,7 @@ - + diff --git a/docs/extensions/write/adding-icons.html b/docs/extensions/write/adding-icons.html index ebecd03888e..06ef4c077dd 100644 --- a/docs/extensions/write/adding-icons.html +++ b/docs/extensions/write/adding-icons.html @@ -13,7 +13,7 @@ - + diff --git a/docs/extensions/write/onboarding-workflow.html b/docs/extensions/write/onboarding-workflow.html index ac0a9680e13..116417cf0d3 100644 --- a/docs/extensions/write/onboarding-workflow.html +++ b/docs/extensions/write/onboarding-workflow.html @@ -13,7 +13,7 @@ - + diff --git a/docs/extensions/write/when-clause-context.html b/docs/extensions/write/when-clause-context.html index 0024d8105b3..8dec77c0574 100644 --- a/docs/extensions/write/when-clause-context.html +++ b/docs/extensions/write/when-clause-context.html @@ -13,7 +13,7 @@ - + diff --git a/docs/installation.html b/docs/installation.html index c3b35abcdef..0f255a4ae46 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 39203d4c72e..f3199a30afc 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 e43caa4a4a7..d0d83ef92f8 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 4d3430eacc0..9a2d3dcb39b 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 73685454fa8..59f0ce94d88 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 071d31e1df7..981d2780743 100644 --- a/docs/intro.html +++ b/docs/intro.html @@ -13,7 +13,7 @@ - + diff --git a/docs/kind.html b/docs/kind.html index 89d769b325d..1311ff96ebf 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 fc066ceac3e..3233e1d8a0c 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 44328486a7c..b527d8f1297 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 6d9457dea17..6c9bb26b6a3 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 009e73f033c..c297014f244 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 bb9e0296369..3a75bde8f53 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 53ba35b657d..603c2162b2f 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 9de06574cc5..7e57e63f151 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 8d7b1619f49..e778cd37547 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 36a94770355..e55352d6863 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 0effcb406a8..e873aa1cc87 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 f6e7963f094..3281b2857c7 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 2b100bf29fe..91c71a385f2 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 c8777dad94b..c3dd847d367 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 6c7baf2b0b5..a794c8c564a 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 0b0ea7bd2f7..5ccb3f0f7e1 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 ba967241c4f..495ec90437c 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 6284f01e15c..ebb1cca9ffc 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 4b6f4aa50a6..011b9603bbc 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 f179fa22863..02308ec38d0 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 d2b643f941c..729f42159cc 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 cf90dbce4dd..e78cc615799 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 972a780fc12..5d2dc495c79 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 685e0826d55..48f5b892872 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 54f185fad8e..e582043bd06 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 555879ebd54..0c0652a892a 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 51e5b36ad89..27a6d32339b 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 2b6d42d03e2..86383989022 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 1f6be27ad63..636ea3355b6 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 611fb3a1232..2f3529f7705 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 46dd7f85878..ca24aed128d 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 f710d727415..351eda66dd0 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 3dc6ba50f37..0d93a1dbc07 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 2ae31d5f17c..581f12488e3 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 ea591233126..d484ab0184b 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 d31cf4d470f..4260f6dce60 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 8bd202f9fec..6bb437d349a 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 51fd521c6f9..9d2ec02387f 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 ed5a4e154fc..32694404f89 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 96077a55424..5ce7e6799b8 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 6f05ce80258..9f4de16e0f8 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 ae09596c645..9e00c9a81fc 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 63353d177d2..f34ae590c2f 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 4cffd82fc56..57453da5a67 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 d810da99ddf..1b13d5cefbf 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 b0a5f8a00aa..db3994c162f 100644 --- a/docs/proxy.html +++ b/docs/proxy.html @@ -13,7 +13,7 @@ - + diff --git a/docs/tags.html b/docs/tags.html index daf9391cf16..4f7bf2d8f8a 100644 --- a/docs/tags.html +++ b/docs/tags.html @@ -13,7 +13,7 @@ - + diff --git a/docs/tags/compose.html b/docs/tags/compose.html index 933a62042f7..254d187a7fc 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 1c803a90e1d..de922cd387a 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 29f2d9bd614..d1a0894ad4f 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 e0a88831658..516aac97e54 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 115f0e2a796..79b647e6293 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 dfe35ca9b40..be9eed50c83 100644 --- a/docs/tags/flatpak.html +++ b/docs/tags/flatpak.html @@ -13,7 +13,7 @@ - + diff --git a/docs/tags/icons.html b/docs/tags/icons.html index fb66ebb4537..b34d3a2fb74 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 4ededf32b76..40322d38642 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 a08b20f28a8..f08a8509430 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 688ed682b51..c1aeddbb900 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 1652dd0a20f..2067c4cb4eb 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 63ffbd18bb3..74fda7f3cc5 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 f9bf620c402..edb47f96acc 100644 --- a/docs/tags/linux.html +++ b/docs/tags/linux.html @@ -13,7 +13,7 @@ - + diff --git a/docs/tags/mac-0-s.html b/docs/tags/mac-0-s.html index 3f16ac65439..3d8ada6a7c1 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 708c56ca179..ba6cad40603 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 7546fe41c8f..510cd2bc634 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 73b98dd9ac0..2ba7eeb8dfb 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 e79922cfeba..107bded7133 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 852013cc279..c2c040aa809 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 399c766443e..079b5813489 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 21b9e441083..b7ded86cb40 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 93dfac81730..e96624c4ab1 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 4e8abe96198..61627c32b17 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 c81640bd9aa..627076fcbaa 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 fe107ef4410..0dc73d71a4c 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 228e620773f..6bc7142d125 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 e54eb88f274..8eb8a87f856 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 dbb6108ea1f..3ef45deadc9 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 c0f5db48530..208af28a987 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 c67a44d9547..372d8f0f864 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 508a4ceb9e8..cb5f171a2bd 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 8fdce39fbb7..83185816483 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 de98ed3f857..42ff089d907 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 41e80f3b728..245de950650 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 88faccbeba7..12c44c7e792 100644 --- a/downloads.html +++ b/downloads.html @@ -13,7 +13,7 @@ - + diff --git a/downloads/linux.html b/downloads/linux.html index a06770ddd07..907aef87c02 100644 --- a/downloads/linux.html +++ b/downloads/linux.html @@ -13,7 +13,7 @@ - + diff --git a/downloads/macos.html b/downloads/macos.html index 4f530448e0f..7521ea5e170 100644 --- a/downloads/macos.html +++ b/downloads/macos.html @@ -13,7 +13,7 @@ - + diff --git a/downloads/windows.html b/downloads/windows.html index 743ed504554..3c3bc3e0abd 100644 --- a/downloads/windows.html +++ b/downloads/windows.html @@ -13,7 +13,7 @@ - + diff --git a/extend.html b/extend.html index 9ee76f57f95..e71f36aa48e 100644 --- a/extend.html +++ b/extend.html @@ -13,7 +13,7 @@ - + diff --git a/features.html b/features.html index ee6f7ac236d..d1b2a232205 100644 --- a/features.html +++ b/features.html @@ -13,7 +13,7 @@ - + diff --git a/index.html b/index.html index c18b2fd5f2c..995f31ccbb2 100644 --- a/index.html +++ b/index.html @@ -13,7 +13,7 @@ - + diff --git a/search.html b/search.html index 74ddd7bbd43..62b7ab20a12 100644 --- a/search.html +++ b/search.html @@ -13,7 +13,7 @@ - +