A file link.
link properties
| Property | Type | Access | Description |
|---|---|---|---|
| asset etag | string | read | The asset etag of the link. |
| asset ID | string | read | The asset ID of the link. |
| asset URL | string | read | The asset URL of the link. |
| class | integer | read | The class descriptor type. |
| date | date | read | Date and time. |
| edited | boolean | read | The edit state of the link. |
| editing state | editing state enumeration | read | Editing state for Version Cue. |
| file path | alias or string | read | The file path. |
| id | integer | read | A unique number identifying the object. |
| index | integer | read | Index of the object within its parent object. |
| label | string | r/w | A label that can be set to any string. |
| link type | string | read | The type of the link. |
| link xmp | link metadata | read | The XMP data of the linked file. |
| name | string | read | The name of the object. |
| needed | boolean | read | The need state of the link. |
| object reference | object | read | An object reference for this object. |
| parent | story, graphic, movie, sound | read | The parent of the object. |
| properties | record | r/w | Property that allows setting of several properties at the same time. |
| size | integer | read | Size of the linked file. |
| status | link status enumeration | read | The status of the link. |
| stock state | link stock state enumeration | read | The stock state of the link. |
| version state | version state enumeration | read | Version state for Version Cue. |
link methods
| Method | Returns | Description |
|---|---|---|
| copy link | Nothing | Copy link file to new location. |
| edit original | Nothing | Edit original. |
| extract label | string | Gets the content of the label associated with the specified key (name). |
| insert label | Nothing | Sets the content of the label associated with the specified key (name), creating the label if it does not already exist. |
| relink | Nothing | Relink the link to a diļ¬erent file. |
| reveal in Bridge | Nothing | Reveal in Bridge. |
| reveal in system | Nothing | Reveal in System. |
| save a version | Nothing | Save a version to Version Cue. |
| show | Nothing | Show link. |
| unembed | Nothing | Unembed data and link to new file or link to original. |
| unlink | Nothing | Unlink text or embed images. |
| update | link | Update Link. |