Comments Panel Scripting Functions

This page details the various component and extension functions available for Vision's Comments Panel component.

Component Functions

This component does not have component functions associated with it.

Extension Functions

insertNote

• Description
  • Called when a note is added.
• Parameters
  • component self - A reference to the component that is invoking this function
  • string note - The text contents of the note
  • string filename - The full filepath to the the attachment
  • string sticky - A boolean indicating whether this note should be flagged as stickied
• Return
  • Nothing
• Scope
  • Client

deleteNote

• Description
  • Called when a user clicks the 'delete' link on a note.
• Parameters
  • component self - A reference to the component that is invoking this function
  • integer id - The id of the note
• Return
  • Nothing
• Scope
  • Client

unstickNote

• Description
  • Called when a user clicks the 'unstick' link on a note.
• Parameters
  • component self - A reference to the component that is invoking this function
  • integer id - The id of the note
• Return
  • Nothing
• Scope
  • Client

downloadAttachment

• Description
  • Called when a user attempts to download an attachment from a note.
• Parameters
  • component self - A reference to the component that is invoking this function
  • integer id - The id of the note
• Return
  • Nothing
• Scope
  • Client

canDelete

• Description
  • Returns whether or not a note with the given id can be deleted. Notes that return True will show a 'delete' link.
• Parameters
  • component self - A reference to the component that is invoking this function
  • integer id - The id of the note
• Return
  • boolean - Notes with a True return can be deleted by the user, False return can not be deleted.
• Scope
  • Client