目录

订阅数据

Health Service Kit扩展能力服务提供了运动健康App的数据订阅/取消订阅接口subscribeDataEx/unSubscribeDataEx,开发者可以直接在第三方应用上调用接口订阅/取消订阅数据。目前支持订阅的数据:日总步数、日总距离、日总卡路里数、日步行时长、日睡眠时长。且运动健康App会保存应用的订阅记录,订阅记录有效期内无需重复订阅。

数据订阅扩展交互流程

  1. 在联盟卡片申请Health Service Kit服务时,选择已经创建的产品,勾选注册订阅通知能力。选择端侧订阅方式,填写接收广播用的action名称。
  2. 应用接入Health Service Kit扩展能力,订阅事件。
  3. 订阅事件满足时,实时通知应用。
  4. 应用收到通知消息,调用查询用户每日活动量/查询健康类数据从运动健康App获取具体数据。

订阅角色

角色/组件

说明

订阅者Subscriber

应用作为订阅者,向Health Service Kit扩展服务订阅事件。订阅者由Subscriber ID唯一标识。

订阅事件EventTypeInfo

用户活动事件。目前包括步数、睡眠数据变化等操作。

订阅通知SampleEvent

Health Service Kit扩展服务向订阅者发送通知广播,通知订阅用户事件变化。

支持的订阅事件/订阅通知

事件类别

事件子类别

描述

扩展元数据(订阅通知携带)

场景目标

SCENARIO_GOAL_EVENT

ACHIEVE

场景目标达成事件

metaKey:
  • goalStatus(JsonArrayString):List<GoalStatus>类型,大小为1,表示当前周期内,用户创建的某个订阅事件中每个目标达成状态。

支持订阅的数据类型及所需权限

事件类别

数据分类

数据类型/活动类型

描述

需获取用户授权的权限

需向华为申请开通的权限

(参见申请 Health Service Kit 服务)

场景目标

SCENARIO_GOAL_EVENT

测量值目标

MetricGoal

DATA_POINT_STEP_SUM

日总步数

HEALTHKIT_EXTEND_SPORT_READ

锻炼实时数据读权限

DATA_POINT_CALORIES_SUM

日总卡路里数

DATA_POINT_DISTANCE_SUM

日总距离

持续时间目标

DurationGoal

DATA_POINT_STEP_SUM

日步行时长

DATA_SET_CORE_SLEEP

日睡眠时长

HEALTHKIT_SLEEP_READ

睡眠数据读权限

参数要求

  • 传入多个目标时, 同时满足条件才会通知。
  • 建议应用在接收订阅事件通知时,对数据进行签名校验。
  • 解订阅时,Subscriber和EventTypeInfo要和订阅时传入的内容一致。
  • 若注册时数据已经满足条件,数据有更新时才会触发通知。
  • 锁屏下也可以注册场景目标事件,且锁屏下仍能收到达标通知,但锁屏通知可能会有一定的时延。
  1. 注册广播用于接收消息。
  2. 调用HiHealthDataStore对象的subscribeDataEx方法,订阅数据。
  3. 接收到广播后,对数据进行签名校验,校验通过则解析消息。
  4. 不需订阅时,调用HiHealthDataStore的unSubscribeDataEx方法取消订阅,传入的Subscriber和EventTypeInfo要和订阅时传入的内容一致。

数据订阅场景示例

// 步骤1: 注册广播用于接收消息
// init context
MyReceiver receiver = new MyReceiver();
String action = "receiver_action";
IntentFilter intentFilter = new IntentFilter(action);
context.registerReceiver(receiver, intentFilter);

// 步骤2:调用HiHealthDataStore对象的subscribeDataEx方法,订阅数据
ReceiverFilter filter = new ReceiverFilter("package_name", action);
Subscriber subscriber = new Subscriber("appId", "subscriberId", "secret", filter);
int unit = 1; // 代表天维度
int periodCount = 100; // 100 day
Recurrence recurrence = new Recurrence(unit);
recurrence.setCount(periodCount);
MetricGoal stepMetricGoal = new MetricGoal(HiHealthPointType.DATA_POINT_STEP_SUM, "step", 10000);
List<Goal> goals = new ArrayList<>();
goals.add(stepMetricGoal);
int startDay = 20220710;
GoalInfo goalInfo = new GoalInfo(goals, startDay, recurrence, "openId");
HiHealthDataStore.subscribeDataEx(context, subscriber, goalInfo, new ResultCallback() {
    @Override
    public void onResult(int i, Object o) {
        Log.i("TAG", "subscribe result code = " + i + ", message = " + o);
        if (resultCode == HiHealthError.SUCCESS) {
            // 订阅成功
            Log.i(TAG, "Subscription succeeded");
        } else if (resultCode == HiHealthError.PARAM_INVALID) {
            // 订阅参数错误
            Log.w(TAG, "Param invalid");
        } else if (resultCode == HiHealthError.ERR_HEALTH_SERVICE_DISCONNECTED) {
            // 与运动健康连接断开
            Log.w(TAG, "HealthKit service was disconnected");
        } else if (resultCode == HiHealthError.ERR_REPEAT_EXCEPTION) {
            // 重复订阅
            Log.w(TAG, "Repeat error");
        } else if (resultCode == HiHealthError.ERR_HMS_UNAVAILABLE_VERSION) {
            // HMS Core版本过低
            Log.w(TAG, "HMS version is too early");
        } else if (resultCode == HiHealthError.ERR_PERMISSION_EXCEPTION) {
            // 授权失效
            Log.w(TAG, "Permission denied");
        } else if (resultCode == HiHealthError.ERR_PRIVACY_USER_DENIED) {
            // 未同意运动健康隐私协议
            Log.w(TAG, "Privacy user denied");
        } else if (resultCode == HiHealthError.ERR_NETWORK) {
            // 网络异常
            Log.w(TAG, "Network request failed");
        } else if (resultCode == HiHealthError.ERR_BETA_SCOPE_EXCEPTION) {
            // 测试权限的用户数量超过限制
            Log.w(TAG, "Beta scope permission denied");
        } else {
            // 其他错误,建议提示调用失败
            Log.w(TAG, "Other error, invoking method failed");
        }
    }
});

// 步骤3: 接收到广播后,对数据进行签名校验,校验通过则解析消息
private class MyReceiver extends BroadcastReceiver {
    private static final String TAG = "MyReceiver";
    public void onReceive(Context context, Intent intent) {
        if (!intent.hasExtra(HiHealthKitConstant.EVENT_SIGNATURE)) {
            Log.w(TAG, "wrong message, no need to deal");
            return;
        }
        byte[] signature = intent.getByteArrayExtra(HiHealthKitConstant.EVENT_SIGNATURE);
        // 将自身生成的签名和接收到的签名比对,如果相等,则认为是正确的消息,否则不予处理
        // 签名生成规则:将type,subType,openId依次通过下划线拼接, 然后与secret进行HMAC-SHA256算法加密生成
        if (!intent.hasExtra(HiHealthKitConstant.SAMPLE_EVENT)) {
            Log.w(TAG, "no event is returned");
            return;
        }
        SampleEvent event = intent.getExtras().getParcelable(HiHealthKitConstant.SAMPLE_EVENT);
        MetaData metaData = event.getMetaData().get(0);
        if ("goalStatus".equals(metaData.getMetaKey())) {
            String metaValue = metaData.getMetaValue();
            try {
                JSONObject goalInfo = new JSONArray(metaValue).getJSONObject(0);
                int startDay = goalInfo.getInt("periodStartDay");
                int endDay = goalInfo.getInt("periodEndDay");
                JSONArray goals = new JSONArray(goalInfo.getString("goalAchieve"));
                for (int i = 0; i < goals.length(); i++) {
                    JSONObject goal = goals.getJSONObject(i);
                    if (goal.getInt("goalType") == CharacteristicConstant.GoalType.METRIC_GOAL) {
                        MetricGoal metricGoal = new Gson().fromJson(goal.toString(), MetricGoal.class);
                        Log.i(TAG, "data type " + metricGoal.getDataType() + " value : " + metricGoal.getValue()
                            + " is achieved");
                    } else if (goal.getInt("goalType") == CharacteristicConstant.GoalType.DURATION_GOAL) {
                        DurationGoal durationGoal = new Gson().fromJson(goal.toString(), DurationGoal.class);
                        Log.i(TAG, "data type " + durationGoal.getDataType() + " duration : "
                            + durationGoal.getDuration() + " is achieved");
                    } else {
                        Log.i(TAG, "wrong goal type");
                    }
                }
            } catch (JSONException e) {
                Log.w(TAG, "json exception");
            }
        }
    }
}

// 步骤4:不需订阅时,调用HiHealthDataStore的unSubscribeDataEx方法解订阅
HiHealthDataStore.unSubscribeDataEx(context, subscriber, goalInfo, new ResultCallback() {
    @Override
    public void onResult(int i, Object o) {
        Log.i(TAG, "unsubscribe result code = " + i + ", message = " + o);
        if (state == HiHealthError.SUCCESS) {
            // 解订阅成功
            Log.i(TAG, "Unsubscription succeeded");
        } else if (state == HiHealthError.PARAM_INVALID) {
            // 解订阅参数错误
            Log.w(TAG, "Param invalid");
        } else if (state == HiHealthError.ERR_PRIVACY_USER_DENIED) {
            // 未打开运动健康并同意隐私协议
            Log.w(TAG, "Privacy user denied");
        } else {
            // 其他错误,建议提示调用失败
            Log.w(TAG, "Other error, invoking method failed");
        }
    }
});
表1 (取消)订阅请求参数

参数名称

参数类型

参数描述

可选选项

subscriber

Subscriber

订阅者

必选(M)

goalInfo

EventTypeInfo

订阅事件

必选(M)

callback

ResultCallback

订阅结果回调

必选(M)

表2 订阅相应参数ResultCallback

参数名称

参数类型

参数描述

resultCode

int

处理结果码

data

Object

  • 成功:"success" (String)
  • 其他:错误信息描述(String)