@ohos.account.appAccount (应用帐号管理)


@ohos.account.appAccount (应用帐号管理)

本模块提供应用帐号信息的添加、删除、修改和查询基础能力,并支持应用间鉴权和分布式数据同步功能。

说明:

本模块首批接口从API version 7开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。

导入模块

import account_appAccount from '@ohos.account.appAccount';
1

account_appAccount.createAppAccountManager

createAppAccountManager(): AppAccountManager

创建应用帐号管理器对象。

系统能力: SystemCapability.Account.AppAccount

返回值:

类型 说明
AppAccountManager 应用帐号管理器对象。

示例:

let appAccountManager = account_appAccount.createAppAccountManager();
1

AppAccountManager

应用帐号管理器类。

createAccount9+

createAccount(name: string, callback: AsyncCallback<void>): void;

根据帐号名创建应用帐号。使用callback异步回调。

系统能力: SystemCapability.Account.AppAccount

参数:

参数名 类型 必填 说明
name string 应用帐号的名称。
callback AsyncCallback<void> 回调函数。当创建成功时,err为null,否则为错误对象。

错误码:

错误码ID 错误信息
12300001 System service exception.
12300002 Invalid name.
12300004 Account already exists.
12300007 The number of accounts reaches the upper limit.

示例:

let appAccountManager = account_appAccount.createAppAccountManager();
try {
  appAccountManager.createAccount("WangWu", (err) => { 
      console.log("createAccount err: " + JSON.stringify(err));
  });
} catch (err) {
  console.log("createAccount err: " + JSON.stringify(err));
}
1
2
3
4
5
6
7
8

createAccount9+

createAccount(name: string, options: CreateAccountOptions, callback: AsyncCallback<void>): void

根据帐号名和可选项创建应用帐号。使用callback异步回调。

系统能力: SystemCapability.Account.AppAccount

参数:

参数名 类型 必填 说明
name string 应用帐号的名称。
options CreateAccountOptions 创建应用帐号的选项,可提供自定义数据,但不建议包含敏感数据(如密码、Token等)。
callback AsyncCallback<void> 回调函数。当创建成功时,err为null,否则为错误对象。

错误码:

错误码ID 错误信息
12300001 System service exception.
12300002 Invalid name or options.
12300004 Account already exists.
12300007 The number of accounts reaches the upper limit.

示例:

let appAccountManager = account_appAccount.createAppAccountManager();
let options = {
  customData: {
    "age": "10"
  }
}
try {
  appAccountManager.createAccount("LiSi", options, (err) => {
    if (err) {
      console.log("createAccount failed, error: " + JSON.stringify(err));
    } else {
      console.log("createAccount successfully");
    }
  });
} catch(err) {
  console.log("createAccount exception: " + JSON.stringify(err));
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17

createAccount9+

createAccount(name: string, options?: CreateAccountOptions): Promise<void>

根据帐号名和可选项创建应用帐号。使用Promise异步回调。

系统能力: SystemCapability.Account.AppAccount

参数:

参数名 类型 必填 说明
name string 应用帐号的名称。
options CreateAccountOptions 创建应用帐号的选项,可提供自定义数据,但不建议包含敏感数据(如密码、Token等)。不填无影响。

返回值:

类型 说明
Promise<void> 无返回结果的Promise对象。

错误码:

错误码ID 错误信息
12300001 System service exception.
12300002 Invalid name or options.
12300004 Account already exists.
12300007 The number of accounts reaches the upper limit.
12400003 The number of custom data reaches the upper limit.

示例:

let appAccountManager = account_appAccount.createAppAccountManager();
let options = {
  customData: {
    "age": "10"
  }
}
try {
  appAccountManager.createAccount("LiSi", options).then(() => {
    console.log("createAccount successfully");
  }).catch((err) => {
    console.log("createAccount failed, error: " + JSON.stringify(err));
  });
} catch(err) {
  console.log("createAccount exception: " + JSON.stringify(err));
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15

createAccountImplicitly9+

createAccountImplicitly(owner: string, callback: AuthCallback): void

根据指定的帐号所有者隐式地创建应用帐号。使用callback异步回调。

系统能力: SystemCapability.Account.AppAccount

参数:

参数名 类型 必填 说明
owner string 应用帐号所有者的包名。
callback AuthCallback 认证器回调对象,返回创建结果。

错误码:

错误码ID 错误信息
12300001 System service exception.
12300002 Invalid owner.
12300007 The number of accounts reaches the upper limit.
12300010 Account service busy.
12300113 Authenticator service not found.
12300114 Authenticator service exception.

示例:

import featureAbility from '@ohos.ability.featureAbility';

function onResultCallback(code, result) {
  console.log("resultCode: "  + code);
  console.log("result: "  + JSON.stringify(result));
}

function onRequestRedirectedCallback(request) {
  let abilityStartSetting = {want: request};
  featureAbility.startAbility(abilityStartSetting, (err) => {
    console.log("startAbility err: " + JSON.stringify(err));
  });
}

let appAccountManager = account_appAccount.createAppAccountManager();
try {  
  appAccountManager.createAccountImplicitly("com.example.accountjsdemo", {
    onResult: onResultCallback,
    onRequestRedirected: onRequestRedirectedCallback
  });
} catch (err) {
  console.log("createAccountImplicitly exception: " + JSON.stringify(err));
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23

createAccountImplicitly9+

createAccountImplicitly(owner: string, options: CreateAccountImplicitlyOptions, callback: AuthCallback): void

根据指定的帐号所有者和可选项隐式地创建应用帐号。使用callback异步回调。

系统能力: SystemCapability.Account.AppAccount

参数:

参数名 类型 必填 说明
owner string 应用帐号所有者的包名。
options CreateAccountImplicitlyOptions 隐式创建账号的选项。
callback AuthCallback 认证器回调对象,返回创建结果。

错误码:

错误码ID 错误信息
12300001 System service exception.
12300002 Invalid name or options.
12300007 The number of accounts reaches the upper limit.
12300010 Account service busy.
12300113 Authenticator service not found.
12300114 Authenticator service exception.

示例:

import featureAbility from '@ohos.ability.featureAbility';

function onResultCallback(code, result) {
  console.log("resultCode: "  + code);
  console.log("result: "  + JSON.stringify(result));
}

function onRequestRedirectedCallback(request) {
  let abilityStartSetting = {want: request};
  featureAbility.startAbility(abilityStartSetting, (err) => {
    console.log("startAbility err: " + JSON.stringify(err));
  });
}

let appAccountManager = account_appAccount.createAppAccountManager();
let options = {
  authType: "getSocialData",
  requiredLabels: [ "student" ]
};
try {
  appAccountManager.createAccountImplicitly("com.example.accountjsdemo", options, {
    onResult: onResultCallback,
    onRequestRedirected: onRequestRedirectedCallback
  });
} catch (err) {
  console.log("createAccountImplicitly exception: " + JSON.stringify(err));
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27

removeAccount9+

removeAccount(name: string, callback: AsyncCallback<void>): void

删除应用帐号。使用callback异步回调。

系统能力: SystemCapability.Account.AppAccount

参数:

参数名 类型 必填 说明
name string 应用帐号的名称。
callback AsyncCallback<void> 回调函数。当删除成功时,err为null,否则为错误对象。

错误码:

错误码ID 错误信息
12300001 System service exception.
12300002 Invalid name.
12300003 Account not found.

示例:

let appAccountManager = account_appAccount.createAppAccountManager();
try {
  appAccountManager.removeAccount("ZhaoLiu", (err) => {
    if (err) {
      console.log("removeAccount failed, error: " + JSON.stringify(err));
    } else {
      console.log("removeAccount successfully");
    }
 });
} catch(err) {
  console.log("removeAccount exception: " + JSON.stringify(err));
}
1
2
3
4
5
6
7
8
9
10
11
12

removeAccount9+

removeAccount(name: string): Promise<void>

删除应用帐号。使用Promise异步回调。

系统能力: SystemCapability.Account.AppAccount

参数:

参数名 类型 必填 说明
name string 应用帐号的名称。

返回值:

类型 说明
Promise<void> 无返回结果的Promise对象。

错误码:

错误码ID 错误信息
12300001 System service exception.
12300002 Invalid name.
12300003 Account not found.

示例:

let appAccountManager = account_appAccount.createAppAccountManager();
try {
  appAccountManager.removeAccount("Lisi").then(() => {
    console.log("removeAccount successfully");
  }).catch((err) => {
    console.log("removeAccount failed, error: " + JSON.stringify(err));
  });
} catch (err) {
  console.log("removeAccount exception: " + JSON.stringify(err));
}
1
2
3
4
5
6
7
8
9
10

setAppAccess9+

setAppAccess(name: string, bundleName: string, isAccessible: boolean, callback: AsyncCallback<void>): void

设置指定应用对特定帐号的访问权限。使用callback异步回调。

系统能力: SystemCapability.Account.AppAccount

参数:

参数名 类型 必填 说明
name string 应用帐号的名称。
bundleName string 第三方应用的包名。
isAccessible boolean 是否可访问。true表示允许访问,false表示禁止访问。
callback AsyncCallback<void> 回调函数,如果设置成功,err为null,否则为错误对象。

错误码:

错误码ID 错误信息
12300001 System service exception.
12300002 Invalid name or bundleName.
12300003 Account not found.
12400001 Application not found.

示例:

let appAccountManager = account_appAccount.createAppAccountManager();
try {
  appAccountManager.setAppAccess("ZhangSan", "com.example.accountjsdemo", true, (err) => {
    if (err) {
      console.log("setAppAccess failed: " + JSON.stringify(err));
    } else {
      console.log("setAppAccess successfully");
    }
  });
} catch (err) {
  console.log("setAppAccess exception: " + JSON.stringify(err));
}
1
2
3
4
5
6
7
8
9
10
11
12

setAppAccess9+

setAppAccess(name: string, bundleName: string, isAccessible: boolean): Promise<void>

设置指定应用对特定帐号的数据访问权限。使用Promise异步回调。

系统能力: SystemCapability.Account.AppAccount

参数:

参数名 类型 必填 说明
name string 应用帐号的名称。
bundleName string 第三方应用的包名。
isAccessible boolean 是否可访问。true表示允许访问,false表示禁止访问。

返回值:

类型 说明
Promise<void> 无返回结果的Promise对象。

错误码:

错误码ID 错误信息
12300001 System service exception.
12300002 Invalid name or bundleName.
12300003 Account not found.
12400001 Application not found.

示例:

let appAccountManager = account_appAccount.createAppAccountManager();
try {
  appAccountManager.setAppAccess("ZhangSan", "com.example.accountjsdemo", true).then(() => {
    console.log("setAppAccess successfully");
  }).catch((err) => {
    console.log("setAppAccess failed: " + JSON.stringify(err));
  });
} catch (err) {
  console.log("setAppAccess exception: " + JSON.stringify(err));
}
1
2
3
4
5
6
7
8
9
10

checkAppAccess9+

checkAppAccess(name: string, bundleName: string, callback: AsyncCallback<boolean>): void

检查指定应用对特定帐号的数据是否可访问。使用callback异步回调。

系统能力: SystemCapability.Account.AppAccount

参数:

参数名 类型 必填 说明
name string 应用帐号的名称。
bundleName string 第三方应用的包名。
callback AsyncCallback<boolean> 回调函数。返回true表示指定应用可访问特定帐号的数据;返回false表示不可访问。

错误码:

错误码ID 错误信息
12300001 System service exception.
12300002 Invalid name or bundleName.
12300003 Account not found.
12400001 Application not found.

示例:

let appAccountManager = account_appAccount.createAppAccountManager();
try {
  appAccountManager.checkAppAccess("ZhangSan", "com.example.accountjsdemo", (err, isAccessible) => {
    if (err) {
      console.log("checkAppAccess failed, error: " + JSON.stringify(err));
    } else {
      console.log("checkAppAccess successfully");
    }
  });
} catch (err) {
  console.log("checkAppAccess exception: " + JSON.stringify(err));
}
1
2
3
4
5
6
7
8
9
10
11
12

checkAppAccess9+

checkAppAccess(name: string, bundleName: string): Promise<boolean>

检查指定应用对特定帐号的数据是否可访问。使用Promise异步回调。

系统能力: SystemCapability.Account.AppAccount

参数:

参数名 类型 必填 说明
name string 应用帐号的名称。
bundleName string 第三方应用的包名。

返回值:

类型 说明
Promise<boolean> Promise对象。返回true表示指定应用可访问特定帐号的数据;返回false表示不可访问。

错误码:

错误码ID 错误信息
12300001 System service exception.
12300002 Invalid name or bundleName.
12300003 Account not found.
12400001 Application not found.

示例:

let appAccountManager = account_appAccount.createAppAccountManager();
try {
  appAccountManager.checkAppAccess("ZhangSan", "com.example.accountjsdemo").then((isAccessible) => {
    console.log("checkAppAccess successfully, isAccessible: " + isAccessible);
  }).catch((err) => {
    console.log("checkAppAccess failed, error: " + JSON.stringify(err));
  });
} catch (err) {
  console.log("checkAppAccess exception: " + JSON.stringify(err));
}
1
2
3
4
5
6
7
8
9
10

setDataSyncEnabled9+

setDataSyncEnabled(name: string, isEnabled: boolean, callback: AsyncCallback<void>): void

开启或禁止指定应用帐号的数据同步功能。使用callback异步回调。

需要权限: ohos.permission.DISTRIBUTED_DATASYNC

系统能力: SystemCapability.Account.AppAccount

参数:

参数名 类型 必填 说明
name string 应用帐号的名称。
isEnabled boolean 是否开启数据同步。
callback AsyncCallback<void> 回调函数。当开启或禁止成功时,err为null,否则为错误对象。

错误码:

错误码ID 错误信息
12300001 System service exception.
12300002 Invalid name.
12300003 Account not found.

示例:

let appAccountManager = account_appAccount.createAppAccountManager();
try {
    appAccountManager.setDataSyncEnabled("ZhangSan", true, (err) => { 
        console.log("setDataSyncEnabled err: " + JSON.stringify(err));
    });
} catch (err) {
    console.log("setDataSyncEnabled err: " + JSON.stringify(err));
}
1
2
3
4
5
6
7
8

setDataSyncEnabled9+

setDataSyncEnabled(name: string, isEnabled: boolean): Promise<void>

开启或禁止指定应用帐号的数据同步功能。使用Promise异步回调。

需要权限: ohos.permission.DISTRIBUTED_DATASYNC

系统能力: SystemCapability.Account.AppAccount

参数:

参数名 类型 必填 说明
name string 应用帐号的名称。
isEnabled boolean 是否开启数据同步。

返回值:

类型 说明
Promise<void> 无返回结果的Promise对象。

错误码:

错误码ID 错误信息
12300001 System service exception.
12300002 Invalid name.
12300003 Account not found.

示例:

let appAccountManager = account_appAccount.createAppAccountManager();
try {
    appAccountManager .setDataSyncEnabled("ZhangSan", true).then(() => { 
        console.log('setDataSyncEnabled Success');
    }).catch((err) => {
        console.log("setDataSyncEnabled err: "  + JSON.stringify(err));
    });
} catch (err) {
    console.log("setDataSyncEnabled err: "  + JSON.stringify(err));
}
1
2
3
4
5
6
7
8
9
10

checkDataSyncEnabled9+

checkDataSyncEnabled(name: string, callback: AsyncCallback<boolean>): void

检查指定应用帐号是否开启数据同步功能。使用callback异步回调。

需要权限: ohos.permission.DISTRIBUTED_DATASYNC

系统能力: SystemCapability.Account.AppAccount

参数:

参数名 类型 必填 说明
name string 应用帐号的名称。
callback AsyncCallback<boolean> 回调函数。返回true表示指定应用帐号已开启数据同步功能;返回false表示未开启。

错误码:

错误码ID 错误信息
12300001 System service exception.
12300002 Invalid name.
12300003 Account not found.

示例:

let appAccountManager = account_appAccount.createAppAccountManager();
try {
  appAccountManager.checkDataSyncEnabled("ZhangSan", (err, isEnabled) => {
    if (err) {
      console.log("checkDataSyncEnabled failed, err: " + JSON.stringify(err));
    } else {
      console.log('checkDataSyncEnabled successfully, isEnabled: ' + isEnabled);
    }
  });
} catch (err) {
  console.log("checkDataSyncEnabled err: " + JSON.stringify(err));
}
1
2
3
4
5
6
7
8
9
10
11
12

checkDataSyncEnabled9+

checkDataSyncEnabled(name: string): Promise<boolean>

检查指定应用帐号是否开启数据同步功能。使用Promise异步回调。

需要权限: ohos.permission.DISTRIBUTED_DATASYNC

系统能力: SystemCapability.Account.AppAccount

参数:

参数名 类型 必填 说明
name string 应用帐号的名称。

返回值:

类型 说明
Promise<boolean> Promise对象。返回true表示指定应用帐号已开启数据同步功能;返回false表示未开启。

错误码:

错误码ID 错误信息
12300001 System service exception.
12300002 Invalid name.
12300003 Account not found.

示例:

let appAccountManager = account_appAccount.createAppAccountManager();
try {
  appAccountManager.checkDataSyncEnabled("ZhangSan").then((isEnabled) => {
      console.log("checkDataSyncEnabled successfully, isEnabled: " + isEnabled);
  }).catch((err) => {
    console.log("checkDataSyncEnabled failed, err: " + JSON.stringify(err));
  });
} catch (err) {
  console.log("checkDataSyncEnabled err: " + JSON.stringify(err));
}
1
2
3
4
5
6
7
8
9
10

setCredential9+

setCredential(name: string, credentialType: string, credential: string,callback: AsyncCallback<void>): void

设置指定应用帐号的凭据。使用callback异步回调。

系统能力: SystemCapability.Account.AppAccount

参数:

参数名 类型 必填 说明
name string 应用帐号的名称。
credentialType string 凭据类型。
credential string 凭据取值。
callback AsyncCallback<void> 回调函数。当凭据设置成功时,err为null,否则为错误对象。

错误码:

错误码ID 错误信息
12300001 System service exception.
12300002 Invalid name or credentialType or credential.
12300003 Account not found.

示例:

let appAccountManager = account_appAccount.createAppAccountManager();
try {
  appAccountManager.setCredential("ZhangSan", "PIN_SIX", "xxxxxx", (err) => {
    if (err) {
      console.log("setCredential failed, error: " + JSON.stringify(err));
    } else {
      console.log("setCredential successfully");
    }
  });
} catch (err) {
  console.log("setCredential exception: " + JSON.stringify(err));
}
1
2
3
4
5
6
7
8
9
10
11
12

setCredential9+

setCredential(name: string, credentialType: string, credential: string): Promise<void>

设置指定应用帐号的凭据。使用Promise异步回调。

系统能力: SystemCapability.Account.AppAccount

参数:

参数名 类型 必填 说明
name string 应用帐号的名称。
credentialType string 凭据类型。
credential string 凭据取值。

返回值:

类型 说明
Promise<void> 无返回结果的Promise对象。

错误码:

错误码ID 错误信息
12300001 System service exception.
12300002 Invalid name or credentialType or credential.
12300003 Account not found.

示例:

let appAccountManager = account_appAccount.createAppAccountManager();
try {
  appAccountManager.setCredential("ZhangSan", "PIN_SIX", "xxxxxx").then(() => {
    console.log("setCredential successfully");
  }).catch((err) => {
    console.log("setCredential failed, error: " + JSON.stringify(err));
  });
} catch (err) {
  console.log("setCredential exception: " + JSON.stringify(err));
}
1
2
3
4
5
6
7
8
9
10

getCredential9+

getCredential(name: string, credentialType: string, callback: AsyncCallback<string>): void

获取指定应用帐号的凭据。使用callback异步回调。

系统能力: SystemCapability.Account.AppAccount

参数:

参数名 类型 必填 说明
name string 应用帐号的名称。
credentialType string 凭据类型。
callback AsyncCallback<string> 回调函数。当获取凭据成功时,err为null,data为指定应用帐号的凭据;否则为错误对象。

错误码:

错误码ID 错误信息
12300001 System service exception.
12300002 Invalid name or credentialType.
12300003 Account not found.
12300102 Credential not found.

示例:

let appAccountManager = account_appAccount.createAppAccountManager();
try {
    appAccountManager.getCredential("ZhangSan", "PIN_SIX", (err, result) => { 
      if (err) {
        console.log("getCredential failed, error: " + JSON.stringify(err));
      } else {
        console.log('getCredential successfully, result: ' + result);
      }
    });
} catch (err) {
    console.log("getCredential err: " + JSON.stringify(err));
}
1
2
3
4
5
6
7
8
9
10
11
12

getCredential9+

getCredential(name: string, credentialType: string): Promise<string>

获取指定应用帐号的凭据。使用Promise异步回调。

系统能力: SystemCapability.Account.AppAccount

参数:

参数名 类型 必填 说明
name string 应用帐号的名称。
credentialType string 凭据类型。

返回值:

类型 说明
Promise<string> Promise对象,返回指定应用帐号的凭据。

错误码:

错误码ID 错误信息
12300001 System service exception.
12300002 Invalid name or credentialType.
12300003 Account not found.
12300102 Credential not found.

示例:

let appAccountManager = account_appAccount.createAppAccountManager();
try {
  appAccountManager.getCredential("ZhangSan", "PIN_SIX").then((credential) => {
      console.log("getCredential successfully, credential: " + credential);
  }).catch((err) => {
      console.log("getCredential failed, error: " + JSON.stringify(err));
  });
} catch (err) {
  console.log("getCredential exception: "  + JSON.stringify(err));
}
1
2
3
4
5
6
7
8
9
10

setCustomData9+

setCustomData(name: string, key: string, value: string, callback: AsyncCallback<void>): void

设置指定应用帐号的自定义数据。使用callback异步回调。

系统能力: SystemCapability.Account.AppAccount

参数:

参数名 类型 必填 说明
name string 应用帐号的名称。
key string 自定义数据的键名。
value string 自定义数据的取值。
callback AsyncCallback<void> 回调函数。当设置自定义数据成功时,err为null,否则为错误对象。

错误码:

错误码ID 错误信息
12300001 System service exception.
12300002 Invalid name or key or value.
12300003 Account not found.
12400003 The number of custom data reaches the upper limit.

示例:

let appAccountManager = account_appAccount.createAppAccountManager();
try {
  appAccountManager.setCustomData("ZhangSan", "age", "12", (err) => {
    if (err) {
      console.log("setCustomData failed, error: " + JSON.stringify(err));
    } else {
      console.log("setCustomData successfully");
    }
  });
} catch (err) {
  console.log("setCustomData exception: " + JSON.stringify(err));
}
1
2
3
4
5
6
7
8
9
10
11
12

setCustomData9+

setCustomData(name: string, key: string, value: string): Promise<void>

设置指定应用帐号的自定义数据。使用Promise异步回调。

系统能力: SystemCapability.Account.AppAccount

参数:

参数名 类型 必填 说明
name string 应用帐号的名称。
key string 自定义数据的键名。
value string 自定义数据的取值。

返回值:

类型 说明
Promise<void> 无返回结果的Promise对象。

错误码:

错误码ID 错误信息
12300001 System service exception.
12300002 Invalid name or key or value.
12300003 Account not found.
12400003 The number of custom data reaches the upper limit.

示例:

let appAccountManager = account_appAccount.createAppAccountManager();
try {
  appAccountManager.setCustomData("ZhangSan", "age", "12").then(() => {
    console.log("setCustomData successfully");
  }).catch((err) => {
    console.log("setCustomData failed, error: " + JSON.stringify(err));
  });
} catch (err) {
  console.log("setCustomData exception: " + JSON.stringify(err));
}
1
2
3
4
5
6
7
8
9
10

getCustomData9+

getCustomData(name: string, key: string, callback: AsyncCallback<string>): void

根据指定键名获取特定应用帐号的自定义数据。使用callback异步回调。

系统能力: SystemCapability.Account.AppAccount

参数:

参数名 类型 必填 说明
name string 应用帐号的名称。
key string 自定义数据的键名。
callback AsyncCallback<string> 回调函数。当获取成功时,err为null,data为自定义数据的取值;否则为错误对象。

错误码:

错误码ID 错误信息
12300001 System service exception.
12300002 Invalid name or key.
12300003 Account not found.
12400002 Custom data not found.

示例:

let appAccountManager = account_appAccount.createAppAccountManager();
try {
  appAccountManager.getCustomData("ZhangSan", "age", (err, data) => {
    if (err) {
      console.log('getCustomData failed, error: ' + err);
    } else {
      console.log("getCustomData successfully, data: " + data);
    }
  });
} catch (err) {
  console.log("getCustomData exception: " + JSON.stringify(err));
}
1
2
3
4
5
6
7
8
9
10
11
12

getCustomData9+

getCustomData(name: string, key: string): Promise<string>

根据指定键名获取特定应用帐号的自定义数据。使用Promise异步回调。

系统能力: SystemCapability.Account.AppAccount

参数:

参数名 类型 必填 说明
name string 应用帐号的名称。
key string 自定义数据的键名。

返回值:

类型 说明
Promise<string> Promise对象,返回自定义数据的取值。

错误码:

错误码ID 错误信息
12300001 System service exception.
12300002 Invalid name or key.
12300003 Account not found.
12400002 Custom data not found.

示例:

let appAccountManager = account_appAccount.createAppAccountManager();
try {
  appAccountManager.getCustomData("ZhangSan", "age").then((data) => {
    console.log("getCustomData successfully, data: " + data);
  }).catch((err) => {
    console.log("getCustomData failed, error: " + JSON.stringify(err));
  });
} catch (err) {
  console.log("getCustomData exception: " + JSON.stringify(err));
}
1
2
3
4
5
6
7
8
9
10

getCustomDataSync9+

getCustomDataSync(name: string, key: string): string;

根据指定键名获取特定应用帐号的自定义数据。使用同步方式返回结果。

系统能力: SystemCapability.Account.AppAccount

参数:

参数名 类型 必填 说明
name string 应用帐号的名称。
key string 自定义数据的键名。

返回值:

类型 说明
string 自定义数据的取值。

错误码:

错误码ID 错误信息
12300001 System service exception.
12300002 Invalid name or key.
12300003 Account not found.
12400002 Custom data not found.

示例:

let appAccountManager = account_appAccount.createAppAccountManager();
try {
    let value = appAccountManager.getCustomDataSync("ZhangSan", "age");
    console.info("getCustomDataSync successfully, vaue:" + value);
} catch (err) {
  console.error("getCustomDataSync failed, error: " + JSON.stringify(err));
}
1
2
3
4
5
6
7

getAllAccounts9+

getAllAccounts(callback: AsyncCallback<Array<AppAccountInfo>>): void

获取所有可访问的应用帐号信息。使用callback异步回调。

需要权限: ohos.permission.GET_ALL_APP_ACCOUNTS。

系统能力: SystemCapability.Account.AppAccount

参数:

参数名 类型 必填 说明
callback AsyncCallback<Array<AppAccountInfo>> 回调函数。当查询成功时,err为null,data为获取到的应用帐号信息列表;否则为错误对象。

错误码:

错误码ID 错误信息
12300001 System service exception.

示例:

let appAccountManager = account_appAccount.createAppAccountManager();
try {
  appAccountManager.getAllAccounts((err, data) => {
    if (err) {
      console.debug("getAllAccounts failed, error:" + JSON.stringify(err));
    } else {
      console.debug("getAllAccounts successfully");
    }
  });
} catch (err) {
    console.debug("getAllAccounts exception: " + JSON.stringify(err));
}
1
2
3
4
5
6
7
8
9
10
11
12

getAllAccounts9+

getAllAccounts(): Promise<Array<AppAccountInfo>>

获取所有可访问的应用帐号信息。使用Promise异步回调。

需要权限: ohos.permission.GET_ALL_APP_ACCOUNTS。

系统能力: SystemCapability.Account.AppAccount

返回值:

类型 说明
Promise<Array<AppAccountInfo>> Promise对象,返回全部应用已授权帐号信息对象。

错误码:

错误码ID 错误信息
12300001 System service exception.

示例:

let appAccountManager = account_appAccount.createAppAccountManager();
try {
  appAccountManager.getAllAccounts().then((data) => {
    console.debug("getAllAccounts successfully");
  }).catch((err) => {
    console.debug("getAllAccounts failed, error:" + JSON.stringify(err));
  });
} catch (err) {
  console.debug("getAllAccounts exception: " + JSON.stringify(err));
}
1
2
3
4
5
6
7
8
9
10

getAccountsByOwner9+

getAccountsByOwner(owner: string, callback: AsyncCallback<Array<AppAccountInfo>>): void

根据应用帐号所有者获取调用方可访问的应用帐号列表。使用callback异步回调。

需要权限: ohos.permission.GET_ALL_APP_ACCOUNTS。

系统能力: SystemCapability.Account.AppAccount

参数:

参数名 类型 必填 说明
owner string 应用帐号所有者的包名。
callback AsyncCallback<Array<AppAccountInfo>> 回调函数。如果获取成功,err为null,data为获取到的应用帐号列表;否则为错误对象。

错误码:

错误码ID 错误信息
12300001 System service exception.
12300002 Invalid owner.
12400001 Application not found.

示例:

let appAccountManager = account_appAccount.createAppAccountManager();
try {
  appAccountManager.getAccountsByOwner("com.example.accountjsdemo2", (err, data) => {
    if (err) {
      console.debug("getAccountsByOwner failed, error:" + JSON.stringify(err));
    } else {
      console.debug("getAccountsByOwner successfully, data:" + JSON.stringify(data));
    }
  });
} catch (err) {
  console.debug("getAccountsByOwner exception:" + JSON.stringify(err));
}
1
2
3
4
5
6
7
8
9
10
11
12

getAccountsByOwner9+

getAccountsByOwner(owner: string): Promise<Array<AppAccountInfo>>

根据应用帐号所有者获取调用方可访问的应用帐号列表。使用Promise异步回调。

需要权限: ohos.permission.GET_ALL_APP_ACCOUNTS。

系统能力: SystemCapability.Account.AppAccount

参数:

参数名 类型 必填 说明
owner string 应用帐号所有者的包名。

返回值:

类型 说明
Promise<Array<AppAccountInfo>> Promise对象,返回获取到的应用帐号列表。

错误码:

错误码ID 错误信息
12300001 System service exception.
12300002 Invalid owner.
12400001 Application not found.

示例:

let appAccountManager = account_appAccount.createAppAccountManager();
try {
  appAccountManager.getAccountsByOwner("com.example.accountjsdemo2").then((data) => {
    console.debug("getAccountsByOwner successfully, data:" + JSON.stringify(data));
  }).catch((err) => {
    console.debug("getAccountsByOwner failed, error:" + JSON.stringify(err));
  });
} catch (err) {
  console.debug("getAccountsByOwner exception:" + JSON.stringify(err));
}
1
2
3
4
5
6
7
8
9
10

on('accountChange')9+

on(type: 'accountChange', owners: Array<string>, callback: Callback<Array<AppAccountInfo>>): void

订阅指定应用的帐号信息变更事件。

系统能力: SystemCapability.Account.AppAccount

参数:

参数名 类型 必填 说明
type 'accountChange' 事件回调类型,支持的事件为'accountChange',当目标应用更新帐号信息时,触发该事件。
owners Array<string> 应用帐号所有者的包名列表。
callback Callback<Array<AppAccountInfo>> 回调函数,返回信息发生变更的应用帐号列表。

错误码:

错误码ID 错误信息
12300001 System service exception.
12300002 Invalid type or owners.
12300011 Callback has been registered.
12400001 Application not found.

示例:

let appAccountManager = account_appAccount.createAppAccountManager();
function changeOnCallback(data){
	console.log("receive change data:" + JSON.stringify(data));
}
try{
	appAccountManager.on("accountChange", ["com.example.actsaccounttest"], changeOnCallback);
} catch(err) {
	console.error("on accountChange failed, error:" + JSON.stringify(err));
}
1
2
3
4
5
6
7
8
9

off('accountChange')9+

off(type: 'accountChange', callback?: Callback<Array<AppAccountInfo>>): void

取消订阅帐号信息变更事件。

系统能力: SystemCapability.Account.AppAccount

参数:

参数名 类型 必填 说明
type 'accountChange' 事件回调类型,支持的事件为'accountChange',当帐号所有者更新帐号信息时,触发该事件。
callback Callback<Array<AppAccountInfo>> 回调函数,返回信息发生变更的应用帐号列表。

错误码:

错误码ID 错误信息
12300001 System service exception.
12300002 Invalid type.
12300012 Callback has not been registered.

示例:

let appAccountManager = account_appAccount.createAppAccountManager();
function changeOnCallback(data){
	console.log("receive change data:" + JSON.stringify(data));
}
try{
	appAccountManager.on("accountChange", ["com.example.actsaccounttest"], changeOnCallback);
} catch(err) {
	console.error("on accountChange failed, error:" + JSON.stringify(err));
}
try{
	appAccountManager.off('accountChange', changeOnCallback);
}
catch(err){
	console.error("off accountChange failed, error:" + JSON.stringify(err));
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15

auth9+

auth(name: string, owner: string, authType: string, callback: AuthCallback): void

对应用帐号进行鉴权以获取授权令牌。使用callback异步回调。

系统能力: SystemCapability.Account.AppAccount

参数:

参数名 类型 必填 说明
name string 应用帐号的名称。
owner string 应用帐号所有者的包名。
authType string 鉴权类型。
callback AuthCallback 回调对象,返回鉴权结果。

错误码:

错误码ID 错误信息
12300001 System service exception.
12300002 Invalid name or owner or authType.
12300003 Account not found.
12300010 Account service busy.
12300113 Authenticator service not found.
12300114 Authenticator service exception.

示例:

import featureAbility from '@ohos.ability.featureAbility';

function onResultCallback(code, authResult) {
  console.log("resultCode: "  + code);
  console.log("authResult: "  + JSON.stringify(authResult));
}

function onRequestRedirectedCallback(request) {
  let abilityStartSetting = {want: request};
  featureAbility.startAbility(abilityStartSetting, (err) => {
      console.log("startAbility err: " + JSON.stringify(err));
  });
}

let appAccountManager = account_appAccount.createAppAccountManager();
try {
  appAccountManager.auth("LiSi", "com.example.accountjsdemo", "getSocialData", {
      onResult: onResultCallback,
      onRequestRedirected: onRequestRedirectedCallback
  });
} catch (err) {
  console.log("auth exception: "  + JSON.stringify(err));
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23

auth9+

auth(name: string, owner: string, authType: string, options: {[key: string]: Object}, callback: AuthCallback): void

对应用帐号进行鉴权以获取授权令牌。使用callback异步回调。

系统能力: SystemCapability.Account.AppAccount

参数:

参数名 类型 必填 说明
name string 应用帐号的名称。
owner string 应用帐号所有者的包名。
authType string 鉴权类型。
options {[key: string]: Object} 鉴权所需的可选项。
callback AuthCallback 回调对象,返回鉴权结果。

错误码:

错误码ID 错误信息
12300001 System service exception.
12300002 Invalid name or owner or authType.
12300003 Account not exist.
12300010 Account service busy.
12300113 Authenticator service not found.
12300114 Authenticator service exception.

示例:

import featureAbility from '@ohos.ability.featureAbility';

function onResultCallback(code, authResult) {
  console.log("resultCode: "  + code);
  console.log("authResult: "  + JSON.stringify(authResult));
}

function onRequestRedirectedCallback(request) {
  let abilityStartSetting = {want: request};
  featureAbility.startAbility(abilityStartSetting, (err) => {
      console.log("startAbility err: " + JSON.stringify(err));
  });
}

let options = {
  "password": "xxxx",
};
let appAccountManager = account_appAccount.createAppAccountManager();
try {
  appAccountManager.auth("LiSi", "com.example.accountjsdemo", "getSocialData", options, {
      onResult: onResultCallback,
      onRequestRedirected: onRequestRedirectedCallback
  });
} catch (err) {
  console.log("auth exception: "  + JSON.stringify(err));
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26

getAuthToken9+

getAuthToken(name: string, owner: string, authType: string, callback: AsyncCallback<string>): void

获取指定应用帐号的特定鉴权类型的授权令牌。使用callback异步回调。

系统能力: SystemCapability.Account.AppAccount

参数:

参数名 类型 必填 说明
name string 应用帐号的名称。
owner string 应用帐号所有者的包名。
authType string 鉴权类型。
callback AsyncCallback<string> 回调函数。当获取成功时,err为null,data为授权令牌值;否则为错误对象。

错误码:

错误码ID 错误信息
12300001 System service exception.
12300002 Invalid name, owner or authType.
12300003 Account not found.
12300107 AuthType not found.

示例:

let appAccountManager = account_appAccount.createAppAccountManager();
try {
  appAccountManager.getAuthToken("LiSi", "com.example.accountjsdemo", "getSocialData", (err, token) => {
    if (err) {
      console.log("getAuthToken failed, error: " + JSON.stringify(err));
    } else {
      console.log("getAuthToken successfully, token: " + token);
    }
  });
} catch (err) {
    console.log("getAuthToken exception: " + JSON.stringify(err));
}
1
2
3
4
5
6
7
8
9
10
11
12

getAuthToken9+

getAuthToken(name: string, owner: string, authType: string): Promise<string>

获取指定应用帐号的特定鉴权类型的授权令牌。使用Promise异步回调。

系统能力: SystemCapability.Account.AppAccount

参数:

参数名 类型 必填 说明
name string 应用帐号的名称。
owner string 应用帐号所有者的包名。
authType string 鉴权类型。

返回值:

类型 说明
Promise<string> Promise对象,返回授权令牌。

错误码:

错误码ID 错误信息
12300001 System service exception.
12300002 Invalid name or owner or authType.
12300003 Account not found.
12300107 AuthType not found.

示例:

let appAccountManager = account_appAccount.createAppAccountManager();
try {
  appAccountManager.getAuthToken("LiSi", "com.example.accountjsdemo", "getSocialData").then((token) => {
    console.log("getAuthToken successfully, token: " + token);
  }).catch((err) => {
    console.log("getAuthToken failed, error: " + JSON.stringify(err));
  });
} catch (err) {
    console.log("getAuthToken exception: " + JSON.stringify(err));
}
1
2
3
4
5
6
7
8
9
10

setAuthToken9+

setAuthToken(name: string, authType: string, token: string, callback: AsyncCallback<void>): void

为指定应用帐号设置特定鉴权类型的授权令牌。使用callback异步回调。

系统能力: SystemCapability.Account.AppAccount

参数:

参数名 类型 必填 说明
name string 应用帐号的名称。
authType string 鉴权类型。
token string 授权令牌。
callback AsyncCallback<void> 回调函数。当设置成功时,err为null;否则为错误对象。

错误码:

错误码ID 错误信息
12300001 System service exception.
12300002 Invalid name or authType or token.
12300003 Account not found.
12400004 The number of token reaches the upper limit.

示例:

let appAccountManager = account_appAccount.createAppAccountManager();
try {
  appAccountManager.setAuthToken("LiSi", "getSocialData", "xxxx", (err) => {
    if (err) {
      console.log("setAuthToken failed, error: " + JSON.stringify(err));
    } else {
      console.log("setAuthToken successfully");
    }
  });
} catch (err) {
    console.log('setAuthToken exception: ' + JSON.stringify(err));
}
1
2
3
4
5
6
7
8
9
10
11
12

setAuthToken9+

setAuthToken(name: string, authType: string, token: string): Promise<void>

为指定应用帐号设置特定鉴权类型的授权令牌。使用Promise异步回调。

系统能力: SystemCapability.Account.AppAccount

参数:

参数名 类型 必填 说明
name string 应用帐号的名称。
authType string 鉴权类型。
token string 授权令牌。

返回值:

类型 说明
Promise<void> 无返回结果的Promise对象。

错误码:

错误码ID 错误信息
12300001 System service exception.
12300002 Invalid name or authType or token.
12300003 Account not found.
12400004 The number of token reaches the upper limit.

示例:

let appAccountManager = account_appAccount.createAppAccountManager();
try {
  appAccountManager.setAuthToken("LiSi", "getSocialData", "xxxx").then(() => {
      console.log("setAuthToken successfully");
  }).catch((err) => {
      console.log("setAuthToken failed, error: " + JSON.stringify(err));
  });
} catch (err) {
  console.log("setAuthToken exception: " + JSON.stringify(err));
}
1
2
3
4
5
6
7
8
9
10

deleteAuthToken9+

deleteAuthToken(name: string, owner: string, authType: string, token: string, callback: AsyncCallback<void>): void

删除指定应用帐号的特定鉴权类型的授权令牌。使用callback异步回调。

系统能力: SystemCapability.Account.AppAccount

参数:

参数名 类型 必填 说明
name string 应用帐号的名称。
owner string 应用帐号所有者的包名。
authType string 鉴权类型。
token string 授权令牌。
callback AsyncCallback<void> 回调函数。当删除成功时,err为null;否则为错误对象。

错误码:

错误码ID 错误信息
12300001 System service exception.
12300002 Invalid name or owner or authType or token.
12300003 Account not found.
12300107 AuthType not found.

示例:

let appAccountManager = account_appAccount.createAppAccountManager();
try {
    appAccountManager.deleteAuthToken("LiSi", "com.example.accountjsdemo", "getSocialData", "xxxxx", (err) => {
      if (err) {
        console.log('deleteAuthToken failed, error: ' + JSON.stringify(err));
      } else {
        console.log("deleteAuthToken successfully");
      }
    });
} catch (err) {
    console.log('deleteAuthToken exception: ' + JSON.stringify(err));
}
1
2
3
4
5
6
7
8
9
10
11
12

deleteAuthToken9+

deleteAuthToken(name: string, owner: string, authType: string, token: string): Promise<void>

删除指定应用帐号的特定鉴权类型的授权令牌。使用Promise异步回调。

系统能力: SystemCapability.Account.AppAccount

参数:

参数名 类型 必填 说明
name string 应用帐号的名称。
owner string 应用帐号所有者的包名。
authType string 鉴权类型。
token string 授权令牌。

返回值:

类型 说明
Promise<void> 无返回结果的Promise对象。

错误码:

错误码ID 错误信息
12300001 System service exception.
12300002 Invalid name or owner or authType or token.
12300003 Account not found.
12300107 AuthType not found.

示例:

let appAccountManager = account_appAccount.createAppAccountManager();
try {
  appAccountManager.deleteAuthToken("LiSi", "com.example.accountjsdemo", "getSocialData", "xxxxx").then(() => {
    console.log("deleteAuthToken successfully");
  }).catch((err) => {
    console.log('deleteAuthToken failed, error: ' + JSON.stringify(err));
  });
} catch (err) {
  console.log('deleteAuthToken exception: ' + JSON.stringify(err));
}
1
2
3
4
5
6
7
8
9
10

setAuthTokenVisibility9+

setAuthTokenVisibility(name: string, authType: string, bundleName: string, isVisible: boolean, callback: AsyncCallback<void>): void

设置指定帐号的特定鉴权类型的授权令牌对指定应用的可见性。使用callback异步回调。

系统能力: SystemCapability.Account.AppAccount

参数:

参数名 类型 必填 说明
name string 应用帐号的名称。
authType string 鉴权类型。
bundleName string 被设置可见性的应用包名。
isVisible boolean 是否可见。true表示可见,false表示不可见。
callback AsyncCallback<void> 回调函数。当设置成功时,err为null;否则为错误对象。

错误码:

错误码ID 错误信息
12300001 System service exception.
12300002 Invalid name or authType or bundleName.
12300003 Account not found.
12300107 AuthType not found.
12400001 Application not found.
12400005 The size of authorization list reaches the upper limit.

示例:

let appAccountManager = account_appAccount.createAppAccountManager();
try {
    appAccountManager.setAuthTokenVisibility("LiSi", "getSocialData", "com.example.accountjsdemo", true, (err) => {
      if (err) {
        console.log("setAuthTokenVisibility failed, error: " + JSON.stringify(err));
      } else {
        console.log("setAuthTokenVisibility successfully");
      }
    });
} catch (err) {
    console.log("setAuthTokenVisibility exception: " + JSON.stringify(err));
}
1
2
3
4
5
6
7
8
9
10
11
12

setAuthTokenVisibility9+

setAuthTokenVisibility(name: string, authType: string, bundleName: string, isVisible: boolean): Promise<void>

设置指定帐号的特定鉴权类型的授权令牌对指定应用的可见性。使用Promise异步回调。

系统能力: SystemCapability.Account.AppAccount

参数:

参数名 类型 必填 说明
name string 应用帐号的名称。
authType string 鉴权类型。
bundleName string 被设置可见性的应用包名。
isVisible boolean 是否可见。true表示可见,false表示不可见。

返回值:

类型 说明
Promise<void> 无返回结果的Promise对象。

错误码:

错误码ID 错误信息
12300001 System service exception.
12300002 Invalid name or authType or bundleName.
12300003 Account not found.
12300107 AuthType not found.
12400001 Application not found.
12400005 The size of authorization list reaches the upper limit.

示例:

let appAccountManager = account_appAccount.createAppAccountManager();
try {
  appAccountManager.setAuthTokenVisibility("LiSi", "getSocialData", "com.example.accountjsdemo", true).then(() => {
    console.log("setAuthTokenVisibility successfully");
  }).catch((err) => {
    console.log("setAuthTokenVisibility failed, error: " + JSON.stringify(err));
  });
} catch (err) {
  console.log("setAuthTokenVisibility exception: " + JSON.stringify(err));
}
1
2
3
4
5
6
7
8
9
10

checkAuthTokenVisibility9+

checkAuthTokenVisibility(name: string, authType: string, bundleName: string, callback: AsyncCallback<boolean>): void

检查指定应用帐号的特定鉴权类型的授权令牌对指定应用的可见性。使用callback异步回调。

系统能力: SystemCapability.Account.AppAccount

参数:

参数名 类型 必填 说明
name string 应用帐号的名称。
authType string 鉴权类型。
bundleName string 检查可见性的应用包名。
callback AsyncCallback<boolean> 回调函数。当检查成功时,err为null,data为true表示可见,data为false表示不可见;否则为错误对象。

错误码:

错误码ID 错误信息
12300001 System service exception.
12300002 Invalid name or authType or bundleName.
12300003 Account not found.
12300107 AuthType not found.
12400001 Application not found.

示例:

let appAccountManager = account_appAccount.createAppAccountManager();
try {
  appAccountManager.checkAuthTokenVisibility("LiSi", "getSocialData", "com.example.accountjsdemo", (err, isVisible) => {
    if (err) {
      console.log("checkAuthTokenVisibility failed, error: " + JSON.stringify(err));
    } else {
      console.log("checkAuthTokenVisibility successfully, isVisible: " + isVisible);
    }
  });
} catch (err) {
  console.log("checkAuthTokenVisibility exception: " + JSON.stringify(err));
}
1
2
3
4
5
6
7
8
9
10
11
12

checkAuthTokenVisibility9+

checkAuthTokenVisibility(name: string, authType: string, bundleName: string): Promise<boolean>

检查指定应用帐号的特定鉴权类型的授权令牌对指定应用的可见性。使用Promise异步回调。

系统能力: SystemCapability.Account.AppAccount

参数:

参数名 类型 必填 说明
name string 应用帐号的名称。
authType string 鉴权类型。
bundleName string 用于检查可见性的应用包名。

返回值:

类型 说明
Promise<boolean> Promise对象。返回true表示授权令牌对指定应用的可见,返回false表示不可见。

错误码:

错误码ID 错误信息
12300001 System service exception.
12300002 Invalid name or authType or bundleName.
12300003 Account not found.
12300107 AuthType not found.
12400001 Application not found.

示例:

let appAccountManager = account_appAccount.createAppAccountManager();
try {
  appAccountManager.checkAuthTokenVisibility("LiSi", "getSocialData", "com.example.accountjsdemo").then((isVisible) => {
    console.log("checkAuthTokenVisibility successfully, isVisible: " + isVisible);
  }).catch((err) => {
    console.log("checkAuthTokenVisibility failed, error: " + JSON.stringify(err));
  });
} catch (err) {
  console.log("checkAuthTokenVisibility exception: " + JSON.stringify(err));
}
1
2
3
4
5
6
7
8
9
10

getAllAuthTokens9+

getAllAuthTokens(name: string, owner: string, callback: AsyncCallback<Array<AuthTokenInfo>>): void

获取指定帐号对调用方可见的所有授权令牌。使用callback异步回调。

系统能力: SystemCapability.Account.AppAccount

参数:

参数名 类型 必填 说明
name string 应用帐号的名称。
owner string 应用帐号所有者的包名。
callback AsyncCallback<Array<AuthTokenInfo>> 回调函数。当获取成功时,err为null,data为授权令牌数组;否则为错误对象。

错误码:

错误码ID 错误信息
12300001 System service exception.
12300002 Invalid name or owner.
12300003 Account not found.

示例:

let appAccountManager = account_appAccount.createAppAccountManager();
try {
  appAccountManager.getAllAuthTokens("LiSi", "com.example.accountjsdemo", (err, tokenArr) => {
    if (err) {
      console.log("getAllAuthTokens failed, error: "  + JSON.stringify(err));
    } else {
      console.log('getAllAuthTokens successfully, tokenArr: ' + tokenArr);
    }
  });
} catch (err) {
  console.log("getAllAuthTokens exception: "  + JSON.stringify(err));
}
1
2
3
4
5
6
7
8
9
10
11
12

getAllAuthTokens9+

getAllAuthTokens(name: string, owner: string): Promise<Array<AuthTokenInfo>>

获取指定帐号对调用方可见的所有授权令牌。使用Promise异步回调。

系统能力: SystemCapability.Account.AppAccount

参数:

参数名 类型 必填 说明
name string 应用帐号的名称。
owner string 应用帐号所有者的包名。

返回值:

类型 说明
Promise<Array<AuthTokenInfo>> Promise对象,返回授权令牌数组。

错误码:

错误码ID 错误信息
12300001 System service exception.
12300002 Invalid name or owner.
12300003 Account not found.

示例:

let appAccountManager = account_appAccount.createAppAccountManager();
try {
  appAccountManager.getAllAuthTokens("LiSi", "com.example.accountjsdemo").then((tokenArr) => {
      console.log('getAllAuthTokens successfully, tokenArr: ' + JSON.stringify(tokenArr));
  }).catch((err) => {
      console.log("getAllAuthTokens failed, error: "  + JSON.stringify(err));
  });
} catch (err) {
  console.log("getAllAuthTokens exception: "  + JSON.stringify(err));
}
1
2
3
4
5
6
7
8
9
10

getAuthList9+

getAuthList(name: string, authType: string, callback: AsyncCallback<Array<string>>): void

获取指定应用帐号的特定鉴权类型的授权列表,即被授权的包名数组(令牌的授权列表通过setAuthTokenVisibility来设置)。使用callback异步回调。

系统能力: SystemCapability.Account.AppAccount

参数:

参数名 类型 必填 说明
name string 应用帐号的名称。
authType string 鉴权类型。
callback AsyncCallback<Array<string>> 回调函数。当获取成功时,err为null,data为被授权的包名数组;否则为错误对象。

错误码:

错误码ID 错误信息
12300001 System service exception.
12300002 Invalid name or authType.
12300003 Account not found.
12300107 AuthType not found.

示例:

let appAccountManager = account_appAccount.createAppAccountManager();
try {
  appAccountManager.getAuthList("com.example.accountjsdemo", "getSocialData", (err, authList) => {
    if (err) {
      console.log("getAuthList failed, error: " + JSON.stringify(err));
    } else {
      console.log("getAuthList successfully, authList: " + authList);
    }
  });
} catch (err) {
  console.log('getAuthList exception: ' + JSON.stringify(err));
}
1
2
3
4
5
6
7
8
9
10
11
12

getAuthList9+

getAuthList(name: string, authType: string): Promise<Array<string>>

获取指定应用帐号的特定鉴权类型的授权列表,即被授权的包名数组(令牌的授权列表通过setAuthTokenVisibility来设置)。使用Promise异步回调。

系统能力: SystemCapability.Account.AppAccount

参数:

参数名 类型 必填 说明
name string 应用帐号的名称。
authType string 鉴权类型。

返回值:

类型 说明
Promise<Array<string>> Promise对象,返回被授权的包名数组。

错误码:

错误码ID 错误信息
12300001 System service exception.
12300002 Invalid name or authType.
12300003 Account not found.
12300107 AuthType not found.

示例:

let appAccountManager = account_appAccount.createAppAccountManager();
try {
  appAccountManager.getAuthList("com.example.accountjsdemo", "getSocialData").then((authList) => {
      console.log("getAuthList successfully, authList: " + authList);
  }).catch((err) => {
      console.log("getAuthList failed, error: "  + JSON.stringify(err));
  });
} catch (err) {
  console.log("getAuthList exception: "  + JSON.stringify(err));
}
1
2
3
4
5
6
7
8
9
10

getAuthCallback9+

getAuthCallback(sessionId: string, callback: AsyncCallback<AuthCallback>): void

获取鉴权会话的认证器回调对象。使用callback异步回调。

系统能力: SystemCapability.Account.AppAccount

参数:

参数名 类型 必填 说明
sessionId string 鉴权会话的标识。
callback AsyncCallback<AuthCallback> 回调函数。当获取成功时,err为null,data为鉴权会话的认证器回调对象;否则为错误对象。

错误码:

错误码ID 错误信息
12300001 System service exception.
12300002 Invalid sessionId.
12300108 Session not found.

示例:

import featureAbility from '@ohos.ability.featureAbility';
let appAccountManager = account_appAccount.createAppAccountManager();
featureAbility.getWant((err, want) => {
  var sessionId = want.parameters[account_appAccount.Constants.KEY_SESSION_ID];
  try {
    appAccountManager.getAuthCallback(sessionId, (err, callback) => {
      if (err.code != account_appAccount.ResultCode.SUCCESS) {
          console.log("getAuthCallback err: "  + JSON.stringify(err));
          return;
      }
      var result = {
        accountInfo: {
          name: "Lisi",
          owner: "com.example.accountjsdemo",
        },
        tokenInfo: {
          token: "xxxxxx",
          authType: "getSocialData"
        }
      }; 
      callback.onResult(account_appAccount.ResultCode.SUCCESS, result);
    });
  } catch (err) {
      console.log("getAuthCallback exception: "  + JSON.stringify(err));
  }
});
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26

getAuthCallback9+

getAuthCallback(sessionId: string): Promise<AuthCallback>

获取鉴权会话的认证器回调对象。使用Promise异步回调。

系统能力: SystemCapability.Account.AppAccount

参数:

参数名 类型 必填 说明
sessionId string 鉴权会话的标识。

返回值:

类型 说明
Promise<AuthCallback> Promise对象,返回鉴权会话的认证器回调对象。

错误码:

错误码ID 错误信息
12300001 System service exception.
12300002 Invalid sessionId.
12300108 Session not found.

示例:

import featureAbility from '@ohos.ability.featureAbility';

let appAccountManager = account_appAccount.createAppAccountManager();
featureAbility.getWant().then((want) => {
    var sessionId = want.parameters[account_appAccount.Constants.KEY_SESSION_ID];
    try {
      appAccountManager.getAuthCallback(sessionId).then((callback) => {
      var result = {
        accountInfo: {
          name: "Lisi",
          owner: "com.example.accountjsdemo",
        },
        tokenInfo: {
          token: "xxxxxx",
          authType: "getSocialData"
        }
      };
      callback.onResult(account_appAccount.ResultCode.SUCCESS, result);
      }).catch((err) => {
          console.log("getAuthCallback err: "  + JSON.stringify(err));
      });
    } catch (err) {
      console.log("getAuthCallback exception: "  + JSON.stringify(err));
    }
}).catch((err) => {
    console.log("getWant err: "  + JSON.stringify(err));
});
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27

queryAuthenticatorInfo9+

queryAuthenticatorInfo(owner: string, callback: AsyncCallback<AuthenticatorInfo>): void

获取指定应用的认证器信息。使用callback异步回调。

系统能力: SystemCapability.Account.AppAccount

参数:

参数名 类型 必填 说明
owner string 应用包名。
callback AsyncCallback<AuthenticatorInfo> 回调函数。当获取成功时,err为null,data为认证器信息对象;否则为错误对象。

错误码:

错误码ID 错误信息
12300001 System service exception.
12300002 Invalid owner.
12300113 Authenticator service not found.

示例:

let appAccountManager = account_appAccount.createAppAccountManager();
try {
  appAccountManager.queryAuthenticatorInfo("com.example.accountjsdemo", (err, info) => {
    if (err) {
      console.log("queryAuthenticatorInfo failed, error: "  + JSON.stringify(err));
    } else {
      console.log('queryAuthenticatorInfo successfully, info: ' + JSON.stringify(info));
    }
  });
} catch (err) {
  console.log("queryAuthenticatorInfo exception: "  + JSON.stringify(err));
}
1
2
3
4
5
6
7
8
9
10
11
12

queryAuthenticatorInfo9+

queryAuthenticatorInfo(owner: string): Promise<AuthenticatorInfo>

获取指定应用的认证器信息。使用Promise异步回调。

系统能力: SystemCapability.Account.AppAccount

参数:

参数名 类型 必填 说明
owner string 应用包名。

返回值:

类型 说明
Promise<AuthenticatorInfo> Promise对象,返回指定应用的认证器信息对象。

错误码:

错误码ID 错误信息
12300001 System service exception.
12300002 Invalid owner.
12300113 Authenticator service not found.

示例:

let appAccountManager = account_appAccount.createAppAccountManager();
try {
  appAccountManager.queryAuthenticatorInfo("com.example.accountjsdemo").then((info) => { 
      console.log("queryAuthenticatorInfo successfully, info: " + JSON.stringify(info));
  }).catch((err) => {
      console.log("queryAuthenticatorInfo failed, error: "  + JSON.stringify(err));
  });
} catch (err) {
  console.log("queryAuthenticatorInfo exception: "  + JSON.stringify(err));
}
1
2
3
4
5
6
7
8
9
10

checkAccountLabels9+

checkAccountLabels(name: string, owner: string, labels: Array<string>, callback: AsyncCallback<boolean>): void;

检查指定应用帐号是否满足特定的标签集合。使用callback异步回调。该方法依赖目标应用的认证器提供标签检查的能力。

系统能力: SystemCapability.Account.AppAccount

参数:

参数名 类型 必填 说明
name string 应用帐号的名称。
owner string 应用帐号的所有者。
labels Array<string> 标签数组。
callback AsyncCallback<boolean> 回调函数。当检查成功时,err为null,data为true表示满足特定的标签集合,data为false表示不满足;否则为错误对象。

错误码:

错误码ID 错误信息
12300001 System service exception.
12300002 Invalid name or owner or labels.
12300003 Account not found.
12300010 Account service busy.
12300113 Authenticator service not found.
12300114 Authenticator service exception.

示例:

let appAccountManager = account_appAccount.createAppAccountManager();
let labels = ["student"];
try {
  appAccountManager.checkAccountLabels("zhangsan", "com.example.accountjsdemo", labels, (err, hasAllLabels) => {
    if (err) {
      console.log("checkAccountLabels failed, error: "  + JSON.stringify(err));
    } else {
      console.log("checkAccountLabels successfully, hasAllLabels: " + hasAllLabels);
    }
  });
} catch (err) {
  console.log("checkAccountLabels exception: "  + JSON.stringify(err));
}
1
2
3
4
5
6
7
8
9
10
11
12
13

checkAccountLabels9+

checkAccountLabels(name: string, owner: string, labels: Array<string>): Promise<boolean>

检查指定应用帐号是否满足特定的标签集合。使用Promise异步回调。该方法依赖目标应用的认证器提供标签检查的能力。

系统能力: SystemCapability.Account.AppAccount

参数:

参数名 类型 必填 说明
name string 应用帐号的名称。
owner string 应用帐号的所有者。
labels Array<string> 标签数组。

返回值:

类型 说明
Promise<boolean> Promise对象。返回true表示指定帐号满足特定的标签集合,返回false表示不满足。

错误码:

错误码ID 错误信息
12300001 System service exception.
12300002 Invalid name or owner or labels.
12300003 Account not found.
12300010 Account service busy.
12300113 Authenticator service not found.
12300114 Authenticator service exception.

示例:

let appAccountManager = account_appAccount.createAppAccountManager();
let labels = ["student"];
try {
  appAccountManager.checkAccountLabels("zhangsan", "com.example.accountjsdemo", labels).then((hasAllLabels) => {
    console.log('checkAccountLabels successfully: ' + hasAllLabels);
  }).catch((err) => {
    console.log("checkAccountLabels failed, error: "  + JSON.stringify(err));
  });
} catch (err) {
  console.log("checkAccountLabels exception: "  + JSON.stringify(err));
}
1
2
3
4
5
6
7
8
9
10
11

deleteCredential9+

deleteCredential(name: string, credentialType: string, callback: AsyncCallback<void>): void

删除指定应用帐号的特定类型的凭据信息。使用callback异步回调。

系统能力: SystemCapability.Account.AppAccount

参数:

参数名 类型 必填 说明
name string 应用帐号的名称。
credentialType string 凭据类型。
callback AsyncCallback<void> 回调函数。当删除成功时,err为null;否则为错误对象。

错误码:

错误码ID 错误信息
12300001 System service exception.
12300002 Invalid name or credentialType.
12300003 Account not found.
12300102 Credential not found.

示例:

let appAccountManager = account_appAccount.createAppAccountManager();
try {
  appAccountManager.deleteCredential("zhangsan", "PIN_SIX", (err) => {
    if (err) {
      console.log("deleteCredential failed, error: "  + JSON.stringify(err));
    } else {
      console.log("deleteCredential successfully");
    }
  });
} catch (err) {
  console.log("deleteCredential exception: "  + JSON.stringify(err));
}
1
2
3
4
5
6
7
8
9
10
11
12

deleteCredential9+

deleteCredential(name: string, credentialType: string): Promise<void>

删除指定应用帐号的特定类型的凭据信息。使用Promise异步回调。

系统能力: SystemCapability.Account.AppAccount

参数:

参数名 类型 必填 说明
name string 应用帐号的名称。
credentialType string 凭据类型。

返回值:

类型 说明
Promise<void> 无返回结果的Promise对象。

错误码:

错误码ID 错误信息
12300001 System service exception.
12300002 Invalid name or credentialType.
12300003 Account not found.
12300102 Credential not found.

示例:

let appAccountManager = account_appAccount.createAppAccountManager();
try {
  appAccountManager.deleteCredential("zhangsan", "PIN_SIX").then(() => {
    console.log("deleteCredential successfully");
  }).catch((err) => {
    console.log("deleteCredential failed, error: " + JSON.stringify(err));
  });
} catch (err) {
  console.log("deleteCredential exception: "  + JSON.stringify(err));
}
1
2
3
4
5
6
7
8
9
10

selectAccountsByOptions9+

selectAccountsByOptions(options: SelectAccountsOptions, callback: AsyncCallback<Array<AppAccountInfo>>): void

根据选项选择调用方可访问的帐号列表。使用callback异步回调。如果选项中包含标签约束,则该方法依赖目标应用的认证器提供标签检查的能力。

系统能力: SystemCapability.Account.AppAccount

参数:

参数名 类型 必填 说明
options SelectAccountsOptions 选择帐号的选项。
callback AsyncCallback<Array<AppAccountInfo>> 回调函数。当根据选项选择请求方可访问的帐号列表时,err为null,data为可访问的帐号信息对象;否则为错误对象。

错误码:

错误码ID 错误信息
12300001 System service exception.
12300002 Invalid options.
12300010 Account service busy.
12300114 Authenticator service exception.

示例:

let appAccountManager = account_appAccount.createAppAccountManager();
let options = {
  allowedOwners: [ "com.example.accountjsdemo" ],
  requiredLabels: [ "student" ]
};
try {
  appAccountManager.selectAccountsByOptions(options, (err, accountArr) => {
    if (err) {
      console.log("selectAccountsByOptions failed, error: "  + JSON.stringify(err));
    } else {
      console.log("selectAccountsByOptions successfully, accountArr: " + JSON.stringify(accountArr));
    }
  });
} catch (err) {
  console.log("selectAccountsByOptions exception: "  + JSON.stringify(err));
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16

selectAccountsByOptions9+

selectAccountsByOptions(options: SelectAccountsOptions): Promise<Array<AppAccountInfo>>

根据选项选择调用方可访问的帐号列表。使用Promise异步回调。如果选项中包含标签约束,则该方法依赖目标应用的认证器提供标签检查的能力。

系统能力: SystemCapability.Account.AppAccount

参数:

参数名 类型 必填 说明
options SelectAccountsOptions 选择帐号的选项。

返回值:

类型 说明
Promise<AppAccountInfo> Promise对象,返回调用方可访问的帐号列表。

错误码:

错误码ID 错误信息
12300001 System service exception.
12300002 Invalid options.
12300010 Account service busy.
12300114 Authenticator service exception.

示例:

let appAccountManager = account_appAccount.createAppAccountManager();
let options = {
  allowedOwners: ["com.example.accountjsdemo"]
};
try {
  appAccountManager.selectAccountsByOptions(options).then((accountArr) => {
    console.log("selectAccountsByOptions successfully, accountArr: " + JSON.stringify(accountArr));
  }).catch((err) => {
    console.log("selectAccountsByOptions failed, error: "  + JSON.stringify(err));
  });
} catch (err) {
  console.log("selectAccountsByOptions exception: "  + JSON.stringify(err));
}
1
2
3
4
5
6
7
8
9
10
11
12
13

verifyCredential9+

verifyCredential(name: string, owner: string, callback: AuthCallback): void;

验证指定帐号的凭据。使用callback异步回调。

系统能力: SystemCapability.Account.AppAccount

参数:

参数名 类型 必填 说明
name string 应用帐号的名称。
owner string 应用帐号所有者的包名。
callback AuthCallback 回调函数,返回验证结果。

错误码:

错误码ID 错误信息
12300001 System service exception.
12300002 Invalid name or owner.
12300003 Account not found.
12300010 Account service busy.
12300113 Authenticator service not found.
12300114 Authenticator service exception.

示例:

let appAccountManager = account_appAccount.createAppAccountManager();
try {
    appAccountManager.verifyCredential("zhangsan", "com.example.accountjsdemo", {
        onResult: (resultCode, result) => {
            console.log("verifyCredential onResult, resultCode:" + JSON.stringify(resultCode));
            console.log("verifyCredential onResult, result:" + JSON.stringify(result));
        },
        onRequestRedirected: (request) => {
            console.log("verifyCredential onRequestRedirected, request:" + JSON.stringify(request));
        }
    });
} catch (err) {
    console.log("verifyCredential err: "  + JSON.stringify(err));
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14

verifyCredential9+

verifyCredential(name: string, owner: string, options: VerifyCredentialOptions, callback: AuthCallback): void;

验证用户凭据。使用callback异步回调。

系统能力: SystemCapability.Account.AppAccount

参数:

参数名 类型 必填 说明
name string 应用帐号的名称。
owner string 应用帐号所有者的包名。
options VerifyCredentialOptions 验证凭据的选项。
callback AuthCallback 回调函数,返回验证结果。

错误码:

错误码ID 错误信息
12300001 System service exception.
12300002 Invalid name or owner or options.
12300003 Account not found.
12300010 Account service busy.
12300113 Authenticator service not found.
12300114 Authenticator service exception.

示例:

let appAccountManager = account_appAccount.createAppAccountManager();
let options = {
  credentialType: "pin",
  credential: "123456"
};
try {
  appAccountManager.verifyCredential("zhangsan", "com.example.accountjsdemo", options, {
    onResult: (resultCode, result) => {
      console.log("verifyCredential onResult, resultCode:" + JSON.stringify(resultCode));
      console.log("verifyCredential onResult, result:" + JSON.stringify(result));
    },
    onRequestRedirected: (request) => {
      console.log("verifyCredential onRequestRedirected, request:" + JSON.stringify(request));
    }
  });
} catch (err) {
  console.log("verifyCredential err: "  + JSON.stringify(err));
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18

setAuthenticatorProperties9+

setAuthenticatorProperties(owner: string, callback: AuthCallback): void;

设置指定应用的认证器属性。使用callback异步回调。

系统能力: SystemCapability.Account.AppAccount

参数:

参数名 类型 必填 说明
owner string 认证器的所有者。
callback AuthCallback 回调函数,返回设置属性的结果。

错误码:

错误码ID 错误信息
12300001 System service exception.
12300002 Invalid owner.
12300010 Account service busy.
12300113 Authenticator service not found.
12300114 Authenticator service exception.

示例:

let appAccountManager = account_appAccount.createAppAccountManager();
try {
  appAccountManager.setAuthenticatorProperties("com.example.accountjsdemo", {
    onResult: (resultCode, result) => {
      console.log("setAuthenticatorProperties onResult, resultCode:" + JSON.stringify(resultCode));
      console.log("setAuthenticatorProperties onResult, result:" + JSON.stringify(result));
    },
    onRequestRedirected: (request) => {
      console.log("setAuthenticatorProperties onRequestRedirected, request:" + JSON.stringify(request));
    }
  });
} catch (err) {
  console.log("setAuthenticatorProperties err: "  + JSON.stringify(err));
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14

setAuthenticatorProperties9+

setAuthenticatorProperties(owner: string, options: SetPropertiesOptions, callback: AuthCallback): void;

设置认证器属性。使用callback异步回调。

系统能力: SystemCapability.Account.AppAccount

参数:

参数名 类型 必填 说明
owner string 认证器的所有者。
options SetPropertiesOptions 设置属性的选项。
callback AuthCallback 认证器回调,返回设置属性的结果。

错误码:

错误码ID 错误信息
12300001 System service exception.
12300002 Invalid owner or options.
12300010 Account service busy.
12300113 Authenticator service not found.
12300114 Authenticator service exception.

示例:

let appAccountManager = account_appAccount.createAppAccountManager();
let options = {
  properties: {"prop1": "value1"}
};
try {
  appAccountManager.setAuthenticatorProperties("com.example.accountjsdemo", options, {
    onResult: (resultCode, result) => {
      console.log("setAuthenticatorProperties onResult, resultCode:" + JSON.stringify(resultCode));
      console.log("setAuthenticatorProperties onResult, result:" + JSON.stringify(result));
    },
    onRequestRedirected: (request) => {
      console.log("setAuthenticatorProperties onRequestRedirected, request:" + JSON.stringify(request));
    }
  });
} catch (err) {
  console.log("setAuthenticatorProperties err: "  + JSON.stringify(err));
} 

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18

addAccount(deprecated)

addAccount(name: string, callback: AsyncCallback<void>): void

根据帐号名添加应用帐号。使用callback异步回调。

说明:

从 API version 7开始支持,从API version 9开始废弃。建议使用createAccount替代。

系统能力: SystemCapability.Account.AppAccount

参数:

参数名 类型 必填 说明
name string 应用帐号的名称。
callback AsyncCallback<void> 回调函数。当创建成功时,err为null,否则为错误对象。

示例:

let appAccountManager = account_appAccount.createAppAccountManager();
appAccountManager.addAccount("WangWu", (err) => { 
    console.log("addAccount err: " + JSON.stringify(err));
});
1
2
3
4

addAccount(deprecated)

addAccount(name: string, extraInfo: string, callback: AsyncCallback<void>): void

根据帐号名和额外信息添加应用帐号。使用callback异步回调。

说明: 从 API version 7开始支持,从API version 9开始废弃。建议使用createAccount替代。

系统能力: SystemCapability.Account.AppAccount

参数:

参数名 类型 必填 说明
name string 应用帐号的名称。
extraInfo string 额外信息(能转换string类型的其它信息),额外信息不能是应用帐号的敏感信息(如应用账号密码、token等)。
callback AsyncCallback<void> 回调函数。当创建成功时,err为null,否则为错误对象。

示例:

let appAccountManager = account_appAccount.createAppAccountManager();
appAccountManager.addAccount("LiSi", "token101", (err) => { 
  console.log("addAccount err: " + JSON.stringify(err));
});
1
2
3
4

addAccount(deprecated)

addAccount(name: string, extraInfo?: string): Promise<void>

根据帐号名和额外信息添加应用帐号。使用callback异步回调。使用Promise异步回调。

说明:
从 API version 7开始支持,从API version 9开始废弃。建议使用createAccount替代。

系统能力: SystemCapability.Account.AppAccount

参数:

参数名 类型 必填 说明
name string 应用帐号的名称。
extraInfo string 额外信息(能转换string类型的其它信息),额外信息不能是应用帐号的敏感信息(如应用账号密码、token等)。

返回值:

类型 说明
Promise<void> 无返回结果的Promise对象。

示例:

let appAccountManager = account_appAccount.createAppAccountManager();
appAccountManager.addAccount("LiSi", "token101").then(()=> { 
  console.log('addAccount Success');
}).catch((err) => {
  console.log("addAccount err: "  + JSON.stringify(err));
});
1
2
3
4
5
6

addAccountImplicitly(deprecated)

addAccountImplicitly(owner: string, authType: string, options: {[key: string]: any}, callback: AuthenticatorCallback): void

根据指定的帐号所有者隐式地添加应用帐号。使用callback异步回调。

说明:

从 API version 8开始支持,从API version 9开始废弃。建议使用createAccountImplicitly替代。

系统能力: SystemCapability.Account.AppAccount

参数:

参数名 类型 必填 说明
owner string 应用帐号所有者的包名。
authType string 鉴权类型。鉴权类型为自定义。
options {[key: string]: any} 鉴权所需要的可选项。可选项可根据自己需要设置。
callback AuthenticatorCallback 认证器回调对象,返回添加结果。

示例:

import featureAbility from '@ohos.ability.featureAbility';

function onResultCallback(code, result) {
  console.log("resultCode: "  + code);
  console.log("result: "  + JSON.stringify(result));
}

function onRequestRedirectedCallback(request) {
  let abilityStartSetting = {want: request};
  featureAbility.startAbility(abilityStartSetting, (err)=>{
    console.log("startAbility err: " + JSON.stringify(err));
  });
}

let appAccountManager = account_appAccount.createAppAccountManager();
appAccountManager.addAccountImplicitly("com.example.accountjsdemo", "getSocialData", {}, {
  onResult: onResultCallback,
  onRequestRedirected: onRequestRedirectedCallback
});
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19

deleteAccount(deprecated)

deleteAccount(name: string, callback: AsyncCallback<void>): void

删除应用帐号。使用callback异步回调。

说明:

从 API version 7开始支持,从API version 9开始废弃。建议使用removeAccount替代。

系统能力: SystemCapability.Account.AppAccount

参数:

参数名 类型 必填 说明
name string 应用帐号的名称。
callback AsyncCallback<void> 回调函数。当删除成功时,err为null,否则为错误对象。

示例:

let appAccountManager = account_appAccount.createAppAccountManager();
appAccountManager.deleteAccount("ZhaoLiu", (err) => { 
    console.log("deleteAccount err: " + JSON.stringify(err));
 });
1
2
3
4

deleteAccount(deprecated)

deleteAccount(name: string): Promise<void>

删除应用帐号。使用Promise异步回调。

说明:

从 API version 7开始支持,从API version 9开始废弃。建议使用removeAccount替代。

系统能力: SystemCapability.Account.AppAccount

参数:

参数名 类型 必填 说明
name string 应用帐号的名称。

返回值:

类型 说明
Promise<void> 无返回结果的Promise对象。

示例:

let appAccountManager = account_appAccount.createAppAccountManager();
appAccountManager.deleteAccount("ZhaoLiu").then(() => { 
      console.log('deleteAccount Success');
 }).catch((err) => {
    console.log("deleteAccount err: "  + JSON.stringify(err));
});
1
2
3
4
5
6

disableAppAccess(deprecated)

disableAppAccess(name: string, bundleName: string, callback: AsyncCallback<void>): void

禁止指定第三方应用帐号名称对指定的第三方应用进行访问。使用callback异步回调。

说明:

从 API version 7开始支持,从API version 9开始废弃。建议使用setAppAccess替代。

系统能力: SystemCapability.Account.AppAccount

参数:

参数名 类型 必填 说明
name string 应用帐号的名称。
bundleName string 第三方应用的包名。
callback AsyncCallback<void> 回调函数。当禁止指定第三方应用帐号名称对指定包名称的第三方应用进行访问设置成功时,err为null,否则为错误对象。

示例:

let appAccountManager = account_appAccount.createAppAccountManager();
appAccountManager.disableAppAccess("ZhangSan", "com.example.accountjsdemo", (err) => { 
    console.log("disableAppAccess err: " + JSON.stringify(err));
});
1
2
3
4

disableAppAccess(deprecated)

disableAppAccess(name: string, bundleName: string): Promise<void>

禁止指定第三方应用帐号名称对指定包名称的第三方应用进行访问。使用Promise异步回调。

说明:

从 API version 7开始支持,从API version 9开始废弃。建议使用setAppAccess替代。

系统能力: SystemCapability.Account.AppAccount

参数:

参数名 类型 必填 说明
name string 要禁用访问的第三方应用帐号的名称。
bundleName string 第三方应用的包名。

返回值:

类型 说明
Promise<void> 无返回结果的Promise对象。

示例:

let appAccountManager = account_appAccount.createAppAccountManager();
appAccountManager.disableAppAccess("ZhangSan", "com.example.accountjsdemo").then(() => { 
    console.log('disableAppAccess Success');
}).catch((err) => {
    console.log("disableAppAccess err: "  + JSON.stringify(err));
});
1
2
3
4
5
6

enableAppAccess(deprecated)

enableAppAccess(name: string, bundleName: string, callback: AsyncCallback<void>): void

允许指定第三方应用帐号名称对指定包名称的第三方应用进行访问。使用callback异步回调。

说明:

从 API version 7开始支持,从API version 9开始废弃。建议使用setAppAccess替代。

系统能力: SystemCapability.Account.AppAccount

参数:

参数名 类型 必填 说明
name string 应用帐号的名称。
bundleName string 第三方应用的包名。
callback AsyncCallback<void> 回调函数。当允许指定第三方应用帐号名称对指定包名称的第三方应用进行访问设置成功时,err为null,否则为错误对象。

示例:

let appAccountManager = account_appAccount.createAppAccountManager();
appAccountManager.enableAppAccess("ZhangSan", "com.example.accountjsdemo", (err) => { 
    console.log("enableAppAccess: " + JSON.stringify(err));
 });
1
2
3
4

enableAppAccess(deprecated)

enableAppAccess(name: string, bundleName: string): Promise<void>

允许指定第三方应用帐号的名称对指定包名称的第三方应用进行访问。使用Promise异步回调。

说明:

从 API version 7开始支持,从API version 9开始废弃。建议使用setAppAccess替代。

系统能力: SystemCapability.Account.AppAccount

参数:

参数名 类型 必填 说明
name string 应用帐号的名称。
bundleName string 第三方应用的包名。

返回值:

类型 说明
Promise<void> 无返回结果的Promise对象。

示例:

let appAccountManager = account_appAccount.createAppAccountManager();
appAccountManager.enableAppAccess("ZhangSan", "com.example.accountjsdemo").then(() => { 
     console.log('enableAppAccess Success');
}).catch((err) => {
    console.log("enableAppAccess err: "  + JSON.stringify(err));
});
1
2
3
4
5
6

checkAppAccountSyncEnable(deprecated)

checkAppAccountSyncEnable(name: string, callback: AsyncCallback<boolean>): void

检查指定应用帐号是否开启数据同步功能。使用callback异步回调。

说明:

从 API version 7开始支持,从API version 9开始废弃。建议使用checkDataSyncEnabled替代。

需要权限: ohos.permission.DISTRIBUTED_DATASYNC

系统能力: SystemCapability.Account.AppAccount

参数:

参数名 类型 必填 说明
name string 应用帐号的名称。
callback AsyncCallback<boolean> 回调函数。返回true表示指定应用帐号已开启数据同步功能;返回false表示未开启。

示例:

let appAccountManager = account_appAccount.createAppAccountManager();
appAccountManager.checkAppAccountSyncEnable("ZhangSan", (err, result) => { 
    console.log("checkAppAccountSyncEnable err: " + JSON.stringify(err));
    console.log('checkAppAccountSyncEnable result: ' + result);
});
1
2
3
4
5

checkAppAccountSyncEnable(deprecated)

checkAppAccountSyncEnable(name: string): Promise<boolean>

检查指定应用帐号是否开启数据同步功能。使用Promise异步回调。

说明:

从 API version 7开始支持,从API version 9开始废弃。建议使用checkDataSyncEnabled替代。

需要权限: ohos.permission.DISTRIBUTED_DATASYNC

系统能力: SystemCapability.Account.AppAccount

参数:

参数名 类型 必填 说明
name string 应用帐号的名称。

返回值:

类型 说明
Promise<boolean> Promise对象。返回true表示指定应用帐号已开启数据同步功能;返回false表示未开启。

示例:

let appAccountManager = account_appAccount.createAppAccountManager();
appAccountManager.checkAppAccountSyncEnable("ZhangSan").then((data) => { 
    console.log('checkAppAccountSyncEnable, result: ' + data);
}).catch((err) => {
    console.log("checkAppAccountSyncEnable err: "  + JSON.stringify(err));
});
1
2
3
4
5
6

setAccountCredential(deprecated)

setAccountCredential(name: string, credentialType: string, credential: string,callback: AsyncCallback<void>): void

设置指定应用帐号的凭据。使用callback异步回调。

说明:

从 API version 7开始支持,从API version 9开始废弃,建议使用setCredential替代。

系统能力: SystemCapability.Account.AppAccount

参数:

参数名 类型 必填 说明
name string 应用帐号的名称。
credentialType string 凭据类型。
credential string 凭据取值。
callback AsyncCallback<void> 回调函数。当设置此应用程序帐号的凭据成功时,err为null,否则为错误对象。

示例:

let appAccountManager = account_appAccount.createAppAccountManager();
appAccountManager.setAccountCredential("ZhangSan", "credentialType001", "credential001", (err) => { 
    console.log("setAccountCredential err: " + JSON.stringify(err));
});
1
2
3
4

setAccountCredential(deprecated)

setAccountCredential(name: string, credentialType: string, credential: string): Promise<void>

设置指定应用帐号的凭据。使用Promise异步回调。

说明:

从 API version 7开始支持,从API version 9开始废弃,建议使用setCredential替代。

系统能力: SystemCapability.Account.AppAccount

参数:

参数名 类型 必填 说明
name string 应用帐号的名称。
credentialType string 凭据类型。
credential string 凭据取值。

返回值:

类型 说明
Promise<void> 无返回结果的Promise对象。

示例:

let appAccountManager = account_appAccount.createAppAccountManager();
appAccountManager.setAccountCredential("ZhangSan", "credentialType001", "credential001").then(() => { 
    console.log('setAccountCredential Success');
}).catch((err) => {
    console.log("setAccountCredential err: "  + JSON.stringify(err));
});
1
2
3
4
5
6

setAccountExtraInfo(deprecated)

setAccountExtraInfo(name: string, extraInfo: string, callback: AsyncCallback<void>): void

设置指定应用帐号的额外信息。使用callback异步回调。

说明:

从 API version 7开始支持,从API version 9开始废弃。建议使用setCustomData替代。

系统能力: SystemCapability.Account.AppAccount

参数:

参数名 类型 必填 说明
name string 应用帐号的名称。
extraInfo string 额外信息(能转换string类型的其它信息),额外信息不能是应用帐号的敏感信息(如应用账号密码、token等)。
callback AsyncCallback<void> 回调函数。当设置成功时,err为null,否则为错误对象。

示例:

let appAccountManager = account_appAccount.createAppAccountManager();
appAccountManager.setAccountExtraInfo("ZhangSan", "Tk002", (err) => { 
    console.log("setAccountExtraInfo err: " + JSON.stringify(err));
});
1
2
3
4

setAccountExtraInfo(deprecated)

setAccountExtraInfo(name: string, extraInfo: string): Promise<void>

设置此应用程序帐号的额外信息。使用Promise异步回调。

说明:

从 API version 7开始支持,从API version 9开始废弃。建议使用setCustomData替代。

系统能力: SystemCapability.Account.AppAccount

参数:

参数名 类型 必填 说明
name string 应用帐号的名称。
extraInfo string 额外信息(能转换string类型的其它信息),额外信息不能是应用帐号的敏感信息(如应用账号密码、token等)。

返回值:

类型 说明
Promise<void> 无返回结果的Promise对象。

示例:

let appAccountManager = account_appAccount.createAppAccountManager();
appAccountManager.setAccountExtraInfo("ZhangSan", "Tk002").then(() => { 
    console.log('setAccountExtraInfo Success');
}).catch((err) => {
    console.log("setAccountExtraInfo err: "  + JSON.stringify(err));
});
1
2
3
4
5
6

setAppAccountSyncEnable(deprecated)

setAppAccountSyncEnable(name: string, isEnable: boolean, callback: AsyncCallback<void>): void

开启或禁止指定应用帐号的数据同步功能。使用callback异步回调。

说明:

从 API version 7开始支持,从API version 9开始废弃。建议使用setDataSyncEnabled替代。

需要权限: ohos.permission.DISTRIBUTED_DATASYNC

系统能力: SystemCapability.Account.AppAccount

参数:

参数名 类型 必填 说明
name string 应用帐号的名称。
isEnable boolean 是否开启数据同步。
callback AsyncCallback<void> 回调函数。当开启或禁止成功时,err为null,否则为错误对象。

示例:

let appAccountManager = account_appAccount.createAppAccountManager();
appAccountManager.setAppAccountSyncEnable("ZhangSan", true, (err) => { 
    console.log("setAppAccountSyncEnable err: " + JSON.stringify(err));
});
1
2
3
4

setAppAccountSyncEnable(deprecated)

setAppAccountSyncEnable(name: string, isEnable: boolean): Promise<void>

开启或禁止指定应用帐号的数据同步功能。使用Promise异步回调。

说明:

从 API version 7开始支持,从API version 9开始废弃。建议使用setDataSyncEnabled替代。

需要权限: ohos.permission.DISTRIBUTED_DATASYNC

系统能力: SystemCapability.Account.AppAccount

参数:

参数名 类型 必填 说明
name string 应用帐号的名称。
isEnable boolean 是否开启数据同步。

返回值:

类型 说明
Promise<void> 无返回结果的Promise对象。

示例:

let appAccountManager = account_appAccount.createAppAccountManager();
appAccountManager .setAppAccountSyncEnable("ZhangSan", true).then(() => { 
    console.log('setAppAccountSyncEnable Success');
}).catch((err) => {
    console.log("setAppAccountSyncEnable err: "  + JSON.stringify(err));
});
1
2
3
4
5
6

setAssociatedData(deprecated)

setAssociatedData(name: string, key: string, value: string, callback: AsyncCallback<void>): void

设置指定应用帐号的关联数据。使用callback异步回调。

说明:

从 API version 7开始支持,从API version 9开始废弃。建议使用setCustomData替代。

系统能力: SystemCapability.Account.AppAccount

参数:

参数名 类型 必填 说明
name string 应用帐号的名称。
key string 关联数据的键名。
value string 关联数据的取值。
callback AsyncCallback<void> 回调函数。当设置与此应用帐号关联的数据成功时,err为null,否则为错误对象。

示例:

let appAccountManager = account_appAccount.createAppAccountManager();
appAccountManager.setAssociatedData("ZhangSan", "k001", "v001", (err) => { 
    console.log("setAssociatedData err: " + JSON.stringify(err));
});
1
2
3
4

setAssociatedData(deprecated)

setAssociatedData(name: string, key: string, value: string): Promise<void>

设置指定应用帐号的关联数据。使用Promise异步回调。

说明:

从 API version 7开始支持,从API version 9开始废弃。建议使用setCustomData替代。

系统能力: SystemCapability.Account.AppAccount

参数:

参数名 类型 必填 说明
name string 应用帐号的名称。
key string 关联数据的键名。
value string 关联数据的取值。

返回值:

类型 说明
Promise<void> 无返回结果的Promise对象。

示例:

let appAccountManager = account_appAccount.createAppAccountManager();
appAccountManager.setAssociatedData("ZhangSan", "k001", "v001").then(() => { 
    console.log('setAssociatedData Success');
}).catch((err) => {
    console.log("setAssociatedData err: "  + JSON.stringify(err));
});
1
2
3
4
5
6

getAllAccessibleAccounts(deprecated)

getAllAccessibleAccounts(callback: AsyncCallback<Array<AppAccountInfo>>): void

获取所有可访问的应用帐号信息。使用callback异步回调。

说明:

从 API version 7开始支持,从API version 9开始废弃。建议使用getAllAccounts替代。

需要权限: ohos.permission.GET_ALL_APP_ACCOUNTS。

系统能力: SystemCapability.Account.AppAccount

参数:

参数名 类型 必填 说明
callback AsyncCallback<Array<AppAccountInfo>> 回调函数。当查询成功时,err为null,data为获取到的应用帐号信息列表;否则为错误对象。

示例:

let appAccountManager = account_appAccount.createAppAccountManager();
appAccountManager.getAllAccessibleAccounts((err, data)=>{
	console.debug("getAllAccessibleAccounts err:" + JSON.stringify(err));
	console.debug("getAllAccessibleAccounts data:" + JSON.stringify(data));
});
1
2
3
4
5

getAllAccessibleAccounts(deprecated)

getAllAccessibleAccounts(): Promise<Array<AppAccountInfo>>

获取所有可访问的应用帐号信息。使用Promise异步回调。

说明:

从 API version 7开始支持,从API version 9开始废弃。建议使用getAllAccounts替代。

需要权限: ohos.permission.GET_ALL_APP_ACCOUNTS。

系统能力: SystemCapability.Account.AppAccount

返回值:

类型 说明
Promise<Array<AppAccountInfo>> Promise对象,返回全部应用已授权帐号信息对象。

示例:

let appAccountManager = account_appAccount.createAppAccountManager();
appAccountManager.getAllAccessibleAccounts().then((data) => { 
     console.log('getAllAccessibleAccounts: ' + data);
}).catch((err) => {
    console.log("getAllAccessibleAccounts err: "  + JSON.stringify(err));
});
1
2
3
4
5
6

getAllAccounts(deprecated)

getAllAccounts(owner: string, callback: AsyncCallback<Array<AppAccountInfo>>): void

根据应用帐号所有者获取调用方可访问的应用帐号列表。使用callback异步回调。

说明:

从 API version 7开始支持,从API version 9开始废弃。建议使用getAccountsByOwner替代。

需要权限: ohos.permission.GET_ALL_APP_ACCOUNTS。

系统能力: SystemCapability.Account.AppAccount

参数:

参数名 类型 必填 说明
owner string 应用帐号所有者的包名。
callback AsyncCallback<Array<AppAccountInfo>> 应用帐号信息列表。

示例:

let appAccountManager = account_appAccount.createAppAccountManager();
const selfBundle = "com.example.actsgetallaaccounts";
appAccountManager.getAllAccounts(selfBundle, (err, data)=>{
	console.debug("getAllAccounts err:" + JSON.stringify(err));
	console.debug("getAllAccounts data:" + JSON.stringify(data));
});
1
2
3
4
5
6

getAllAccounts(deprecated)

getAllAccounts(owner: string): Promise<Array<AppAccountInfo>>

根据应用帐号所有者获取调用方可访问的应用帐号列表。使用Promise异步回调。

说明:

从 API version 7开始支持,从API version 9开始废弃。建议使用getAccountsByOwner替代。

需要权限: ohos.permission.GET_ALL_APP_ACCOUNTS,仅系统应用可用。

系统能力: SystemCapability.Account.AppAccount

参数:

参数名 类型 必填 说明
owner string 应用包名称。

返回值:

类型 说明
Promise<Array<AppAccountInfo>> Promise对象,返回指定应用全部帐号信息对象。

示例:

let appAccountManager = account_appAccount.createAppAccountManager();
const selfBundle = "com.example.actsgetallaaccounts";
appAccountManager.getAllAccounts(selfBundle).then((data) => { 
     console.log('getAllAccounts: ' + data);
}).catch((err) => {
    console.log("getAllAccounts err: "  + JSON.stringify(err));
});
1
2
3
4
5
6
7

getAccountCredential(deprecated)

getAccountCredential(name: string, credentialType: string, callback: AsyncCallback<string>): void

获取指定应用帐号的凭据。使用callback异步回调。

说明:

从 API version 7开始支持,从API version 9开始废弃。建议使用getCredential替代。

系统能力: SystemCapability.Account.AppAccount

参数:

参数名 类型 必填 说明
name string 应用帐号的名称。
credentialType string 凭据类型。
callback AsyncCallback<string> 回调函数。当获取凭据成功时,err为null,data为指定应用帐号的凭据;否则为错误对象。

示例:

let appAccountManager = account_appAccount.createAppAccountManager();
appAccountManager.getAccountCredential("ZhangSan", "credentialType001", (err, result) => { 
    console.log("getAccountCredential err: " + JSON.stringify(err));
    console.log('getAccountCredential result: ' + result);
});
1
2
3
4
5

getAccountCredential(deprecated)

getAccountCredential(name: string, credentialType: string): Promise<string>

获取指定应用帐号的凭据。使用Promise异步回调。

说明:

从 API version 7开始支持,从API version 9开始废弃。建议使用getCredential替代。

系统能力: SystemCapability.Account.AppAccount

参数:

参数名 类型 必填 说明
name string 应用帐号的名称。
credentialType string 凭据类型。

返回值:

类型 说明
Promise<string> Promise对象,返回指定应用帐号的凭据。

示例:

let appAccountManager = account_appAccount.createAppAccountManager();
appAccountManager.getAccountCredential("ZhangSan", "credentialType001").then((data) => { 
    console.log('getAccountCredential, result: ' + data);
}).catch((err) => {
    console.log("getAccountCredential err: "  + JSON.stringify(err));
});
1
2
3
4
5
6

getAccountExtraInfo(deprecated)

getAccountExtraInfo(name: string, callback: AsyncCallback<string>): void

获取指定应用帐号的额外信息(能转换成string类型的其它信息)。使用callback异步回调。

说明:

从 API version 7开始支持,从API version 9开始废弃。建议使用getCustomData替代。

系统能力: SystemCapability.Account.AppAccount

参数:

参数名 类型 必填 说明
name string 应用帐号的名称。
callback AsyncCallback<string> 回调函数。当获取此应用帐号的额外信息成功时,err为null,data返回此应用帐号的额外信息对象;否则为错误对象。

示例:

let appAccountManager = account_appAccount.createAppAccountManager();
appAccountManager.getAccountExtraInfo("ZhangSan", (err, result) => { 
    console.log("getAccountExtraInfo err: " + JSON.stringify(err));
    console.log('getAccountExtraInfo result: ' + result);
});
1
2
3
4
5

getAccountExtraInfo(deprecated)

getAccountExtraInfo(name: string): Promise<string>

获取指定应用帐号的额外信息(能转换成string类型的其它信息)。使用Promise异步回调。

说明:

从 API version 7开始支持,从API version 9开始废弃。建议使用getCustomData替代。

系统能力: SystemCapability.Account.AppAccount

参数:

参数名 类型 必填 说明
name string 应用帐号的名称。

返回值:

类型 说明
Promise<string> Promise对象,返回此应用程序帐号的额外信息对象。

示例:

let appAccountManager = account_appAccount.createAppAccountManager();
appAccountManager.getAccountExtraInfo("ZhangSan").then((data) => { 
    console.log('getAccountExtraInfo, result: ' + data);
}).catch((err) => {
    console.log("getAccountExtraInfo err: "  + JSON.stringify(err));
});
1
2
3
4
5
6

getAssociatedData(deprecated)

getAssociatedData(name: string, key: string, callback: AsyncCallback<string>): void

根据指定键名获取特定应用帐号的关联数据。使用callback异步回调。

说明:

从 API version 7开始支持,从API version 9开始废弃。建议使用getCustomData替代。

系统能力: SystemCapability.Account.AppAccount

参数:

参数名 类型 必填 说明
name string 应用帐号的名称。
key string 关联数据的键名。
callback AsyncCallback<string> 回调函数。当获取成功时,err为null,data为关联数据的取值;否则为错误对象。

示例:

let appAccountManager = account_appAccount.createAppAccountManager();
appAccountManager.getAssociatedData("ZhangSan", "k001", (err, result) => { 
    console.log("getAssociatedData err: " + JSON.stringify(err));
    console.log('getAssociatedData result: ' + result);
});
1
2
3
4
5

getAssociatedData(deprecated)

getAssociatedData(name: string, key: string): Promise<string>

获取与此应用程序帐号关联的数据。使用Promise异步回调。

说明:

从 API version 7开始支持,从API version 9开始废弃。建议使用getCustomData替代。

系统能力: SystemCapability.Account.AppAccount

参数:

参数名 类型 必填 说明
name string 应用帐号的名称。
key string 关联数据的键名。

返回值:

类型 说明
Promise<string> Promise对象,返回关联数据的取值。

示例:

let appAccountManager = account_appAccount.createAppAccountManager();
appAccountManager.getAssociatedData("ZhangSan", "k001").then((data) => { 
     console.log('getAssociatedData: ' + data);
}).catch((err) => {
    console.log("getAssociatedData err: "  + JSON.stringify(err));
});
1
2
3
4
5
6

on('change')(deprecated)

on(type: 'change', owners: Array<string>, callback: Callback<Array<AppAccountInfo>>): void

订阅指定应用的帐号信息变更事件。

说明:

从 API version 7开始支持,从API version 9开始废弃。建议使用on('accountChange')替代。

系统能力: SystemCapability.Account.AppAccount

参数:

参数名 类型 必填 说明
type 'change' 事件回调类型,支持的事件为'change',当帐号所有者更新帐号信息时,触发该事件。
owners Array<string> 应用帐号所有者的包名列表。
callback Callback<Array<AppAccountInfo>> 回调函数,返回信息发生变更的应用帐号列表。

示例:

let appAccountManager = account_appAccount.createAppAccountManager();
function changeOnCallback(data){
	console.debug("receive change data:" + JSON.stringify(data));
}
try{
	appAccountManager.on('change', ["com.example.actsaccounttest"], changeOnCallback);
}
catch(err){
	console.error("on accountOnOffDemo err:" + JSON.stringify(err));
}
1
2
3
4
5
6
7
8
9
10

off('change')(deprecated)

off(type: 'change', callback?: Callback<Array<AppAccountInfo>>): void

取消订阅帐号信息变更事件。

说明:

从 API version 7开始支持,从API version 9开始废弃。建议使用off('accountChange')替代。

系统能力: SystemCapability.Account.AppAccount

参数:

参数名 类型 必填 说明
type 'change' 事件回调类型,支持的事件为'change',当帐号所有者更新帐号信息时,触发该事件。
callback Callback<Array<AppAccountInfo>> 回调函数,返回信息发生变更的应用帐号列表。

示例:

let appAccountManager = account_appAccount.createAppAccountManager();
function changeOnCallback(data){
	console.debug("receive change data:" + JSON.stringify(data));
	appAccountManager.off('change', function(){
		console.debug("off finish");
	})
}
try{
	appAccountManager.on('change', ["com.example.actsaccounttest"], changeOnCallback);
}
catch(err){
	console.error("on accountOnOffDemo err:" + JSON.stringify(err));
}
1
2
3
4
5
6
7
8
9
10
11
12
13

authenticate(deprecated)

authenticate(name: string, owner: string, authType: string, options: {[key: string]: any}, callback: AuthenticatorCallback): void

对应用帐号进行鉴权以获取授权令牌。使用callback异步回调。

说明:

从 API version 8开始支持,从API version 9开始废弃。建议使用auth替代。

系统能力: SystemCapability.Account.AppAccount

参数:

参数名 类型 必填 说明
name string 应用帐号的名称。
owner string 应用帐号所有者的包名。
authType string 鉴权类型。
options {[key: string]: any} 鉴权所需的可选项。
callback AuthenticatorCallback 回调对象,返回鉴权结果。

示例:

import featureAbility from '@ohos.ability.featureAbility';

function onResultCallback(code, result) {
    console.log("resultCode: "  + code);
    console.log("result: "  + JSON.stringify(result));
}

function onRequestRedirectedCallback(request) {
    let abilityStartSetting = {want: request};
    featureAbility.startAbility(abilityStartSetting, (err)=>{
        console.log("startAbility err: " + JSON.stringify(err));
    });
}

let appAccountManager = account_appAccount.createAppAccountManager();
appAccountManager.authenticate("LiSi", "com.example.accountjsdemo", "getSocialData", {}, {
  onResult: onResultCallback,
  onRequestRedirected: onRequestRedirectedCallback
});
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19

getOAuthToken(deprecated)

getOAuthToken(name: string, owner: string, authType: string, callback: AsyncCallback<string>): void

获取指定应用帐号的特定鉴权类型的授权令牌。使用callback异步回调。

说明:

从 API version 8开始支持,从API version 9开始废弃。建议使用getAuthToken替代。

系统能力: SystemCapability.Account.AppAccount

参数:

参数名 类型 必填 说明
name string 应用帐号的名称。
owner string 应用帐号所有者的包名。
authType string 鉴权类型。
callback AsyncCallback<string> 回调函数。当获取成功时,err为null,data为授权令牌值;否则为错误对象。

示例:

let appAccountManager = account_appAccount.createAppAccountManager();
appAccountManager.getOAuthToken("LiSi", "com.example.accountjsdemo", "getSocialData", (err, data) => {
     console.log('getOAuthToken err: ' + JSON.stringify(err));
     console.log('getOAuthToken token: ' + data);
});
1
2
3
4
5

getOAuthToken(deprecated)

getOAuthToken(name: string, owner: string, authType: string): Promise<string>

获取指定应用帐号的特定鉴权类型的授权令牌。使用Promise异步回调。

说明:

从 API version 8开始支持,从API version 9开始废弃。建议使用getAuthToken替代。

系统能力: SystemCapability.Account.AppAccount

参数:

参数名 类型 必填 说明
name string 应用帐号的名称。
owner string 应用帐号所有者的包名。
authType string 鉴权类型。

返回值:

类型 说明
Promise<string> Promise对象,返回授权令牌。

示例:

let appAccountManager = account_appAccount.createAppAccountManager();
appAccountManager.getOAuthToken("LiSi", "com.example.accountjsdemo", "getSocialData").then((data) => {
     console.log('getOAuthToken token: ' + data);
}).catch((err) => {
    console.log("getOAuthToken err: "  + JSON.stringify(err));
});
1
2
3
4
5
6

setOAuthToken(deprecated)

setOAuthToken(name: string, authType: string, token: string, callback: AsyncCallback<void>): void

为指定应用帐号设置特定鉴权类型的授权令牌。使用callback异步回调。

说明:

从 API version 8开始支持,从API version 9开始废弃。建议使用setAuthToken替代。

系统能力: SystemCapability.Account.AppAccount

参数:

参数名 类型 必填 说明
name string 应用帐号的名称。
authType string 鉴权类型。
token string 授权令牌。
callback AsyncCallback<void> 回调函数。当设置成功时,err为null;否则为错误对象。

示例:

let appAccountManager = account_appAccount.createAppAccountManager();
appAccountManager.setOAuthToken("LiSi", "getSocialData", "xxxx", (err) => {
    console.log('setOAuthToken err: ' + JSON.stringify(err));
});
1
2
3
4

setOAuthToken(deprecated)

setOAuthToken(name: string, authType: string, token: string): Promise<void>

为指定应用帐号设置特定鉴权类型的授权令牌。使用Promise异步回调。

说明:

从 API version 8开始支持,从API version 9开始废弃。建议使用setAuthToken替代。

系统能力: SystemCapability.Account.AppAccount

参数:

参数名 类型 必填 说明
name string 应用帐号的名称。
authType string 鉴权类型。
token string 授权令牌。

返回值:

类型 说明
Promise<void> 无返回结果的Promise对象。

示例:

let appAccountManager = account_appAccount.createAppAccountManager();
appAccountManager.setOAuthToken("LiSi", "getSocialData", "xxxx").then(() => {
    console.log('setOAuthToken successfully');
}).catch((err) => {
    console.log('setOAuthToken err: ' + JSON.stringify(err));
});
1
2
3
4
5
6

deleteOAuthToken(deprecated)

deleteOAuthToken(name: string, owner: string, authType: string, token: string, callback: AsyncCallback<void>): void

删除指定应用帐号的特定鉴权类型的授权令牌。使用callback异步回调。

说明:

从 API version 8开始支持,从API version 9开始废弃。建议使用deleteAuthToken替代。

系统能力: SystemCapability.Account.AppAccount

参数:

参数名 类型 必填 说明
name string 应用帐号的名称。
owner string 应用帐号所有者的包名。
authType string 鉴权类型。
token string 授权令牌。
callback AsyncCallback<void> 回调函数。当删除成功时,err为null;否则为错误对象。

示例:

let appAccountManager = account_appAccount.createAppAccountManager();
appAccountManager.deleteOAuthToken("LiSi", "com.example.accountjsdemo", "getSocialData", "xxxxx", (err) => {
     console.log('deleteOAuthToken err: ' + JSON.stringify(err));
});
1
2
3
4

deleteOAuthToken(deprecated)

deleteOAuthToken(name: string, owner: string, authType: string, token: string): Promise<void>

删除指定应用帐号的特定鉴权类型的授权令牌。使用Promise异步回调。

说明:

从 API version 8开始支持,从API version 9开始废弃。建议使用deleteAuthToken替代。

系统能力: SystemCapability.Account.AppAccount

参数:

参数名 类型 必填 说明
name string 应用帐号的名称。
owner string 应用帐号所有者的包名。
authType string 鉴权类型。
token string 授权令牌。

返回值:

类型 说明
Promise<void> 无返回结果的Promise对象。

示例:

let appAccountManager = account_appAccount.createAppAccountManager();
appAccountManager.deleteOAuthToken("LiSi", "com.example.accountjsdemo", "getSocialData", "xxxxx").then(() => {
     console.log('deleteOAuthToken successfully');
}).catch((err) => {
    console.log("deleteOAuthToken err: "  + JSON.stringify(err));
});
1
2
3
4
5
6

setOAuthTokenVisibility(deprecated)

setOAuthTokenVisibility(name: string, authType: string, bundleName: string, isVisible: boolean, callback: AsyncCallback<void>): void

设置指定帐号的特定鉴权类型的授权令牌对指定应用的可见性。使用callback异步回调。

说明:

从 API version 8开始支持,从API version 9开始废弃。建议使用setAuthTokenVisibility替代。

系统能力: SystemCapability.Account.AppAccount

参数:

参数名 类型 必填 说明
name string 应用帐号的名称。
authType string 鉴权类型。
bundleName string 被设置可见性的应用包名。
isVisible boolean 是否可见。true表示可见,false表示不可见。
callback AsyncCallback<void> 回调函数。当设置成功时,err为null;否则为错误对象。

示例:

let appAccountManager = account_appAccount.createAppAccountManager();
appAccountManager.setOAuthTokenVisibility("LiSi", "getSocialData", "com.example.accountjsdemo", true, (err) => {
     console.log('setOAuthTokenVisibility err: ' + JSON.stringify(err));
});
1
2
3
4

setOAuthTokenVisibility(deprecated)

setOAuthTokenVisibility(name: string, authType: string, bundleName: string, isVisible: boolean): Promise<void>

设置指定帐号的特定鉴权类型的授权令牌对指定应用的可见性。使用Promise异步回调。

说明:

从 API version 8开始支持,从API version 9开始废弃。建议使用setAuthTokenVisibility替代。

系统能力: SystemCapability.Account.AppAccount

参数:

参数名 类型 必填 说明
name string 应用帐号的名称。
authType string 鉴权类型。
bundleName string 被设置可见性的应用包名。
isVisible boolean 是否可见。true表示可见,false表示不可见。

返回值:

类型 说明
Promise<void> 无返回结果的Promise对象。

示例:

let appAccountManager = account_appAccount.createAppAccountManager();
appAccountManager.setOAuthTokenVisibility("LiSi", "getSocialData", "com.example.accountjsdemo", true).then(() => {
    console.log('setOAuthTokenVisibility successfully');
}).catch((err) => {
    console.log('setOAuthTokenVisibility err: ' + JSON.stringify(err));
});
1
2
3
4
5
6

checkOAuthTokenVisibility(deprecated)

checkOAuthTokenVisibility(name: string, authType: string, bundleName: string, callback: AsyncCallback<boolean>): void

检查指定应用帐号的特定鉴权类型的授权令牌对指定应用的可见性。使用callback异步回调。

说明:

从 API version 8开始支持,从API version 9开始废弃。建议使用checkAuthTokenVisibility替代。

系统能力: SystemCapability.Account.AppAccount

参数:

参数名 类型 必填 说明
name string 应用帐号的名称。
authType string 鉴权类型。
bundleName string 检查可见性的应用包名。
callback AsyncCallback<boolean> 回调函数。当检查成功时,err为null,data为true表示可见,data为false表示不可见;否则为错误对象。

示例:

let appAccountManager = account_appAccount.createAppAccountManager();
appAccountManager.checkOAuthTokenVisibility("LiSi", "getSocialData", "com.example.accountjsdemo", (err, data) => {
    console.log('checkOAuthTokenVisibility err: ' + JSON.stringify(err));
    console.log('checkOAuthTokenVisibility isVisible: ' + data);
});
1
2
3
4
5

checkOAuthTokenVisibility(deprecated)

checkOAuthTokenVisibility(name: string, authType: string, bundleName: string): Promise<boolean>

检查指定应用帐号的特定鉴权类型的授权令牌对指定应用的可见性。使用Promise异步回调。

说明:

从 API version 8开始支持,从API version 9开始废弃。建议使用checkAuthTokenVisibility替代。

系统能力: SystemCapability.Account.AppAccount

参数:

参数名 类型 必填 说明
name string 应用帐号的名称。
authType string 鉴权类型。
bundleName string 用于检查可见性的应用包名。

返回值:

类型 说明
Promise<boolean> Promise对象。返回true表示指定鉴权类型的OAuth令牌对特定应用的可见,返回false表示不可见。

示例:

let appAccountManager = account_appAccount.createAppAccountManager();
appAccountManager.checkOAuthTokenVisibility("LiSi", "getSocialData", "com.example.accountjsdemo").then((data) => {
    console.log('checkOAuthTokenVisibility isVisible: ' + data);
}).catch((err) => {
    console.log('checkOAuthTokenVisibility err: ' + JSON.stringify(err));
});
1
2
3
4
5
6

getAllOAuthTokens(deprecated)

getAllOAuthTokens(name: string, owner: string, callback: AsyncCallback<Array<OAuthTokenInfo>>): void

获取指定帐号对调用方可见的所有授权令牌。使用callback异步回调。

说明:

从 API version 8开始支持,从API version 9开始废弃。建议使用getAllAuthTokens替代。

系统能力: SystemCapability.Account.AppAccount

参数:

参数名 类型 必填 说明
name string 应用帐号的名称。
owner string 应用帐号所有者的包名。
callback AsyncCallback<Array<OAuthTokenInfo>> 回调函数。当获取成功时,err为null,data为授权令牌数组;否则为错误对象。

示例:

let appAccountManager = account_appAccount.createAppAccountManager();
appAccountManager.getAllOAuthTokens("LiSi", "com.example.accountjsdemo", (err, data) => {
    console.log("getAllOAuthTokens err: "  + JSON.stringify(err));
    console.log('getAllOAuthTokens data: ' + JSON.stringify(data));
});
1
2
3
4
5

getAllOAuthTokens(deprecated)

getAllOAuthTokens(name: string, owner: string): Promise<Array<OAuthTokenInfo>>

获取指定帐号对调用方可见的所有授权令牌。使用Promise异步回调。

说明:

从 API version 8开始支持,从API version 9开始废弃。建议使用getAllAuthTokens替代。

系统能力: SystemCapability.Account.AppAccount

参数:

参数名 类型 必填 说明
name string 应用帐号的名称。
owner string 应用帐号所有者的包名。

返回值:

类型 说明
Promise<Array< OAuthTokenInfo>> Promise对象,返回授权令牌数组。

示例:

let appAccountManager = account_appAccount.createAppAccountManager();
appAccountManager.getAllOAuthTokens("LiSi", "com.example.accountjsdemo").then((data) => {
    console.log('getAllOAuthTokens data: ' + JSON.stringify(data));
}).catch((err) => {
    console.log("getAllOAuthTokens err: "  + JSON.stringify(err));
});
1
2
3
4
5
6

getOAuthList(deprecated)

getOAuthList(name: string, authType: string, callback: AsyncCallback<Array<string>>): void

获取指定应用帐号的特定鉴权类型的授权列表,即被授权的包名数组(令牌的授权列表通过setOAuthTokenVisibility(#setoauthtokenvisibilitydeprecated)来设置)。使用callback异步回调。

说明:

从 API version 8开始支持,从API version 9开始废弃。建议使用getAuthList替代。

系统能力: SystemCapability.Account.AppAccount

参数:

参数名 类型 必填 说明
name string 应用帐号的名称。
authType string 鉴权类型。
callback AsyncCallback<Array<string>> 回调函数。当获取成功时,err为null,data为被授权的包名数组;否则为错误对象。

示例:

let appAccountManager = account_appAccount.createAppAccountManager();
appAccountManager.getOAuthList("com.example.accountjsdemo", "getSocialData", (err, data) => {
  console.log('getOAuthList err: ' + JSON.stringify(err));
  console.log('getOAuthList data: ' + JSON.stringify(data));
});
1
2
3
4
5

getOAuthList(deprecated)

getOAuthList(name: string, authType: string): Promise<Array<string>>

获取指定应用帐号的特定鉴权类型的授权列表,即被授权的包名数组(令牌的授权列表通过setOAuthTokenVisibility(#setoauthtokenvisibilitydeprecated)来设置)。使用Promise异步回调。

说明:

从 API version 8开始支持,从API version 9开始废弃。建议使用getAuthList替代。

系统能力: SystemCapability.Account.AppAccount

参数:

参数名 类型 必填 说明
name string 应用帐号的名称。
authType string 鉴权类型。

返回值:

类型 说明
Promise<Array<string>> Promise对象,返回被授权的包名数组。

示例:

let appAccountManager = account_appAccount.createAppAccountManager();
appAccountManager.getOAuthList("com.example.accountjsdemo", "getSocialData").then((data) => {
     console.log('getOAuthList data: ' + JSON.stringify(data));
}).catch((err) => {
    console.log("getOAuthList err: "  + JSON.stringify(err));
});
1
2
3
4
5
6

getAuthenticatorCallback(deprecated)

getAuthenticatorCallback(sessionId: string, callback: AsyncCallback<AuthenticatorCallback>): void

获取鉴权会话的认证器回调。使用callback异步回调。

说明:

从 API version 8开始支持,从API version 9开始废弃。建议使用getAuthCallback替代。

系统能力: SystemCapability.Account.AppAccount

参数:

参数名 类型 必填 说明
sessionId string 鉴权会话的标识。
callback AsyncCallback<AuthenticatorCallback> 回调函数。当获取鉴权会话的认证器回调函数成功时,err为null,data为认证器回调函数;否则为错误对象。

示例:

import featureAbility from '@ohos.ability.featureAbility';
let appAccountManager = account_appAccount.createAppAccountManager();
featureAbility.getWant((err, want) => {
  var sessionId = want.parameters[account_appAccount.Constants.KEY_SESSION_ID];
  appAccountManager.getAuthenticatorCallback(sessionId, (err, callback) => {
      if (err.code != account_appAccount.ResultCode.SUCCESS) {
          console.log("getAuthenticatorCallback err: "  + JSON.stringify(err));
          return;
      }
      var result = {[account_appAccount.Constants.KEY_NAME]: "LiSi",
                    [account_appAccount.Constants.KEY_OWNER]: "com.example.accountjsdemo",
                    [account_appAccount.Constants.KEY_AUTH_TYPE]: "getSocialData",
                    [account_appAccount.Constants.KEY_TOKEN]: "xxxxxx"};
      callback.onResult(account_appAccount.ResultCode.SUCCESS, result);
  });
});
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16

getAuthenticatorCallback(deprecated)

getAuthenticatorCallback(sessionId: string): Promise<AuthenticatorCallback>

获取鉴权会话的认证器回调。使用Promise异步回调。

说明:

从 API version 8开始支持,从API version 9开始废弃。建议使用getAuthCallback替代。

系统能力: SystemCapability.Account.AppAccount

参数:

参数名 类型 必填 说明
sessionId string 鉴权会话的标识。

返回值:

类型 说明
Promise<AuthenticatorCallback> Promise对象,返回鉴权会话的认证器回调对象。

示例:

import featureAbility from '@ohos.ability.featureAbility';

let appAccountManager = account_appAccount.createAppAccountManager();
featureAbility.getWant().then((want) => {
    var sessionId = want.parameters[account_appAccount.Constants.KEY_SESSION_ID];
    appAccountManager.getAuthenticatorCallback(sessionId).then((callback) => {
        var result = {[account_appAccount.Constants.KEY_NAME]: "LiSi",
                      [account_appAccount.Constants.KEY_OWNER]: "com.example.accountjsdemo",
                      [account_appAccount.Constants.KEY_AUTH_TYPE]: "getSocialData",
                      [account_appAccount.Constants.KEY_TOKEN]: "xxxxxx"};
        callback.onResult(account_appAccount.ResultCode.SUCCESS, result);
    }).catch((err) => {
        console.log("getAuthenticatorCallback err: "  + JSON.stringify(err));
    });
}).catch((err) => {
    console.log("getWant err: "  + JSON.stringify(err));
});
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17

getAuthenticatorInfo(deprecated)

getAuthenticatorInfo(owner: string, callback: AsyncCallback<AuthenticatorInfo>): void

获取指定应用的认证器信息。使用callback异步回调。

说明:

从 API version 8开始支持,从API version 9开始废弃。建议使用queryAuthenticatorInfo替代。

系统能力: SystemCapability.Account.AppAccount

参数:

参数名 类型 必填 说明
owner string 应用帐号所有者的包名。
callback AsyncCallback<AuthenticatorInfo> 回调函数。当获取成功时,err为null,data为认证器信息对象;否则为错误对象。

示例:

let appAccountManager = account_appAccount.createAppAccountManager();
appAccountManager.getAuthenticatorInfo("com.example.accountjsdemo", (err, data) => {
    console.log("getAuthenticatorInfo err: "  + JSON.stringify(err));
    console.log('getAuthenticatorInfo data: ' + JSON.stringify(data));
});
1
2
3
4
5

getAuthenticatorInfo(deprecated)

getAuthenticatorInfo(owner: string): Promise<AuthenticatorInfo>

获取指定应用的认证器信息。使用Promise异步回调。

说明:

从 API version 8开始支持,从API version 9开始废弃。建议使用queryAuthenticatorInfo替代。

系统能力: SystemCapability.Account.AppAccount

参数:

参数名 类型 必填 说明
owner string 应用帐号所有者的包名。

返回值:

类型 说明
Promise<AuthenticatorInfo> Promise对象,返回指定应用的认证器信息对象。

示例:

let appAccountManager = account_appAccount.createAppAccountManager();
appAccountManager.getAuthenticatorInfo("com.example.accountjsdemo").then((data) => { 
     console.log('getAuthenticatorInfo: ' + JSON.stringify(data));
}).catch((err) => {
    console.log("getAuthenticatorInfo err: "  + JSON.stringify(err));
});
1
2
3
4
5
6

AppAccountInfo

表示应用帐号信息。

系统能力: 以下各项对应的系统能力均为SystemCapability.Account.AppAccount。

名称 类型 必填 说明
owner string 应用帐号所有者的包名。
name string 应用帐号的名称。

AuthTokenInfo9+

表示Auth令牌信息。

系统能力: 以下各项对应的系统能力均为SystemCapability.Account.AppAccount。

名称 类型 必填 说明
authType9+ string 令牌的鉴权类型。
token9+ string 令牌的取值。
account9+ AppAccountInfo 令牌所属的帐号信息。

OAuthTokenInfo(deprecated)

表示OAuth令牌信息。

说明:

从 API version 8开始支持,从API version 9开始废弃。建议使用AuthTokenInfo替代。

系统能力: 以下各项对应的系统能力均为SystemCapability.Account.AppAccount。

名称 类型 必填 说明
authType string 令牌的鉴权类型。
token string 令牌的取值。
account9+ AppAccountInfo 令牌所属的帐号信息。

AuthenticatorInfo8+

表示OAuth认证器信息。

系统能力: 以下各项对应的系统能力均为SystemCapability.Account.AppAccount。

名称 类型 必填 说明
owner string 认证器的所有者包名。
iconId number 认证器的图标标识。
labelId number 认证器的标签标识。

AuthResult9+

表示认证结果信息。

系统能力: 以下各项对应的系统能力均为SystemCapability.Account.AppAccount。

名称 类型 必填 说明
account AppAccountInfo 令牌所属的帐号信息。
tokenInfo AuthTokenInfo 令牌信息。

CreateAccountOptions9+

表示创建账号的选项。

系统能力: 以下各项对应的系统能力均为SystemCapability.Account.AppAccount。

名称 类型 必填 说明
customData {[key: string]: string} 自定义数据。

CreateAccountImplicitlyOptions9+

表示隐式创建账号的选项。

系统能力: 以下各项对应的系统能力均为SystemCapability.Account.AppAccount。

名称 类型 必填 说明
requiredLabels Array<string> 必须的标签。
authType string 鉴权类型。
parameters {[key: string]: Object} 自定义参数对象。

SelectAccountsOptions9+

表示用于选择帐号的选项。

系统能力: 以下各项对应的系统能力均为SystemCapability.Account.AppAccount。

名称 类型 必填 说明
allowedAccounts Array<AppAccountInfo> 允许的帐号数组。
allowedOwners Array<string> 允许的帐号所有者数组。
requiredLabels Array<string> 认证器的标签标识。

VerifyCredentialOptions9+

表示用于验证凭据的选项。

系统能力: 以下各项对应的系统能力均为SystemCapability.Account.AppAccount。

名称 类型 必填 说明
credentialType string 凭据类型。
credential string 凭据取值。
parameters {[key: string]: Object} 自定义参数对象。

SetPropertiesOptions9+

表示用于设置属性的选项。

系统能力: 以下各项对应的系统能力均为SystemCapability.Account.AppAccount。

名称 类型 必填 说明
properties {[key: string]: Object} 属性对象。
parameters {[key: string]: Object} 自定义参数对象。

Constants8+

表示常量的枚举。

系统能力: 以下各项对应的系统能力均为SystemCapability.Account.AppAccount。

名称 说明
ACTION_ADD_ACCOUNT_IMPLICITLY(deprecated) "addAccountImplicitly" 表示操作,隐式添加帐号。
ACTION_AUTHENTICATE(deprecated) "authenticate" 表示操作,鉴权。
ACTION_CREATE_ACCOUNT_IMPLICITLY9+ "createAccountImplicitly" 表示操作,隐式创建帐号。
ACTION_AUTH9+ "auth" 表示操作,鉴权。
ACTION_VERIFY_CREDENTIAL9+ "verifyCredential" 表示操作,验证凭据。
ACTION_SET_AUTHENTICATOR_PROPERTIES9+ "setAuthenticatorProperties" 表示操作,设置认证器属性。
KEY_NAME "name" 表示键名,应用帐号的名称。
KEY_OWNER "owner" 表示键名,应用帐号所有者。
KEY_TOKEN "token" 表示键名,令牌。
KEY_ACTION "action" 表示键名,操作。
KEY_AUTH_TYPE "authType" 表示键名,鉴权类型。
KEY_SESSION_ID "sessionId" 表示键名,会话标识。
KEY_CALLER_PID "callerPid" 表示键名,调用方PID。
KEY_CALLER_UID "callerUid" 表示键名,调用方UID。
KEY_CALLER_BUNDLE_NAME "callerBundleName" 表示键名,调用方包名。
KEY_REQUIRED_LABELS9+ "requiredLabels" 表示键名,必需的标签。
KEY_BOOLEAN_RESULT9+ "booleanResult" 表示键名,布尔返回值。

ResultCode8+

表示返回码的枚举。

系统能力: 以下各项对应的系统能力均为SystemCapability.Account.AppAccount。

名称 说明
SUCCESS 0 表示操作成功。
ERROR_ACCOUNT_NOT_EXIST 10001 表示应用帐号不存在。
ERROR_APP_ACCOUNT_SERVICE_EXCEPTION 10002 表示应用帐号服务异常。
ERROR_INVALID_PASSWORD 10003 表示密码无效。
ERROR_INVALID_REQUEST 10004 表示请求无效。
ERROR_INVALID_RESPONSE 10005 表示响应无效。
ERROR_NETWORK_EXCEPTION 10006 表示网络异常。
ERROR_OAUTH_AUTHENTICATOR_NOT_EXIST 10007 表示认证器不存在。
ERROR_OAUTH_CANCELED 10008 表示鉴权取消。
ERROR_OAUTH_LIST_TOO_LARGE 10009 表示开放授权列表过大。
ERROR_OAUTH_SERVICE_BUSY 10010 表示开放授权服务忙碌。
ERROR_OAUTH_SERVICE_EXCEPTION 10011 表示开放授权服务异常。
ERROR_OAUTH_SESSION_NOT_EXIST 10012 表示鉴权会话不存在。
ERROR_OAUTH_TIMEOUT 10013 表示鉴权超时。
ERROR_OAUTH_TOKEN_NOT_EXIST 10014 表示开放授权令牌不存在。
ERROR_OAUTH_TOKEN_TOO_MANY 10015 表示开放授权令牌过多。
ERROR_OAUTH_UNSUPPORT_ACTION 10016 表示不支持的鉴权操作。
ERROR_OAUTH_UNSUPPORT_AUTH_TYPE 10017 表示不支持的鉴权类型。
ERROR_PERMISSION_DENIED 10018 表示权限不足。

AuthCallback9+

认证器回调类。

onResult9+

onResult: (code: number, result?: AuthResult) => void

通知请求结果。

系统能力: SystemCapability.Account.AppAccount

参数:

参数名 类型 必填 说明
code number 鉴权结果码。
result AuthResult 鉴权结果。

示例:

let appAccountManager = account_appAccount.createAppAccountManager();
var sessionId = "1234";
appAccountManager.getAuthCallback(sessionId).then((callback) => {
    var result = {
        accountInfo: {
          name: "Lisi",
          owner: "com.example.accountjsdemo",
        },
        tokenInfo: {
          token: "xxxxxx",
          authType: "getSocialData"
        }
    };
    callback.onResult(account_appAccount.ResultCode.SUCCESS, result);
}).catch((err) => {
    console.log("getAuthCallback err: "  + JSON.stringify(err));
});
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17

onRequestRedirected9+

onRequestRedirected: (request: Want) => void

通知请求被跳转。

系统能力: SystemCapability.Account.AppAccount

参数:

参数名 类型 必填 说明
request Want 用于跳转的请求信息。

示例:

class MyAuthenticator extends account_appAccount.Authenticator {
    createAccountImplicitly(options, callback) {
        callback.onRequestRedirected({
            bundleName: "com.example.accountjsdemo",
            abilityName: "com.example.accountjsdemo.LoginAbility",
        });
    }

    auth(name, authType, options, callback) {
        var result = {
          accountInfo: {
            name: "Lisi",
            owner: "com.example.accountjsdemo",
          },
          tokenInfo: {
            token: "xxxxxx",
            authType: "getSocialData"
          }
        };
        callback.onResult(account_appAccount.ResultCode.SUCCESS, result);
    }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22

onRequestContinued9+

onRequestContinued?: () => void

通知请求被继续处理。

系统能力: SystemCapability.Account.AppAccount

示例:

let appAccountManager = account_appAccount.createAppAccountManager();
var sessionId = "1234";
appAccountManager.getAuthCallback(sessionId).then((callback) => {
    callback.onRequestContinued();
}).catch((err) => {
    console.log("getAuthCallback err: "  + JSON.stringify(err));
});
1
2
3
4
5
6
7

AuthenticatorCallback(deprecated)

OAuth认证器回调接口。

说明:

从 API version 8开始支持,从API version 9开始废弃。建议使用AuthCallback替代。

onResult8+

onResult: (code: number, result: {[key: string]: any}) => void

通知请求结果。

系统能力: SystemCapability.Account.AppAccount

参数:

参数名 类型 必填 说明
code number 鉴权结果码。
result {[key: string]: any} 鉴权结果。

示例:

let appAccountManager = account_appAccount.createAppAccountManager();
var sessionId = "1234";
appAccountManager.getAuthenticatorCallback(sessionId).then((callback) => {
    var result = {[account_appAccount.Constants.KEY_NAME]: "LiSi",
                  [account_appAccount.Constants.KEY_OWNER]: "com.example.accountjsdemo",
                  [account_appAccount.Constants.KEY_AUTH_TYPE]: "getSocialData",
                  [account_appAccount.Constants.KEY_TOKEN]: "xxxxxx"};
    callback.onResult(account_appAccount.ResultCode.SUCCESS, result);
}).catch((err) => {
    console.log("getAuthenticatorCallback err: "  + JSON.stringify(err));
});
1
2
3
4
5
6
7
8
9
10
11

onRequestRedirected8+

onRequestRedirected: (request: Want) => void

通知请求被跳转。

系统能力: SystemCapability.Account.AppAccount

参数:

参数名 类型 必填 说明
request Want 用于跳转的请求信息。

示例:

class MyAuthenticator extends account_appAccount.Authenticator {
    addAccountImplicitly(authType, callerBundleName, options, callback) {
        callback.onRequestRedirected({
            bundleName: "com.example.accountjsdemo",
            abilityName: "com.example.accountjsdemo.LoginAbility",
        });
    }

    authenticate(name, authType, callerBundleName, options, callback) {
        var result = {[account_appAccount.Constants.KEY_NAME]: name,
                      [account_appAccount.Constants.KEY_AUTH_TYPE]: authType,
                      [account_appAccount.Constants.KEY_TOKEN]: "xxxxxx"};
        callback.onResult(account_appAccount.ResultCode.SUCCESS, result);
    }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15

onRequestContinued9+

onRequestContinued?: () => void

通知请求被继续处理。

系统能力: SystemCapability.Account.AppAccount

示例:

let appAccountManager = account_appAccount.createAppAccountManager();
var sessionId = "1234";
appAccountManager.getAuthenticatorCallback(sessionId).then((callback) => {
    callback.onRequestContinued();
}).catch((err) => {
    console.log("getAuthenticatorCallback err: "  + JSON.stringify(err));
});
1
2
3
4
5
6
7

Authenticator8+

认证器基类。

createAccountImplicitly9+

createAccountImplicitly(options: CreateAccountImplicitlyOptions, callback: AuthCallback): void

根据指定的帐号所有者隐式地创建应用帐号,并使用callback异步回调返回结果。

系统能力: SystemCapability.Account.AppAccount

参数:

参数名 类型 必填 说明
options CreateAccountImplicitlyOptions 隐式创建账号的选项。
callback AuthCallback 认证器回调对象,用于返回创建结果。

addAccountImplicitlydeprecated

addAccountImplicitly(authType: string, callerBundleName: string, options: {[key: string]: any}, callback: AuthenticatorCallback): void

根据指定的鉴权类型和可选项,隐式地添加应用帐号,并使用callback异步回调返回结果。

说明:

从 API version 8开始支持, 从API version 9开始废弃。建议使用createAccountImplicitly替代。

系统能力: SystemCapability.Account.AppAccount

参数:

参数名 类型 必填 说明
authType string 应用帐号的鉴权类型。
callerBundleName string 鉴权请求方的包名。
options {[key: string]: any} 鉴权所需要的可选项。
callback AuthenticatorCallback 认证器回调,用于返回鉴权结果。

auth9+

auth(name: string, authType: string, options: {[key:string]: Object}, callback: AuthCallback): void

对应用帐号进行鉴权以获取授权令牌,并使用callback异步回调返回结果。

系统能力: SystemCapability.Account.AppAccount

参数:

参数名 类型 必填 说明
name string 应用帐号的名称。
authType string 应用帐号的鉴权类型。
callerBundleName string 鉴权类型。
options {[key: string]: Object} 鉴权所需要的可选项。
callback AuthCallback 回调对象,用于返回鉴权结果。

authenticatedeprecated

authenticate(name: string, authType: string, callerBundleName: string, options: {[key: string]: any}, callback: AuthenticatorCallback): void

对应用帐号进行鉴权,获取OAuth令牌,并使用callback异步回调返回结果。

说明:

从 API version 8开始支持, 从API version 9开始废弃。建议使用auth替代。

系统能力: SystemCapability.Account.AppAccount

参数:

参数名 类型 必填 说明
name string 应用帐号的名称。
authType string 应用帐号的鉴权类型。
callerBundleName string 鉴权请求方的包名。
options {[key: string]: any} 鉴权所需要的可选项。
callback AuthenticatorCallback 认证器回调,用于返回鉴权结果。

verifyCredential9+

verifyCredential(name: string, options: VerifyCredentialOptions, callback: AuthCallback): void;

验证应用帐号的凭据,并使用callback异步回调返回结果。

系统能力: SystemCapability.Account.AppAccount

参数:

参数名 类型 必填 说明
name string 应用帐号的名称。
options VerifyCredentialOptions 验证凭据的可选项。
callback AuthCallback 认证器回调,用于返回验证结果。

setProperties9+

setProperties(options: SetPropertiesOptions, callback: AuthCallback): void;

设置认证器属性,并使用callback异步回调返回结果。

系统能力: SystemCapability.Account.AppAccount

参数:

参数名 类型 必填 说明
options SetPropertiesOptions 设置属性的可选项。
callback AuthCallback 认证器回调,用于返回设置结果。

checkAccountLabels9+

checkAccountLabels(name: string, labels: Array<string>, callback: AuthCallback): void;

检查帐号标签,并使用callback异步回调返回结果。

系统能力: SystemCapability.Account.AppAccount

参数:

参数名 类型 必填 说明
name string 应用帐号的名称。
labels Array<string> 标签数组。
callback AuthCallback 认证器回调,用于返回检查结果。

isAccountRemovable9+

isAccountRemovable(name: string, callback: AuthCallback): void;

判断帐号是否可以删除,并使用callback异步回调返回结果。

系统能力: SystemCapability.Account.AppAccount

参数:

参数名 类型 必填 说明
name string 应用帐号的名称。
callback AuthCallback 认证器回调,用于返回判断结果。

getRemoteObject9+

getRemoteObject(): rpc.RemoteObject;

获取认证器的远程对象,不可以重载实现。

系统能力: SystemCapability.Account.AppAccount

示例:

class MyAuthenticator extends account_appAccount.Authenticator {
  addAccountImplicitly(authType, callerBundleName, options, callback) {
    callback.onRequestRedirected({
      bundleName: "com.example.accountjsdemo",
      abilityName: "com.example.accountjsdemo.LoginAbility",
    });
  }

  authenticate(name, authType, callerBundleName, options, callback) {
    var result = {[account_appAccount.Constants.KEY_NAME]: name,
                  [account_appAccount.Constants.KEY_AUTH_TYPE]: authType,
                  [account_appAccount.Constants.KEY_TOKEN]: "xxxxxx"};
    callback.onResult(account_appAccount.ResultCode.SUCCESS, result);
  }

  verifyCredential(name, options, callback) {
    callback.onRequestRedirected({
      bundleName: "com.example.accountjsdemo",
      abilityName: "com.example.accountjsdemo.VerifyAbility",
      parameters: {
        name: name
      }
    });
  }

  setProperties(options, callback) {
    callback.onResult(account_appAccount.ResultCode.SUCCESS, {});
  }

  checkAccountLabels(name, labels, callback) {
    var result = {[account_appAccount.Constants.KEY_BOOLEAN_RESULT]: false};
    callback.onResult(account_appAccount.ResultCode.SUCCESS, result);
  }

  isAccountRemovable(name, callback) {
    var result = {[account_appAccount.Constants.KEY_BOOLEAN_RESULT]: true};
    callback.onResult(account_appAccount.ResultCode.SUCCESS, result);
  }
}
var authenticator = null;
export default {
  onConnect(want) {
    authenticator = new MyAuthenticator();
    return authenticator.getRemoteObject();
  }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46