Class ContentMgr

Provides helper methods for getting content assets, library folders and the content library of the current site.

Constant Summary 

ConstantDescription
PRIVATE_LIBRARY: String = “PrivateLibrary”The input string to identify that the library is a private site library when invoking getLibrary(String).

Property Summary 

PropertyDescription
siteLibrary: Library (read-only)Returns the content library of the current site.

Constructor Summary 

This class does not have a constructor, so you cannot create it directly.

Method Summary 

MethodDescription
static getContent(Library, String)Returns the content with the corresponding identifier within the specified library.
static getContent(String)Returns the content with the corresponding identifier within the current site’s site library.
static getFolder(Library, String)Returns the folder identified by the specified id within the specified library.
static getFolder(String)Returns the folder identified by the specified id within the current site’s site library.
static getLibrary(String)Returns the content library specified by the given id.
static getSiteLibrary()Returns the content library of the current site.

Methods inherited from class Object 

assign, create, create, defineProperties, defineProperty, entries, freeze, fromEntries, getOwnPropertyDescriptor, getOwnPropertyNames, getOwnPropertySymbols, getPrototypeOf, hasOwnProperty, is, isExtensible, isFrozen, isPrototypeOf, isSealed, keys, preventExtensions, propertyIsEnumerable, seal, setPrototypeOf, toLocaleString, toString, valueOf, values

Constant Details 

PRIVATE_LIBRARY 

PRIVATE_LIBRARY: String = "PrivateLibrary"

The input string to identify that the library is a private site library when invoking getLibrary(String).


Property Details 

siteLibrary 

siteLibrary: Library (read-only)

Returns the content library of the current site.


Method Details 

getContent(Library, String) 

static getContent(library: Library, id: String): Content

Returns the content with the corresponding identifier within the specified library.

Parameters:

  • library - the content library to look for the content in
  • id - the ID of the content asset to find.

Returns:

  • the content if found, or null if not found.

getContent(String) 

static getContent(id: String): Content

Returns the content with the corresponding identifier within the current site's site library.

Parameters:

  • id - the ID of the content asset to find.

Returns:

  • the content if found, or null if not found.

getFolder(Library, String) 

static getFolder(library: Library, id: String): Folder

Returns the folder identified by the specified id within the specified library.

Parameters:

  • library - the content library to look for the folder in
  • id - the ID of the folder to find.

Returns:

  • the folder, or null if not found.

getFolder(String) 

static getFolder(id: String): Folder

Returns the folder identified by the specified id within the current site's site library.

Parameters:

  • id - the ID of the folder to find.

Returns:

  • the folder, or null if not found.

getLibrary(String) 

static getLibrary(libraryId: String): Library

Returns the content library specified by the given id. If PRIVATE_LIBRARY is used, then the current site's private library will be returned.

Parameters:

  • libraryId - the id of the library to return.

Returns:

  • the library for the passed id. Returns null if there is no content library with that id.

getSiteLibrary() 

static getSiteLibrary(): Library

Returns the content library of the current site.

Returns:

  • the content library of the current site, or null if there is not content library assigned to the current site.