@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 '@ohos.bluetooth.access';

access.factoryReset¹¹⁺

factoryReset(callback: AsyncCallback<void>): void

Restores the Bluetooth factory settings.

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

Error codes

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

Example

import { AsyncCallback, BusinessError } from '@ohos.base';
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.

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

Error codes

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

Example

import { AsyncCallback, BusinessError } from '@ohos.base';
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

Error codes

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

Example

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