electron/docs/api
arno renevier 81bdba67ec
feat: Implement password delegate for NSS (#41205)
* feat: Implement password delegate for NSS (#41188)

Introduce an app event client-certificate-request-password. It allows
the user to display a UI to prompt for the password.

An alternative would have been to implement a class similar to
CryptoModulePasswordDialogView, to provide the UI. This might have been
simpler for the user, comparing to letting them implement the UI. But it
seems like electron does not have an i18n framework, so it's not
possible to provide a locale aware UI.

* fix lint:markdown error

* address review comments

* use a trampoline handler in JS. The api exposed is now app.setClientCertRequestPasswordHandler
* use properties on the Event object instead of positional parameters
* remove ChromeNSSCryptoModuleDelegate::OnPassword in favor of args->GetNext(&password_)

* address review comments second round

- backslash escape parametrized TypeScript
- rename hostName param to hostname
- use base::ScopedAllowBaseSyncPrimitivesForTesting
- and then, rename ChromeNSSCryptoModuleDelegate to ElectronNSSCryptoModuleDelegate

* Update docs/api/app.md

Co-authored-by: Sam Maddock <samuel.maddock@gmail.com>

* Update docs/api/app.md

Co-authored-by: Erick Zhao <erick@hotmail.ca>

---------

Co-authored-by: Arno Renevier <arnaud@switchboard.app>
Co-authored-by: Sam Maddock <samuel.maddock@gmail.com>
Co-authored-by: Erick Zhao <erick@hotmail.ca>
2024-07-17 09:48:03 -04:00
..
structures feat: enable Windows Control Overlay on Linux (#41769) 2024-06-27 14:56:36 +02:00
accelerator.md docs: note accelerator case insensitivity (#40783) 2024-01-04 10:06:12 -05:00
app.md feat: Implement password delegate for NSS (#41205) 2024-07-17 09:48:03 -04:00
auto-updater.md docs: ensure all links are on a single line (#42235) 2024-05-28 11:15:18 -07:00
base-window.md feat: enable Windows Control Overlay on Linux (#41769) 2024-06-27 14:56:36 +02:00
browser-view.md feat: replace BrowserView with WebContentsView (#35658) 2023-12-13 13:01:03 -08:00
browser-window.md feat: enable Windows Control Overlay on Linux (#41769) 2024-06-27 14:56:36 +02:00
client-request.md build: add Markdown lint check for unescaped angle brackets (#41753) 2024-04-04 14:50:35 -04:00
clipboard.md chore: extend linting of code blocks in the docs (#40245) 2023-11-21 16:50:08 +09:00
command-line-switches.md docs: add backticks around example URL (#42536) 2024-06-17 16:35:26 -07:00
command-line.md chore: extend linting of code blocks in the docs (#40245) 2023-11-21 16:50:08 +09:00
content-tracing.md docs: ensure all links are on a single line (#42235) 2024-05-28 11:15:18 -07:00
context-bridge.md chore: update @electron/lint-roller to 2.1.0 (#42078) 2024-05-10 11:00:15 +02:00
cookies.md chore: extend linting of code blocks in the docs (#40245) 2023-11-21 16:50:08 +09:00
crash-reporter.md docs: backslash escape parametrized TypeScript types (#41575) 2024-03-25 11:19:44 +01:00
debugger.md chore: extend linting of code blocks in the docs (#40245) 2023-11-21 16:50:08 +09:00
desktop-capturer.md chore: extend linting of code blocks in the docs (#40245) 2023-11-21 16:50:08 +09:00
dialog.md docs: correct the return value for canceled showSaveDialog (#41926) 2024-04-23 11:29:14 -04:00
dock.md docs: fix the Apple HIG link for Dock context menu (#42450) 2024-06-13 15:24:05 -05:00
download-item.md feat: add getPercentComplete / getCurrentBytesPerSecond / getEndTime to DownloadItem (#42805) 2024-07-15 19:32:44 -04:00
environment-variables.md docs: ensure all links are on a single line (#42235) 2024-05-28 11:15:18 -07:00
extensions.md docs: ensure all links are on a single line (#42235) 2024-05-28 11:15:18 -07:00
global-shortcut.md chore: extend linting of code blocks in the docs (#40245) 2023-11-21 16:50:08 +09:00
in-app-purchase.md feat: added username to IAP purchaseProduct method (#35902) 2022-12-12 10:11:48 -08:00
incoming-message.md feat: add net module to utility process (#40017) 2024-01-04 16:20:37 -05:00
ipc-main.md docs: backslash escape parametrized TypeScript types (#41575) 2024-03-25 11:19:44 +01:00
ipc-renderer.md docs: ensure all links are on a single line (#42235) 2024-05-28 11:15:18 -07:00
menu-item.md docs: use "id" instead of "label" for positions (#41843) 2024-04-14 17:10:09 -07:00
menu.md docs: use "id" instead of "label" for positions (#41843) 2024-04-14 17:10:09 -07:00
message-channel-main.md chore: type check JS in docs (#38423) 2023-06-05 16:26:26 +09:00
message-port-main.md docs: fix broken links (#36519) 2022-12-05 13:18:57 -05:00
native-image.md docs: nativeImage api cleanup (#41519) 2024-03-12 12:33:56 -04:00
native-theme.md feat: add nativeTheme.inForcedColorsMode (#32956) 2022-03-21 10:30:02 +01:00
navigation-history.md feat: duplicate navigation related APIs to contents.navigationHistory (#41752) 2024-06-05 09:34:47 -07:00
net-log.md chore: extend linting of code blocks in the docs (#40245) 2023-11-21 16:50:08 +09:00
net.md docs - Update net.md (#42691) 2024-07-01 14:45:49 -04:00
notification.md fix: Windows Toast notification dismissal from Action Center (#40197) 2023-10-17 19:33:00 -04:00
parent-port.md docs: fix broken links (#36519) 2022-12-05 13:18:57 -05:00
power-monitor.md feat: add thermal states to powerMonitor (#37935) 2023-04-19 11:46:55 +02:00
power-save-blocker.md chore: extend linting of code blocks in the docs (#40245) 2023-11-21 16:50:08 +09:00
process.md chore: bump chromium to 124.0.6323.0 (main) (#41412) 2024-02-29 10:31:13 +01:00
protocol.md docs: ensure all links are on a single line (#42235) 2024-05-28 11:15:18 -07:00
push-notifications.md docs: backslash escape parametrized TypeScript types (#41575) 2024-03-25 11:19:44 +01:00
safe-storage.md docs: clarify security semantics of safeStorage (#42666) 2024-06-26 13:24:06 -07:00
screen.md chore: extend linting of code blocks in the docs (#40245) 2023-11-21 16:50:08 +09:00
service-workers.md chore: extend linting of code blocks in the docs (#40245) 2023-11-21 16:50:08 +09:00
session.md docs: ensure all links are on a single line (#42235) 2024-05-28 11:15:18 -07:00
share-menu.md docs: type names changed from wrapper to primitive (#31752) 2021-11-15 22:13:18 -06:00
shell.md chore: extend linting of code blocks in the docs (#40245) 2023-11-21 16:50:08 +09:00
system-preferences.md feat: expose system preferences to utility process (#42203) 2024-06-20 11:15:57 -04:00
touch-bar-button.md docs: type names changed from wrapper to primitive (#31752) 2021-11-15 22:13:18 -06:00
touch-bar-color-picker.md docs: type names changed from wrapper to primitive (#31752) 2021-11-15 22:13:18 -06:00
touch-bar-group.md fix: ensure the typescript definitions only export correct value types (#28712) 2021-06-15 13:50:31 -07:00
touch-bar-label.md docs: type names changed from wrapper to primitive (#31752) 2021-11-15 22:13:18 -06:00
touch-bar-other-items-proxy.md fix: ensure the typescript definitions only export correct value types (#28712) 2021-06-15 13:50:31 -07:00
touch-bar-popover.md docs: type names changed from wrapper to primitive (#31752) 2021-11-15 22:13:18 -06:00
touch-bar-scrubber.md docs: type names changed from wrapper to primitive (#31752) 2021-11-15 22:13:18 -06:00
touch-bar-segmented-control.md docs: type names changed from wrapper to primitive (#31752) 2021-11-15 22:13:18 -06:00
touch-bar-slider.md docs: type names changed from wrapper to primitive (#31752) 2021-11-15 22:13:18 -06:00
touch-bar-spacer.md docs: type names changed from wrapper to primitive (#31752) 2021-11-15 22:13:18 -06:00
touch-bar.md chore: extend linting of code blocks in the docs (#40245) 2023-11-21 16:50:08 +09:00
tray.md docs: nativeImage api cleanup (#41519) 2024-03-12 12:33:56 -04:00
utility-process.md docs: Properly document runAsNode utility process option (#41255) 2024-02-06 15:54:36 -08:00
view.md feat: customize border radius of Views (#42320) 2024-07-16 20:16:25 -04:00
web-contents-view.md feat: Allow WebContentsView to accept webContents object. (#42086) 2024-05-30 12:45:35 -07:00
web-contents.md docs: grammar fix in isBeingCaptured docs (#42692) 2024-07-01 15:01:27 -04:00
web-frame-main.md docs: ensure all links are on a single line (#42235) 2024-05-28 11:15:18 -07:00
web-frame.md chore: extend linting of code blocks in the docs (#40245) 2023-11-21 16:50:08 +09:00
web-request.md docs: backslash escape parametrized TypeScript types (#41575) 2024-03-25 11:19:44 +01:00
web-utils.md feat: add webUtils module with getPathForFile method (#38776) 2023-11-20 15:59:36 -08:00
webview-tag.md fix: fixed the type of WebviewTag.webpreferences (#42275) 2024-05-25 22:06:06 -07:00
window-open.md chore: extend linting of code blocks in the docs (#40245) 2023-11-21 16:50:08 +09:00