ScriptingParameter (JaplSE 0.9.2, Java API for AppleScript System Events generated by JaplScript 3.4.11)

@Plural("scripting parameters")
@Code("sdpa")
@Name("scripting parameter")
public interface ScriptingParameter
extends Reference

A parameter within a command within a suite within a scripting definition.

Fields
Modifier and Type	Field	Description
`static TypeClass`	`CLASS`

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`String`	`getDescription()`	The description of the parameter.
`String`	`getId()`	The unique identifier of the parameter.
`String`	`getKind()`	The kind of object or data specified by this parameter.
`String`	`getName()`	The name of the parameter.
`Map<String,Object>`	`getProperties()`	Returns all properties for an instance of this class.
`boolean`	`isHidden()`	Is the parameter hidden?
`boolean`	`isOptional()`	Is the parameter optional?

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

The name of the parameter.

@Code("ID  ")
@Kind("property")
@Name("id")
@Type("text")
String getId()

The unique identifier of the parameter.

@Code("desc")
@Kind("property")
@Name("description")
@Type("text")
String getDescription()

The description of the parameter.

@Code("hidn")
@Kind("property")
@Name("hidden")
@Type("boolean")
boolean isHidden()

Is the parameter hidden?

@Code("kind")
@Kind("property")
@Name("kind")
@Type("text")
String getKind()

The kind of object or data specified by this parameter.

@Code("optl")
@Kind("property")
@Name("optional")
@Type("boolean")
boolean isOptional()

Is the parameter optional?

Interface ScriptingParameter