ScriptingAddition (JaplSA 0.9.3, Java API for AppleScript Standard Additions generated by JaplScript 3.4.11)

All Superinterfaces:: Reference

@Code("")
@Name("Scripting Addition")
public interface ScriptingAddition
extends Reference

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

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

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method	Description
`void`	`addingFolderItemsTo(Alias folderReceivingTheNewItems, Alias[] aListOfTheItemsTheFolderReceived)`	Called after new items have been added to a folder.
`String`	`asciiCharacter(int theCodePointOfTheSpecifiedCharacter)`	Convert a number to a character.
`int`	`asciiNumber(String theCharacter)`	Convert a character to a number.
`void`	`beep(int numberOfTimesToBeep)`	Beep 1 or more times.
`Reference`	`chooseApplication(String theDialogWindowTitle, String thePromptToBeDisplayedInTheDialogBox, boolean allowMultipleItemsToBeSelectedDefaultIsFalse, TypeClass theDesiredTypeOfResultMayBeApplicationTheDefaultOrAlias)`	Choose an application on this machine or the network.
`Color`	`chooseColor(Color theDefaultColor)`	Choose a color.
`Alias`	`chooseFile(String thePromptToBeDisplayedInTheDialogBox, String[] aListOfFileTypesOrTypeIdentifiersOnlyFilesOfTheSpecifiedTypesWillBeSelectable, Alias theDefaultFileLocation, boolean showInvisibleFilesAndFoldersDefaultIsFalse, boolean allowMultipleItemsToBeSelectedDefaultIsFalse, boolean showTheContentsOfPackagesPackagesWillBeTreatedAsFoldersDefaultIsFalse)`	Choose a file on a disk or server.
`JaplScriptFile`	`chooseFileName(String thePromptToBeDisplayedInTheDialogBox, String theDefaultNameForTheNewFile, Alias theDefaultFileLocation)`	Get a new file reference from the user, without creating the file.
`Alias`	`chooseFolder(String thePromptToBeDisplayedInTheDialogBox, Alias theDefaultFolderLocation, boolean showInvisibleFilesAndFoldersDefaultIsFalse, boolean allowMultipleItemsToBeSelectedDefaultIsFalse, boolean showTheContentsOfPackagesPackagesWillBeTreatedAsFoldersDefaultIsFalse)`	Choose a folder on a disk or server.
`double[]`	`chooseFromList(double[] aListOfItemsToDisplay, String theDialogWindowTitle, String thePromptToBeDisplayedInTheDialogBox, String[] aListOfItemsToInitiallySelectAnEmptyListIfNoSelection, String theNameOfTheOkButton, String theNameOfTheCancelButton, boolean allowMultipleItemsToBeSelected, boolean canTheUserMakeNoSelectionAndThenChooseOk)`	Choose one or more items from a list.
`double[]`	`chooseFromList(String[] aListOfItemsToDisplay, String theDialogWindowTitle, String thePromptToBeDisplayedInTheDialogBox, String[] aListOfItemsToInitiallySelectAnEmptyListIfNoSelection, String theNameOfTheOkButton, String theNameOfTheCancelButton, boolean allowMultipleItemsToBeSelected, boolean canTheUserMakeNoSelectionAndThenChooseOk)`	Choose one or more items from a list.
`Reference`	`chooseRemoteApplication(String theDialogWindowTitle, String thePromptToBeDisplayedAboveTheListOfApplications)`	Choose a running application on a remote machine or on this machine.
`Url`	`chooseUrl(Essv[] whichNetworkServicesToShow, boolean allowUserToTypeInAUrl)`	Choose a service on the Internet.
`List[]`	`clipboardInfo(TypeClass restrictsToInformationAboutOnlyThisDataType)`	Return information about the clipboard.
`void`	`closeAccess(Reference theFileReferenceNumberAliasOrFileReferenceOfTheFileToClose)`	Close a file that was opened for access.
`void`	`closingFolderWindowFor(Alias theFolderThatWasClosed)`	Called after a folder window has been closed.
`Date`	`currentDate()`	Return the current date and time.
`void`	`delay(double theNumberOfSecondsToDelayDefaultIs0)`	Pause for a fixed amount of time.
`AlertReply`	`displayAlert(String theAlertTextWillBeDisplayedInEmphasizedSystemFont, String theExplanatoryMessageWillBeDisplayedInSmallSystemFont, Ealt theTypeOfAlertDefaultIsInformational, String[] aListOfUpToThreeButtonNames, String theNameOrNumberOfTheDefaultButton, String theNameOrNumberOfTheCancelButton, int numberOfSecondsToWaitBeforeAutomaticallyDismissingTheAlert)`	Display an alert.
`DialogReply`	`displayDialog(String theTextToDisplayInTheDialogBox, String theDefaultEditableText, boolean shouldEditableTextBeDisplayedAsBulletsDefaultIsFalse, String[] aListOfUpToThreeButtonNames, String theNameOrNumberOfTheDefaultButton, String theNameOrNumberOfTheCancelButton, String theDialogWindowTitle, String theResourceNameOrIdOfTheIconToDisplay, Stic OrOneOfTheseSystemIcons, JaplScriptFile OrAnAliasOrFileReferenceToAIcnsFile, int numberOfSecondsToWaitBeforeAutomaticallyDismissingTheDialog)`	Display a dialog box, optionally requesting user input.
`void`	`displayNotification(String theBodyTextOfTheNotification, String theTitleOfTheNotificationDefaultIsTheNameOfTheCallingApplication, String theSubtitleOfTheNotification, String theNameOfTheSoundToPlay)`	Display a notification.
`String`	doShellScript(String theShellScriptToExecute, TypeClass theDesiredTypeOfResultDefaultIsTextUtf8, boolean executeTheCommandAsTheAdministrator, String useThisAdministratorAccountToAvoidAPasswordDialogIfThisParameterIsSpecifiedThePasswordParameterMustAlsoBeSpecified, String useThisAdministratorPasswordToAvoidAPasswordDialog, String thePromptToBeDisplayedInThePasswordDialogWhenTheNameAndPasswordAreNotSpecifiedOrAreIncorrect, boolean changeAllLineEndingsToMacStyleAndTrimATrailingOneDefaultTrue)	Execute a shell script using the ‘sh’ shell.
`int`	`getEof(Reference aFileReferenceNumberAliasOrFileReferenceOfAFile)`	Return the length, in bytes, of a file.
`static ScriptingAddition`	`getInstance()`	Returns an instance for application StandardAdditions.
`Map<String,Object>`	`getProperties()`	Returns all properties for an instance of this class.
`VolumeSettings`	`getVolumeSettings()`	Get the sound output and input volume settings.
`WebPage`	handleCgiRequest(String thePathOfTheUrl, String theDataForTheGetMethodOrDataAfterTheInAPostMethod, String thePostArguments, String theMimeContentTypeOfPostArguments, String eitherGetOrPost, String theIpAddressOfTheEntityMakingTheRequest, String theUserNameAssociatedWithTheRequest, String thePasswordSentWithTheRequest, String additionalInformationAboutTheUserUsuallyTheEmailAddress, String theNameOfTheServerApplicationSendingThisRequest, String theIpPortNumberOfTheServer, String thePathToTheScriptExecutingThisCgiInUrlForm, String theUrlOfThePageTheClientUsedToLinkToTheCgi, String theNameOfTheClientSoftware, String thePathToTheFileOrCgi, String eitherPreprocessorPostprocessorCgiOrAcgi, String theInternetAddressOfTheClient, String theFullRequestAsSentToTheServer, int theIdOfTheConnectionFromTheServerToTheClient, String theUrlOfTheRootFolderOfTheVirtualHost)	Sent to a script to process a Common Gateway Interface request.
`FileInformation`	`infoFor(JaplScriptFile anAliasOrFileReferenceToTheFileOrFolder, boolean returnTheSizeOfTheFileOrFolderDefaultIsTrue)`	Return information for a file or folder.
`String[]`	`listDisks()`	Return a list of the currently mounted volumes.
`String[]`	`listFolder(JaplScriptFile anAliasOrFileReferenceToTheFolder, boolean listInvisibleFilesDefaultIsTrue)`	Return the contents of a specified folder.
`Reference`	`loadScript(JaplScriptFile anAliasOrFileReferenceToTheFileContainingTheScriptObject)`	Return a script object loaded from a specified file.
`String`	`localizedString(String theKey, String theNameOfTheStringsFileExcludingTheStringsSuffixDefaultIsLocalizable, JaplScriptFile anAliasOrFileReferenceToTheBundleContainingTheStringsFileDefaultIsTheCurrentApplicationScriptBundle)`	Return the localized string for the specified key.
`JaplScriptFile`	`mountVolume(String theNameOrUrlPathEGAfpServerVolumeOfTheVolumeToMount, String theServerOnWhichTheVolumeResidesOmitIfUrlPathProvided, String theAppletalkZoneInWhichTheServerResidesOmitIfUrlPathProvided, String theUserNameWithWhichToLogInToTheServerOmitForGuestAccess, String thePasswordForTheUserNameOmitForGuestAccess)`	Mount the specified server volume.
`void`	`movingFolderWindowFor(Alias theFolderWhoseWindowWasMovedOrResized, Rectangle thePreviousCoordinatesOfFolderWindowYouCanGetTheNewCoordinatesFromTheFinder)`	Called after a folder window has been moved or resized.
`int`	`offset(String theSourceTextToFindThePositionOf, String theTargetTextToSearchIn)`	Find one piece of text inside another.
`int`	`openForAccess(JaplScriptFile theFileOrAliasToOpenForAccessIfTheFileDoesNotExistANewFileIsCreated, boolean whetherToAllowWritingToTheFile)`	Open a disk file for the read and write commands.
`void`	`openingFolder(Alias theFolderThatWasOpened)`	Called after a folder has been opened into a window.
`void`	`openLocation(String theUrlToOpen, boolean shouldErrorConditionsBeReportedInADialog)`	Opens a URL with the appropriate program.
`String`	`pathTo(Reference theItemPathToReturnEGCurrentApplicationFrontmostApplicationApplicationAppnameMeIt, TypeClass theTypeToReturnAliasOrStringDefaultIsAlias)`	Return the full path to the specified application or script.
`Alias`	`pathTo(Afdr theFolderToReturn, Fldm whereToLookForTheIndicatedFolder, TypeClass theTypeToReturnAliasOrStringDefaultIsAlias, boolean createTheFolderIfItDoesnTExistDefaultIsTrue)`	Return the full path to the specified folder.
`String`	`pathTo(Appf theItemPathToReturnEGCurrentApplicationFrontmostApplicationApplicationAppnameMeIt, TypeClass theTypeToReturnAliasOrStringDefaultIsAlias)`	Return the full path to the specified application or script.
`Alias`	`pathToResource(String theNameOfTheRequestedResource, JaplScriptFile anAliasOrFileReferenceToTheBundleContainingTheResourceDefaultIsTheTargetApplicationOrCurrentScriptBundle, String theNameOfASubdirectoryInTheBundleSResourcesDirectory)`	Return the full path to the specified resource.
`double`	`randomNumber(double theUpperLimitDefaultIs10IfThisParameterIsSpecifiedTheFromAndToParametersWillBeIgnored, double theLowestNumberToReturnDefaultIs00, double theHighestNumberToReturnDefaultIs10, int aStartingPointForARepeatableSequenceOfRandomNumbersAValueOf0WillUseARandomSeed)`	Generate a random number.
`Reference`	`read(Reference theFileReferenceNumberAliasOrFileReferenceOfTheFileToRead, int startingFromThisPositionIfOmittedStartAtLastPositionReadFrom, int theNumberOfBytesToReadFromCurrentPositionIfOmittedReadUntilTheEndOfTheFile, int OrStopAtThisPosition, String OrReadUpToButNotIncludingThisCharacter, String OrReadUpToAndIncludingThisCharacter, String theValueThatSeparatesItemsToRead, String[] OrAListOfValuesThatSeparateItemsToRead, TypeClass theFormInWhichToReadAndReturnData)`	Read data from a file that has been opened for access.
`void`	`removingFolderItemsFrom(Alias theFolderLosingTheItems, Alias[] aListOfTheItemsTheFolderLostForPermanentlyDeletedItemsOnlyTheNamesInStringsAreProvided)`	Called after items have been removed from a folder.
`int`	`round(double theNumberToRound, Olie theRoundingDirectionIfOmittedRoundsToNearestToNearestRounds5CasesToTheNearestEvenIntegerInOrderToDecreaseCumulativeErrorsToAlwaysRound5AwayFromZeroUseAsTaughtInSchool)`	Round number to integer.
`Reference`	`runScript(Reference theScriptTextOrAnAliasOrFileReferenceToAScriptFileToRun, Reference[] aListOfParameters, String theScriptingComponentToUseDefaultIsTheCurrentScriptingComponent)`	Run a specified script or script file.
`void`	say(String theTextToSpeakWhichCanIncludeIntonationCharacters, String theTextToDisplayInTheFeedbackWindowIfDifferentIgnoredUnlessSpeechRecognitionIsOn, String theVoiceToSpeakWithDefaultIsTheSystemVoice, double theRateOfSpeechInWordsPerMinuteAverageHumanSpeechOccursAtARateOf180To220WordsPerMinuteDefaultDependsOnTheVoiceUsedIfUsingIsNotGivenTheSystemSpeakingRateIsTheDefault, double theBasePitchFrequencyARealNumberFrom0To127ValuesCorrespondToMidiNoteValuesWhere60IsEqualToMiddleCTypicalPitchesRangeFromAround30To40ForALowPitchedMaleVoiceToPerhaps55To65ForAHighPitchedChildSVoice, double thePitchModulationARealNumberFrom0To127AValueOf0CorrespondsToAMonotoneInWhichAllSpeechIsAtTheBaseSpeechPitchGivenAPitchValueOf46AModulationOf2MeansTheWidestRangeOfPitchesWouldBe44To48, double theVolumeARealNumberFrom0To1DefaultIsTheSystemVolume, boolean stopAnyCurrentSpeechBeforeStartingDefaultIsFalseWhenFalseSayWaitsForPreviousSpeechCommandsToCompleteBeforeBeginningToSpeak, boolean waitForSpeechToCompleteBeforeReturningDefaultIsTrue, Reference theAliasFileReferenceOrPathStringOfAnAiffFileExistingOrNotToContainTheSoundOutput)	Speak the given text.
`String[]`	`scriptingComponents()`	Return a list of all scripting components (e.g.
`void`	`setEof(Reference aFileReferenceNumberAliasOrFileReferenceOfAFile, int theNewLengthOfTheFileInBytesAnyDataBeyondThisPositionIsLost)`	Set the length, in bytes, of a file.
`void`	`setTheClipboardTo(Reference theDataToPlaceOnTheClipboard)`	Place data on an application’s clipboard.
`void`	`setVolume(double theSoundOutputVolumeARealNumberFrom0To7ThisParameterIsDeprecatedIfSpecifiedAllOtherParametersWillBeIgnored, int theSoundOutputVolumeAnIntegerFrom0To100, int theSoundInputVolumeAnIntegerFrom0To100, int theAlertVolumeAnIntegerFrom0To100, boolean shouldTheSoundOutputBeMuted)`	Set the sound output and/or input volume.
`void`	`storeScript(Reference theScriptObjectToStore, JaplScriptFile anAliasOrFileReferenceToTheFileToStoreTheScriptObjectIn, Savo controlDisplayOfTheSaveAsDialog)`	Store a script object into a file.
`String`	`summarize(Alias theTextOrAnAliasToATextFileToSummarize, int theNumberOfSentencesDesiredInTheSummary)`	Summarize the specified text or text file.
`String`	`summarize(String theTextOrAnAliasToATextFileToSummarize, int theNumberOfSentencesDesiredInTheSummary)`	Summarize the specified text or text file.
`Reference`	`systemAttribute(Reference theAttributeToTestEitherAGestaltValueOrAShellEnvironmentVariable, int testSpecificBitsOfResponseIgnoredForEnvironmentVariables)`	Test attributes of this computer.
`SystemInformation`	`systemInfo()`	Get information about the system.
`Reference`	`theClipboard(TypeClass theTypeOfDataDesired)`	Return the contents of an application’s clipboard.
`int`	`timeToGmt()`	Return the difference between local time and GMT (Universal Time).
`void`	`write(Reference theDataToWriteToTheFile, Reference theFileReferenceNumberAliasOrFileReferenceOfTheFileToWriteTo, int startWritingAtThisPositionInTheFile, int theNumberOfBytesToWriteIfNotSpecifiedWriteAllTheDataProvided, TypeClass howToWriteTheDataAsTextDataListEtc)`	Write data to a file that was opened for access with write permission.

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

beep
```
@Kind("command")
@Name("beep")
void beep(int numberOfTimesToBeep)
```
Beep 1 or more times.

Parameters:

numberOfTimesToBeep - number of times to beep

chooseApplication

@Kind("command")
@Name("choose application")
Reference chooseApplication(@Parameter("with title")
                            String theDialogWindowTitle,
                            @Parameter("with prompt")
                            String thePromptToBeDisplayedInTheDialogBox,
                            @Parameter("multiple selections allowed")
                            boolean allowMultipleItemsToBeSelectedDefaultIsFalse,
                            @Parameter("as")
                            TypeClass theDesiredTypeOfResultMayBeApplicationTheDefaultOrAlias)

Choose an application on this machine or the network.

Parameters:: theDialogWindowTitle - the dialog window title; thePromptToBeDisplayedInTheDialogBox - the prompt to be displayed in the dialog box; allowMultipleItemsToBeSelectedDefaultIsFalse - Allow multiple items to be selected? (default is false); theDesiredTypeOfResultMayBeApplicationTheDefaultOrAlias - the desired type of result. May be application (the default) or alias.
Returns:: the chosen application

chooseColor

@Kind("command")
@Name("choose color")
Color chooseColor(@Parameter("default color")
                  Color theDefaultColor)

Choose a color.

Parameters:: theDefaultColor - the default color
Returns:: the chosen color

chooseFile

@Kind("command")
@Name("choose file")
Alias chooseFile(@Parameter("with prompt")
                 String thePromptToBeDisplayedInTheDialogBox,
                 @Parameter("of type")
                 String[] aListOfFileTypesOrTypeIdentifiersOnlyFilesOfTheSpecifiedTypesWillBeSelectable,
                 @Parameter("default location")
                 Alias theDefaultFileLocation,
                 @Parameter("invisibles")
                 boolean showInvisibleFilesAndFoldersDefaultIsFalse,
                 @Parameter("multiple selections allowed")
                 boolean allowMultipleItemsToBeSelectedDefaultIsFalse,
                 @Parameter("showing package contents")
                 boolean showTheContentsOfPackagesPackagesWillBeTreatedAsFoldersDefaultIsFalse)

Choose a file on a disk or server.

Parameters:: thePromptToBeDisplayedInTheDialogBox - the prompt to be displayed in the dialog box; aListOfFileTypesOrTypeIdentifiersOnlyFilesOfTheSpecifiedTypesWillBeSelectable - a list of file types or type identifiers. Only files of the specified types will be selectable.; theDefaultFileLocation - the default file location; showInvisibleFilesAndFoldersDefaultIsFalse - Show invisible files and folders? (default is false); allowMultipleItemsToBeSelectedDefaultIsFalse - Allow multiple items to be selected? (default is false); showTheContentsOfPackagesPackagesWillBeTreatedAsFoldersDefaultIsFalse - Show the contents of packages? (Packages will be treated as folders. Default is false.)
Returns:: the chosen file

chooseFileName

@Kind("command")
@Name("choose file name")
JaplScriptFile chooseFileName(@Parameter("with prompt")
                              String thePromptToBeDisplayedInTheDialogBox,
                              @Parameter("default name")
                              String theDefaultNameForTheNewFile,
                              @Parameter("default location")
                              Alias theDefaultFileLocation)

Get a new file reference from the user, without creating the file.

Parameters:: thePromptToBeDisplayedInTheDialogBox - the prompt to be displayed in the dialog box; theDefaultNameForTheNewFile - the default name for the new file; theDefaultFileLocation - the default file location
Returns:: the file the user specified

chooseFolder

@Kind("command")
@Name("choose folder")
Alias chooseFolder(@Parameter("with prompt")
                   String thePromptToBeDisplayedInTheDialogBox,
                   @Parameter("default location")
                   Alias theDefaultFolderLocation,
                   @Parameter("invisibles")
                   boolean showInvisibleFilesAndFoldersDefaultIsFalse,
                   @Parameter("multiple selections allowed")
                   boolean allowMultipleItemsToBeSelectedDefaultIsFalse,
                   @Parameter("showing package contents")
                   boolean showTheContentsOfPackagesPackagesWillBeTreatedAsFoldersDefaultIsFalse)

Choose a folder on a disk or server.

Parameters:: thePromptToBeDisplayedInTheDialogBox - the prompt to be displayed in the dialog box; theDefaultFolderLocation - the default folder location; showInvisibleFilesAndFoldersDefaultIsFalse - Show invisible files and folders? (default is false); allowMultipleItemsToBeSelectedDefaultIsFalse - Allow multiple items to be selected? (default is false); showTheContentsOfPackagesPackagesWillBeTreatedAsFoldersDefaultIsFalse - Show the contents of packages? (Packages will be treated as folders. Default is false.)
Returns:: the chosen folder

chooseFromList

@Kind("command")
@Name("choose from list")
double[] chooseFromList(String[] aListOfItemsToDisplay,
                        @Parameter("with title")
                        String theDialogWindowTitle,
                        @Parameter("with prompt")
                        String thePromptToBeDisplayedInTheDialogBox,
                        @Parameter("default items")
                        String[] aListOfItemsToInitiallySelectAnEmptyListIfNoSelection,
                        @Parameter("OK button name")
                        String theNameOfTheOkButton,
                        @Parameter("cancel button name")
                        String theNameOfTheCancelButton,
                        @Parameter("multiple selections allowed")
                        boolean allowMultipleItemsToBeSelected,
                        @Parameter("empty selection allowed")
                        boolean canTheUserMakeNoSelectionAndThenChooseOk)

Choose one or more items from a list.

Parameters:: aListOfItemsToDisplay - a list of items to display; theDialogWindowTitle - the dialog window title; thePromptToBeDisplayedInTheDialogBox - the prompt to be displayed in the dialog box; aListOfItemsToInitiallySelectAnEmptyListIfNoSelection - a list of items to initially select (an empty list if no selection); theNameOfTheOkButton - the name of the OK button; theNameOfTheCancelButton - the name of the Cancel button; allowMultipleItemsToBeSelected - Allow multiple items to be selected?; canTheUserMakeNoSelectionAndThenChooseOk - Can the user make no selection and then choose OK?
Returns:: the list of selected items

chooseFromList

@Kind("command")
@Name("choose from list")
double[] chooseFromList(double[] aListOfItemsToDisplay,
                        @Parameter("with title")
                        String theDialogWindowTitle,
                        @Parameter("with prompt")
                        String thePromptToBeDisplayedInTheDialogBox,
                        @Parameter("default items")
                        String[] aListOfItemsToInitiallySelectAnEmptyListIfNoSelection,
                        @Parameter("OK button name")
                        String theNameOfTheOkButton,
                        @Parameter("cancel button name")
                        String theNameOfTheCancelButton,
                        @Parameter("multiple selections allowed")
                        boolean allowMultipleItemsToBeSelected,
                        @Parameter("empty selection allowed")
                        boolean canTheUserMakeNoSelectionAndThenChooseOk)

Choose one or more items from a list.

Parameters:: aListOfItemsToDisplay - a list of items to display; theDialogWindowTitle - the dialog window title; thePromptToBeDisplayedInTheDialogBox - the prompt to be displayed in the dialog box; aListOfItemsToInitiallySelectAnEmptyListIfNoSelection - a list of items to initially select (an empty list if no selection); theNameOfTheOkButton - the name of the OK button; theNameOfTheCancelButton - the name of the Cancel button; allowMultipleItemsToBeSelected - Allow multiple items to be selected?; canTheUserMakeNoSelectionAndThenChooseOk - Can the user make no selection and then choose OK?
Returns:: the list of selected items

chooseRemoteApplication

@Kind("command")
@Name("choose remote application")
Reference chooseRemoteApplication(@Parameter("with title")
                                  String theDialogWindowTitle,
                                  @Parameter("with prompt")
                                  String thePromptToBeDisplayedAboveTheListOfApplications)

Choose a running application on a remote machine or on this machine.

Parameters:: theDialogWindowTitle - the dialog window title; thePromptToBeDisplayedAboveTheListOfApplications - the prompt to be displayed above the list of applications
Returns:: the chosen application

chooseUrl

@Kind("command")
@Name("choose URL")
Url chooseUrl(@Parameter("showing")
              Essv[] whichNetworkServicesToShow,
              @Parameter("editable URL")
              boolean allowUserToTypeInAUrl)

Choose a service on the Internet.

Parameters:: whichNetworkServicesToShow - which network services to show; allowUserToTypeInAUrl - Allow user to type in a URL?
Returns:: the chosen URL

delay
```
@Kind("command")
@Name("delay")
void delay(double theNumberOfSecondsToDelayDefaultIs0)
```
Pause for a fixed amount of time.

Parameters:

theNumberOfSecondsToDelayDefaultIs0 - the number of seconds to delay (default is 0)

displayAlert

@Kind("command")
@Name("display alert")
AlertReply displayAlert(String theAlertTextWillBeDisplayedInEmphasizedSystemFont,
                        @Parameter("message")
                        String theExplanatoryMessageWillBeDisplayedInSmallSystemFont,
                        @Parameter("as")
                        Ealt theTypeOfAlertDefaultIsInformational,
                        @Parameter("buttons")
                        String[] aListOfUpToThreeButtonNames,
                        @Parameter("default button")
                        String theNameOrNumberOfTheDefaultButton,
                        @Parameter("cancel button")
                        String theNameOrNumberOfTheCancelButton,
                        @Parameter("giving up after")
                        int numberOfSecondsToWaitBeforeAutomaticallyDismissingTheAlert)

Display an alert.

Parameters:: theAlertTextWillBeDisplayedInEmphasizedSystemFont - the alert text (will be displayed in emphasized system font); theExplanatoryMessageWillBeDisplayedInSmallSystemFont - the explanatory message (will be displayed in small system font); theTypeOfAlertDefaultIsInformational - the type of alert (default is informational); aListOfUpToThreeButtonNames - a list of up to three button names; theNameOrNumberOfTheDefaultButton - the name or number of the default button; theNameOrNumberOfTheCancelButton - the name or number of the cancel button; numberOfSecondsToWaitBeforeAutomaticallyDismissingTheAlert - number of seconds to wait before automatically dismissing the alert
Returns:: a record containing the button clicked

displayDialog

@Kind("command")
@Name("display dialog")
DialogReply displayDialog(String theTextToDisplayInTheDialogBox,
                          @Parameter("default answer")
                          String theDefaultEditableText,
                          @Parameter("hidden answer")
                          boolean shouldEditableTextBeDisplayedAsBulletsDefaultIsFalse,
                          @Parameter("buttons")
                          String[] aListOfUpToThreeButtonNames,
                          @Parameter("default button")
                          String theNameOrNumberOfTheDefaultButton,
                          @Parameter("cancel button")
                          String theNameOrNumberOfTheCancelButton,
                          @Parameter("with title")
                          String theDialogWindowTitle,
                          @Parameter("with icon")
                          String theResourceNameOrIdOfTheIconToDisplay,
                          @Parameter("with icon")
                          Stic OrOneOfTheseSystemIcons,
                          @Parameter("with icon")
                          JaplScriptFile OrAnAliasOrFileReferenceToAIcnsFile,
                          @Parameter("giving up after")
                          int numberOfSecondsToWaitBeforeAutomaticallyDismissingTheDialog)

Display a dialog box, optionally requesting user input.

Parameters:: theTextToDisplayInTheDialogBox - the text to display in the dialog box; theDefaultEditableText - the default editable text; shouldEditableTextBeDisplayedAsBulletsDefaultIsFalse - Should editable text be displayed as bullets? (default is false); aListOfUpToThreeButtonNames - a list of up to three button names; theNameOrNumberOfTheDefaultButton - the name or number of the default button; theNameOrNumberOfTheCancelButton - the name or number of the cancel button; theDialogWindowTitle - the dialog window title; theResourceNameOrIdOfTheIconToDisplay - the resource name or ID of the icon to display…; OrOneOfTheseSystemIcons - …or one of these system icons…; OrAnAliasOrFileReferenceToAIcnsFile - …or an alias or file reference to a ‘.icns’ file; numberOfSecondsToWaitBeforeAutomaticallyDismissingTheDialog - number of seconds to wait before automatically dismissing the dialog
Returns:: a record containing the button clicked and text entered (if any)

displayNotification

@Kind("command")
@Name("display notification")
void displayNotification(String theBodyTextOfTheNotification,
                         @Parameter("with title")
                         String theTitleOfTheNotificationDefaultIsTheNameOfTheCallingApplication,
                         @Parameter("subtitle")
                         String theSubtitleOfTheNotification,
                         @Parameter("sound name")
                         String theNameOfTheSoundToPlay)

Display a notification. At least one of the body text and the title must be specified.

Parameters:: theBodyTextOfTheNotification - the body text of the notification; theTitleOfTheNotificationDefaultIsTheNameOfTheCallingApplication - the title of the notification (default is the name of the calling application).; theSubtitleOfTheNotification - the subtitle of the notification; theNameOfTheSoundToPlay - the name of the sound to play

say
```
@Kind("command")
@Name("say")
void say(String theTextToSpeakWhichCanIncludeIntonationCharacters,
         @Parameter("displaying")
         String theTextToDisplayInTheFeedbackWindowIfDifferentIgnoredUnlessSpeechRecognitionIsOn,
         @Parameter("using")
         String theVoiceToSpeakWithDefaultIsTheSystemVoice,
         @Parameter("speaking rate")
         double theRateOfSpeechInWordsPerMinuteAverageHumanSpeechOccursAtARateOf180To220WordsPerMinuteDefaultDependsOnTheVoiceUsedIfUsingIsNotGivenTheSystemSpeakingRateIsTheDefault,
         @Parameter("pitch")
         double theBasePitchFrequencyARealNumberFrom0To127ValuesCorrespondToMidiNoteValuesWhere60IsEqualToMiddleCTypicalPitchesRangeFromAround30To40ForALowPitchedMaleVoiceToPerhaps55To65ForAHighPitchedChildSVoice,
         @Parameter("modulation")
         double thePitchModulationARealNumberFrom0To127AValueOf0CorrespondsToAMonotoneInWhichAllSpeechIsAtTheBaseSpeechPitchGivenAPitchValueOf46AModulationOf2MeansTheWidestRangeOfPitchesWouldBe44To48,
         @Parameter("volume")
         double theVolumeARealNumberFrom0To1DefaultIsTheSystemVolume,
         @Parameter("stopping current speech")
         boolean stopAnyCurrentSpeechBeforeStartingDefaultIsFalseWhenFalseSayWaitsForPreviousSpeechCommandsToCompleteBeforeBeginningToSpeak,
         @Parameter("waiting until completion")
         boolean waitForSpeechToCompleteBeforeReturningDefaultIsTrue,
         @Parameter("saving to")
         Reference theAliasFileReferenceOrPathStringOfAnAiffFileExistingOrNotToContainTheSoundOutput)
```
Speak the given text.

Parameters:

theTextToSpeakWhichCanIncludeIntonationCharacters - the text to speak, which can include intonation characters

theTextToDisplayInTheFeedbackWindowIfDifferentIgnoredUnlessSpeechRecognitionIsOn - the text to display in the feedback window (if different). Ignored unless Speech Recognition is on.

theVoiceToSpeakWithDefaultIsTheSystemVoice - the voice to speak with. (Default is the system voice.)

theRateOfSpeechInWordsPerMinuteAverageHumanSpeechOccursAtARateOf180To220WordsPerMinuteDefaultDependsOnTheVoiceUsedIfUsingIsNotGivenTheSystemSpeakingRateIsTheDefault - the rate of speech in words per minute. Average human speech occurs at a rate of 180 to 220 words per minute. (Default depends on the voice used. If “using” is not given, the system speaking rate is the default.)

theBasePitchFrequencyARealNumberFrom0To127ValuesCorrespondToMidiNoteValuesWhere60IsEqualToMiddleCTypicalPitchesRangeFromAround30To40ForALowPitchedMaleVoiceToPerhaps55To65ForAHighPitchedChildSVoice - the base pitch frequency, a real number from 0 to 127. Values correspond to MIDI note values, where 60 is equal to middle C. Typical pitches range from around 30 to 40 for a low-pitched male voice to perhaps 55 to 65 for a high-pitched child’s voice.

thePitchModulationARealNumberFrom0To127AValueOf0CorrespondsToAMonotoneInWhichAllSpeechIsAtTheBaseSpeechPitchGivenAPitchValueOf46AModulationOf2MeansTheWidestRangeOfPitchesWouldBe44To48 - the pitch modulation, a real number from 0 to 127. A value of 0 corresponds to a monotone in which all speech is at the base speech pitch. Given a pitch value of 46, a modulation of 2 means the widest range of pitches would be 44 to 48.

theVolumeARealNumberFrom0To1DefaultIsTheSystemVolume - the volume, a real number from 0 to 1 (default is the system volume).

stopAnyCurrentSpeechBeforeStartingDefaultIsFalseWhenFalseSayWaitsForPreviousSpeechCommandsToCompleteBeforeBeginningToSpeak - stop any current speech before starting (default is false). When false, “say” waits for previous speech commands to complete before beginning to speak.

waitForSpeechToCompleteBeforeReturningDefaultIsTrue - wait for speech to complete before returning (default is true).

theAliasFileReferenceOrPathStringOfAnAiffFileExistingOrNotToContainTheSoundOutput - the alias, file reference or path string of an AIFF file (existing or not) to contain the sound output.

infoFor
```
@Kind("command")
@Name("info for")
FileInformation infoFor(JaplScriptFile anAliasOrFileReferenceToTheFileOrFolder,
                        @Parameter("size")
                        boolean returnTheSizeOfTheFileOrFolderDefaultIsTrue)
```
Return information for a file or folder.

Parameters:

anAliasOrFileReferenceToTheFileOrFolder - an alias or file reference to the file or folder

returnTheSizeOfTheFileOrFolderDefaultIsTrue - Return the size of the file or folder? (default is true)

Returns:

a record containing the information for the specified file or folder

listDisks
```
@Kind("command")
@Name("list disks")
String[] listDisks()
```
Return a list of the currently mounted volumes.

Returns:

a list of the currently mounted volumes.

listFolder
```
@Kind("command")
@Name("list folder")
String[] listFolder(JaplScriptFile anAliasOrFileReferenceToTheFolder,
                    @Parameter("invisibles")
                    boolean listInvisibleFilesDefaultIsTrue)
```
Return the contents of a specified folder.

Parameters:

anAliasOrFileReferenceToTheFolder - an alias or file reference to the folder

listInvisibleFilesDefaultIsTrue - List invisible files? (default is true)

Returns:

a list of the items in the specified folder

mountVolume

@Kind("command")
@Name("mount volume")
JaplScriptFile mountVolume(String theNameOrUrlPathEGAfpServerVolumeOfTheVolumeToMount,
                           @Parameter("on server")
                           String theServerOnWhichTheVolumeResidesOmitIfUrlPathProvided,
                           @Parameter("in AppleTalk zone")
                           String theAppletalkZoneInWhichTheServerResidesOmitIfUrlPathProvided,
                           @Parameter("as user name")
                           String theUserNameWithWhichToLogInToTheServerOmitForGuestAccess,
                           @Parameter("with password")
                           String thePasswordForTheUserNameOmitForGuestAccess)

Mount the specified server volume.

Parameters:: theNameOrUrlPathEGAfpServerVolumeOfTheVolumeToMount - the name or URL path (e.g. ‘afp://server/volume/’) of the volume to mount; theServerOnWhichTheVolumeResidesOmitIfUrlPathProvided - the server on which the volume resides; omit if URL path provided; theAppletalkZoneInWhichTheServerResidesOmitIfUrlPathProvided - the AppleTalk zone in which the server resides; omit if URL path provided; theUserNameWithWhichToLogInToTheServerOmitForGuestAccess - the user name with which to log in to the server; omit for guest access; thePasswordForTheUserNameOmitForGuestAccess - the password for the user name; omit for guest access
Returns:: a specifier for the mounted volume

pathTo
```
@Kind("command")
@Name("path to")
String pathTo(Reference theItemPathToReturnEGCurrentApplicationFrontmostApplicationApplicationAppnameMeIt,
              @Parameter("as")
              TypeClass theTypeToReturnAliasOrStringDefaultIsAlias)
```
Return the full path to the specified application or script.

Parameters:

theItemPathToReturnEGCurrentApplicationFrontmostApplicationApplicationAppnameMeIt - the item path to return; e.g., current application, frontmost application, application “AppName”, me, it

theTypeToReturnAliasOrStringDefaultIsAlias - the type to return: alias or string (default is alias)

Returns:

the path to the specified item

pathTo
```
@Kind("command")
@Name("path to")
String pathTo(Appf theItemPathToReturnEGCurrentApplicationFrontmostApplicationApplicationAppnameMeIt,
              @Parameter("as")
              TypeClass theTypeToReturnAliasOrStringDefaultIsAlias)
```
Return the full path to the specified application or script.

Parameters:

theItemPathToReturnEGCurrentApplicationFrontmostApplicationApplicationAppnameMeIt - the item path to return; e.g., current application, frontmost application, application “AppName”, me, it

theTypeToReturnAliasOrStringDefaultIsAlias - the type to return: alias or string (default is alias)

Returns:

the path to the specified item

pathTo

@Kind("command")
@Name("path to")
Alias pathTo(Afdr theFolderToReturn,
             @Parameter("from")
             Fldm whereToLookForTheIndicatedFolder,
             @Parameter("as")
             TypeClass theTypeToReturnAliasOrStringDefaultIsAlias,
             @Parameter("folder creation")
             boolean createTheFolderIfItDoesnTExistDefaultIsTrue)

Return the full path to the specified folder.

Parameters:: theFolderToReturn - the folder to return; whereToLookForTheIndicatedFolder - where to look for the indicated folder; theTypeToReturnAliasOrStringDefaultIsAlias - the type to return: alias or string (default is alias); createTheFolderIfItDoesnTExistDefaultIsTrue - Create the folder if it doesn’t exist? (default is true)
Returns:: the path to the specified folder

pathToResource
```
@Kind("command")
@Name("path to resource")
Alias pathToResource(String theNameOfTheRequestedResource,
                     @Parameter("in bundle")
                     JaplScriptFile anAliasOrFileReferenceToTheBundleContainingTheResourceDefaultIsTheTargetApplicationOrCurrentScriptBundle,
                     @Parameter("in directory")
                     String theNameOfASubdirectoryInTheBundleSResourcesDirectory)
```
Return the full path to the specified resource.

Parameters:

theNameOfTheRequestedResource - the name of the requested resource

anAliasOrFileReferenceToTheBundleContainingTheResourceDefaultIsTheTargetApplicationOrCurrentScriptBundle - an alias or file reference to the bundle containing the resource (default is the target application or current script bundle)

theNameOfASubdirectoryInTheBundleSResourcesDirectory - the name of a subdirectory in the bundle’s “Resources” directory

Returns:

the path to the resource

asciiCharacter
```
@Kind("command")
@Name("ASCII character")
String asciiCharacter(int theCodePointOfTheSpecifiedCharacter)
```
Convert a number to a character.

Parameters:

theCodePointOfTheSpecifiedCharacter - the code point of the specified character

Returns:

the character

asciiNumber
```
@Kind("command")
@Name("ASCII number")
int asciiNumber(String theCharacter)
```
Convert a character to a number.

Parameters:

theCharacter - the character

Returns:

the code point of the specified character

localizedString

@Kind("command")
@Name("localized string")
String localizedString(String theKey,
                       @Parameter("from table")
                       String theNameOfTheStringsFileExcludingTheStringsSuffixDefaultIsLocalizable,
                       @Parameter("in bundle")
                       JaplScriptFile anAliasOrFileReferenceToTheBundleContainingTheStringsFileDefaultIsTheCurrentApplicationScriptBundle)

Return the localized string for the specified key.

Parameters:: theKey - the key; theNameOfTheStringsFileExcludingTheStringsSuffixDefaultIsLocalizable - the name of the strings file excluding the “.strings” suffix (default is “Localizable”); anAliasOrFileReferenceToTheBundleContainingTheStringsFileDefaultIsTheCurrentApplicationScriptBundle - an alias or file reference to the bundle containing the strings file (default is the current application/script bundle)
Returns:: the localized string

offset
```
@Kind("command")
@Name("offset")
int offset(@Parameter("of")
           String theSourceTextToFindThePositionOf,
           @Parameter("in")
           String theTargetTextToSearchIn)
```
Find one piece of text inside another.

Parameters:

theSourceTextToFindThePositionOf - the source text to find the position of

theTargetTextToSearchIn - the target text to search in

Returns:

the position of the source text in the target, or 0 if not found

summarize
```
@Kind("command")
@Name("summarize")
String summarize(String theTextOrAnAliasToATextFileToSummarize,
                 @Parameter("in")
                 int theNumberOfSentencesDesiredInTheSummary)
```
Summarize the specified text or text file.

Parameters:

theTextOrAnAliasToATextFileToSummarize - the text (or an alias to a text file) to summarize

theNumberOfSentencesDesiredInTheSummary - the number of sentences desired in the summary

Returns:

a summarized version of the text or file

summarize
```
@Kind("command")
@Name("summarize")
String summarize(Alias theTextOrAnAliasToATextFileToSummarize,
                 @Parameter("in")
                 int theNumberOfSentencesDesiredInTheSummary)
```
Summarize the specified text or text file.

Parameters:

theTextOrAnAliasToATextFileToSummarize - the text (or an alias to a text file) to summarize

theNumberOfSentencesDesiredInTheSummary - the number of sentences desired in the summary

Returns:

a summarized version of the text or file

setTheClipboardTo
```
@Kind("command")
@Name("set the clipboard to")
void setTheClipboardTo(Reference theDataToPlaceOnTheClipboard)
```
Place data on an application’s clipboard. Use inside a ‘tell’ block and activate the application first.

Parameters:

theDataToPlaceOnTheClipboard - the data to place on the clipboard

theClipboard
```
@Kind("command")
@Name("the clipboard")
Reference theClipboard(@Parameter("as")
                       TypeClass theTypeOfDataDesired)
```
Return the contents of an application’s clipboard. Use in a ‘tell’ block after activating the application.

Parameters:

theTypeOfDataDesired - the type of data desired

Returns:

the data

clipboardInfo
```
@Kind("command")
@Name("clipboard info")
List[] clipboardInfo(@Parameter("for")
                     TypeClass restrictsToInformationAboutOnlyThisDataType)
```
Return information about the clipboard.

Parameters:

restrictsToInformationAboutOnlyThisDataType - restricts to information about only this data type

Returns:

a list of {data type, size} for each type of data on the clipboard

openForAccess
```
@Kind("command")
@Name("open for access")
int openForAccess(JaplScriptFile theFileOrAliasToOpenForAccessIfTheFileDoesNotExistANewFileIsCreated,
                  @Parameter("write permission")
                  boolean whetherToAllowWritingToTheFile)
```
Open a disk file for the read and write commands.

Parameters:

theFileOrAliasToOpenForAccessIfTheFileDoesNotExistANewFileIsCreated - the file or alias to open for access. If the file does not exist, a new file is created.

whetherToAllowWritingToTheFile - whether to allow writing to the file.

Returns:

a file reference number; use for ‘read’, ‘write’, and ‘close access’

closeAccess
```
@Kind("command")
@Name("close access")
void closeAccess(Reference theFileReferenceNumberAliasOrFileReferenceOfTheFileToClose)
```
Close a file that was opened for access.

Parameters:

theFileReferenceNumberAliasOrFileReferenceOfTheFileToClose - the file reference number, alias, or file reference of the file to close

read

@Kind("command")
@Name("read")
Reference read(Reference theFileReferenceNumberAliasOrFileReferenceOfTheFileToRead,
               @Parameter("from")
               int startingFromThisPositionIfOmittedStartAtLastPositionReadFrom,
               @Parameter("for")
               int theNumberOfBytesToReadFromCurrentPositionIfOmittedReadUntilTheEndOfTheFile,
               @Parameter("to")
               int OrStopAtThisPosition,
               @Parameter("before")
               String OrReadUpToButNotIncludingThisCharacter,
               @Parameter("until")
               String OrReadUpToAndIncludingThisCharacter,
               @Parameter("using delimiter")
               String theValueThatSeparatesItemsToRead,
               @Parameter("using delimiters")
               String[] OrAListOfValuesThatSeparateItemsToRead,
               @Parameter("as")
               TypeClass theFormInWhichToReadAndReturnData)

Read data from a file that has been opened for access.

Parameters:: theFileReferenceNumberAliasOrFileReferenceOfTheFileToRead - the file reference number, alias, or file reference of the file to read; startingFromThisPositionIfOmittedStartAtLastPositionReadFrom - starting from this position; if omitted, start at last position read from; theNumberOfBytesToReadFromCurrentPositionIfOmittedReadUntilTheEndOfTheFile - the number of bytes to read from current position; if omitted, read until the end of the file…; OrStopAtThisPosition - …or stop at this position…; OrReadUpToButNotIncludingThisCharacter - …or read up to but not including this character…; OrReadUpToAndIncludingThisCharacter - …or read up to and including this character; theValueThatSeparatesItemsToRead - the value that separates items to read…; OrAListOfValuesThatSeparateItemsToRead - …or a list of values that separate items to read; theFormInWhichToReadAndReturnData - the form in which to read and return data
Returns:: the data read from the file

write
```
@Kind("command")
@Name("write")
void write(Reference theDataToWriteToTheFile,
           @Parameter("to")
           Reference theFileReferenceNumberAliasOrFileReferenceOfTheFileToWriteTo,
           @Parameter("starting at")
           int startWritingAtThisPositionInTheFile,
           @Parameter("for")
           int theNumberOfBytesToWriteIfNotSpecifiedWriteAllTheDataProvided,
           @Parameter("as")
           TypeClass howToWriteTheDataAsTextDataListEtc)
```
Write data to a file that was opened for access with write permission.

Parameters:

theDataToWriteToTheFile - the data to write to the file

theFileReferenceNumberAliasOrFileReferenceOfTheFileToWriteTo - the file reference number, alias, or file reference of the file to write to

startWritingAtThisPositionInTheFile - start writing at this position in the file

theNumberOfBytesToWriteIfNotSpecifiedWriteAllTheDataProvided - the number of bytes to write; if not specified, write all the data provided

howToWriteTheDataAsTextDataListEtc - how to write the data: as text, data, list, etc.

getEof
```
@Kind("command")
@Name("get eof")
int getEof(Reference aFileReferenceNumberAliasOrFileReferenceOfAFile)
```
Return the length, in bytes, of a file.

Parameters:

aFileReferenceNumberAliasOrFileReferenceOfAFile - a file reference number, alias, or file reference of a file

Returns:

the total number of bytes in the file

setEof
```
@Kind("command")
@Name("set eof")
void setEof(Reference aFileReferenceNumberAliasOrFileReferenceOfAFile,
            @Parameter("to")
            int theNewLengthOfTheFileInBytesAnyDataBeyondThisPositionIsLost)
```
Set the length, in bytes, of a file.

Parameters:

aFileReferenceNumberAliasOrFileReferenceOfAFile - a file reference number, alias, or file reference of a file

theNewLengthOfTheFileInBytesAnyDataBeyondThisPositionIsLost - the new length of the file, in bytes. Any data beyond this position is lost.

loadScript
```
@Kind("command")
@Name("load script")
Reference loadScript(JaplScriptFile anAliasOrFileReferenceToTheFileContainingTheScriptObject)
```
Return a script object loaded from a specified file.

Parameters:

anAliasOrFileReferenceToTheFileContainingTheScriptObject - an alias or file reference to the file containing the script object

Returns:

the script object. You can get this object’s properties or call its handlers as if it were a local script object.

storeScript

@Kind("command")
@Name("store script")
void storeScript(Reference theScriptObjectToStore,
                 @Parameter("in")
                 JaplScriptFile anAliasOrFileReferenceToTheFileToStoreTheScriptObjectIn,
                 @Parameter("replacing")
                 Savo controlDisplayOfTheSaveAsDialog)

Store a script object into a file.

Parameters:: theScriptObjectToStore - the script object to store; anAliasOrFileReferenceToTheFileToStoreTheScriptObjectIn - an alias or file reference to the file to store the script object in; controlDisplayOfTheSaveAsDialog - control display of the Save As dialog

runScript

@Kind("command")
@Name("run script")
Reference runScript(Reference theScriptTextOrAnAliasOrFileReferenceToAScriptFileToRun,
                    @Parameter("with parameters")
                    Reference[] aListOfParameters,
                    @Parameter("in")
                    String theScriptingComponentToUseDefaultIsTheCurrentScriptingComponent)

Run a specified script or script file.

Parameters:: theScriptTextOrAnAliasOrFileReferenceToAScriptFileToRun - the script text (or an alias or file reference to a script file) to run; aListOfParameters - a list of parameters; theScriptingComponentToUseDefaultIsTheCurrentScriptingComponent - the scripting component to use; default is the current scripting component
Returns:: the result of running the script

scriptingComponents
```
@Kind("command")
@Name("scripting components")
String[] scriptingComponents()
```
Return a list of all scripting components (e.g. AppleScript).

Returns:

a list of installed scripting components

currentDate
```
@Kind("command")
@Name("current date")
Date currentDate()
```
Return the current date and time.

Returns:

the current date and time. Use ‘month of (current date)’, etc. to get individual parts.

doShellScript

@Kind("command")
@Name("do shell script")
String doShellScript(String theShellScriptToExecute,
                     @Parameter("as")
                     TypeClass theDesiredTypeOfResultDefaultIsTextUtf8,
                     @Parameter("administrator privileges")
                     boolean executeTheCommandAsTheAdministrator,
                     @Parameter("user name")
                     String useThisAdministratorAccountToAvoidAPasswordDialogIfThisParameterIsSpecifiedThePasswordParameterMustAlsoBeSpecified,
                     @Parameter("password")
                     String useThisAdministratorPasswordToAvoidAPasswordDialog,
                     @Parameter("with prompt")
                     String thePromptToBeDisplayedInThePasswordDialogWhenTheNameAndPasswordAreNotSpecifiedOrAreIncorrect,
                     @Parameter("altering line endings")
                     boolean changeAllLineEndingsToMacStyleAndTrimATrailingOneDefaultTrue)

Execute a shell script using the ‘sh’ shell.

Parameters:: theShellScriptToExecute - the shell script to execute.; theDesiredTypeOfResultDefaultIsTextUtf8 - the desired type of result; default is text (UTF-8); executeTheCommandAsTheAdministrator - execute the command as the administrator; useThisAdministratorAccountToAvoidAPasswordDialogIfThisParameterIsSpecifiedThePasswordParameterMustAlsoBeSpecified - use this administrator account to avoid a password dialog (If this parameter is specified, the “password” parameter must also be specified.); useThisAdministratorPasswordToAvoidAPasswordDialog - use this administrator password to avoid a password dialog; thePromptToBeDisplayedInThePasswordDialogWhenTheNameAndPasswordAreNotSpecifiedOrAreIncorrect - the prompt to be displayed in the password dialog when the name and password are not specified or are incorrect; changeAllLineEndingsToMacStyleAndTrimATrailingOneDefaultTrue - change all line endings to Mac-style and trim a trailing one (default true)
Returns:: the command output

getVolumeSettings
```
@Kind("command")
@Name("get volume settings")
VolumeSettings getVolumeSettings()
```
Get the sound output and input volume settings.

Returns:

a record containing the sound output and input volume settings

randomNumber
```
@Kind("command")
@Name("random number")
double randomNumber(double theUpperLimitDefaultIs10IfThisParameterIsSpecifiedTheFromAndToParametersWillBeIgnored,
                    @Parameter("from")
                    double theLowestNumberToReturnDefaultIs00,
                    @Parameter("to")
                    double theHighestNumberToReturnDefaultIs10,
                    @Parameter("with seed")
                    int aStartingPointForARepeatableSequenceOfRandomNumbersAValueOf0WillUseARandomSeed)
```
Generate a random number.

Parameters:

theUpperLimitDefaultIs10IfThisParameterIsSpecifiedTheFromAndToParametersWillBeIgnored - the upper limit (Default is 1.0. If this parameter is specified, the “from” and “to” parameters will be ignored.)

theLowestNumberToReturnDefaultIs00 - the lowest number to return (default is 0.0)

theHighestNumberToReturnDefaultIs10 - the highest number to return (default is 1.0)

aStartingPointForARepeatableSequenceOfRandomNumbersAValueOf0WillUseARandomSeed - a starting point for a repeatable sequence of random numbers. A value of 0 will use a random seed.

Returns:

a number between the “from” and “to” limits, including limit values. If all specified limits are integers, the result is an integer. Otherwise, the result is a real.

round
```
@Kind("command")
@Name("round")
int round(double theNumberToRound,
          @Parameter("rounding")
          Olie theRoundingDirectionIfOmittedRoundsToNearestToNearestRounds5CasesToTheNearestEvenIntegerInOrderToDecreaseCumulativeErrorsToAlwaysRound5AwayFromZeroUseAsTaughtInSchool)
```
Round number to integer.

Parameters:

theNumberToRound - the number to round

theRoundingDirectionIfOmittedRoundsToNearestToNearestRounds5CasesToTheNearestEvenIntegerInOrderToDecreaseCumulativeErrorsToAlwaysRound5AwayFromZeroUseAsTaughtInSchool - the rounding direction; if omitted, rounds to nearest. “to nearest” rounds .5 cases to the nearest even integer in order to decrease cumulative errors. To always round .5 away from zero, use “as taught in school.”

Returns:

the rounded value

setVolume

@Kind("command")
@Name("set volume")
void setVolume(double theSoundOutputVolumeARealNumberFrom0To7ThisParameterIsDeprecatedIfSpecifiedAllOtherParametersWillBeIgnored,
               @Parameter("output volume")
               int theSoundOutputVolumeAnIntegerFrom0To100,
               @Parameter("input volume")
               int theSoundInputVolumeAnIntegerFrom0To100,
               @Parameter("alert volume")
               int theAlertVolumeAnIntegerFrom0To100,
               @Parameter("output muted")
               boolean shouldTheSoundOutputBeMuted)

Set the sound output and/or input volume.

Parameters:: theSoundOutputVolumeARealNumberFrom0To7ThisParameterIsDeprecatedIfSpecifiedAllOtherParametersWillBeIgnored - the sound output volume, a real number from 0 to 7 (This parameter is deprecated; if specified, all other parameters will be ignored.); theSoundOutputVolumeAnIntegerFrom0To100 - the sound output volume, an integer from 0 to 100; theSoundInputVolumeAnIntegerFrom0To100 - the sound input volume, an integer from 0 to 100; theAlertVolumeAnIntegerFrom0To100 - the alert volume, an integer from 0 to 100; shouldTheSoundOutputBeMuted - Should the sound output be muted?

systemAttribute
```
@Kind("command")
@Name("system attribute")
Reference systemAttribute(Reference theAttributeToTestEitherAGestaltValueOrAShellEnvironmentVariable,
                          @Parameter("has")
                          int testSpecificBitsOfResponseIgnoredForEnvironmentVariables)
```
Test attributes of this computer.

Parameters:

theAttributeToTestEitherAGestaltValueOrAShellEnvironmentVariable - the attribute to test (either a “Gestalt” value or a shell environment variable).

testSpecificBitsOfResponseIgnoredForEnvironmentVariables - test specific bits of response (ignored for environment variables)

Returns:

the result of the query (or a list of all environment variables, if no attribute is provided)

systemInfo
```
@Kind("command")
@Name("system info")
SystemInformation systemInfo()
```
Get information about the system.

Returns:

a record containing the system information

timeToGmt
```
@Kind("command")
@Name("time to GMT")
int timeToGmt()
```
Return the difference between local time and GMT (Universal Time).

Returns:

the difference between current time zone and Universal Time, in seconds

openingFolder
```
@Kind("command")
@Name("opening folder")
void openingFolder(Alias theFolderThatWasOpened)
```
Called after a folder has been opened into a window.

Parameters:

theFolderThatWasOpened - the folder that was opened

closingFolderWindowFor
```
@Kind("command")
@Name("closing folder window for")
void closingFolderWindowFor(Alias theFolderThatWasClosed)
```
Called after a folder window has been closed.

Parameters:

theFolderThatWasClosed - the folder that was closed

movingFolderWindowFor

@Kind("command")
@Name("moving folder window for")
void movingFolderWindowFor(Alias theFolderWhoseWindowWasMovedOrResized,
                           @Parameter("from")
                           Rectangle thePreviousCoordinatesOfFolderWindowYouCanGetTheNewCoordinatesFromTheFinder)

Called after a folder window has been moved or resized.

Parameters:: theFolderWhoseWindowWasMovedOrResized - the folder whose window was moved or resized; thePreviousCoordinatesOfFolderWindowYouCanGetTheNewCoordinatesFromTheFinder - the previous coordinates of folder window (you can get the new coordinates from the Finder)

addingFolderItemsTo

@Kind("command")
@Name("adding folder items to")
void addingFolderItemsTo(Alias folderReceivingTheNewItems,
                         @Parameter("after receiving")
                         Alias[] aListOfTheItemsTheFolderReceived)

Called after new items have been added to a folder.

Parameters:: folderReceivingTheNewItems - Folder receiving the new items; aListOfTheItemsTheFolderReceived - a list of the items the folder received

removingFolderItemsFrom

@Kind("command")
@Name("removing folder items from")
void removingFolderItemsFrom(Alias theFolderLosingTheItems,
                             @Parameter("after losing")
                             Alias[] aListOfTheItemsTheFolderLostForPermanentlyDeletedItemsOnlyTheNamesInStringsAreProvided)

Called after items have been removed from a folder.

Parameters:: theFolderLosingTheItems - the folder losing the items; aListOfTheItemsTheFolderLostForPermanentlyDeletedItemsOnlyTheNamesInStringsAreProvided - a list of the items the folder lost. For permanently deleted items, only the names (in strings) are provided.

openLocation

@Kind("command")
@Name("open location")
void openLocation(String theUrlToOpen,
                  @Parameter("error reporting")
                  boolean shouldErrorConditionsBeReportedInADialog)

Opens a URL with the appropriate program.

Parameters:: theUrlToOpen - the URL to open; shouldErrorConditionsBeReportedInADialog - Should error conditions be reported in a dialog?

handleCgiRequest

@Kind("command")
@Name("handle CGI request")
WebPage handleCgiRequest(String thePathOfTheUrl,
                         @Parameter("searching for")
                         String theDataForTheGetMethodOrDataAfterTheInAPostMethod,
                         @Parameter("with posted data")
                         String thePostArguments,
                         @Parameter("of content type")
                         String theMimeContentTypeOfPostArguments,
                         @Parameter("using access method")
                         String eitherGetOrPost,
                         @Parameter("from address")
                         String theIpAddressOfTheEntityMakingTheRequest,
                         @Parameter("from user")
                         String theUserNameAssociatedWithTheRequest,
                         @Parameter("using password")
                         String thePasswordSentWithTheRequest,
                         @Parameter("with user info")
                         String additionalInformationAboutTheUserUsuallyTheEmailAddress,
                         @Parameter("from server")
                         String theNameOfTheServerApplicationSendingThisRequest,
                         @Parameter("via port")
                         String theIpPortNumberOfTheServer,
                         @Parameter("executing by")
                         String thePathToTheScriptExecutingThisCgiInUrlForm,
                         @Parameter("referred by")
                         String theUrlOfThePageTheClientUsedToLinkToTheCgi,
                         @Parameter("from browser")
                         String theNameOfTheClientSoftware,
                         @Parameter("using action")
                         String thePathToTheFileOrCgi,
                         @Parameter("of action type")
                         String eitherPreprocessorPostprocessorCgiOrAcgi,
                         @Parameter("from client IP address")
                         String theInternetAddressOfTheClient,
                         @Parameter("with full request")
                         String theFullRequestAsSentToTheServer,
                         @Parameter("with connection ID")
                         int theIdOfTheConnectionFromTheServerToTheClient,
                         @Parameter("from virtual host")
                         String theUrlOfTheRootFolderOfTheVirtualHost)

Sent to a script to process a Common Gateway Interface request.

Parameters:: thePathOfTheUrl - the path of the URL; theDataForTheGetMethodOrDataAfterTheInAPostMethod - the data for the GET method or data after the ‘?’ in a POST method; thePostArguments - the POST arguments; theMimeContentTypeOfPostArguments - the MIME content type of POST arguments; eitherGetOrPost - either ‘GET’ or ‘POST’; theIpAddressOfTheEntityMakingTheRequest - the IP address of the entity making the request; theUserNameAssociatedWithTheRequest - the user name associated with the request; thePasswordSentWithTheRequest - the password sent with the request; additionalInformationAboutTheUserUsuallyTheEmailAddress - additional information about the user, usually the email address; theNameOfTheServerApplicationSendingThisRequest - the name of the server application sending this request; theIpPortNumberOfTheServer - the IP port number of the server; thePathToTheScriptExecutingThisCgiInUrlForm - the path to the script executing this CGI, in URL form; theUrlOfThePageTheClientUsedToLinkToTheCgi - the URL of the page the client used to link to the CGI; theNameOfTheClientSoftware - the name of the client software; thePathToTheFileOrCgi - the path to the file or CGI; eitherPreprocessorPostprocessorCgiOrAcgi - either PREPROCESSOR, POSTPROCESSOR, CGI, or ACGI; theInternetAddressOfTheClient - the Internet address of the client; theFullRequestAsSentToTheServer - the full request as sent to the server; theIdOfTheConnectionFromTheServerToTheClient - the ID of the connection from the server to the client; theUrlOfTheRootFolderOfTheVirtualHost - the URL of the root folder of the virtual host
Returns:: An HTML page resulting from the CGI execution

getProperties
```
Map<String,Object> getProperties()
```
Returns all properties for an instance of this class.

Returns:

Map containing all properties

getInstance
```
static ScriptingAddition getInstance()
```
Returns an instance for application StandardAdditions.

Returns:

instance

Interface ScriptingAddition

Field Summary

Method Summary

Methods inherited from interface com.tagtraum.japlscript.Reference

Field Detail

CLASS

APPLICATION_CLASSES

Method Detail

beep

chooseApplication

chooseColor

chooseFile

chooseFileName

chooseFolder

chooseFromList

chooseFromList

chooseRemoteApplication

chooseUrl

delay

displayAlert

displayDialog

displayNotification

say

infoFor

listDisks

listFolder

mountVolume

pathTo

pathTo

pathTo

pathToResource

asciiCharacter

asciiNumber

localizedString

offset

summarize

summarize

setTheClipboardTo

theClipboard

clipboardInfo

openForAccess

closeAccess

read

write

getEof

setEof

loadScript

storeScript

runScript

scriptingComponents

currentDate

doShellScript

getVolumeSettings

randomNumber

round

setVolume

systemAttribute

systemInfo

timeToGmt

openingFolder

closingFolderWindowFor

movingFolderWindowFor

addingFolderItemsTo

removingFolderItemsFrom

openLocation

handleCgiRequest

getProperties

getInstance