In This Topic ▼

loadDocumentAttachment Method

Summary

Loads an attachment as a LEADDocument object.

Syntax

TypeScript

JavaScript

loadDocumentAttachment = function( 
   ownerDocument, 
   ownerDocumentId, 
   options 
)

static loadDocumentAttachment( 
   ownerDocument: LEADDocument, 
   ownerDocumentId: string, 
   options: LoadAttachmentOptions 
): JQueryPromise<LEADDocument>;

Parameters

ownerDocument

Owner document. If this is null, then the owner document is specified by

ownerDocumentId.

ownerDocumentId

Owner document ID. If this is null, then the owner document is specified by ownerDocument.

options

Options to identify and load the attachment. This value cannot be null.

Return Value

A Promise object that can resolve successfully to a LEADDocument object for the attachment, or fail if the attachment cannot be loaded.

Remarks

Use loadDocumentAttachment to load an attachment from a document. The method can be used if the owner document is already loaded as a LEADDocument object (by passing it as the ownerDocument parameter), or to save an attachment if the owner document is not loaded and only its ID is available (by passing its ID as the ownerDocumentId parameter).

This method works as follows:

Only if using ownerDocumentId: The owner document is loaded from the cache using loadFromCache. If loading is not successful, then null is returned.
The corresponding DocumentAttachment object for LoadAttachmentOptions.attachmentNumber of options is obtained.

If loading is not successful, then an exception is thrown.

If the value of DocumentAttachment.documentId is not null, then it is assumed that the attachment document is already in the cache, and therefore the attachment is loaded using the options set in LoadDocumentOptions.loadAttachmentsMode using loadFromCache, and returned.

If the value of DocumentAttachment.documentId is null or loading from the cache fails, then the workflow continues to the next step.

If the attachment is not embedded (the value of DocumentAttachment.isEmbedded is false), then null is returned.
If the attachment is embedded (the value of DocumentAttachment.isEmbedded is true), then the attachment data is loaded; and if successful, a LEADDocument object is created for it and returned.

For more information, refer to Document Attachments.

Example

For an example, refer to DocumentAttachment and DocumentAttachment.documentId.

Requirements

Target Platforms