Programオブジェクトのインスタンスを作成するビルダー。
拡張
Builder
コンストラクタ
new ProgramBuilder()
new ProgramBuilder(): ProgramBuilder戻り値
ProgramBuilderメソッド
attributes()
attributes(attributes:string[]): ProgramBuilder
Programの属性を設定します。
このフィールドは番組では任意です。
パラメーター
attributes
string[]
Programの文字列。このフィールドで推奨される標準値のリストについては、開発者ガイドを参照してください。リストの最大サイズは32です。アイテムが32個を超える場合、余分なアイテムは削除されます。各項目の最大サイズは255バイトです。この長さを超える項目は切り捨てられ、最後の3バイトは「…」に置き換えられます。
エラー
- このビルダーインスタンスで既にオブジェクトを1回ビルドした後にこの関数を呼び出すと、
IllegalStateErrorがスローされます。 - 有効なUTF-8ではない文字列が渡されると、
InvalidArgumentErrorがスローされます。
戻り値
ProgramBuilder ProgramBuilder：属性が設定されたProgramBuilderオブジェクト。
build()
build(): IProgram 指定されたパラメーターからProgramオブジェクトをビルドします。
エラー
- 必須フィールドが1つ以上欠落していると、
InvalidArgumentErrorがスローされます。 - このビルダーインスタンスで既にオブジェクトを1回ビルドした後にこの関数を呼び出すと、
IllegalStateErrorがスローされます。
戻り値
IProgram IProgram：ビルドされたProgramオブジェクト。
channelDescriptor()
channelDescriptor(channelDescriptor: IChannelDescriptor): ProgramBuilder 番組のChannelDescriptorを設定します。
このフィールドは、Programオブジェクトを作成するために必須です。
パラメーター
channelDescriptor()
IChannelDescriptor この番組が放送されているチャンネルを一意に識別する記述子。エラー
- このビルダーインスタンスで既にオブジェクトを1回ビルドした後にこの関数を呼び出すと、
IllegalStateErrorがスローされます。
戻り値
ProgramBuilder ProgramBuilder：ChannelDescriptorに値が設定されたProgramBuilderオブジェクト。
description()
description(description:string): ProgramBuilder
番組の説明を設定します。
このフィールドは任意ですが、わかっている場合は必ず入力する必要があります。
パラメーター
説明
string
特定の番組の簡単な説明。たとえば、エピソードの説明などです。文字列の長さが8192バイトを超えると、文字列は「…」で切り捨てられます。
エラー
- このビルダーインスタンスで既にオブジェクトを1回ビルドした後にこの関数を呼び出すと、
IllegalStateErrorがスローされます。 - 有効なUTF-8ではない文字列が渡されると、
InvalidArgumentErrorがスローされます。
戻り値
ProgramBuilder ProgramBuilder：説明が設定されたProgramBuilderオブジェクト。
endTimeMs()
endTimeMs(endTimeMs:number): ProgramBuilder
番組の終了時刻を設定します。
このフィールドは、Programオブジェクトを作成するために必須です。
パラメーター
endTimeMs
number
番組の終了時刻（エポックミリ秒単位）。このフィールドは、過去または将来の値を表すことができます。
エラー
- このビルダーインスタンスで既にオブジェクトを1回ビルドした後にこの関数を呼び出すと、
IllegalStateErrorがスローされます。
戻り値
ProgramBuilder ProgramBuilder：終了時刻が設定されたProgramBuilderオブジェクト。
genres()
genres(genres:string[]): ProgramBuilder
番組のジャンルを設定します。
このフィールドは任意ですが、わかっている場合は必ず入力する必要があります。
パラメーター
genres
string[]
番組に適用されるジャンルのリスト。このフィールドで推奨される標準値のリストについては、開発者ガイドを参照してください。リストの最大サイズは32です。アイテムが32個を超える場合、余分なアイテムは削除されます。各項目の最大サイズは255バイトです。この長さを超える項目は切り捨てられ、最後の3バイトは「…」に置き換えられます。
エラー
- このビルダーインスタンスで既にオブジェクトを1回ビルドした後にこの関数を呼び出すと、
IllegalStateErrorがスローされます。 - 有効なUTF-8ではない文字列が渡されると、
InvalidArgumentErrorがスローされます。
戻り値
ProgramBuilder ProgramBuilder：ジャンルが設定されたProgramBuilderオブジェクト。
identifier()
identifier(identifier:string): ProgramBuilder
番組の識別子を設定します。
パラメーター
identifier
string
電子番組表リスト内の番組の識別子。このフィールドはProgramをビルドするために必須です。このフィールドの最大長は8192バイトです。
エラー
- このビルダーインスタンスで既にオブジェクトを1回ビルドした後にこの関数を呼び出すと、
IllegalStateErrorがスローされます。 - フィールドが最大長の8192バイトを超えると、
InvalidArgumentErrorがスローされます。 - 有効なUTF-8ではない文字列が渡されると、
InvalidArgumentErrorがスローされます。
戻り値
ProgramBuilder 番組識別子が設定されたProgramBuilderオブジェクト。
posterArtUrl()
posterArtUrl(url:string): ProgramBuilder
番組のポスターアートURLを設定します。
このフィールドは任意ですが、わかっている場合は必ず入力する必要があります。
パラメーター
url
string
エラー
- このビルダーインスタンスで既にオブジェクトを1回ビルドした後にこの関数を呼び出すと、
IllegalStateErrorがスローされます。 - フィールドが最大長の8192を超えると、InvalidArgumentErrorがスローされます。
- 有効なUTF-8ではない文字列が渡されると、
InvalidArgumentErrorがスローされます。
戻り値
ProgramBuilder ProgramBuilder：ポスターアートのURLが設定されたProgramBuilderオブジェクト。
ratings()
ratings(ratings:string[]): ProgramBuilder
番組のレーティングを設定します。
このフィールドは任意ですが、わかっている場合は必ず入力する必要があります。
パラメーター
ratings
string[]
特定の番組で推奨される保護者による指導レベルを示すために使用される文字列のリスト。これには、番組が放送される国または地域で使用されている任意のレーティングシステムに従うことができます。このフィールドで推奨される標準値のリストについては、開発者ガイドを参照してください。リストの最大サイズは32です。アイテムが32個を超える場合、余分なアイテムは削除されます。各項目の最大サイズは255バイトです。この長さを超える項目は切り捨てられ、最後の3バイトは「…」に置き換えられます。
エラー
- このビルダーインスタンスで既にオブジェクトを1回ビルドした後にこの関数を呼び出すと、
IllegalStateErrorがスローされます。 - 有効なUTF-8ではない文字列が渡されると、
InvalidArgumentErrorがスローされます。
戻り値
ProgramBuilder ProgramBuilder：評価が設定されたProgramBuilderオブジェクト。
seriesInfo()
seriesInfo(seriesInfo: ISeriesInfo): ProgramBuilder 番組のシリーズ情報を設定します。このフィールドは任意です。ただし、番組がエピソードを表していて、かつこの情報が入手可能な場合は、必ず入力する必要があります。パラメーター
seriesInfo
ISeriesInfo シーズンやエピソード番号など、番組のシリーズ関連情報。エラー
- このビルダーインスタンスで既にオブジェクトを1回ビルドした後にこの関数を呼び出すと、
IllegalStateErrorがスローされます。
戻り値
ProgramBuilder ProgramBuilder：seriesInfoに値が設定されたProgramBuilderオブジェクト。
startTimeMs()
startTimeMs(starTime:number): ProgramBuilder
番組の開始時刻を設定します。
このフィールドは、Programオブジェクトを作成するために必須です。
パラメーター
starTime
number
エラー
- このビルダーインスタンスで既にオブジェクトを1回ビルドした後にこの関数を呼び出すと、
IllegalStateErrorがスローされます。
戻り値
ProgramBuilder ProgramBuilder：開始時刻が設定されたProgramBuilderオブジェクト。
subtitle()
subtitle(subtitle:string): ProgramBuilder
番組のサブタイトルを設定します。
このフィールドは任意ですが、該当する場合やわかっている場合は必ず入力する必要があります。
パラメーター
subtitle
string
特定の番組のサブタイトル。たとえば、「MCIS: Los Angeles」のエピソード名である「Maybe Today」など。文字列の長さが255バイトを超えると文字列は切り捨てられ、最後の3バイトは「…」に置き換えられます。
エラー
- このビルダーインスタンスで既にオブジェクトを1回ビルドした後にこの関数を呼び出すと、
IllegalStateErrorがスローされます。 - 有効なUTF-8ではない文字列が渡されると、
InvalidArgumentErrorがスローされます。
戻り値
ProgramBuilder ProgramBuilder：字幕が設定されたProgramBuilderオブジェクト。
thumbnailUrl()
thumbnailUrl(url:string): ProgramBuilder
番組のサムネイルURLを設定します。
このフィールドは任意ですが、わかっている場合は必ず入力する必要があります。
パラメーター
url
string
エラー
- このビルダーインスタンスで既にオブジェクトを1回ビルドした後にこの関数を呼び出すと、
IllegalStateErrorがスローされます。 - フィールドが最大長の8192バイトを超えると、
InvalidArgumentErrorがスローされます。 - 有効なUTF-8ではない文字列が渡されると、
InvalidArgumentErrorがスローされます。
戻り値
ProgramBuilder ProgramBuilder：サムネイルURLが設定されたProgramBuilderオブジェクト。
title()
title(title:string): ProgramBuilder
番組のタイトルを設定します。
このフィールドは、Programオブジェクトを作成するために必須です。
パラメーター
title
string
特定の番組のタイトルまたは名前。たとえば、「MCIS: Los Angeles」など。文字列の長さが255バイトを超えると文字列は切り捨てられ、最後の3バイトは「…」に置き換えられます。
エラー
- このビルダーインスタンスで既にオブジェクトを1回ビルドした後にこの関数を呼び出すと、
IllegalStateErrorがスローされます。 - 有効なUTF-8ではない文字列が渡されると、
InvalidArgumentErrorがスローされます。
戻り値
ProgramBuilder ProgramBuilder：タイトルが設定されたProgramBuilderオブジェクト。
