@esri/hub.js
@esri/hub.js

HubDiscussion

Class

Hub Discussion Class

Implements

Extends

Constructors

Constructor Parameters

Parameter Type Default Notes
entity Required IHubDiscussion
context Required IArcGISContext

Properties

Property Type Notes
context Protected Inherited IArcGISContext
entity Protected Inherited IHubDiscussion
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
Promise<HubDiscussion>

Create a new HubDiscussion, returning a HubDiscussion instance. Note: This does not persist the Discussion into the backing store
Promise<HubDiscussion>

Fetch a Discussion from the backing store and return a HubDiscussion instance.
HubDiscussion

Create an instance from an IHubDiscussion object
Promise<void>

Delete the HubDiscussion from the store set a flag to indicate that it is destroyed
Promise<IHubDiscussion>

Load the project from the editor object
Promise<IEditorConfig>
Promise<void>
Promise<IHubDiscussionEditor>

Return the project as an editor object
void

Apply a new state to the instance
void

Add an association to this entity
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 .save() call
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
IAssociationInfo[]

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

Remove an association from this entity
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 .save() call
Promise<void>

Share the Entity with the specified group id
Promise<IGroup[]>

Return a list of groups the Entity is shared to.
IHubDiscussion

Return the backing entity as an object literal
Promise<void>

Unshare the Entity with the specified group id
void

Updates the isDiscussable property

create

Static Static Class Method

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

Parameters

Parameter Type Default Notes
partialDiscussion Required Partial<IHubDiscussion>

a partial IHubDiscussion
context Required IArcGISContext

ArcGIS context
save Optional boolean false

Returns

promise that resolves a HubDiscussion

Promise<HubDiscussion>

fetch

Static Static Class Method

Fetch a Discussion from the backing store and return a HubDiscussion instance.

Parameters

Parameter Type Default Notes
identifier Required string

slug or item id
context Required IArcGISContext

ArcGIS context

Returns

promise that resolves a HubDiscussion

Promise<HubDiscussion>

fromJson

Static Static Class Method

Create an instance from an IHubDiscussion object

Parameters

Parameter Type Default Notes
json Required Partial<IHubDiscussion>

JSON object to create a HubDiscussion from
context Required IArcGISContext

ArcGIS context

Returns

a HubDiscussion

HubDiscussion

delete

Class Method

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

  • delete() : Promise<void>

Returns

a promise

Promise<void>

fromEditor

Class Method

Load the project from the editor object

Parameters

Parameter Type Default Notes
editor Required IHubDiscussionEditor

Returns

Promise<IHubDiscussion>

getEditorConfig

Class Method

Parameters

Parameter Type Default Notes
i18nScope Required string
type Required DiscussionEditorType

Returns

Promise<IEditorConfig>

save

Class Method
  • save() : Promise<void>

Returns

Promise<void>

toEditor

Class Method

Return the project as an editor object

Parameters

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

Returns

Promise<IHubDiscussionEditor>

update

Class Method

Apply a new state to the instance

Parameters

Parameter Type Default Notes
changes Required Partial<IHubDiscussion>

A partial IHubDiscussion

Returns

void

addAssociation

Class Method

Add an association to this entity

Parameters

Parameter Type Default Notes
info Required IAssociationInfo

Returns

void

addPermissionPolicy

Class Method

Add a policy to the entity

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

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

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

Parameters

Parameter Type Default Notes
type Required AssociationType

Returns

IAssociationInfo[]

removeAssociation

Class Method

Remove an association from this entity

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

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>

setFollowersGroupAccess

Class Method

Sets the access level of the followers group

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>

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

IHubDiscussion

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>

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/discussions/HubDiscussion.ts:21