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 IUpdateChannelParams

Returns

{Promise}

Promise<IChannel>
Property Type Notes
access SharingAccess
acl IChannelAclObject
allowAnonymous boolean
allowReaction boolean
allowReply boolean
allowedReactions PostReaction[] | null
blockWords string[] | null
defaultPostStatus PostStatus
groups string[]
id string
name string | null
orgs string[]
softDelete boolean
createdAt Inherited Date
creator Inherited string
editor Inherited string
updatedAt Inherited Date
channelAcl Optional IChannelAclPermission[]
posts Optional IPost[]

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