HubItemEntity

Class

Base class for all Hub Entities backed by items

Implements

Constructors

new HubItemEntity(entity: IHubItemEntity, context: IArcGISContext) : HubItemEntity

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
canDelete	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	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	string	Return the entity id
orgId	string	The orgId of the Entity, if available
owner	string	Return the entity owner

Methods

Method	Returns	Notes
addAssociation(info: IAssociationInfo)	void	Add an association to this entity
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
delete()	Promise<void>
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
listAssociations(type: AssociationType)	IAssociationInfo[]	Return a list of IAssociationInfo objects representing the associations this entity has, to the specified type
removeAssociation(info: IAssociationInfo)	void	Remove an association from this entity
removePermissionPolicy(permission: Permission, id: string)	void	Remove a policy from the entity
save()	Promise<void>
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
setFollowersGroupAccess(access: SettableAccessLevel)	Promise<void>	Sets the access level of the followers group
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()	IHubItemEntity	Return the backing entity as an object literal
unshareWithGroup(groupId: string)	Promise<void>	Unshare the Entity with the specified group id
update(changes: Partial<IHubItemEntity>)	void
updateIsDiscussable(isDiscussable: boolean)	void	Updates the isDiscussable property

addAssociation

Class Method

Add an association to this entity

addAssociation(info: IAssociationInfo) : void

Parameters

Parameter	Type	Default	Notes
info Required	IAssociationInfo

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

delete

Class Method

delete() : Promise<void>

Returns

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

listAssociations

Class Method

Return a list of IAssociationInfo objects representing the associations this entity has, to the specified type

listAssociations(type: AssociationType) : IAssociationInfo[]

Parameters

Parameter	Type	Default	Notes
type Required	AssociationType

Returns

IAssociationInfo[]

removeAssociation

Class Method

Remove an association from this entity

removeAssociation(info: IAssociationInfo) : void

Parameters

Parameter	Type	Default	Notes
info Required	IAssociationInfo

Returns

void

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

save

Class Method

save() : Promise<void>

Returns

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

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>

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

Returns

IHubItemEntity

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

update(changes: Partial<IHubItemEntity>) : void

Parameters

Parameter	Type	Default	Notes
changes Required	Partial<IHubItemEntity>

Returns

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/core/HubItemEntity.ts:50