@ohos.telephony.radio (Network Search)

The radio module provides basic network search management functions. You can obtain the radio access technology (RAT) used in the CS and PS domains, network status, current network selection mode, ISO country code of the registered network, ID of the slot in which the primary card is located, list of signal strengths of the registered network, carrier name, and IMEI, MEID, and unique device ID of the SIM card in the specified slot. Besides, you can check whether the current device supports 5G(NR) and whether the radio service is enabled on the primary SIM card.

NOTE

The initial APIs of this module are supported since API version 6. Newly added APIs will be marked with a superscript to indicate their earliest API version.

Modules to Import

import radio from '@ohos.telephony.radio';

radio.getRadioTech

getRadioTech(slotId: number, callback: AsyncCallback<{psRadioTech: RadioTechnology, csRadioTech: RadioTechnology}>): void

Obtains the RAT used in the CS and PS domains for the SIM card in the specified slot. This API uses an asynchronous callback to return the result.

Required permission: ohos.permission.GET_NETWORK_INFO

System capability: SystemCapability.Telephony.CoreService

Parameters

Error codes

For details about the following error codes, see Telephony Error Codes.

Example

let slotId = 0;
radio.getRadioTech(slotId, (err, data) => {
    console.log(`callback: err->${JSON.stringify(err)}, data->${JSON.stringify(data)}`);
});

radio.getRadioTech

getRadioTech(slotId: number): Promise<{psRadioTech: RadioTechnology, csRadioTech: RadioTechnology}>

Obtains the RAT used in the CS and PS domains for the SIM card in the specified slot. This API uses a promise to return the result.

Required permission: ohos.permission.GET_NETWORK_INFO

System capability: SystemCapability.Telephony.CoreService

Parameters

Return value

Error codes

For details about the following error codes, see Telephony Error Codes.

Example

let slotId = 0;
let promise = radio.getRadioTech(slotId);
promise.then(data => {
    console.log(`getRadioTech success, data->${JSON.stringify(data)}`);
}).catch(err => {
    console.log(`getRadioTech failed, err->${JSON.stringify(err)}`);
});

radio.getNetworkState

getNetworkState(callback: AsyncCallback<NetworkState>): void

Obtains the network status. This API uses an asynchronous callback to return the result.

Required permission: ohos.permission.GET_NETWORK_INFO

System capability: SystemCapability.Telephony.CoreService

Parameters

Error codes

For details about the following error codes, see Telephony Error Codes.

Example

radio.getNetworkState((err, data) => {
    console.log(`callback: err->${JSON.stringify(err)}, data->${JSON.stringify(data)}`);
});

radio.getNetworkState

getNetworkState(slotId: number, callback: AsyncCallback<NetworkState>): void

Obtains the network status. This API uses an asynchronous callback to return the result.

Required permission: ohos.permission.GET_NETWORK_INFO

System capability: SystemCapability.Telephony.CoreService

Parameters

Error codes

For details about the following error codes, see Telephony Error Codes.

Example

let slotId = 0;
radio.getNetworkState(slotId, (err, data) => {
    console.log(`callback: err->${JSON.stringify(err)}, data->${JSON.stringify(data)}`);
});

radio.getNetworkState

getNetworkState(slotId?: number): Promise<NetworkState>

Obtains the network status. This API uses a promise to return the result.

Required permission: ohos.permission.GET_NETWORK_INFO

System capability: SystemCapability.Telephony.CoreService

Parameters

Return value

Error codes

For details about the following error codes, see Telephony Error Codes.

Example

let slotId = 0;
let promise = radio.getNetworkState(slotId);
promise.then(data => {
    console.log(`getNetworkState success, promise: data->${JSON.stringify(data)}`);
}).catch(err => {
    console.log(`getNetworkState failed, promise: err->${JSON.stringify(err)}`);
});

radio.getNetworkSelectionMode

getNetworkSelectionMode(slotId: number, callback: AsyncCallback<NetworkSelectionMode>): void

Obtains the network selection mode of the SIM card in the specified slot. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.Telephony.CoreService

Parameters

Error codes

For details about the following error codes, see Telephony Error Codes.

Example

let slotId = 0;
radio.getNetworkSelectionMode(slotId, (err, data) => {
    console.log(`callback: err->${JSON.stringify(err)}, data->${JSON.stringify(data)}`);
});

radio.getNetworkSelectionMode

getNetworkSelectionMode(slotId: number): Promise<NetworkSelectionMode>

Obtains the network selection mode of the SIM card in the specified slot. This API uses a promise to return the result.

System capability: SystemCapability.Telephony.CoreService

Parameters

Return value

Error codes

For details about the following error codes, see Telephony Error Codes.

Example

let slotId = 0;
let promise = radio.getNetworkSelectionMode(slotId);
promise.then(data => {
    console.log(`getNetworkSelectionMode success, promise: data->${JSON.stringify(data)}`);
}).catch(err => {
    console.log(`getNetworkSelectionMode failed, promise: err->${JSON.stringify(err)}`);
});

radio.getISOCountryCodeForNetwork⁷⁺

getISOCountryCodeForNetwork(slotId: number, callback: AsyncCallback<string>): void

Obtains the ISO country code of the network with which the SIM card in the specified slot is registered. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.Telephony.CoreService

Parameters

Error codes

For details about the following error codes, see Telephony Error Codes.

Example

let slotId = 0;
radio.getISOCountryCodeForNetwork(slotId, (err, data) => {
    console.log(`callback: err->${JSON.stringify(err)}, data->${JSON.stringify(data)}`);
});

radio.getISOCountryCodeForNetwork⁷⁺

getISOCountryCodeForNetwork(slotId: number): Promise<string>

Obtains the ISO country code of the network with which the SIM card in the specified slot is registered. This API uses a promise to return the result.

System capability: SystemCapability.Telephony.CoreService

Parameters

Return value

Error codes

For details about the following error codes, see Telephony Error Codes.

Example

let slotId = 0;
let promise = radio.getISOCountryCodeForNetwork(slotId);
promise.then(data => {
    console.log(`getISOCountryCodeForNetwork success, promise: data->${JSON.stringify(data)}`);
}).catch(err => {
    console.log(`getISOCountryCodeForNetwork failed, promise: err->${JSON.stringify(err)}`);
});

radio.getPrimarySlotId⁷⁺

getPrimarySlotId(callback: AsyncCallback<number>): void

Obtains the ID of the slot in which the primary card is located. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.Telephony.CoreService

Parameters

Error codes

For details about the following error codes, see Telephony Error Codes.

Example

radio.getPrimarySlotId((err, data) => {
   console.log(`callback: err->${JSON.stringify(err)}, data->${JSON.stringify(data)}`);
});

radio.getPrimarySlotId⁷⁺

getPrimarySlotId(): Promise<number>

Obtains the ID of the slot in which the primary card is located. This API uses a promise to return the result.

System capability: SystemCapability.Telephony.CoreService

Return value

Error codes

For details about the following error codes, see Telephony Error Codes.

Example

let promise = radio.getPrimarySlotId();
promise.then(data => {
    console.log(`getPrimarySlotId success, promise: data->${JSON.stringify(data)}`);
}).catch(err => {
    console.error(`getPrimarySlotId failed, promise: err->${JSON.stringify(err)}`);
});

radio.getSignalInformation⁷⁺

getSignalInformation(slotId: number, callback: AsyncCallback<Array<SignalInformation>>): void

Obtains a list of signal strengths of the network with which the SIM card in the specified slot is registered. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.Telephony.CoreService

Parameters

Error codes

For details about the following error codes, see Telephony Error Codes.

Example

let slotId = 0;
radio.getSignalInformation(slotId, (err, data) => {
   console.log(`callback: err->${JSON.stringify(err)}, data->${JSON.stringify(data)}`);
});

radio.getSignalInformation⁷⁺

getSignalInformation(slotId: number): Promise<Array<SignalInformation>>

Obtains a list of signal strengths of the network with which the SIM card in the specified slot is registered. This API uses a promise to return the result.

System capability: SystemCapability.Telephony.CoreService

Parameters

Return value

Error codes

For details about the following error codes, see Telephony Error Codes.

Example

let slotId = 0;
let promise = radio.getSignalInformation(slotId);
promise.then(data => {
    console.log(`getSignalInformation success, promise: data->${JSON.stringify(data)}`);
}).catch(err => {
    console.error(`getSignalInformation failed, promise: err->${JSON.stringify(err)}`);
});

radio.isNrSupported^(deprecated)

isNrSupported(): boolean

Checks whether the current device supports 5G (NR).

NOTE

This API is supported since API version 7 and deprecated since API version 9. You are advised to use isNRSupported instead.

System capability: SystemCapability.Telephony.CoreService

Return value

Example

let result = radio.isNrSupported();
console.log("Result: "+ result);

radio.isNrSupported^(deprecated)

isNrSupported(slotId: number): boolean

Checks whether the current device supports 5G (NR).

NOTE

This API is supported since API version 8 and deprecated since API version 9. You are advised to use isNRSupported instead.

System capability: SystemCapability.Telephony.CoreService

Parameters

Return value

Example

let slotId = 0;
let result = radio.isNrSupported(slotId);
console.log("Result: "+ result);

radio.isNRSupported⁹⁺

isNRSupported(): boolean

Checks whether the current device supports 5G (NR).

System capability: SystemCapability.Telephony.CoreService

Return value

Example

let result = radio.isNRSupported();
console.log("Result: "+ result);

radio.isNRSupported⁹⁺

isNRSupported(slotId: number): boolean

Checks whether the current device supports 5G (NR).

System capability: SystemCapability.Telephony.CoreService

Parameters

Return value

Example

let slotId = 0;
let result = radio.isNRSupported(slotId);
console.log("Result: "+ result);

radio.isRadioOn⁷⁺

isRadioOn(callback: AsyncCallback<boolean>): void

Checks whether the radio service is enabled on the primary SIM card. This API uses an asynchronous callback to return the result.

Required permission: ohos.permission.GET_NETWORK_INFO

System capability: SystemCapability.Telephony.CoreService

Parameters

Error codes

For details about the following error codes, see Telephony Error Codes.

Example

radio.isRadioOn((err, data) => {
    console.log(`callback: err->${JSON.stringify(err)}, data->${JSON.stringify(data)}`);
});

radio.isRadioOn⁷⁺

isRadioOn(slotId: number, callback: AsyncCallback<boolean>): void

Checks whether the radio service is enabled on the SIM card in the specified slot. This API uses an asynchronous callback to return the result.

Required permission: ohos.permission.GET_NETWORK_INFO

System capability: SystemCapability.Telephony.CoreService

Parameters

Error codes

For details about the following error codes, see Telephony Error Codes.

Example

let slotId = 0;
radio.isRadioOn(slotId, (err, data) => {
    console.log(`callback: err->${JSON.stringify(err)}, data->${JSON.stringify(data)}`);
});

radio.isRadioOn⁷⁺

isRadioOn(slotId?: number): Promise<boolean>

Checks whether the radio service is enabled on the SIM card in the specified slot. This API uses a promise to return the result.

Required permission: ohos.permission.GET_NETWORK_INFO

System capability: SystemCapability.Telephony.CoreService

Parameters

Return value

Error codes

For details about the following error codes, see Telephony Error Codes.

Example

let slotId = 0;
let promise = radio.isRadioOn(slotId);
promise.then(data => {
    console.log(`isRadioOn success, promise: data->${JSON.stringify(data)}`);
}).catch(err => {
    console.error(`isRadioOn failed, promise: err->${JSON.stringify(err)}`);
});

radio.getOperatorName⁷⁺

getOperatorName(slotId: number, callback: AsyncCallback<string>): void

Obtains the carrier name for the SIM card in the specified slot. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.Telephony.CoreService

Parameters

Error codes

For details about the following error codes, see Telephony Error Codes.

Example

let slotId = 0;
radio.getOperatorName(slotId, (err, data) => {
    console.log(`callback: err->${JSON.stringify(err)}, data->${JSON.stringify(data)}`);
});

radio.getOperatorName⁷⁺

getOperatorName(slotId: number): Promise<string>

Obtains the carrier name for the SIM card in the specified slot. This API uses a promise to return the result.

System capability: SystemCapability.Telephony.CoreService

Parameters

Return value

Error codes

For details about the following error codes, see Telephony Error Codes.

Example

let slotId = 0;
let promise = radio.getOperatorName(slotId);
promise.then(data => {
    console.log(`getOperatorName success, promise: data->${JSON.stringify(data)}`);
}).catch(err => {
    console.log(`getOperatorName failed, promise: err->${JSON.stringify(err)}`);
});

radio.setPrimarySlotId⁸⁺

setPrimarySlotId(slotId: number, callback: AsyncCallback<void>): void

Sets the ID of the slot in which the primary card is located. This API uses an asynchronous callback to return the result.

System API: This is a system API.

Required permission: ohos.permission.SET_TELEPHONY_STATE

System capability: SystemCapability.Telephony.CoreService

Parameters

Error codes

For details about the following error codes, see Telephony Error Codes.

Example

let slotId = 0;
radio.setPrimarySlotId(slotId, (err) => {
    console.log(`callback: err->${JSON.stringify(err)}`);
});

radio.setPrimarySlotId⁸⁺

setPrimarySlotId(slotId: number): Promise<void>

Sets the ID of the slot in which the primary card is located. This API uses a promise to return the result.

System API: This is a system API.

Required permission: ohos.permission.SET_TELEPHONY_STATE

System capability: SystemCapability.Telephony.CoreService

Parameters

Return value

Error codes

For details about the following error codes, see Telephony Error Codes.

Example

let slotId = 0;
let promise = radio.setPrimarySlotId(slotId);
promise.then(() => {
    console.log(`setPrimarySlotId success.`);
}).catch((err) => {
    console.log(`setPrimarySlotId failed, promise: err->${JSON.stringify(err)}`);
});

radio.getIMEI⁸⁺

getIMEI(callback: AsyncCallback<string>): void

Obtains the IMEI of the SIM card in a card slot. This API uses an asynchronous callback to return the result.

System API: This is a system API.

Required permission: ohos.permission.GET_TELEPHONY_STATE

System capability: SystemCapability.Telephony.CoreService

Parameters

Error codes

For details about the following error codes, see Telephony Error Codes.

Example

radio.getIMEI((err, data) => {
    console.log(`callback: err->${JSON.stringify(err)}, data->${JSON.stringify(data)}`);
});

radio.getIMEI⁸⁺

getIMEI(slotId: number, callback: AsyncCallback<string>): void

Obtains the IMEI of the SIM card in the specified card slot. This API uses an asynchronous callback to return the result.

System API: This is a system API.

Required permission: ohos.permission.GET_TELEPHONY_STATE

System capability: SystemCapability.Telephony.CoreService

Parameters

Error codes

For details about the following error codes, see Telephony Error Codes.

Example

let slotId = 0;
radio.getIMEI(slotId, (err, data) => {
    console.log(`callback: err->${JSON.stringify(err)}, data->${JSON.stringify(data)}`);
});

radio.getIMEI⁸⁺

getIMEI(slotId?: number): Promise<string>

Obtains the IMEI of the SIM card in the specified card slot. This API uses a promise to return the result.

System API: This is a system API.

Required permission: ohos.permission.GET_TELEPHONY_STATE

System capability: SystemCapability.Telephony.CoreService

Parameters

Return value

Error codes

For details about the following error codes, see Telephony Error Codes.

Example

let slotId = 0;
let promise = radio.getIMEI(slotId);
promise.then(data => {
    console.log(`getIMEI success, promise: data->${JSON.stringify(data)}`);
}).catch(err => {
    console.error(`getIMEI failed, promise: err->${JSON.stringify(err)}`);
});

radio.getMEID⁸⁺

getMEID(callback: AsyncCallback<string>): void

Obtains the MEID of the SIM card in a card slot. This API uses an asynchronous callback to return the result.

System API: This is a system API.

Required permission: ohos.permission.GET_TELEPHONY_STATE

System capability: SystemCapability.Telephony.CoreService

Parameters

Error codes

For details about the following error codes, see Telephony Error Codes.

Example

radio.getMEID((err, data) => {
    console.log(`callback: err->${JSON.stringify(err)}, data->${JSON.stringify(data)}`);
});

radio.getMEID⁸⁺

getMEID(slotId: number, callback: AsyncCallback<string>): void

Obtains the MEID of the SIM card in the specified card slot. This API uses an asynchronous callback to return the result.

System API: This is a system API.

Required permission: ohos.permission.GET_TELEPHONY_STATE

System capability: SystemCapability.Telephony.CoreService

Parameters

Error codes

For details about the following error codes, see Telephony Error Codes.

Example

let slotId = 0;
radio.getMEID(slotId, (err, data) => {
    console.log(`callback: err->${JSON.stringify(err)}, data->${JSON.stringify(data)}`);
});

radio.getMEID⁸⁺

getMEID(slotId?: number): Promise<string>

Obtains the MEID of the SIM card in the specified card slot. This API uses a promise to return the result.

System API: This is a system API.

Required permission: ohos.permission.GET_TELEPHONY_STATE

System capability: SystemCapability.Telephony.CoreService

Parameters

Return value

Error codes

For details about the following error codes, see Telephony Error Codes.

Example

let slotId = 0;
let promise = radio.getMEID(slotId);
promise.then(data => {
    console.log(`getMEID success, promise: data->${JSON.stringify(data)}`);
}).catch(err => {
    console.error(`getMEID failed, promise: err->${JSON.stringify(err)}`);
});

radio.getUniqueDeviceId⁸⁺

getUniqueDeviceId(callback: AsyncCallback<string>): void

Obtains the unique device ID of the SIM card in a card slot. This API uses an asynchronous callback to return the result.

System API: This is a system API.

Required permission: ohos.permission.GET_TELEPHONY_STATE

System capability: SystemCapability.Telephony.CoreService

Parameters

Error codes

For details about the following error codes, see Telephony Error Codes.

Example

radio.getUniqueDeviceId((err, data) => {
    console.log(`callback: err->${JSON.stringify(err)}, data->${JSON.stringify(data)}`);
});

radio.getUniqueDeviceId⁸⁺

getUniqueDeviceId(slotId: number, callback: AsyncCallback<string>): void

Obtains the unique device ID of the SIM card in the specified card slot. This API uses an asynchronous callback to return the result.

System API: This is a system API.

Required permission: ohos.permission.GET_TELEPHONY_STATE

System capability: SystemCapability.Telephony.CoreService

Parameters

Error codes

For details about the following error codes, see Telephony Error Codes.

Example

let slotId = 0;
radio.getUniqueDeviceId(slotId, (err, data) => {
    console.log(`callback: err->${JSON.stringify(err)}, data->${JSON.stringify(data)}`);
});

radio.getUniqueDeviceId⁸⁺

getUniqueDeviceId(slotId?: number): Promise<string>

Obtains the unique device ID of the SIM card in the specified card slot. This API uses a promise to return the result.

System API: This is a system API.

Required permission: ohos.permission.GET_TELEPHONY_STATE

System capability: SystemCapability.Telephony.CoreService

Parameters

Return value

Error codes

For details about the following error codes, see Telephony Error Codes.

Example

let slotId = 0;
let promise = radio.getUniqueDeviceId(slotId);
promise.then(data => {
    console.log(`getUniqueDeviceId success, promise: data->${JSON.stringify(data)}`);
}).catch(err => {
    console.error(`getUniqueDeviceId failed, promise: err->${JSON.stringify(err)}`);
});

radio.sendUpdateCellLocationRequest⁸⁺

sendUpdateCellLocationRequest(callback: AsyncCallback<void>): void

Sends a cell location update request. This API uses an asynchronous callback to return the result.

System API: This is a system API.

Required permissions: ohos.permission.LOCATION and ohos.permission.APPROXIMATELY_LOCATION

System capability: SystemCapability.Telephony.CoreService

Parameters

Error codes

For details about the following error codes, see Telephony Error Codes.

Example

radio.sendUpdateCellLocationRequest((err) => {
    console.log(`callback: err->${JSON.stringify(err)}`);
});

radio.sendUpdateCellLocationRequest⁸⁺

sendUpdateCellLocationRequest(slotId: number, callback: AsyncCallback<void>): void

Sends a cell location update request for the SIM card in the specified slot. This API uses an asynchronous callback to return the result.

System API: This is a system API.

Required permissions: ohos.permission.LOCATION and ohos.permission.APPROXIMATELY_LOCATION

System capability: SystemCapability.Telephony.CoreService

Parameters

Error codes

For details about the following error codes, see Telephony Error Codes.

Example

let slotId = 0;
radio.sendUpdateCellLocationRequest(slotId, (err) => {
    console.log(`callback: err->${JSON.stringify(err)}`);
});

radio.sendUpdateCellLocationRequest⁸⁺

sendUpdateCellLocationRequest(slotId?: number): Promise<void>

Sends a cell location update request for the SIM card in the specified slot. This API uses a promise to return the result.

System API: This is a system API.

Required permissions: ohos.permission.LOCATION and ohos.permission.APPROXIMATELY_LOCATION

System capability: SystemCapability.Telephony.CoreService

Parameters

Return value

Error codes

For details about the following error codes, see Telephony Error Codes.

Example

let slotId = 0;
radio.sendUpdateCellLocationRequest(slotId).then(() => {
    console.log(`sendUpdateCellLocationRequest success.`);
}).catch((err) => {
    console.log(`sendUpdateCellLocationRequest failed, promise: err->${JSON.stringify(err)}`);
});

radio.getCellInformation⁸⁺

getCellInformation(callback: AsyncCallback<Array<CellInformation>>): void

Obtains cell information. This API uses an asynchronous callback to return the result.

System API: This is a system API.

Required permissions: ohos.permission.LOCATION and ohos.permission.APPROXIMATELY_LOCATION

System capability: SystemCapability.Telephony.CoreService

Parameters

Error codes

For details about the following error codes, see Telephony Error Codes.

Example

radio.getCellInformation((err, data) => {
    console.log(`callback: err->${JSON.stringify(err)}, data->${JSON.stringify(data)}`);
});

radio.getCellInformation⁸⁺

getCellInformation(slotId: number, callback: AsyncCallback<Array<CellInformation>>): void

Obtains cell information for the SIM card in the specified slot. This API uses an asynchronous callback to return the result.

System API: This is a system API.

Required permissions: ohos.permission.LOCATION and ohos.permission.APPROXIMATELY_LOCATION

System capability: SystemCapability.Telephony.CoreService

Parameters

Error codes

For details about the following error codes, see Telephony Error Codes.

Example

let slotId = 0;
radio.getCellInformation(slotId, (err, data) => {
    console.log(`callback: err->${JSON.stringify(err)}, data->${JSON.stringify(data)}`);
});

radio.getCellInformation⁸⁺

getCellInformation(slotId?: number): Promise<Array<CellInformation>>

Obtains cell information for the SIM card in the specified slot. This API uses a promise to return the result.

System API: This is a system API.

Required permissions: ohos.permission.LOCATION and ohos.permission.APPROXIMATELY_LOCATION

System capability: SystemCapability.Telephony.CoreService

Parameters

Return value

Error codes

For details about the following error codes, see Telephony Error Codes.

Example

let slotId = 0;
let promise = radio.getCellInformation(slotId);
promise.then(data => {
    console.log(`getCellInformation success, promise: data->${JSON.stringify(data)}`);
}).catch(err => {
    console.error(`getCellInformation failed, promise: err->${JSON.stringify(err)}`);
});

radio.setNetworkSelectionMode

setNetworkSelectionMode(options: NetworkSelectionModeOptions, callback: AsyncCallback<void>): void

Sets the network selection mode. This API uses an asynchronous callback to return the result.

System API: This is a system API.

Required permission: ohos.permission.SET_TELEPHONY_STATE

System capability: SystemCapability.Telephony.CoreService

Parameters

Error codes

For details about the following error codes, see Telephony Error Codes.

Example

let networkInformation={
    operatorName: "China Mobile",
    operatorNumeric: "898600",
    state: radio.NetworkInformationState.NETWORK_AVAILABLE,
    radioTech: "CS"
}
let networkSelectionModeOptions={
    slotId: 0,
    selectMode: radio.NetworkSelectionMode.NETWORK_SELECTION_AUTOMATIC,
    networkInformation: networkInformation,
    resumeSelection: true
}
radio.setNetworkSelectionMode(networkSelectionModeOptions, (err) => {
    console.log(`callback: err->${JSON.stringify(err)}`);
});

radio.setNetworkSelectionMode

setNetworkSelectionMode(options: NetworkSelectionModeOptions): Promise<void>

Sets the network selection mode. This API uses a promise to return the result.

System API: This is a system API.

Required permission: ohos.permission.SET_TELEPHONY_STATE

System capability: SystemCapability.Telephony.CoreService

Parameters

Return value

Error codes

For details about the following error codes, see Telephony Error Codes.

Example

let networkInformation={
    operatorName: "China Mobile",
    operatorNumeric: "898600",
    state: radio.NetworkInformationState.NETWORK_AVAILABLE,
    radioTech: "CS"
}
let networkSelectionModeOptions={
    slotId: 0,
    selectMode: radio.NetworkSelectionMode.NETWORK_SELECTION_AUTOMATIC,
    networkInformation: networkInformation,
    resumeSelection: true
}
let promise = radio.setNetworkSelectionMode(networkSelectionModeOptions);
promise.then(() => {
    console.log(`setNetworkSelectionMode success.`);
}).catch((err) => {
    console.log(`setNetworkSelectionMode failed, promise: err->${JSON.stringify(err)}`);
});

radio.getNetworkSearchInformation

getNetworkSearchInformation(slotId: number, callback: AsyncCallback<NetworkSearchResult>): void

Obtains network search information for the SIM card in the specified slot. This API uses an asynchronous callback to return the result.

System API: This is a system API.

Required permission: ohos.permission.GET_TELEPHONY_STATE

System capability: SystemCapability.Telephony.CoreService

Parameters

Error codes

For details about the following error codes, see Telephony Error Codes.

Example

radio.getNetworkSearchInformation(0, (err, data) => {
    console.log(`callback: err->${JSON.stringify(err)}, data->${JSON.stringify(data)}`);
});

radio.getNetworkSearchInformation

getNetworkSearchInformation(slotId: number): Promise<NetworkSearchResult>

Obtains network search information for the SIM card in the specified slot. This API uses a promise to return the result.

System API: This is a system API.

Required permission: ohos.permission.GET_TELEPHONY_STATE

System capability: SystemCapability.Telephony.CoreService

Parameters

Return value

Error codes

For details about the following error codes, see Telephony Error Codes.

Example

let promise = radio.getNetworkSearchInformation(0);
promise.then(data => {
    console.log(`getNetworkSearchInformation success, promise: data->${JSON.stringify(data)}`);
}).catch(err => {
    console.log(`getNetworkSearchInformation failed, promise: err->${JSON.stringify(err)}`);
});

radio.getNrOptionMode⁸⁺

getNrOptionMode(callback: AsyncCallback<NrOptionMode>): void

Obtains the NR option mode. This API uses an asynchronous callback to return the result.

System API: This is a system API.

System capability: SystemCapability.Telephony.CoreService

Parameters

Error codes

For details about the following error codes, see Telephony Error Codes.

Example

radio.getNrOptionMode((err, data) => {
    console.log(`callback: err->${JSON.stringify(err)}, data->${JSON.stringify(data)}`);
});

radio.getNrOptionMode⁸⁺

getNrOptionMode(slotId: number, callback: AsyncCallback<NrOptionMode>): void

Obtains the NR option mode for the SIM card in the specified slot. This API uses an asynchronous callback to return the result.

System API: This is a system API.

System capability: SystemCapability.Telephony.CoreService

Parameters

Error codes

For details about the following error codes, see Telephony Error Codes.

Example

let slotId = 0;
radio.getNrOptionMode(slotId, (err, data) => {
    console.log(`callback: err->${JSON.stringify(err)}, data->${JSON.stringify(data)}`);
});

radio.getNrOptionMode⁸⁺

getNrOptionMode(slotId?: number): Promise<NrOptionMode>

Obtains the NR option mode for the SIM card in the specified slot. This API uses a promise to return the result.

System API: This is a system API.

System capability: SystemCapability.Telephony.CoreService

Parameters

Return value

Error codes

For details about the following error codes, see Telephony Error Codes.

Example

let slotId = 0;
let promise = radio.getNrOptionMode(slotId);
promise.then(data => {
    console.log(`getNrOptionMode success, promise: data->${JSON.stringify(data)}`);
}).catch(err => {
    console.error(`getNrOptionMode failed, promise: err->${JSON.stringify(err)}`);
});

radio.turnOnRadio⁷⁺

turnOnRadio(callback: AsyncCallback<void>): void

Turns on the radio function. This API uses an asynchronous callback to return the result.

System API: This is a system API.

Required permission: ohos.permission.SET_TELEPHONY_STATE

System capability: SystemCapability.Telephony.CoreService

Parameters

Error codes

For details about the following error codes, see Telephony Error Codes.

Example

radio.turnOnRadio((err) => {
    console.log(`callback: err->${JSON.stringify(err)}`);
});

radio.turnOnRadio⁷⁺

turnOnRadio(slotId: number, callback: AsyncCallback<void>): void

Turns on the radio function for the SIM card in the specified slot. This API uses an asynchronous callback to return the result.

System API: This is a system API.

Required permission: ohos.permission.SET_TELEPHONY_STATE

System capability: SystemCapability.Telephony.CoreService

Parameters

Error codes

For details about the following error codes, see Telephony Error Codes.

Example

let slotId = 0;
radio.turnOnRadio(slotId, (err) => {
    console.log(`callback: err->${JSON.stringify(err)}`);
});

radio.turnOnRadio⁷⁺

turnOnRadio(slotId?: number): Promise<void>

Turns on the radio function for the SIM card in the specified slot. This API uses a promise to return the result.

System API: This is a system API.

Required permission: ohos.permission.SET_TELEPHONY_STATE

System capability: SystemCapability.Telephony.CoreService

Parameters

Return value

Error codes

For details about the following error codes, see Telephony Error Codes.

Example

let slotId = 0;
radio.turnOnRadio(slotId).then(() => {
    console.log(`turnOnRadio success.`);
}).catch((err) => {
    console.error(`turnOnRadio failed, promise: err->${JSON.stringify(err)}`);
});

radio.turnOffRadio⁷⁺

turnOffRadio(callback: AsyncCallback<void>): void

Turns off the radio function. This API uses an asynchronous callback to return the result.

System API: This is a system API.

Required permission: ohos.permission.SET_TELEPHONY_STATE

System capability: SystemCapability.Telephony.CoreService

Parameters

Error codes

For details about the following error codes, see Telephony Error Codes.

Example

radio.turnOffRadio((err) => {
    console.log(`callback: err->${JSON.stringify(err)}`);
});

radio.turnOffRadio⁷⁺

turnOffRadio(slotId: number, callback: AsyncCallback<void>): void

Turns off the radio function for the SIM card in the specified slot. This API uses an asynchronous callback to return the result.

System API: This is a system API.

Required permission: ohos.permission.SET_TELEPHONY_STATE

System capability: SystemCapability.Telephony.CoreService

Parameters

Error codes

For details about the following error codes, see Telephony Error Codes.

Example

let slotId = 0;
radio.turnOffRadio(slotId, (err) => {
    console.log(`callback: err->${JSON.stringify(err)}`);
});

radio.turnOffRadio⁷⁺

turnOffRadio(slotId?: number): Promise<void>

Turns off the radio function for the SIM card in the specified slot. This API uses a promise to return the result.

System API: This is a system API.

Required permission: ohos.permission.SET_TELEPHONY_STATE

System capability: SystemCapability.Telephony.CoreService

Parameters

Return value

Error codes

For details about the following error codes, see Telephony Error Codes.

Example

let slotId = 0;
radio.turnOffRadio(slotId).then(() => {
    console.log(`turnOffRadio success.`);
}).catch((err) => {
    console.error(`turnOffRadio failed, promise: err->${JSON.stringify(err)}`);
});

radio.setPreferredNetwork⁸⁺

setPreferredNetwork(slotId: number, networkMode: PreferredNetworkMode, callback: AsyncCallback<void>): void

Sets the preferred network for the SIM card in the specified slot. This API uses an asynchronous callback to return the result.

System API: This is a system API.

Required permission: ohos.permission.SET_TELEPHONY_STATE

System capability: SystemCapability.Telephony.CoreService

Parameters

Error codes

For details about the following error codes, see Telephony Error Codes.

Example

let slotId = 0;
radio.setPreferredNetwork(slotId, radio.PreferredNetworkMode.PREFERRED_NETWORK_MODE_GSM, (err) => {
    console.log(`callback: err->${JSON.stringify(err)}`);
});

radio.setPreferredNetwork⁸⁺

setPreferredNetwork(slotId: number, networkMode: PreferredNetworkMode): Promise<void>

Sets the preferred network for the SIM card in the specified slot. This API uses a promise to return the result.

System API: This is a system API.

Required permission: ohos.permission.SET_TELEPHONY_STATE

System capability: SystemCapability.Telephony.CoreService

Parameters

Return value

Error codes

For details about the following error codes, see Telephony Error Codes.

Example

let slotId = 0;
radio.setPreferredNetwork(slotId, radio.PreferredNetworkMode.PREFERRED_NETWORK_MODE_GSM).then(() => {
    console.log(`setPreferredNetwork success.`);
}).catch((err) => {
    console.log(`setPreferredNetwork failed, promise: err->${JSON.stringify(err)}`);
});

radio.getPreferredNetwork⁸⁺

getPreferredNetwork(slotId: number, callback: AsyncCallback<PreferredNetworkMode>): void

Obtains the preferred network for the SIM card in the specified slot. This API uses an asynchronous callback to return the result.

System API: This is a system API.

Required permission: ohos.permission.GET_TELEPHONY_STATE

System capability: SystemCapability.Telephony.CoreService

Parameters

Error codes

For details about the following error codes, see Telephony Error Codes.

Example

radio.getPreferredNetwork(0, (err, data) => {
    console.log(`callback: err->${JSON.stringify(err)}, data->${JSON.stringify(data)}`);
});

radio.getPreferredNetwork⁸⁺

getPreferredNetwork(slotId: number): Promise<PreferredNetworkMode>

Obtains the preferred network for the SIM card in the specified slot. This API uses a promise to return the result.

System API: This is a system API.

Required permission: ohos.permission.GET_TELEPHONY_STATE

System capability: SystemCapability.Telephony.CoreService

Parameters

Return value

Error codes

For details about the following error codes, see Telephony Error Codes.

Example

let promise = radio.getPreferredNetwork(0);
promise.then(data => {
    console.log(`getPreferredNetwork success, promise: data->${JSON.stringify(data)}`);
}).catch(err => {
    console.log(`getPreferredNetwork failed, promise: err->${JSON.stringify(err)}`);
});

radio.getImsRegInfo⁹⁺

getImsRegInfo(slotId: number, imsType: ImsServiceType, callback: AsyncCallback<ImsRegInfo>): void

Obtains the IMS registration status of the specified IMS service type for the SIM card in the specified slot. This API uses an asynchronous callback to return the result.

System API: This is a system API.

Required permission: ohos.permission.GET_TELEPHONY_STATE

System capability: SystemCapability.Telephony.CoreService

Parameters

Error codes

For details about the following error codes, see Telephony Error Codes.

Example

radio.getImsRegInfo(0, radio.ImsServiceType.TYPE_VIDEO, (err, data) => {
    console.log(`callback: err->${JSON.stringify(err)}, data->${JSON.stringify(data)}`);
});

radio.getImsRegInfo⁹⁺

getImsRegInfo(slotId: number, imsType: ImsServiceType): Promise<ImsRegInfo>

Obtains the IMS registration status of the specified IMS service type for the SIM card in the specified slot. This API uses a promise to return the result.

System API: This is a system API.

Required permission: ohos.permission.GET_TELEPHONY_STATE

System capability: SystemCapability.Telephony.CoreService

Parameters

Return value

Error codes

For details about the following error codes, see Telephony Error Codes.

Example

let promise = radio.getImsRegInfo(0, radio.ImsServiceType.TYPE_VIDEO);
promise.then(data => {
    console.log(`getImsRegInfo success, promise: data->${JSON.stringify(data)}`);
}).catch(err => {
    console.log(`getImsRegInfo failed, promise: err->${JSON.stringify(err)}`);
});

radio.on('imsRegStateChange')⁹⁺

on(type: 'imsRegStateChange', slotId: number, imsType: ImsServiceType, callback: Callback<ImsRegInfo>): void

Enables listening for imsRegStateChange events. This API uses an asynchronous callback to return the result.

System API: This is a system API.

Required permission: ohos.permission.GET_TELEPHONY_STATE

System capability: SystemCapability.Telephony.CoreService

Parameters

Error codes

For details about the following error codes, see Telephony Error Codes.

Example

radio.on('imsRegStateChange', 0, radio.ImsServiceType.TYPE_VIDEO, data => {
    console.log(`callback: data->${JSON.stringify(data)}`);
});

radio.off('imsRegStateChange')⁹⁺

off(type: 'imsRegStateChange', slotId: number, imsType: ImsServiceType, callback?: Callback<ImsRegInfo>): void

Disables listening for imsRegStateChange events. This API uses an asynchronous callback to return the result.

System API: This is a system API.

Required permission: ohos.permission.GET_TELEPHONY_STATE

System capability: SystemCapability.Telephony.CoreService

Parameters

Error codes

For details about the following error codes, see Telephony Error Codes.

Example

radio.off('imsRegStateChange', 0, radio.ImsServiceType.TYPE_VIDEO, data => {
    console.log(`callback: data->${JSON.stringify(data)}`);
});

RadioTechnology

Enumerates radio access technologies.

System capability: SystemCapability.Telephony.CoreService

SignalInformation

Defines the signal strength.

System capability: SystemCapability.Telephony.CoreService

NetworkType

Enumerates network types.

System capability: SystemCapability.Telephony.CoreService

NetworkState

Defines the network status.

System capability: SystemCapability.Telephony.CoreService

RegState

Defines the network status.

System capability: SystemCapability.Telephony.CoreService

NsaState

Enumerates NSA network states.

System capability: SystemCapability.Telephony.CoreService

NetworkSelectionMode

Enumerates network selection modes.

System capability: SystemCapability.Telephony.CoreService

PreferredNetworkMode⁸⁺

Enumerates preferred network modes.

System API: This is a system API.

System capability: SystemCapability.Telephony.CoreService

CellInformation⁸⁺

Defines the cell information.

System API: This is a system API.

System capability: SystemCapability.Telephony.CoreService

CdmaCellInformation⁸⁺

Defines the CDMA cell information.

System API: This is a system API.

System capability: SystemCapability.Telephony.CoreService

GsmCellInformation⁸⁺

Defines the GSM cell information.

System API: This is a system API.

System capability: SystemCapability.Telephony.CoreService

LteCellInformation⁸⁺

LTE cell information.

System API: This is a system API.

System capability: SystemCapability.Telephony.CoreService

NrCellInformation⁸⁺

Defines the 5G NR cell information.

System API: This is a system API.

System capability: SystemCapability.Telephony.CoreService

TdscdmaCellInformation⁸⁺

Defines the TD-SCDMA cell information.

System API: This is a system API.

System capability: SystemCapability.Telephony.CoreService

WcdmaCellInformation⁸⁺

Defines the WCDMA cell information.

System API: This is a system API.

System capability: SystemCapability.Telephony.CoreService

NrOptionMode⁸⁺

Enumerates NR selection modes.

System API: This is a system API.

System capability: SystemCapability.Telephony.CoreService

NetworkSearchResult

Defines the network search result.

System API: This is a system API.

System capability: SystemCapability.Telephony.CoreService

NetworkInformation

Defines the network information.

System API: This is a system API.

System capability: SystemCapability.Telephony.CoreService

NetworkInformationState

Enumerates network information states.

System API: This is a system API.

System capability: SystemCapability.Telephony.CoreService

NetworkSelectionModeOptions

Defines the network selection mode.

System API: This is a system API.

System capability: SystemCapability.Telephony.CoreService

ImsRegState⁹⁺

Enumerates IMS registration states.

System API: This is a system API.

System capability: SystemCapability.Telephony.CoreService

ImsRegTech⁹⁺

Enumerates IMS registration technologies.

System API: This is a system API.

System capability: SystemCapability.Telephony.CoreService

ImsRegInfo⁹⁺

Defines the IMS registration information.

System API: This is a system API.

System capability: SystemCapability.Telephony.CoreService

ImsServiceType⁹⁺

Enumerates IMS service types.

System API: This is a system API.

System capability: SystemCapability.Telephony.CoreService