IHubSite
DRAFT: Under development and more properties will likely be added
Extends
Properties
Property | Type | Notes |
---|---|---|
string |
oAuth Client Id for the Site |
|
Record<stringany> |
Content Views settings |
|
string |
Custom Domain Name |
|
IExtent |
Default extent used when loading maps on the site |
|
string |
Full hostname
Looks like |
|
Record<stringany> |
Feed configurations |
|
string |
Header CSS |
|
string[] |
Legacy capabilities |
|
string[] |
Legacy teams - list of ids |
|
Record<stringany> |
Default map configuration for the site |
|
Array<{
|
Array of minimal page objects |
|
string |
Subdomain of the site
Will be prepended to |
|
Record<stringany> |
Site Telemetry Settings |
|
Record<stringany> |
Site Theme as json |
|
Inherited | boolean |
Can current user delete the entity
Derived from |
Inherited | boolean |
Can current user edit the entity
Derived from |
Inherited | IHubCatalog |
Catalog |
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 Inherited | AccessLevel |
Access level of the item ("private" | "org" | "public") |
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 | 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 | 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 | IHubLayout |
Layout property |
Optional Inherited |
{
|
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 |
Methods
Method | Returns | Notes |
---|---|---|
|
Promise<IVersion> |
Creates a new version of the entity |
|
Promise<{
|
Deletes the specified version of the entity |
|
Promise<IVersion> |
Gets the specified version of the entity |
|
Promise<IVersionMetadata[]> |
Gets all the versions of the entity |
|
Promise<IVersion> |
Updates the specified version of the entity |
|
Promise<IVersionMetadata> |
Updates the specified entity version's metadata |
createVersion
Parameters
Parameter | Type | Default | Notes |
---|---|---|---|
options Optional | ICreateVersionOptions |
Returns
deleteVersion
Deletes the specified version of the entity
Parameters
Returns
- success:
- boolean
updateVersion
Updates the specified version of the entity
Parameters
Parameter | Type | Default | Notes |
---|---|---|---|
version Required | IVersion |
Returns
updateVersionMetadata
Updates the specified entity version's metadata
Parameters
Parameter | Type | Default | Notes |
---|---|---|---|
version Required | IVersionMetadata |
Returns
Index Signatures
Interface defined in common/src/core/types/IHubSite.ts:15
Creates a new version of the entity