@esri/hub.js

@esri/hub.js

getIncludesAndReferencesQuery

Function

builds a query that will return entities that are "included" AND "referenced"

builds a query that will return entities that are "included" AND "referenced"

getIncludesAndReferencesQuery(entity: HubEntity, associationType: HubEntityType, isParent: boolean, context: IArcGISContext) : Promise<IQuery>

Parameters

Parameter	Type	Default	Notes
entity Required	HubEntity		Hub entity
associationType Required	HubEntityType		entity type to query for
isParent Required	boolean		whether the provided Hub entity is the parent in the association relationship
context Required	IArcGISContext		contextual auth and portal information

Returns

Promise<IQuery>

Property	Type	Notes
filters	IFilter[]	Filters that make up the query
targetEntity	EntityType	What entity is this query targeting. This is used internally to ensure we query the correct API
properties Optional	Record<stringany>	Additional properties. Useful for groupMember queries where we need to send in the groupId to construct the url

Function defined in packages/common/src/associations/internal/getIncludesAndReferencesQuery.ts:25