enrichContentSearchResult

Function

Enrich a generic search result

Parameters

Parameter Type Default Notes
item Required IItem
include Required string[]
requestOptions Required IHubRequestOptions

Available requestOptions

Property Type Notes
authentication Optional UserSession
hubApiUrl Optional string
isPortal Optional boolean
portalSelf Optional IHubRequestOptionsPortalSelf

Returns

Promise<IHubSearchResult>
Property Type Notes
access AccessLevel

Access level of the backing entity

family HubFamily

Hub Family

createdDate Inherited Date

Date the entity was created

createdDateSource Inherited string

Source of the creation date as a property path e.q item.created

id Inherited string

Id of the entity as a string

name Inherited string

Name of the Entity For Entities backed by items, this is typically the title

type Inherited string

For Item backed results, this will be item.type Otherwise it will be "Group", "User", "Event" etc

updatedDate Inherited Date

Date when the entity was last updated Depending on the entity, this could be derived in many different ways

updatedDateSource Inherited string

Source of the updated date

geometry Optional IHubGeography

Geometry connected to this entity For items, it will default to the extent, but may be derived from a boundary resource or the extent of a layer

owner Optional string

Owner; Applies to Items and Groups

source Optional Inherited string

Source of the entity. Exact logic for this tbd, but the intent is to allow the result to be attributed to something other than "owner"

summary Optional Inherited string

Sanitized summary derived from item.snippet, item.description, group.description, user.description, event.description etc


Function defined in common/src/content/HubContent.ts:22