com.docomostar.system
クラス InvitationParam

Object
  上位を拡張 com.docomostar.system.InvitationParam

public final class InvitationParam
extends Object

招集機能による起動要求送信用のパラメータを定義します。

導入されたバージョン:
Star-1.0
関連項目:
Invitation

フィールドの概要
static int DOWNLOAD_DIRECTLY
          招集先の端末に招集対象のアプリケーションが存在しない場合の振る舞いを規定する定数の一つで、 直接ダウンロードすることを表します(=1)。
static int DOWNLOAD_FROM_BROWSER
          招集先の端末に招集対象のアプリケーションが存在しない場合の振る舞いを規定する定数の一つで、 ダウンロードサイトへ誘導することを表します(=2)。
static int NO_DOWNLOAD
          招集先の端末に招集対象のアプリケーションが存在しない場合の振る舞いを規定する定数の一つで、 ダウンロードは行わないことを表します(=0)。
 
コンストラクタの概要
InvitationParam(String launcherAppName, XString phoneNumber, int expiration, String param, int downloadBehavior)
          招集機能による起動要求送信用に招集パラメータを生成します。
 
メソッドの概要
 int getDownloadBehavior()
          招集先の端末に招集対象のアプリケーションが存在しない場合の振る舞いを取得します。
 int getExpiration()
          招集の有効期限を取得します。
 String getLauncherAppName()
          招集元のアプリケーション名を取得します。
 String getLaunchParameter()
          起動パラメータを取得します。
 XString getRecipient()
          招集対象の端末の電話番号を取得します。
 void setDownloadBehavior(int downloadBehavior)
          招集先の端末に招集対象のアプリケーションが存在しない場合の振る舞いを設定します。
 void setExpiration(int expiration)
          招集の有効期限を設定します。
 void setLauncherAppName(String launcherAppName)
          招集元のアプリケーション名を設定します。
 void setLaunchParameter(String param)
          起動パラメータを設定します。
 void setRecipient(XString phoneNumber)
          電話番号を指定して、招集対象の端末を設定します。
 
クラス Object から継承されたメソッド
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

フィールドの詳細

NO_DOWNLOAD

public static final int NO_DOWNLOAD
招集先の端末に招集対象のアプリケーションが存在しない場合の振る舞いを規定する定数の一つで、 ダウンロードは行わないことを表します(=0)。

招集先の端末に招集対象のアプリケーションがダウンロードされていない状況で、 NO_DOWNLOAD が設定された招集メッセージが着信した場合、 招集対象のアプリケーションのダウンロードを試みることはありません。

関連項目:
定数フィールド値

DOWNLOAD_DIRECTLY

public static final int DOWNLOAD_DIRECTLY
招集先の端末に招集対象のアプリケーションが存在しない場合の振る舞いを規定する定数の一つで、 直接ダウンロードすることを表します(=1)。

招集先の端末に招集対象のアプリケーションがダウンロードされていない状況で、 DOWNLOAD_DIRECTLY が設定された招集メッセージが着信すると、 招集先の端末は、 アプリケーションマネージャ から招集対象のアプリケーションを直接ダウンロードすることができます。

関連項目:
定数フィールド値

DOWNLOAD_FROM_BROWSER

public static final int DOWNLOAD_FROM_BROWSER
招集先の端末に招集対象のアプリケーションが存在しない場合の振る舞いを規定する定数の一つで、 ダウンロードサイトへ誘導することを表します(=2)。

招集先の端末に招集対象のアプリケーションがダウンロードされていない状況で、 DOWNLOAD_FROM_BROWSER が設定された招集メッセージが着信すると、 招集先の端末において i-mode ブラウザが起動し、招集対象のアプリケーションのダウンロードサイトへ接続されます。 招集先の端末は、 ダウンロードサイトから招集対象のアプリケーションをダウンロードすることができます。

関連項目:
定数フィールド値
コンストラクタの詳細

InvitationParam

public InvitationParam(String launcherAppName,
                       XString phoneNumber,
                       int expiration,
                       String param,
                       int downloadBehavior)
招集機能による起動要求送信用に招集パラメータを生成します。 パラメータは引数で指定される内容で初期化されます。

パラメータ:
launcherAppName - 招集元のアプリケーション名を指定します。
phoneNumber - 招集対象の端末の電話番号を指定します。
expiration - 招集の有効期限を秒数で指定します。
param - 起動パラメータを指定します。
downloadBehavior - 招集先の端末に招集対象のアプリケーションが存在しない場合の振る舞いを指定します。
例外:
NullPointerException -
引数 phoneNumber に null が指定された場合に発生します。
IllegalArgumentException -
引数 launcherAppName の長さがデフォルトエンコーディングで評価して 20 バイトを超える場合に発生します。
IllegalArgumentException -
引数 phoneNumber に文字列長が 11 桁以外の XString が指定された場合に発生します。
IllegalArgumentException -
引数 expiration に 15 より小さな値、または 2592000 より大きい値が指定された場合に発生します。
IllegalArgumentException -
引数 param に不正な文字列が指定された場合に発生します。
IllegalArgumentException -
引数 downloadBehavior に不正な値が指定された場合に発生します。
メソッドの詳細

setLauncherAppName

public void setLauncherAppName(String launcherAppName)
招集元のアプリケーション名を設定します。

招集メッセージ着信時、どのアプリケーションから招集要求されたのかを提示するためにこの情報は使用されます。

引数 launcherAppName に null または空文字列が指定された場合、招集元のアプリケーション名は設定されません。 招集元のアプリケーション名が設定されていない状況で 招集機能による起動要求送信 された場合、招集元のアプリケーション名として、 このアプリケーションの ADF の AppName キーの値が使用されます。

注釈: ADF の AppName キーを端末の内部に保存する際に、 ADF の AppName キーの文字列長が 16 バイトよりも長い場合は、値の一部が保存されない場合があるため、 以下のような振る舞いとなることに注意してください。
  • 端末に保存されている AppName キーの値が 20 バイト以下の場合、 端末に保存されている AppName キーの値が、招集元のアプリケーション名として使用されます。
  • 端末に保存されている AppName キーの値が 20 バイトよりも長い場合、 先頭から 20 バイト分のデータのみが招集元のアプリケーション名として使用され、21 バイト目以降の値は無視されます。 ただし、バイト単位ではなく文字単位で情報の切捨てが行われます。 (20-21バイト目のデータが、2バイト文字だった場合は、20バイト目以降の値は無視されます。)

パラメータ:
launcherAppName - 招集元のアプリケーション名を指定します。アプリケーション名は、デフォルトエンコーディングで評価して 20 バイト以下の文字列を指定する必要があります。
例外:
IllegalArgumentException -
引数 launcherAppName の長さがデフォルトエンコーディングで評価して 20 バイトを超える場合に発生します。

setRecipient

public void setRecipient(XString phoneNumber)
電話番号を指定して、招集対象の端末を設定します。

このメソッド(及びコンストラクタ)の引数 phoneNumber で指定した電話番号の端末に対して、招集メッセージが送信されます。

引数 phoneNumber には 11 桁の XString を指定してください。 引数 phoneNumber の文字列の長さが 11 桁ではない場合、例外が発生します。

また、招集対象の端末の電話番号は、この端末の電話帳に登録されている必要があります。 ただし、招集対象の端末の電話番号が、この端末の電話帳に登録されているかどうかのチェックはこのメソッドでは行いません。 チェックは招集機能による起動要求送信時に行われることに注意してください。

パラメータ:
phoneNumber - 招集対象の端末の電話番号を指定します。
例外:
NullPointerException -
引数 phoneNumber に null が指定された場合に発生します。
IllegalArgumentException -
引数 phoneNumber に文字列長が 11 桁以外の XString が指定された場合に発生します。

setExpiration

public void setExpiration(int expiration)
招集の有効期限を設定します。

招集先の端末に招集メッセージ着信後、引数で指定された秒数が経過すると、その招集は有効期限切れとなります。

パラメータ:
expiration - 招集の有効期限を秒数で指定します。 15 以上〜 2592000 以下の値を指定できます。
例外:
IllegalArgumentException -
引数 expiration に 15 より小さな値、または 2592000 より大きい値が指定された場合に発生します。

setLaunchParameter

public void setLaunchParameter(String param)
起動パラメータを設定します。

引数 param に null を指定した場合、起動パラメータは設定されません。

パラメータ:
param - 起動パラメータを指定します。 ASCII 図形文字 (0x20 〜 0x7E) のみで構成された、 1 文字以上 50 文字以下の文字列が指定できます。 null を指定した場合、起動パラメータは設定されません。
例外:
IllegalArgumentException -
引数 param に不正な文字列が指定された場合に発生します。

setDownloadBehavior

public void setDownloadBehavior(int downloadBehavior)
招集先の端末に招集対象のアプリケーションが存在しない場合の振る舞いを設定します。

引数 downloadBehavior に DOWNLOAD_DIRECTLYDOWNLOAD_FROM_BROWSER が指定された場合、 招集先の端末が招集対象のアプリケーションをダウンロードするように促します。
引数 downloadBehavior に NO_DOWNLOAD が指定された場合、 招集先の端末が招集対象のアプリケーションをダウンロードするように促すことはありません。

招集先の端末に招集対象のアプリケーションが既にインストールされていた場合は、このパラメータは意味を持ちません。

パラメータ:
downloadBehavior - 招集先の端末に招集対象のアプリケーションが存在しない場合の振る舞いを指定します。 NO_DOWNLOADDOWNLOAD_DIRECTLYDOWNLOAD_FROM_BROWSER を指定可能です。
例外:
IllegalArgumentException -
引数 downloadBehavior に不正な値が指定された場合に発生します。

getLauncherAppName

public String getLauncherAppName()
招集元のアプリケーション名を取得します。 招集元のアプリケーション名が設定されていない場合、null が返ります。

戻り値:
招集元のアプリケーション名を返します。

getRecipient

public XString getRecipient()
招集対象の端末の電話番号を取得します。

戻り値:
招集対象の端末の電話番号を返します。

getExpiration

public int getExpiration()
招集の有効期限を取得します。

戻り値:
招集の有効期限を秒数で返します。

getLaunchParameter

public String getLaunchParameter()
起動パラメータを取得します。 起動パラメータが設定されていない場合、null が返ります。

戻り値:
起動パラメータを返します。

getDownloadBehavior

public int getDownloadBehavior()
招集先の端末に招集対象のアプリケーションが存在しない場合の振る舞いを取得します。

戻り値:
招集先の端末に招集対象のアプリケーションが存在しない場合の振る舞いを返します。


NTT DOCOMO,INC.

本製品または文書は著作権法により保護されており、その使用、複製、再頒布および逆コンパイルを制限するライセンスのもとにおいて頒布されます。NTTドコモ(その他に許諾者がある場合は当該許諾者も含めて)の書面による事前の許可なく、本製品および関連する文書のいかなる部分も、いかなる方法によっても複製することが禁じられます。フォントを含む第三者のソフトウェアは、著作権法により保護されており、その提供者からライセンスを受けているものです。

Sun、Sun Microsystems、Java、J2MEおよびJ2SEは、米国およびその他の国における米国 Sun Microsystems,Inc.の商標または登録商標です。サンのロゴマークは、米国 Sun Microsystems, Inc.の登録商標です。

FeliCaは、ソニー株式会社が開発した非接触ICカードの技術方式です。FeliCaは、ソニー株式会社の登録商標です。

「iモード」、「iアプリ/アイアプリ」、「i-αppli」ロゴ、「DoJa」はNTTドコモの商標または登録商標です。

その他記載された会社名、製品名などは該当する各社の商標または登録商標です。