PhoneBookGroup (DoJa 3.5 (APIリファレンス))

概要

パッケージ

クラス

階層ツリー

非推奨 API

索引

ヘルプ

前のクラス 次のクラス

フレームあり フレームなし

概要: 入れ子 | フィールド | コンストラクタ | メソッド

詳細: フィールド | コンストラクタ | メソッド

com.nttdocomo.system
クラス PhoneBookGroup

Object
  |
  +--com.nttdocomo.system.PhoneBookGroup

public final class PhoneBookGroup
extends Object

携帯電話のネイティブの電話帳グループ機能にアクセスする手段を提供します。

電話帳グループデータの取得および新規登録機能を提供します。ネイティブデータへのアクセス機能およびそのXObjectとの関係の基本については、 XObjectクラスの説明を参照してください。

selectEntryメソッドを実行することにより、ネイティブのユーザインタフェースを介して、端末に登録されている電話帳グループの一覧から電話帳グループのエントリを取得することができます。取得されたエントリには、電話帳グループのエントリID、グループ名(XString)が設定されています。

電話帳グループを新規に登録するためには、 addEntry メソッドにグループ名を通常の文字列で渡します。登録はネイティブのユーザインタフェースを介して行われ、 addEntryメソッドは戻り値として登録されたエントリのIDを返します。このエントリIDを使用して、 getEntry メソッドによりユーザ操作なしに登録した電話帳グループエントリを取得したり、 PhoneBookクラスで電話帳グループを指定して電話帳データの新規登録を行うことが可能です。

導入されたバージョン:: DoJa-3.0
関連項目:: 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

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

取得されたエントリには、 ID、名前(XString) が設定されています。

パーミッションとして携帯電話情報の参照が許可されているトラステッドiアプリのみこのメソッドを呼び出すことができます。このメソッドを呼び出すとサスペンドします。

戻り値:: 取得した電話帳グループのエントリを返します。ユーザが選択操作をキャンセルするとnullを返します。また、選択可能なエントリが存在しない場合にもnullを返します。
例外:: IllegalStateException - 待ち受け実行時の非活性化状態で呼び出された場合に発生します。; SecurityException - パーミッションとして携帯電話情報の参照が許可されているが、 iアプリ個別のユーザ設定により許可されない場合に発生します。; SecurityException - ロック機能などのネイティブ独自のセキュリティ設定により、電話帳グループエントリを取得できない場合に発生します。; InterruptedOperationException - 競合条件などにより、選択操作が異常終了した場合に発生します。

getEntry

public static PhoneBookGroup getEntry(int id)
                               throws StoreException

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

取得されたエントリには、 ID、名前(XString) が設定されています。

パーミッションとして携帯電話情報の参照が許可されているトラステッドiアプリのみこのメソッドを呼び出すことができます。

パラメータ:: id - 電話帳グループのIDを指定します。
戻り値:: 取得した電話帳グループのエントリを返します。
例外:: SecurityException - パーミッションとして携帯電話情報の参照が許可されているが、 iアプリ個別のユーザ設定により許可されない場合に発生します。; SecurityException - ロック機能などのネイティブ独自のセキュリティ設定により、電話帳グループエントリを取得できない場合に発生します。; StoreException - 指定したIDのグループが存在しない場合に発生します(NOT_FOUND)。
関連項目:: addEntry(String), getId()

addEntry

public static int addEntry(String name)
                    throws InterruptedOperationException

ユーザ操作により電話帳グループを新規登録します。引数には null を指定することができます。

ADFにAccessUserInfoキーの指定が必要です。このメソッドを呼び出すとサスペンドします。

パラメータ:: name - 名前(通常文字列)を指定します。
戻り値:: 登録されたグループのIDを返します。ユーザが登録操作をキャンセルした場合、-1 を返します。
例外:: IllegalStateException - ダウンロード即起動アプリがこのメソッドを呼び出した場合に発生します。; IllegalStateException - 待ち受け実行時の非活性化状態で呼び出された場合に発生します。; SecurityException - ADFにAccessUserInfoキーの指定がないアプリケーションがこのメソッドを呼び出した場合に発生します。; SecurityException - ロック機能などのネイティブ独自のセキュリティ設定により、電話帳グループの登録ができない場合に発生します。; InterruptedOperationException - 競合条件などにより、登録操作が異常終了した場合に発生します。

getId

public int getId()

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

戻り値:: 電話帳グループのIDを返します。

getName

public XString getName()

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

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

概要