as

Settings
Sign out
Notifications
Alexa
亚马逊应用商店
AWS
文档
Support
Contact Us
My Cases
新手入门
设计和开发
应用发布
参考
支持

ProgramBuilder

ProgramBuilder

一个生成器,用于创建Program对象实例。

扩展

构造函数

new ProgramBuilder()

new ProgramBuilder(): ProgramBuilder

返回值

ProgramBuilder

继承自

Builder.constructor

方法

attributes()

attributes(attributes): ProgramBuilder

设置Program的属性。

参数

attributes

string[]

这个Program的属性列表。请参阅开发者指南,了解该字段的推荐规范值列表。该列表的最大大小为32。如果超过32个项目,多余的项目将被移除。每个项目的最大长度为255个字节,超过此长度的项目将被截断,最后3个字节将替换为“…”。

返回值

ProgramBuilder

设置了属性的ProgramBuilder对象。

详情

对于该节目,此字段为选填。

抛出

IllegalStateError:如果此生成器实例已经构建过一次对象,则再次调用此函数时会抛出该错误。

抛出

如果传入的字符串不是有效的UTF-8格式,则抛出InvalidArgumentError


build()

build(): IProgram

根据提供的参数构建Program对象。

返回值

IProgram

构建的Program对象。

抛出

如果缺少一个或多个必填字段,则抛出InvalidArgumentError

抛出

IllegalStateError:如果此生成器实例已经构建过一次对象,则再次调用此函数时会抛出该错误。

覆盖

Builder.build


channelDescriptor()

channelDescriptor(channelDescriptor): ProgramBuilder

设置节目的ChannelDescriptor

参数

channelDescriptor

IChannelDescriptor

该节目播出的频道的唯一标识描述符。

返回值

ProgramBuilder

设置了ChannelDescriptorProgramBuilder对象。

详情

要构建Program对象,此字段为必填。

抛出

IllegalStateError:如果此生成器实例已经构建过一次对象,则再次调用此函数时会抛出该错误。


description()

description(description): ProgramBuilder

设置节目的描述。

参数

description

string

特定节目的简要描述。例如,关于剧集的描述。如果字符串的长度超过8,192个字节,则该字符串将被截断并在末尾添加“…”。

返回值

ProgramBuilder

设置了描述信息的ProgramBuilder对象。

详情

此字段为选填;但如果已知,则应提供。

抛出

IllegalStateError:如果此生成器实例已经构建过一次对象,则再次调用此函数时会抛出该错误。

抛出

如果传入的字符串不是有效的UTF-8格式,则抛出InvalidArgumentError


endTimeMs()

endTimeMs(endTimeMs): ProgramBuilder

设置节目的结束时间。

参数

endTimeMs

number

表示节目结束时间的时间戳(以毫秒为单位,从纪元开始计算)。该字段可以表示过去或未来的值。

返回值

ProgramBuilder

设置了结束时间的ProgramBuilder对象。

详情

必须返回此字段,才能构建Program对象。

抛出

IllegalStateError:如果此生成器实例已经构建过一次对象,则再次调用此函数时会抛出该错误。


genres()

genres(genres): ProgramBuilder

设置节目的类型。

参数

genres

string[]

适用于节目的类型列表。请参阅开发者指南,了解该字段的推荐规范值列表。该列表的最大大小为32。如果超过32个项目,多余的项目将被移除。每个项目的最大长度为255个字节,超过此长度的项目将被截断,最后3个字节将替换为“…”。

返回值

ProgramBuilder

设置了类型的ProgramBuilder对象。

详情

此字段为选填;但如果已知,则应提供。

抛出

IllegalStateError:如果此生成器实例已经构建过一次对象,则再次调用此函数时会抛出该错误。

抛出

如果传入的字符串不是有效的UTF-8格式,则抛出InvalidArgumentError


identifier()

identifier(identifier): ProgramBuilder

设置节目的标识符。

参数

identifier

string

电子节目指南列表中节目的标识符。必须提供此字段,才能构建Program对象。该字段的最大长度为8,192个字节。

返回值

ProgramBuilder

设置了节目标识符的ProgramBuilder对象。

抛出

IllegalStateError:如果此生成器实例已经构建过一次对象,则再次调用此函数时会抛出该错误。

抛出

如果该字段超过8,192个字节的最大长度,则抛出InvalidArgumentError

抛出

如果传入的字符串不是有效的UTF-8格式,则抛出InvalidArgumentError


posterArtUrl()

posterArtUrl(url): ProgramBuilder

设置节目的海报图URL。

参数

url

string

返回值

ProgramBuilder

设置了海报图URL的ProgramBuilder对象。

详情

此字段为选填;但如果已知,则应提供。

抛出

IllegalStateError:如果此生成器实例已经构建过一次对象,则再次调用此函数时会抛出该错误。

抛出

如果该字段超过8,192个字节的最大长度,则抛出InvalidArgumentError。

抛出

如果传入的字符串不是有效的UTF-8格式,则抛出InvalidArgumentError


ratings()

ratings(ratings): ProgramBuilder

设置节目的评级。

参数

ratings

string[]

字符串列表,用于表示针对特定节目而提供的家长指导级别建议。这可以是播出节目的国家或地区使用的任何评级系统。请参阅开发者指南,了解该字段的推荐规范值列表。该列表的最大大小为32。如果超过32个项目,多余的项目将被移除。每个项目的最大长度为255个字节,超过此长度的项目将被截断,最后3个字节将替换为“…”。

返回值

ProgramBuilder

设置了评级的ProgramBuilder对象。

详情

此字段为选填;但如果已知,则应提供。

抛出

IllegalStateError:如果此生成器实例已经构建过一次对象,则再次调用此函数时会抛出该错误。

抛出

如果传入的字符串不是有效的UTF-8格式,则抛出InvalidArgumentError


seriesInfo()

seriesInfo(seriesInfo): ProgramBuilder

设置节目的系列信息。

参数

seriesInfo

ISeriesInfo

该节目的系列剧集信息,例如季和剧集编号。

返回值

ProgramBuilder

设置了seriesInfo的ProgramBuilder对象。

详情

此字段为可选项,但如果节目是一个剧集内容,且此信息可用,则应返回此字段。

抛出

IllegalStateError:如果此生成器实例已经构建过一次对象,则再次调用此函数时会抛出该错误。


startTimeMs()

startTimeMs(starTime): ProgramBuilder

设置节目的开始时间。

参数

starTime

number

返回值

ProgramBuilder

设置了开始时间的ProgramBuilder对象。

详情

要构建Program对象,此字段为必填。

抛出

IllegalStateError:如果此生成器实例已经构建过一次对象,则再次调用此函数时会抛出该错误。


subtitle()

subtitle(subtitle): ProgramBuilder

设置节目的子标题。

参数

subtitle

string

特定节目的从属标题。例如,“Maybe Today”,即为“MCIS: Los Angeles”的剧集名称。如果字符串的长度超过255个字节,则该字符串将被截断,并且最后3个字节将替换为“…”。

返回值

ProgramBuilder

设置了子标题的ProgramBuilder对象。

详情

此字段为可选项;但如果情况适用并且信息已知,则应返回。

抛出

IllegalStateError:如果此生成器实例已经构建过一次对象,则再次调用此函数时会抛出该错误。

抛出

如果传入的字符串不是有效的UTF-8格式,则抛出InvalidArgumentError


thumbnailUrl()

thumbnailUrl(url): ProgramBuilder

设置节目的缩略图URL。

参数

url

string

返回值

ProgramBuilder

设置了缩略图URL的ProgramBuilder对象。

详情

此字段为选填;但如果已知,则应提供。

抛出

IllegalStateError:如果此生成器实例已经构建过一次对象,则再次调用此函数时会抛出该错误。

抛出

如果该字段超过8,192个字节的最大长度,则抛出InvalidArgumentError。

抛出

如果传入的字符串不是有效的UTF-8格式,则抛出InvalidArgumentError


title()

title(title): ProgramBuilder

设置节目的标题。

参数

title

string

特定节目的标题或名称。例如,“MCIS: Los Angeles”。如果字符串的长度超过255个字节,则该字符串将被截断,并且最后3个字节将替换为“…”。

返回值

ProgramBuilder

设置了标题的ProgramBuilder对象。

详情

要构建Program对象,此字段为必填。

抛出

IllegalStateError:如果此生成器实例已经构建过一次对象,则再次调用此函数时会抛出该错误。

抛出

如果传入的字符串不是有效的UTF-8格式,则抛出InvalidArgumentError


Last updated: 2025年9月30日