Skip to content

D
Docs

OpenHarmony / Docs
1 年多 前同步成功

通知 159
Star 292
Fork 28
D
Docs
未验证 提交 861d0904 编写于 作者: O openharmony_ci 提交者： Gitee
浏览文件
操作

!17028 add single sign on api docs 

Merge pull request !17028 from jidong/dev0410
上级 a17cfbba bd42ad49
隐藏空白更改
内联 并排
Showing with 212 addition and 6 deletion
zh-cn/application-dev/reference/apis/js-apis-osAccount.md
浏览文件 @ 861d0904
......@@ -4441,7 +4441,9 @@ auth(domainAccountInfo: DomainAccountInfo, credential: Uint8Array, callback: IUs
getAccountInfo: (domain, accountName, callback) => {},
getAuthStatusInfo: (domainAccountInfo, callback) => {},
bindAccount: (domainAccountInfo, localId, callback) => {},
unbindAccount: (domainAccountInfo, callback) => {}
unbindAccount: (domainAccountInfo, callback) => {},
isAccountTokenValid: (domainAccountInfo, callback) => {},
getAccessToken: (options, callback) => {}
}
account_osAccount.DomainAccountManager.registerPlugin(plugin);
let userAuth = new account_osAccount.UserAuth();
......@@ -4494,7 +4496,9 @@ authWithPopup(domainAccountInfo: DomainAccountInfo, callback: IUserAuthCallback)
getAccountInfo: (domain, accountName, callback) => {},
getAuthStatusInfo: (domainAccountInfo, callback) => {},
bindAccount: (domainAccountInfo, localId, callback) => {},
unbindAccount: (domainAccountInfo, callback) => {}
unbindAccount: (domainAccountInfo, callback) => {},
isAccountTokenValid: (domainAccountInfo, callback) => {},
getAccessToken: (options, callback) => {}
}
account_osAccount.DomainAccountManager.registerPlugin(plugin)
```
......@@ -4534,7 +4538,9 @@ authWithToken(domainAccountInfo: DomainAccountInfo, token: Uint8Array, callback:
getAccountInfo: (domain, accountName, callback) => {},
getAuthStatusInfo: (domainAccountInfo, callback) => {},
bindAccount: (domainAccountInfo, localId, callback) => {},
unbindAccount: (domainAccountInfo, callback) => {}
unbindAccount: (domainAccountInfo, callback) => {},
isAccountTokenValid: (domainAccountInfo, callback) => {},
getAccessToken: (options, callback) => {}
}
account_osAccount.DomainAccountManager.registerPlugin(plugin)
```
......@@ -4576,7 +4582,9 @@ getAccountInfo(domain: string, accountName: string, callback: AsyncCallback<D
},
getAuthStatusInfo: (domainAccountInfo, callback) => {},
bindAccount: (domainAccountInfo, localId, callback) => {},
unbindAccount: (domainAccountInfo, callback) => {}
unbindAccount: (domainAccountInfo, callback) => {},
isAccountTokenValid: (domainAccountInfo, callback) => {},
getAccessToken: (options, callback) => {}
}
account_osAccount.DomainAccountManager.registerPlugin(plugin)
```
......@@ -4614,7 +4622,9 @@ getAuthStatusInfo(domainAccountInfo: DomainAccountInfo, callback: AsyncCallback&
})
},
bindAccount: (domainAccountInfo, localId, callback) => {},
unbindAccount: (domainAccountInfo, callback) => {}
unbindAccount: (domainAccountInfo, callback) => {},
isAccountTokenValid: (domainAccountInfo, callback) => {},
getAccessToken: (options, callback) => {}
}
account_osAccount.DomainAccountManager.registerPlugin(plugin)
```
......@@ -4649,7 +4659,9 @@ bindAccount(domainAccountInfo: DomainAccountInfo, localId: number, callback: Asy
// notify binding result
callback({code: 0})
},
unbindAccount: (domainAccountInfo, callback) => {}
unbindAccount: (domainAccountInfo, callback) => {},
isAccountTokenValid: (domainAccountInfo, callback) => {},
getAccessToken: (options, callback) => {}
}
account_osAccount.DomainAccountManager.registerPlugin(plugin)
```
......@@ -4684,6 +4696,84 @@ unbindAccount(domainAccountInfo: DomainAccountInfo, callback: AsyncCallback<v
// mock unbinding operation
// notify unbinding result
callback({code: 0})
},
isAccountTokenValid: (domainAccountInfo, callback) => {},
getAccessToken: (options, callback) => {}
}
account_osAccount.DomainAccountManager.registerPlugin(plugin)
```
### isAccountTokenValid<sup>10+</sup>
isAccountTokenValid(domainAccountInfo: DomainAccountInfo, token: Uint8Array, callback: AsyncCallback&lt;boolean&gt;): void
检查指定的域帐号令牌是否有效。
**系统接口：** 此接口为系统接口。
**系统能力：** SystemCapability.Account.OsAccount
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ---------- | --------------------------------------- | ---- | --------------- |
| domainAccountInfo | [DomainAccountInfo](#domainaccountinfo8) | 是 | 指示域帐号信息。|
| token | Uint8Array | 是 | 指示域帐号令牌。 |
| callback | AsyncCallback&lt;boolean&gt; | 是 | 指示检查结果回调。|
**示例：**
```js
let plugin = {
auth: (domainAccountInfo, credential, callback) => {},
authWithPopup: (domainAccountInfo, callback) => {},
authWithToken: (domainAccountInfo, callback) => {},
getAccountInfo: (domain, accountName, callback) => {},
getAuthStatusInfo: (domainAccountInfo, callback) => {},
bindAccount: (domainAccountInfo, localId, callback) => {},
unbindAccount: (domainAccountInfo, callback) => {},
isAccountTokenValid: (domainAccountInfo, callback) => {
// mock checking operation
// notify checking result
callback({code: 0}, true);
},
getAccessToken: (options, callback) => {}
}
account_osAccount.DomainAccountManager.registerPlugin(plugin)
```
### getAccessToken<sup>10+</sup>
getAccessToken(options: GetDomainAccessTokenOptions, callback: AsyncCallback&lt;Uint8Array&gt;): void
根据指定的选项获取域访问令牌。
**系统接口：** 此接口为系统接口。
**系统能力：** SystemCapability.Account.OsAccount
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ---------- | --------------------------------------- | ---- | --------------- |
| options | [GetDomainAccessTokenOptions](#getdomainaccesstokenoptions10) | 是 | 指示获取域访问令牌的选项。|
| callback | AsyncCallback&lt;Uint8Array&gt; | 是 | 指示结果回调。|
**示例：**
```js
let plugin = {
auth: (domainAccountInfo, credential, callback) => {},
authWithPopup: (domainAccountInfo, callback) => {},
authWithToken: (domainAccountInfo, callback) => {},
getAccountInfo: (domain, accountName, callback) => {},
getAuthStatusInfo: (domainAccountInfo, callback) => {},
bindAccount: (domainAccountInfo, localId, callback) => {},
unbindAccount: (domainAccountInfo, callback) => {},
isAccountTokenValid: (domainAccountInfo, callback) => {},
getAccessToken: (options, callback) => {
// mock getting operation
let token = new Uint8Array([0]);
// notify result
callback({code: 0}, token);
}
}
account_osAccount.DomainAccountManager.registerPlugin(plugin)
......@@ -5003,6 +5093,107 @@ hasAccount(domainAccountInfo: DomainAccountInfo): Promise&lt;boolean&gt;
}
```
### updateAccountToken<sup>10+</sup>
updateAccountToken(domainAccountInfo: DomainAccountInfo, token: Uint8Array, callback: AsyncCallback&lt;void&gt;): void;
更新指定域帐号的令牌，空令牌表示目标域帐号的令牌失效。使用callback异步回调。
**系统接口：** 此接口为系统接口。
**系统能力：** SystemCapability.Account.OsAccount
**需要权限：** ohos.permission.MANAGE_LOCAL_ACCOUNTS
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ---------- | --------------------------------------- | ---- | --------------- |
| domainAccountInfo | [DomainAccountInfo](#domainaccountinfo8) | 是 | 指示域帐号信息。|
| token | Uint8Array | 是 | 指示域帐号的令牌。|
| callback | AsyncCallback&lt;void&gt; | 是 | 回调函数。如果更新成功，err为null，否则为错误对象。|
**错误码：**
| 错误码ID | 错误信息 |
| -------- | --------------------------- |
| 12300001 | System service exception. |
| 12300002 | Invalid token. |
| 12300003 | Account not found. |
**示例：**
```js
let domainAccountInfo = {
domain: "CHINA",
accountName: "zhangsan",
accountId: "123456"
}
let token = new Uint8Array([0])
try {
account_osAccount.DomainAccountManager.updateAccountToken(domainAccountInfo, token, (err) => {
if (err != null) {
console.log("updateAccountToken failed, error: " + JSON.stringify(err));
} else {
console.log("updateAccountToken successfully");
}
})
} catch (err) {
console.log('updateAccountToken exception = ' + JSON.stringify(err));
}
```
### updateAccountToken<sup>10+</sup>
updateAccountToken(domainAccountInfo: DomainAccountInfo, token: Uint8Array): Promise&lt;void&gt;
更新指定域帐号的令牌，空令牌表示目标域帐号的令牌失效。使用Promise异步回调。
**系统接口：** 此接口为系统接口。
**系统能力：** SystemCapability.Account.OsAccount
**需要权限：** ohos.permission.MANAGE_LOCAL_ACCOUNTS
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ---------- | --------------------------------------- | ---- | --------------- |
| domainAccountInfo | [DomainAccountInfo](#domainaccountinfo8) | 是 | 指示域帐号信息。|
| token | Uint8Array | 是 | 指示域帐号的令牌。|
**返回值：**
| 类型 | 说明 |
| :------------------------ | ----------------------- |
| Promise&lt;void&gt; | Promise对象，无返回结果的Promise对象。 |
**错误码：**
| 错误码ID | 错误信息 |
| -------- | --------------------------- |
| 12300001 | System service exception. |
| 12300002 | Invalid token. |
| 12300003 | Account not found. |
**示例：**
```js
let domainAccountInfo = {
domain: "CHINA",
accountName: "zhangsan",
accountId: "123456"
}
let token = new Uint8Array([0])
try {
account_osAccount.DomainAccountManager.updateAccountToken(domainAccountInfo, token).then(() => {
console.log("updateAccountToken successfully");
}).catch((err) => {
console.log("updateAccountToken failed, error: " + JSON.stringify(err));
});
} catch (err) {
console.log('updateAccountToken exception = ' + JSON.stringify(err));
}
```
## UserIdentityManager<sup>8+</sup>
获取用户身份管理类。
......@@ -6086,3 +6277,18 @@ onAcquireInfo?: (module: number, acquire: number, extraInfo: any) => void;
| ----------- | ------ | ---- | ---------- |
| remainTimes | number | 是 | 剩余次数 |
| freezingTime | number | 是 | 冻结时间 |
## GetDomainAccessTokenOptions<sup>10+</sup>
表示获取域访问令牌的选项。
**系统接口：** 此接口为系统接口。
**系统能力：** 以下各项对应的系统能力均为SystemCapability.Account.OsAccount。
| 名称 | 类型 | 必填 | 说明 |
| ----------- | ------ | ---- | ---------- |
| domainAccountInfo | [DomainAccountInfo](#domainaccountinfo8) | 是 | 域帐号的信息 |
| domainAccountToken | Uint8Array | 是 | 域帐号的令牌 |
| businessParams | { [key: string]: object } | 是 | 业务参数，由业务方根据请求协议自定义 |
| callerUid | number | 是 | 调用方唯一标识符 |
Markdown is supported
0% 或 .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑！
想要评论请 注册 或