Module tagtraum.japlse

Package com.tagtraum.macos.systemevents

Interface UserDomainObject

All Superinterfaces:

Domain, Reference

@Plural("user domain objects")
@Code("domu")
@Name("user domain object")
@Inherits("domain")
public interface UserDomainObject
extends Reference, Domain

The user domain in the file system.

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	countFolders()
int	countFolders(String filter)
Folder	getDesktopFolder()	The user's Desktop folder.
Folder	getDocumentsFolder()	The user's Documents folder.
Folder	getDownloadsFolder()	The user's Downloads folder.
Folder	getFavoritesFolder()	The user's Favorites folder.
Folder	getFolder(int index)
Folder	getFolder(Id id)
default Folder[]	getFolders()
Folder[]	getFolders(String filter)
Folder	getHomeFolder()	The user's Home folder.
Folder	getMoviesFolder()	The user's Movies folder.
Folder	getMusicFolder()	The user's Music folder.
Folder	getPicturesFolder()	The user's Pictures folder.
Map<String,Object>	getProperties()	Returns all properties for an instance of this class.
Folder	getPublicFolder()	The user's Public folder.
Folder	getSitesFolder()	The user's Sites folder.
Folder	getTemporaryItemsFolder()	The Temporary Items folder.

Methods inherited from interface com.tagtraum.macos.systemevents.Domain

getApplicationsFolder, getApplicationSupportFolder, getDesktopPicturesFolder, getFolderActionScriptsFolder, getFontsFolder, getId, getLibraryFolder, getName, getPreferencesFolder, getScriptingAdditionsFolder, getScriptsFolder, getSharedDocumentsFolder, getSpeakableItemsFolder, getUtilitiesFolder, getWorkflowsFolder

Methods inherited from interface com.tagtraum.japlscript.Reference

cast, getApplicationReference, getObjectReference, getTypeClass, isInstanceOf

Field Detail

CLASS

static final TypeClass CLASS

Method Detail

getFolders

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

Specified by:

getFolders in interface Domain

Returns:

an array of all Folders

getFolders

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

Specified by:

getFolders in interface Domain

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)

Specified by:

getFolder in interface Domain

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)

Specified by:

getFolder in interface Domain

Parameters:

id - id of the item

Returns:

the Folder with the requested id

countFolders

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

Specified by:

countFolders in interface Domain

Returns:

number of all Folders

countFolders

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

Specified by:

countFolders in interface Domain

Parameters:

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

Returns:

the number of elements that pass the filter

getDesktopFolder

@Code("desk")
@Kind("property")
@Name("desktop folder")
@Type("folder")
Folder getDesktopFolder()

The user's Desktop folder.

Returns:

property value

getDocumentsFolder

@Code("docs")
@Kind("property")
@Name("documents folder")
@Type("folder")
Folder getDocumentsFolder()

The user's Documents folder.

Returns:

property value

getDownloadsFolder

@Code("down")
@Kind("property")
@Name("downloads folder")
@Type("folder")
Folder getDownloadsFolder()

The user's Downloads folder.

Returns:

property value

getFavoritesFolder

@Code("favs")
@Kind("property")
@Name("favorites folder")
@Type("folder")
Folder getFavoritesFolder()

The user's Favorites folder.

Returns:

property value

getHomeFolder

@Code("cusr")
@Kind("property")
@Name("home folder")
@Type("folder")
Folder getHomeFolder()

The user's Home folder.

Returns:

property value

getMoviesFolder

@Code("mdoc")
@Kind("property")
@Name("movies folder")
@Type("folder")
Folder getMoviesFolder()

The user's Movies folder.

Returns:

property value

getMusicFolder

@Code("%doc")
@Kind("property")
@Name("music folder")
@Type("folder")
Folder getMusicFolder()

The user's Music folder.

Returns:

property value

getPicturesFolder

@Code("pdoc")
@Kind("property")
@Name("pictures folder")
@Type("folder")
Folder getPicturesFolder()

The user's Pictures folder.

Returns:

property value

getPublicFolder

@Code("pubb")
@Kind("property")
@Name("public folder")
@Type("folder")
Folder getPublicFolder()

The user's Public folder.

Returns:

property value

getSitesFolder

@Code("site")
@Kind("property")
@Name("sites folder")
@Type("folder")
Folder getSitesFolder()

The user's Sites folder.

Returns:

property value

getTemporaryItemsFolder

@Code("temp")
@Kind("property")
@Name("temporary items folder")
@Type("folder")
Folder getTemporaryItemsFolder()

The Temporary Items folder.

Returns:

property value

getProperties

Map<String,Object> getProperties()

Returns all properties for an instance of this class.

Specified by:

getProperties in interface Domain

Returns:

Map containing all properties