com.docomostar.system
クラス AvatarStore

Object
  com.docomostar.system.AvatarStore

public final class AvatarStore
extends Object

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

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

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

導入されたバージョン:

Star-1.0

メソッドの概要

static int	addEntry(AvatarData avatar) ユーザ操作によりアバターデータを新規登録します。
static int	selectEntryId() ユーザ操作によりアバターデータのエントリIDを取得します。

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

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

メソッドの詳細

selectEntryId

public static int selectEntryId()
                         throws InterruptedOperationException

ユーザ操作によりアバターデータのエントリIDを取得します。

このメソッドで得られたエントリ ID を PhoneTheme.setImageTheme(int, int) メソッドの引数に指定することにより、 そのエントリのアバターデータをテレビ電話通話中の代替画像に設定することができます。

パーミッションとしてテーマ設定が許可されている トラステッドStar アプリのみこのメソッドを呼び出すことができます。 上記以外の動作の詳細については、 com.docomostar.system パッケージに記述されている説明を参照してください。

端末によっては、このメソッドをサポートしていない場合があります。 その場合には、例外 UnsupportedOperationException が発生します。

戻り値:

取得したアバターデータのエントリIDを返します。 ユーザが選択操作をキャンセルすると -1 を返します。 また、選択可能なエントリが存在しない場合にも -1 を返します。

例外:

UnsupportedOperationException -
端末がこのメソッドをサポートしていない場合に発生します。

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

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

addEntry

public static int addEntry(AvatarData avatar)
                    throws InterruptedOperationException

ユーザ操作によりアバターデータを新規登録します。

引数に指定されたアバターデータが保持している再配布可能かどうかの設定のままで保存されます。

パーミッションとしてテーマ設定が許可されている トラステッドStar アプリのみこのメソッドを呼び出すことができます。 上記以外の動作の詳細については、 com.docomostar.system パッケージに記述されている説明を参照して下さい。

端末によっては、このメソッドをサポートしていない場合があります。 その場合には、例外 UnsupportedOperationException が発生します。

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

パラメータ:

avatar - 登録するアバターデータを指定します。

戻り値:

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

例外:

UnsupportedOperationException -
端末がこのメソッドをサポートしていない場合に発生します。

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

MediaException -
(UNSUPPORTED_FORMAT)
引数の avatar にシステムが提供している以外のアバターデータ (AvatarDataインタフェースを実装した未知のクラスのオブジェクト) が渡された場合に発生します。

MediaException -
(ILLEGAL_STATE)
指定されているアバターデータが use 状態でない場合に発生します。

MediaException -
(ILLEGAL_STATE)
指定されているアバターデータ利用が「一度きり」 である場合に発生します。

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

MediaException -
(UNSUPPORTED_FORMAT)
指定されたアバターデータのデータサイズが、 登録可能なデータサイズ(bytes)よりも大きい場合に発生します。

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