Module tagtraum.japlphoto

Package com.tagtraum.macos.photos

Interface Application

All Superinterfaces:

Reference

@Code("capp")
@Name("application")
public interface Application
extends Reference

The application's top-level scripting object.

Author:

JaplScript 3.4.11

Field Summary

Fields

Modifier and Type	Field	Description
static Set<Class<?>>	APPLICATION_CLASSES	All classes belonging to this application.
static TypeClass	CLASS

Method Summary

Modifier and Type	Method	Description
void	add(MediaItem[] theListOfMediaItemsToAdd, Album theAlbumToAddTo)	Add media items to an album.
int	count(Reference theObjectsToBeCounted, TypeClass theClassOfObjectsToBeCounted)	Return the number of elements of a particular class within an object.
default int	countAlbums()	All user created albums in the library, in no specific order.
int	countAlbums(String filter)	All user created albums in the library, in no specific order.
default int	countContainers()	Top level containers in the library, including user created albums and folders, as well as the favorites album.
int	countContainers(String filter)	Top level containers in the library, including user created albums and folders, as well as the favorites album.
default int	countFolders()	All user created folders in the library, in no specific order.
int	countFolders(String filter)	All user created folders in the library, in no specific order.
default int	countMediaItems()	Media items in the library.
int	countMediaItems(String filter)	Media items in the library.
default int	countMoments()	Moments in the library.
int	countMoments(String filter)	Moments in the library.
void	delete(Album theAlbumOrFolderToDelete)	Delete an object.
void	delete(Folder theAlbumOrFolderToDelete)	Delete an object.
MediaItem	duplicate(MediaItem theMediaItemToDuplicate)	Duplicate an object.
boolean	exists(Reference theObjectSToCheck)	Verify that an object exists.
void	export(MediaItem[] theListOfMediaItemsToExport, JaplScriptFile theDestinationOfTheExport, boolean exportTheOriginalFilesIfTrueOtherwiseExportRenderedJpgsDefaultsToFalse)	Export media items to the specified location as files.
Album	getAlbum(int index)	All user created albums in the library, in no specific order.
Album	getAlbum(Id id)	All user created albums in the library, in no specific order.
default Album[]	getAlbums()	All user created albums in the library, in no specific order.
Album[]	getAlbums(String filter)	All user created albums in the library, in no specific order.
Container	getContainer(int index)	Top level containers in the library, including user created albums and folders, as well as the favorites album.
Container	getContainer(Id id)	Top level containers in the library, including user created albums and folders, as well as the favorites album.
default Container[]	getContainers()	Top level containers in the library, including user created albums and folders, as well as the favorites album.
Container[]	getContainers(String filter)	Top level containers in the library, including user created albums and folders, as well as the favorites album.
Album	getFavoritesAlbum()	Favorited media items album.
Folder	getFolder(int index)	All user created folders in the library, in no specific order.
Folder	getFolder(Id id)	All user created folders in the library, in no specific order.
default Folder[]	getFolders()	All user created folders in the library, in no specific order.
Folder[]	getFolders(String filter)	All user created folders in the library, in no specific order.
static Application	getInstance()	Returns an instance for application Photos.
Album	getLastImportAlbum()	Last import album.
MediaItem	getMediaItem(int index)	Media items in the library.
MediaItem	getMediaItem(Id id)	Media items in the library.
default MediaItem[]	getMediaItems()	Media items in the library.
MediaItem[]	getMediaItems(String filter)	Media items in the library.
Moment	getMoment(int index)	Moments in the library.
Moment	getMoment(Id id)	Moments in the library.
default Moment[]	getMoments()	Moments in the library.
Moment[]	getMoments(String filter)	Moments in the library.
String	getName()	The name of the application.
Map<String,Object>	getProperties()	Returns all properties for an instance of this class.
Album	getRecentlyDeletedAlbum()	The set of recently deleted media items.
MediaItem[]	getSelection()	The currently selected media items in the application.
String	getVersion()	The version number of the application.
MediaItem[]	import_(JaplScriptFile[] theListOfFilesToCopy, Album theAlbumToImportInto, boolean skipDuplicateCheckingAndImportEverythingDefaultsToFalse)	Import files into the library.
boolean	isFrontmost()	Is this the active application?
boolean	isSlideshowRunning()	Returns true if a slideshow is currently running.
Album	make(TypeClass theClassOfTheNewObjectAllowedValuesAreAlbumOrFolder, String theNameOfTheNewObject, Folder theParentFolderForTheNewObject)	Create a new object.
<T extends Reference> T	make(Class<T> klass)	Create a new object.
void	nextSlide()	Skip to next slide in currently-playing slideshow.
void	open(JaplScriptFile thePhotoLibraryToBeOpened)	Open a photo library.
void	pauseSlideshow()	Pause the currently-playing slideshow.
void	previousSlide()	Skip to previous slide in currently-playing slideshow.
void	quit()	Quit the application.
void	resumeSlideshow()	Resume the currently-playing slideshow.
MediaItem[]	search(String theTextToSearchFor)	Search for items matching the search string.
void	spotlight(Container theFullPathToTheImage)	Show the image at path in the application, used to show spotlight search results.
void	spotlight(MediaItem theFullPathToTheImage)	Show the image at path in the application, used to show spotlight search results.
void	spotlight(String theFullPathToTheImage)	Show the image at path in the application, used to show spotlight search results.
void	startSlideshow(MediaItem[] theMediaItemsToShow)	Display an ad-hoc slide show from a list of media items, an album, or a folder.
void	stopSlideshow()	End the currently-playing slideshow.

Methods inherited from interface com.tagtraum.japlscript.Reference

cast, getApplicationReference, getObjectReference, getTypeClass, isInstanceOf

Field Detail

CLASS

static final TypeClass CLASS

APPLICATION_CLASSES

static final Set<Class<?>> APPLICATION_CLASSES

All classes belonging to this application.

Method Detail

count

@Kind("command")
@Name("count")
int count(Reference theObjectsToBeCounted,
          @Parameter("each")
          TypeClass theClassOfObjectsToBeCounted)

Return the number of elements of a particular class within an object.

Parameters:

theObjectsToBeCounted - The objects to be counted.

theClassOfObjectsToBeCounted - The class of objects to be counted.

Returns:

The count.

exists

@Kind("command")
@Name("exists")
boolean exists(Reference theObjectSToCheck)

Verify that an object exists.

Parameters:

theObjectSToCheck - The object(s) to check.

Returns:

Did the object(s) exist?

open

@Kind("command")
@Name("open")
void open(JaplScriptFile thePhotoLibraryToBeOpened)

Open a photo library.

Parameters:

thePhotoLibraryToBeOpened - The photo library to be opened.

quit

@Kind("command")
@Name("quit")
void quit()

Quit the application.

import_

@Kind("command")
@Name("import")
MediaItem[] import_(JaplScriptFile[] theListOfFilesToCopy,
                    @Parameter("into")
                    Album theAlbumToImportInto,
                    @Parameter("skip check duplicates")
                    boolean skipDuplicateCheckingAndImportEverythingDefaultsToFalse)

Import files into the library.

Parameters:

theListOfFilesToCopy - The list of files to copy.

theAlbumToImportInto - The album to import into.

skipDuplicateCheckingAndImportEverythingDefaultsToFalse - Skip duplicate checking and import everything, defaults to false.

Returns:

The imported media items in an array

export

@Kind("command")
@Name("export")
void export(MediaItem[] theListOfMediaItemsToExport,
            @Parameter("to")
            JaplScriptFile theDestinationOfTheExport,
            @Parameter("using originals")
            boolean exportTheOriginalFilesIfTrueOtherwiseExportRenderedJpgsDefaultsToFalse)

Export media items to the specified location as files.

Parameters:

theListOfMediaItemsToExport - The list of media items to export.

theDestinationOfTheExport - The destination of the export.

exportTheOriginalFilesIfTrueOtherwiseExportRenderedJpgsDefaultsToFalse - Export the original files if true, otherwise export rendered jpgs. defaults to false.

duplicate

@Kind("command")
@Name("duplicate")
MediaItem duplicate(MediaItem theMediaItemToDuplicate)

Duplicate an object. Only media items can be duplicated.

Parameters:

theMediaItemToDuplicate - The media item to duplicate

Returns:

The duplicated media item

make

@Kind("command")
@Name("make")
Album make(@Parameter("new")
           TypeClass theClassOfTheNewObjectAllowedValuesAreAlbumOrFolder,
           @Parameter("named")
           String theNameOfTheNewObject,
           @Parameter("at")
           Folder theParentFolderForTheNewObject)

Create a new object. Only new albums and folders can be created.

Parameters:

theClassOfTheNewObjectAllowedValuesAreAlbumOrFolder - The class of the new object, allowed values are album or folder

theNameOfTheNewObject - The name of the new object.

theParentFolderForTheNewObject - The parent folder for the new object.

Returns:

The new object.

make

@Kind("make")
<T extends Reference> T make(Class<T> klass)

Create a new object. Only new albums and folders can be created.

Parameters:

klass - Java type of the object to create.

Returns:

a new object of type klass

delete

@Kind("command")
@Name("delete")
void delete(Album theAlbumOrFolderToDelete)

Delete an object. Only albums and folders can be deleted.

Parameters:

theAlbumOrFolderToDelete - The album or folder to delete.

delete

@Kind("command")
@Name("delete")
void delete(Folder theAlbumOrFolderToDelete)

Delete an object. Only albums and folders can be deleted.

Parameters:

theAlbumOrFolderToDelete - The album or folder to delete.

add

@Kind("command")
@Name("add")
void add(MediaItem[] theListOfMediaItemsToAdd,
         @Parameter("to")
         Album theAlbumToAddTo)

Add media items to an album.

Parameters:

theListOfMediaItemsToAdd - The list of media items to add.

theAlbumToAddTo - The album to add to.

startSlideshow

@Kind("command")
@Name("start slideshow")
void startSlideshow(@Parameter("using")
                    MediaItem[] theMediaItemsToShow)

Display an ad-hoc slide show from a list of media items, an album, or a folder.

Parameters:

theMediaItemsToShow - The media items to show.

stopSlideshow

@Kind("command")
@Name("stop slideshow")
void stopSlideshow()

End the currently-playing slideshow.

nextSlide

@Kind("command")
@Name("next slide")
void nextSlide()

Skip to next slide in currently-playing slideshow.

previousSlide

@Kind("command")
@Name("previous slide")
void previousSlide()

Skip to previous slide in currently-playing slideshow.

pauseSlideshow

@Kind("command")
@Name("pause slideshow")
void pauseSlideshow()

Pause the currently-playing slideshow.

resumeSlideshow

@Kind("command")
@Name("resume slideshow")
void resumeSlideshow()

Resume the currently-playing slideshow.

spotlight

@Kind("command")
@Name("spotlight")
void spotlight(String theFullPathToTheImage)

Show the image at path in the application, used to show spotlight search results.

Parameters:

theFullPathToTheImage - The full path to the image

spotlight

@Kind("command")
@Name("spotlight")
void spotlight(MediaItem theFullPathToTheImage)

Show the image at path in the application, used to show spotlight search results.

Parameters:

theFullPathToTheImage - The full path to the image

spotlight

@Kind("command")
@Name("spotlight")
void spotlight(Container theFullPathToTheImage)

Show the image at path in the application, used to show spotlight search results.

Parameters:

theFullPathToTheImage - The full path to the image

search

@Kind("command")
@Name("search")
MediaItem[] search(@Parameter("for")
                   String theTextToSearchFor)

Search for items matching the search string. Identical to entering search text in the Search field in Photos.

Parameters:

theTextToSearchFor - The text to search for

Returns:

reference(s) to found media item(s)

getName

@Code("pnam")
@Kind("property")
@Name("name")
@Type("text")
String getName()

The name of the application.

Returns:

property value

isFrontmost

@Code("pisf")
@Kind("property")
@Name("frontmost")
@Type("boolean")
boolean isFrontmost()

Is this the active application?

Returns:

property value

getVersion

@Code("vers")
@Kind("property")
@Name("version")
@Type("text")
String getVersion()

The version number of the application.

Returns:

property value

getContainers

@Kind("element")
@Type("container")
default Container[] getContainers()

Top level containers in the library, including user created albums and folders, as well as the favorites album.

Returns:

an array of all Containers

getContainers

@Kind("element")
@Type("container")
Container[] getContainers(String filter)

Top level containers in the library, including user created albums and folders, as well as the favorites album.

Parameters:

filter - AppleScript filter clause without the leading "whose" or "where"

Returns:

an array of all Containers

getContainer

@Kind("element")
@Type("container")
Container getContainer(int index)

Top level containers in the library, including user created albums and folders, as well as the favorites album.

Parameters:

index - index into the element list (zero-based)

Returns:

the Container at the requested index

getContainer

@Kind("element")
@Type("container")
Container getContainer(Id id)

Top level containers in the library, including user created albums and folders, as well as the favorites album.

Parameters:

id - id of the item

Returns:

the Container with the requested id

countContainers

@Kind("element")
@Type("container")
default int countContainers()

Top level containers in the library, including user created albums and folders, as well as the favorites album.

Returns:

number of all Containers

countContainers

@Kind("element")
@Type("container")
int countContainers(String filter)

Top level containers in the library, including user created albums and folders, as well as the favorites album.

Parameters:

filter - AppleScript filter clause without the leading "whose" or "where"

Returns:

the number of elements that pass the filter

getAlbums

@Kind("element")
@Type("album")
default Album[] getAlbums()

All user created albums in the library, in no specific order.

Returns:

an array of all Albums

getAlbums

@Kind("element")
@Type("album")
Album[] getAlbums(String filter)

All user created albums in the library, in no specific order.

Parameters:

filter - AppleScript filter clause without the leading "whose" or "where"

Returns:

an array of all Albums

getAlbum

@Kind("element")
@Type("album")
Album getAlbum(int index)

All user created albums in the library, in no specific order.

Parameters:

index - index into the element list (zero-based)

Returns:

the Album at the requested index

getAlbum

@Kind("element")
@Type("album")
Album getAlbum(Id id)

All user created albums in the library, in no specific order.

Parameters:

id - id of the item

Returns:

the Album with the requested id

countAlbums

@Kind("element")
@Type("album")
default int countAlbums()

All user created albums in the library, in no specific order.

Returns:

number of all Albums

countAlbums

@Kind("element")
@Type("album")
int countAlbums(String filter)

All user created albums in the library, in no specific order.

Parameters:

filter - AppleScript filter clause without the leading "whose" or "where"

Returns:

the number of elements that pass the filter

getFolders

@Kind("element")
@Type("folder")
default Folder[] getFolders()

All user created folders in the library, in no specific order.

Returns:

an array of all Folders

getFolders

@Kind("element")
@Type("folder")
Folder[] getFolders(String filter)

All user created folders in the library, in no specific order.

Parameters:

filter - AppleScript filter clause without the leading "whose" or "where"

Returns:

an array of all Folders

getFolder

@Kind("element")
@Type("folder")
Folder getFolder(int index)

All user created folders in the library, in no specific order.

Parameters:

index - index into the element list (zero-based)

Returns:

the Folder at the requested index

getFolder

@Kind("element")
@Type("folder")
Folder getFolder(Id id)

All user created folders in the library, in no specific order.

Parameters:

id - id of the item

Returns:

the Folder with the requested id

countFolders

@Kind("element")
@Type("folder")
default int countFolders()

All user created folders in the library, in no specific order.

Returns:

number of all Folders

countFolders

@Kind("element")
@Type("folder")
int countFolders(String filter)

All user created folders in the library, in no specific order.

Parameters:

filter - AppleScript filter clause without the leading "whose" or "where"

Returns:

the number of elements that pass the filter

getMediaItems

@Kind("element")
@Type("media item")
default MediaItem[] getMediaItems()

Media items in the library.

Returns:

an array of all MediaItems

getMediaItems

@Kind("element")
@Type("media item")
MediaItem[] getMediaItems(String filter)

Media items in the library.

Parameters:

filter - AppleScript filter clause without the leading "whose" or "where"

Returns:

an array of all MediaItems

getMediaItem

@Kind("element")
@Type("media item")
MediaItem getMediaItem(int index)

Media items in the library.

Parameters:

index - index into the element list (zero-based)

Returns:

the MediaItem at the requested index

getMediaItem

@Kind("element")
@Type("media item")
MediaItem getMediaItem(Id id)

Media items in the library.

Parameters:

id - id of the item

Returns:

the MediaItem with the requested id

countMediaItems

@Kind("element")
@Type("media item")
default int countMediaItems()

Media items in the library.

Returns:

number of all MediaItems

countMediaItems

@Kind("element")
@Type("media item")
int countMediaItems(String filter)

Media items in the library.

Parameters:

filter - AppleScript filter clause without the leading "whose" or "where"

Returns:

the number of elements that pass the filter

getMoments

@Kind("element")
@Type("moment")
default Moment[] getMoments()

Moments in the library.

Returns:

an array of all Moments

getMoments

@Kind("element")
@Type("moment")
Moment[] getMoments(String filter)

Moments in the library.

Parameters:

filter - AppleScript filter clause without the leading "whose" or "where"

Returns:

an array of all Moments

getMoment

@Kind("element")
@Type("moment")
Moment getMoment(int index)

Moments in the library.

Parameters:

index - index into the element list (zero-based)

Returns:

the Moment at the requested index

getMoment

@Kind("element")
@Type("moment")
Moment getMoment(Id id)

Moments in the library.

Parameters:

id - id of the item

Returns:

the Moment with the requested id

countMoments

@Kind("element")
@Type("moment")
default int countMoments()

Moments in the library.

Returns:

number of all Moments

countMoments

@Kind("element")
@Type("moment")
int countMoments(String filter)

Moments in the library.

Parameters:

filter - AppleScript filter clause without the leading "whose" or "where"

Returns:

the number of elements that pass the filter

getSelection

@Code("selc")
@Kind("property")
@Name("selection")
@Type("media item")
MediaItem[] getSelection()

The currently selected media items in the application.

Returns:

property value

getFavoritesAlbum

@Code("fvAl")
@Kind("property")
@Name("favorites album")
@Type("album")
Album getFavoritesAlbum()

Favorited media items album.

Returns:

property value

getLastImportAlbum

@Code("lstI")
@Kind("property")
@Name("last import album")
@Type("album")
Album getLastImportAlbum()

Last import album.

Returns:

property value

isSlideshowRunning

@Code("SSrn")
@Kind("property")
@Name("slideshow running")
@Type("boolean")
boolean isSlideshowRunning()

Returns true if a slideshow is currently running.

Returns:

property value

getRecentlyDeletedAlbum

@Code("trAl")
@Kind("property")
@Name("recently deleted album")
@Type("album")
Album getRecentlyDeletedAlbum()

The set of recently deleted media items.

Returns:

property value

getProperties

Map<String,Object> getProperties()

Returns all properties for an instance of this class.

Returns:

Map containing all properties

getInstance

static Application getInstance()

Returns an instance for application Photos.

Returns:

instance