openharmony/interface_sdk-js
1
0
Fork 0
mirror of https://gitee.com/openharmony/interface_sdk-js synced 2024-11-23 15:20:17 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity
6904f63ce5
interface_sdk-js/api/@ohos.bluetooth.baseProfile.d.ts
quguiren 525dcb35f1 add bluetooth.baseProfile @crossplatform 
Signed-off-by: quguiren <quguiren@huawei.com>
2024-09-05 15:31:41 +08:00

457 lines
17 KiB
TypeScript
Raw Blame History

/*
* Copyright (c) 2023-2024 Huawei Device Co., Ltd.
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/**
* @file
* @kit ConnectivityKit
*/
import type { AsyncCallback, Callback } from './@ohos.base';
import type constant from './@ohos.bluetooth.constant';
/**
* Provides basic profile methods.
*
* @namespace baseProfile
* @syscap SystemCapability.Communication.Bluetooth.Core
* @since 10
*/
/**
* Provides basic profile methods.
*
* @namespace baseProfile
* @syscap SystemCapability.Communication.Bluetooth.Core
* @crossplatform
* @since 13
*/
declare namespace baseProfile {
/**
* Indicate the profile connection state.
*
* @typedef { constant.ProfileConnectionState } ProfileConnectionState
* @syscap SystemCapability.Communication.Bluetooth.Core
* @since 10
*/
/**
* Indicate the profile connection state.
*
* @typedef { constant.ProfileConnectionState } ProfileConnectionState
* @syscap SystemCapability.Communication.Bluetooth.Core
* @crossplatform
* @since 13
*/
type ProfileConnectionState = constant.ProfileConnectionState;
/**
* Enum for connection strategy of the profile
*
* @enum { number }
* @syscap SystemCapability.Communication.Bluetooth.Core
* @systemapi
* @since 10
*/
export enum ConnectionStrategy {
/**
* The value of connection strategy unsupported.
*
* @syscap SystemCapability.Communication.Bluetooth.Core
* @systemapi
* @since 10
*/
CONNECTION_STRATEGY_UNSUPPORTED = 0,
/**
* The value of connection strategy allowed.
*
* @syscap SystemCapability.Communication.Bluetooth.Core
* @systemapi
* @since 10
*/
CONNECTION_STRATEGY_ALLOWED = 1,
/**
* The value of connection strategy forbidden.
*
* @syscap SystemCapability.Communication.Bluetooth.Core
* @systemapi
* @since 10
*/
CONNECTION_STRATEGY_FORBIDDEN = 2
}
/**
* Enum for cause of disconnect.
*
* @enum { number }
* @syscap SystemCapability.Communication.Bluetooth.Core
* @since 12
*/
/**
* Enum for cause of disconnect.
*
* @enum { number }
* @syscap SystemCapability.Communication.Bluetooth.Core
* @crossplatform
* @since 13
*/
enum DisconnectCause {
/**
* User disconnect device.
*
* @syscap SystemCapability.Communication.Bluetooth.Core
* @since 12
*/
/**
* User disconnect device.
*
* @syscap SystemCapability.Communication.Bluetooth.Core
* @crossplatform
* @since 13
*/
USER_DISCONNECT = 0,
/**
* The connection needs to be initiated from the keyboard side.
*
* @syscap SystemCapability.Communication.Bluetooth.Core
* @since 12
*/
CONNECT_FROM_KEYBOARD = 1,
/**
* The connection needs to be initiated from the mouse side.
*
* @syscap SystemCapability.Communication.Bluetooth.Core
* @since 12
*/
CONNECT_FROM_MOUSE = 2,
/**
* The connection needs to be initiated from the car side.
*
* @syscap SystemCapability.Communication.Bluetooth.Core
* @since 12
*/
CONNECT_FROM_CAR = 3,
/**
* Too many devices are currently connected.
*
* @syscap SystemCapability.Communication.Bluetooth.Core
* @since 12
*/
TOO_MANY_CONNECTED_DEVICES = 4,
/**
* Connection failed due to an internal error.
*
* @syscap SystemCapability.Communication.Bluetooth.Core
* @since 12
*/
CONNECT_FAIL_INTERNAL = 5
}
/**
* Profile state change parameters.
*
* @typedef StateChangeParam
* @syscap SystemCapability.Communication.Bluetooth.Core
* @since 10
*/
/**
* Profile state change parameters.
*
* @typedef StateChangeParam
* @syscap SystemCapability.Communication.Bluetooth.Core
* @crossplatform
* @since 13
*/
export interface StateChangeParam {
/**
* The address of device
*
* @type { string }
* @syscap SystemCapability.Communication.Bluetooth.Core
* @since 10
*/
/**
* The address of device
*
* @type { string }
* @syscap SystemCapability.Communication.Bluetooth.Core
* @crossplatform
* @since 13
*/
deviceId: string;
/**
* Profile state value
*
* @type { ProfileConnectionState }
* @syscap SystemCapability.Communication.Bluetooth.Core
* @since 10
*/
/**
* Profile state value
*
* @type { ProfileConnectionState }
* @syscap SystemCapability.Communication.Bluetooth.Core
* @crossplatform
* @since 13
*/
state: ProfileConnectionState;
/**
* Cause of disconnect
*
* @type { DisconnectCause }
* @syscap SystemCapability.Communication.Bluetooth.Core
* @since 12
*/
/**
* Cause of disconnect
*
* @type { DisconnectCause }
* @syscap SystemCapability.Communication.Bluetooth.Core
* @crossplatform
* @since 13
*/
cause: DisconnectCause;
}
/**
* Base interface of profile.
*
* @typedef BaseProfile
* @syscap SystemCapability.Communication.Bluetooth.Core
* @since 10
*/
/**
* Base interface of profile.
*
* @typedef BaseProfile
* @syscap SystemCapability.Communication.Bluetooth.Core
* @crossplatform
* @since 13
*/
export interface BaseProfile {
/**
* Set connection strategy of this profile.
*
* @permission ohos.permission.ACCESS_BLUETOOTH and ohos.permission.MANAGE_BLUETOOTH
* @param { string } deviceId - Indicates device ID. For example, "11:22:33:AA:BB:FF".
* @param { ConnectionStrategy } strategy - the connection strategy of this profile.
* @returns { Promise<void> } Returns the promise object.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 202 - Non-system applications are not allowed to use system APIs.
* @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified.
* <br>2. Incorrect parameter types. 3. Parameter verification failed.
* @throws { BusinessError } 801 - Capability not supported.
* @throws { BusinessError } 2900001 - Service stopped.
* @throws { BusinessError } 2900003 - Bluetooth disabled.
* @throws { BusinessError } 2900004 - Profile not supported.
* @throws { BusinessError } 2900099 - Operation failed.
* @syscap SystemCapability.Communication.Bluetooth.Core
* @systemapi
* @since 10
*/
setConnectionStrategy(deviceId: string, strategy: ConnectionStrategy): Promise<void>;
/**
* Set connection strategy of this profile.
*
* @permission ohos.permission.ACCESS_BLUETOOTH and ohos.permission.MANAGE_BLUETOOTH
* @param { string } deviceId - Indicates device ID. For example, "11:22:33:AA:BB:FF".
* @param { ConnectionStrategy } strategy - the connection strategy of this profile.
* @param { AsyncCallback<void> } callback - the callback of setConnectionStrategy.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 202 - Non-system applications are not allowed to use system APIs.
* @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified.
* <br>2. Incorrect parameter types. 3. Parameter verification failed.
* @throws { BusinessError } 801 - Capability not supported.
* @throws { BusinessError } 2900001 - Service stopped.
* @throws { BusinessError } 2900003 - Bluetooth disabled.
* @throws { BusinessError } 2900004 - Profile not supported.
* @throws { BusinessError } 2900099 - Operation failed.
* @syscap SystemCapability.Communication.Bluetooth.Core
* @systemapi
* @since 10
*/
setConnectionStrategy(deviceId: string, strategy: ConnectionStrategy, callback: AsyncCallback<void>): void;
/**
* Get connection strategy of this profile.
*
* @permission ohos.permission.ACCESS_BLUETOOTH and ohos.permission.MANAGE_BLUETOOTH
* @param { string } deviceId - Indicates device ID. For example, "11:22:33:AA:BB:FF".
* @param { AsyncCallback<ConnectionStrategy> } callback - the callback of getConnectionStrategy.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 202 - Non-system applications are not allowed to use system APIs.
* @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified.
* <br>2. Incorrect parameter types. 3. Parameter verification failed.
* @throws { BusinessError } 801 - Capability not supported.
* @throws { BusinessError } 2900001 - Service stopped.
* @throws { BusinessError } 2900003 - Bluetooth disabled.
* @throws { BusinessError } 2900004 - Profile not supported.
* @throws { BusinessError } 2900099 - Operation failed.
* @syscap SystemCapability.Communication.Bluetooth.Core
* @systemapi
* @since 10
*/
getConnectionStrategy(deviceId: string, callback: AsyncCallback<ConnectionStrategy>): void;
/**
* Get connection strategy of this profile.
*
* @permission ohos.permission.ACCESS_BLUETOOTH and ohos.permission.MANAGE_BLUETOOTH
* @param { string } deviceId - Indicates device ID. For example, "11:22:33:AA:BB:FF".
* @returns { Promise<ConnectionStrategy> } Returns the promise object.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 202 - Non-system applications are not allowed to use system APIs.
* @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified.
* <br>2. Incorrect parameter types. 3. Parameter verification failed.
* @throws { BusinessError } 801 - Capability not supported.
* @throws { BusinessError } 2900001 - Service stopped.
* @throws { BusinessError } 2900003 - Bluetooth disabled.
* @throws { BusinessError } 2900004 - Profile not supported.
* @throws { BusinessError } 2900099 - Operation failed.
* @syscap SystemCapability.Communication.Bluetooth.Core
* @systemapi
* @since 10
*/
getConnectionStrategy(deviceId: string): Promise<ConnectionStrategy>;
/**
* Obtains the connected devices list of profile.
*
* @permission ohos.permission.ACCESS_BLUETOOTH
* @returns { Array<string> } Returns the address of connected devices list.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 801 - Capability not supported.
* @throws { BusinessError } 2900001 - Service stopped.
* @throws { BusinessError } 2900003 - Bluetooth disabled.
* @throws { BusinessError } 2900004 - Profile not supported.
* @throws { BusinessError } 2900099 - Operation failed.
* @syscap SystemCapability.Communication.Bluetooth.Core
* @since 10
*/
/**
* Obtains the connected devices list of profile.
*
* @permission ohos.permission.ACCESS_BLUETOOTH
* @returns { Array<string> } Returns the address of connected devices list.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 801 - Capability not supported.
* @throws { BusinessError } 2900001 - Service stopped.
* @throws { BusinessError } 2900003 - Bluetooth disabled.
* @throws { BusinessError } 2900004 - Profile not supported.
* @throws { BusinessError } 2900099 - Operation failed.
* @syscap SystemCapability.Communication.Bluetooth.Core
* @crossplatform
* @since 13
*/
getConnectedDevices(): Array<string>;
/**
* Obtains the profile connection state.
*
* @permission ohos.permission.ACCESS_BLUETOOTH
* @param { string } deviceId - Indicates device ID. For example, "11:22:33:AA:BB:FF".
* @returns { ProfileConnectionState } Returns the connection state.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified.
* <br>2. Incorrect parameter types. 3. Parameter verification failed.
* @throws { BusinessError } 801 - Capability not supported.
* @throws { BusinessError } 2900001 - Service stopped.
* @throws { BusinessError } 2900003 - Bluetooth disabled.
* @throws { BusinessError } 2900004 - Profile not supported.
* @throws { BusinessError } 2900099 - Operation failed.
* @syscap SystemCapability.Communication.Bluetooth.Core
* @since 10
*/
/**
* Obtains the profile connection state.
*
* @permission ohos.permission.ACCESS_BLUETOOTH
* @param { string } deviceId - Indicates device ID. For example, "11:22:33:AA:BB:FF".
* @returns { ProfileConnectionState } Returns the connection state.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified.
* <br>2. Incorrect parameter types. 3. Parameter verification failed.
* @throws { BusinessError } 801 - Capability not supported.
* @throws { BusinessError } 2900001 - Service stopped.
* @throws { BusinessError } 2900003 - Bluetooth disabled.
* @throws { BusinessError } 2900004 - Profile not supported.
* @throws { BusinessError } 2900099 - Operation failed.
* @syscap SystemCapability.Communication.Bluetooth.Core
* @crossplatform
* @since 13
*/
getConnectionState(deviceId: string): ProfileConnectionState;
/**
* Subscribe the event reported when the profile connection state changes .
*
* @permission ohos.permission.ACCESS_BLUETOOTH
* @param { 'connectionStateChange' } type - Type of the profile connection state changes event to listen for.
* @param { Callback<StateChangeParam> } callback - Callback used to listen for event.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified.
* <br>2. Incorrect parameter types. 3. Parameter verification failed.
* @throws { BusinessError } 801 - Capability not supported.
* @syscap SystemCapability.Communication.Bluetooth.Core
* @since 10
*/
/**
* Subscribe the event reported when the profile connection state changes .
*
* @permission ohos.permission.ACCESS_BLUETOOTH
* @param { 'connectionStateChange' } type - Type of the profile connection state changes event to listen for.
* @param { Callback<StateChangeParam> } callback - Callback used to listen for event.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified.
* <br>2. Incorrect parameter types. 3. Parameter verification failed.
* @throws { BusinessError } 801 - Capability not supported.
* @syscap SystemCapability.Communication.Bluetooth.Core
* @crossplatform
* @since 13
*/
on(type: 'connectionStateChange', callback: Callback<StateChangeParam>): void;
/**
* Unsubscribe the event reported when the profile connection state changes .
*
* @permission ohos.permission.ACCESS_BLUETOOTH
* @param { 'connectionStateChange' } type - Type of the profile connection state changes event to listen for.
* @param { Callback<StateChangeParam> } callback - Callback used to listen for event.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified.
* <br>2. Incorrect parameter types. 3. Parameter verification failed.
* @throws { BusinessError } 801 - Capability not supported.
* @syscap SystemCapability.Communication.Bluetooth.Core
* @since 10
*/
/**
* Unsubscribe the event reported when the profile connection state changes .
*
* @permission ohos.permission.ACCESS_BLUETOOTH
* @param { 'connectionStateChange' } type - Type of the profile connection state changes event to listen for.
* @param { Callback<StateChangeParam> } callback - Callback used to listen for event.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 401 - Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified.
* <br>2. Incorrect parameter types. 3. Parameter verification failed.
* @throws { BusinessError } 801 - Capability not supported.
* @syscap SystemCapability.Communication.Bluetooth.Core
* @crossplatform
* @since 13
*/
off(type: 'connectionStateChange', callback?: Callback<StateChangeParam>): void;
}
}
export default baseProfile;
Reference in New Issue View Git Blame Copy Permalink