com.nttdocomo.system
クラス Alarm

Object
  com.nttdocomo.system.Alarm

public final class Alarm

extends Object

携帯電話のネイティブのアラーム機能にアクセスする手段を提供します。 このクラスのインスタンスは、 携帯電話のネイティブのアラームの 1 つのエントリを表しますが、 インスタンスを取得する手段はありません。

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

addEntry の戻り値について:

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

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

[DoJa-4.1 (902iS) まで]
端末によっては、i アプリからのアラーム設定がサポートされていない場合があります。
[DoJa-5.0 (903i) 以降]
全ての端末が、i アプリからのアラーム設定をサポートしています。

導入されたバージョン:

DoJa-4.1 (902i)

メソッドの概要

static boolean	addEntry(ScheduleDate date) ユーザ操作によりアラームを新規登録します。
static int	getSupportedTypes() アラームに設定可能なスケジュール時刻のタイプを取得します。

クラス Object から継承したメソッド

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

メソッドの詳細

getSupportedTypes

public static int getSupportedTypes()

アラームに設定可能なスケジュール時刻のタイプを取得します。

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

戻り値:

アラームに設定可能なスケジュール時刻のタイプを返します。

例外:

UnsupportedOperationException - [DoJa-4.1 (902iS) まで] 端末がこのメソッドをサポートしていない場合に発生します。

addEntry

public static boolean addEntry(ScheduleDate date)
                        throws InterruptedOperationException

ユーザ操作によりアラームを新規登録します。

date 引数が null の場合、 アラーム登録画面が起動された日付が指定されたことになります。 その場合に時刻がいつに設定されるかは機種依存です。

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

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

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

パラメータ:

date - アラームを鳴らす日時を指定します。

戻り値:

登録が成功したか否かを返します。 登録が成功した場合にのみ、true を返します。 ユーザが登録操作をキャンセルした場合、false を返します。

例外:

UnsupportedOperationException - [DoJa-4.1 (902iS) まで] 端末がこのメソッドをサポートしていない場合に発生します。

IllegalStateException - ダウンロード即起動アプリがこのメソッドを呼び出した場合に発生します。

IllegalStateException - 待ち受け実行時の非活性化状態で呼び出された場合に発生します。

IllegalArgumentException - サポートされない日時指定タイプの起動時刻を指定した場合に発生します。

IllegalArgumentException - サポートされない範囲の日時の起動時刻 (例えば、1900年など)を指定した場合に発生します。

SecurityException - ADF に AccessUserInfo キーの指定がないアプリケーションが このメソッドを呼び出した場合に発生します。

SecurityException - ロック機能などのネイティブ独自のセキュリティ設定により、 アラームを登録できない場合に発生します。

InterruptedOperationException - 競合条件などにより、登録操作が異常終了した場合に発生します。