@enduco/nativescript-health-data

ns plugin add @enduco/nativescript-health-data

这是一个 NativeScript 插件，它将 Apple HealthKit 和 Google Fit 进行抽象，以便从用户的设备读取健康数据。

先决条件

Android

Google Fit API 密钥 - 前往 Google 开发者控制台，创建一个项目，并启用 Fitness API。然后在 凭据 选项卡下，为 Android 应用创建一个 Fitness API OAuth2 客户端 ID（选择 用户数据 并点击 我需要哪些凭据？ 按钮）。如果您使用 Linux/maxOS，使用以下代码生成您的 SHA1 密钥。

keytool -exportcert -keystore path-to-debug-or-production-keystore -list -v

请注意，默认（调试）密钥库密码为空。

iOS

确保您已启用应用 ID 中的 HealthKit 权限。

许可证

Apache 许可证版本 2.0

API

以下示例均在 TypeScript 中，演示 demo 使用 Nativescript 与 Angular 开发。

以下是导入和实例化插件的方法，所有示例都需要此设置

import { AggregateBy, HealthData, HealthDataType } from "nativescript-health-data";

export class MyHealthyClass {
  private healthData: HealthData;

  constructor() {
    this.healthData = new HealthData();
  }
}

isAvailable

这告诉您设备是否支持健康数据。在 iOS 上这可能是始终 true。在 Android 上，如果 Play Services 版本不够新，将提示用户（自动）更新其版本。如果您不希望此行为，向此函数传递 false，如下所示。

this.healthData.isAvailable(false)
    .then(available => console.log(available));

isAuthorized

此函数（和下一个函数）接受一个 HealthDataType 的数组。每个都有一个 name 和一个 accessType。

• name 可以是以下 '可用数据类型' 之一。
• accessType 可以是 read、write 或 readAndWrite（请注意，此插件目前仅支持读取数据，但将会改变）。

iOS 在这里有点愚蠢：如果您只请求了 'read' 访问，您将永远不会从此方法得到一个 true 响应。 详情请见此处。

this.healthData.isAuthorized([<HealthDataType>{name: "steps", accessType: "read"}])
    .then(authorized => console.log(authorized));

requestAuthorization

此函数接受与 isAuthorized 相同的参数，并在用户之前未授权您的应用访问传递的任何 HealthDataType 时触发同意屏幕。

请注意，此插件目前仅支持读取数据，但将会改变。

const types: Array<HealthDataType> = [
	{name: "height", accessType: "write"},
	{name: "weight", accessType: "readAndWrite"},
	{name: "steps", accessType: "read"},
	{name: "distance", accessType: "read"}
];

this.healthData.requestAuthorization(types)
    .then(authorized => console.log(authorized))
    .catch(error => console.log("Request auth error: ", error));

query

必选属性是 startData、endDate 和 dataType。dataType 必须是以下 '可用数据类型' 之一。

默认情况下，数据不会聚合，因此返回所有单独的数据点。但是，此插件提供了一种通过 hour、day 或 sourceAndDay 聚合数据的方法，后者将允许您按来源（Fitbit、Nike Run Club、手动输入等）读取每日数据。

如果您在运行 query 之前没有运行 requestAuthorization，插件将为您运行 requestAuthorization（对于请求的 dataType）。欢迎！😉

this.healthData.query(
    {
      startDate: new Date(new Date().getTime() - 3 * 24 * 60 * 60 * 1000), // 3 days ago
      endDate: new Date(), // now
      dataType: "steps", // equal to the 'name' property of 'HealthDataType'
      unit: "count", // make sure this is compatible with the 'dataType' (see below)
      aggregateBy: "day", // optional, one of: "hour", "day", "sourceAndDay"
      sortOrder: "desc" // optional, default "asc"
    })
    .then(result => console.log(JSON.stringify(result)))
    .catch(error => this.resultToShow = error);

startMonitoring（目前仅限 iOS）

如果您想在被健康数据更改时收到通知，您可以监控特定类型。即使在您的应用处于后台时，这也有效，只需设置 enableBackgroundUpdates: true。请注意，iOS 将唤醒您的应用以便您可以对此通知做出反应（例如在 onUpdate 函数中查询此数据类型的最近更改），但作为交换，您有责任通知 iOS 您已完成。因此，请确保按照以下示例调用 completionHandler。

并非所有数据类型都支持 backgroundUpdateFrequency: "immediate"，因此当在 HealthKit 中添加/删除数据时，您的应用可能不会立即被调用。

后台通知可能在 iOS 模拟器上不起作用，因此请在实际设备上测试这些功能。

this.healthData.startMonitoring(
    {
      dataType: "heartRate",
      enableBackgroundUpdates: true,
      backgroundUpdateFrequency: "immediate",
      onUpdate: (completionHandler: () => void) => {
        console.log("Our app was notified that health data changed, so querying...");
        this.getData("heartRate", "count/min").then(() => completionHandler());
      }
    })
    .then(() => this.resultToShow = `Started monitoring heartRate`)
    .catch(error => this.resultToShow = error);

stopMonitoring（目前仅限 iOS）

如果您不再希望收到健康数据更改时的通知，最好调用此方法。

this.healthData.stopMonitoring(
    {
      dataType: "heartRate",
    })
    .then(() => this.resultToShow = `Stopped monitoring heartRate`)
    .catch(error => this.resultToShow = error);

可用的数据类型

在版本 1.0.0 中，这些是可以读取的数据支持类型。同时，请确保传入正确的 unit。

请注意，您需要负责传入正确的 unit，尽管每种类型只有一个选项。实际上，目前 unit 在 Android 上被忽略，而在 iOS 上可以传入未记录的类型（例如，distance 的 mi）。

原因是我打算支持每种类型更多的单位，但这尚未实现...因此这是为了未来的向后兼容性！🤯