Properties exposed by Entities that are backed by Items



Property Type Notes
canDelete boolean

Can current user delete the entity Derived from item.itemControl = "admin"

canEdit boolean

Can current user edit the entity Derived from item.itemControl = "admin" | "update"

itemControl string

Platform derived based on current user's access to the entity if defined, it means the user can edit the entity

owner string

Username of the owner of the item

schemaVersion number

Current schema version. Used to determine what if any schema migrations should be applied when the item is loaded

tags string[]

User configurable tags

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

access Optional AccessLevel

Access level of the item ("private" | "org" | "public")

boundary Optional 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 string

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

description Optional string

Description for the item

extent Optional number[][]

Extent of the Entity

location Optional IHubLocation
orgId Optional string

The orgId of the Entity, if available

thumbnail Optional string

Thumbnail (read-only)

thumbnailUrl Optional string

Thumbnail Uril (read-only)

typeKeywords Optional string[]

System configurable typekeywords

url Optional string

Canonical Url for the Entity

view Optional IWithViewSettings

Project display properties

capabilities Optional Inherited EntityCapabilities
permissions Optional Inherited IEntityPermissionPolicy[]

Array of permission policies that apply to the entity

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

Interface defined in common/src/core/types/IHubItemEntity.ts:10