@ohos.bluetooth.access (Bluetooth Access Module) (System API)

The access module provides APIs for enabling and disabling Bluetooth and obtaining the Bluetooth status.

NOTE

The initial APIs of this module are supported since API version 10. Newly added APIs will be marked with a superscript to indicate their earliest API version. This topic describes only the system APIs provided by the module. For details about its public APIs, see @ohos.bluetooth.access (Bluetooth Access Module).

Modules to Import

import { access } from '@kit.ConnectivityKit';

access.factoryReset¹¹⁺

factoryReset(callback: AsyncCallback<void>): void

Restores the Bluetooth factory settings. This API uses an asynchronous callback to return the result.

System API: This is a system API.

Required permissions: ohos.permission.ACCESS_BLUETOOTH and ohos.permission.MANAGE_BLUETOOTH

System capability: SystemCapability.Communication.Bluetooth.Core

Parameters

Name	Type	Mandatory	Description
callback	AsyncCallback<void>	Yes	Callback used to return the result. If the Bluetooth factory settings are restored successfully, err is undefined. Otherwise, err is an error object.

Error codes

For details about the error codes, see Universal Error Codes and Bluetooth Error Codes.

ID	Error Message
201	Permission denied.
202	Non-system applications are not allowed to use system APIs.
401	Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. 2. Incorrect parameter types.
801	Capability not supported.
2900001	Service stopped.
2900099	Operation failed.

Example

import { BusinessError } from '@kit.BasicServicesKit';
try {
    access.factoryReset((err: BusinessError) => {
        if (err) {
            console.error("factoryReset error");
        }
    });
} catch (err) {
    console.error('errCode: ' + (err as BusinessError).code + ', errMessage: ' + (err as BusinessError).message);
}

access.factoryReset¹¹⁺

factoryReset(): Promise<void>

Restores the Bluetooth factory settings. This API uses a promise to return the result.

System API: This is a system API.

Required permissions: ohos.permission.ACCESS_BLUETOOTH and ohos.permission.MANAGE_BLUETOOTH

System capability: SystemCapability.Communication.Bluetooth.Core

Return value

Type	Description
Promise<void>	Promise that returns no value.

Error codes

For details about the error codes, see Universal Error Codes and Bluetooth Error Codes.

ID	Error Message
201	Permission denied.
202	Non-system applications are not allowed to use system APIs.
801	Capability not supported.
2900001	Service stopped.
2900099	Operation failed.

Example

import { BusinessError } from '@kit.BasicServicesKit';
try {
    access.factoryReset().then(() => {
        console.info("factoryReset");
    });
} catch (err) {
    console.error('errCode: ' + (err as BusinessError).code + ', errMessage: ' + (err as BusinessError).message);
}

access.getLocalAddress¹¹⁺

getLocalAddress(): string

Obtains the Bluetooth address of the local device.

System API: This is a system API.

Required permissions: ohos.permission.ACCESS_BLUETOOTH and ohos.permission.GET_BLUETOOTH_LOCAL_MAC

System capability: SystemCapability.Communication.Bluetooth.Core

Return value

Type	Description
string	Bluetooth address obtained.

Error codes

For details about the error codes, see Universal Error Codes and Bluetooth Error Codes.

ID	Error Message
201	Permission denied.
202	Non-system applications are not allowed to use system APIs.
801	Capability not supported.
2900001	Service stopped.
2900099	Operation failed.

Example

import { BusinessError } from '@kit.BasicServicesKit';
try {
    let localAddr = access.getLocalAddress();
} catch (err) {
    console.error('errCode: ' + (err as BusinessError).code + ', errMessage: ' + (err as BusinessError).message);
}

access.restrictBluetooth¹²⁺

restrictBluetooth(): Promise<void>

Restricts the BR/EDR capability of this Bluetooth device.

System API: This is a system API.

Required permissions: ohos.permission.ACCESS_BLUETOOTH and ohos.permission.MANAGE_BLUETOOTH

System capability: SystemCapability.Communication.Bluetooth.Core

Return value

Type	Description
Promise<void>	Promise that returns no value.

Error codes

For details about the error codes, see Universal Error Codes and Bluetooth Error Codes.

ID	Error Message
201	Permission denied.
202	Non-system applications are not allowed to use system APIs.
801	Capability not supported.
2900001	Service stopped.
2900099	Operation failed.

Example

import { BusinessError } from '@kit.BasicServicesKit';
try {
    access.restrictBluetooth().then(() => {
        console.info("restrictBluetooth");
    });
} catch (err) {
    console.error('errCode: ' + (err as BusinessError).code + ', errMessage: ' + (err as BusinessError).message);
}

access.notifyDialogResult²⁰⁺

notifyDialogResult(notifyDialogResultParams: NotifyDialogResultParams): Promise<void>

Notifies the Bluetooth service of the user's action in operating the Bluetooth switch dialog. This API uses a promise to return the result.

• Use this API with access.enableBluetoothAsync (supported since API version 20). When an application requests to enable Bluetooth, call this API to notify the Bluetooth service of the user's action in operating the Bluetooth switch dialog.
• Use this API with access.disableBluetoothAsync (supported since API version 20). When an application requests to disable Bluetooth, call this API to notify the Bluetooth service of the user's action in operating the Bluetooth switch dialog.

System API: This is a system API.

Required permissions: ohos.permission.ACCESS_BLUETOOTH and ohos.permission.MANAGE_BLUETOOTH

System capability: SystemCapability.Communication.Bluetooth.Core

Parameters

Name	Type	Mandatory	Description
notifyDialogResultParams	NotifyDialogResultParams	Yes	User's action in operating the Bluetooth switch dialog.

Return value

Type	Description
Promise<void>	Promise that returns no value.

Error codes

For details about the error codes, see Universal Error Codes and Bluetooth Error Codes.

ID	Error Message
201	Permission denied.
202	Non-system applications are not allowed to use system APIs.
801	Capability not supported.
2900001	Service stopped.
2900099	Operation failed.

Example

import { BusinessError } from '@kit.BasicServicesKit';
try {
    let notifyDialogResultParams: access.NotifyDialogResultParams = {
        "dialogType": 0,
        "dialogResult": true,
    };
    access.notifyDialogResult(notifyDialogResultParams);
} catch (err) {
    console.error('errCode: ' + (err as BusinessError).code + ', errMessage: ' + (err as BusinessError).message);
}

NotifyDialogResultParams²⁰⁺

Defines the user's action in operating the Bluetooth switch dialog.

System API: This is a system API.

System capability: SystemCapability.Communication.Bluetooth.Core

Name	Type	Read-Only	Optional	Description
dialogType	DialogType	No	No	Dialog type.
dialogResult	boolean	No	No	User's action in operating the Bluetooth switch dialog. The value true means to enable Bluetooth, and the value false means the opposite.

DialogType²⁰⁺

Enumerates the dialog types.

System API: This is a system API.

System capability: SystemCapability.Communication.Bluetooth.Core

Name	Value	Description
BLUETOOTH_SWITCH	0	Bluetooth switch dialog.