目录

ConsentsController

Class Info

public class ConsentsController

授权管理接口,用户可通过该接口查看和取消应用自身已授权的权限。

Public Method Summary

Qualifier and Type

Method Name and Description

Task<ScopeLangItem>

get(String lang, String appId)

查询应用已授权的权限列表,只支持查询应用自身的授权信息。最新的授权列表结果会有2分钟的缓存时间。

Task<Void>

cancelAuthorization(boolean deleteData)

取消应用全部授权,支持删除用户数据。

Task<Void>

cancelAuthorization(String appId, List<String> scopes)

取消应用部分授权,只支持取消应用自身HealthKit相关的权限。

Public Methods

[h2]get(String lang, String appId)

Method

public Task<ScopeLangItem> get(String lang, String appId)

查询应用已授权的权限列表,只支持查询应用自身的授权信息。最新的授权列表结果会有2分钟的缓存时间。

Parameters

Name

Description

lang

语言代码,若参数无效,默认使用en-us。

appId

应用ID,只支持查询应用自身的授权信息。

Returns

Type

Description

Task<ScopeLangItem>

应用已授权的权限列表。

查询应用已授权的权限列表的示例代码如下:
“Java”
// 日志Tag
private static final String TAG = "HealthKitConsents";

// 保存查询的应用授权信息
private ScopeLangItem scopeLangItem;

public void getAppScopes() {
    // 1. 获取ConsentsController对象
    // 请注意此处的this为Activity对象
    ConsentsController consentsController = HuaweiHiHealth.getConsentsController(this);

    // 2. 查询应用已授权的权限列表
    // 需要将"APP ID"参数替换成您应用的APP ID值
    Task<ScopeLangItem> task = consentsController.get("zh-cn", "APP ID");
    // 3. 添加成功或失败listener,处理调用结果
    task.addOnSuccessListener(new OnSuccessListener<ScopeLangItem>() {
        @Override
        public void onSuccess(ScopeLangItem result) {
            Log.i(TAG, "getAppScopes success");
            scopeLangItem = result;
            // 4. 获取应用已授权的权限列表
            if (result.getUrl2Desc() != null) {
                Set<String> scopeUrl = result.getUrl2Desc().keySet();
                Log.i(TAG, "getAppScopes size " + scopeUrl.size());
            }
        }
    }).addOnFailureListener(new OnFailureListener() {
        @Override
        public void onFailure(Exception e) {
            Log.e(TAG, "getAppScopes exception");
        }
    });
}
“Kotlin”
// 保存查询的应用授权信息
private var scopeLangItem: ScopeLangItem? = null
fun getAppScopes() {
    // 1. 获取ConsentsController对象
    // 请注意此处的this为Activity对象
    val consentsController = HuaweiHiHealth.getConsentsController(this)

    // 2. 查询应用已授权的权限列表
    // 需要将"APP ID"参数替换成您应用的APP ID值
    val task = consentsController.get("zh-cn", "APP ID")
    // 3. 添加成功或失败listener,处理调用结果
    task.addOnSuccessListener { result ->
        Log.i(TAG, "getAppScopes success")
        scopeLangItem = result
        // 4. 获取应用已授权的权限列表
        if (result.url2Desc != null) {
            val scopeUrl = result.url2Desc.keys
            Log.i(TAG, "getAppScopes size " + scopeUrl.size)
        }
    }.addOnFailureListener { Log.e(TAG, "getAppScopes exception") }
}

companion object {
    // 日志Tag
    private val TAG = "HealthKitConsents"
}

[h2]cancelAuthorization(String appId, List<String> scopes)

Method

public Task<Void> cancelAuthorization(String appId, List<String> scopes)

取消应用部分授权,只支持取消应用自身HealthKit相关的权限。

Parameters

Name

Description

appId

应用ID,只支持取消应用自身的权限。

scopes

权限列表,要取消的HealthKit权限列表,取值为ScopeLangItem中url2Desc的key值。

Returns

Type

Description

Task<Void>

用来检查请求是否成功、失败、已完成的Task对象。

取消应用部分授权的示例代码如下:
“Java”
// 日志Tag
private static final String TAG = "HealthKitConsents";

// 保存查询的应用授权信息
private ScopeLangItem scopeLangItem;

public void revokeScopes(View view) {
    // 1. 获取ConsentsController对象
    // 请注意此处的this为Activity对象
    ConsentsController consentsController = HuaweiHiHealth.getConsentsController(this);

    // 2. 取消应用部分授权
    // 需要将"APP ID"参数替换成您应用的APP ID值
    Task<Void> task = consentsController.cancelAuthorization("APP ID", getRevokeScopes());
    task.addOnSuccessListener(new OnSuccessListener<Void>() {
        @Override
        public void onSuccess(Void aVoid) {
            Log.i(TAG, "revokeScopes success");
        }
    }).addOnFailureListener(new OnFailureListener() {
        @Override
        public void onFailure(Exception e) {
            Log.e(TAG, "revokeApp exception");
        }
    });
}

/**
 * 获取要取消的授权列表, 样例中直接使用getAppScopes中的查询结果,返回最后一个权限scope url值。开发者请自定义相关逻辑
 *
 * @return 要取消的授权列表
 */
private List<String> getRevokeScopes() {
    List<String> scopeUrls = new ArrayList<>(Optional.ofNullable(scopeLangItem)
        .map(ScopeLangItem::getUrl2Desc)
        .map(Map::keySet)
        .orElse(Collections.emptySet()));

    if (scopeUrls.isEmpty()) {
        return scopeUrls;
    }

    Collections.sort(scopeUrls);
    List<String> revokeScopeUrls = scopeUrls.subList(scopeUrls.size() - 1, scopeUrls.size());

    return revokeScopeUrls;
}
“Kotlin”
// 保存查询的应用授权信息
private val scopeLangItem: ScopeLangItem? = null

fun revokeScopes(view: View) {
    // 1. 获取ConsentsController对象
    // 请注意此处的this为Activity对象
    val consentsController = HuaweiHiHealth.getConsentsController(this)

    // 2. 取消应用部分授权
    // 需要将"APP ID"参数替换成您应用的APP ID值
    val task = consentsController.cancelAuthorization("APP ID", getRevokeScopes())
    task.addOnSuccessListener { Log.i(TAG, "revokeScopes success") }
        .addOnFailureListener { Log.e(TAG, "revokeApp exception") }
}

/**
 * 获取要取消的授权列表, 样例中直接使用getAppScopes中的查询结果,返回最后一个权限ID值。开发者请自定义相关逻辑
 *
 * @return 要取消的授权列表
 */
private fun getRevokeScopes(): List<String> {
    val scopeUrls = ArrayList(
        Optional.ofNullable(scopeLangItem)
            .map { scopeLangItem -> scopeLangItem.url2Desc }
            .map { url2Desc -> url2Desc.keys }
            .orElse(Collections.emptySet())
    )

    if (scopeUrls.isEmpty()) {
        return scopeUrls
    }

    scopeUrls.sort()
    return scopeUrls.subList(scopeUrls.size - 1, scopeUrls.size)
}

companion object {
    // 日志Tag
    private val TAG = "HealthKitConsents"
}

[h2]cancelAuthorization(boolean deleteData)

Method

public Task<Void> cancelAuthorization(boolean deleteData)

取消应用全部授权,支持删除用户数据。

Parameters

Name

Description

deleteData

是否删除用户数据,true为删除用户数据,false为不删除用户数据。

Returns

Type

Description

Task<Void>

用来检查请求是否成功、失败、已完成的Task对象。

取消应用全部授权的示例代码如下:
“Java”
// 日志Tag
private static final String TAG = "HealthKitConsents";

public void cancelAuthorization(View view) {
    // 1. 获取ConsentsController对象
    // 请注意此处的this为Activity对象
    ConsentsController mConsentsController = HuaweiHiHealth.getConsentsController(this);
    // 2. 是否删除用户数据,true为删除用户数据,false为不删除用户数据
    boolean clearUserData = true;
    // 3. 取消应用全部授权,是否删除用户数据
    Task<Void> task = mConsentsController.cancelAuthorization(clearUserData);
    task.addOnSuccessListener(new OnSuccessListener<Void>() {
        @Override
        public void onSuccess(Void aVoid) {
            Log.i(TAG, "cancelAuthorization success");
            if(clearUserData){
                Log.i(TAG, "clearUserData success");
            }
        }
    }).addOnFailureListener(new OnFailureListener() {
        @Override
        public void onFailure(Exception e) {
            Log.e(TAG, "cancelAuthorization exception");
        }
    });
}
“Kotlin”
fun cancelAuthorization(view: View) {
    // 1. 获取ConsentsController对象
    // 请注意此处的this为Activity对象
    val mConsentsController = HuaweiHiHealth.getConsentsController(this)
    // 2. 是否删除用户数据,true为删除用户数据,false为不删除用户数据
    val clearUserData = true
    // 3. 取消应用全部授权,是否删除用户数据
    val task = mConsentsController!!.cancelAuthorization(clearUserData)
    task.addOnSuccessListener {
        Log.i(TAG, "cancelAuthorization success")
        if (clearUserData) {
            Log.i(TAG, "clearUserData success")
        }
    }.addOnFailureListener { e ->
        Log.e(TAG, "cancelAuthorization exception")
    }
}
companion object {
    // 日志Tag
    private val TAG = "HealthKitConsents"
}