updateChannelV2

Function

update channel V2

Parameters

Parameter Type Default Notes
options Required IUpdateChannelParamsV2

Returns

{Promise}

Promise<IChannel>
Property Type Notes
access SharingAccess | null

deprecated V1 permissions field, use channelAcl

allowAnonymous boolean | null

deprecated V1 permissions field, use channelAcl

allowAsAnonymous boolean
allowPost boolean
allowReaction boolean
allowReply boolean
allowedReactions PostReaction[] | null
blockWords string[] | null
defaultPostStatus PostStatus
groups string[] | null

deprecated V1 permissions field, use channelAcl

id string
metadata IChannelMetadata | null
name string | null
orgId string
orgs string[] | null

deprecated V1 permissions field, use channelAcl

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:194