Class ChannelGroup

constructor

• new ChannelGroup(query: Query, data: RawChannelGroup): ChannelGroup

  Parameters

  • query: Query
  • data: RawChannelGroup

  Returns ChannelGroup

iconId

memberAddPower

memberRemovePower

modifyPower

name

nameMode

saveDb

sortId

type

partial

• get partial(): boolean

  Checks if the channel group is partially filled.

  Returns boolean

  Whether the channel group is partially filled.

_patch

• _patch(data: Partial<RawChannelGroup>): void

  Patches the channel group with new data.

  Parameters

  • data: Partial<RawChannelGroup>

    The new data to patch the channel group with.

  Returns void

copy

• copy(options: ChannelGroupCopyOptions_Create): Promise<ChannelGroup>

  Copies this channel group into a new channel group.

  Parameters

  • options: ChannelGroupCopyOptions_Create

    The options for copying the channel group.

  Returns Promise<ChannelGroup>

  The created channel group.

• copy(options: ChannelGroupCopyOptions_Target): Promise<null>

  Copies this channel group into an existing channel group.

  Parameters

  • options: ChannelGroupCopyOptions_Target

    The options for copying the channel group.

  Returns Promise<null>

  A promise that resolves when the channel group has been copied.

delete

• delete(force?: boolean): Promise<void>

  Deletes the channel group.

  Parameters

  • Optionalforce: boolean = false

    Whether to force the deletion. Force deletion will remove the channel group from all clients.

  Returns Promise<void>

  A promise that resolves when the channel group has been deleted.

rename

• rename(name: string): Promise<ChannelGroup>

  Renames the channel group.

  Parameters

  • name: string

    The new name for the channel group.

  Returns Promise<ChannelGroup>

  The updated channel group.