In This Topic ▼

saveAttachmentToCache Method

Summary

Saves an attachment to the cache.

Syntax

TypeScript

JavaScript

saveAttachmentToCache = function( 
   ownerDocument, 
   ownerDocumentId, 
   options 
)

static saveAttachmentToCache( 
   ownerDocument: LEADDocument, 
   ownerDocumentId: string, 
   options: SaveAttachmentToCacheOptions 
): JQueryPromise<string>;

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 save the attachment. This value cannot be null.

Return Value

A Promise object that can resolve successfully to a string object identifying the attachment document ID, or fail if the operation was not successful.

Remarks

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

One of ownerDocument or ownerDocumentId must be specified but not both.

This method works as follows:

If and 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 SaveAttachmentToCacheOptions.attachmentNumber of options is obtained.

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

If the value of DocumentAttachment.documentId is not null, it is assumed that the attachment document is already in the cache and therefore this value is returned directly.

If this value is null or checking if the document in cache fails, then the workflow continues to the next section.

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 obtained; and if successful, saved (uploaded) into the cache using the options set in SaveAttachmentToCacheOptions.uploadDocumentOptions of options. The ID of this new document is returned.