Attachment

Method summary

Methods

download ( )

Downloads this attachment. Depending on browser settings, this may prompt the user to choose where to save the file, or save it automatically.

Example

attachment.download();

Back to Top

getDataUrl ( ) → {string}

Returns a URL where the attachment data can be downloaded from.

Returns:

Type	Description
string	The relative path to download the attachment data

Example

var url = attachment.getDataUrl();

Back to Top

getDescription ( ) → {string}

Returns the description of the attachment.

Returns:

Type	Description
string	The description of the attachment

Example

var description = attachment.getDescription();

Back to Top

getEditor ( editorId ) → {AttachmentEditor}

Returns the editor details for the attachment.

Parameters:

Name	Type	Argument	Description
editorId	insight.enums.EditorType	optional	id of the editor to retrieve

Throws:

Will throw an error if attachment doesn't have a requested editor

Returns:

Type	Description
AttachmentEditor	Attachment Editor object. Returns editor with the same id as editorId or first editor, when editorId is not specified.

Example

var attachmentEditor = attachment.getEditor();

Back to Top

getFilename ( ) → {string}

Returns the filename for this attachment.

Returns:

Type	Description
string	The filename for this attachment

Example

var filename = attachment.getFilename();

Back to Top

getId ( ) → {string}

Returns the unique ID for this attachment.

Returns:

Type	Description
string	The ID representing this attachment

Example

var id = attachment.getId();

Back to Top

getLastModifiedDate ( ) → {Date}

Returns the date/time when the last modification of the attachment data took place.

Returns:

Type	Description
Date	The last modified time

Example

var date = attachment.getLastModifiedDate();

Back to Top

getLastModifiedUserId ( ) → {string}

Returns the ID of the last user to modify the attachment data.

Returns:

Type	Description
string	The User ID of the modifying user

Example

var userId = attachment.getLastModifiedUserId();

Back to Top

getSize ( ) → {number}

Returns the size of the attachment data.

Returns:

Type	Description
number	The size in bytes of the attachment data in bytes.

Example

var size = attachment.getSize();

Back to Top

getTags ( ) → {Array.<string>}

Returns the tags applied to this attachment.

Returns:

Type	Description
Array.<string>	An array of tag names

Example

var tags = attachment.getTags();

Back to Top

hasEditor ( editorId ) → {boolean}

Returns the editor details for the attachment.

Parameters:

Name	Type	Argument	Description
editorId	insight.enums.EditorType	optional	id of the editor to retrieve

Returns:

Type	Description
boolean	When editorId is specified, returns true if attachment has an editor with specified id, otherwise returns false. When editorId is not specified, returns true if there's any editors available, otherwise returns false

Example

var hasEditor = attachment.hasEditor();

Back to Top

openProperties ( propertyName )

Opens the file attachments dialog showing the properties of this attachment. If propertyName is provided then the edit mode will be activated for that property of the attachment.

Parameters:

Name	Type	Argument	Description
propertyName		optional	the name of a property to edit ('filename', 'description' or 'tags')

Example

attachment.openProperties('filename');

Back to Top