HubProject

Class

Hub Project Class

Implements

Extends

HubItemEntity

Constructors

new HubProject(entity: IHubProject, context: IArcGISContext) : HubProject

Constructor Parameters

Parameter	Type	Default	Notes
entity Required	IHubProject
context Required	IArcGISContext

Properties

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

Accessors

Accessor	Type	Notes
catalog	Catalog	Catalog instance for this project. Note: Do not hold direct references to this object; always access it from the project.
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(partialProject: Partial<IHubProject>, context: IArcGISContext, save: boolean)	Promise<HubProject>	Create a new HubProject, returning a HubProject instance. Note: This does not persist the Project into the backing store
fetch(identifier: string, context: IArcGISContext)	Promise<HubProject>	Fetch a Project from the backing store and return a HubProject instance.
fromJson(json: Partial<IHubProject>, context: IArcGISContext)	HubProject	Create an instance from an IHubProject object
getEditorConfig(i18nScope: string, type: ProjectEditorType, options: UiSchemaElementOptions[])	Promise<IEditorConfig>	Static method to get the editor config for the HubProject entity.
delete()	Promise<void>	Delete the HubProject from the store set a flag to indicate that it is destroyed
save()	Promise<void>	Save the HubProject to the backing store. Currently Projects are stored as Items in Portal
update(changes: Partial<IHubProject>)	void	Apply a new state to the instance
addPermissionPolicy(policy: IEntityPermissionPolicy)	void	Add a policy to the entity
afterSave()	Promise<void>	Hook that subclasses should call to invoke shared post-save behavior
checkCapability(capability: Capability)	ICapabilityAccessResponse	Check if the current user can access a specific capability
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
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)	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
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
sharedWith()	Promise<IGroup[]>	Return a list of groups the Entity is shared to.
toJson()	IHubProject	Return the backing entity as an object literal
unshareWithGroup(groupId: string)	Promise<void>	Unshare the Entity with the specified group id

create

Static Static Class Method

Create a new HubProject, returning a HubProject instance. Note: This does not persist the Project into the backing store

create(partialProject: Partial<IHubProject>, context: IArcGISContext, save: boolean) : Promise<HubProject>

Parameters

Parameter	Type	Default
partialProject Required	Partial<IHubProject>
context Required	IArcGISContext
save Optional	boolean	false

Returns

Promise<HubProject>

fetch

Static Static Class Method

Fetch a Project from the backing store and return a HubProject instance.

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

Parameters

Parameter	Type	Default	Notes
identifier Required	string		Identifier of the project to load
context Required	IArcGISContext

Returns

Promise<HubProject>

fromJson

Static Static Class Method

Create an instance from an IHubProject object

fromJson(json: Partial<IHubProject>, context: IArcGISContext) : HubProject

Parameters

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

Returns

HubProject

getEditorConfig

Static Static Class Method

Static method to get the editor config for the HubProject entity.

getEditorConfig(i18nScope: string, type: ProjectEditorType, options: UiSchemaElementOptions[]) : Promise<IEditorConfig>

Parameters

Parameter	Type	Default	Notes
i18nScope Required	string		translation scope to be interpolated into the uiSchema
type Required	ProjectEditorType		editor type - corresonds to the returned uiSchema
options Optional	UiSchemaElementOptions[]	[]	optional hash of dynamic uiSchema element options Note: typescript does not have a means to specify static methods in interfaces so while this is the implementation of IWithEditorBehavior, it is not enforced by the compiler.

Parameter

Type

Default

Notes

i18nScope Required

string

translation scope to be interpolated into the uiSchema

type Required

ProjectEditorType

editor type - corresonds to the returned uiSchema

options Optional

UiSchemaElementOptions[]

[]

optional hash of dynamic uiSchema element options

Note: typescript does not have a means to specify static methods in interfaces so while this is the implementation of IWithEditorBehavior, it is not enforced by the compiler.

Returns

Promise<IEditorConfig>

delete

Class Method

Delete the HubProject from the store set a flag to indicate that it is destroyed

delete() : Promise<void>

Returns

Promise<void>

save

Class Method

Save the HubProject to the backing store. Currently Projects are stored as Items in Portal

save() : Promise<void>

Returns

Promise<void>

update

Class Method

Apply a new state to the instance

update(changes: Partial<IHubProject>) : void

Parameters

Parameter	Type	Default	Notes
changes Required	Partial<IHubProject>

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>

checkCapability

Class Method

Check if the current user can access a specific capability

checkCapability(capability: Capability) : ICapabilityAccessResponse

Parameters

Parameter	Type	Default	Notes
capability Required	Capability

Returns

ICapabilityAccessResponse

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>

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) : Promise<void>

Parameters

Parameter	Type	Default	Notes
file Required	any

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>

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() : IHubProject

Returns

IHubProject

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>

Class defined in common/src/projects/HubProject.ts:23