openharmony/interface_sdk-js
1
0
Fork 0
mirror of https://gitee.com/openharmony/interface_sdk-js synced 2024-11-27 09:22:53 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

update jsdoc

Browse Source 
Signed-off-by: fangyun <fangyun2@huawei.com>
This commit is contained in:
fangyun 2024-04-08 09:22:38 +08:00
parent 89dc3ee350
commit cfaf773b07
5 changed files with 34 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
api/@ohos.enterprise.deviceControl.d.ts vendored
View File

@ -120,6 +120,25 @@ declare namespace deviceControl {
* @since 11
*/
function lockScreen(admin: Want): void;
/**
* Allows the administrator to operate device.
* This function can be called by a super administrator.
*
* @permission ohos.permission.ENTERPRISE_OPERATE_DEVICE
* @param { Want } admin - admin indicates the administrator ability information.
* @param { string } operate - operate indicates the operation to be performed,
* the supported device operations include lockScreen, resetFactory, reboot and shutDown.
* @param { string } [addition] - addition indicates the specify additional parameters when performing the operation.
* @throws { BusinessError } 9200001 - the application is not an administrator of the device.
* @throws { BusinessError } 9200002 - the administrator application does not have permission to manage the device.
* @throws { BusinessError } 201 - the application does not have permission to call this function.
* @throws { BusinessError } 401 - invalid input parameter.
* @syscap SystemCapability.Customization.EnterpriseDeviceManager
* @stagemodelonly
* @since 12
*/
function operateDevice(admin: Want, operate: string, addition?: string): void;
}
export default deviceControl;

3
api/@ohos.enterprise.deviceInfo.d.ts vendored
View File

@ -149,7 +149,8 @@ declare namespace deviceInfo {
*
* @permission ohos.permission.ENTERPRISE_GET_DEVICE_INFO
* @param { Want } admin - admin indicates the administrator ability information.
* @param { string } label - label indicates the specific type of information.
* @param { string } label - label indicates the specific information that needs to be queried,
* the supported device information include deviceName, deviceSerial and simInfo.
* @returns { string } the specific information of device.
* @throws { BusinessError } 9200001 - the application is not an administrator of the device.
* @throws { BusinessError } 9200002 - the administrator application does not have permission to manage the device.

11
api/@ohos.enterprise.deviceSettings.d.ts vendored
View File

@ -362,8 +362,10 @@ declare namespace deviceSettings {
*
* @permission ohos.permission.ENTERPRISE_MANAGE_SETTINGS
* @param { Want } admin - admin indicates the administrator ability information.
* @param { string } item - the scene to execute power policy.
* @param { string } value - device power policy.
* @param { string } item - item indicates the device properties that need to be set, including screenOff, powerPolicy and dateTime.
* screenOff means the device screen off time, powerPolicy means the device power policy
* and dataTime means the device system time.
* @param { string } value - device settings policy.
* @throws { BusinessError } 9200001 - the application is not an administrator of the device.
* @throws { BusinessError } 9200002 - the administrator application does not have permission to manage the device.
* @throws { BusinessError } 201 - the application does not have permission to call this function.
@ -380,8 +382,9 @@ declare namespace deviceSettings {
*
* @permission ohos.permission.ENTERPRISE_MANAGE_SETTINGS
* @param { Want } admin - admin indicates the administrator ability information.
* @param { string } item - the scene to execute power policy.
* @returns { string } device power policy.
* @param { string } item - item indicates the device properties that need to be get, including screenOff and powerPolicy.
* screenOff means the device screen off time, powerPolicy means the device power policy.
* @returns { string } device settings policy.
* @throws { BusinessError } 9200001 - the application is not an administrator of the device.
* @throws { BusinessError } 9200002 - the administrator application does not have permission to manage the device.
* @throws { BusinessError } 201 - the application does not have permission to call this function.

6
api/@ohos.enterprise.restrictions.d.ts vendored
View File

@ -262,7 +262,8 @@ declare namespace restrictions {
*
* @permission ohos.permission.ENTERPRISE_MANAGE_RESTRICTIONS
* @param { Want } admin - admin indicates the administrator ability information.
* @param { string } feature - feature indicates the specific feature to be disallowed or allowed.
* @param { string } feature - feature indicates the specific feature to be disallowed or allowed,
* the supported device features include modifyDateTime, bluetooth, printer, hdc, microphone, fingerprint, usb and wifi.
* @param { boolean } disallow - true if disallow the specific feature of device, otherwise false.
* @throws { BusinessError } 9200001 - the application is not an administrator of the device.
* @throws { BusinessError } 9200002 - the administrator application does not have permission to manage the device.
@ -279,7 +280,8 @@ declare namespace restrictions {
*
* @permission ohos.permission.ENTERPRISE_MANAGE_RESTRICTIONS
* @param { Want } admin - admin indicates the administrator ability information.
* @param { string } feature - feature indicates the specific feature to be queried.
* @param { string } feature - feature indicates the specific feature to be queried,
* the supported device features include modifyDateTime, bluetooth, printer, hdc, microphone, fingerprint, usb and wifi.
* @returns { boolean } true if the specific feature of device is disallowed, otherwise false.
* @throws { BusinessError } 9200001 - the application is not an administrator of the device.
* @throws { BusinessError } 9200002 - the administrator application does not have permission to manage the device.

3
api/@ohos.enterprise.securityManager.d.ts vendored
View File

@ -124,7 +124,8 @@ declare namespace securityManager {
*
* @permission ohos.permission.ENTERPRISE_MANAGE_SECURITY
* @param { Want } admin - admin indicates the administrator ability information.
* @param { string } item - item indicates the specific type of security policy.
* @param { string } item - item indicates the specified security policy that needs to be obtained, including patch and encryption.
* patch means the device security patch tag, and encryption means the device encryption status.
* @returns { string } security policy of the specific type.
* @throws { BusinessError } 9200001 - the application is not an administrator of the device.
* @throws { BusinessError } 9200002 - the administrator application does not have permission to manage the device.