HubContent
Implements
- IWithStoreBehavior
- IWithSharingBehavior
- IWithThumbnailBehavior
- IWithFeaturedImageBehavior
- IWithPermissionBehavior
- IWithDiscussionsBehavior
- IWithFollowersBehavior
- IWithStoreBehavior
- IWithEditorBehavior
Extends
Constructors
Constructor Parameters
Parameter | Type | Default | Notes |
---|---|---|---|
entity Required | IHubEditableContent | ||
context Required | IArcGISContext |
Properties
Property | Type | Notes |
---|---|---|
Protected Inherited | IArcGISContext | |
Protected Inherited | IHubEditableContent | |
Protected Inherited | false | |
Protected Inherited | null |
Accessors
Methods
Method | Returns | Notes |
---|---|---|
|
HubContent |
Create an instance from an IHubEditableContent object |
|
Promise<void> |
Delete the HubContent from the store set a flag to indicate that it is destroyed |
|
Promise<IHubEditableContent> |
Load the project from the editor object |
|
Promise<IEditorConfig> | |
|
Promise<void> |
Save the HubContent to the backing store. Currently Projects are stored as Items in Portal |
|
Promise<IHubContentEditor> |
Return the project as an editor object |
|
void |
Apply a new state to the instance |
|
void |
Add a policy to the entity |
|
Promise<void> |
Hook that subclasses should call to invoke shared post-save behavior |
|
IPermissionAccessResponse |
Check if current user has a specific permission, accounting for both system and entity level policies |
|
Promise<void> |
Remove the featured image from the item |
|
void |
Clear the thumbnail from the item, if one exists. Persisted on next |
|
Promise<IGroup> |
Returns the followers group |
|
IEntityPermissionPolicy[] |
Get all policies related to a specific permission |
|
string |
Return the full url to the thumbnail, optionally with a width parameter |
|
void |
Remove a policy from the entity |
|
Promise<void> |
Set the access level of the backing item |
|
Promise<void> |
Set a featured image on the Entity, if one already exists it is cleared out before the new one is set to keep the number of resources in control |
|
Promise<void> |
Sets the access level of the followers group |
|
Promise<void> |
Sets whether or not the followers group is discussable |
|
void |
Store thumbnail information to be sent with the next |
|
Promise<void> |
Share the Entity with the specified group id |
|
Promise<void> |
Share the Entity with the specified group ids |
|
Promise<IGroup[]> |
Return a list of groups the Entity is shared to. |
|
IHubEditableContent |
Return the backing entity as an object literal |
|
Promise<void> |
Unshare the Entity with the specified group id |
|
Promise<void> |
Unshare the Entity with the specified group ids |
|
void |
Updates the isDiscussable property |
fromJson
StaticParameters
Parameter | Type | Default | Notes |
---|---|---|---|
json Required | Partial<IHubEditableContent> |
JSON object to create a HubContent from |
|
context Optional | IArcGISContext |
ArcGIS context |
Returns
delete
Delete the HubContent from the store set a flag to indicate that it is destroyed
Returns
fromEditor
Load the project from the editor object
Parameters
Parameter | Type | Default | Notes |
---|---|---|---|
editor Required | IHubContentEditor |
Returns
getEditorConfig
Parameters
Parameter | Type | Default | Notes |
---|---|---|---|
i18nScope Required | string | ||
type Required | ContentEditorType |
Returns
save
Save the HubContent to the backing store. Currently Projects are stored as Items in Portal
Returns
toEditor
Return the project as an editor object
Parameters
Parameter | Type | Default | Notes |
---|---|---|---|
editorContext Optional | IEntityEditorContext | {} | |
include Optional | string[] | [] |
Returns
update
Apply a new state to the instance
Parameters
Parameter | Type | Default | Notes |
---|---|---|---|
changes Required | Partial<IHubEditableContent> |
Returns
addPermissionPolicy
Add a policy to the entity
Parameters
Parameter | Type | Default | Notes |
---|---|---|---|
policy Required | IEntityPermissionPolicy |
Returns
afterSave
Hook that subclasses should call to invoke shared post-save behavior
Returns
checkPermission
Check if current user has a specific permission, accounting for both system and entity level policies
Parameters
Parameter | Type | Default | Notes |
---|---|---|---|
permission Required | Permission |
Returns
clearThumbnail
Clear the thumbnail from the item, if one exists. Persisted on next .save()
call
Returns
getPermissionPolicies
Get all policies related to a specific permission
Parameters
Parameter | Type | Default | Notes |
---|---|---|---|
permission Required | Permission |
Returns
getThumbnailUrl
Return the full url to the thumbnail, optionally with a width parameter
Parameters
Returns
removePermissionPolicy
Remove a policy from the entity
Parameters
Parameter | Type | Default | Notes |
---|---|---|---|
permission Required | Permission | ||
id Required | string |
Returns
setAccess
Set the access level of the backing item
Parameters
Parameter | Type | Default | Notes |
---|---|---|---|
access Required | SettableAccessLevel |
Returns
setFeaturedImage
Set a featured image on the Entity, if one already exists it is cleared out before the new one is set to keep the number of resources in control
Parameters
Returns
setFollowersGroupAccess
Sets the access level of the followers group
Parameters
Parameter | Type | Default | Notes |
---|---|---|---|
access Required | SettableAccessLevel |
Returns
setFollowersGroupIsDiscussable
Sets whether or not the followers group is discussable
Parameters
Returns
setThumbnail
Store thumbnail information to be sent with the next .save()
call
Parameters
Returns
updateIsDiscussable
Updates the isDiscussable property
Parameters
Parameter | Type | Default | Notes |
---|---|---|---|
isDiscussable Required | boolean |
whether to enable or disable discussions |
Returns
Class defined in common/src/content/HubContent.ts:19
Create an instance from an IHubEditableContent object