Link

Methods:

copyLink, editOriginal, extractLabel, getElements, insertLabel, relink, revealInBridge, revealInSystem, saveAVersion, show, toSource, toSpecifier, unembed, unlink, update

Objects:

Boolean, Date, EditingState, File, LinkMetadata, LinkStatus, LinkStockState, Number, Object, String, VersionState

Property Listing

Property	Type	Access	Description
assetEtag	String	readonly	The asset etag of the linked object.
assetID	String	readonly	The asset ID of the linked object.
assetURL	String	readonly	The asset URL of the linked object.
date	Date	readonly	The date and time the Link was created.
edited	Boolean	readonly	If true, indicates the linked object has been edited in the current document but the source file has not been updated.
editingState	EditingState EditingState.EDITING_CONFLICT EditingState.EDITING_LOCALLY EditingState.EDITING_LOCALLY_LOCKED EditingState.EDITING_NOWHERE EditingState.EDITING_REMOTELY EditingState.EDITING_UNKNOWN	readonly	The Version Cue editing state of the file.
filePath	File	readonly	The full path to the file.
id	Number	readonly	The unique ID of the Link.
index	Number	readonly	The index of the link in the links collection.
label	String	read/write	A property that can be set to any string.
linkType	String	readonly	The file type of the linked object.
linkXmp	LinkMetadata	readonly	XMP data for the link source file.
name	String	readonly	The name of the Link.
needed	Boolean	readonly	If true, indicates a link to a full-resolution version of the source file is needed. If false, indicates the object is embedded.
parent		readonly	The linked object. Can return: Story, Graphic, Movie or Sound.
properties	Object	read/write	A property that allows setting of several properties at the same time.
size	Number	readonly	The size of the Link file.
status	LinkStatus LinkStatus.LINK_EMBEDDED LinkStatus.LINK_MISSING LinkStatus.LINK_OUT_OF_DATE LinkStatus.NORMAL	readonly	The status of the link.
stockState	LinkStockState LinkStockState.LINK_IS_NOT_STOCK LinkStockState.LINK_IS_STOCK_COMP LinkStockState.LINK_IS_STOCK_HIGH_RESOLUTION	readonly	The stock state of the source file image.
versionState	VersionState VersionState.LOCAL_NEWER VersionState.LOCAL_PROJECT_MATCH VersionState.NO_RESOURCE VersionState.PROJECT_FILE_NEWER VersionState.VERSION_CONFLICT VersionState.VERSION_UNKNOWN	readonly	The Version Cue version state of the file.

Method Listing

undefined copyLink (to:File)

Makes a copy of the source file and places it in the specified folder. If a file name is specified in the file path, renames the copied file. Note: Cannot be used to change the file type.

Parameter	Type	Description
to	File	The folder to which to copy the file. To rename the file, include the file name in the path.

undefined editOriginal ()

Opens the source file of the link in the default editor for the source file type.

String extractLabel (key:String)

Gets the label value associated with the specified key.

Parameter	Type	Description
key	String	The key.

Object getElements ()

Resolves the object specifier, creating an array of object references.

undefined insertLabel (key:String, value:String)

Sets the label to the value associated with the specified key.

Parameter	Type	Description
key	String	The key.
value	String	The value.

undefined relink (to:File)

Points the link to a new source file.

Parameter	Type	Description
to	File	The full path name of the new source file.

undefined revealInBridge ()

Opens Adobe Bridge and selects the source file of the link.

undefined revealInSystem ()

Opens the file system to the folder that contains the source file of the link, and selects the file.

undefined saveAVersion (versionComments:String, [forceSave:Boolean=Boolean])

Saves a version to Version Cue.

Parameter	Type	Description
versionComments	String	The comments that describe the version. (Optional)
forceSave	Boolean	If true, forcibly saves the version. (Optional) (default: false)

Parameter

Type

Description

versionComments

String

The comments that describe the version. (Optional)

forceSave

Boolean

If true, forcibly saves the version. (Optional)

(default: false)

undefined show ()

Selects the link.

String toSource ()

Generates a string which, if executed, will return the Link.

String toSpecifier ()

Retrieves the object specifier.

undefined unembed (to:File)

Unembeds the source file. If no folder is specified, creates a link to the original source file; if a folder is specified, copies the file to the folder and creates a link to the copied file.