You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/useCases.md
+28Lines changed: 28 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -14,6 +14,7 @@ The different use cases currently available in the package are classified below,
14
14
-[Get Collection Facets](#get-collection-facets)
15
15
-[Get User Permissions on a Collection](#get-user-permissions-on-a-collection)
16
16
-[List All Collection Items](#list-all-collection-items)
17
+
-[Get Collection Featured Items](#get-collection-featured-items)
17
18
-[Collections write use cases](#collections-write-use-cases)
18
19
-[Create a Collection](#create-a-collection)
19
20
-[Update a Collection](#update-a-collection)
@@ -202,6 +203,33 @@ This use case supports the following optional parameters depending on the search
202
203
-**offset**: (number) Offset for pagination.
203
204
-**collectionSearchCriteria**: ([CollectionSearchCriteria](../src/collections/domain/models/CollectionSearchCriteria.ts)) Supports filtering the collection items by different properties.
204
205
206
+
#### Get Collection Featured Items
207
+
208
+
Returns a [CollectionFeaturedItem](../src/collections/domain/models/CollectionFeaturedItem.ts) array containing the featured items of the requested collection, given the collection identifier or alias.
The `collectionIdOrAlias` is a generic collection identifier, which can be either a string (for queries by CollectionAlias), or a number (for queries by CollectionId).
230
+
231
+
If no collection identifier is specified, the default collection identifier; `:root` will be used. If you want to search for a different collection, you must add the collection identifier as a parameter in the use case call.
Copy file name to clipboardExpand all lines: src/collections/domain/useCases/GetCollectionFeaturedItems.ts
+1-1Lines changed: 1 addition & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -15,7 +15,7 @@ export class GetCollectionFeaturedItems implements UseCase<CollectionFeaturedIte
15
15
*
16
16
* @param {number | string} [collectionIdOrAlias = ':root'] - A generic collection identifier, which can be either a string (for queries by CollectionAlias), or a number (for queries by CollectionId)
17
17
* If this parameter is not set, the default value is: ':root'
0 commit comments