You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/api/dialog.md
+4-4
Original file line number
Diff line number
Diff line change
@@ -52,8 +52,8 @@ The `dialog` module has the following methods:
52
52
boxes.
53
53
*`securityScopedBookmarks` Boolean (optional) _masOS__mas_ - Create [security scoped bookmarks](https://developer.apple.com/library/content/documentation/Security/Conceptual/AppSandboxDesignGuide/AppSandboxInDepth/AppSandboxInDepth.html#//apple_ref/doc/uid/TP40011183-CH3-SW16) when packaged for the Mac App Store.
54
54
*`callback` Function (optional)
55
-
*`filePaths` String[] - An array of file paths chosen by the user
56
-
*`bookmarks` String[]_macOS__mas_ - An array matching the `filePaths` array of base64 encoded strings which contains security scoped bookmark data. `securityScopedBookmarks` must be enabled for this to be populated.
55
+
*`filePaths` String[](optional) - An array of file paths chosen by the user. If the dialog is cancelled this will be `undefined`.
56
+
*`bookmarks` String[](optional) _macOS__mas_ - An array matching the `filePaths` array of base64 encoded strings which contains security scoped bookmark data. `securityScopedBookmarks` must be enabled for this to be populated.
57
57
58
58
Returns `String[]`, an array of file paths chosen by the user,
59
59
if the callback is provided it returns `undefined`.
@@ -103,8 +103,8 @@ shown.
103
103
defaults to `true`.
104
104
*`securityScopedBookmarks` Boolean (optional) _masOS__mas_ - Create a [security scoped bookmark](https://developer.apple.com/library/content/documentation/Security/Conceptual/AppSandboxDesignGuide/AppSandboxInDepth/AppSandboxInDepth.html#//apple_ref/doc/uid/TP40011183-CH3-SW16) when packaged for the Mac App Store. If this option is enabled and the file doesn't already exist a blank file will be created at the chosen path.
105
105
*`callback` Function (optional)
106
-
*`filename` String
107
-
*`bookmark` String _macOS__mas_ - Base64 encoded string which contains the security scoped bookmark data for the saved file. `securityScopedBookmarks` must be enabled for this to be present.
106
+
*`filename` String (optional) If the dialog is cancelled this will be `undefined`.
107
+
*`bookmark` String (optional) _macOS__mas_ - Base64 encoded string which contains the security scoped bookmark data for the saved file. `securityScopedBookmarks` must be enabled for this to be present.
108
108
109
109
Returns `String`, the path of the file chosen by the user,
0 commit comments