ChannelMetadata对象实例的生成器。
扩展
Builder
构造函数
new ChannelMetadataBuilder()
new ChannelMetadataBuilder(): ChannelMetadataBuilder返回值
ChannelMetadataBuilder方法
attributes()
attributes(attributes:string[]): ChannelMetadataBuilder
在ChannelMetadata生成器中设置频道属性。
对于频道元数据，此字段为选填。
参数
attributes
string[]
频道的属性。请参阅开发者指南，了解该字段的推荐规范值列表。该列表的最大大小为32。如果超过32个项目，多余的项目将被移除。每个项目的最大长度为255个字节，超过此长度的项目将被截断，最后3个字节将替换为“…”。
抛出
IllegalStateError如果在此生成器实例已经构建过一次对象之后调用该函数。InvalidArgumentError如果传入的字符串不是有效的UTF-8格式。
返回值
ChannelMetadataBuilder ChannelMetadataBuilder 设置了频道属性的ChannelMetadataBuilder对象。
build()
build(): IChannelMetadata 根据ChannelMetadataBuilder中的字段构建ChannelMetadata对象。
抛出
InvalidArgumentError如果缺少一个或多个必填字段。IllegalStateError如果在此生成器实例已经构建过一次对象之后调用该函数。
返回值
IChannelMetadata IChannelMetadata 构建的ChannelMetadata对象。
channelGroupId
channelGroupId(channelGroupId:string): ChannelMetadataBuilder
在ChannelMetadata生成器中设置频道组ID。
此字段为可选项，通常不需要，除非您的亚马逊联系人建议返回。
参数
channelGroupId
string
您的亚马逊联系人提供的频道组ID。该字段的最大长度为8,192个字节。
抛出
IllegalStateError如果在此生成器实例已经构建过一次对象之后调用该函数。InvalidArgumentError如果ExternId中的任何字段超过8,192个字节的最大长度InvalidArgumentError如果传入的字符串不是有效的UTF-8格式。
返回值
ChannelMetadataBuilder ChannelMetadataBuilder 设置了channelGroupId的ChannelMetadataBuilder对象。
channelType()
channelType(channelType: ChannelTypeEnum): ChannelMetadataBuilder 在ChannelMetadata生成器中设置频道类型。此字段只能设置为OTT，因为系统尚不支持其他频道类型。
频道元数据需要此信息，因此必须返回此字段。
参数
channelType
ChannelTypeEnum 表示频道来源的频道类型。这必须是在ChannelTypeEnum中定义的来源之一。
抛出
IllegalStateError如果在此生成器实例已经构建过一次对象之后调用该函数。
返回值
ChannelMetadataBuilder ChannelMetadataBuilder 设置了频道类型的ChannelMetadataBuilder对象。
externalIdList
externalIdList(externalIdList: IExternalId[]): ChannelMetadataBuilder
在ChannelMetadata生成器中设置频道ExternalId列表。
对于频道元数据，此字段为选填。
参数
externalIdList
IExternalId[]
外部时间表源的标识符列表，频道应该与之关联。列表的最大大小为255。如果超过255个项目，多余的项目将被移除。IExtrnalId中的字段的最大长度为8,192个字节。
抛出
IllegalStateError如果在此生成器实例已经构建过一次对象之后调用该函数。InvalidArgumentError如果ExternalId中的任何字段超过8,192个字节的最大长度。InvalidArgumentError如果传入的字符串不是有效的UTF-8格式。
返回值
ChannelMetadataBuilder ChannelMetadataBuilder 设置了频道外部ID列表的ChannelMetadataBuilder对象。
genres()
genres(genres:string[]): ChannelMetadataBuilder
在ChannelMetadata生成器中设置频道类型。
对于频道元数据，此字段为选填。
参数
genres
string[]
适用于频道的类型列表。请参阅开发者指南，了解该字段的推荐规范值列表。该列表的最大大小为32。如果超过32个项目，多余的项目将被移除。每个项目的最大长度为255个字节，超过此长度的项目将被截断，最后3个字节将替换为“…”。
抛出
IllegalStateError如果在此生成器实例已经构建过一次对象之后调用该函数。InvalidArgumentError如果传入的字符串不是有效的UTF-8格式。
返回值
ChannelMetadataBuilder ChannelMetadataBuilder设置了频道类型的ChannelMetadataBuilder对象。
logoUrl()
logoUrl(logoUrl:string): ChannelMetadataBuilder
在ChannelMetadata生成器中设置频道标志URL。
对于频道元数据，此字段为选填。
参数
logoUrl
string
频道标志的URL。用于渲染频道缩略图。该字段的最大长度为8,192个字节。
抛出
IllegalStateError如果在此生成器实例已经构建过一次对象之后调用该函数。InvalidArgumentError如果该字段超过8,192个字节的最大长度。InvalidArgumentError如果传入的字符串不是有效的UTF-8格式。
返回值
ChannelMetadataBuilder ChannelMetadataBuilder 设置了频道标志URL的ChannelMetadataBuilder对象。
name()
name(name:string): ChannelMetadataBuilder
在ChannelMetadata生成器中设置频道名称。
频道元数据需要此信息，并且不能是空字符串。
参数
name
string
表示该频道的营销名称，例如“The CW”或“Comedy Central”。如果字符串的长度超过255个字节，则该字符串将被截断，并且最后3个字节将替换为“…”。
抛出
IllegalStateError如果在此生成器实例已经构建过一次对象之后调用该函数。InvalidArgumentError如果传入的字符串不是有效的UTF-8格式。
返回值
ChannelMetadataBuilder ChannelMetadataBuilder 设置了频道名称的ChannelMetadataBuilder对象。
sortRank()
sortRank(sortRank:number): ChannelMetadataBuilder
在ChannelMetadata生成器中设置频道排名。
对于频道元数据，此字段为选填。
参数
sortRank
number
该频道相对于其他频道的排名。在此应用的电子节目指南 (EPG) 中，排名值（整数）越小的频道越靠前显示。此字段为可选项，如果未提供，则默认为MAX Int32。如果您想根据频道的排名值显示频道，请联系您的亚马逊联系人。
抛出
IllegalStateError如果在此生成器实例已经构建过一次对象之后调用该函数。
返回值
ChannelMetadataBuilder ChannelMetadataBuilder 设置了频道排名的ChannelMetadataBuilder对象。
videoResolution
videoResolution(videoResolution:string): ChannelMetadataBuilder
在ChannelMetadata生成器中设置频道视频分辨率。
对于频道元数据，此字段为选填。
参数
videoResolution
string
频道的视频分辨率。请参阅开发者指南，了解该字段的推荐规范值列表。如果字符串的长度超过127个字节，则该字符串将被截断，并且最后3个字节将替换为“…”。
抛出
IllegalStateError如果在此生成器实例已经构建过一次对象之后调用该函数。InvalidArgumentError如果传入的字符串不是有效的UTF-8格式。
返回值
ChannelMetadataBuilder ChannelMetadataBuilder 设置了频道视频分辨率的ChannelMetadataBuilder对象。
