diff --git a/api/@ohos.driver.deviceManager.d.ts b/api/@ohos.driver.deviceManager.d.ts index d2f07bd2e7b01108cd1bf850b12d26a2da4d7268..5eb72de0c73e8e59f58f9567db3d5f4ff71537fd 100644 --- a/api/@ohos.driver.deviceManager.d.ts +++ b/api/@ohos.driver.deviceManager.d.ts @@ -26,7 +26,8 @@ import type rpc from './@ohos.rpc'; * * @namespace deviceManager * @syscap SystemCapability.Driver.ExternalDevice - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ declare namespace deviceManager { /** @@ -39,9 +40,24 @@ declare namespace deviceManager { * @throws { BusinessError } 22900001 - ExternalDeviceManager service exception or busType parameter error. * @syscap SystemCapability.Driver.ExternalDevice * @since 10 + * @arkts 1.1 */ function queryDevices(busType?: number): Array>; + /** + * Query the external device list. + * + * @permission ohos.permission.ACCESS_EXTENSIONAL_DEVICE_DRIVER + * @param { int } busType - The bus type of device to be queried. + * @returns { Array> } External device list. + * @throws { BusinessError } 201 - The permission check failed. + * @throws { BusinessError } 22900001 - ExternalDeviceManager service exception or busType parameter error. + * @syscap SystemCapability.Driver.ExternalDevice + * @since 20 + * @arkts 1.2 + */ + function queryDevices(busType?: int): Array>; + /** * Bind the device based on the device information returned by queryDevices(). * @@ -170,9 +186,27 @@ declare namespace deviceManager { * @syscap SystemCapability.Driver.ExternalDevice * @systemapi * @since 12 + * @arkts 1.1 */ function queryDeviceInfo(deviceId?: number): Array>; + /** + * Queries external device information. + * + * @permission ohos.permission.ACCESS_EXTENSIONAL_DEVICE_DRIVER + * @param { int } deviceId - ID of device to query. + * @returns { Array> } Device information obtained. + * @throws { BusinessError } 201 - The permission check failed. + * @throws { BusinessError } 202 - Permission denied. A non-system application cannot call a system API. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Incorrect parameter types. + * @throws { BusinessError } 26300001 - ExternalDeviceManager service exception. + * @syscap SystemCapability.Driver.ExternalDevice + * @systemapi + * @since 20 + * @arkts 1.2 + */ + function queryDeviceInfo(deviceId?: int): Array>; + /** * Queries driver information. * @@ -185,7 +219,8 @@ declare namespace deviceManager { * @throws { BusinessError } 26300001 - ExternalDeviceManager service exception. * @syscap SystemCapability.Driver.ExternalDevice * @systemapi - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ function queryDriverInfo(driverUid?: string): Array>; @@ -202,9 +237,27 @@ declare namespace deviceManager { * @throws { BusinessError } 26300002 - Service not allowed. * @syscap SystemCapability.Driver.ExternalDevice * @since 18 + * @arkts 1.1 */ function bindDriverWithDeviceId(deviceId: number, onDisconnect: AsyncCallback): Promise; + /** + * Bind the device based on the device information returned by queryDevices(). + * + * @permission ohos.permission.ACCESS_DDK_DRIVERS + * @param { int } deviceId - Device id on the device list returned by queryDevices(). + * @param { AsyncCallback } onDisconnect - Callback is invoked when device is disconnected after bind + * success. + * @returns { Promise } Indicates the bind result including device ID and remote object. + * @throws { BusinessError } 201 - The permission check failed. + * @throws { BusinessError } 26300001 - ExternalDeviceManager service exception. + * @throws { BusinessError } 26300002 - Service not allowed. + * @syscap SystemCapability.Driver.ExternalDevice + * @since 20 + * @arkts 1.2 + */ + function bindDriverWithDeviceId(deviceId: int, onDisconnect: AsyncCallback): Promise; + /** * Unbind the device based on the device information returned by queryDevices(). * @@ -216,22 +269,40 @@ declare namespace deviceManager { * @throws { BusinessError } 26300003 - There is no binding relationship. * @syscap SystemCapability.Driver.ExternalDevice * @since 18 + * @arkts 1.1 */ function unbindDriverWithDeviceId(deviceId: number): Promise; + /** + * Unbind the device based on the device information returned by queryDevices(). + * + * @permission ohos.permission.ACCESS_DDK_DRIVERS + * @param { int } deviceId - Device id on the device list returned by queryDevices(). + * @returns { Promise } - Indicates the unbind result invoked when unbind is finished. + * @throws { BusinessError } 201 - The permission check failed. + * @throws { BusinessError } 26300001 - ExternalDeviceManager service exception. + * @throws { BusinessError } 26300003 - There is no binding relationship. + * @syscap SystemCapability.Driver.ExternalDevice + * @since 20 + * @arkts 1.2 + */ + function unbindDriverWithDeviceId(deviceId: int): Promise; + /** * Enumerates the bus types. * * @enum { number } * @syscap SystemCapability.Driver.ExternalDevice - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ export enum BusType { /** * USB device type * * @syscap SystemCapability.Driver.ExternalDevice - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ USB = 1, } @@ -241,7 +312,8 @@ declare namespace deviceManager { * * @typedef Device * @syscap SystemCapability.Driver.ExternalDevice - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ interface Device { /** @@ -249,7 +321,8 @@ declare namespace deviceManager { * * @type { BusType } * @syscap SystemCapability.Driver.ExternalDevice - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ busType: BusType; @@ -259,15 +332,27 @@ declare namespace deviceManager { * @type { number } * @syscap SystemCapability.Driver.ExternalDevice * @since 10 + * @arkts 1.1 */ deviceId: number; + /** + * Device ID. + * + * @type { int } + * @syscap SystemCapability.Driver.ExternalDevice + * @since 20 + * @arkts 1.2 + */ + deviceId: int; + /** * Description of the device. * * @type { string } * @syscap SystemCapability.Driver.ExternalDevice - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ description: string; } @@ -278,7 +363,8 @@ declare namespace deviceManager { * @typedef USBDevice * @extends Device * @syscap SystemCapability.Driver.ExternalDevice - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ interface USBDevice extends Device { /** @@ -287,17 +373,39 @@ declare namespace deviceManager { * @type { number } * @syscap SystemCapability.Driver.ExternalDevice * @since 10 + * @arkts 1.1 */ vendorId: number; + /** + * Vendor ID. + * + * @type { int } + * @syscap SystemCapability.Driver.ExternalDevice + * @since 20 + * @arkts 1.2 + */ + vendorId: int; + /** * Product ID. * * @type { number } * @syscap SystemCapability.Driver.ExternalDevice * @since 10 + * @arkts 1.1 */ productId: number; + + /** + * Product ID. + * + * @type { int } + * @syscap SystemCapability.Driver.ExternalDevice + * @since 20 + * @arkts 1.2 + */ + productId: int; } /** @@ -305,7 +413,8 @@ declare namespace deviceManager { * * @typedef RemoteDeviceDriver * @syscap SystemCapability.Driver.ExternalDevice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ interface RemoteDeviceDriver { /** @@ -314,15 +423,27 @@ declare namespace deviceManager { * @type { number } * @syscap SystemCapability.Driver.ExternalDevice * @since 11 + * @arkts 1.1 */ deviceId: number; + /** + * Device ID. + * + * @type { int } + * @syscap SystemCapability.Driver.ExternalDevice + * @since 20 + * @arkts 1.2 + */ + deviceId: int; + /** * Remote driver object. * * @type { rpc.IRemoteObject } * @syscap SystemCapability.Driver.ExternalDevice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ remote: rpc.IRemoteObject; } @@ -333,7 +454,8 @@ declare namespace deviceManager { * @typedef USBInterfaceDesc * @syscap SystemCapability.Driver.ExternalDevice * @systemapi - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ interface USBInterfaceDesc { /** @@ -343,9 +465,21 @@ declare namespace deviceManager { * @syscap SystemCapability.Driver.ExternalDevice * @systemapi * @since 12 + * @arkts 1.1 */ bInterfaceNumber: number; + /** + * Interface number. + * + * @type { int } + * @syscap SystemCapability.Driver.ExternalDevice + * @systemapi + * @since 20 + * @arkts 1.2 + */ + bInterfaceNumber: int; + /** * Interface class code. * @@ -353,9 +487,21 @@ declare namespace deviceManager { * @syscap SystemCapability.Driver.ExternalDevice * @systemapi * @since 12 + * @arkts 1.1 */ bClass: number; + /** + * Interface class code. + * + * @type { int } + * @syscap SystemCapability.Driver.ExternalDevice + * @systemapi + * @since 20 + * @arkts 1.2 + */ + bClass: int; + /** * Interface subclass code. * @@ -363,9 +509,21 @@ declare namespace deviceManager { * @syscap SystemCapability.Driver.ExternalDevice * @systemapi * @since 12 + * @arkts 1.1 */ bSubClass: number; + /** + * Interface subclass code. + * + * @type { int } + * @syscap SystemCapability.Driver.ExternalDevice + * @systemapi + * @since 20 + * @arkts 1.2 + */ + bSubClass: int; + /** * Interface protocol. * @@ -373,8 +531,20 @@ declare namespace deviceManager { * @syscap SystemCapability.Driver.ExternalDevice * @systemapi * @since 12 + * @arkts 1.1 */ bProtocol: number; + + /** + * Interface protocol. + * + * @type { int } + * @syscap SystemCapability.Driver.ExternalDevice + * @systemapi + * @since 20 + * @arkts 1.2 + */ + bProtocol: int; } @@ -384,7 +554,8 @@ declare namespace deviceManager { * @typedef DeviceInfo * @syscap SystemCapability.Driver.ExternalDevice * @systemapi - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ interface DeviceInfo { /** @@ -394,16 +565,29 @@ declare namespace deviceManager { * @syscap SystemCapability.Driver.ExternalDevice * @systemapi * @since 12 + * @arkts 1.1 */ deviceId: number; + /** + * Device ID. + * + * @type { int } + * @syscap SystemCapability.Driver.ExternalDevice + * @systemapi + * @since 20 + * @arkts 1.2 + */ + deviceId: int; + /** * Whether the device has a matched driver. * * @type { boolean } * @syscap SystemCapability.Driver.ExternalDevice * @systemapi - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ isDriverMatched: boolean; @@ -413,7 +597,8 @@ declare namespace deviceManager { * @type { ?string } * @syscap SystemCapability.Driver.ExternalDevice * @systemapi - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ driverUid?: string; } @@ -425,7 +610,8 @@ declare namespace deviceManager { * @extends DeviceInfo * @syscap SystemCapability.Driver.ExternalDevice * @systemapi - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ interface USBDeviceInfo extends DeviceInfo { /** @@ -435,9 +621,21 @@ declare namespace deviceManager { * @syscap SystemCapability.Driver.ExternalDevice * @systemapi * @since 12 + * @arkts 1.1 */ vendorId: number; + /** + * Vendor ID. + * + * @type { int } + * @syscap SystemCapability.Driver.ExternalDevice + * @systemapi + * @since 20 + * @arkts 1.2 + */ + vendorId: int; + /** * Product ID. * @@ -445,16 +643,29 @@ declare namespace deviceManager { * @syscap SystemCapability.Driver.ExternalDevice * @systemapi * @since 12 + * @arkts 1.1 */ productId: number; + /** + * Product ID. + * + * @type { int } + * @syscap SystemCapability.Driver.ExternalDevice + * @systemapi + * @since 20 + * @arkts 1.2 + */ + productId: int; + /** * List of USB interface descriptors. * * @type { Array> } * @syscap SystemCapability.Driver.ExternalDevice * @systemapi - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ interfaceDescList: Array>; } @@ -465,7 +676,8 @@ declare namespace deviceManager { * @typedef DriverInfo * @syscap SystemCapability.Driver.ExternalDevice * @systemapi - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ interface DriverInfo { /** @@ -474,7 +686,8 @@ declare namespace deviceManager { * @type { BusType } * @syscap SystemCapability.Driver.ExternalDevice * @systemapi - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ busType: BusType; @@ -484,7 +697,8 @@ declare namespace deviceManager { * @type { string } * @syscap SystemCapability.Driver.ExternalDevice * @systemapi - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ driverUid: string; @@ -494,7 +708,8 @@ declare namespace deviceManager { * @type { string } * @syscap SystemCapability.Driver.ExternalDevice * @systemapi - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ driverName: string; @@ -504,7 +719,8 @@ declare namespace deviceManager { * @type { string } * @syscap SystemCapability.Driver.ExternalDevice * @systemapi - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ driverVersion: string; @@ -514,7 +730,8 @@ declare namespace deviceManager { * @type { string } * @syscap SystemCapability.Driver.ExternalDevice * @systemapi - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ driverSize: string; @@ -524,7 +741,8 @@ declare namespace deviceManager { * @type { string } * @syscap SystemCapability.Driver.ExternalDevice * @systemapi - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ description: string; } @@ -536,7 +754,8 @@ declare namespace deviceManager { * @extends DriverInfo * @syscap SystemCapability.Driver.ExternalDevice * @systemapi - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ interface USBDriverInfo extends DriverInfo { /** @@ -546,9 +765,21 @@ declare namespace deviceManager { * @syscap SystemCapability.Driver.ExternalDevice * @systemapi * @since 12 + * @arkts 1.1 */ productIdList: Array; + /** + * IDs of supported products. + * + * @type { Array } + * @syscap SystemCapability.Driver.ExternalDevice + * @systemapi + * @since 20 + * @arkts 1.2 + */ + productIdList: Array; + /** * IDs of supported vendors. * @@ -556,8 +787,20 @@ declare namespace deviceManager { * @syscap SystemCapability.Driver.ExternalDevice * @systemapi * @since 12 + * @arkts 1.1 */ vendorIdList: Array; + + /** + * IDs of supported vendors. + * + * @type { Array } + * @syscap SystemCapability.Driver.ExternalDevice + * @systemapi + * @since 20 + * @arkts 1.2 + */ + vendorIdList: Array; } }