From 82ea3faae5442318ba0154aef32850a5a4bd0ee3 Mon Sep 17 00:00:00 2001 From: Calvin Date: Mon, 9 Dec 2024 11:44:43 -0700 Subject: [PATCH] docs: update security scoped bookmarks info (#44968) --- docs/api/dialog.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/api/dialog.md b/docs/api/dialog.md index 81458ddece3b..27590bf6c209 100644 --- a/docs/api/dialog.md +++ b/docs/api/dialog.md @@ -360,7 +360,7 @@ On Windows the options are more limited, due to the Win32 APIs used: ## Bookmarks array -`showOpenDialog`, `showOpenDialogSync`, `showSaveDialog`, and `showSaveDialogSync` will return a `bookmarks` array. +`showOpenDialog` and `showSaveDialog` resolve to an object with a `bookmarks` field. This field is an array of Base64 encoded strings that contain the [security scoped bookmark](https://developer.apple.com/library/content/documentation/Security/Conceptual/AppSandboxDesignGuide/AppSandboxInDepth/AppSandboxInDepth.html#//apple_ref/doc/uid/TP40011183-CH3-SW16) data for the saved file. The `securityScopedBookmarks` option must be enabled for this to be present. | Build Type | securityScopedBookmarks boolean | Return Type | Return Value | |------------|---------------------------------|:-----------:|--------------------------------|