LiveEventBuilder
一个生成器，用于创建LiveEvent对象实例。
扩展
构造函数
new LiveEventBuilder()
new LiveEventBuilder():
LiveEventBuilder
返回值
继承自
方法
attributes()
attributes(
attributes):LiveEventBuilder
在直播活动生成器中设置直播活动的属性并返回该生成器的实例。
参数
attributes
string[]
直播活动的属性。请参阅开发者指南，了解该字段的推荐规范值列表。此字段为选填；但如果已知，则应提供。该列表的最大大小为32。如果超过32个项目，多余的项目将被移除。每个项目的最大长度为255个字节，超过此长度的项目将被截断，最后3个字节将替换为“…”。
返回值
设置了attributes的LiveEventBuilder对象。
抛出
如果在此生成器实例已经构建过一次对象之后再次调用该函数。
抛出
如果传入的字符串不是有效的UTF-8格式。
build()
build():
ILiveEvent
根据提供的参数构建LiveEvent对象。
返回值
构建的LiveEvent对象。
详情
这个函数必须在使用其他生成器函数配置好所有必要的直播活动生成器字段之后才能调用。每个生成器对象只能调用一次build() 函数。
抛出
如果缺少一个或多个必填字段。
抛出
如果在此生成器实例已经构建过一次对象之后再次调用该函数。
覆盖
description()
description(
description):LiveEventBuilder
在直播活动生成器中设置直播活动的描述并返回该生成器的实例。
参数
description
string
直播活动的简要描述。此字段是可选的。如果字符串的长度超过8,192个字节，则该字符串将被截断，并且最后3个字节将替换为“…”。
返回值
设置了description的LiveEventBuilder对象。
抛出
如果在此生成器实例已经构建过一次对象之后再次调用该函数。
抛出
如果传入的字符串不是有效的UTF-8格式。
endTimeMs()
endTimeMs(
endTimeMs):LiveEventBuilder
在直播活动生成器中设置直播活动的结束时间并返回该生成器的实例。
参数
endTimeMs
number
直播活动的结束时间，以毫秒为单位（从纪元开始计算）。该字段可以表示过去或未来的值。如果eventType为SCHEDULED_EVENT，则此字段为必填。
返回值
设置了endTimeMs的LiveEventBuilder对象。
抛出
如果在此生成器实例已经构建过一次对象之后再次调用该函数。
eventType()
eventType(
eventType):LiveEventBuilder
在直播活动生成器中设置直播活动的类型并返回该生成器的实例。
参数
eventType
直播活动的类型。此字段为必填。
返回值
设置了eventType的LiveEventBuilder对象。
抛出
如果在此生成器实例已经构建过一次对象之后再次调用该函数。
genres()
genres(
genres):LiveEventBuilder
在直播活动生成器中设置直播活动的类型并返回该生成器的实例。
参数
genres
string[]
适用于直播活动的类型清单。请参阅开发者指南，了解该字段的推荐规范值列表。是否提供类型由您自行决定；但如果类型已知，则应提供。该列表的最大大小为32。如果超过32个项目，多余的项目将被移除。每个项目的最大长度为255个字节，超过此长度的项目将被截断，最后3个字节将替换为“…”。
返回值
设置了genres的LiveEventBuilder对象。
抛出
如果在此生成器实例已经构建过一次对象之后再次调用该函数。
抛出
如果传入的字符串不是有效的UTF-8格式。
identifier()
identifier(
identifier):LiveEventBuilder
在直播活动生成器中设置直播活动的唯一标识符并返回该生成器的实例。
参数
identifier
string
特定直播活动的唯一标识符。此标识符在应用程序包内的所有直播活动中应该是唯一的。对于特定的直播活动，此标识符在每次更新时都应该保持一致，不应发生变化。此字段为必填，并且最大长度为8,192个字节。
返回值
设置了identifier的LiveEventBuilder对象。
抛出
如果在此生成器实例已经构建过一次对象之后再次调用该函数。
抛出
如果字段超过8,192个字节的最大长度。
抛出
如果传入的字符串不是有效的UTF-8格式。
logoUrl()
logoUrl(
logoUrl):LiveEventBuilder
在直播活动生成器中设置直播活动的标志URL并返回该生成器的实例。
参数
logoUrl
string
可供找到直播活动标志的URL。此字段是可选的。该字段的最大长度为8,192个字节。
返回值
设置了logoUrl的LiveEventBuilder对象。
抛出
如果在此生成器实例已经构建过一次对象之后再次调用该函数。
抛出
如果字段超过8,192个字节的最大长度。
抛出
如果传入的字符串不是有效的UTF-8格式。
playbackReference()
playbackReference(
playbackReference):LiveEventBuilder
在直播活动生成器中设置直播活动的播放参考并返回该生成器的实例。
参数
playbackReference
直播活动的播放参考，描述如何开始播放。此字段为必填。
返回值
设置了playbackReference的LiveEventBuilder对象。
抛出
如果在此生成器实例已经构建过一次对象之后再次调用该函数。
posterArtUrl()
posterArtUrl(
posterArtUrl):LiveEventBuilder
在直播活动生成器中设置直播活动的海报图URL并返回该生成器的实例。
参数
posterArtUrl
string
可供找到海报图片的URL。此字段是可选的。该字段的最大长度为8,192个字节。
返回值
设置了posterArtUrl的LiveEventBuilder对象。
抛出
如果在此生成器实例已经构建过一次对象之后再次调用该函数。
抛出
如果字段超过8,192个字节的最大长度。
抛出
如果传入的字符串不是有效的UTF-8格式。
ratings()
ratings(
ratings):LiveEventBuilder
在直播活动生成器中设置直播活动的评级并返回该生成器的实例。
参数
ratings
string[]
字符串列表，用于表示针对特定直播活动而提供的家长指导级别建议。这可以是播出直播活动的国家或地区使用的任何评级系统。是否提供家长指导评分由您自行决定；但如果评级已知，则应提供。请参阅开发者指南，了解该字段的推荐规范值列表。该列表的最大大小为32。如果超过32个项目，多余的项目将被移除。每个项目的最大长度为255个字节，超过此长度的项目将被截断，最后3个字节将替换为“…”。
返回值
设置了ratings的LiveEventBuilder对象。
抛出
如果在此生成器实例已经构建过一次对象之后再次调用该函数。
抛出
如果传入的字符串不是有效的UTF-8格式。
sortRank()
sortRank(
sortRank):LiveEventBuilder
可选函数，在直播活动生成器中设置直播活动的排名并返回该生成器的实例。
参数
sortRank
number
此直播活动相对于其他直播活动的排名。
返回值
设置了排名的LiveEventBuilder对象。
详情
在此应用的行中，排名值（整数）越小的直播活动越靠前显示。如果未提供，该字段将默认为MAX Int32。如果两个或更多直播活动的排名相同，则按标题的字母顺序进行排序。
抛出
IllegalStateError：如果此构建器实例已经构建过一次对象，则再次调用此函数时会抛出该错误。
startTimeMs()
startTimeMs(
startTimeMs):LiveEventBuilder
在直播活动生成器中设置直播活动的开始时间并返回该生成器的实例。
参数
startTimeMs
number
直播活动的开始时间，以毫秒为单位（从纪元开始计算）。该字段可以表示过去或未来的值。如果eventType为SCHEDULED_EVENT，则此字段为必填。
返回值
设置了startTimeMs的LiveEventBuilder对象。
抛出
如果在此生成器实例已经构建过一次对象之后再次调用该函数。
title()
title(
title):LiveEventBuilder
在直播活动生成器中设置直播活动的标题并返回该生成器的实例。
参数
title
string
直播活动的标题。此字段为必填。如果字符串的长度超过255个字节，则该字符串将被截断，并且最后3个字节将替换为“…”。
返回值
设置了title的LiveEventBuilder对象。
抛出
如果在此生成器实例已经构建过一次对象之后再次调用该函数。
抛出
如果传入的字符串不是有效的UTF-8格式。
Last updated: 2025年9月30日
