com.nttdocomo.system
クラス PhoneBookGroup

Object
  com.nttdocomo.system.PhoneBookGroup

public final class PhoneBookGroup

extends Object

携帯電話のネイティブの電話帳グループ管理機能にアクセスする手段を提供します。 このクラスのインスタンスは、 携帯電話のネイティブの電話帳グループの 1 つのエントリを表します。

このクラスに定義されているクラスメソッドの使い方や、 ネイティブのデータへのアクセス方法に関する規定の大原則は com.nttdocomo.system パッケージの記述を参照して下さい。

電話帳グループエントリからは、 電話帳グループのエントリ ID、ならびに電話帳グループ名(XString)が、 それぞれ取得できます。

導入されたバージョン:

DoJa-3.0 (505i)

関連項目:

PhoneBook

メソッドの概要

static int	addEntry(String name) ユーザ操作により電話帳グループを新規登録します。
static PhoneBookGroup	getEntry(int id) 電話帳グループのエントリ ID を指定して、 ユーザ操作なしに電話帳グループのエントリを取得します。
int	getId() 電話帳グループのエントリ ID を取得します。
XString	getName() 電話帳グループの名前(XString)を取得します。
static PhoneBookGroup	selectEntry() ユーザ操作により電話帳グループのエントリを取得します。

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

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

メソッドの詳細

selectEntry

public static PhoneBookGroup selectEntry()
                                  throws InterruptedOperationException

ユーザ操作により電話帳グループのエントリを取得します。

パーミッションとして携帯電話情報の参照が許可されている トラステッドiアプリのみこのメソッドを呼び出すことができます。 上記以外の動作の詳細については com.nttdocomo.system パッケージに記述されている 「エントリ取得時の振る舞い」の説明を参照して下さい。

戻り値:

取得した電話帳グループのエントリを返します。 ユーザが選択操作をキャンセルするとnullを返します。 また、選択可能なエントリが存在しない場合にもnullを返します。

例外:

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

SecurityException - パーミッションとして携帯電話情報の参照が許可されているが、 iアプリ個別のユーザ設定により許可されない場合に発生します。

SecurityException - ロック機能などのネイティブ独自のセキュリティ設定により、 電話帳グループエントリを取得できない場合に発生します。

IllegalStateException - [DoJa-4.0 (901i) 以降] FOMA端末で、UIM読み込み中の場合に発生します。

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

getEntry

public static PhoneBookGroup getEntry(int id)
                               throws StoreException

電話帳グループのエントリ ID を指定して、 ユーザ操作なしに電話帳グループのエントリを取得します。

パーミッションとして携帯電話情報の参照が許可されている トラステッドiアプリのみこのメソッドを呼び出すことができます。 上記以外の動作の詳細については com.nttdocomo.system パッケージに記述されている 「エントリ取得時の振る舞い」の説明を参照して下さい。

パラメータ:

id - 電話帳グループのエントリ ID を指定します。

戻り値:

取得した電話帳グループのエントリを返します。

例外:

SecurityException - パーミッションとして携帯電話情報の参照が許可されているが、 iアプリ個別のユーザ設定により許可されない場合に発生します。

SecurityException - ロック機能などのネイティブ独自のセキュリティ設定により、 電話帳グループエントリを取得できない場合に発生します。

StoreException - 指定したIDのグループが存在しない場合に発生します(NOT_FOUND)。

IllegalStateException - [DoJa-4.0 (901i) 以降] FOMA端末で、UIM読み込み中の場合に発生します。

関連項目:

addEntry(String), getId()

addEntry

public static int addEntry(String name)
                    throws InterruptedOperationException

ユーザ操作により電話帳グループを新規登録します。

ADFにAccessUserInfoキーの指定が必要です。 上記以外の動作の詳細については com.nttdocomo.system パッケージの記述を参照して下さい。

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

パラメータ:

name - 名前(通常文字列)を指定します。

戻り値:

登録された電話帳グループのエントリ ID を返します。 ユーザが登録操作をキャンセルした場合、-1 を返します。

例外:

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

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

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

SecurityException - ロック機能などのネイティブ独自のセキュリティ設定により、 電話帳グループの登録ができない場合に発生します。

IllegalStateException - [DoJa-4.0 (901i) 以降] FOMA端末で、UIM読み込み中の場合に発生します。

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

getId

public int getId()

電話帳グループのエントリ ID を取得します。

戻り値:

電話帳グループのエントリ ID を返します。

getName

public XString getName()

電話帳グループの名前(XString)を取得します。

戻り値:

名前を返します。 名前が登録されていない場合、空文字列を表すXStringを返します。