getWellknownCollection
Get a single collection based on the collection name and entity type
Parameters
Parameter | Type | Default | Notes |
---|---|---|---|
i18nScope Required | string | ||
entityType Required | EntityType | ||
collectionName Required | WellKnownCollection | Name of the collection requested |
Returns
An IHubCollection definition JSON object
Property | Type | Notes |
---|---|---|
string | Unique key, used for query params and telemetry | |
string | String to show in the UI. translated. | |
IQuery | Default query for the Collection | |
EntityType | What entity is this query targeting. This is used internally to ensure we query the correct API | |
Optional | IGalleryDisplayConfig | Optional display configuration to control a collection's appearance in the UI |
Optional | string[] | Specify the includes to be requested when working with this collection |
Optional | "asc" | "desc" | Default sort direction for the Collection |
Optional | string | Default sort field for the Collection |
Function defined in common/src/search/wellKnownCatalog.ts:779