updateChannel

Function

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

Parameters

Parameter Type Default Notes
options Required IUpdateChannelParams

Returns

{Promise}

Promise<IChannel>
Property Type Notes
access SharingAccess
allowAnonymous boolean
allowAsAnonymous boolean
allowPost boolean
allowReaction boolean
allowReply boolean
allowedReactions PostReaction[] | null
blockWords string[] | null
defaultPostStatus PostStatus
groups string[]
id string
metadata IChannelMetadata | null
name string | null
orgId string
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:55