@acoustic-content-sdk/component-api
Advanced tools
Comparing version
@@ -577,3 +577,3 @@ (function (global, factory) { | ||
*/ | ||
var VERSION = { version: { major: '9', minor: '0', patch: '384', branch: 'master' }, build: new Date(1582623497680) }; | ||
var VERSION = { version: { major: '9', minor: '0', patch: '407', branch: 'master' }, build: new Date(1582907290955) }; | ||
/** | ||
@@ -580,0 +580,0 @@ * Module name |
@@ -1,2 +0,2 @@ | ||
!function(e,t){"object"==typeof exports&&"undefined"!=typeof module?t(exports):"function"==typeof define&&define.amd?define("@acoustic-content-sdk/component-api",["exports"],t):t(((e=e||self)["acoustic-content-sdk"]=e["acoustic-content-sdk"]||{},e["acoustic-content-sdk"]["component-api"]={}))}(this,(function(e){"use strict";var t={version:{major:"9",minor:"0",patch:"384",branch:"master"},build:new Date(1582623497680)};e.ACOUSTIC_RC_INTERCEPTOR_TOKEN="8453750A-4519-4184-840B-D490E909D23E",e.VERSION=t,Object.defineProperty(e,"__esModule",{value:!0})})); | ||
!function(e,t){"object"==typeof exports&&"undefined"!=typeof module?t(exports):"function"==typeof define&&define.amd?define("@acoustic-content-sdk/component-api",["exports"],t):t(((e=e||self)["acoustic-content-sdk"]=e["acoustic-content-sdk"]||{},e["acoustic-content-sdk"]["component-api"]={}))}(this,(function(e){"use strict";var t={version:{major:"9",minor:"0",patch:"407",branch:"master"},build:new Date(1582907290955)};e.ACOUSTIC_RC_INTERCEPTOR_TOKEN="8453750A-4519-4184-840B-D490E909D23E",e.VERSION=t,Object.defineProperty(e,"__esModule",{value:!0})})); | ||
//# sourceMappingURL=acoustic-content-sdk-component-api.umd.min.js.map |
@@ -10,3 +10,3 @@ /** | ||
*/ | ||
export const VERSION = { version: { major: '9', minor: '0', patch: '384', branch: 'master' }, build: new Date(1582623497680) }; | ||
export const VERSION = { version: { major: '9', minor: '0', patch: '407', branch: 'master' }, build: new Date(1582907290955) }; | ||
/** | ||
@@ -17,2 +17,2 @@ * Module name | ||
export const MODULE = '@acoustic-content-sdk/component-api'; | ||
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoidmVyc2lvbi5qcyIsInNvdXJjZVJvb3QiOiJuZzovL0BhY291c3RpYy1jb250ZW50LXNkay9jb21wb25lbnQtYXBpLyIsInNvdXJjZXMiOlsidmVyc2lvbi50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOzs7Ozs7Ozs7QUFDQSxNQUFNLE9BQU8sT0FBTyxHQUFHLEVBQUMsT0FBTyxFQUFFLEVBQUMsS0FBSyxFQUFFLEdBQUcsRUFBRSxLQUFLLEVBQUUsR0FBRyxFQUFFLEtBQUssRUFBRSxLQUFLLEVBQUUsTUFBTSxFQUFFLFFBQVEsRUFBQyxFQUFFLEtBQUssRUFBRSxJQUFJLElBQUksQ0FBQyxhQUFhLENBQUMsRUFBQzs7Ozs7QUFFMUgsTUFBTSxPQUFPLE1BQU0sR0FBRyxxQ0FBcUMiLCJzb3VyY2VzQ29udGVudCI6WyIvKiogVmVyc2lvbiBhbmQgYnVpbGQgbnVtYmVyIG9mIHRoZSBwYWNrYWdlICovXG5leHBvcnQgY29uc3QgVkVSU0lPTiA9IHt2ZXJzaW9uOiB7bWFqb3I6ICc5JywgbWlub3I6ICcwJywgcGF0Y2g6ICczODQnLCBicmFuY2g6ICdtYXN0ZXInfSwgYnVpbGQ6IG5ldyBEYXRlKDE1ODI2MjM0OTc2ODApfTtcbi8qKiBNb2R1bGUgbmFtZSAqL1xuZXhwb3J0IGNvbnN0IE1PRFVMRSA9ICdAYWNvdXN0aWMtY29udGVudC1zZGsvY29tcG9uZW50LWFwaSc7XG4iXX0= | ||
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoidmVyc2lvbi5qcyIsInNvdXJjZVJvb3QiOiJuZzovL0BhY291c3RpYy1jb250ZW50LXNkay9jb21wb25lbnQtYXBpLyIsInNvdXJjZXMiOlsidmVyc2lvbi50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOzs7Ozs7Ozs7QUFDQSxNQUFNLE9BQU8sT0FBTyxHQUFHLEVBQUMsT0FBTyxFQUFFLEVBQUMsS0FBSyxFQUFFLEdBQUcsRUFBRSxLQUFLLEVBQUUsR0FBRyxFQUFFLEtBQUssRUFBRSxLQUFLLEVBQUUsTUFBTSxFQUFFLFFBQVEsRUFBQyxFQUFFLEtBQUssRUFBRSxJQUFJLElBQUksQ0FBQyxhQUFhLENBQUMsRUFBQzs7Ozs7QUFFMUgsTUFBTSxPQUFPLE1BQU0sR0FBRyxxQ0FBcUMiLCJzb3VyY2VzQ29udGVudCI6WyIvKiogVmVyc2lvbiBhbmQgYnVpbGQgbnVtYmVyIG9mIHRoZSBwYWNrYWdlICovXG5leHBvcnQgY29uc3QgVkVSU0lPTiA9IHt2ZXJzaW9uOiB7bWFqb3I6ICc5JywgbWlub3I6ICcwJywgcGF0Y2g6ICc0MDcnLCBicmFuY2g6ICdtYXN0ZXInfSwgYnVpbGQ6IG5ldyBEYXRlKDE1ODI5MDcyOTA5NTUpfTtcbi8qKiBNb2R1bGUgbmFtZSAqL1xuZXhwb3J0IGNvbnN0IE1PRFVMRSA9ICdAYWNvdXN0aWMtY29udGVudC1zZGsvY29tcG9uZW50LWFwaSc7XG4iXX0= |
@@ -10,3 +10,3 @@ /** | ||
*/ | ||
export var VERSION = { version: { major: '9', minor: '0', patch: '384', branch: 'master' }, build: new Date(1582623497680) }; | ||
export var VERSION = { version: { major: '9', minor: '0', patch: '407', branch: 'master' }, build: new Date(1582907290955) }; | ||
/** | ||
@@ -17,2 +17,2 @@ * Module name | ||
export var MODULE = '@acoustic-content-sdk/component-api'; | ||
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoidmVyc2lvbi5qcyIsInNvdXJjZVJvb3QiOiJuZzovL0BhY291c3RpYy1jb250ZW50LXNkay9jb21wb25lbnQtYXBpLyIsInNvdXJjZXMiOlsidmVyc2lvbi50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOzs7Ozs7Ozs7QUFDQSxNQUFNLEtBQU8sT0FBTyxHQUFHLEVBQUMsT0FBTyxFQUFFLEVBQUMsS0FBSyxFQUFFLEdBQUcsRUFBRSxLQUFLLEVBQUUsR0FBRyxFQUFFLEtBQUssRUFBRSxLQUFLLEVBQUUsTUFBTSxFQUFFLFFBQVEsRUFBQyxFQUFFLEtBQUssRUFBRSxJQUFJLElBQUksQ0FBQyxhQUFhLENBQUMsRUFBQzs7Ozs7QUFFMUgsTUFBTSxLQUFPLE1BQU0sR0FBRyxxQ0FBcUMiLCJzb3VyY2VzQ29udGVudCI6WyIvKiogVmVyc2lvbiBhbmQgYnVpbGQgbnVtYmVyIG9mIHRoZSBwYWNrYWdlICovXG5leHBvcnQgY29uc3QgVkVSU0lPTiA9IHt2ZXJzaW9uOiB7bWFqb3I6ICc5JywgbWlub3I6ICcwJywgcGF0Y2g6ICczODQnLCBicmFuY2g6ICdtYXN0ZXInfSwgYnVpbGQ6IG5ldyBEYXRlKDE1ODI2MjM0OTc2ODApfTtcbi8qKiBNb2R1bGUgbmFtZSAqL1xuZXhwb3J0IGNvbnN0IE1PRFVMRSA9ICdAYWNvdXN0aWMtY29udGVudC1zZGsvY29tcG9uZW50LWFwaSc7XG4iXX0= | ||
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoidmVyc2lvbi5qcyIsInNvdXJjZVJvb3QiOiJuZzovL0BhY291c3RpYy1jb250ZW50LXNkay9jb21wb25lbnQtYXBpLyIsInNvdXJjZXMiOlsidmVyc2lvbi50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOzs7Ozs7Ozs7QUFDQSxNQUFNLEtBQU8sT0FBTyxHQUFHLEVBQUMsT0FBTyxFQUFFLEVBQUMsS0FBSyxFQUFFLEdBQUcsRUFBRSxLQUFLLEVBQUUsR0FBRyxFQUFFLEtBQUssRUFBRSxLQUFLLEVBQUUsTUFBTSxFQUFFLFFBQVEsRUFBQyxFQUFFLEtBQUssRUFBRSxJQUFJLElBQUksQ0FBQyxhQUFhLENBQUMsRUFBQzs7Ozs7QUFFMUgsTUFBTSxLQUFPLE1BQU0sR0FBRyxxQ0FBcUMiLCJzb3VyY2VzQ29udGVudCI6WyIvKiogVmVyc2lvbiBhbmQgYnVpbGQgbnVtYmVyIG9mIHRoZSBwYWNrYWdlICovXG5leHBvcnQgY29uc3QgVkVSU0lPTiA9IHt2ZXJzaW9uOiB7bWFqb3I6ICc5JywgbWlub3I6ICcwJywgcGF0Y2g6ICc0MDcnLCBicmFuY2g6ICdtYXN0ZXInfSwgYnVpbGQ6IG5ldyBEYXRlKDE1ODI5MDcyOTA5NTUpfTtcbi8qKiBNb2R1bGUgbmFtZSAqL1xuZXhwb3J0IGNvbnN0IE1PRFVMRSA9ICdAYWNvdXN0aWMtY29udGVudC1zZGsvY29tcG9uZW50LWFwaSc7XG4iXX0= |
@@ -571,3 +571,3 @@ /** | ||
*/ | ||
const VERSION = { version: { major: '9', minor: '0', patch: '384', branch: 'master' }, build: new Date(1582623497680) }; | ||
const VERSION = { version: { major: '9', minor: '0', patch: '407', branch: 'master' }, build: new Date(1582907290955) }; | ||
/** | ||
@@ -574,0 +574,0 @@ * Module name |
@@ -571,3 +571,3 @@ /** | ||
*/ | ||
var VERSION = { version: { major: '9', minor: '0', patch: '384', branch: 'master' }, build: new Date(1582623497680) }; | ||
var VERSION = { version: { major: '9', minor: '0', patch: '407', branch: 'master' }, build: new Date(1582907290955) }; | ||
/** | ||
@@ -574,0 +574,0 @@ * Module name |
@@ -1,1 +0,1 @@ | ||
{"name":"@acoustic-content-sdk/component-api","version":"9.0.384","description":"Module to attach inline-edit functionality to an WCH based Angular application.","keywords":["acoustic","acoustic-content","angular","sdk"],"bugs":{"web":"https://developer.ibm.com/answers/smartspace/wch/index.html"},"license":"MIT","author":"Carsten Leue <carsten.leue@de.ibm.com>","sideEffects":false,"main":"bundles/acoustic-content-sdk-component-api.umd.js","module":"esm5/acoustic-content-sdk-component-api.js","typings":"acoustic-content-sdk-component-api.d.ts","dependencies":{"@acoustic-content-sdk/api":"9.0.384"},"peerDependencies":{"rxjs":"^6"},"es2015":"fesm2015/acoustic-content-sdk-component-api.js","esm2015":"esm2015/acoustic-content-sdk-component-api.js","esm5":"esm5/acoustic-content-sdk-component-api.js","fesm2015":"fesm2015/acoustic-content-sdk-component-api.js","fesm5":"fesm5/acoustic-content-sdk-component-api.js","tsdoc":{"tsdocFlavor":"AEDoc"},"publishConfig":{"registry":"https://registry.npmjs.org/","access":"public"}} | ||
{"name":"@acoustic-content-sdk/component-api","version":"9.0.407","description":"Module to attach inline-edit functionality to an WCH based Angular application.","keywords":["acoustic","acoustic-content","angular","sdk"],"bugs":{"web":"https://developer.ibm.com/answers/smartspace/wch/index.html"},"license":"MIT","author":"Carsten Leue <carsten.leue@de.ibm.com>","sideEffects":false,"main":"bundles/acoustic-content-sdk-component-api.umd.js","module":"esm5/acoustic-content-sdk-component-api.js","typings":"acoustic-content-sdk-component-api.d.ts","dependencies":{"@acoustic-content-sdk/api":"9.0.407"},"peerDependencies":{"rxjs":"^6"},"es2015":"fesm2015/acoustic-content-sdk-component-api.js","esm2015":"esm2015/acoustic-content-sdk-component-api.js","esm5":"esm5/acoustic-content-sdk-component-api.js","fesm2015":"fesm2015/acoustic-content-sdk-component-api.js","fesm5":"fesm5/acoustic-content-sdk-component-api.js","tsdoc":{"tsdocFlavor":"AEDoc"},"publishConfig":{"registry":"https://registry.npmjs.org/","access":"public"}} |
282
README.md
@@ -601,42 +601,2 @@ <a name="_677b16ffb74b80b4c69a456df49fd0a8916ef9a4d0b841ac5e0ca6ebaf88519d"></a> | ||
<a name="_5bdb99c3c8b05089449d0a5a1bee0d60e204a05bb63fd86319aaff8795d5063a"></a> | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
[Home](#_f68be7b26fd989a10729db5615af1f890587faa077ca5b6a3808a8b2ad117ce5) > [@acoustic-content-sdk/component-api](#_bf48e67afc21b2a61cc872d7321d567a2eaac94849d38e62150a4d6f6186e280) > [AbstractComponentResolver](#_70740c710c6c49b9c96beacdfc75493a581c7abfd24c80995b736bf0da7fd6cb) > [resolveComponent](#_5bdb99c3c8b05089449d0a5a1bee0d60e204a05bb63fd86319aaff8795d5063a) | ||
## AbstractComponentResolver.resolveComponent() method | ||
<b>Signature:</b> | ||
```typescript | ||
resolveComponent(aRenderingContext: RenderingContextV2, aLayoutMode?: string): Observable<T>; | ||
``` | ||
## Parameters | ||
| Parameter | Type | Description | | ||
| --- | --- | --- | | ||
| aRenderingContext | <code>RenderingContextV2</code> | | | ||
| aLayoutMode | <code>string</code> | | | ||
<b>Returns:</b> | ||
`Observable<T>` | ||
<a name="_0bfa9f96865266b6ea0b98d324d12d5dd99dbd443fde90511bb8795b86d7a3a6"></a> | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
[Home](#_f68be7b26fd989a10729db5615af1f890587faa077ca5b6a3808a8b2ad117ce5) > [@acoustic-content-sdk/component-api](#_bf48e67afc21b2a61cc872d7321d567a2eaac94849d38e62150a4d6f6186e280) > [AbstractComponentTypeRefResolver](#_44bb4bd67227ba65f468f36d8c14b8063be6e22f98753132c89cd2423d4d62ee) > [getTypeByLayout](#_0bfa9f96865266b6ea0b98d324d12d5dd99dbd443fde90511bb8795b86d7a3a6) | ||
## AbstractComponentTypeRefResolver.getTypeByLayout property | ||
Returns the type object based on the layout configuration | ||
<b>Signature:</b> | ||
```typescript | ||
getTypeByLayout: (aLayout: Layout, aLayoutMode?: string) => Observable<T>; | ||
``` | ||
<a name="_ebb9bf23e84578069ca5ad7a9b35aaefece4f5bc82d5e3547f2a5409c99e580c"></a> | ||
@@ -687,2 +647,27 @@ <!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
<a name="_5bdb99c3c8b05089449d0a5a1bee0d60e204a05bb63fd86319aaff8795d5063a"></a> | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
[Home](#_f68be7b26fd989a10729db5615af1f890587faa077ca5b6a3808a8b2ad117ce5) > [@acoustic-content-sdk/component-api](#_bf48e67afc21b2a61cc872d7321d567a2eaac94849d38e62150a4d6f6186e280) > [AbstractComponentResolver](#_70740c710c6c49b9c96beacdfc75493a581c7abfd24c80995b736bf0da7fd6cb) > [resolveComponent](#_5bdb99c3c8b05089449d0a5a1bee0d60e204a05bb63fd86319aaff8795d5063a) | ||
## AbstractComponentResolver.resolveComponent() method | ||
<b>Signature:</b> | ||
```typescript | ||
resolveComponent(aRenderingContext: RenderingContextV2, aLayoutMode?: string): Observable<T>; | ||
``` | ||
## Parameters | ||
| Parameter | Type | Description | | ||
| --- | --- | --- | | ||
| aRenderingContext | <code>RenderingContextV2</code> | | | ||
| aLayoutMode | <code>string</code> | | | ||
<b>Returns:</b> | ||
`Observable<T>` | ||
<a name="_5735f8546b48ba6360481fa6f3cf05567d9352e3142f145202de6fce0f65d161"></a> | ||
@@ -733,2 +718,17 @@ <!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
<a name="_0bfa9f96865266b6ea0b98d324d12d5dd99dbd443fde90511bb8795b86d7a3a6"></a> | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
[Home](#_f68be7b26fd989a10729db5615af1f890587faa077ca5b6a3808a8b2ad117ce5) > [@acoustic-content-sdk/component-api](#_bf48e67afc21b2a61cc872d7321d567a2eaac94849d38e62150a4d6f6186e280) > [AbstractComponentTypeRefResolver](#_44bb4bd67227ba65f468f36d8c14b8063be6e22f98753132c89cd2423d4d62ee) > [getTypeByLayout](#_0bfa9f96865266b6ea0b98d324d12d5dd99dbd443fde90511bb8795b86d7a3a6) | ||
## AbstractComponentTypeRefResolver.getTypeByLayout property | ||
Returns the type object based on the layout configuration | ||
<b>Signature:</b> | ||
```typescript | ||
getTypeByLayout: (aLayout: Layout, aLayoutMode?: string) => Observable<T>; | ||
``` | ||
<a name="_81904b39d3d898bd8e7df7e67f5af2e5fe29a3ae4fda28b9e759cd6ceeff71ca"></a> | ||
@@ -762,2 +762,30 @@ <!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
<a name="_7106e4ca1eacf0d1784e2a20b2ecc37048638a9b4cbfa1cd5232fbf6506503b4"></a> | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
[Home](#_f68be7b26fd989a10729db5615af1f890587faa077ca5b6a3808a8b2ad117ce5) > [@acoustic-content-sdk/component-api](#_bf48e67afc21b2a61cc872d7321d567a2eaac94849d38e62150a4d6f6186e280) > [DeliveryLayoutResolver](#_37e25e72d836d7dffea179136e94833ad266f0c63b27f5d0a3b4d2377fde9287) > [getDeliveryLayout](#_7106e4ca1eacf0d1784e2a20b2ecc37048638a9b4cbfa1cd5232fbf6506503b4) | ||
## DeliveryLayoutResolver.getDeliveryLayout() method | ||
Resolves a layout record | ||
<b>Signature:</b> | ||
```typescript | ||
getDeliveryLayout(aLayoutId: string): Observable<DeliveryLayout>; | ||
``` | ||
## Parameters | ||
| Parameter | Type | Description | | ||
| --- | --- | --- | | ||
| aLayoutId | <code>string</code> | the ID of the layout | | ||
<b>Returns:</b> | ||
`Observable<DeliveryLayout>` | ||
an observable of the layout | ||
<a name="_1f5b614658ac29fca2b9e3f83e13a1aeabf4db651c766d85603626ce466625ed"></a> | ||
@@ -791,10 +819,10 @@ <!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
<a name="_7106e4ca1eacf0d1784e2a20b2ecc37048638a9b4cbfa1cd5232fbf6506503b4"></a> | ||
<a name="_57a835e2a39cf31c0261b69de6984eee899c4b935eb1a00759ad1fe2f008c744"></a> | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
[Home](#_f68be7b26fd989a10729db5615af1f890587faa077ca5b6a3808a8b2ad117ce5) > [@acoustic-content-sdk/component-api](#_bf48e67afc21b2a61cc872d7321d567a2eaac94849d38e62150a4d6f6186e280) > [DeliveryLayoutResolver](#_37e25e72d836d7dffea179136e94833ad266f0c63b27f5d0a3b4d2377fde9287) > [getDeliveryLayout](#_7106e4ca1eacf0d1784e2a20b2ecc37048638a9b4cbfa1cd5232fbf6506503b4) | ||
[Home](#_f68be7b26fd989a10729db5615af1f890587faa077ca5b6a3808a8b2ad117ce5) > [@acoustic-content-sdk/component-api](#_bf48e67afc21b2a61cc872d7321d567a2eaac94849d38e62150a4d6f6186e280) > [DeliverySearchResolver](#_86a2197b5f45d56274c3f5927df08993a9dc9e2d7df193730850a50846ffbd01) > [getDeliverySearchResults](#_57a835e2a39cf31c0261b69de6984eee899c4b935eb1a00759ad1fe2f008c744) | ||
## DeliveryLayoutResolver.getDeliveryLayout() method | ||
## DeliverySearchResolver.getDeliverySearchResults() method | ||
Resolves a layout record | ||
Execute the search. The implementation will add the classification to the `fq` part of the query, automatically, so there is no need to contain it in the query. | ||
@@ -804,3 +832,3 @@ <b>Signature:</b> | ||
```typescript | ||
getDeliveryLayout(aLayoutId: string): Observable<DeliveryLayout>; | ||
getDeliverySearchResults<T>(aQuery: QueryInput, aClassification: string): Observable<SearchResults<T>>; | ||
``` | ||
@@ -812,9 +840,10 @@ | ||
| --- | --- | --- | | ||
| aLayoutId | <code>string</code> | the ID of the layout | | ||
| aQuery | <code>QueryInput</code> | the query input | | ||
| aClassification | <code>string</code> | the classification | | ||
<b>Returns:</b> | ||
`Observable<DeliveryLayout>` | ||
`Observable<SearchResults<T>>` | ||
an observable of the layout | ||
the search result | ||
@@ -850,10 +879,10 @@ | ||
<a name="_57a835e2a39cf31c0261b69de6984eee899c4b935eb1a00759ad1fe2f008c744"></a> | ||
<a name="_e322f8ea6cd200657de20b0d22cf1f33e9842efeb3378b44ad6cb727ef91700a"></a> | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
[Home](#_f68be7b26fd989a10729db5615af1f890587faa077ca5b6a3808a8b2ad117ce5) > [@acoustic-content-sdk/component-api](#_bf48e67afc21b2a61cc872d7321d567a2eaac94849d38e62150a4d6f6186e280) > [DeliverySearchResolver](#_86a2197b5f45d56274c3f5927df08993a9dc9e2d7df193730850a50846ffbd01) > [getDeliverySearchResults](#_57a835e2a39cf31c0261b69de6984eee899c4b935eb1a00759ad1fe2f008c744) | ||
[Home](#_f68be7b26fd989a10729db5615af1f890587faa077ca5b6a3808a8b2ad117ce5) > [@acoustic-content-sdk/component-api](#_bf48e67afc21b2a61cc872d7321d567a2eaac94849d38e62150a4d6f6186e280) > [DeliveryTypeResolver](#_196c18625f2fc00461398a477674b48123c97233cb74b4ccb41cb1754fc20945) > [getDeliveryType](#_e322f8ea6cd200657de20b0d22cf1f33e9842efeb3378b44ad6cb727ef91700a) | ||
## DeliverySearchResolver.getDeliverySearchResults() method | ||
## DeliveryTypeResolver.getDeliveryType() method | ||
Execute the search. The implementation will add the classification to the `fq` part of the query, automatically, so there is no need to contain it in the query. | ||
Resolves a rendering context given the ID of the item | ||
@@ -863,3 +892,3 @@ <b>Signature:</b> | ||
```typescript | ||
getDeliverySearchResults<T>(aQuery: QueryInput, aClassification: string): Observable<SearchResults<T>>; | ||
getDeliveryType(aID: string): Observable<DeliveryType>; | ||
``` | ||
@@ -871,10 +900,9 @@ | ||
| --- | --- | --- | | ||
| aQuery | <code>QueryInput</code> | the query input | | ||
| aClassification | <code>string</code> | the classification | | ||
| aID | <code>string</code> | the ID of the item | | ||
<b>Returns:</b> | ||
`Observable<SearchResults<T>>` | ||
`Observable<DeliveryType>` | ||
the search result | ||
an observable of the context | ||
@@ -903,10 +931,10 @@ | ||
<a name="_c32f2bdd281a12f581a5128e9c04f272880b77595f6377e9ad81d19bd56e9f40"></a> | ||
<a name="_09806bdefb43431b63872c7dec1ecade6214056ba22835b4639c866d9587da98"></a> | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
[Home](#_f68be7b26fd989a10729db5615af1f890587faa077ca5b6a3808a8b2ad117ce5) > [@acoustic-content-sdk/component-api](#_bf48e67afc21b2a61cc872d7321d567a2eaac94849d38e62150a4d6f6186e280) > [HandlebarsResolver](#_35470f724d580d24b38304601b0a25d58715d599b92afc9308ac90e1cfeffa48) > [getHandlebarsProcessor](#_c32f2bdd281a12f581a5128e9c04f272880b77595f6377e9ad81d19bd56e9f40) | ||
[Home](#_f68be7b26fd989a10729db5615af1f890587faa077ca5b6a3808a8b2ad117ce5) > [@acoustic-content-sdk/component-api](#_bf48e67afc21b2a61cc872d7321d567a2eaac94849d38e62150a4d6f6186e280) > [LayoutMappingResolver](#_ee3cf61045259888a7d516792ceaf7545452c1e2fafebce3d96f976d57db0617) > [getSelector](#_09806bdefb43431b63872c7dec1ecade6214056ba22835b4639c866d9587da98) | ||
## HandlebarsResolver.getHandlebarsProcessor() method | ||
## LayoutMappingResolver.getSelector property | ||
Resolves the template ID to a processor | ||
Returns the layout selector based on the rendering context | ||
@@ -916,18 +944,5 @@ <b>Signature:</b> | ||
```typescript | ||
getHandlebarsProcessor(aId: string): Observable<HandlebarsProcessor>; | ||
getSelector: (aLayoutMode: string, aRenderingContext: RenderingContextV2) => string | undefined; | ||
``` | ||
## Parameters | ||
| Parameter | Type | Description | | ||
| --- | --- | --- | | ||
| aId | <code>string</code> | the ID of the template | | ||
<b>Returns:</b> | ||
`Observable<HandlebarsProcessor>` | ||
an observable of the processor | ||
<a name="_58018a5e09a34f27b492784ad94b0545e33a703967c36f84941e15e96569ed40"></a> | ||
@@ -993,10 +1008,10 @@ <!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
<a name="_e322f8ea6cd200657de20b0d22cf1f33e9842efeb3378b44ad6cb727ef91700a"></a> | ||
<a name="_c32f2bdd281a12f581a5128e9c04f272880b77595f6377e9ad81d19bd56e9f40"></a> | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
[Home](#_f68be7b26fd989a10729db5615af1f890587faa077ca5b6a3808a8b2ad117ce5) > [@acoustic-content-sdk/component-api](#_bf48e67afc21b2a61cc872d7321d567a2eaac94849d38e62150a4d6f6186e280) > [DeliveryTypeResolver](#_196c18625f2fc00461398a477674b48123c97233cb74b4ccb41cb1754fc20945) > [getDeliveryType](#_e322f8ea6cd200657de20b0d22cf1f33e9842efeb3378b44ad6cb727ef91700a) | ||
[Home](#_f68be7b26fd989a10729db5615af1f890587faa077ca5b6a3808a8b2ad117ce5) > [@acoustic-content-sdk/component-api](#_bf48e67afc21b2a61cc872d7321d567a2eaac94849d38e62150a4d6f6186e280) > [HandlebarsResolver](#_35470f724d580d24b38304601b0a25d58715d599b92afc9308ac90e1cfeffa48) > [getHandlebarsProcessor](#_c32f2bdd281a12f581a5128e9c04f272880b77595f6377e9ad81d19bd56e9f40) | ||
## DeliveryTypeResolver.getDeliveryType() method | ||
## HandlebarsResolver.getHandlebarsProcessor() method | ||
Resolves a rendering context given the ID of the item | ||
Resolves the template ID to a processor | ||
@@ -1006,3 +1021,3 @@ <b>Signature:</b> | ||
```typescript | ||
getDeliveryType(aID: string): Observable<DeliveryType>; | ||
getHandlebarsProcessor(aId: string): Observable<HandlebarsProcessor>; | ||
``` | ||
@@ -1014,26 +1029,11 @@ | ||
| --- | --- | --- | | ||
| aID | <code>string</code> | the ID of the item | | ||
| aId | <code>string</code> | the ID of the template | | ||
<b>Returns:</b> | ||
`Observable<DeliveryType>` | ||
`Observable<HandlebarsProcessor>` | ||
an observable of the context | ||
an observable of the processor | ||
<a name="_09806bdefb43431b63872c7dec1ecade6214056ba22835b4639c866d9587da98"></a> | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
[Home](#_f68be7b26fd989a10729db5615af1f890587faa077ca5b6a3808a8b2ad117ce5) > [@acoustic-content-sdk/component-api](#_bf48e67afc21b2a61cc872d7321d567a2eaac94849d38e62150a4d6f6186e280) > [LayoutMappingResolver](#_ee3cf61045259888a7d516792ceaf7545452c1e2fafebce3d96f976d57db0617) > [getSelector](#_09806bdefb43431b63872c7dec1ecade6214056ba22835b4639c866d9587da98) | ||
## LayoutMappingResolver.getSelector property | ||
Returns the layout selector based on the rendering context | ||
<b>Signature:</b> | ||
```typescript | ||
getSelector: (aLayoutMode: string, aRenderingContext: RenderingContextV2) => string | undefined; | ||
``` | ||
<a name="_ab2d3b5104f03cb600b7892d2f332e62cb556693d2ed1c7d600cf33921be55ae"></a> | ||
@@ -1069,2 +1069,32 @@ <!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
<a name="_3607bf57592aa64c2d91e5f13bbe1d43a6c84e559f843107a99edddbcc5b8083"></a> | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
[Home](#_f68be7b26fd989a10729db5615af1f890587faa077ca5b6a3808a8b2ad117ce5) > [@acoustic-content-sdk/component-api](#_bf48e67afc21b2a61cc872d7321d567a2eaac94849d38e62150a4d6f6186e280) > [ReconciledDeliverySearchInput](#_1a6e66b3bab2c7b296d1638238d31106791c9c3ee0552d393d8551ad45b1b2d8) > [predicate](#_3607bf57592aa64c2d91e5f13bbe1d43a6c84e559f843107a99edddbcc5b8083) | ||
## ReconciledDeliverySearchInput.predicate property | ||
Matcher function that tests if a particular value matches the search query | ||
<b>Signature:</b> | ||
```typescript | ||
predicate: UnaryFunction<T, boolean>; | ||
``` | ||
<a name="_9d200b0fa5742520e12c2715b286a711ebc651deadffef264b738b204a97ae99"></a> | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
[Home](#_f68be7b26fd989a10729db5615af1f890587faa077ca5b6a3808a8b2ad117ce5) > [@acoustic-content-sdk/component-api](#_bf48e67afc21b2a61cc872d7321d567a2eaac94849d38e62150a4d6f6186e280) > [ReconciledDeliverySearchInput](#_1a6e66b3bab2c7b296d1638238d31106791c9c3ee0552d393d8551ad45b1b2d8) > [query](#_9d200b0fa5742520e12c2715b286a711ebc651deadffef264b738b204a97ae99) | ||
## ReconciledDeliverySearchInput.query property | ||
The search query object used to execute a query equivalent to the matcher | ||
<b>Signature:</b> | ||
```typescript | ||
query: QueryInput; | ||
``` | ||
<a name="_4da6fe2546e37a77bf44ea068dac6a8166dcc6f9666a6a51b4761f1cffdcd243"></a> | ||
@@ -1244,10 +1274,10 @@ <!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
<a name="_3607bf57592aa64c2d91e5f13bbe1d43a6c84e559f843107a99edddbcc5b8083"></a> | ||
<a name="_05ddddc112dc407d8a58e79421b4eeda711aefd5eeac57d0051bf53dee41d55f"></a> | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
[Home](#_f68be7b26fd989a10729db5615af1f890587faa077ca5b6a3808a8b2ad117ce5) > [@acoustic-content-sdk/component-api](#_bf48e67afc21b2a61cc872d7321d567a2eaac94849d38e62150a4d6f6186e280) > [ReconciledDeliverySearchInput](#_1a6e66b3bab2c7b296d1638238d31106791c9c3ee0552d393d8551ad45b1b2d8) > [predicate](#_3607bf57592aa64c2d91e5f13bbe1d43a6c84e559f843107a99edddbcc5b8083) | ||
[Home](#_f68be7b26fd989a10729db5615af1f890587faa077ca5b6a3808a8b2ad117ce5) > [@acoustic-content-sdk/component-api](#_bf48e67afc21b2a61cc872d7321d567a2eaac94849d38e62150a4d6f6186e280) > [SeedResolver](#_a4982205a8f59b9c67b4e902c1d1886504a61ca99039720d504db1d277c4e435) > [getSeed](#_05ddddc112dc407d8a58e79421b4eeda711aefd5eeac57d0051bf53dee41d55f) | ||
## ReconciledDeliverySearchInput.predicate property | ||
## SeedResolver.getSeed() method | ||
Matcher function that tests if a particular value matches the search query | ||
Resolves a rendering context given the ID of the item | ||
@@ -1257,19 +1287,18 @@ <b>Signature:</b> | ||
```typescript | ||
predicate: UnaryFunction<T, boolean>; | ||
getSeed(aID: string, aClassification: string): Observable<string>; | ||
``` | ||
<a name="_9d200b0fa5742520e12c2715b286a711ebc651deadffef264b738b204a97ae99"></a> | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
## Parameters | ||
[Home](#_f68be7b26fd989a10729db5615af1f890587faa077ca5b6a3808a8b2ad117ce5) > [@acoustic-content-sdk/component-api](#_bf48e67afc21b2a61cc872d7321d567a2eaac94849d38e62150a4d6f6186e280) > [ReconciledDeliverySearchInput](#_1a6e66b3bab2c7b296d1638238d31106791c9c3ee0552d393d8551ad45b1b2d8) > [query](#_9d200b0fa5742520e12c2715b286a711ebc651deadffef264b738b204a97ae99) | ||
| Parameter | Type | Description | | ||
| --- | --- | --- | | ||
| aID | <code>string</code> | the ID of the item | | ||
| aClassification | <code>string</code> | classification of the item | | ||
## ReconciledDeliverySearchInput.query property | ||
<b>Returns:</b> | ||
The search query object used to execute a query equivalent to the matcher | ||
`Observable<string>` | ||
<b>Signature:</b> | ||
an observable of the context | ||
```typescript | ||
query: QueryInput; | ||
``` | ||
@@ -1318,30 +1347,1 @@ <a name="_62fe17c83fe616e6a777320786c65441cab60d700e0b6dc1cc466c9c8e62f1bd"></a> | ||
<a name="_05ddddc112dc407d8a58e79421b4eeda711aefd5eeac57d0051bf53dee41d55f"></a> | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
[Home](#_f68be7b26fd989a10729db5615af1f890587faa077ca5b6a3808a8b2ad117ce5) > [@acoustic-content-sdk/component-api](#_bf48e67afc21b2a61cc872d7321d567a2eaac94849d38e62150a4d6f6186e280) > [SeedResolver](#_a4982205a8f59b9c67b4e902c1d1886504a61ca99039720d504db1d277c4e435) > [getSeed](#_05ddddc112dc407d8a58e79421b4eeda711aefd5eeac57d0051bf53dee41d55f) | ||
## SeedResolver.getSeed() method | ||
Resolves a rendering context given the ID of the item | ||
<b>Signature:</b> | ||
```typescript | ||
getSeed(aID: string, aClassification: string): Observable<string>; | ||
``` | ||
## Parameters | ||
| Parameter | Type | Description | | ||
| --- | --- | --- | | ||
| aID | <code>string</code> | the ID of the item | | ||
| aClassification | <code>string</code> | classification of the item | | ||
<b>Returns:</b> | ||
`Observable<string>` | ||
an observable of the context | ||
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
+ Added
- Removed