Amazon Developer

as

Settings
Sign out
Notifications
Alexa
Amazon Appstore
Ring
AWS
Documentation
Support
Contact Us
My Cases
Get Started
Design and Develop
Publish
Reference
Support

ChannelInfoBuilder

Builder that creates an instance of the ChannelInfo object.

Extends

  • Builder

Constructors

new ChannelInfoBuilder()

new ChannelInfoBuilder(): ChannelInfoBuilder

Returns

ChannelInfoBuilder

Methods

build()

build(): IChannelInfo

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

Throws

  • InvalidArgumentError if one or more of the required fields are missing.
  • IllegalStateError if the function is called after this builder instance has already built an object once.

Returns

IChannelInfo

IChannelInfo The built ChannelInfo object.


channelDescriptor()

channelDescriptor(channelDescriptor: IChannelDescriptor): ChannelInfoBuilder

Sets the ChannelDescriptor of the builder. This is required.

Parameters

channelDescriptor

IChannelDescriptor

Throws

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

Returns

ChannelInfoBuilder

ChannelInfoBuilder The ChannelInfoBuilder object with channelDescriptor set.


channelMetadata()

channelMetadata(metadata: IChannelMetadata): ChannelInfoBuilder

Sets the ChannelMetadata of the builder. This is required.

Parameters

metadata

IChannelMetadata

Throws

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

Returns

ChannelInfoBuilder

ChannelInfoBuilder The ChannelInfoBuilder object with channelMetadata set.


Last updated: Jul 31, 2026