com.docomostar.system
クラス Invitation

Object
  com.docomostar.system.Invitation

public final class Invitation
extends Object

招集機能を提供するクラスです。

招集機能は、他の端末にインストールされている Star アプリを起動する機能を提供します。

招集メッセージ送信処理
他の端末にインストールされている Star アプリを起動したい場合、 sendLaunchRequest(InvitationParam) メソッドを利用します。sendLaunchRequest(InvitationParam) メソッドを実行すると、 招集対象の端末に対して、招集メッセージが送信されます。

招集メッセージ受信処理
端末に対して招集メッセージが着信すると、招集対象のアプリケーションが起動されます。 招集起動の対象となる Star アプリは、 パーミッションとしてｉアプリコールの利用が許可されているアプリです。 招集メッセージ内に含まれている 招集アプリケーションIDと、 招集先の端末にインストールされている Star アプリに設定されている招集アプリケーションIDが一致した場合、 招集対象の Star アプリとしてアプリケーションが起動されます。

招集メッセージ着信時に、招集対象の Star アプリが起動中だった場合、 招集イベントが発生し、対応するリスナが呼び出されます。

招集メッセージ着信時に、招集対象の Star アプリが起動されていなかった場合、 招集対象の Star アプリが、 StarApplication.LAUNCHED_BY_INVITE_MESSAGE の起動タイプで起動されます。 その場合、 StarApplicationManager.getPushedEvent(int) を呼び出すことで招集イベントを取得できます。

導入されたバージョン:

Star-1.0

関連項目:

InvitationParam, InvitedEvent

メソッドの概要

static boolean

sendLaunchRequest(InvitationParam param) 他の端末にインストールされている Star アプリに対して起動要求を送信します。

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

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

メソッドの詳細

sendLaunchRequest

public static boolean sendLaunchRequest(InvitationParam param)
                                 throws InvitationException

他の端末にインストールされている Star アプリに対して起動要求を送信します。

このメソッドを実行すると、Star アプリはサスペンドせずに起動要求の送信を行います。 このメソッドはブロッキングメソッドです。起動要求送信の成否に関係なく、処理が完了するまで、このメソッドは戻りません。

起動要求の送信処理においてサーバが正常応答を返した場合、true を返します。 送信処理中にサーバがエラーを返した場合、 InvitationException をスローします。 その他の場合(ユーザによるキャンセル処理が行われた場合や、パケット規制中の場合など)は、false を返します。

このメソッドは複数同時に実行することはできません。 また、このメソッドでは内部的に HTTP 通信を行うため HttpConnection と同時に使用することはできません。 HttpConnection によるコネクション使用中、及びこのメソッド実行中にこのメソッドが呼ばれると InvitationException がスローされます。

引数 param に含まれる 招集元のアプリケーション名 が設定されていない場合は、 招集元のアプリケーション名として、このアプリの ADF の AppName キーの値が使用されます。 また、引数 param に含まれる 招集先の電話番号 がこの端末の電話帳に登録されていない場合は例外が発生します。

本メソッドは ADF の UseNetwork キー、及び パーミッションとしてｉアプリコールの利用を許可されたトラステッド Star アプリからのみ使用可能です。 ADF に UseNetwork キーを指定していないアプリケーションから使用された場合、例外が発生します。 パーミッションとしてｉアプリコールの利用を許可されていないアプリケーションから使用された場合、アプリケーションは強制終了します。

パラメータ:

param - 招集パラメータを指定します。

戻り値:

送信が正常に完了した場合、true を返します。 それ以外の場合、false を返します。

例外:

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

SecurityException -
ADF に UseNetwork キーの指定がないアプリケーションから呼び出された場合に発生します。

SecurityException -
ADF に UseNetwork キーが指定されているが、 Star アプリ個別のユーザ設定により許可されない場合に発生します。

SecurityException -
ロック機能などのネイティブ独自のセキュリティ設定により、 起動要求を送信できない場合に発生します。

SecurityException -
引数 param に含まれる招集先の電話番号が、この端末の電話帳に登録されていない場合に発生します。

InvitationException -
(BUSY_RESOURCE)
現在実行中の Star アプリにおいて、 既にパケット通信中の場合に発生します。

InvitationException -
(RESPONSE_ERROR)
サーバからの応答が不正な場合に発生します。