提交 e4c5b0ad 编写于 作者: E ester.zhou

Update docs (18106)

Signed-off-by: Nester.zhou <ester.zhou@huawei.com>
上级 30142c76
...@@ -16,7 +16,7 @@ import adminManager from '@ohos.enterprise.adminManager'; ...@@ -16,7 +16,7 @@ import adminManager from '@ohos.enterprise.adminManager';
enableAdmin(admin: Want, enterpriseInfo: EnterpriseInfo, type: AdminType, callback: AsyncCallback\<void>): void enableAdmin(admin: Want, enterpriseInfo: EnterpriseInfo, type: AdminType, callback: AsyncCallback\<void>): void
Enables a device administrator application based on the specified bundle name and class name. This API uses an asynchronous callback to return the result. Enables a device administrator application of the current user. This API uses an asynchronous callback to return the result. The super administrator application can be enabled only by the administrator.
**Required permissions**: ohos.permission.MANAGE_ENTERPRISE_DEVICE_ADMIN **Required permissions**: ohos.permission.MANAGE_ENTERPRISE_DEVICE_ADMIN
...@@ -29,13 +29,13 @@ Enables a device administrator application based on the specified bundle name an ...@@ -29,13 +29,13 @@ Enables a device administrator application based on the specified bundle name an
| Name | Type | Mandatory | Description | | Name | Type | Mandatory | Description |
| -------------- | ----------------------------------- | ---- | ------------------ | | -------------- | ----------------------------------- | ---- | ------------------ |
| admin | [Want](js-apis-app-ability-want.md) | Yes | Device administrator application. | | admin | [Want](js-apis-app-ability-want.md) | Yes | Device administrator application. |
| enterpriseInfo | [EnterpriseInfo](#enterpriseinfo) | Yes | Enterprise information of the device administrator application. | | enterpriseInfo | [EnterpriseInfo](#enterpriseinfo) | Yes | Enterprise information of the device administrator application. |
| type | [AdminType](#admintype) | Yes | Type of the device administrator to enable. | | type | [AdminType](#admintype) | Yes | Type of the device administrator to enable. |
| callback | AsyncCallback\<void> | Yes | Callback used to return the result.| | callback | AsyncCallback\<void> | Yes | Callback used to return the result. If the operation is successful, **err** is **null**. Otherwise, **err** is an error object.|
**Error codes** **Error codes**
For details about the following error codes, see [Enterprise Device Management Error Codes](../errorcodes/errorcode-enterpriseDeviceManager.md). For details about the error codes, see [Enterprise Device Management Error Codes](../errorcodes/errorcode-enterpriseDeviceManager.md).
| ID| Error Message | | ID| Error Message |
| ------- | --------------------------------------------------------------- | | ------- | --------------------------------------------------------------- |
...@@ -48,7 +48,7 @@ For details about the following error codes, see [Enterprise Device Management E ...@@ -48,7 +48,7 @@ For details about the following error codes, see [Enterprise Device Management E
```js ```js
let wantTemp = { let wantTemp = {
bundleName: "com.example.myapplication", bundleName: "com.example.myapplication",
abilityName: "EntryAbility", abilityName: "com.example.myapplication.MainAbility",
}; };
let enterpriseInfo = { let enterpriseInfo = {
name: "enterprise name", name: "enterprise name",
...@@ -67,7 +67,7 @@ adminManager.enableAdmin(wantTemp, enterpriseInfo, adminManager.AdminType.ADMIN_ ...@@ -67,7 +67,7 @@ adminManager.enableAdmin(wantTemp, enterpriseInfo, adminManager.AdminType.ADMIN_
enableAdmin(admin: Want, enterpriseInfo: EnterpriseInfo, type: AdminType, userId: number, callback: AsyncCallback\<void>): void enableAdmin(admin: Want, enterpriseInfo: EnterpriseInfo, type: AdminType, userId: number, callback: AsyncCallback\<void>): void
Enables a device administrator application for the specified user based on the specified bundle name and class name. This API uses an asynchronous callback to return the result. Enables a device administrator application of the user specified by **userId**. This API uses an asynchronous callback to return the result. The super administrator application can be enabled only by the administrator.
**Required permissions**: ohos.permission.MANAGE_ENTERPRISE_DEVICE_ADMIN **Required permissions**: ohos.permission.MANAGE_ENTERPRISE_DEVICE_ADMIN
...@@ -83,11 +83,11 @@ Enables a device administrator application for the specified user based on the s ...@@ -83,11 +83,11 @@ Enables a device administrator application for the specified user based on the s
| enterpriseInfo | [EnterpriseInfo](#enterpriseinfo) | Yes | Enterprise information of the device administrator application. | | enterpriseInfo | [EnterpriseInfo](#enterpriseinfo) | Yes | Enterprise information of the device administrator application. |
| type | [AdminType](#admintype) | Yes | Type of the device administrator to enable. | | type | [AdminType](#admintype) | Yes | Type of the device administrator to enable. |
| userId | number | Yes | User ID. The default value is the user ID of the caller. The value must be greater than or equal to 0.| | userId | number | Yes | User ID. The default value is the user ID of the caller. The value must be greater than or equal to 0.|
| callback | AsyncCallback\<void> | Yes | Callback used to return the result. | | callback | AsyncCallback\<void> | Yes | Callback used to return the result. If the operation is successful, **err** is **null**. Otherwise, **err** is an error object. |
**Error codes** **Error codes**
For details about the following error codes, see [Enterprise Device Management Error Codes](../errorcodes/errorcode-enterpriseDeviceManager.md). For details about the error codes, see [Enterprise Device Management Error Codes](../errorcodes/errorcode-enterpriseDeviceManager.md).
| ID| Error Message | | ID| Error Message |
| ------- | --------------------------------------------------------------- | | ------- | --------------------------------------------------------------- |
...@@ -100,7 +100,7 @@ For details about the following error codes, see [Enterprise Device Management E ...@@ -100,7 +100,7 @@ For details about the following error codes, see [Enterprise Device Management E
```js ```js
let wantTemp = { let wantTemp = {
bundleName: "com.example.myapplication", bundleName: "com.example.myapplication",
abilityName: "EntryAbility", abilityName: "com.example.myapplication.MainAbility",
}; };
let enterpriseInfo = { let enterpriseInfo = {
name: "enterprise name", name: "enterprise name",
...@@ -119,7 +119,7 @@ adminManager.enableAdmin(wantTemp, enterpriseInfo, adminManager.AdminType.ADMIN_ ...@@ -119,7 +119,7 @@ adminManager.enableAdmin(wantTemp, enterpriseInfo, adminManager.AdminType.ADMIN_
enableAdmin(admin: Want, enterpriseInfo: EnterpriseInfo, type: AdminType, userId?: number): Promise\<void> enableAdmin(admin: Want, enterpriseInfo: EnterpriseInfo, type: AdminType, userId?: number): Promise\<void>
Enables a device administrator application based on the specified bundle name and class name. This API uses a promise to return the result. Enables a device administrator application of the user specified by **userId** (if any) or the current user. This API uses a promise to return the result. The super administrator application can be enabled only by the administrator.
**Required permissions**: ohos.permission.MANAGE_ENTERPRISE_DEVICE_ADMIN **Required permissions**: ohos.permission.MANAGE_ENTERPRISE_DEVICE_ADMIN
...@@ -140,11 +140,11 @@ Enables a device administrator application based on the specified bundle name an ...@@ -140,11 +140,11 @@ Enables a device administrator application based on the specified bundle name an
| Type | Description | | Type | Description |
| ----------------- | ----------------- | | ----------------- | ----------------- |
| Promise\<void> | Promise used to return the result.| | Promise\<void> | Promise that returns no value. If the operation fails, an error object is thrown.|
**Error codes** **Error codes**
For details about the following error codes, see [Enterprise Device Management Error Codes](../errorcodes/errorcode-enterpriseDeviceManager.md). For details about the error codes, see [Enterprise Device Management Error Codes](../errorcodes/errorcode-enterpriseDeviceManager.md).
| ID| Error Message | | ID| Error Message |
| ------- | --------------------------------------------------------------- | | ------- | --------------------------------------------------------------- |
...@@ -157,7 +157,7 @@ For details about the following error codes, see [Enterprise Device Management E ...@@ -157,7 +157,7 @@ For details about the following error codes, see [Enterprise Device Management E
```js ```js
let wantTemp = { let wantTemp = {
bundleName: "com.example.myapplication", bundleName: "com.example.myapplication",
abilityName: "EntryAbility", abilityName: "com.example.myapplication.MainAbility",
}; };
let enterpriseInfo = { let enterpriseInfo = {
name: "enterprise name", name: "enterprise name",
...@@ -173,7 +173,7 @@ adminManager.enableAdmin(wantTemp, enterpriseInfo, adminManager.AdminType.ADMIN_ ...@@ -173,7 +173,7 @@ adminManager.enableAdmin(wantTemp, enterpriseInfo, adminManager.AdminType.ADMIN_
disableAdmin(admin: Want, callback: AsyncCallback\<void>): void disableAdmin(admin: Want, callback: AsyncCallback\<void>): void
Disables a device common administrator application based on the specified bundle name and class name. This API uses an asynchronous callback to return the result. Disables a device common administrator application of the current user. This API uses an asynchronous callback to return the result.
**Required permissions**: ohos.permission.MANAGE_ENTERPRISE_DEVICE_ADMIN **Required permissions**: ohos.permission.MANAGE_ENTERPRISE_DEVICE_ADMIN
...@@ -186,11 +186,11 @@ Disables a device common administrator application based on the specified bundle ...@@ -186,11 +186,11 @@ Disables a device common administrator application based on the specified bundle
| Name | Type | Mandatory | Description | | Name | Type | Mandatory | Description |
| -------- | ----------------------------------- | ---- | ------------------- | | -------- | ----------------------------------- | ---- | ------------------- |
| admin | [Want](js-apis-app-ability-want.md) | Yes | Device common administrator application. | | admin | [Want](js-apis-app-ability-want.md) | Yes | Device common administrator application. |
| callback | AsyncCallback\<void> | Yes | Callback used to return the result.| | callback | AsyncCallback\<void> | Yes | Callback used to return the result. If the operation is successful, **err** is **null**. Otherwise, **err** is an error object.|
**Error codes** **Error codes**
For details about the following error codes, see [Enterprise Device Management Error Codes](../errorcodes/errorcode-enterpriseDeviceManager.md). For details about the error codes, see [Enterprise Device Management Error Codes](../errorcodes/errorcode-enterpriseDeviceManager.md).
| ID| Error Message | | ID| Error Message |
| ------- | ----------------------------------------------------------------- | | ------- | ----------------------------------------------------------------- |
...@@ -216,7 +216,7 @@ adminManager.disableAdmin(wantTemp, error => { ...@@ -216,7 +216,7 @@ adminManager.disableAdmin(wantTemp, error => {
disableAdmin(admin: Want, userId: number, callback: AsyncCallback\<void>): void disableAdmin(admin: Want, userId: number, callback: AsyncCallback\<void>): void
Disables a device common administrator application for the specified user based on the specified bundle name and class name. This API uses an asynchronous callback to return the result. Disables a device common administrator application of the user specified by **userId**. This API uses an asynchronous callback to return the result.
**Required permissions**: ohos.permission.MANAGE_ENTERPRISE_DEVICE_ADMIN **Required permissions**: ohos.permission.MANAGE_ENTERPRISE_DEVICE_ADMIN
...@@ -230,11 +230,11 @@ Disables a device common administrator application for the specified user based ...@@ -230,11 +230,11 @@ Disables a device common administrator application for the specified user based
| -------- | ----------------------------------- | ---- | ---------------------------- | | -------- | ----------------------------------- | ---- | ---------------------------- |
| admin | [Want](js-apis-app-ability-want.md) | Yes | Device common administrator application. | | admin | [Want](js-apis-app-ability-want.md) | Yes | Device common administrator application. |
| userId | number | Yes | User ID. The default value is the user ID of the caller. The value must be greater than or equal to 0.| | userId | number | Yes | User ID. The default value is the user ID of the caller. The value must be greater than or equal to 0.|
| callback | AsyncCallback\<void> | Yes | Callback used to return the result. | | callback | AsyncCallback\<void> | Yes | Callback used to return the result. If the operation is successful, **err** is **null**. Otherwise, **err** is an error object. |
**Error codes** **Error codes**
For details about the following error codes, see [Enterprise Device Management Error Codes](../errorcodes/errorcode-enterpriseDeviceManager.md). For details about the error codes, see [Enterprise Device Management Error Codes](../errorcodes/errorcode-enterpriseDeviceManager.md).
| ID| Error Message | | ID| Error Message |
| ------- | ----------------------------------------------------------------- | | ------- | ----------------------------------------------------------------- |
...@@ -260,7 +260,7 @@ adminManager.disableAdmin(wantTemp, 100, error => { ...@@ -260,7 +260,7 @@ adminManager.disableAdmin(wantTemp, 100, error => {
disableAdmin(admin: Want, userId?: number): Promise\<void> disableAdmin(admin: Want, userId?: number): Promise\<void>
Disables a device common administrator application based on the specified bundle name and class name. This API uses a promise to return the result. Disables a device administrator application of the user specified by **userId** (if any) or the current user. This API uses a promise to return the result.
**Required permissions**: ohos.permission.MANAGE_ENTERPRISE_DEVICE_ADMIN **Required permissions**: ohos.permission.MANAGE_ENTERPRISE_DEVICE_ADMIN
...@@ -279,11 +279,11 @@ Disables a device common administrator application based on the specified bundle ...@@ -279,11 +279,11 @@ Disables a device common administrator application based on the specified bundle
| Type | Description | | Type | Description |
| ----------------- | ----------------- | | ----------------- | ----------------- |
| Promise\<void> | Promise used to return the result.| | Promise\<void> | Promise that returns no value. If the operation fails, an error object is thrown.|
**Error codes** **Error codes**
For details about the following error codes, see [Enterprise Device Management Error Codes](../errorcodes/errorcode-enterpriseDeviceManager.md). For details about the error codes, see [Enterprise Device Management Error Codes](../errorcodes/errorcode-enterpriseDeviceManager.md).
| ID| Error Message | | ID| Error Message |
| ------- | ----------------------------------------------------------------- | | ------- | ----------------------------------------------------------------- |
...@@ -318,11 +318,11 @@ Disables a device super administrator application based on the specified bundle ...@@ -318,11 +318,11 @@ Disables a device super administrator application based on the specified bundle
| Name | Type | Mandatory | Description | | Name | Type | Mandatory | Description |
| ---------- | ----------------------- | ---- | ------------------- | | ---------- | ----------------------- | ---- | ------------------- |
| bundleName | String | Yes | Bundle name of the device super administrator application. | | bundleName | String | Yes | Bundle name of the device super administrator application. |
| callback | AsyncCallback\<void> | Yes | Callback used to return the result.| | callback | AsyncCallback\<void> | Yes | Callback used to return the result. If the operation is successful, **err** is **null**. Otherwise, **err** is an error object.|
**Error codes** **Error codes**
For details about the following error codes, see [Enterprise Device Management Error Codes](../errorcodes/errorcode-enterpriseDeviceManager.md). For details about the error codes, see [Enterprise Device Management Error Codes](../errorcodes/errorcode-enterpriseDeviceManager.md).
| ID| Error Message | | ID| Error Message |
| ------- | ----------------------------------------------------------------- | | ------- | ----------------------------------------------------------------- |
...@@ -363,11 +363,11 @@ Disables a device super administrator application based on the specified bundle ...@@ -363,11 +363,11 @@ Disables a device super administrator application based on the specified bundle
| Type | Description | | Type | Description |
| ----------------- | ----------------- | | ----------------- | ----------------- |
| Promise\<void> | Promise used to return the result.| | Promise\<void> | Promise that returns no value. If the operation fails, an error object is thrown.|
**Error codes** **Error codes**
For details about the following error codes, see [Enterprise Device Management Error Codes](../errorcodes/errorcode-enterpriseDeviceManager.md). For details about the error codes, see [Enterprise Device Management Error Codes](../errorcodes/errorcode-enterpriseDeviceManager.md).
| ID| Error Message | | ID| Error Message |
| ------- | ----------------------------------------------------------------- | | ------- | ----------------------------------------------------------------- |
...@@ -386,7 +386,7 @@ adminManager.disableSuperAdmin(bundleName).catch(error => { ...@@ -386,7 +386,7 @@ adminManager.disableSuperAdmin(bundleName).catch(error => {
isAdminEnabled(admin: Want, callback: AsyncCallback\<boolean>): void isAdminEnabled(admin: Want, callback: AsyncCallback\<boolean>): void
Checks whether a device administrator application is enabled based on the specified bundle name and class name. This API uses an asynchronous callback to return the result. Checks whether a device administrator application of the current user is enabled. This API uses an asynchronous callback to return the result.
**System capability**: SystemCapability.Customization.EnterpriseDeviceManager **System capability**: SystemCapability.Customization.EnterpriseDeviceManager
...@@ -396,8 +396,8 @@ Checks whether a device administrator application is enabled based on the specif ...@@ -396,8 +396,8 @@ Checks whether a device administrator application is enabled based on the specif
| Name | Type | Mandatory | Description | | Name | Type | Mandatory | Description |
| -------- | ----------------------------------- | ---- | -------------------- | | -------- | ----------------------------------- | ---- | -------------------- |
| admin | [Want](js-apis-app-ability-want.md) | Yes | Device administrator application. | | admin | [Want](js-apis-app-ability-want.md) | Yes | Device administrator application. |
| callback | AsyncCallback\<boolean> | Yes | Callback used to return the result.| | callback | AsyncCallback\<boolean> | Yes | Callback used to return the result. If the operation is successful, **err** is **null** and **data** is a Boolean value (**true** means that the device administrator application is enabled; and **false** means the opposite). If the operation fails, **err** is an error object.|
**Example** **Example**
...@@ -419,7 +419,7 @@ adminManager.isAdminEnabled(wantTemp, (error, result) => { ...@@ -419,7 +419,7 @@ adminManager.isAdminEnabled(wantTemp, (error, result) => {
isAdminEnabled(admin: Want, userId: number, callback: AsyncCallback\<boolean>): void isAdminEnabled(admin: Want, userId: number, callback: AsyncCallback\<boolean>): void
Checks whether a device administrator application is enabled for the specified user based on the specified bundle name and class name. This API uses an asynchronous callback to return the result. Checks whether a device administrator application of the user specified by **userId** is enabled. This API uses an asynchronous callback to return the result.
**System capability**: SystemCapability.Customization.EnterpriseDeviceManager **System capability**: SystemCapability.Customization.EnterpriseDeviceManager
...@@ -431,7 +431,7 @@ Checks whether a device administrator application is enabled for the specified u ...@@ -431,7 +431,7 @@ Checks whether a device administrator application is enabled for the specified u
| -------- | ----------------------------------- | ---- | ---------------------------- | | -------- | ----------------------------------- | ---- | ---------------------------- |
| admin | [Want](js-apis-app-ability-want.md) | Yes | Device administrator application. | | admin | [Want](js-apis-app-ability-want.md) | Yes | Device administrator application. |
| userId | number | Yes | User ID. The default value is the user ID of the caller. The value must be greater than or equal to 0.| | userId | number | Yes | User ID. The default value is the user ID of the caller. The value must be greater than or equal to 0.|
| callback | AsyncCallback\<boolean> | Yes | Callback used to return the result. | | callback | AsyncCallback\<boolean> | Yes | Callback used to return the result. If the operation is successful, **err** is **null** and **data** is a Boolean value (**true** means that the device administrator application is enabled; and **false** means the opposite). If the operation fails, **err** is an error object. |
**Example** **Example**
...@@ -453,7 +453,7 @@ adminManager.isAdminEnabled(wantTemp, 100, (error, result) => { ...@@ -453,7 +453,7 @@ adminManager.isAdminEnabled(wantTemp, 100, (error, result) => {
isAdminEnabled(admin: Want, userId?: number): Promise\<boolean> isAdminEnabled(admin: Want, userId?: number): Promise\<boolean>
Checks whether a device administrator application is enabled based on the specified bundle name and class name. This API uses a promise to return the result. Checks whether a device administrator application of the user specified by **userId** (if any) or the current user is enabled. This API uses a promise to return the result.
**System capability**: SystemCapability.Customization.EnterpriseDeviceManager **System capability**: SystemCapability.Customization.EnterpriseDeviceManager
...@@ -470,7 +470,7 @@ Checks whether a device administrator application is enabled based on the specif ...@@ -470,7 +470,7 @@ Checks whether a device administrator application is enabled based on the specif
| Type | Description | | Type | Description |
| ----------------- | ------------------- | | ----------------- | ------------------- |
| Promise\<boolean> | Promise used to return the result.| | Promise\<boolean> | Promise used to return the result. If **true** is returned, the device administrator application is enabled. If **false** is returned, the device administrator application is not enabled.|
**Example** **Example**
...@@ -501,7 +501,7 @@ Checks whether a device super administrator application is enabled based on the ...@@ -501,7 +501,7 @@ Checks whether a device super administrator application is enabled based on the
| Name | Type | Mandatory | Description | | Name | Type | Mandatory | Description |
| ---------- | ----------------------- | ---- | -------------------- | | ---------- | ----------------------- | ---- | -------------------- |
| bundleName | String | Yes | Device administrator application. | | bundleName | String | Yes | Device administrator application. |
| callback | AsyncCallback\<boolean> | Yes | Callback used to return the result.| | callback | AsyncCallback\<boolean> | Yes | Callback used to return the result. If the operation is successful, **err** is **null** and **data** is a Boolean value (**true** means that the device administrator application is enabled; and **false** means the opposite). If the operation fails, **err** is an error object.|
**Example** **Example**
...@@ -536,7 +536,7 @@ Checks whether a device super administrator application is enabled based on the ...@@ -536,7 +536,7 @@ Checks whether a device super administrator application is enabled based on the
| ID | Error Message | | ID | Error Message |
| ----------------- | ------------------- | | ----------------- | ------------------- |
| Promise\<boolean> | Promise used to return the result.| | Promise\<boolean> | Promise used to return the result. If **true** is returned, the device super administrator application is enabled. If **false** is returned, the device super administrator application is not enabled.|
**Example** **Example**
...@@ -567,11 +567,11 @@ Sets the enterprise information of a device administrator application. This API ...@@ -567,11 +567,11 @@ Sets the enterprise information of a device administrator application. This API
| -------------- | ----------------------------------- | ---- | ---------------------- | | -------------- | ----------------------------------- | ---- | ---------------------- |
| admin | [Want](js-apis-app-ability-want.md) | Yes | Device administrator application. | | admin | [Want](js-apis-app-ability-want.md) | Yes | Device administrator application. |
| enterpriseInfo | [EnterpriseInfo](#enterpriseinfo) | Yes | Enterprise information of the device administrator application. | | enterpriseInfo | [EnterpriseInfo](#enterpriseinfo) | Yes | Enterprise information of the device administrator application. |
| callback | AsyncCallback\<void>; | Yes | Callback used to return the result.| | callback | AsyncCallback\<void>; | Yes | Callback used to return the result. If the operation is successful, **err** is **null**. Otherwise, **err** is an error object.|
**Error codes** **Error codes**
For details about the following error codes, see [Enterprise Device Management Error Codes](../errorcodes/errorcode-enterpriseDeviceManager.md). For details about the error codes, see [Enterprise Device Management Error Codes](../errorcodes/errorcode-enterpriseDeviceManager.md).
| ID| Error Message | | ID| Error Message |
| ------- | ----------------------------------------------------- | | ------- | ----------------------------------------------------- |
...@@ -582,7 +582,7 @@ For details about the following error codes, see [Enterprise Device Management E ...@@ -582,7 +582,7 @@ For details about the following error codes, see [Enterprise Device Management E
```js ```js
let wantTemp = { let wantTemp = {
bundleName: "com.example.myapplication", bundleName: "com.example.myapplication",
abilityName: "EntryAbility", abilityName: "com.example.myapplication.MainAbility",
}; };
let enterpriseInfo = { let enterpriseInfo = {
name: "enterprise name", name: "enterprise name",
...@@ -620,11 +620,11 @@ Sets the enterprise information of a device administrator application. This API ...@@ -620,11 +620,11 @@ Sets the enterprise information of a device administrator application. This API
| Type | Description | | Type | Description |
| ----------------- | --------------------- | | ----------------- | --------------------- |
| Promise\<void> | Promise used to return the result.| | Promise\<void> | Promise that returns no value. If the operation fails, an error object is thrown.|
**Error codes** **Error codes**
For details about the following error codes, see [Enterprise Device Management Error Codes](../errorcodes/errorcode-enterpriseDeviceManager.md). For details about the error codes, see [Enterprise Device Management Error Codes](../errorcodes/errorcode-enterpriseDeviceManager.md).
| ID| Error Message | | ID| Error Message |
| ------- | ----------------------------------------------------- | | ------- | ----------------------------------------------------- |
...@@ -635,7 +635,7 @@ For details about the following error codes, see [Enterprise Device Management E ...@@ -635,7 +635,7 @@ For details about the following error codes, see [Enterprise Device Management E
```js ```js
let wantTemp = { let wantTemp = {
bundleName: "com.example.myapplication", bundleName: "com.example.myapplication",
abilityName: "EntryAbility", abilityName: "com.example.myapplication.MainAbility",
}; };
let enterpriseInfo = { let enterpriseInfo = {
name: "enterprise name", name: "enterprise name",
...@@ -661,11 +661,11 @@ Obtains the enterprise information of a device administrator application. This A ...@@ -661,11 +661,11 @@ Obtains the enterprise information of a device administrator application. This A
| Name | Type | Mandatory | Description | | Name | Type | Mandatory | Description |
| -------- | ---------------------------------------- | ---- | ------------------------ | | -------- | ---------------------------------------- | ---- | ------------------------ |
| admin | [Want](js-apis-app-ability-want.md) | Yes | Device administrator application. | | admin | [Want](js-apis-app-ability-want.md) | Yes | Device administrator application. |
| callback | AsyncCallback&lt;[EnterpriseInfo](#enterpriseinfo)&gt; | Yes | Callback used to return the enterprise information of the device administrator application.| | callback | AsyncCallback&lt;[EnterpriseInfo](#enterpriseinfo)&gt; | Yes | Callback used to return the result. If the operation is successful, **err** is **null** and **data** is the enterprise information of the device administrator application. If the operation fails, **err** is an error object.|
**Error codes** **Error codes**
For details about the following error codes, see [Enterprise Device Management Error Codes](../errorcodes/errorcode-enterpriseDeviceManager.md). For details about the error codes, see [Enterprise Device Management Error Codes](../errorcodes/errorcode-enterpriseDeviceManager.md).
| ID| Error Message | | ID| Error Message |
| ------- | ----------------------------------------------------- | | ------- | ----------------------------------------------------- |
...@@ -676,7 +676,7 @@ For details about the following error codes, see [Enterprise Device Management E ...@@ -676,7 +676,7 @@ For details about the following error codes, see [Enterprise Device Management E
```js ```js
let wantTemp = { let wantTemp = {
bundleName: "com.example.myapplication", bundleName: "com.example.myapplication",
abilityName: "EntryAbility", abilityName: "com.example.myapplication.MainAbility",
}; };
adminManager.getEnterpriseInfo(wantTemp, (error, result) => { adminManager.getEnterpriseInfo(wantTemp, (error, result) => {
if (error != null) { if (error != null) {
...@@ -708,11 +708,11 @@ Obtains the enterprise information of a device administrator application. This A ...@@ -708,11 +708,11 @@ Obtains the enterprise information of a device administrator application. This A
| Type | Description | | Type | Description |
| ---------------------------------------- | ------------------------- | | ---------------------------------------- | ------------------------- |
| Promise&lt;[EnterpriseInfo](#enterpriseinfo)&gt; | Promise used to return the enterprise information of the device administrator application.| | Promise&lt;[EnterpriseInfo](#enterpriseinfo)&gt; | Callback used to return the enterprise information of the device administrator application.|
**Error codes** **Error codes**
For details about the following error codes, see [Enterprise Device Management Error Codes](../errorcodes/errorcode-enterpriseDeviceManager.md). For details about the error codes, see [Enterprise Device Management Error Codes](../errorcodes/errorcode-enterpriseDeviceManager.md).
| ID| Error Message | | ID| Error Message |
| ------- | ----------------------------------------------------- | | ------- | ----------------------------------------------------- |
...@@ -723,7 +723,7 @@ For details about the following error codes, see [Enterprise Device Management E ...@@ -723,7 +723,7 @@ For details about the following error codes, see [Enterprise Device Management E
```js ```js
let wantTemp = { let wantTemp = {
bundleName: "com.example.myapplication", bundleName: "com.example.myapplication",
abilityName: "EntryAbility", abilityName: "com.example.myapplication.MainAbility",
}; };
adminManager.getEnterpriseInfo(wantTemp).then((result) => { adminManager.getEnterpriseInfo(wantTemp).then((result) => {
console.log(result.name); console.log(result.name);
...@@ -737,7 +737,7 @@ adminManager.getEnterpriseInfo(wantTemp).then((result) => { ...@@ -737,7 +737,7 @@ adminManager.getEnterpriseInfo(wantTemp).then((result) => {
subscribeManagedEvent(admin: Want, managedEvents: Array\<ManagedEvent>, callback: AsyncCallback\<void>): void subscribeManagedEvent(admin: Want, managedEvents: Array\<ManagedEvent>, callback: AsyncCallback\<void>): void
Subscribes to system management events. This API uses an asynchronous callback to return the result. Configures a device administrator application to subscribe to system management events. This API uses an asynchronous callback to return the result.
**Required permissions**: ohos.permission.ENTERPRISE_SUBSCRIBE_MANAGED_EVENT **Required permissions**: ohos.permission.ENTERPRISE_SUBSCRIBE_MANAGED_EVENT
...@@ -751,11 +751,11 @@ Subscribes to system management events. This API uses an asynchronous callback t ...@@ -751,11 +751,11 @@ Subscribes to system management events. This API uses an asynchronous callback t
| ----- | ----------------------------------- | ---- | ------- | | ----- | ----------------------------------- | ---- | ------- |
| admin | [Want](js-apis-app-ability-want.md) | Yes | Device administrator application.| | admin | [Want](js-apis-app-ability-want.md) | Yes | Device administrator application.|
| managedEvents | Array\<[ManagedEvent](#managedevent)> | Yes| Array of events to subscribe to.| | managedEvents | Array\<[ManagedEvent](#managedevent)> | Yes| Array of events to subscribe to.|
| callback | AsyncCallback\<void> | Yes| Callback used to return the result. If the subscription is successful, **err** is **null**. Otherwise, **err** is an error object.| | callback | AsyncCallback\<void> | Yes| Callback used to return the result. If the operation is successful, **err** is **null**. Otherwise, **err** is an error object.|
**Error codes** **Error codes**
For details about the following error codes, see [Enterprise Device Management Error Codes](../errorcodes/errorcode-enterpriseDeviceManager.md). For details about the error codes, see [Enterprise Device Management Error Codes](../errorcodes/errorcode-enterpriseDeviceManager.md).
|ID| Error Message | |ID| Error Message |
| ------- | ----------------------------------------------------- | | ------- | ----------------------------------------------------- |
...@@ -781,7 +781,7 @@ adminManager.subscribeManagedEvent(wantTemp, events, (error) => { ...@@ -781,7 +781,7 @@ adminManager.subscribeManagedEvent(wantTemp, events, (error) => {
subscribeManagedEvent(admin: Want, managedEvents: Array\<ManagedEvent>): Promise\<void> subscribeManagedEvent(admin: Want, managedEvents: Array\<ManagedEvent>): Promise\<void>
Subscribes to system management events. This API uses a promise to return the result. Configures a device administrator application to subscribe to system management events. This API uses a promise to return the result.
**Required permissions**: ohos.permission.ENTERPRISE_SUBSCRIBE_MANAGED_EVENT **Required permissions**: ohos.permission.ENTERPRISE_SUBSCRIBE_MANAGED_EVENT
...@@ -800,11 +800,11 @@ Subscribes to system management events. This API uses a promise to return the re ...@@ -800,11 +800,11 @@ Subscribes to system management events. This API uses a promise to return the re
| Type | Description | | Type | Description |
| ----- | ----------------------------------- | | ----- | ----------------------------------- |
| Promise\<void> | Promise that returns no value.| | Promise\<void> | Promise that returns no value. If the operation fails, an error object is thrown.|
**Error codes** **Error codes**
For details about the following error codes, see [Enterprise Device Management Error Codes](../errorcodes/errorcode-enterpriseDeviceManager.md). For details about the error codes, see [Enterprise Device Management Error Codes](../errorcodes/errorcode-enterpriseDeviceManager.md).
| ID| Error Message | | ID| Error Message |
| ------- | ----------------------------------------------------- | | ------- | ----------------------------------------------------- |
...@@ -829,7 +829,7 @@ adminManager.subscribeManagedEvent(wantTemp, events).then(() => { ...@@ -829,7 +829,7 @@ adminManager.subscribeManagedEvent(wantTemp, events).then(() => {
unsubscribeManagedEvent(admin: Want, managedEvents: Array\<ManagedEvent>, callback: AsyncCallback\<void>): void unsubscribeManagedEvent(admin: Want, managedEvents: Array\<ManagedEvent>, callback: AsyncCallback\<void>): void
Unsubscribes from system management events. This API uses an asynchronous callback to return the result. Configures a device administrator application to unsubscribe from system management events. This API uses an asynchronous callback to return the result.
**Required permissions**: ohos.permission.ENTERPRISE_SUBSCRIBE_MANAGED_EVENT **Required permissions**: ohos.permission.ENTERPRISE_SUBSCRIBE_MANAGED_EVENT
...@@ -843,11 +843,11 @@ Unsubscribes from system management events. This API uses an asynchronous callba ...@@ -843,11 +843,11 @@ Unsubscribes from system management events. This API uses an asynchronous callba
| ----- | ----------------------------------- | ---- | ------- | | ----- | ----------------------------------- | ---- | ------- |
| admin | [Want](js-apis-app-ability-want.md) | Yes | Device administrator application.| | admin | [Want](js-apis-app-ability-want.md) | Yes | Device administrator application.|
| managedEvents | Array\<[ManagedEvent](#managedevent)> | Yes| Array of events to unsubscribe from.| | managedEvents | Array\<[ManagedEvent](#managedevent)> | Yes| Array of events to unsubscribe from.|
| callback | AsyncCallback\<void> | Yes| Callback used to return the result. If the unsubscription is successful, **err** is **null**. Otherwise, **err** is an error object.| | callback | AsyncCallback\<void> | Yes| Callback used to return the result. If the operation is successful, **err** is **null**. Otherwise, **err** is an error object.|
**Error codes** **Error codes**
For details about the following error codes, see [Enterprise Device Management Error Codes](../errorcodes/errorcode-enterpriseDeviceManager.md). For details about the error codes, see [Enterprise Device Management Error Codes](../errorcodes/errorcode-enterpriseDeviceManager.md).
| ID| Error Message | | ID| Error Message |
| ------- | ----------------------------------------------------- | | ------- | ----------------------------------------------------- |
...@@ -873,7 +873,7 @@ adminManager.unsubscribeManagedEvent(wantTemp, events, (error) => { ...@@ -873,7 +873,7 @@ adminManager.unsubscribeManagedEvent(wantTemp, events, (error) => {
unsubscribeManagedEvent(admin: Want, managedEvents: Array\<ManagedEvent>): Promise\<void> unsubscribeManagedEvent(admin: Want, managedEvents: Array\<ManagedEvent>): Promise\<void>
Unsubscribes from system management events. This API uses an asynchronous callback to return the result. Configures a device administrator application to unsubscribe from system management events. This API uses a promise to return the result.
**Required permissions**: ohos.permission.ENTERPRISE_SUBSCRIBE_MANAGED_EVENT **Required permissions**: ohos.permission.ENTERPRISE_SUBSCRIBE_MANAGED_EVENT
...@@ -892,11 +892,11 @@ Unsubscribes from system management events. This API uses an asynchronous callba ...@@ -892,11 +892,11 @@ Unsubscribes from system management events. This API uses an asynchronous callba
| Type | Description | | Type | Description |
| ----- | ----------------------------------- | | ----- | ----------------------------------- |
| Promise\<void> | Promise that returns no value.| | Promise\<void> | Promise that returns no value. If the operation fails, an error object is thrown.|
**Error codes** **Error codes**
For details about the following error codes, see [Enterprise Device Management Error Codes](../errorcodes/errorcode-enterpriseDeviceManager.md). For details about the error codes, see [Enterprise Device Management Error Codes](../errorcodes/errorcode-enterpriseDeviceManager.md).
| ID| Error Message | | ID| Error Message |
| ------- | ----------------------------------------------------- | | ------- | ----------------------------------------------------- |
...@@ -953,5 +953,6 @@ Enumerates the system management events that can be subscribed to. ...@@ -953,5 +953,6 @@ Enumerates the system management events that can be subscribed to.
| Name | Value | Description | | Name | Value | Description |
| -------------------------- | ---- | ------------- | | -------------------------- | ---- | ------------- |
| MANAGED_EVENT_BUNDLE_ADDED | 0 | Application installation event.| | MANAGED_EVENT_BUNDLE_ADDED | 0 | Bundle added.|
| MANAGED_EVENT_BUNDLE_REMOVED | 1 | Application uninstallation event.| | MANAGED_EVENT_BUNDLE_REMOVED | 1 | Bundle removed.|
# @ohos.enterprise.dateTimeManager # @ohos.enterprise.dateTimeManager (System Time Management)
The **dateTimeManager** module provides APIs for system time management, which can only be called by device administrator applications. The **dateTimeManager** module provides APIs for system time management. Only the enterprise device administrator applications can call the APIs provided by this module.
> **NOTE** > **NOTE**
> >
...@@ -16,7 +16,7 @@ import dateTimeManager from '@ohos.enterprise.dateTimeManager' ...@@ -16,7 +16,7 @@ import dateTimeManager from '@ohos.enterprise.dateTimeManager'
setDateTime(admin: Want, time: number, callback: AsyncCallback\<void>): void setDateTime(admin: Want, time: number, callback: AsyncCallback\<void>): void
Sets the system time. This API uses an asynchronous callback to return the result. Configures a device administrator application to set the system time. This API uses an asynchronous callback to return the result.
**Required permissions**: ohos.permission.ENTERPRISE_SET_DATETIME **Required permissions**: ohos.permission.ENTERPRISE_SET_DATETIME
...@@ -30,11 +30,11 @@ Sets the system time. This API uses an asynchronous callback to return the resul ...@@ -30,11 +30,11 @@ Sets the system time. This API uses an asynchronous callback to return the resul
| ----- | ----------------------------------- | ---- | ------- | | ----- | ----------------------------------- | ---- | ------- |
| admin | [Want](js-apis-app-ability-want.md) | Yes | Device administrator application.| | admin | [Want](js-apis-app-ability-want.md) | Yes | Device administrator application.|
| time | number | Yes| Timestamp (ms).| | time | number | Yes| Timestamp (ms).|
| callback | AsyncCallback\<void> | Yes| Callback used to return the result. If the setting is successful, **err** is **null**. Otherwise, **err** is an error object.| | callback | AsyncCallback\<void> | Yes| Callback used to return the result. If the operation is successful, **err** is **null**. Otherwise, **err** is an error object.|
**Error codes** **Error codes**
For details about the following error codes, see [Enterprise Device Management Error Codes](../errorcodes/errorcode-enterpriseDeviceManager.md). For details about the error codes, see [Enterprise Device Management Error Codes](../errorcodes/errorcode-enterpriseDeviceManager.md).
| ID| Error Message | | ID| Error Message |
| ------- | ---------------------------------------------------------------------------- | | ------- | ---------------------------------------------------------------------------- |
...@@ -59,7 +59,7 @@ dateTimeManager.setDateTime(wantTemp, 1526003846000, (error) => { ...@@ -59,7 +59,7 @@ dateTimeManager.setDateTime(wantTemp, 1526003846000, (error) => {
setDateTime(admin: Want, time: number): Promise\<void> setDateTime(admin: Want, time: number): Promise\<void>
Sets the system time. This API uses a promise to return the result. Configures a device administrator application to set the system time. This API uses a promise to return the result.
**Required permissions**: ohos.permission.ENTERPRISE_SET_DATETIME **Required permissions**: ohos.permission.ENTERPRISE_SET_DATETIME
...@@ -82,7 +82,7 @@ Sets the system time. This API uses a promise to return the result. ...@@ -82,7 +82,7 @@ Sets the system time. This API uses a promise to return the result.
**Error codes** **Error codes**
For details about the following error codes, see [Enterprise Device Management Error Codes](../errorcodes/errorcode-enterpriseDeviceManager.md). For details about the error codes, see [Enterprise Device Management Error Codes](../errorcodes/errorcode-enterpriseDeviceManager.md).
| ID| Error Message | | ID| Error Message |
| ------- | ---------------------------------------------------------------------------- | | ------- | ---------------------------------------------------------------------------- |
......
...@@ -55,8 +55,8 @@ Sets the parameters to be passed in the **PluginManager.Push** API in the FA mod ...@@ -55,8 +55,8 @@ Sets the parameters to be passed in the **PluginManager.Push** API in the FA mod
| --------- | ----------------------------------- | ---- | -------------------------------------------------------------- | | --------- | ----------------------------------- | ---- | -------------------------------------------------------------- |
| want | [Want](js-apis-application-want.md) | Yes | Ability information of the component user. | | want | [Want](js-apis-application-want.md) | Yes | Ability information of the component user. |
| name | string | Yes | Component name. | | name | string | Yes | Component name. |
| data | [KVObject](#kvobject) | No | Component data value. | | data | [KVObject](#kvobject) | Yes | Component data value. |
| extraData | [KVObject](#kvobject) | No | Additional data value. | | extraData | [KVObject](#kvobject) | Yes | Additional data value. |
| jsonPath | string | No | Path to the [external.json](#about-the-externaljson-file) file that stores the template path.| | jsonPath | string | No | Path to the [external.json](#about-the-externaljson-file) file that stores the template path.|
### PushParameterForStage ### PushParameterForStage
...@@ -74,8 +74,8 @@ Sets the parameters to be passed in the **PluginManager.Push** API in the stage ...@@ -74,8 +74,8 @@ Sets the parameters to be passed in the **PluginManager.Push** API in the stage
| owner | [Want](js-apis-application-want.md) | Yes | Ability information of the component provider. | | owner | [Want](js-apis-application-want.md) | Yes | Ability information of the component provider. |
| target | [Want](js-apis-application-want.md) | Yes | Ability information of the component user. | | target | [Want](js-apis-application-want.md) | Yes | Ability information of the component user. |
| name | string | Yes | Component name. | | name | string | Yes | Component name. |
| data | [KVObject](#kvobject) | No | Component data value. | | data | [KVObject](#kvobject) | Yes | Component data value. |
| extraData | [KVObject](#kvobject) | No | Additional data value. | | extraData | [KVObject](#kvobject) | Yes | Additional data value. |
| jsonPath | string | No | Path to the [external.json](#about-the-externaljson-file) file that stores the template path.| | jsonPath | string | No | Path to the [external.json](#about-the-externaljson-file) file that stores the template path.|
### RequestParameters ### RequestParameters
...@@ -117,11 +117,11 @@ Provides the result returned after the **PluginManager.Request** API is called. ...@@ -117,11 +117,11 @@ Provides the result returned after the **PluginManager.Request** API is called.
**System capability**: SystemCapability.ArkUI.ArkUI.Full **System capability**: SystemCapability.ArkUI.ArkUI.Full
| Name | Type | Mandatory| Description | | Name | Type | Mandatory| Description |
| ----------------- | ---------------------------------------------------- | ---- | ---------- | | ----------------- | --------------------------------------------------- | ---- | ---------- |
| componentTemplate | [PluginComponentTemplate](#plugincomponenttemplate)] | Yes | Component template.| | componentTemplate | [PluginComponentTemplate](#plugincomponenttemplate) | Yes | Component template.|
| data | [KVObject](#kvobject) | Yes | Component data.| | data | [KVObject](#kvobject) | Yes | Component data.|
| extraData | [KVObject](#kvobject) | Yes | Additional data.| | extraData | [KVObject](#kvobject) | Yes | Additional data.|
### RequestEventResult ### RequestEventResult
...@@ -175,7 +175,7 @@ Registers the listener for the request event. ...@@ -175,7 +175,7 @@ Registers the listener for the request event.
| Name | Type | Mandatory| Description | | Name | Type | Mandatory| Description |
| --------- | ----------------------------------- | ---- | --------------------------- | | --------- | ----------------------------------- | ---- | --------------------------- |
| source | [Want](js-apis-application-want.md) | Yes | Information about the request sender.| | source | [Want](js-apis-application-want.md) | Yes | Information about the request sender.|
| data | [KVObject](#kvobject) | Yes | Data. | | name | string | Yes | Template name. |
| extraData | [KVObject](#kvobject) | Yes | Additional data. | | extraData | [KVObject](#kvobject) | Yes | Additional data. |
**Example** **Example**
......
...@@ -5,7 +5,7 @@ The **\<PluginComponent>** allows the UI provided by an external application to ...@@ -5,7 +5,7 @@ The **\<PluginComponent>** allows the UI provided by an external application to
> **NOTE** > **NOTE**
> >
> - This component is supported since API version 9. Updates will be marked with a superscript to indicate their earliest API version. > This component is supported since API version 9. Updates will be marked with a superscript to indicate their earliest API version.
## Child Components ## Child Components
...@@ -30,10 +30,21 @@ Creates a **PluginComponent** to display the UI provided by an external applicat ...@@ -30,10 +30,21 @@ Creates a **PluginComponent** to display the UI provided by an external applicat
| ---------- | ------ | --------------------------- | | ---------- | ------ | --------------------------- |
| source | string | Component template name. | | source | string | Component template name. |
| bundleName | string | Bundle name of the provider ability.| | bundleName | string | Bundle name of the provider ability.|
## Attributes ## Attributes
The [universal attributes](ts-universal-attributes-size.md) are supported, and **size** must be set.
**NOTE**
The template can be provided in either of the following modes:
* Use an absolute path. In this case, set **source** to the absolute path of the template and leave **bundleName** blank. This mode is not recommende as it is applicable only to standalone templates that do not need to load resources.
* Use an application package. In this case, set **bundleName** to the application bundle name and **source** to the relative path of the HAP file template.
Example: **{source: 'ets/pages/plugin.js', bundleName: 'com.example.provider'}**
The template is provided only when **source** can be set to an ability name in the FA model.
Example: **{source: 'plugin', bundleName: 'com.example.provider'}**
The universal attribute [size](ts-universal-attributes-size.md) is supported and must be set.
## Events ## Events
......
...@@ -124,8 +124,8 @@ The **ResourceColor** type is used to describe the color types of resources. ...@@ -124,8 +124,8 @@ The **ResourceColor** type is used to describe the color types of resources.
| Type | Description | | Type | Description |
| ---------------------------------------- | ------------------------------------------------- | | ---------------------------------------- | ------------------------------------------------- |
| [Color](ts-appendix-enums.md#color) | Color enums. | | [Color](ts-appendix-enums.md#color) | Color enums. |
| number | Color in hexadecimal notation. RGB is supported. | | number | Color in hexadecimal notation. RGB is supported. Example: **0xffffff** |
| string | Color in RGB or RGBA notation. | | string | Color in RGB or RGBA notation. Example: **'#ffffff', '#ff000000', 'rgb(255, 100, 255)', 'rgba(255, 100, 255, 0.5)'** |
| [Resource](#resource) | Color referenced from system or application resources.| | [Resource](#resource) | Color referenced from system or application resources.|
## LengthConstrain ## LengthConstrain
...@@ -207,7 +207,7 @@ The **ColorFilter** type is used to create a color filter with a 4 x 5 matrix. ...@@ -207,7 +207,7 @@ The **ColorFilter** type is used to create a color filter with a 4 x 5 matrix.
| Name | Type | Mandatory | Description | | Name | Type | Mandatory | Description |
| ----------- | -------- | ---- | ---------------------------------------- | | ----------- | -------- | ---- | ---------------------------------------- |
| constructor | number[] | Yes | Constructor for creating a color filter with a 4 x 5 matrix. The input parameter is [m*n], which is the matrix value in row m and column n. The matrix is row-first.| | constructor | number[] | Yes | Constructor for creating a color filter with a 4 x 5 matrix. The input parameter is [m*n], which is the matrix value in row m and column n. The value range is [0, 1]. The matrix is row-first.|
## CustomBuilder<sup>8+</sup> ## CustomBuilder<sup>8+</sup>
...@@ -216,5 +216,5 @@ The **CustomBuilder** type is used to define custom UI descriptions in component ...@@ -216,5 +216,5 @@ The **CustomBuilder** type is used to define custom UI descriptions in component
| Name | Type | Description | | Name | Type | Description |
| ------------- | ---------------------- | ---------------------------------------- | | ------------- | ---------------------- | ---------------------------------------- |
| CustomBuilder | () =&gt; any | Must be decorated by **@Builder**. For details, see [@Builder](../../quick-start/arkts-dynamic-ui-elememt-building.md#builder).| | CustomBuilder | () =&gt; any | Must be decorated by **@Builder**. For details, see [@Builder](../../quick-start/arkts-builder.md).|
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册