Control

制御用のプローブデータ収集SDK APIを以下に示します。

activate

本APIにより、プローブデータ収集SDKは動作を開始します。

本APIの設定パラメータにより、プローブデータ収集SDKの動作状態を設定できます。

本APIにより、プローブデータ収集SDKは以下の動作を開始します。

• OSからの内部データの収集を開始。
• 配信用タイマーの動作を開始。
• 本API以外のプローブデータ収集SDK APIに対する正常動作を開始。

本APIのパラメータにより、以下の、クラウドサーバへの配信条件を設定できます。

• 配信先クラウドサーバのURL

• 配信周期[秒]

• 配信データに付帯する認証用パラメータ(認証用キー種別と、認証用キー)。

  ※認証用パラメータが未設定の場合、配信動作は行いません。

  ※本APIにて認証用パラメータが未設定の場合、updateKeyにて、配信動作を開始できます。

• 配信データ種別で指定するデータ種別だけを配信します。

本APIは、プローブデータ収集SDKの動作を開始する前にのみ有効です。

本APIで設定したパラメータを変更する場合は、一度deactivateでプローブデータ収集SDKを終了して、再度activateをしてください。

本APIの設定パラメータと戻り値の詳細は、Table.4.1.1 ~ Table.4.1.7 を参照してください。

fun sendActivate(){
	var request = SdkRequest(
		SdkAuthKey(
			SdkAuthKey.SDK_APIKEY,
			"確保したAPIキー"
		),
		vehicleId="車両ID",
		URL="https://example.com/receive/",
		uploadInterval=60,
		UploadDataType(
			SENSOR_INFO,NAVI_INFO,ROUTE_ACTION_LOG
		),
	)

	val result = sdk.activate(request)
}

result = sdk.activate(request: .init(
	authKey: token != "nil" ? SdkAuthKey(type: .API_KEY, value: token) : nil,
	vehicleId: vehicleId != "nil" ? vehicleId : nil,
	url: url,
	uploadInterval: Int(uploadIntervalString)!,
	uploadDataTypes: uploadDataTypes
))

deactivate

本APIにより、プローブデータ収集SDKは動作を終了します。

プローブデータ収集SDKの利用を終了する場合は、必ず本APIを呼び出してください。

本APIは、プローブデータ収集SDKが動作している時のみ有効です。

本APIの戻り値の詳細は、Table.4.1.1 ~ Table.4.1.7 を参照してください。

fun sendDeactivate(){
	val result = sdk.deactivate()
}

sdk.deactivate()

updateKey

本APIの設定パラメータにより、認証用パラメータを更新することができます。

本APIは、プローブデータ収集SDKが動作している時のみ有効です。

activateで認証用パラメータが未設定の場合は、本APIで定期配信が開始されます。

認証用キー種別は、activate、updateKeyで、同一にしてください。

本APIの設定パラメータと戻り値の詳細は、Table.4.1.1 ~ Table.4.1.7 を参照してください。

fun sendUpdateKey(){
	val key = SdkAuthKey{
		keyType=SdkAuthKey.API_KEY,
		keyValue="キーの値",
	}

	val result = sdk.updateKey(key)
}

result = sdk.updateKey(.init(
	type: .API_KEY,
	value: key
))

checkHealth

本APIは、プローブデータ収集SDKの動作に必須ではありません。

本APIにより、プローブデータ収集SDKの動作状態の確認ができます。

詳細フラグがfalseの場合は、戻り値のstatusCodeだけが有効で、それ以外の引数は無効です。

詳細フラグがtrueの場合は、全ての引数が有効です。

本APIの設定パラメータと戻り値の詳細は、Table.4.1.1 ~ Table.4.1.7 を参照してください。

fun sendCheckHealth(){

	val sdkHealthInfo = sdk.checkHealth(needDetails = true)
	if( sdkHealthInfo.statusCode == SdkResult.OK){
		//OK時の処理
	}
	else{
		//NG時の処理

		if( sdkHealthInfo.xxx == false ){
			//xxxがfalse時の処理
		}
	}
}

healthInfo = sdk.checkHealth(needDetails: needDetails)

setVehicleId

本APIは、プローブデータ収集SDKの動作に必須ではありません。

本APIによりvehicleId(車両を識別するID)が設定できます。

vehicleIdは、配信データに付帯データとして毎回付与されます。

vehicleIdが未指定の場合でも配信されます。

本APIの設定パラメータと戻り値の詳細は、Table.4.1.1 ~ Table.4.1.7 を参照してください。

fun sendSetVehicleId(){

	val vehicleId = "車両ID番号"

	val result = sdk.setVehicleId(vehicleId)
}

result = sdk.setVehicleId(vehicleId)

setContext[Androidのみ]

本APIによりプローブデータ収集SDKが使用するcontextを設定します。

本APIはactivate前に必ず設定してください。

fun onCreate(){

	val context : Context = android.content.Context

	sdk.setContext(context)
}

requestLocationPermission[iOSのみ]

本APIにより位置情報取得に関する権限を要求します。

本APIはactivate前に必ず設定してください。

await sdk.requestLocationPermission()

requestActivityPermission[iOSのみ]

本APIによりアクティビティ情報取得に関する権限を要求します。

本APIはactivate前に必ず設定してください。

await sdk.requestActivityPermission()

startBackgroundPositioning[iOSのみ]

本APIによりバックグラウンド実行時の位置情報更新を有効にします。

sdk.startBackgroundPositioning()

stopBackgroundPositioning[iOSのみ]

本APIによりバックグラウンド実行時の位置情報更新を無効にします。

sdk.stopBackgroundPositioning()

isBackgroundPositioning[iOSのみ]

本APIによりバックグラウンド実行時の位置情報更新の状態を取得します。

status = sdk.isBackgroundPositioning()