用于为 ConferenceData 对象创建的构建器。
方法
| 方法 | 返回值类型 | 简介 |
|---|---|---|
add | Conference | 向此 Conference 添加 Conference。 |
add | Conference | 向此 Conference 添加 Entry。 |
build() | Conference | 构建并验证 Conference。 |
set | Conference | 设置此 Conference 的视频会议 ID。 |
set | Conference | 设置在插件清单中定义的会议解决方案 ID。 |
set | Conference | 设置此 Conference 的 Conference，表明会议
未成功创建。 |
set | Conference | 设置此 Conference 的其他备注，例如
管理员的说明或法律声明。 |
详细文档
addConferenceParameter(conferenceParameter)
向此 ConferenceData 添加 ConferenceParameter。每个 ConferenceData 的参数数量上限为
300。
参数
| 名称 | 类型 | 说明 |
|---|---|---|
conference | Conference | 要添加的参数。 |
返回
ConferenceDataBuilder - 此构建器，用于链式调用。
抛出
Error - 如果提供的会议参数无效，或者添加的会议参数过多。
addEntryPoint(entryPoint)
向此 ConferenceData 添加 EntryPoint。每个 ConferenceData 的入口点数量上限为
300。
参数
| 名称 | 类型 | 说明 |
|---|---|---|
entry | Entry | 要添加的入口点。 |
返回
ConferenceDataBuilder - 此构建器，用于链式调用。
抛出
Error - 如果提供的入口点无效，或者添加的入口点过多。
build()
setConferenceId(conferenceId)
设置此 ConferenceData 的视频会议 ID。此字段的最大长度为 512 个字符。
参数
| 名称 | 类型 | 说明 |
|---|---|---|
conference | String | 要设置的 ID。 |
返回
ConferenceDataBuilder - 此构建器，用于链式调用。
抛出
Error - 如果提供的视频会议 ID 过长。
setConferenceSolutionId(conferenceSolutionId)
设置在插件清单中定义的会议解决方案 ID。必须指定该值，并填充会议的名称和 iconUrl 值。
请注意，该字段是 GSuite 插件所必需的，但对于会议插件，系统会忽略该字段
参数
| 名称 | 类型 | 说明 |
|---|---|---|
conference | String | 与清单匹配的 ID。 |
返回
ConferenceDataBuilder - 此构建器，用于链式调用。
抛出
Error - 如果提供的会议解决方案 ID 过长。此字段的最大
长度为 512 个字符。
setError(conferenceError)
设置此 ConferenceData 的 ConferenceError，表明会议未成功创建。
参数
| 名称 | 类型 | 说明 |
|---|---|---|
conference | Conference | 要设置的错误。 |
返回
ConferenceDataBuilder - 此构建器，用于链式调用。
抛出
Error - 如果提供的错误无效。
setNotes(notes)
设置此 ConferenceData 的其他备注，例如管理员的说明或法律声明。可以包含 HTML。此字段的最大长度为
2048 个字符。
参数
| 名称 | 类型 | 说明 |
|---|---|---|
notes | String | 要设置的其他备注。 |
返回
ConferenceDataBuilder - 此构建器，用于链式调用。
抛出
Error - 如果提供的备注过长。