Enumeration

NSURLBookmarkCreationOptions

Options used when creating bookmark data.

Declaration

typedef enum NSURLBookmarkCreationOptions : NSUInteger {
    ...
} NSURLBookmarkCreationOptions;

Overview

When creating a bookmark, use bitwise OR operators to combine the options you want to specify, and provide them to the options parameter of the bookmarkDataWithOptions:includingResourceValuesForKeys:relativeToURL:error: method.

Version-Notes

Security-scoped bookmarks are not available in versions of macOS prior to OS X v10.7.3.

Topics

Constants

NSURLBookmarkCreationPreferFileIDResolution

Specifies that when a bookmark created with this option is resolved, its embedded file ID should take precedence over other sources of information (file system path, for example) in the event of a conflict.

Deprecated
NSURLBookmarkCreationMinimalBookmark

Specifies that a bookmark created with this option should be created with minimal information. This produces a smaller bookmark that can be resolved in fewer ways.

NSURLBookmarkCreationSuitableForBookmarkFile

Specifies that the bookmark data should include properties required to create Finder alias files.

NSURLBookmarkCreationWithSecurityScope

Specifies that you want to create a security-scoped bookmark that, when resolved, provides a security-scoped URL allowing read/write access to a file-system resource; for use in an app that adopts App Sandbox. For more information, see App Sandbox Design Guide. Note that this flag cannot be used in conjunction with either NSURLBookmarkCreationMinimalBookmark or NSURLBookmarkCreationSuitableForBookmarkFile.

NSURLBookmarkCreationSecurityScopeAllowOnlyReadAccess

When combined with the NSURLBookmarkCreationWithSecurityScope option, specifies that you want to create a security-scoped bookmark that, when resolved, provides a security-scoped URL allowing read-only access to a file-system resource; for use in an app that adopts App Sandbox. For more information, see App Sandbox Design Guide.

See Also

Working with Bookmark Data

+ bookmarkDataWithContentsOfURL:error:

Initializes and returns bookmark data derived from an alias file pointed to by a specified URL.

- bookmarkDataWithOptions:includingResourceValuesForKeys:relativeToURL:error:

Returns a bookmark for the URL, created with specified options and resource values.

+ resourceValuesForKeys:fromBookmarkData:

Returns the resource values for properties identified by a specified array of keys contained in specified bookmark data.

+ writeBookmarkData:toURL:options:error:

Creates an alias file on disk at a specified location with specified bookmark data.

- startAccessingSecurityScopedResource

In an app that has adopted App Sandbox, makes the resource pointed to by a security-scoped URL available to the app.

- stopAccessingSecurityScopedResource

In an app that adopts App Sandbox, revokes access to the resource pointed to by a security-scoped URL.

NSURLBookmarkFileCreationOptions

Options used when creating file bookmark data

NSURLBookmarkResolutionOptions

Options used when resolving bookmark data.