Adobe DPS - JavaScript Library API

Class adobeDPS-DocumentMap

See:
adobeDPS-Folio

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.

Fields

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

Methods

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.
Returns:
Array The sorted array of Objects
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.
Returns:
Object The Document with the requested productId or null
©2012-2013 Adobe Systems, inc
Documentation generated by JsDoc Toolkit 2.4.0 on Fri Feb 01 2013 13:18:38 GMT-0800 (PST)