SeriesInfoBuilder

Builder that creates an instance of the SeriesInfo object.

​

Extends

• Builder

​

Constructors

​

new SeriesInfoBuilder()

new SeriesInfoBuilder(): SeriesInfoBuilder

​

Returns

SeriesInfoBuilder

​

Methods

​

build()

build(): ISeriesInfo

Builds the SeriesInfo object based on the parameters provided.

​

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

ISeriesInfo ISeriesInfo The built SeriesInfo object containing season/episode number info for a program.

---

​

episode()

episode(episode: string): SeriesInfoBuilder

Sets the episode number. This field is required in order to build the SeriesInfo object.

​

Parameters

episode

string The string representing the episode number. The string will be truncated if its length exceeds 256 bytes and the last 3 bytes will be replaced with ”…”.

​

Throws

• IllegalStateError if the function is called after this builder instance has already built an object once.
• InvalidArgumentError if a string that is not valid UTF-8 is passed in.

​

Returns

SeriesInfoBuilder SeriesInfoBuilder The SeriesInfoBuilder object with episode number set.

---

​

season()

season(season: string): SeriesInfoBuilder

Sets the season number. This field is required in order to build the SeriesInfo object.

​

Parameters

season

string The string representing the season number. The string will be truncated if its length exceeds 256 bytes and the last 3 bytes will be replaced with ”…”.

​

Throws

• IllegalStateError if the function is called after this builder instance has already built an object once.
• InvalidArgumentError if a string that is not valid UTF-8 is passed in.

​

Returns

SeriesInfoBuilder SeriesInfoBuilder The SeriesInfoBuilder object with season number set.