updateHubChannel

Function

Updates an existing Channel from the given IHubChannel object

updateHubChannel(entity: IHubChannel, context: IArcGISContext) : Promise<IHubChannel>

Parameters

Parameter	Type	Default	Notes
entity Required	IHubChannel		An IHubChannel object
context Required	IArcGISContext		ArcGIS context

Returns

a promise that resolves an IHubChannel representing the updated channel

Promise<IHubChannel>

Property	Type	Notes
access	AccessLevel	The access level of the channel
allowAsAnonymous	boolean	True when authenticated users can post pseudo-anonymously, masking their identity
blockWords	string[]	An array of blocked words. Posts & replies created/edited containing these words will result in the post status being automatically set to blocked
canDelete	boolean	True when the currently authenticated user can delete the channel
canEdit	boolean	True when the currently authenticated user can edit the channel
channel	IChannel	A reference to the underlying IChannel object
orgId	string	The ID of the organization the channel was created within
owner	string	The owner of the channel
permissions	IEntityPermissionPolicy[]	An array of IEntityPermissionPolicy representing the configured permissions for the channel
tags	string[]	Tags applied to the channel
typeKeywords	string[]	Typekeywords applied to the channel
createdDate Inherited	Date	Date the entity was created
createdDateSource Inherited	string	Source of the creation date as a property path e.q `item.created`
id Inherited	string	Id of the entity as a string
name Inherited	string	Name of the Entity For Entities backed by items, this is typically the title
type Inherited	string	For Item backed results, this will be `item.type` Otherwise it will be "Group", "User", "Event" etc
updatedDate Inherited	Date	Date when the entity was last updated Depending on the entity, this could be derived in many different ways
updatedDateSource Inherited	string	Source of the updated date
description Optional	string	Description of the channel
location Optional	IHubLocation	The location of the channel
thumbnail Optional	string	Thumbnail of the channel
view Optional	IWithViewSettings	View settings of the channel
links Optional Inherited	IHubEntityLinks	Links to related things
source Optional Inherited	string	Source of the entity. Exact logic for this tbd, but the intent is to allow the result to be attributed to something other than "owner"
summary Optional Inherited	string	Sanitized summary derived from item.snippet, item.description, group.description, user.description, event.description etc

Function defined in packages/common/src/channels/edit.ts:36