HubTemplate

Class

Hub Template Class - this class encapsulates the standard operations for a "Solution" item despite the Hub team not "owning" this item type. Our primary goal is to allow editing of the item's meta information, manage sharing, etc.

Implements

Extends

HubItemEntity

Constructors

new HubTemplate(entity: IHubTemplate, context: IArcGISContext) : HubTemplate

Constructor Parameters

Parameter	Type	Default	Notes
entity Required	IHubTemplate
context Required	IArcGISContext

Properties

Property	Type	Notes
context Protected Inherited	IArcGISContext
entity Protected Inherited	IHubTemplate
isDestroyed Protected Inherited	false
thumbnailCache Protected Inherited	null

Accessors

Accessor	Type	Notes
canDelete Inherited	boolean	Can the current user delete the Entity? In order to delete an item, the user must be the owner of the item or a full org_admin in the owner's organization.
canEdit Inherited	boolean	Can the current user edit the Entity? In order to edit an item, the user must be the owner of the item or be a member of a shared editing group, to which the item is shared.
id Inherited	string	Return the entity id
orgId Inherited	string	The orgId of the Entity, if available
owner Inherited	string	Return the entity owner

Methods

Method	Returns	Notes
create(partialTemplate: Partial<IHubTemplate>, context: IArcGISContext, save: boolean)	Promise<HubTemplate>	Create a new HubTemplate, returning a HubTemplate instance. This does not automatically persist the Template into the backing store unless save is set to true NOTE: we have no immediate plans to allow template creation from the context of the Hub application, but scaffolding this method for potential future implementation. The underlying createTemplate function will throw an error if attempted.
fetch(identifier: string, context: IArcGISContext)	Promise<HubTemplate>	Fetch a HubTemplate from the backing store and return a HubTemplate instance
fromJson(json: Partial<IHubTemplate>, context: IArcGISContext)	HubTemplate	Create an HubTemplate instance from an IHubTemplate object
delete()	Promise<void>	Delete the Hub Template's backing item and set a flag indicating it's been destroyed
fromEditor(editor: IHubTemplateEditor)	Promise<IHubTemplate>	Transform editor values into a template entity
getEditorConfig(i18nScope: string, type: TemplateEditorType)	Promise<IEditorConfig>
save()	Promise<void>	Save the HubTemplate to the backing store
toEditor(editorContext: IEntityEditorContext, include: string[])	Promise<IHubTemplateEditor>	Transform template entity into an editor object
update(changes: Partial<IHubTemplate>)	void	Update the instance's internal entity state
addPermissionPolicy(policy: IEntityPermissionPolicy)	void	Add a policy to the entity
afterSave()	Promise<void>	Hook that subclasses should call to invoke shared post-save behavior
checkPermission(permission: Permission)	IPermissionAccessResponse	Check if current user has a specific permission, accounting for both system and entity level policies
clearFeaturedImage()	Promise<void>	Remove the featured image from the item
clearThumbnail()	void	Clear the thumbnail from the item, if one exists. Persisted on next `.save()` call
getFollowersGroup()	Promise<IGroup>	Returns the followers group
getPermissionPolicies(permission: Permission)	IEntityPermissionPolicy[]	Get all policies related to a specific permission
getThumbnailUrl(width: number)	string	Return the full url to the thumbnail, optionally with a width parameter
removePermissionPolicy(permission: Permission, id: string)	void	Remove a policy from the entity
setAccess(access: SettableAccessLevel)	Promise<void>	Set the access level of the backing item
setFeaturedImage(file: any, clearExisting: boolean)	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
setFollowersGroupAccess(access: SettableAccessLevel)	Promise<void>	Sets the access level of the followers group
setFollowersGroupIsDiscussable(isDiscussable: boolean)	Promise<void>	Sets whether or not the followers group is discussable
setThumbnail(file: any, filename: string)	void	Store thumbnail information to be sent with the next `.save()` call
shareWithGroup(groupId: string)	Promise<void>	Share the Entity with the specified group id
shareWithGroups(groupIds: string[])	Promise<void>	Share the Entity with the specified group ids
sharedWith()	Promise<IGroup[]>	Return a list of groups the Entity is shared to.
toJson()	IHubTemplate	Return the backing entity as an object literal
unshareWithGroup(groupId: string)	Promise<void>	Unshare the Entity with the specified group id
unshareWithGroups(groupIds: string[])	Promise<void>	Unshare the Entity with the specified group ids
updateIsDiscussable(isDiscussable: boolean)	void	Updates the isDiscussable property

create

Static Static Class Method

Create a new HubTemplate, returning a HubTemplate instance. This does not automatically persist the Template into the backing store unless save is set to true

create(partialTemplate: Partial<IHubTemplate>, context: IArcGISContext, save: boolean) : Promise<HubTemplate>

Parameters

Parameter	Type	Default
partialTemplate Required	Partial<IHubTemplate>
context Required	IArcGISContext
save Optional	boolean	false

Returns

Promise<HubTemplate>

NOTE: we have no immediate plans to allow template creation from the context of the Hub application, but scaffolding this method for potential future implementation. The underlying createTemplate function will throw an error if attempted.

fetch

Static Static Class Method

Fetch a HubTemplate from the backing store and return a HubTemplate instance

fetch(identifier: string, context: IArcGISContext) : Promise<HubTemplate>

Parameters

Parameter	Type	Default	Notes
identifier Required	string
context Required	IArcGISContext

Returns

Promise<HubTemplate>

fromJson

Static Static Class Method

Create an HubTemplate instance from an IHubTemplate object

fromJson(json: Partial<IHubTemplate>, context: IArcGISContext) : HubTemplate

Parameters

Parameter	Type	Default	Notes
json Required	Partial<IHubTemplate>		JSON object to create a HubTemplate from
context Required	IArcGISContext		ArcGIS context

Returns

HubTemplate

delete

Class Method

Delete the Hub Template's backing item and set a flag indicating it's been destroyed

delete() : Promise<void>

Returns

Promise<void>

fromEditor

Class Method

Transform editor values into a template entity

fromEditor(editor: IHubTemplateEditor) : Promise<IHubTemplate>

Parameters

Parameter	Type	Default	Notes
editor Required	IHubTemplateEditor

Returns

Promise<IHubTemplate>

getEditorConfig

Class Method

getEditorConfig(i18nScope: string, type: TemplateEditorType) : Promise<IEditorConfig>

Parameters

Parameter	Type	Default	Notes
i18nScope Required	string
type Required	TemplateEditorType

Returns

Promise<IEditorConfig>

save

Class Method

Save the HubTemplate to the backing store

save() : Promise<void>

Returns

Promise<void>

toEditor

Class Method

Transform template entity into an editor object

toEditor(editorContext: IEntityEditorContext, include: string[]) : Promise<IHubTemplateEditor>

Parameters

Parameter	Type	Default	Notes
editorContext Optional	IEntityEditorContext	{}
include Optional	string[]	[]

Returns

Promise<IHubTemplateEditor>

update

Class Method

Update the instance's internal entity state

update(changes: Partial<IHubTemplate>) : void

Parameters

Parameter	Type	Default	Notes
changes Required	Partial<IHubTemplate>

Returns

void

addPermissionPolicy

Class Method

Add a policy to the entity

addPermissionPolicy(policy: IEntityPermissionPolicy) : void

Parameters

Parameter	Type	Default	Notes
policy Required	IEntityPermissionPolicy

Returns

void

afterSave

Class Method

Hook that subclasses should call to invoke shared post-save behavior

afterSave() : Promise<void>

Returns

Promise<void>

checkPermission

Class Method

Check if current user has a specific permission, accounting for both system and entity level policies

checkPermission(permission: Permission) : IPermissionAccessResponse

Parameters

Parameter	Type	Default	Notes
permission Required	Permission

Returns

IPermissionAccessResponse

clearFeaturedImage

Class Method

Remove the featured image from the item

clearFeaturedImage() : Promise<void>

Returns

Promise<void>

clearThumbnail

Class Method

Clear the thumbnail from the item, if one exists. Persisted on next .save() call

clearThumbnail() : void

Returns

void

getFollowersGroup

Class Method

Returns the followers group

getFollowersGroup() : Promise<IGroup>

Returns

Promise<IGroup>

getPermissionPolicies

Class Method

Get all policies related to a specific permission

getPermissionPolicies(permission: Permission) : IEntityPermissionPolicy[]

Parameters

Parameter	Type	Default	Notes
permission Required	Permission

Returns

IEntityPermissionPolicy[]

getThumbnailUrl

Class Method

Return the full url to the thumbnail, optionally with a width parameter

getThumbnailUrl(width: number) : string

Parameters

Parameter	Type	Default	Notes
width Optional	number	200

Returns

string

removePermissionPolicy

Class Method

Remove a policy from the entity

removePermissionPolicy(permission: Permission, id: string) : void

Parameters

Parameter	Type	Default	Notes
permission Required	Permission
id Required	string

Returns

void

setAccess

Class Method

Set the access level of the backing item

setAccess(access: SettableAccessLevel) : Promise<void>

Parameters

Parameter	Type	Default	Notes
access Required	SettableAccessLevel

Returns

Promise<void>

setFeaturedImage

Class Method

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

setFeaturedImage(file: any, clearExisting: boolean) : Promise<void>

Parameters

Parameter	Type	Default	Notes
file Required	any
clearExisting Optional	boolean	false

Returns

Promise<void>

setFollowersGroupAccess

Class Method

Sets the access level of the followers group

setFollowersGroupAccess(access: SettableAccessLevel) : Promise<void>

Parameters

Parameter	Type	Default	Notes
access Required	SettableAccessLevel

Returns

Promise<void>

setFollowersGroupIsDiscussable

Class Method

Sets whether or not the followers group is discussable

setFollowersGroupIsDiscussable(isDiscussable: boolean) : Promise<void>

Parameters

Parameter	Type	Default	Notes
isDiscussable Required	boolean

Returns

Promise<void>

setThumbnail

Class Method

Store thumbnail information to be sent with the next .save() call

setThumbnail(file: any, filename: string) : void

Parameters

Parameter	Type	Default	Notes
file Required	any
filename Required	string

Returns

void

shareWithGroup

Class Method

Share the Entity with the specified group id

shareWithGroup(groupId: string) : Promise<void>

Parameters

Parameter	Type	Default	Notes
groupId Required	string

Returns

Promise<void>

shareWithGroups

Class Method

Share the Entity with the specified group ids

shareWithGroups(groupIds: string[]) : Promise<void>

Parameters

Parameter	Type	Default	Notes
groupIds Required	string[]

Returns

Promise<void>

sharedWith

Class Method

Return a list of groups the Entity is shared to.

sharedWith() : Promise<IGroup[]>

Returns

Promise<IGroup[]>

toJson

Class Method

Return the backing entity as an object literal

toJson() : IHubTemplate

Returns

IHubTemplate

unshareWithGroup

Class Method

Unshare the Entity with the specified group id

unshareWithGroup(groupId: string) : Promise<void>

Parameters

Parameter	Type	Default	Notes
groupId Required	string

Returns

Promise<void>

unshareWithGroups

Class Method

Unshare the Entity with the specified group ids

unshareWithGroups(groupIds: string[]) : Promise<void>

Parameters

Parameter	Type	Default	Notes
groupIds Required	string[]

Returns

Promise<void>

updateIsDiscussable

Class Method

Updates the isDiscussable property

updateIsDiscussable(isDiscussable: boolean) : void

Parameters

Parameter	Type	Default	Notes
isDiscussable Required	boolean		whether to enable or disable discussions

Returns

void

Class defined in common/src/templates/HubTemplate.ts:25