AttachmentAPI#

Interface AttachmentAPI

With the AttachmentAPI you can access additional data attached to a node.

Hierarchy

AttachmentAPI
- ContextAPI

Index

Methods

createAttachment fetchAttachmentData getAttachmentData getAttachmentDataURI removeAttachment setAttachmentData setAttachmentDataURI

Methods

createAttachment

createAttachment(dataType?): number
Creates a new attachment.
Parameters
- Optional dataType: AttachmentType
  
  Specifies the attachment data type.
Returns number
The attachment id.

fetchAttachmentData

fetchAttachmentData<T>(attachmentID?): Promise<T>
Fetches & returns the attachment data.
Type Parameters
- T = any
Parameters
- Optional attachmentID: number
  
  Specifies the attachment object.
Returns Promise<T>
The attached data.

getAttachmentData

getAttachmentData<T>(attachmentID?): T
Returns the attachment data.
Type Parameters
- T = any
Parameters
- Optional attachmentID: number
  
  Specifies the attachment object.
Returns T
The attached data

Deprecated
getAttachmentData is deprecated, please use fetchAttachmentData instead.

getAttachmentDataURI

getAttachmentDataURI(attachmentID?): string
Returns the attachment data URI.
Parameters
- Optional attachmentID: number
  
  Specifies the attachment object.
Returns string

removeAttachment

removeAttachment(attachmentID?): void
Removes an existing attachment.
Parameters
- Optional attachmentID: number
  
  Specifies the attachment object.
Returns void

setAttachmentData

setAttachmentData<T>(attachmentID?, data?): void
Sets the attachment data.
Type Parameters
- T = any
Parameters
- Optional attachmentID: number
  
  Specifies the attachment object.
- Optional data: T
  
  The new attachment data.
Returns void

setAttachmentDataURI

setAttachmentDataURI(attachmentID?, dataURI?): void
Sets the attachment data URI.
Parameters
- Optional attachmentID: number
  
  Specifies the attachment object.
- Optional dataURI: string
  
  The attachment data URI.
Returns void

Did you find this page useful? Please give it a rating:

★ ★ ★ ★ ★

Thank you for rating this page!

Any issues or feedback?

What kind of problem would you like to report?

This page needs code samples
Code samples do not work
Information is missing
Please tell us more about what's wrong:
Information is incorrect
Please tell us more about what's wrong:
Information is unclear or confusing
Please tell us more about what's wrong:
The page is rendered incorrectly (styling/CSS)
Give Feedback