IHubInitiative

Interface

DRAFT: Under development and more properties will likely be added

Extends

Properties

Property Type Notes
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

owner Inherited string

Username of the owner of the item

tags Inherited string[]

User configurable tags

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

bannerImage Optional Inherited IHubImage

Banner Image as IHubImage

boundary Optional Inherited IHubGeography

boundary will default to the item extent but can be overwritten by enrichments from the Hub API (inline) or fetched from a location such as /resources/boundary.json

culture Optional Inherited string

Culture code of the content i.e. en-us

description Optional Inherited string

Description for the item

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

thumbnailUrl Optional Inherited string

Thumbnail Uril (read-only)

typeKeywords Optional Inherited string[]

System configurable typekeywords

url Optional Inherited string

Canonical Url for the Entity


Interface defined in common/src/core/types/IHubInitiative.ts:8