Class ConferenceDataBuilder

ConferenceDataBuilder

用于为 ConferenceData 对象创建的构建器。

详细文档

addConferenceParameter(conferenceParameter)

向此 ConferenceData 添加 ConferenceParameter。每个 ConferenceData 的参数数量上限为 300。

参数

名称类型说明
conferenceParameterConferenceParameter要添加的参数。

返回

ConferenceDataBuilder - 此构建器,用于链接。

抛出

Error - 如果提供的会议参数无效,或者添加的会议参数过多。


addEntryPoint(entryPoint)

向此 ConferenceData 添加 EntryPoint。每个 ConferenceData 的入口点数量上限为 300。

参数

名称类型说明
entryPointEntryPoint要添加的入口点。

返回

ConferenceDataBuilder - 此构建器,用于链接。

抛出

Error - 如果提供的入口点无效,或者添加的入口点过多。


build()

构建并验证 ConferenceData

返回

ConferenceData - 经过验证的会议数据

抛出

Error - 如果构建的会议数据无效。


setConferenceId(conferenceId)

设置此 ConferenceData 的会议 ID。此字段的长度上限为 512 个字符。

参数

名称类型说明
conferenceIdString要设置的 ID。

返回

ConferenceDataBuilder - 此构建器,用于链接。

抛出

Error - 如果提供的会议 ID 过长。


setConferenceSolutionId(conferenceSolutionId)

设置插件清单中定义的会议解决方案 ID。必须指定此值,并填充会议的名称和 iconUrl 值。

请注意,对于 G Suite 插件,此字段是必填字段,而对于会议插件,该字段会被忽略。

参数

名称类型说明
conferenceSolutionIdString与清单匹配的 ID。

返回

ConferenceDataBuilder - 此构建器,用于链接。

抛出

Error - 如果提供的会议解决方案 ID 过长。此字段的长度上限为 512 个字符。


setError(conferenceError)

设置此 ConferenceDataConferenceError,表示会议未成功创建。

参数

名称类型说明
conferenceErrorConferenceError要设置的错误。

返回

ConferenceDataBuilder - 此构建器,用于链接。

抛出

Error - 如果提供的错误无效。


setNotes(notes)

设置此 ConferenceData 的其他备注,例如管理员的说明或法律声明。可以包含 HTML。此字段的长度上限为 2048 个字符。

参数

名称类型说明
notesString要设置的其他备注。

返回

ConferenceDataBuilder - 此构建器,用于链接。

抛出

Error - 如果提供的备注过长。