https://github.com/japlscript/japlfind
Java API for Apple's Finder (macOS)
https://github.com/japlscript/japlfind
apple applescript finder japlscript java macos
Last synced: 5 months ago
JSON representation
Java API for Apple's Finder (macOS)
- Host: GitHub
- URL: https://github.com/japlscript/japlfind
- Owner: japlscript
- License: lgpl-2.1
- Created: 2021-09-18T14:07:09.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2022-07-14T08:02:11.000Z (over 3 years ago)
- Last Synced: 2025-07-11T15:42:59.360Z (7 months ago)
- Topics: apple, applescript, finder, japlscript, java, macos
- Language: Java
- Homepage:
- Size: 772 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://www.gnu.org/licenses/old-licenses/lgpl-2.1.html)
[](https://maven-badges.herokuapp.com/maven-central/com.tagtraum/japlfind)
[](https://github.com/japlscript/japlfind/actions)
# Japlfind
*Japlfind* is a Java API for the Apple Finder app (macOS) based on
[JaplScript](https://github.com/japlscript/japlscript).
## Installation
Japlfind is released via [Maven](https://maven.apache.org).
You can install it via the following dependency:
```xml
com.tagtraum
japlfind
```
The Maven artifacts also contain sources and javadocs.
If you are using [modules](https://en.wikipedia.org/wiki/Java_Platform_Module_System),
its name is `tagtraum.japlfind`.
## Usage
To use the generated code, do something like this:
```java
import com.tagtraum.macos.finder.Application;
public class StartupDisk {
public static void main(final String[] args) {
// get application
final Application application = Application.getInstance();
final Disk startupDisk = application.getStartupDisk();
System.out.println("Startup Disk: " + startupDisk.getName() + ", Format: " + startupDisk.getFormat());
}
}
```
## API
You can find the complete [API here](https://japlscript.github.io/japlfind/com/tagtraum/macos/finder/package-summary.html).
## AppleScript Sandbox
Since macOS 10.14 (Mojave), Apple imposed a sandbox on AppleScript. Therefore
you may see dialog boxes requesting authorization to perform certain actions.
After a while, these boxes simply disappear and there does not seem to be an easy
way to authorize your app. In this case, you need to open the system preferences,
navigate to *Security & Privacy*, *Privacy*, and then *Automation*, and make
sure your app is allowed to remote control whatever app you are trying to remote
control (see also [this article](https://blog.beatunes.com/2018/10/beatunes-on-mojave-and-windows-10-dark.html)).
If you are shipping a real app with a UI and not just a command line tool, you
need to customize the sandbox permission dialog. You can do so by adding
the key `NSAppleEventsUsageDescription` to your app bundle's `/Contents/Info.plist`
file. For example:
[...]
NSAppleEventsUsageDescription
SuperMusic uses AppleEvents to access your Music.app library,
e.g., to set BPM values or create playlists.
[...]
Apple's documentation for the keyword is [here](https://developer.apple.com/documentation/bundleresources/information_property_list/nsappleeventsusagedescription).