updateChannel

Function

update channel NOTE: only updates channel settings properties (softDelete, allowedReactions, etc). A Channel's access and groups cannot be updated.

Parameters

Parameter	Type	Default	Notes
options Required	IUpdateChannelOptions

{Promise}

Promise<IChannel>

Property	Type	Notes
id	string
access Inherited	SharingAccess
allowAnonymous Inherited	boolean
allowReaction Inherited	boolean
allowReply Inherited	boolean
createdAt Inherited	Date
creator Inherited	string
defaultPostStatus Inherited	PostStatus
editor Inherited	string
softDelete Inherited	boolean
updatedAt Inherited	Date
acl Optional Inherited	IChannelACL
allowedReactions Optional Inherited	PostReaction[]
blockwords Optional Inherited	string[]
groups Optional Inherited	string[]
orgs Optional Inherited	string[]

Function defined in discussions/src/channels.ts:62