composeHubContent

Function

composes a Hub content entity from an item and optional enrichments

composes a Hub content entity from an item and optional enrichments

Parameters

Parameter Type Default Notes
item Required IItem

item to compose content from

requestOptions Required IHubRequestOptions

request options (needed to determine certain urls)

enrichments Required IHubEditableContentEnrichments

enrichments to use during composition

Available requestOptions

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

A string indicating whether credentials (cookies) will be sent with the request. Used internally for authentication workflows.

fetch Optional Inherited function(input: RequestInfo, init: RequestInit) : Promise<Response>

The implementation of fetch to use. Defaults to a global fetch.

headers Optional Inherited [key: string]: any

Additional Headers to pass into the request.

hideToken Optional Inherited boolean

Prevents the token from being passed in a URL Query param that is saved in browser history. Instead, the token will be passed in POST request body or through X-Esri-Authorization header. NOTE: This will force POST requests in browsers since auth header is not yet supported by preflight OPTIONS check with CORS.

httpMethod Optional Inherited HTTPMethods

The HTTP method to send the request with.

maxUrlLength Optional Inherited number

If the length of a GET request's URL exceeds maxUrlLength the request will use POST instead.

params Optional Inherited IParams

Additional parameters to pass in the request.

portal Optional Inherited string

Base url for the portal you want to make the request to. Defaults to authentication.portal if authentication exists, otherwise to 'https://www.arcgis.com/sharing/rest'.

rawResponse Optional Inherited boolean

Return the raw response

Returns

content entity

Property Type Notes
licenseInfo string

TODO: add additional props perhaps using Pick from IHubContent

canDelete Inherited boolean

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

canEdit Inherited boolean

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

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

itemControl Inherited string

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

name Inherited string

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

orgUrlKey Inherited string

Organization urlKey used to construct the slug

owner Inherited string

Username of the owner of the item

schemaVersion Inherited number

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

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

additionalResources Optional IHubAdditionalResource[]
extendedProps Optional IExtendedProps

Discriminated union of additional prop hashes, divided by groupings of content item types These additional props are optional enrichments that may be fetched during the fetchHubContent() process. They are not guaranteed to be present.

schedule Optional IHubSchedule

The schedule at which the reharvest of the item will occur

serverExtractCapability Optional boolean
serverExtractFormats Optional string[]
serverQueryCapability Optional boolean
access Optional Inherited AccessLevel

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

associations Optional Inherited {
groupId:
string
rules:
IHubAssociationRules
}
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

canRecycle Optional Inherited boolean

Can this item be recycled? This will be returned by the Portal API once recycling is enabled on the platform Optional because it can default to false if not returned by the API

categories Optional Inherited string[]

Parsed item categories (see parseItemCategories)

culture Optional Inherited string

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

description Optional Inherited string

Description for the item

discussionSettings Optional Inherited IDiscussionsSettings

The entity's discussion settings

entitySettingsId Optional Inherited string
extent Optional Inherited number[][]

Extent of the Entity

features Optional Inherited IFeatureFlags

We need a means to enable / disable the "feature/capability" represented by a permission for an entity. e.g. we want to disable events for a site, so we have hub:site:events: false

followersGroupId Optional Inherited string

followers group id

isDiscussable Optional Inherited boolean

If the item has discussions enabled

location Optional Inherited IHubLocation

The location of the Entity

orgId Optional Inherited string

The orgId of the Entity, if available

permissions Optional Inherited IEntityPermissionPolicy[]

Array of permission policies that apply to the entity Only permissions with `entity

protected Optional Inherited boolean

Is the item protected?

slug Optional Inherited string

Slug that can be used to lookup an entity by something other than it's id

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

thumbnail Optional Inherited string

Thumbnail (read-only)

thumbnailUrl Optional Inherited string

TODO: Deprecate this in favor of IHubEntityBase.links.thumbnail Thumbnail Url (read-only)

typeKeywords Optional Inherited string[]

System configurable typekeywords

url Optional Inherited string

TODO: change this property to store item.url. Store the canonical url in IHubEntityBase.links.self instead.

view Optional Inherited IWithViewSettings

Project display properties


Function defined in common/src/content/composeHubContent.ts:17