mirror of
https://gitee.com/openharmony/interface_sdk-js
synced 2025-02-17 07:29:22 +00:00
add distributed and os account api
Signed-off-by: jidong <jidong4@huawei.com> Change-Id: I7179b471d441577e5ae94e55fb6a1a0153aabffb
This commit is contained in:
jidong
parent
f216058aeb
commit
bb486fdda6
115
api/@ohos.account.distributedAccount.d.ts
vendored
115
api/@ohos.account.distributedAccount.d.ts
vendored
@ -1,5 +1,5 @@
|
||||
/*
|
||||
* Copyright (c) 2021-2022 Huawei Device Co., Ltd.
|
||||
* Copyright (c) 2021-2023 Huawei Device Co., Ltd.
|
||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||
* you may not use this file except in compliance with the License.
|
||||
* You may obtain a copy of the License at
|
||||
@ -91,6 +91,40 @@ declare namespace distributedAccount {
|
||||
*/
|
||||
getOsAccountDistributedInfo(): Promise<DistributedInfo>;
|
||||
|
||||
/**
|
||||
* Gets the distributed information of the specified OS account.
|
||||
*
|
||||
* @permission ohos.permission.MANAGE_DISTRIBUTED_ACCOUNTS or ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS
|
||||
* @param { number } localId - Indicates the local ID of the specified OS account.
|
||||
* @param { AsyncCallback<DistributedInfo> } callback - Asynchronous callback interface.
|
||||
* @throws { BusinessError } 201 - Permission denied.
|
||||
* @throws { BusinessError } 202 - Not system application.
|
||||
* @throws { BusinessError } 401 - The parameter check failed.
|
||||
* @throws { BusinessError } 12300001 - System service exception.
|
||||
* @throws { BusinessError } 12300003 - Account not found.
|
||||
* @syscap SystemCapability.Account.OsAccount
|
||||
* @systemapi Hide this for inner system use.
|
||||
* @since 10
|
||||
*/
|
||||
getOsAccountDistributedInfoByLocalId(localId: number, callback: AsyncCallback<DistributedInfo>): void;
|
||||
|
||||
/**
|
||||
* Gets the distributed information of the specified OS account.
|
||||
*
|
||||
* @permission ohos.permission.MANAGE_DISTRIBUTED_ACCOUNTS or ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS
|
||||
* @param { number } localId - Indicates the local ID of the specified OS account.
|
||||
* @returns { Promise<DistributedInfo> } The distributed information of the specified OS account.
|
||||
* @throws { BusinessError } 201 - Permission denied.
|
||||
* @throws { BusinessError } 202 - Not system application.
|
||||
* @throws { BusinessError } 401 - The parameter check failed.
|
||||
* @throws { BusinessError } 12300001 - System service exception.
|
||||
* @throws { BusinessError } 12300003 - Account not found.
|
||||
* @syscap SystemCapability.Account.OsAccount
|
||||
* @systemapi Hide this for inner system use.
|
||||
* @since 10
|
||||
*/
|
||||
getOsAccountDistributedInfoByLocalId(localId: number): Promise<DistributedInfo>;
|
||||
|
||||
/**
|
||||
* Updates the distributed information of the OS account.
|
||||
*
|
||||
@ -148,6 +182,75 @@ declare namespace distributedAccount {
|
||||
* @since 9
|
||||
*/
|
||||
setOsAccountDistributedInfo(accountInfo: DistributedInfo): Promise<void>;
|
||||
|
||||
/**
|
||||
* Sets the distributed information of the specified OS account.
|
||||
*
|
||||
* @permission ohos.permission.MANAGE_DISTRIBUTED_ACCOUNTS
|
||||
* @param { number } localId - Indicates the local ID of the OS account.
|
||||
* @param { DistributedInfo } distributedInfo - Indicates the distributed information.
|
||||
* @param { AsyncCallback<void> } callback - Asynchronous callback interface.
|
||||
* @throws { BusinessError } 201 - Permission denied.
|
||||
* @throws { BusinessError } 202 - Not system application.
|
||||
* @throws { BusinessError } 401 - The parameter check failed.
|
||||
* @throws { BusinessError } 12300001 - System service exception.
|
||||
* @throws { BusinessError } 12300002 - Invalid distributedInfo.
|
||||
* @throws { BusinessError } 12300003 - Account identified by localId or by distributedInfo not found.
|
||||
* @throws { BusinessError } 12300008 - Restricted OS account.
|
||||
* @syscap SystemCapability.Account.OsAccount
|
||||
* @systemapi Hide this for inner system use.
|
||||
* @since 10
|
||||
*/
|
||||
setOsAccountDistributedInfoByLocalId(
|
||||
localId: number,
|
||||
distributedInfo: DistributedInfo,
|
||||
callback: AsyncCallback<void>
|
||||
): void;
|
||||
|
||||
/**
|
||||
* Sets the distributed information of the specified OS account.
|
||||
*
|
||||
* @permission ohos.permission.MANAGE_DISTRIBUTED_ACCOUNTS
|
||||
* @param { number } localId - Indicates the local ID of the OS account.
|
||||
* @param { DistributedInfo } distributedInfo - Indicates the distributed information.
|
||||
* @returns { Promise<void> } The promise returned by the function.
|
||||
* @throws { BusinessError } 201 - Permission denied.
|
||||
* @throws { BusinessError } 202 - Not system application.
|
||||
* @throws { BusinessError } 401 - The parameter check failed.
|
||||
* @throws { BusinessError } 12300001 - System service exception.
|
||||
* @throws { BusinessError } 12300002 - Invalid distributedInfo.
|
||||
* @throws { BusinessError } 12300003 - Account identified by localId or by distributedInfo not found.
|
||||
* @throws { BusinessError } 12300008 - Restricted OS account.
|
||||
* @syscap SystemCapability.Account.OsAccount
|
||||
* @systemapi Hide this for inner system use.
|
||||
* @since 10
|
||||
*/
|
||||
setOsAccountDistributedInfoByLocalId(localId: number, distributedInfo: DistributedInfo): Promise<void>;
|
||||
}
|
||||
|
||||
/**
|
||||
* Enum for distributed account status.
|
||||
*
|
||||
* @enum { number }
|
||||
* @syscap SystemCapability.Account.OsAccount
|
||||
* @since 10
|
||||
*/
|
||||
enum DistributedAccountStatus {
|
||||
/**
|
||||
* Indicates that the account is not logged in.
|
||||
*
|
||||
* @syscap SystemCapability.Account.OsAccount
|
||||
* @since 10
|
||||
*/
|
||||
NOT_LOGGED_IN = 0,
|
||||
|
||||
/**
|
||||
* Indicates that the account is logged in.
|
||||
*
|
||||
* @syscap SystemCapability.Account.OsAccount
|
||||
* @since 10
|
||||
*/
|
||||
LOGGED_IN = 1
|
||||
}
|
||||
|
||||
/**
|
||||
@ -203,6 +306,16 @@ declare namespace distributedAccount {
|
||||
*/
|
||||
avatar?: string;
|
||||
|
||||
/**
|
||||
* The status in the distributed information of the OS account.
|
||||
*
|
||||
* @type { ?DistributedAccountStatus }
|
||||
* @readonly
|
||||
* @syscap SystemCapability.Account.OsAccount
|
||||
* @since 10
|
||||
*/
|
||||
readonly status?: DistributedAccountStatus;
|
||||
|
||||
/**
|
||||
* The scalable data in the distributed information of the OS account.
|
||||
*
|
||||
|
||||
87
api/@ohos.account.osAccount.d.ts
vendored
87
api/@ohos.account.osAccount.d.ts
vendored
@ -2880,6 +2880,26 @@ declare namespace osAccount {
|
||||
* @since 8
|
||||
*/
|
||||
freezingTime?: number;
|
||||
|
||||
/**
|
||||
* Indicates the enrollment progress.
|
||||
*
|
||||
* @type { ?string }
|
||||
* @syscap SystemCapability.Account.OsAccount
|
||||
* @systemapi Hide this for inner system use.
|
||||
* @since 10
|
||||
*/
|
||||
enrollmentProgress?: string;
|
||||
|
||||
/**
|
||||
* Indicates the sensor information.
|
||||
*
|
||||
* @type { ?string }
|
||||
* @syscap SystemCapability.Account.OsAccount
|
||||
* @systemapi Hide this for inner system use.
|
||||
* @since 10
|
||||
*/
|
||||
sensorInfo?: string;
|
||||
}
|
||||
|
||||
/**
|
||||
@ -3066,7 +3086,25 @@ declare namespace osAccount {
|
||||
* @systemapi Hide this for inner system use.
|
||||
* @since 8
|
||||
*/
|
||||
FREEZING_TIME = 3
|
||||
FREEZING_TIME = 3,
|
||||
|
||||
/**
|
||||
* Indicates the enrollment progress.
|
||||
*
|
||||
* @syscap SystemCapability.Account.OsAccount
|
||||
* @systemapi Hide this for inner system use.
|
||||
* @since 10
|
||||
*/
|
||||
ENROLLMENT_PROGRESS = 4,
|
||||
|
||||
/**
|
||||
* Indicates the sensor information.
|
||||
*
|
||||
* @syscap SystemCapability.Account.OsAccount
|
||||
* @systemapi Hide this for inner system use.
|
||||
* @since 10
|
||||
*/
|
||||
SENSOR_INFO = 5
|
||||
}
|
||||
|
||||
/**
|
||||
@ -3188,6 +3226,33 @@ declare namespace osAccount {
|
||||
*/
|
||||
FACE_3D = 20001,
|
||||
|
||||
/**
|
||||
* Indicates the capacitive fingerprint credential.
|
||||
*
|
||||
* @syscap SystemCapability.Account.OsAccount
|
||||
* @systemapi Hide this for inner system use.
|
||||
* @since 10
|
||||
*/
|
||||
FINGERPRINT_CAPACITIVE = 30000,
|
||||
|
||||
/**
|
||||
* Indicates the optical fingerprint credential.
|
||||
*
|
||||
* @syscap SystemCapability.Account.OsAccount
|
||||
* @systemapi Hide this for inner system use.
|
||||
* @since 10
|
||||
*/
|
||||
FINGERPRINT_OPTICAL = 30001,
|
||||
|
||||
/**
|
||||
* Indicates the ultrasonic fingerprint credential.
|
||||
*
|
||||
* @syscap SystemCapability.Account.OsAccount
|
||||
* @systemapi Hide this for inner system use.
|
||||
* @since 10
|
||||
*/
|
||||
FINGERPRINT_ULTRASONIC = 30002,
|
||||
|
||||
/**
|
||||
* Indicates the mixed domain credential.
|
||||
*
|
||||
@ -3542,7 +3607,25 @@ declare namespace osAccount {
|
||||
* @systemapi Hide this for inner system use.
|
||||
* @since 8
|
||||
*/
|
||||
FINGERPRINT_TIP_TOO_SLOW = 5
|
||||
FINGERPRINT_TIP_TOO_SLOW = 5,
|
||||
|
||||
/**
|
||||
* Indicates that the finger is down.
|
||||
*
|
||||
* @syscap SystemCapability.Account.OsAccount
|
||||
* @systemapi Hide this for inner system use.
|
||||
* @since 10
|
||||
*/
|
||||
FINGERPRINT_TIP_FINGER_DOWN = 6,
|
||||
|
||||
/**
|
||||
* Indicates that the finger is up.
|
||||
*
|
||||
* @syscap SystemCapability.Account.OsAccount
|
||||
* @systemapi Hide this for inner system use.
|
||||
* @since 10
|
||||
*/
|
||||
FINGERPRINT_TIP_FINGER_UP = 7
|
||||
}
|
||||
|
||||
/**
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user