An assignment.
|
Property
|
Type
|
Access
|
Description
|
|
assignedStories
|
AssignedStories
|
read
|
Every assigned story.
|
|
assignmentFileStatus
|
AssignmentStatus enumeration
|
read
|
The status of the assignment file.
|
|
documentPath
|
String
|
read
|
The path to the document this destination points to.
|
|
exportOptions
|
AssignmentExportOptions enumeration
|
r/w
|
The fidelity of the assignment proxy file.
|
|
filePath
|
File
|
read
|
The file path.
|
|
frameColor
|
Array of 3 Reals (0 - 255), UIColors enumeration (see table at end of chapter)
|
r/w
|
The color of the assignment’s frames.
|
|
|
id
|
Long
|
read
|
A unique number identifying the object.
|
|
index
|
Long
|
read
|
Index of the object within its parent object.
|
|
label
|
String
|
r/w
|
A label that can be set to any string.
|
|
name
|
String
|
r/w
|
The name of the object.
|
|
parent
|
Object
|
read
|
The parent of the object.
|
|
properties
|
An array of property names and values
|
r/w
|
Property that allows setting of several properties at the same time.
|
|
userName
|
String
|
r/w
|
The user name for tracked changes and notes.
|
|
Method
|
Returns
|
Description
|
|
extractLabel
|
String
|
Gets the content of the label associated with the specified key (name).
|
|
getElements
|
Array of Objects
|
Resolve the object specifier.
|
|
insertLabel
|
Nothing
|
Sets the content of the label associated with the specified key (name), creating the label if it does not already exist.
|
|
remove
|
Assignment
|
Delete an assignment and its file.
|
|
toSource
|
String
|
Generate JavaScript source that, if executed, will return the specified objects.
|
|
toSpecifier
|
String
|
Retrieve the object specifier.
|
|
update
|
Nothing
|
Update an assignment file.
|
