Module tagtraum.japlphoto

Package com.tagtraum.macos.photos

Interface Album

All Superinterfaces:

Container, Reference

@Code("IPal")
@Name("album")
@Inherits("container")
public interface Album
extends Reference, Container

An album. A container that holds media items.

Author:

JaplScript 3.4.11

Field Summary

Fields

Modifier and Type	Field	Description
static TypeClass	CLASS

Method Summary

Modifier and Type	Method	Description
default int	countMediaItems()	The media items contained in this album.
int	countMediaItems(String filter)	The media items contained in this album.
MediaItem	getMediaItem(int index)	The media items contained in this album.
MediaItem	getMediaItem(Id id)	The media items contained in this album.
default MediaItem[]	getMediaItems()	The media items contained in this album.
MediaItem[]	getMediaItems(String filter)	The media items contained in this album.
Map<String,Object>	getProperties()	Returns all properties for an instance of this class.

Methods inherited from interface com.tagtraum.macos.photos.Container

getId, getName, getParent, setName

Methods inherited from interface com.tagtraum.japlscript.Reference

cast, getApplicationReference, getObjectReference, getTypeClass, isInstanceOf

Field Detail

CLASS

static final TypeClass CLASS

Method Detail

getMediaItems

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

The media items contained in this album.

Returns:

an array of all MediaItems

getMediaItems

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

The media items contained in this album.

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)

The media items contained in this album.

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)

The media items contained in this album.

Parameters:

id - id of the item

Returns:

the MediaItem with the requested id

countMediaItems

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

The media items contained in this album.

Returns:

number of all MediaItems

countMediaItems

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

The media items contained in this album.

Parameters:

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

Returns:

the number of elements that pass the filter

getProperties

Map<String,Object> getProperties()

Returns all properties for an instance of this class.

Specified by:

getProperties in interface Container

Returns:

Map containing all properties