com.nttdocomo.system
クラス DecomailTemplateStore

Object
  com.nttdocomo.system.DecomailTemplateStore

public final class DecomailTemplateStore

extends Object

[iアプリオプションAPI]

携帯電話のネイティブのデコメールテンプレート管理機能にアクセスする手段を提供します。

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

エントリ登録時の文字列の扱いについて
このクラスでは、文字列の扱いは大原則ではなく、 デコメールテンプレートのフォーマットの仕様に従います。 インライン画像数が上限を超えた場合も含めて、 この仕様に準拠していない場合には例外が発生します。

導入されたバージョン:

DoJa-5.0 (903i)

メソッドの概要

static int	addEntry(String templateData) ユーザ操作によりデコメールテンプレートを新規登録します。
StringBuffer	getDecomailTemplate() エントリのデコメールテンプレートを取得します。
static DecomailTemplateStore	getEntry(int id) デコメールテンプレートのエントリを取得します。
int	getId() デコメールテンプレートのエントリIDを取得します。
static DecomailTemplateStore	selectEntry() ユーザ操作によりデコメールテンプレートのエントリを取得します。

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

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

メソッドの詳細

addEntry

public static int addEntry(String templateData)
                    throws InterruptedOperationException

ユーザ操作によりデコメールテンプレートを新規登録します。

ADF に AccessUserInfo キーの指定が必要です。

デコメールテンプレートは、登録時にネイティブにより整形されます。 インライン画像以外の添付ファイルが設定されていた場合には、 その添付ファイルは登録時に削除されます。

なお、登録が完了した場合には、このメソッドは 登録されたエントリ ID を返します。 ユーザが登録操作をキャンセルした場合には -1 を返します。 また、データ保存領域の容量を超えているために登録できない場合は、 ユーザが登録操作をキャンセルした場合と同様の値を返します。

引数 templateData が、デコメールテンプレートの仕様に準拠していない場合に、 デコメールテンプレートを整形し処理が続行されるか、 例外 IllegalArgumentException が発生するかは機種依存です。

端末によっては、 i アプリからデコメールテンプレートを利用する機能をサポートしていない場合があります。 その場合には、例外 UnsupportedOperationException が発生します。

パラメータ:

templateData - 登録するデコメールテンプレートの文字列を指定します。

戻り値:

登録されたエントリの ID を返します。 ユーザが登録操作をキャンセルした場合には -1 を返します。

例外:

UnsupportedOperationException - 端末が i アプリからデコメールテンプレートを利用する機能をサポートしていない場合に発生します。

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

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

NullPointerException - 引数 templateData が null の場合に発生します。

IllegalArgumentException - 引数 templateData が、デコメールテンプレートの仕様に準拠していない場合に発生します。

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

SecurityException - ロック機能などのネイティブ独自のセキュリティ設定により、 デコメールテンプレートを登録できない場合に発生します。

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

selectEntry

public static DecomailTemplateStore selectEntry()
                                         throws InterruptedOperationException

ユーザ操作によりデコメールテンプレートのエントリを取得します。

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

端末によっては、 i アプリからデコメールテンプレートを利用する機能をサポートしていない場合があります。 その場合には、例外 UnsupportedOperationException が発生します。

戻り値:

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

例外:

UnsupportedOperationException - 端末が i アプリからデコメールテンプレートを利用する機能をサポートしていない場合に発生します。

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

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

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

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

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

getEntry

public static DecomailTemplateStore getEntry(int id)
                                      throws StoreException

デコメールテンプレートのエントリを取得します。

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

端末によっては、 i アプリからデコメールテンプレートを利用する機能をサポートしていない場合があります。 その場合には、例外 UnsupportedOperationException が発生します。

パラメータ:

id - 取得するデコメールテンプレートのエントリ ID を指定します。

戻り値:

取得したデコメールテンプレートのエントリを返します。

例外:

UnsupportedOperationException - 端末が i アプリからデコメールテンプレートを利用する機能をサポートしていない場合に発生します。

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

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

SecurityException -

ロック機能などのネイティブ独自のセキュリティ設定により、 デコメールテンプレートのエントリを取得できない場合に発生します。
以下の場合も含みます。

• UIM 内情報を用いた実行制限がかけられている場合
• 指定された ID のデコメールテンプレートが、 このアプリケーション自身が保存したものでない場合

StoreException - 指定された ID のデコメールテンプレートのエントリが存在しない場合に発生します(NOT_FOUND)。

getId

public int getId()

デコメールテンプレートのエントリIDを取得します。

戻り値:

デコメールテンプレートのエントリIDを返します。

getDecomailTemplate

public StringBuffer getDecomailTemplate()

エントリのデコメールテンプレートを取得します。

このメソッドで取得するデコメールテンプレートには、 テキストパートは含まれません。 なお、 このデコメールテンプレートとaddEntry(String) の引数で指定したデコメールテンプレートが、 完全一致するかどうかは機種依存です。

戻り値:

デコメールテンプレートを文字列バッファで返します。