HubItemEntity

Class

Base class for all Hub Entities backed by items

Implements

Constructors

Constructor Parameters

Parameter Type Default Notes
entity Required IHubItemEntity
context Required IArcGISContext

Properties

Property Type Notes
context Protected IArcGISContext
entity Protected IHubItemEntity
isDestroyed Protected false
thumbnailCache Protected null

Accessors

Accessor Type Notes
id string

Return the entity id

owner string

Return the entity owner

Methods

Method Returns Notes
Promise<void>

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

Promise<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.

Promise<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.

Promise<void>

Remove the featured image from the item

Promise<void>
string

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

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

void

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

Promise<void>

Share the Entity with the specified group id

Promise<IGroup[]>

Return a list of groups the Entity is shared to.

IHubItemEntity

Return the backing entity as an object literal

Promise<void>

Unshare the Entity with the specified group id

void

afterSave

Class Method

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

  • afterSave() : Promise<void>

Returns

Promise<void>

canDelete

Class Method

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.

  • canDelete() : Promise<boolean>

Returns

Promise<boolean>

canEdit

Class Method

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.

  • canEdit() : Promise<boolean>

Returns

Promise<boolean>

clearFeaturedImage

Class Method

Remove the featured image from the item

  • clearFeaturedImage() : Promise<void>

Returns

Promise<void>

delete

Class Method

  • delete() : Promise<void>

Returns

Promise<void>

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

save

Class Method

  • save() : Promise<void>

Returns

Promise<void>

setAccess

Class Method

Set the access level of the backing item

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

Returns

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>

update

Class Method

Parameters

Parameter Type Default Notes
changes Required Partial<IHubItemEntity>

Returns

void

Class defined in common/src/core/HubItemEntity.ts:32