Title here
Summary here
AbstractMCorner
AbstractMCorner ⇐ MAbstract
Class defining a generic Corner entry holding associated contents.
Kind: global abstract mixin
Extends: MAbstract
Properties
| Name | Type |
|---|---|
| forceCorner | Boolean |
| isCorner | Boolean |
- AbstractMCorner ⇐
MAbstract- .getCornerEntries([options]) ⇒
Promise.<Array.<AbstractEntry>> - .getEntryComponents(entryId, [options]) ⇒
Promise.<Array.<AbstractEntryComponent>> - .getComponentContents(entryId, componentId, options) ⇒
ListModel.<BusinessModel> - ._getCornerEntries([options]) ⇒
Promise.<Array.<Entry>> - ._getEntryComponents(entryId, [options]) ⇒
Promise.<Entry> - ._getComponentContents(entryId, componentId, options) ⇒
ListModel.<BusinessModel>
- .getCornerEntries([options]) ⇒
getCornerEntries([options]) ⇒ Promise.<Array.<AbstractEntry>>
Return the entries of the corner, which are the access point to go deeper in a part of a corner.
Kind: instance method of AbstractMCorner
| Param | Type | Default | Description |
|---|---|---|---|
| [options] | Object | Some options | |
| [options.force] | boolean | false | If true, don't use the cache |
| [options.duration] | number | | Duration in milliseconds before invalidation of cache (if null, $$maxAge value is used by default) |
getEntryComponents(entryId, [options]) ⇒ Promise.<Array.<AbstractEntryComponent>>
Array of component types that are browsable when the user navigates the entry.
Kind: instance method of AbstractMCorner
| Param | Type | Default | Description |
|---|---|---|---|
| entryId | String | ||
| [options] | Object | Some options | |
| [options.force] | boolean | false | If true, don't use the cache |
| [options.duration] | number | | Duration in milliseconds before invalidation of cache (if null, $$maxAge value is used by default) |
getComponentContents(entryId, componentId, options) ⇒ ListModel.<BusinessModel>
Return the contents that will populate a component of an entry. May contains different types of items depending of the type of the component. Here a content refers to a data model (Content, Channel, People, Event, …).
Kind: instance method of AbstractMCorner
| Param | Type | Default | Description |
|---|---|---|---|
| entryId | string | the id of the entry | |
| componentId | string | the id of the component | |
| options | Object | null | additional options | |
| [options.duration] | number | | Duration in milliseconds before invalidation of cache (if null, $$maxAge value is used by default) |
_getCornerEntries([options]) ⇒ Promise.<Array.<Entry>>
Retrieves current corner entries.
Kind: instance abstract method of AbstractMCorner
Returns: Promise.<Array.<Entry>> - A promise holding a list of corner entries.
| Param | Type | Description |
|---|---|---|
| [options] | Object | Some options |
_getEntryComponents(entryId, [options]) ⇒ Promise.<Entry>
Retrieves the components for a given corner entry.
Kind: instance abstract method of AbstractMCorner
Returns: Promise.<Entry> - A promise holding an entry object when resolved.
| Param | Type | Description |
|---|---|---|
| entryId | String | the identifier of the corner entry (of the module) |
| [options] | Object | Some options |
_getComponentContents(entryId, componentId, options) ⇒ ListModel.<BusinessModel>
Return the contents that will populate a component of a corner entry.
Kind: instance abstract method of AbstractMCorner
Returns: ListModel.<BusinessModel> - A list model object holding an associated business model.
| Param | Type | Description |
|---|---|---|
| entryId | string | the identifier of the corner entry (of the module) |
| componentId | string | the identifier of the component |
| options | Object | additional options |
Next
Aggregate