com.docomostar.system.AutoPositioningParam
|
|||||||||
| 前のクラス 次のクラス | フレームあり フレームなし | ||||||||
| 概要: 入れ子 | フィールド | コンストラクタ | メソッド | 詳細: フィールド | コンストラクタ | メソッド | ||||||||
Object
public final class AutoPositioningParam
制御情報のパラメータを定義するクラスです。
このクラスでは、制御情報の各パラメータの値の設定および設定されている値の取得を行う機能を提供します。
設定および取得が可能なパラメータは以下の通りです。
| パラメータ名 | 説明 |
|---|---|
| 自動測位利用アプリ名 | 端末上で表示する自動測位利用アプリの名称を表します。 デフォルトエンコーディングで評価して最大 20 バイトの文字列を指定できます。 このパラメータは必ず指定しなければいけません。 |
| 位置情報通知先 URL | 自動測位機能により測位された位置情報の通知先を表します。 デフォルトエンコーディングで評価して最大 512 バイトの文字列を指定できます。 有効なプロトコルスキームは http のみです。 設定可能なホストとポートは、ダウンロード元URLのホストとポート、またはそれ以外でパーミッションによりHTTP通信が許可されているホストとポートを設定します。 このパラメータは必ず指定しなければいけません。 |
| 位置情報通知停止期間 | 制御情報の登録が完了した時点から何時間後に通知を開始するかを表します。
1 〜 24 の整数または定数
NOTIFICATION_PERMANENTLY、NOTIFICATION_NEVER を指定できます。
1 〜 24 の整数を指定した場合、制御情報の登録が完了した時点でその制御情報に基づいた自動測位を停止し、
指定した時間が経過すると自動測位を開始します。
停止期間を設けずに通知を継続する場合は、
NOTIFICATION_PERMANENTLY を指定します。
また、制御情報が更新されるまで停止し続ける場合は、
NOTIFICATION_NEVER を指定します。 |
| フリー領域 | コンテンツプロバイダが任意で設定したデータを表します。 このパラメータは、位置情報とともに通知されます。 デフォルトエンコーディングで評価して最大 128 バイトの文字列を指定できます。 空文字列を指定した場合は、null が指定されたものとして扱われます。 |
自動測位機能を利用するためには、
AutoPositioningParam オブジェクトを AutoPositioning.setParameter(AutoPositioningParam) メソッドで登録する必要があります。
AutoPositioning| フィールドの概要 | |
|---|---|
static int |
NOTIFICATION_NEVER
位置情報通知停止期間を規定する定数の一つで、位置情報通知を無期限停止することを表します(=-1)。 |
static int |
NOTIFICATION_PERMANENTLY
位置情報通知停止期間を規定する定数の一つで、位置情報通知を継続することを表します(=0)。 |
| コンストラクタの概要 | |
|---|---|
AutoPositioningParam(String appName,
String url)
新規の制御情報のパラメータを生成します。 |
|
AutoPositioningParam(String appName,
String url,
int stopTime,
String description)
新規の制御情報のパラメータを生成します。 |
|
| メソッドの概要 | |
|---|---|
String |
getAppName()
自動測位利用アプリ名を取得します。 |
String |
getDescription()
フリー領域に設定されている文字列を取得します。 |
String |
getNotificationURL()
位置情報通知先 URL を取得します。 |
int |
getStopTime()
位置情報通知停止期間を取得します。 |
void |
setAppName(String appName)
自動測位利用アプリ名を設定します。 |
void |
setDescription(String description)
フリー領域に文字列を設定します。 |
void |
setNotificationURL(String url)
位置情報通知先 URL を設定します。 |
void |
setStopTime(int stopTime)
位置情報通知停止期間を設定します。 |
| クラス Object から継承されたメソッド |
|---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| フィールドの詳細 |
|---|
public static final int NOTIFICATION_PERMANENTLY
位置情報通知停止期間を規定する定数の一つで、位置情報通知を継続することを表します(=0)。
public static final int NOTIFICATION_NEVER
位置情報通知停止期間を規定する定数の一つで、位置情報通知を無期限停止することを表します(=-1)。
| コンストラクタの詳細 |
|---|
public AutoPositioningParam(String appName,
String url)
新規の制御情報のパラメータを生成します。
このコンストラクタは AutoPositioningParam(appName, url, NOTIFICATION_PERMANENTLY, null)
と等価です。
appName - 自動測位利用アプリ名を指定します。url - 位置情報通知先 URL を指定します。
UnsupportedOperationException -
NullPointerException -
NullPointerException -
IllegalArgumentException -
IllegalArgumentException -
Connector.open(String) を呼び出すと
IllegalArgumentException が発生する場合Connector.open(String) を呼び出すと
ConnectionNotFoundException が発生する場合SecurityException -
public AutoPositioningParam(String appName,
String url,
int stopTime,
String description)
新規の制御情報のパラメータを生成します。 パラメータは引数で指定される内容で初期化されます。 パラメータの詳細は、クラス説明を参照してください。
端末によっては、自動測位機能をサポートしていない場合があります。 その場合には、例外 UnsupportedOperationException が発生します。
appName - 自動測位利用アプリ名を指定します。url - 位置情報通知先 URL を指定します。stopTime - 位置情報通知停止期間を指定します。description - フリー領域を指定します。
UnsupportedOperationException -
NullPointerException -
NullPointerException -
IllegalArgumentException -
IllegalArgumentException -
Connector.open(String) を呼び出すと
IllegalArgumentException が発生する場合Connector.open(String) を呼び出すと
ConnectionNotFoundException が発生する場合IllegalArgumentException -
IllegalArgumentException -
SecurityException -
| メソッドの詳細 |
|---|
public void setAppName(String appName)
自動測位利用アプリ名を設定します。 パラメータの詳細は、クラス説明を参照してください。
appName - 自動測位利用アプリ名 を指定します。
NullPointerException -
IllegalArgumentException -
public void setNotificationURL(String url)
位置情報通知先 URL を設定します。 パラメータの詳細は、クラス説明を参照してください。
url - 通知先の URL を指定します。
NullPointerException -
IllegalArgumentException -
Connector.open(String) を呼び出すと
IllegalArgumentException が発生する場合Connector.open(String) を呼び出すと
ConnectionNotFoundException が発生する場合SecurityException -
public void setStopTime(int stopTime)
位置情報通知停止期間を設定します。 パラメータの詳細は、クラス説明を参照してください。
停止することなく位置情報通知を継続する場合は
NOTIFICATION_PERMANENTLY、
位置情報通知を無期限停止する場合は
NOTIFICATION_NEVER
を引数 stopTime に指定してください。
stopTime - 位置情報通知停止期間を指定します。
IllegalArgumentException -
public void setDescription(String description)
フリー領域に文字列を設定します。 パラメータの詳細は、クラス説明を参照してください。
description - フリー領域の文字列を指定します。
IllegalArgumentException -
public String getAppName()
自動測位利用アプリ名を取得します。
public String getNotificationURL()
位置情報通知先 URL を取得します。
public int getStopTime()
位置情報通知停止期間を取得します。
public String getDescription()
フリー領域に設定されている文字列を取得します。 フリー領域が設定されていない場合は null を返します。
|
|||||||||
| 前のクラス 次のクラス |
フレームあり>getAppNamepublic String getAppName()
| ||||||||