From 5bc7b901220fe95bc3d25671bcfbcadf80a7f3eb Mon Sep 17 00:00:00 2001 From: "ester.zhou" Date: Wed, 17 May 2023 17:23:17 +0800 Subject: [PATCH] Update docs (18105) Signed-off-by: ester.zhou --- .../apis/js-apis-enterprise-adminManager.md | 72 +++++++++---------- .../js-apis-enterprise-dateTimeManager.md | 14 ++-- .../apis/js-apis-enterprise-deviceInfo.md | 34 ++++----- .../reference/apis/js-apis-plugincomponent.md | 20 +++--- .../ts-basic-components-plugincomponent.md | 17 ++++- .../reference/arkui-ts/ts-types.md | 8 +-- 6 files changed, 88 insertions(+), 77 deletions(-) diff --git a/en/application-dev/reference/apis/js-apis-enterprise-adminManager.md b/en/application-dev/reference/apis/js-apis-enterprise-adminManager.md index a29988585e..d6f1383c46 100644 --- a/en/application-dev/reference/apis/js-apis-enterprise-adminManager.md +++ b/en/application-dev/reference/apis/js-apis-enterprise-adminManager.md @@ -16,7 +16,7 @@ import adminManager from '@ohos.enterprise.adminManager'; enableAdmin(admin: Want, enterpriseInfo: EnterpriseInfo, type: AdminType, callback: AsyncCallback\): 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 @@ -29,9 +29,9 @@ Enables a device administrator application based on the specified bundle name an | Name | Type | Mandatory | Description | | -------------- | ----------------------------------- | ---- | ------------------ | | 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. | -| callback | AsyncCallback\ | Yes | Callback used to return the result.| +| callback | AsyncCallback\ | Yes | Callback used to return the result. If the operation is successful, **err** is **null**. Otherwise, **err** is an error object.| **Error codes** @@ -67,7 +67,7 @@ adminManager.enableAdmin(wantTemp, enterpriseInfo, adminManager.AdminType.ADMIN_ enableAdmin(admin: Want, enterpriseInfo: EnterpriseInfo, type: AdminType, userId: number, callback: AsyncCallback\): 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 @@ -83,7 +83,7 @@ Enables a device administrator application for the specified user based on the s | enterpriseInfo | [EnterpriseInfo](#enterpriseinfo) | Yes | Enterprise information of the device administrator application. | | 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.| -| callback | AsyncCallback\ | Yes | Callback used to return the result. | +| callback | AsyncCallback\ | Yes | Callback used to return the result. If the operation is successful, **err** is **null**. Otherwise, **err** is an error object. | **Error codes** @@ -119,7 +119,7 @@ adminManager.enableAdmin(wantTemp, enterpriseInfo, adminManager.AdminType.ADMIN_ enableAdmin(admin: Want, enterpriseInfo: EnterpriseInfo, type: AdminType, userId?: number): Promise\ -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 @@ -140,7 +140,7 @@ Enables a device administrator application based on the specified bundle name an | Type | Description | | ----------------- | ----------------- | -| Promise\ | Promise used to return the result.| +| Promise\ | Promise that returns no value. If the operation fails, an error object is thrown.| **Error codes** @@ -173,7 +173,7 @@ adminManager.enableAdmin(wantTemp, enterpriseInfo, adminManager.AdminType.ADMIN_ disableAdmin(admin: Want, callback: AsyncCallback\): 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 @@ -186,7 +186,7 @@ Disables a device common administrator application based on the specified bundle | Name | Type | Mandatory | Description | | -------- | ----------------------------------- | ---- | ------------------- | | admin | [Want](js-apis-app-ability-want.md) | Yes | Device common administrator application. | -| callback | AsyncCallback\ | Yes | Callback used to return the result.| +| callback | AsyncCallback\ | Yes | Callback used to return the result. If the operation is successful, **err** is **null**. Otherwise, **err** is an error object.| **Error codes** @@ -216,7 +216,7 @@ adminManager.disableAdmin(wantTemp, error => { disableAdmin(admin: Want, userId: number, callback: AsyncCallback\): 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 @@ -230,7 +230,7 @@ Disables a device common administrator application for the specified user based | -------- | ----------------------------------- | ---- | ---------------------------- | | 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.| -| callback | AsyncCallback\ | Yes | Callback used to return the result. | +| callback | AsyncCallback\ | Yes | Callback used to return the result. If the operation is successful, **err** is **null**. Otherwise, **err** is an error object. | **Error codes** @@ -260,7 +260,7 @@ adminManager.disableAdmin(wantTemp, 100, error => { disableAdmin(admin: Want, userId?: number): Promise\ -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 @@ -279,7 +279,7 @@ Disables a device common administrator application based on the specified bundle | Type | Description | | ----------------- | ----------------- | -| Promise\ | Promise used to return the result.| +| Promise\ | Promise that returns no value. If the operation fails, an error object is thrown.| **Error codes** @@ -318,7 +318,7 @@ Disables a device super administrator application based on the specified bundle | Name | Type | Mandatory | Description | | ---------- | ----------------------- | ---- | ------------------- | | bundleName | String | Yes | Bundle name of the device super administrator application. | -| callback | AsyncCallback\ | Yes | Callback used to return the result.| +| callback | AsyncCallback\ | Yes | Callback used to return the result. If the operation is successful, **err** is **null**. Otherwise, **err** is an error object.| **Error codes** @@ -363,7 +363,7 @@ Disables a device super administrator application based on the specified bundle | Type | Description | | ----------------- | ----------------- | -| Promise\ | Promise used to return the result.| +| Promise\ | Promise that returns no value. If the operation fails, an error object is thrown.| **Error codes** @@ -386,7 +386,7 @@ adminManager.disableSuperAdmin(bundleName).catch(error => { isAdminEnabled(admin: Want, callback: AsyncCallback\): 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 @@ -396,8 +396,8 @@ Checks whether a device administrator application is enabled based on the specif | Name | Type | Mandatory | Description | | -------- | ----------------------------------- | ---- | -------------------- | -| admin | [Want](js-apis-app-ability-want.md) | Yes | Device administrator application. | -| callback | AsyncCallback\ | Yes | Callback used to return the result.| +| admin | [Want](js-apis-app-ability-want.md) | Yes | Device administrator application. | +| callback | AsyncCallback\ | 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** @@ -419,7 +419,7 @@ adminManager.isAdminEnabled(wantTemp, (error, result) => { isAdminEnabled(admin: Want, userId: number, callback: AsyncCallback\): 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 @@ -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. | | 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\ | Yes | Callback used to return the result. | +| callback | AsyncCallback\ | 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** @@ -453,7 +453,7 @@ adminManager.isAdminEnabled(wantTemp, 100, (error, result) => { isAdminEnabled(admin: Want, userId?: number): Promise\ -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 @@ -470,7 +470,7 @@ Checks whether a device administrator application is enabled based on the specif | Type | Description | | ----------------- | ------------------- | -| Promise\ | Promise used to return the result.| +| Promise\ | 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** @@ -501,7 +501,7 @@ Checks whether a device super administrator application is enabled based on the | Name | Type | Mandatory | Description | | ---------- | ----------------------- | ---- | -------------------- | | bundleName | String | Yes | Device administrator application. | -| callback | AsyncCallback\ | Yes | Callback used to return the result.| +| callback | AsyncCallback\ | 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** @@ -536,7 +536,7 @@ Checks whether a device super administrator application is enabled based on the | ID | Error Message | | ----------------- | ------------------- | -| Promise\ | Promise used to return the result.| +| Promise\ | 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** @@ -567,7 +567,7 @@ Sets the enterprise information of a device administrator application. This API | -------------- | ----------------------------------- | ---- | ---------------------- | | admin | [Want](js-apis-app-ability-want.md) | Yes | Device administrator application. | | enterpriseInfo | [EnterpriseInfo](#enterpriseinfo) | Yes | Enterprise information of the device administrator application. | -| callback | AsyncCallback\; | Yes | Callback used to return the result.| +| callback | AsyncCallback\; | Yes | Callback used to return the result. If the operation is successful, **err** is **null**. Otherwise, **err** is an error object.| **Error codes** @@ -620,7 +620,7 @@ Sets the enterprise information of a device administrator application. This API | Type | Description | | ----------------- | --------------------- | -| Promise\ | Promise used to return the result.| +| Promise\ | Promise that returns no value. If the operation fails, an error object is thrown.| **Error codes** @@ -661,7 +661,7 @@ Obtains the enterprise information of a device administrator application. This A | Name | Type | Mandatory | Description | | -------- | ---------------------------------------- | ---- | ------------------------ | | admin | [Want](js-apis-app-ability-want.md) | Yes | Device administrator application. | -| callback | AsyncCallback<[EnterpriseInfo](#enterpriseinfo)> | Yes | Callback used to return the enterprise information of the device administrator application.| +| callback | AsyncCallback<[EnterpriseInfo](#enterpriseinfo)> | 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** @@ -708,7 +708,7 @@ Obtains the enterprise information of a device administrator application. This A | Type | Description | | ---------------------------------------- | ------------------------- | -| Promise<[EnterpriseInfo](#enterpriseinfo)> | Promise used to return the enterprise information of the device administrator application.| +| Promise<[EnterpriseInfo](#enterpriseinfo)> | Callback used to return the enterprise information of the device administrator application.| **Error codes** @@ -737,7 +737,7 @@ adminManager.getEnterpriseInfo(wantTemp).then((result) => { subscribeManagedEvent(admin: Want, managedEvents: Array\, callback: AsyncCallback\): 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 @@ -751,7 +751,7 @@ Subscribes to system management events. This API uses an asynchronous callback t | ----- | ----------------------------------- | ---- | ------- | | admin | [Want](js-apis-app-ability-want.md) | Yes | Device administrator application.| | managedEvents | Array\<[ManagedEvent](#managedevent)> | Yes| Array of events to subscribe to.| -| callback | AsyncCallback\ | Yes| Callback used to return the result. If the subscription is successful, **err** is **null**. Otherwise, **err** is an error object.| +| callback | AsyncCallback\ | Yes| Callback used to return the result. If the operation is successful, **err** is **null**. Otherwise, **err** is an error object.| **Error codes** @@ -781,7 +781,7 @@ adminManager.subscribeManagedEvent(wantTemp, events, (error) => { subscribeManagedEvent(admin: Want, managedEvents: Array\): Promise\ -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 @@ -800,7 +800,7 @@ Subscribes to system management events. This API uses a promise to return the re | Type | Description | | ----- | ----------------------------------- | -| Promise\ | Promise that returns no value.| +| Promise\ | Promise that returns no value. If the operation fails, an error object is thrown.| **Error codes** @@ -829,7 +829,7 @@ adminManager.subscribeManagedEvent(wantTemp, events).then(() => { unsubscribeManagedEvent(admin: Want, managedEvents: Array\, callback: AsyncCallback\): 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 @@ -843,7 +843,7 @@ Unsubscribes from system management events. This API uses an asynchronous callba | ----- | ----------------------------------- | ---- | ------- | | admin | [Want](js-apis-app-ability-want.md) | Yes | Device administrator application.| | managedEvents | Array\<[ManagedEvent](#managedevent)> | Yes| Array of events to unsubscribe from.| -| callback | AsyncCallback\ | Yes| Callback used to return the result. If the unsubscription is successful, **err** is **null**. Otherwise, **err** is an error object.| +| callback | AsyncCallback\ | Yes| Callback used to return the result. If the operation is successful, **err** is **null**. Otherwise, **err** is an error object.| **Error codes** @@ -873,7 +873,7 @@ adminManager.unsubscribeManagedEvent(wantTemp, events, (error) => { unsubscribeManagedEvent(admin: Want, managedEvents: Array\): Promise\ -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 @@ -892,7 +892,7 @@ Unsubscribes from system management events. This API uses an asynchronous callba | Type | Description | | ----- | ----------------------------------- | -| Promise\ | Promise that returns no value.| +| Promise\ | Promise that returns no value. If the operation fails, an error object is thrown.| **Error codes** diff --git a/en/application-dev/reference/apis/js-apis-enterprise-dateTimeManager.md b/en/application-dev/reference/apis/js-apis-enterprise-dateTimeManager.md index 03ce0c6ac2..261fbffaee 100644 --- a/en/application-dev/reference/apis/js-apis-enterprise-dateTimeManager.md +++ b/en/application-dev/reference/apis/js-apis-enterprise-dateTimeManager.md @@ -16,7 +16,7 @@ import dateTimeManager from '@ohos.enterprise.dateTimeManager' setDateTime(admin: Want, time: number, callback: AsyncCallback\): 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 @@ -59,7 +59,7 @@ dateTimeManager.setDateTime(wantTemp, 1526003846000, (error) => { setDateTime(admin: Want, time: number): Promise\ -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 @@ -106,7 +106,7 @@ dateTimeManager.setDateTime(wantTemp, 1526003846000).then(() => { disallowModifyDateTime(admin: Want, disallow: boolean, callback: AsyncCallback\): void -Disables modification of the system time. This API uses an asynchronous callback to return the result. +Configures a device administrator application to disable modification of the system time. This API uses an asynchronous callback to return the result. **Required permissions**: ohos.permission.ENTERPRISE_SET_DATETIME @@ -149,7 +149,7 @@ dateTimeManager.disallowModifyDateTime(wantTemp, true, (error) => { disallowModifyDateTime(admin: Want, disallow: boolean): Promise\ -Disables modification of the system time. This API uses a promise to return the result. +Configures a device administrator application to disable modification of the system time. This API uses a promise to return the result. **Required permissions**: ohos.permission.ENTERPRISE_SET_DATETIME @@ -196,7 +196,7 @@ dateTimeManager.disallowModifyDateTime(wantTemp, true).then(() => { isModifyDateTimeDisallowed(admin: Want, callback: AsyncCallback\): void -Checks whether modification of the system time is disabled. This API uses an asynchronous callback to return the result. +Configures a device administrator application to check whether modification of the system time is disabled. This API uses an asynchronous callback to return the result. **Required permissions**: ohos.permission.ENTERPRISE_SET_DATETIME @@ -238,7 +238,7 @@ dateTimeManager.isModifyDateTimeDisallowed(wantTemp, (error) => { isModifyDateTimeDisallowed(admin: Want): Promise\ -Checks whether modification of the system time is disabled. This API uses a promise to return the result. +Configures a device administrator application to check whether modification of the system time is disabled. This API uses a promise to return the result. **Required permissions**: ohos.permission.ENTERPRISE_SET_DATETIME @@ -256,7 +256,7 @@ Checks whether modification of the system time is disabled. This API uses a prom | Type | Description | | ----- | ----------------------------------- | -| Promise\ | Promise Promise used to return the result. The value **true** means that modification of the system time is disabled, and **false** means the opposite.| +| Promise\ | Promise used to return the result. The value **true** means that modification of the system time is disabled, and **false** means the opposite.| **Error codes** diff --git a/en/application-dev/reference/apis/js-apis-enterprise-deviceInfo.md b/en/application-dev/reference/apis/js-apis-enterprise-deviceInfo.md index 46b82f586b..0a167a411d 100644 --- a/en/application-dev/reference/apis/js-apis-enterprise-deviceInfo.md +++ b/en/application-dev/reference/apis/js-apis-enterprise-deviceInfo.md @@ -16,7 +16,7 @@ import deviceInfo from '@ohos.enterprise.deviceInfo'; getDeviceSerial(admin: Want, callback: AsyncCallback<string>): void -Obtains the device serial number. This API uses an asynchronous callback to return the result. +Configures a device administrator application to obtain the device serial number. This API uses an asynchronous callback to return the result. **Required permissions**: ohos.permission.ENTERPRISE_GET_DEVICE_INFO @@ -29,13 +29,13 @@ Obtains the device serial number. This API uses an asynchronous callback to retu | Name | Type | Mandatory | Description | | -------- | ---------------------------------------- | ---- | ------------------------------- | | admin | [Want](js-apis-app-ability-want.md) | Yes | Device administrator application. | -| callback | AsyncCallback<string> | Yes | Callback used to return the device serial number. | +| callback | AsyncCallback<string> | Yes | Callback used to return the result.
If the operation is successful, **err** is **null** and **data** is the device serial number obtained. If the operation fails, **err** is an error object. | **Error codes** For details about the error codes, see [Enterprise Device Management Error Codes](../errorcodes/errorcode-enterpriseDeviceManager.md). -| ID| Error Message | +| ID| Error Message | | ------- | ---------------------------------------------------------------------------- | | 9200001 | the application is not an administrator of the device. | | 9200002 | the administrator application does not have permission to manage the device. | @@ -60,7 +60,7 @@ deviceInfo.getDeviceSerial(wantTemp, (error, result) => { getDeviceSerial(admin: Want): Promise<string> -Obtains the device serial number. This API uses a promise to return the result. +Configures a device administrator application to obtain the device serial number. This API uses a promise to return the result. **Required permissions**: ohos.permission.ENTERPRISE_GET_DEVICE_INFO @@ -84,7 +84,7 @@ Obtains the device serial number. This API uses a promise to return the result. For details about the error codes, see [Enterprise Device Management Error Codes](../errorcodes/errorcode-enterpriseDeviceManager.md). -| ID| Error Message | +| ID| Error Message | | ------- | ---------------------------------------------------------------------------- | | 9200001 | the application is not an administrator of the device. | | 9200002 | the administrator application does not have permission to manage the device. | @@ -107,7 +107,7 @@ deviceInfo.getDeviceSerial(wantTemp).then((result) => { getDisplayVersion(admin: Want, callback: AsyncCallback<string>): void; -Obtains the device version number. This API uses an asynchronous callback to return the result. +Configures a device administrator application to obtain the device version number. This API uses an asynchronous callback to return the result. **Required permissions**: ohos.permission.ENTERPRISE_GET_DEVICE_INFO @@ -120,13 +120,13 @@ Obtains the device version number. This API uses an asynchronous callback to ret | Name | Type | Mandatory | Description | | -------- | ---------------------------------------- | ---- | ------------------------------- | | admin | [Want](js-apis-app-ability-want.md) | Yes | Device administrator application. | -| callback | AsyncCallback<string> | Yes | Callback used to return the device version number. | +| callback | AsyncCallback<string> | Yes | Callback used to return the result.
If the operation is successful, **err** is **null** and **data** is the device version number obtained. If the operation fails, **err** is an error object. | **Error codes** For details about the error codes, see [Enterprise Device Management Error Codes](../errorcodes/errorcode-enterpriseDeviceManager.md). -| ID| Error Message | +| ID| Error Message | | ------- | ---------------------------------------------------------------------------- | | 9200001 | the application is not an administrator of the device. | | 9200002 | the administrator application does not have permission to manage the device. | @@ -151,7 +151,7 @@ deviceInfo.getDisplayVersion(wantTemp, (error, result) => { getDisplayVersion(admin: Want): Promise<string> -Obtains the device version number. This API uses a promise to return the result. +Configures a device administrator application to obtain the device version number. This API uses a promise to return the result. **Required permissions**: ohos.permission.ENTERPRISE_GET_DEVICE_INFO @@ -169,13 +169,13 @@ Obtains the device version number. This API uses a promise to return the result. | Type | Description | | --------------------- | ------------------------- | -| Promise<string> | Promise used to return the device version number. | +| Promise<string> | Promise used to return the device version number.| **Error codes** For details about the error codes, see [Enterprise Device Management Error Codes](../errorcodes/errorcode-enterpriseDeviceManager.md). -| ID| Error Message | +| ID| Error Message | | ------- | ---------------------------------------------------------------------------- | | 9200001 | the application is not an administrator of the device. | | 9200002 | the administrator application does not have permission to manage the device. | @@ -198,7 +198,7 @@ deviceInfo.getDisplayVersion(wantTemp).then((result) => { getDeviceName(admin: Want, callback: AsyncCallback<string>): void -Obtains the device name. This API uses an asynchronous callback to return the result. +Configures a device administrator application to obtain the device name. This API uses an asynchronous callback to return the result. **Required permissions**: ohos.permission.ENTERPRISE_GET_DEVICE_INFO @@ -211,13 +211,13 @@ Obtains the device name. This API uses an asynchronous callback to return the re | Name | Type | Mandatory | Description | | -------- | ---------------------------------------- | ---- | ------------------------------- | | admin | [Want](js-apis-app-ability-want.md) | Yes | Device administrator application. | -| callback | AsyncCallback<string> | Yes | Callback used to return the device name. | +| callback | AsyncCallback<string> | Yes | Callback used to return the result.
If the operation is successful, **err** is **null** and **data** is the device name obtained. If the operation fails, **err** is an error object. | **Error codes** For details about the error codes, see [Enterprise Device Management Error Codes](../errorcodes/errorcode-enterpriseDeviceManager.md). -| ID| Error Message | +| ID| Error Message | | ------- | ---------------------------------------------------------------------------- | | 9200001 | the application is not an administrator of the device. | | 9200002 | the administrator application does not have permission to manage the device. | @@ -242,7 +242,7 @@ deviceInfo.getDeviceName(wantTemp, (error, result) => { getDeviceName(admin: Want): Promise<string> -Obtains the device name. This API uses a promise to return the result. +Configures a device administrator application to obtain the device name. This API uses a promise to return the result. **Required permissions**: ohos.permission.ENTERPRISE_GET_DEVICE_INFO @@ -260,13 +260,13 @@ Obtains the device name. This API uses a promise to return the result. | Type | Description | | --------------------- | ------------------------- | -| Promise<string> | Promise used to return the device name. | +| Promise<string> | Promise used to return the device name.| **Error codes** For details about the error codes, see [Enterprise Device Management Error Codes](../errorcodes/errorcode-enterpriseDeviceManager.md). -| ID| Error Message | +| ID| Error Message | | ------- | ---------------------------------------------------------------------------- | | 9200001 | the application is not an administrator of the device. | | 9200002 | the administrator application does not have permission to manage the device. | diff --git a/en/application-dev/reference/apis/js-apis-plugincomponent.md b/en/application-dev/reference/apis/js-apis-plugincomponent.md index 740fd72e50..7becd3c7ee 100644 --- a/en/application-dev/reference/apis/js-apis-plugincomponent.md +++ b/en/application-dev/reference/apis/js-apis-plugincomponent.md @@ -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. | | name | string | Yes | Component name. | -| data | [KVObject](#kvobject) | No | Component data value. | -| extraData | [KVObject](#kvobject) | No | Additional data value. | +| data | [KVObject](#kvobject) | Yes | Component 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.| ### PushParameterForStage @@ -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. | | target | [Want](js-apis-application-want.md) | Yes | Ability information of the component user. | | name | string | Yes | Component name. | -| data | [KVObject](#kvobject) | No | Component data value. | -| extraData | [KVObject](#kvobject) | No | Additional data value. | +| data | [KVObject](#kvobject) | Yes | Component 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.| ### RequestParameters @@ -117,11 +117,11 @@ Provides the result returned after the **PluginManager.Request** API is called. **System capability**: SystemCapability.ArkUI.ArkUI.Full -| Name | Type | Mandatory| Description | -| ----------------- | ---------------------------------------------------- | ---- | ---------- | -| componentTemplate | [PluginComponentTemplate](#plugincomponenttemplate)] | Yes | Component template.| -| data | [KVObject](#kvobject) | Yes | Component data.| -| extraData | [KVObject](#kvobject) | Yes | Additional data.| +| Name | Type | Mandatory| Description | +| ----------------- | --------------------------------------------------- | ---- | ---------- | +| componentTemplate | [PluginComponentTemplate](#plugincomponenttemplate) | Yes | Component template.| +| data | [KVObject](#kvobject) | Yes | Component data.| +| extraData | [KVObject](#kvobject) | Yes | Additional data.| ### RequestEventResult @@ -175,7 +175,7 @@ Registers the listener for the request event. | Name | Type | Mandatory| Description | | --------- | ----------------------------------- | ---- | --------------------------- | | 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. | **Example** diff --git a/en/application-dev/reference/arkui-ts/ts-basic-components-plugincomponent.md b/en/application-dev/reference/arkui-ts/ts-basic-components-plugincomponent.md index e7f8efe820..1119b6bc2d 100644 --- a/en/application-dev/reference/arkui-ts/ts-basic-components-plugincomponent.md +++ b/en/application-dev/reference/arkui-ts/ts-basic-components-plugincomponent.md @@ -5,7 +5,7 @@ The **\** allows the UI provided by an external application to > **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 @@ -30,10 +30,21 @@ Creates a **PluginComponent** to display the UI provided by an external applicat | ---------- | ------ | --------------------------- | | source | string | Component template name. | | bundleName | string | Bundle name of the provider ability.| - ## 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. In the multi-HAP scenario, a HAP file is identified based on its relative path and name. + + Example: **{source: 'ets/pages/plugin.js&plugin', 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 diff --git a/en/application-dev/reference/arkui-ts/ts-types.md b/en/application-dev/reference/arkui-ts/ts-types.md index fac677383a..7638ad39fb 100644 --- a/en/application-dev/reference/arkui-ts/ts-types.md +++ b/en/application-dev/reference/arkui-ts/ts-types.md @@ -124,8 +124,8 @@ The **ResourceColor** type is used to describe the color types of resources. | Type | Description | | ---------------------------------------- | ------------------------------------------------- | | [Color](ts-appendix-enums.md#color) | Color enums. | -| number | Color in hexadecimal notation. RGB is supported. | -| string | Color in RGB or ARGB notation. | +| number | Color in hexadecimal notation. RGB is supported. Example: **0xffffff** | +| string | Color in RGB or ARGB notation. Example: **'#ffffff', '#ff000000', 'rgb(255, 100, 255)', 'rgba(255, 100, 255, 0.5)'** | | [Resource](#resource) | Color referenced from system or application resources.| ## ColoringStrategy @@ -215,7 +215,7 @@ The **ColorFilter** type is used to create a color filter with a 4 x 5 matrix. | 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.| ## CustomBuilder8+ @@ -224,7 +224,7 @@ The **CustomBuilder** type is used to define custom UI descriptions in component | Name | Type | Description | | ------------- | ---------------------- | ---------------------------------------- | -| CustomBuilder | () => any | Must be decorated by **@Builder**. For details, see [@Builder](../../quick-start/arkts-dynamic-ui-elememt-building.md#builder).| +| CustomBuilder | () => any | Must be decorated by **@Builder**. For details, see [@Builder](../../quick-start/arkts-builder.md).| ## PixelStretchEffectOptions10+ -- GitLab