fetchEntityCatalog

Function

Fetch a Catalog for an entity. This function fetches the entity and returns the .catalog property However, other properties can be fetched by passing the name of the property in the prop option. Additionally, passing the hubEntityType option provide a performance boost by skipping the fetch of the backing Item, then fetching the entity.

fetchEntityCatalog(identifier: string, context: IArcGISContext, options: {
hubEntityType:
string
prop:
string
}) : Promise<IHubCatalog>

Parameters

Parameter	Type	Default	Notes
identifier Required	string
context Required	IArcGISContext
options Optional	{ hubEntityType: string prop: string }

Returns

Promise<IHubCatalog>

Property	Type	Notes
schemaVersion	number	Schema Version
collections Optional	IHubCollection[]	Collections within the Catalog
displayConfig Optional	IGalleryDisplayConfig	Optional display configuration to control a catalog's appearance in the UI
emojii Optional	string	Optional Emoji to show in the UI
integrity Optional	{ collections: string scopes: string }	Hashes to verify the integrity of the catalog Only verified when the catalog is loaded into the editor If the hashes do not match, the catalog will not be loaded and the user will simply have the option to reset the catalog
scopes Optional	ICatalogScope	Filter defines the "scopes" of the Catalog, on a per entity type basis
title Optional	string	Title for the Gallery
type Optional	CatalogType

Function defined in common/src/search/fetchEntityCatalog.ts:27