Constructor
new TvSchedules(client)
A constructor to initialize TvSchedules instance.
NOTICE: This module is a part of DimoraClient module. You should not to call this constructor as directly.
TvSchedules の インスタンスを初期化するためのコンストラクタ。
お知らせ: このモジュールは DimoraClient モジュールの一部です。このコンストラクタは直接呼び出さないでください。
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
client |
DimoraClient
|
An instance of DimoraClient module |
Methods
fetch(filter, callback)
A method to fetch a list of the scheduled Tv programs
放送が予定されているテレビ番組のリストを取得するメソッド
放送が予定されているテレビ番組のリストを取得するメソッド
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
filter |
TvSchedules~fetchFilter
|
A filter conditions |
callback |
TvSchedules~fetchCallback
|
An callback function |
Type Definitions
fetchCallback(error, items)
Callback of fetch(...) method
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
error |
Error
|
An error object (If something happened) |
items |
Array.<TvScheduleItem>
|
An array of TV program schedules |
fetchFilter
Filter conditions for fetch(...) method
Properties:
| Name | Type | Attributes | Description |
|---|---|---|---|
keyword |
String
|
A keyword | |
channelTypes |
Array.<String>
|
<optional> |
A channel type (multiple values are supported) Available values: 'TE' (地上デジタル), 'BS' (BSデジタル), 'CS' (CSデジタル) |
- Source:
Type:
-
Object