as

Settings
Sign out
Notifications
Alexa
亚马逊应用商店
Ring
AWS
文档
Support
Contact Us
My Cases
新手入门
设计和开发
应用发布
参考
支持
跳转到主要内容
一个生成器,用于创建Program对象实例。

扩展

  • Builder

构造函数

new ProgramBuilder()

new ProgramBuilder(): ProgramBuilder

返回值

ProgramBuilder

方法

attributes()

attributes(attributes: string[]): ProgramBuilder 设置Program的属性。 对于该节目,此字段为选填。

参数

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

抛出

  • IllegalStateError 如果在此生成器实例已经构建过一次对象之后调用该函数。
  • InvalidArgumentError 如果传入的字符串不是有效的UTF-8格式。

返回值

ProgramBuilder ProgramBuilder 设置了属性的ProgramBuilder对象。

build()

build(): IProgram 根据提供的参数构建Program对象。

抛出

  • InvalidArgumentError 如果缺少一个或多个必填字段。
  • IllegalStateError 如果在此生成器实例已经构建过一次对象之后调用该函数。

返回值

IProgram IProgram 构建的Program对象。

channelDescriptor()

channelDescriptor(channelDescriptor: IChannelDescriptor): ProgramBuilder 设置节目的ChannelDescriptor。 必须返回此字段,才能构建Program对象。

参数

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

抛出

  • IllegalStateError 如果在此生成器实例已经构建过一次对象之后调用该函数。

返回值

ProgramBuilder ProgramBuilder 设置了ChannelDescriptor的ProgramBuilder对象。

description()

description(description: string): ProgramBuilder 设置节目的描述。 此字段为选填;但如果已知,则应提供。

参数

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

抛出

  • IllegalStateError 如果在此生成器实例已经构建过一次对象之后调用该函数。
  • InvalidArgumentError 如果传入的字符串不是有效的UTF-8格式。

返回值

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

endTimeMs()

endTimeMs(endTimeMs: number): ProgramBuilder 设置节目的结束时间。 必须返回此字段,才能构建Program对象。

参数

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

抛出

  • IllegalStateError 如果在此生成器实例已经构建过一次对象之后调用该函数。

返回值

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

genres()

genres(genres: string[]): ProgramBuilder 设置节目的类型。 此字段为选填;但如果已知,则应提供。

参数

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

抛出

  • IllegalStateError 如果在此生成器实例已经构建过一次对象之后调用该函数。
  • InvalidArgumentError 如果传入的字符串不是有效的UTF-8格式。

返回值

ProgramBuilder ProgramBuilder 设置了类型的ProgramBuilder对象。

identifier()

identifier(identifier: string): ProgramBuilder 设置节目的标识符。

参数

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

抛出

  • IllegalStateError 如果在此生成器实例已经构建过一次对象之后调用该函数。
  • InvalidArgumentError 如果该字段超过8,192个字节的最大长度。
  • InvalidArgumentError 如果传入的字符串不是有效的UTF-8格式。

返回值

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

posterArtUrl()

posterArtUrl(url: string): ProgramBuilder 设置节目的海报图URL。 此字段为选填;但如果已知,则应提供。

参数

url
string

抛出

  • IllegalStateError 如果在此生成器实例已经构建过一次对象之后调用该函数。
  • InvalidArgumentError 如果该字段超过8,192个字节的最大长度。
  • InvalidArgumentError 如果传入的字符串不是有效的UTF-8格式。

返回值

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

ratings()

ratings(ratings: string[]): ProgramBuilder 设置节目的评级。 此字段为选填;但如果已知,则应提供。

参数

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

抛出

  • IllegalStateError 如果在此生成器实例已经构建过一次对象之后调用该函数。
  • InvalidArgumentError 如果传入的字符串不是有效的UTF-8格式。

返回值

ProgramBuilder ProgramBuilder 设置了评级的ProgramBuilder对象。

seriesInfo()

seriesInfo(seriesInfo: ISeriesInfo): ProgramBuilder 设置节目的系列信息。此字段为可选项,但如果节目是一个剧集内容,且此信息可用,则应返回此字段。

参数

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

抛出

  • IllegalStateError 如果在此生成器实例已经构建过一次对象之后调用该函数。

返回值

ProgramBuilder ProgramBuilder 设置了seriesInfo的ProgramBuilder对象。

startTimeMs()

startTimeMs(starTime: number): ProgramBuilder 设置节目的开始时间。 必须返回此字段,才能构建Program对象。

参数

starTime
number

抛出

  • IllegalStateError 如果在此生成器实例已经构建过一次对象之后调用该函数。

返回值

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

subtitle()

subtitle(subtitle: string): ProgramBuilder 设置节目的子标题。 此字段为可选项;但如果情况适用并且信息已知,则应返回。

参数

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

抛出

  • IllegalStateError 如果在此生成器实例已经构建过一次对象之后调用该函数。
  • InvalidArgumentError 如果传入的字符串不是有效的UTF-8格式。

返回值

ProgramBuilder ProgramBuilder 设置了子标题的ProgramBuilder对象。

thumbnailUrl()

thumbnailUrl(url: string): ProgramBuilder 设置节目的缩略图URL。 此字段为选填;但如果已知,则应提供。

参数

url
string

抛出

  • IllegalStateError 如果在此生成器实例已经构建过一次对象之后调用该函数。
  • InvalidArgumentError 如果该字段超过8,192个字节的最大长度。
  • InvalidArgumentError 如果传入的字符串不是有效的UTF-8格式。

返回值

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

title()

title(title: string): ProgramBuilder 设置节目的标题。 必须返回此字段,才能构建Program对象。

参数

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

抛出

  • IllegalStateError 如果在此生成器实例已经构建过一次对象之后调用该函数。
  • InvalidArgumentError 如果传入的字符串不是有效的UTF-8格式。

返回值

ProgramBuilder ProgramBuilder 设置了标题的ProgramBuilder对象。
最后修改于 2026年10月26日