checkCapabilityAccess

Function

Check an individual capability access rule

Parameters

Parameter Type Default Notes
rule Required ICapabilityPermission
context Required IArcGISContext
entity Required IHubItemEntity | HubEntity

Returns

Property Type Notes
capability Capability

Capability being checked

responses IPermissionAccessResponse[]

Individual permission check responses. Used for observability

access Inherited boolean

Is the user allowed to perform the action

code Inherited string

Code for the access response. Used for i18n and UX level messages

response Inherited PolicyResponse

Reason for the access response

message Optional Inherited string

Message with details access response. Typically used to return additional information about assertion failures


Function defined in common/src/capabilities/_internal/checkCapabilityAccess.ts:13