updateSite
Update a Hub Site
This checks for and applies domain changes
Parameters
Parameter | Type | Default | Notes |
---|---|---|---|
site Required | IHubSite | ||
requestOptions Required | IHubRequestOptions |
Available requestOptions
Property | Type | Notes |
---|---|---|
Optional | UserSession | |
Optional | string | |
Optional | boolean | |
Optional | IHubRequestOptionsPortalSelf |
Returns
Property | Type | Notes |
---|---|---|
string[] |
Array of capabilities enabled for the site |
|
{
|
Currently not an actual ICatalog |
|
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 |
|
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 | 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 |
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 | 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 | 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 |
Culture code of the content
i.e. |
Optional Inherited | string |
Description for the item |
Optional Inherited | IHubLayout |
Layout property |
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 Uril (read-only) |
Optional Inherited | string[] |
System configurable typekeywords |
Optional Inherited | string |
Canonical Url for the Entity |
Function defined in common/src/sites/HubSites.ts:373