Class adobeDPS-DocumentMap

A map of Documents to ids with update signals.
Accessible from adobeDPS.libraryService.folioMap

Constructor

adobeDPS-DocumentMap()

[inner] Create a new map of documents by id.

	Field	Defined By
	addedSignal : adobeDPS-Signal Signal indicating that documents have been added to internal.	DocumentMap
	removedSignal : adobeDPS-Signal Signal indicating that documents have been removed from internal.	DocumentMap
	internal : Object An associative array containing the documents, indexed by id.	DocumentMap

	Method	Defined By
	sort(sortFunc:function) Function to sort the map using a sort function and return a new Array of objects.	DocumentMap
	getByProductId(productId:String) Get a document from the list by its productId, if it has such a field.	DocumentMap

Class Detail

adobeDPS-DocumentMap()

[inner] Create a new map of documents by id.

Field Details

addedSignal : adobeDPS-Signal

Signal indicating that documents have been added to internal.
Callback Signature: documentsAddedHandler([ Object, ...])

removedSignal : adobeDPS-Signal

Signal indicating that documents have been removed from internal.
Callback Signature: documentsRemovedHandler([ Object, ...])

internal : Object

An associative array containing the documents, indexed by id.

Method Details

sort(sortFunc:function) : Array

Function to sort the map using a sort function and return a new Array of objects.

Parameters
sortFunc	function	A function to sort the Map. This function can be any function accepted by the `Array.sort()` function.

getByProductId(productId:String) : Object

Get a document from the list by its productId, if it has such a field. Returns null if a document with the provided productId cannot be found.

Parameters
productId	String	The productId of the Folio requested.