関数 getHealthDataRecords

getHealthDataRecords(
sdk: SDKInstance,
arg: GetHealthDataRecordsToApp,
): Promise<GetHealthDataRecordsToSdk | PacketErrorData>
指定した集計区間のヘルスデータを取得する

iOSではヘルスケア、Androidではヘルスコネクトから取得します。事前にrequestPermissionでヘルスデータ機能の実行権限を要求する必要があります。

totalCalorieはAndroidのみ利用できます。iOSではbaseCalorieとactiveCalorieの合計を利用してください。

返却値の単位は次のとおりです。
- step: 歩数
- distance: km
- activeCalorie: kcal
- baseCalorie: kcal
- totalCalorie: kcal
- height: m
- weight: kg
パラメータ
- sdk: SDKInstance
- arg: GetHealthDataRecordsToApp
戻り値 Promise<GetHealthDataRecordsToSdk | PacketErrorData>
エラーレスポンス
以下は例外ではなく、PacketErrorDataとしてPromiseがresolveされます。
- ERRORS.SUBSCRIPTION_REQUIRED: サービスをサブスクライブしていない場合
- ERRORS.LIGHT_USERS_NOT_SUPPORTED: この機能を利用できないユーザーの場合
- ERRORS.SERVICE_NOT_REQUESTING_PERMISSION: サービスがヘルスデータ機能の実行権限を要求していない場合
- ERRORS.SERVICE_PERMISSION_NOT_GRANTED: ユーザーがヘルスデータ機能の実行権限を許可していない場合
- ERRORS.DEVICE_SETTINGS_NOT_SATISFIED: 端末のヘルス機能が利用できない場合
- ERRORS.APP_PERMISSION_DENIED: ポケットサインアプリに必要な権限がない場合
- ERRORS.DEVICE_UNABLE_TO_PROCESS: 端末がヘルスデータの取得を処理できない場合
- ERRORS.INVALID_ARGUMENT: 指定したデータ種別が端末でサポートされていない場合
- ERRORS.NETWORK_ERROR: サーバーとの通信に失敗した場合
- ERRORS.SERVER_INTERNAL_ERROR: サーバー内部でエラーが発生した場合
- ERRORS.SERVER_ERROR: サーバーからエラーが返された場合
- ERRORS.INVALID_PACKET_DATA_SCHEMA: 引数が所定の形式を満たさない場合
- ERRORS.UNHANDLED_ERROR: 予期しないエラーが発生した場合
例外
- ERRORS.INVALID_SDK_ARGUMENT: SDKインスタンスが不正な場合に同期的にthrowされます。
- ERRORS.APP_BACKEND_API_NOT_SUPPORTED_YET: 利用中のアプリがこのAPIに対応していない場合にPromiseがrejectされます。
- ERRORS.APP_BACKEND_INVOKE_TIMEOUT: アプリからの応答がタイムアウトした場合にPromiseがrejectされます。

関数 getHealthDataRecords

パラメータ

戻り値 Promise<GetHealthDataRecordsToSdk | PacketErrorData>

エラーレスポンス

例外

テーマ設定