ChannelInfoBuilder

Builder that creates an instance of the ChannelInfo object.

Extends

• Builder<IChannelInfo>

Constructors

new ChannelInfoBuilder()

new ChannelInfoBuilder(): ChannelInfoBuilder

Returns

ChannelInfoBuilder

Inherited from

Builder.constructor

Properties

_className

protected readonly _className: string = 'ChannelInfoBuilder'

Overrides

Builder._className

Methods

build()

build(): IChannelInfo

Builds the ChannelInfo object from the fields set in the ChannelInfoBuilder object.

Returns

IChannelInfo

The built ChannelInfo object.

Throws

InvalidArgumentError if one or more of the required fields are missing.

Throws

IllegalStateError if the function is called after this builder instance has already built an object once.

Overrides

Builder.build

---

channelDescriptor()

channelDescriptor(channelDescriptor): ChannelInfoBuilder

Sets the ChannelDescriptor of the builder. This is required.

Parameters

channelDescriptor

IChannelDescriptor

Returns

ChannelInfoBuilder

The ChannelInfoBuilder object with channelDescriptor set.

Throws

IllegalStateError if the function is called after this builder instance has already built an object once.

---

channelMetadata()

channelMetadata(metadata): ChannelInfoBuilder

Sets the ChannelMetadata of the builder. This is required.

Parameters

metadata

IChannelMetadata

Returns

ChannelInfoBuilder

The ChannelInfoBuilder object with channelMetadata set.

Throws

IllegalStateError if the function is called after this builder instance has already built an object once.

---

markBuilderAsUsed()

protected markBuilderAsUsed(): void

Returns

void

Inherited from

Builder.markBuilderAsUsed

---

throwErrorIfBuilderAlreadyUsed()

protected throwErrorIfBuilderAlreadyUsed(): void

Returns

void

Inherited from

Builder.throwErrorIfBuilderAlreadyUsed

---

Last updated: Sep 30, 2025