requestAssociation

Function

When an entity sends an "outgoing" association request or accepts an "incoming" association request, half of the association "connection" is made.

from the parent's perspective: the parent "includes" the child in its association group

From the child's perspective: the child "references" the parent via a typeKeyword of the form ref||

Note: we export this function under 2 names - requestAssociation and acceptAssociation. These actions are functionally equivalent, but we want to make the intent more clear to the consumer.

When an entity sends an "outgoing" association request or accepts an "incoming" association request, half of the association "connection" is made.

from the parent's perspective: the parent "includes" the child in its association group

From the child's perspective: the child "references" the parent via a typeKeyword of the form ref||

Note: we export this function under 2 names - requestAssociation and acceptAssociation. These actions are functionally equivalent, but we want to make the intent more clear to the consumer.

requestAssociation(entity: HubEntity, associationType: HubEntityType, id: string, context: IArcGISContext) : Promise<void>

Parameters

Parameter	Type	Notes
entity Required	HubEntity	entity requesting association
associationType Required	HubEntityType
id Required	string	id of the entity the requesting entity wants to associate with
context Required	IArcGISContext	contextual portal and auth information

Returns

Promise<void>

Function defined in common/src/associations/requestAssociation.ts:32