@esri/hub.js

@esri/hub.js

deepCatalogContains

Function

Check that a specific entity is contained within a hierarchy of catalogs

deepCatalogContains(identifier: string, hubEntityType: HubEntityType, path: string, context: IArcGISContext, rootCatalog: IHubCatalog) : Promise<IContainsResponse>

Parameters

Parameter	Type	Default	Notes
identifier Required	string		id or slug of the entity to check
hubEntityType Required	HubEntityType		Entity type of the identifier
path Required	string		definition of the containment hierarchy /site/00c/projects/cc1 etc
context Required	IArcGISContext
rootCatalog Optional	IHubCatalog		Optional, root level catalog to start checking from (typically the site)

Returns

Promise<IContainsResponse>

Property	Type	Notes
identifier	string
isContained	boolean
catalogInfo Optional	Record<stringICatalogInfo>	Cacheable information about the catalogs
duration Optional	number	How long did it take to check containment?
reason Optional	string	If the entity is not contained, this will be populated with a reason

Function defined in packages/common/src/core/deepCatalogContains.ts:18