getWellknownCollection

Function

Get a single collection based on the collection name and entity type

getWellknownCollection(i18nScope: string, entityType: EntityType, collectionName: WellKnownCollection) : IHubCollection

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

IHubCollection

Property	Type	Notes
key	string	Unique key, used for query params and telemetry
label	string	String to show in the UI. translated.
scope	IQuery	Default query for the Collection
targetEntity	EntityType	What entity is this query targeting. This is used internally to ensure we query the correct API
displayConfig Optional	IGalleryDisplayConfig	Optional display configuration to control a collection's appearance in the UI
include Optional	string[]	Specify the includes to be requested when working with this collection
sortDirection Optional	"asc" \| "desc"	Default sort direction for the Collection
sortField Optional	string	Default sort field for the Collection

Function defined in common/src/search/wellKnownCatalog.ts:779