概要  パッケージ   クラス  階層ツリー  非推奨 API  索引  ヘルプ 
 前のクラス   次のクラス フレームあり    フレームなし    
概要:  入れ子 | フィールド | コンストラクタ | メソッド 詳細:  フィールド | コンストラクタ | メソッド

com.nttdocomo.system
クラス DTVSchedule

Object
  拡張com.nttdocomo.system.DTVSchedule
public final class DTVSchedule
extends Object
 [iアプリオプションAPI]

携帯電話のネイティブの (デジタルテレビ)視聴/録画予約スケジューラ機能にアクセスする手段を提供します。 このクラスのインスタンスは、 携帯電話のネイティブの視聴/録画予約スケジュールデータの 1 つのエントリを表しますが、 インスタンスを取得する手段はありません。

このクラスに定義されているクラスメソッドの使い方や、 ネイティブのデータへのアクセス方法に関する規定の大原則は com.nttdocomo.system パッケージの記述を参照して下さい。 ただし、エントリ取得機能 (selectEntry、getEntry) は提供されず、 エントリ登録機能 (addEntry(int, int, String, ScheduleDate, String)、addEntry(int, DTVScheduleParam)) についても、 下記の点が大原則と異なります。

addEntry の戻り値について:
このクラスにおいては、addEntryの戻り値として、 エントリ ID ではなく、登録成否を表す論理値が返されます。

エントリ登録時に、引数に渡す ScheduleDate または DTVScheduleParam オブジェクトの設定により、 「1回限り」 「毎日」 「毎週」 「毎月」 「毎年」のスケジュール時刻を設定できます。 ただし、 サポートされるスケジュールタイプは、 ネイティブの視聴/録画予約スケジューラ機能に依存します。 この端末でサポートされるスケジュールタイプを取得するには、 getSupportedTypes()、getSupportedTypes(int) を利用して下さい。

ミニマムスペック:
  • ミニマムスペックでは、「1回限り」のスケジュール時刻を設定可能です。
[DoJa-5.0 (903iTV) 以降]
録画予約スケジュールを新規登録することができます。

導入されたバージョン:
DoJa-4.0 (901iTV)、DoJa-5.1 (905i)

フィールドの概要
static int AFFILIATION_ID_NONE
          系列識別が未指定であることを表します(=-1)。
static int FREQUENCY_NONE
          物理チャンネルが未指定であることを表します(=-1)。
static int SERVICE_ID_NONE
          サービス識別が未指定であることを表します(=-1)。
static int TYPE_RECORD
          録画予約を表します(=1)。
static int TYPE_WATCH
          視聴予約を表します(=0)。
 
メソッドの概要
static boolean addEntry(int type, DTVScheduleParam param)
          予約タイプを指定して、ユーザ操作により視聴/録画予約スケジュールを新規登録します。
static boolean addEntry(int frequency, int serviceId, String serviceName, ScheduleDate startTime, String eventName)
          推奨されていません。  DoJa-5.0 (903iTV) 以降では、 addEntry(int, DTVScheduleParam) に置き換えられました。
static int getSupportedTypes()
          視聴予約においてサポートしているスケジュール時刻のタイプを取得します。
static int getSupportedTypes(int type)
          予約タイプを指定して、 視聴/録画予約においてサポートしているスケジュール時刻のタイプを取得します。
 
クラス Object から継承したメソッド
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

フィールドの詳細

FREQUENCY_NONE

public static final int FREQUENCY_NONE
物理チャンネルが未指定であることを表します(=-1)。

導入されたバージョン:
DoJa-5.0 (903iTV)、DoJa-5.1 (905i)
関連項目:
定数フィールド値

SERVICE_ID_NONE

public static final int SERVICE_ID_NONE
サービス識別が未指定であることを表します(=-1)。

関連項目:
定数フィールド値

AFFILIATION_ID_NONE

public static final int AFFILIATION_ID_NONE
系列識別が未指定であることを表します(=-1)。

導入されたバージョン:
DoJa-5.0 (903iTV)、DoJa-5.1 (905i)
関連項目:
定数フィールド値

TYPE_WATCH

public static final int TYPE_WATCH
視聴予約を表します(=0)。

導入されたバージョン:
DoJa-5.0 (903iTV)、DoJa-5.1 (905i)
関連項目:
定数フィールド値

TYPE_RECORD

public static final int TYPE_RECORD
録画予約を表します(=1)。

導入されたバージョン:
DoJa-5.0 (903iTV)、DoJa-5.1 (905i)
関連項目:
定数フィールド値
メソッドの詳細

getSupportedTypes

public static int getSupportedTypes()
視聴予約においてサポートしているスケジュール時刻のタイプを取得します。

このメソッドの振る舞いは、getSupportedTypes(int) の引数に TYPE_WATCH が指定された場合と同じです。

戻り値:
サポートしているスケジュール時刻のタイプを返します。
例外:
UnsupportedOperationException - [DoJa-5.1 (905i) 以降] 端末がデジタルテレビ機能をサポートしていない場合に発生します。
UnsupportedOperationException - [DoJa-5.1 (905i) 以降] デジタルテレビ機能はサポートしていても、 視聴/録画予約スケジューラ機能をサポートしていない場合に発生します。

getSupportedTypes

public static int getSupportedTypes(int type)
予約タイプを指定して、 視聴/録画予約においてサポートしているスケジュール時刻のタイプを取得します。

予約タイプに TYPE_WATCH を指定すると視聴予約において、 TYPE_RECORD を指定すると録画予約において、 それぞれサポートしているスケジュール時刻のタイプを取得できます。

このメソッドは ScheduleDate.ONETIME、 ScheduleDate.DAILY、 ScheduleDate.WEEKLY、 ScheduleDate.MONTHLY、 ScheduleDate.YEARLY のうち、 サポートされているスケジュール時刻タイプ(日時指定タイプ)の論理和を返します。 例えば、「1回限り」「毎日」「毎週」をサポートしている場合、
7( = ONETIME|DAILY|WEEKLY)
が返ります。

パラメータ:
type - 予約タイプを指定します。
戻り値:
サポートしているスケジュール時刻のタイプを返します。
例外:
UnsupportedOperationException - [DoJa-5.1 (905i) 以降] 端末がデジタルテレビ機能をサポートしていない場合に発生します。
UnsupportedOperationException - [DoJa-5.1 (905i) 以降] デジタルテレビ機能はサポートしていても、 視聴/録画予約スケジューラ機能をサポートしていない場合に発生します。
IllegalArgumentException - 引数 type に不正な値が指定された場合に発生します。
導入されたバージョン:
DoJa-5.0 (903iTV)、DoJa-5.1 (905i)

addEntry

public static boolean addEntry(int frequency,
                               int serviceId,
                               String serviceName,
                               ScheduleDate startTime,
                               String eventName)
                        throws InterruptedOperationException
推奨されていません。  DoJa-5.0 (903iTV) 以降では、 addEntry(int, DTVScheduleParam) に置き換えられました。

ユーザ操作により視聴予約スケジュールを新規登録します。

引数 startTime には null を指定できません。 指定した場合は例外が発生します。

ADFにAccessUserInfoキーの指定が必要です。 上記以外の動作の詳細については、このクラスの説明、 ならびに、その説明から引用されている com.nttdocomo.system パッケージに記述されている説明を参照して下さい。

データ保存領域の容量を超えているために登録できない場合は、 ユーザが登録操作をキャンセルした場合と同様の値を返します。

[DoJa-5.1 (905i) 以降]
このメソッドは、引数 startTime の時間フィールドに設定されている値を、 ネイティブの視聴予約スケジュール機能にそのまま渡します。 すなわち、ScheduleDate オブジェクトにはタイムゾーン情報がないため、 同オブジェクトに設定されている日時はローカルタイムとして渡されます。

パラメータ:
frequency - 物理チャンネルを指定します。 13 以上 62 以下の値を指定できます。
serviceId - サービス識別を指定します。 0 以上 216 -1 以下の値を指定できます。 サービス識別を指定したくない場合は SERVICE_ID_NONE を指定します。
serviceName - チャンネル名(通常文字列)を指定します。null を指定可能です。
startTime - 番組開始時刻を指定します。null は指定できません。
eventName - 番組名(通常文字列)を指定します。 null を指定可能です。
戻り値:
登録が成功したか否かを返します。 登録が成功した場合にのみ、true を返します。 ユーザが登録操作をキャンセルした場合、false を返します。
例外:
UnsupportedOperationException - [DoJa-5.1 (905i) 以降] 端末がデジタルテレビ機能をサポートしていない場合に発生します。
UnsupportedOperationException - [DoJa-5.1 (905i) 以降] デジタルテレビ機能はサポートしていても、 視聴/録画予約スケジューラ機能をサポートしていない場合に発生します。
IllegalStateException - ダウンロード即起動アプリがこのメソッドを呼び出した場合に発生します。
IllegalStateException - 待ち受け実行時の非活性化状態で呼び出された場合に発生します。
NullPointerException - 引数 startTime が null の場合に発生します。
IllegalArgumentException - 引数 frequency に 13 より小さい値、または 62 より大きい値が指定された場合に発生します。
IllegalArgumentException - 引数 serviceId に -1 より小さい値、 または 216 -1 より大きい値が指定された場合に発生します。
IllegalArgumentException - サポートされない日時指定タイプの番組開始時刻を 指定した場合に発生します。
IllegalArgumentException - サポートされない範囲の日時の起動時刻 (例えば、1900年など)を指定した場合に発生します。
IllegalArgumentException - [DoJa-4.0 (901iTV) まで] 端末の現在時刻が指定した番組開始時刻を過ぎている場合、または、 端末の現在時刻と指定した番組開始時刻が同時刻（年/月/時/分の一致）である場合に発生します。 端末の現在時刻が設定されていない場合にも発生します。
[DoJa-5.0 (903iTV) 以降] 端末の現在時刻が設定されていない場合にのみ発生します。
SecurityException - ADFにAccessUserInfoキーの指定がないアプリケーションが このメソッドを呼び出した場合に発生します。
SecurityException - ロック機能などのネイティブ独自のセキュリティ設定により、 スケジュールを登録できない場合に発生します。
InterruptedOperationException - 競合条件などにより、登録操作が異常終了した場合に発生します。

addEntry

public static boolean addEntry(int type,
                               DTVScheduleParam param)
                        throws InterruptedOperationException
予約タイプを指定して、ユーザ操作により視聴/録画予約スケジュールを新規登録します。

予約タイプに TYPE_WATCH を指定すると視聴予約スケジュールを、 TYPE_RECORD を指定すると録画予約スケジュールをそれぞれ新規登録します。 各予約タイプにおいてパラメータに指定すべき項目は下記表の通りになります。 指定必須の項目に null や「未指定を表す値」を指定した場合は例外が発生します。

パラメータ項目視聴予約録画予約
物理チャンネルM (※1)M (※1)
サービス識別
系列識別
チャンネル名OO
番組開始時刻MM
番組終了時刻- (※2)M
繰り返しタイプMM
番組名OO
[凡例] "M"=指定必須、"O"=指定オプション、"-"=指定不要
(※1) 少なくともいずれか 1 つは指定しなければなりません。
(※2) 指定しても無視されます。

ADF に AccessUserInfo キーの指定が必要です。 上記以外の動作の詳細については、このクラスの説明、 ならびに、その説明から引用されている com.nttdocomo.system パッケージに記述されている説明を参照して下さい。

データ保存領域の容量を超えているために登録できない場合は、 ユーザが登録操作をキャンセルした場合と同様の値を返します。

[DoJa-5.1 (905i) 以降]
このメソッドは、引数 param に設定されている「番組開始時刻」「番組終了時刻」について、 Calendar オブジェクトの時間フィールドに設定されている値を、 そのままネイティブの視聴/録画予約スケジュール機能に渡します。 すなわち、Calendar オブジェクトに設定されているタイムゾーンは無視され、 同オブジェクトに設定されている日時はローカルタイムとして渡されます。

パラメータ:
type - 予約タイプを指定します。 TYPE_WATCH、TYPE_RECORD を指定可能です。
param - 予約スケジュールのパラメータを指定します。
戻り値:
登録が成功したか否かを返します。 登録が成功した場合にのみ、true を返 title="com.nttdocomo.system 蜀