LiveEventオブジェクトのインスタンスを作成するビルダー。
拡張
Builder
コンストラクタ
new LiveEventBuilder()
new LiveEventBuilder(): LiveEventBuilder戻り値
LiveEventBuilderメソッド
attributes()
attributes(attributes:string[]): LiveEventBuilder
ライブイベントビルダーでライブイベントの属性を設定し、ビルダーのインスタンスを返します。
パラメーター
attributes
string[]
ライブイベントのプロパティ。このフィールドで推奨される標準値のリストについては、開発者ガイドを参照してください。このフィールドは任意ですが、わかっている場合は必ず入力する必要があります。リストの最大サイズは32です。アイテムが32個を超える場合、余分なアイテムは削除されます。各項目の最大サイズは255バイトです。この長さを超える項目は切り捨てられ、最後の3バイトは「…」に置き換えられます。
エラー
- このビルダーインスタンスで既にオブジェクトを1回ビルドした後にこの関数を呼び出すと、IllegalStateErrorがスローされます。
- 有効なUTF-8ではない文字列が渡されると、InvalidArgumentErrorがスローされます。
戻り値
LiveEventBuilder ILiveEventBuilder：attributesに値が設定されたLiveEventBuilderオブジェクト。
build()
build(): ILiveEvent 指定されたパラメーターからLiveEventオブジェクトをビルドします。この関数は、他のビルダー関数を使用してライブイベントビルダーの目的のフィールドを設定した後に、呼び出す必要があります。build() 関数は、ビルダーオブジェクトごとに1回だけ呼び出す必要があります。
エラー
- 必須フィールドが1つ以上欠落していると、InvalidArgumentErrorがスローされます。
- このビルダーインスタンスで既にオブジェクトを1回ビルドした後にこの関数を呼び出すと、
IllegalStateErrorがスローされます。
戻り値
ILiveEvent iLiveEvent：ビルドされたLiveEventオブジェクト。
description()
description(description:string): LiveEventBuilder
ライブイベントビルダーでライブイベントの説明を設定し、ビルダーのインスタンスを返します。
パラメーター
説明
string
ライブイベントの簡単な説明。このフィールドは省略可能です。文字列の長さが8192バイトを超えると文字列は切り捨てられ、最後の3バイトは「…」に置き換えられます。
エラー
- このビルダーインスタンスで既にオブジェクトを1回ビルドした後にこの関数を呼び出すと、IllegalStateErrorがスローされます。
- 有効なUTF-8ではない文字列が渡されると、InvalidArgumentErrorがスローされます。
戻り値
LiveEventBuilder ILiveEventBuilder：descriptionに値が設定されたLiveEventBuilderオブジェクト。
endTimeMs()
endTimeMs(endTimeMs:number): LiveEventBuilder
ライブイベントビルダーでライブイベントの終了時刻を設定し、ビルダーのインスタンスを返します。
パラメーター
endTimeMs
number
ライブイベントの終了時刻（エポックミリ秒単位）。このフィールドは、過去または将来の値を表すことができます。eventTypeがSCHEDULED_EVENTの場合、このフィールドは必須です。
エラー
- このビルダーインスタンスで既にオブジェクトを1回ビルドした後にこの関数を呼び出すと、IllegalStateErrorがスローされます。
戻り値
LiveEventBuilder ILiveEventBuilder：endTimeMsに値が設定されたLiveEventBuilderオブジェクト。
eventType()
eventType(eventType: EventType): LiveEventBuilder ライブイベントビルダーでライブイベントのタイプを設定し、ビルダーのインスタンスを返します。パラメーター
eventType
EventType ライブイベントのタイプ。このフィールドは必須です。エラー
- このビルダーインスタンスで既にオブジェクトを1回ビルドした後にこの関数を呼び出すと、IllegalStateErrorがスローされます。
戻り値
LiveEventBuilder ILiveEventBuilder：eventTypeに値が設定されたLiveEventBuilderオブジェクト。
genres()
genres(genres:string[]): LiveEventBuilder
ライブイベントビルダーでライブイベントのジャンルを設定し、ビルダーのインスタンスを返します。
パラメーター
genres
string[]
ライブイベントに適用されるジャンルのリスト。このフィールドで推奨される標準値のリストについては、開発者ガイドを参照してください。ジャンルを指定するかどうかは任意ですが、わかっている場合は必ず提供する必要があります。リストの最大サイズは32です。アイテムが32個を超える場合、余分なアイテムは削除されます。各項目の最大サイズは255バイトです。この長さを超える項目は切り捨てられ、最後の3バイトは「…」に置き換えられます。
エラー
- このビルダーインスタンスで既にオブジェクトを1回ビルドした後にこの関数を呼び出すと、IllegalStateErrorがスローされます。
- 有効なUTF-8ではない文字列が渡されると、InvalidArgumentErrorがスローされます。
戻り値
LiveEventBuilder ILiveEventBuilder：genresに値が設定されたLiveEventBuilderオブジェクト。
identifier()
identifier(identifier:string): LiveEventBuilder
ライブイベントビルダーでライブイベントの一意の識別子を設定し、ビルダーのインスタンスを返します。
パラメーター
identifier
string
特定のライブイベントの一意の識別子。この識別子は、アプリケーションパッケージ内のすべてのライブイベントで一意である必要があります。特定のライブイベントの更新時に、この識別子は変更しないでください。このフィールドは必須で、最大長は8192バイトです。
エラー
- このビルダーインスタンスで既にオブジェクトを1回ビルドした後にこの関数を呼び出すと、IllegalStateErrorがスローされます。
- フィールドが最大長の8192バイトを超えると、InvalidArgumentErrorがスローされます。
- 有効なUTF-8ではない文字列が渡されると、InvalidArgumentErrorがスローされます。
戻り値
LiveEventBuilder ILiveEventBuilder：identifierに値が設定されたLiveEventBuilderオブジェクト。
logoUrl()
logoUrl(logoUrl:string): LiveEventBuilder
ライブイベントビルダーでライブイベントのロゴURLを設定し、ビルダーのインスタンスを返します。
パラメーター
logoUrl
string
ライブイベントのロゴが表示されるURL。このフィールドは省略可能です。このフィールドの最大長は8192バイトです。
エラー
- このビルダーインスタンスで既にオブジェクトを1回ビルドした後にこの関数を呼び出すと、IllegalStateErrorがスローされます。
- フィールドが最大長の8192バイトを超えると、InvalidArgumentErrorがスローされます。
- 有効なUTF-8ではない文字列が渡されると、InvalidArgumentErrorがスローされます。
戻り値
LiveEventBuilder ILiveEventBuilder：logoUrlに値が設定されたLiveEventBuilderオブジェクト。
playbackReference
playbackReference(playbackReference: IPlaybackReference): LiveEventBuilder ライブイベントビルダーでライブイベントの再生リファレンスを設定し、ビルダーのインスタンスを返します。パラメーター
playbackReference
IPlaybackReference ライブイベントの再生リファレンス。再生を開始する方法が記述されています。このフィールドは必須です。エラー
- このビルダーインスタンスで既にオブジェクトを1回ビルドした後にこの関数を呼び出すと、IllegalStateErrorがスローされます。
戻り値
LiveEventBuilder ILiveEventBuilder：playbackReferenceに値が設定されたLiveEventBuilderオブジェクト。
posterArtUrl()
posterArtUrl(posterArtUrl:string): LiveEventBuilder
ライブイベントビルダーでライブイベントのポスターアートURLを設定し、ビルダーのインスタンスを返します。
パラメーター
posterArtUrl()
string
ポスターアート画像が表示されるURL。このフィールドは省略可能です。このフィールドの最大長は8192バイトです。
エラー
- このビルダーインスタンスで既にオブジェクトを1回ビルドした後にこの関数を呼び出すと、IllegalStateErrorがスローされます。
- フィールドが最大長の8192バイトを超えると、InvalidArgumentErrorがスローされます。
- 有効なUTF-8ではない文字列が渡されると、InvalidArgumentErrorがスローされます。
戻り値
LiveEventBuilder ILiveEventBuilder：posterArtUrlに値が設定されたLiveEventBuilderオブジェクト。
ratings()
ratings(ratings:string[]): LiveEventBuilder
ライブイベントビルダーでライブイベントのレーティングを設定し、ビルダーのインスタンスを返します。
パラメーター
ratings
string[]
特定のライブイベントで推奨される保護者による指導レベルを示すために使用される文字列のリスト。ライブイベントが放送される国や地域で使用されている任意のレーティングシステムに従うことができます。保護者による指導のレーティングを指定するかどうかは任意ですが、わかっている場合は必ず提供する必要があります。このフィールドで推奨される標準値のリストについては、開発者ガイドを参照してください。リストの最大サイズは32です。アイテムが32個を超える場合、余分なアイテムは削除されます。各項目の最大サイズは255バイトです。この長さを超える項目は切り捨てられ、最後の3バイトは「…」に置き換えられます。
エラー
- このビルダーインスタンスで既にオブジェクトを1回ビルドした後にこの関数を呼び出すと、IllegalStateErrorがスローされます。
- 有効なUTF-8ではない文字列が渡されると、InvalidArgumentErrorがスローされます。
戻り値
LiveEventBuilder ILiveEventBuilder：ratingsに値が設定されたLiveEventBuilderオブジェクト。
sortRank()
sortRank(sortRank:number): LiveEventBuilder
ライブイベントビルダーのライブイベントの並べ替えランクを設定し、ビルダーのインスタンスを返す関数（任意）。
このアプリの行では、並べ替えランクの整数値が小さいライブイベントが、並べ替えランクの値が大きいライブイベントよりも前に表示されます。指定しない場合、このフィールドはデフォルトでMAX Int32に設定されます。並べ替えランクが同じライブイベントが複数ある場合は、タイトルのアルファベット順に並べられます。
パラメーター
sortRank
number
このライブイベントを他のライブイベントと比較した場合の並べ替えランク。
エラー
- このビルダーインスタンスで既にオブジェクトを1回ビルドした後にこの関数を呼び出すと、
IllegalStateErrorがスローされます。
戻り値
LiveEventBuilder LiveEventBuilder：並べ替えランクが設定されたLiveEventBuilderオブジェクト。
startTimeMs()
startTimeMs(startTimeMs:number): LiveEventBuilder
ライブイベントビルダーでライブイベントの開始時刻を設定し、ビルダーのインスタンスを返します。
パラメーター
startTimeMs
number
ライブイベントの開始時刻（エポックミリ秒単位）。このフィールドは、過去または将来の値を表すことができます。eventTypeがSCHEDULED_EVENTの場合、このフィールドは必須です。
エラー
- このビルダーインスタンスで既にオブジェクトを1回ビルドした後にこの関数を呼び出すと、IllegalStateErrorがスローされます。
戻り値
LiveEventBuilder ILiveEventBuilder：startTimeMsに値が設定されたLiveEventBuilderオブジェクト。
title()
title(title:string): LiveEventBuilder
ライブイベントビルダーでライブイベントのタイトルを設定し、ビルダーのインスタンスを返します。
パラメーター
title
string
ライブイベントのタイトル。このフィールドは必須です。文字列の長さが255バイトを超えると文字列は切り捨てられ、最後の3バイトは「…」に置き換えられます。
エラー
- このビルダーインスタンスで既にオブジェクトを1回ビルドした後にこの関数を呼び出すと、IllegalStateErrorがスローされます。
- 有効なUTF-8ではない文字列が渡されると、InvalidArgumentErrorがスローされます。
戻り値
LiveEventBuilder ILiveEventBuilder：titleに値が設定されたLiveEventBuilderオブジェクト。
