composeHubContent
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 |
---|---|---|
Optional | UserSession | |
Optional | string | |
Optional | boolean | |
Optional | IHubRequestOptionsPortalSelf | |
Optional Inherited | RequestCredentials |
A string indicating whether credentials (cookies) will be sent with the request. Used internally for authentication workflows. |
Optional Inherited | function(input: RequestInfo, init: RequestInit) : Promise<Response> |
The implementation of |
Optional Inherited | [key: string]: any |
Additional Headers to pass into the request. |
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. |
Optional Inherited | HTTPMethods |
The HTTP method to send the request with. |
Optional Inherited | number |
If the length of a GET request's URL exceeds |
Optional Inherited | IParams |
Additional parameters to pass in the request. |
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'. |
Optional Inherited | boolean |
Return the raw response |
Returns
content entity
Property | Type | Notes |
---|---|---|
string |
TODO: add additional props perhaps using Pick from IHubContent |
|
Inherited | boolean |
Can current user delete the entity
Derived from |
Inherited | boolean |
Can current user edit the entity
Derived from |
Inherited | Date |
Date the entity was created |
Inherited | string |
Source of the creation date as a property path
e.q |
Inherited | string |
Id of the entity as a string |
Inherited | string |
Platform derived based on current user's access to the entity if defined, it means the user can edit the entity |
Inherited | string |
Name of the Entity For Entities backed by items, this is typically the title |
Inherited | string |
Organization urlKey used to construct the slug |
Inherited | string |
Username of the owner of the item |
Inherited | number |
Current schema version. Used to determine what if any schema migrations should be applied when the item is loaded |
Inherited | string[] |
User configurable tags |
Inherited | string |
For Item backed results, this will be |
Inherited | Date |
Date when the entity was last updated Depending on the entity, this could be derived in many different ways |
Inherited | string |
Source of the updated date |
Optional | IHubAdditionalResource[] | |
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. |
Optional | IHubSchedule |
The schedule at which the reharvest of the item will occur |
Optional | boolean | |
Optional | string[] | |
Optional | boolean | |
Optional Inherited | AccessLevel |
Access level of the item ("private" | "org" | "public") |
Optional Inherited |
{
|
|
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 |
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 |
Optional Inherited | string[] |
Parsed item categories (see parseItemCategories) |
Optional Inherited | string |
Culture code of the content
i.e. |
Optional Inherited | string |
Description for the item |
Optional Inherited | IDiscussionsSettings |
The entity's discussion settings |
Optional Inherited | string | |
Optional Inherited | number[][] |
Extent of the Entity |
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 |
Optional Inherited | string |
followers group id |
Optional Inherited | boolean |
If the item has discussions enabled |
Optional Inherited | IHubEntityLinks |
Links to related things |
Optional Inherited | IHubLocation |
The location of the Entity |
Optional Inherited | string |
The orgId of the Entity, if available |
Optional Inherited | IEntityPermissionPolicy[] |
Array of permission policies that apply to the entity Only permissions with `entity |
Optional Inherited | boolean |
Is the item protected? |
Optional Inherited | string |
Slug that can be used to lookup an entity by something other than it's id |
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" |
Optional Inherited | string |
Sanitized summary derived from item.snippet, item.description, group.description, user.description, event.description etc |
Optional Inherited | string |
Thumbnail (read-only) |
Optional Inherited | string |
TODO: Deprecate this in favor of IHubEntityBase.links.thumbnail Thumbnail Url (read-only) |
Optional Inherited | string[] |
System configurable typekeywords |
Optional Inherited | string |
TODO: change this property to store item.url. Store the canonical url in IHubEntityBase.links.self instead. |
Optional Inherited | IWithViewSettings |
Project display properties |
Function defined in common/src/content/composeHubContent.ts:17