mirror of
https://gitee.com/openharmony/interface_sdk-js
synced 2024-10-07 22:24:20 +00:00
ff61b1d252
Signed-off-by: dingxiaochen <dingxiaochen@huawei.com>
202 lines
6.6 KiB
TypeScript
202 lines
6.6 KiB
TypeScript
/*
|
|
* Copyright (C) 2021-2022 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.
|
|
*/
|
|
|
|
import {AsyncCallback} from "./basic";
|
|
|
|
/**
|
|
* Provides methods related to cellular data services.
|
|
*
|
|
* @since 7
|
|
* @syscap SystemCapability.Telephony.CellularData
|
|
*/
|
|
declare namespace data {
|
|
/**
|
|
* Checks whether cellular data services are enabled.
|
|
*
|
|
* @return Returns {@code true} if cellular data services are enabled; returns {@code false} otherwise.
|
|
* @permission ohos.permission.GET_NETWORK_INFO
|
|
*/
|
|
function getDefaultCellularDataSlotId(callback: AsyncCallback<number>): void;
|
|
function getDefaultCellularDataSlotId(): Promise<number>;
|
|
|
|
/**
|
|
* Checks whether cellular data services are enabled.
|
|
*
|
|
* <p>Requires Permission: {@code ohos.permission.GET_NETWORK_INFO}.
|
|
*
|
|
* @return Returns default cellular data slot id.
|
|
* @permission ohos.permission.GET_NETWORK_INFO
|
|
* @since 9
|
|
*/
|
|
function getDefaultCellularDataSlotIdSync(): number;
|
|
|
|
/**
|
|
* Switches cellular data services to another card, without changing the default settings.
|
|
*
|
|
* @param slotId Indicates the ID of the target card slot.
|
|
* The value {@code 0} indicates card 1, and the value {@code 1} indicates card 2.
|
|
* @permission ohos.permission.SET_TELEPHONY_STATE
|
|
* @systemapi Hide this for inner system use.
|
|
*/
|
|
function setDefaultCellularDataSlotId(slotId: number, callback: AsyncCallback<void>): void;
|
|
function setDefaultCellularDataSlotId(slotId: number): Promise<void>;
|
|
|
|
/**
|
|
* Indicates that there is no uplink or downlink data.
|
|
*
|
|
* <p>It is a return value of service state query of cellular data services.
|
|
*/
|
|
function getCellularDataFlowType(callback: AsyncCallback<DataFlowType>): void;
|
|
function getCellularDataFlowType(): Promise<DataFlowType>;
|
|
|
|
/**
|
|
* Obtains the connection state of the PS domain.
|
|
*
|
|
* @param slotId Indicates the ID of a card slot.
|
|
* The value {@code 0} indicates card 1, and the value {@code 1} indicates card 2.
|
|
* @param callback Returns the connection state, which can be any of the following:
|
|
* <ul>
|
|
* <li>{@code DataConnectState#DATA_STATE_UNKNOWN}
|
|
* <li>{@code DataConnectState#DATA_STATE_DISCONNECTED}
|
|
* <li>{@code DataConnectState#DATA_STATE_CONNECTING}
|
|
* <li>{@code DataConnectState#DATA_STATE_CONNECTED}
|
|
* <li>{@code DataConnectState#DATA_STATE_SUSPENDED}
|
|
* </ul>
|
|
*/
|
|
function getCellularDataState(callback: AsyncCallback<DataConnectState>): void;
|
|
function getCellularDataState(): Promise<DataConnectState>;
|
|
|
|
/**
|
|
* Checks whether cellular data services are enabled.
|
|
*
|
|
* @param callback Returns {@code true} if cellular data services are enabled; returns {@code false} otherwise.
|
|
* @permission ohos.permission.GET_NETWORK_INFO
|
|
*/
|
|
function isCellularDataEnabled(callback: AsyncCallback<boolean>): void;
|
|
function isCellularDataEnabled(): Promise<boolean>;
|
|
|
|
/**
|
|
* Enables cellular data services.
|
|
*
|
|
* @permission ohos.permission.SET_TELEPHONY_STATE
|
|
* @systemapi Hide this for inner system use.
|
|
*/
|
|
function enableCellularData(callback: AsyncCallback<void>): void;
|
|
function enableCellularData(): Promise<void>;
|
|
|
|
/**
|
|
* Diables cellular data services.
|
|
*
|
|
* @permission ohos.permission.SET_TELEPHONY_STATE
|
|
* @systemapi Hide this for inner system use.
|
|
*/
|
|
function disableCellularData(callback: AsyncCallback<void>): void;
|
|
function disableCellularData(): Promise<void>;
|
|
|
|
/**
|
|
* Checks whether roaming is enabled for cellular data services.
|
|
*
|
|
* @param slotId Indicates the ID of a card slot.
|
|
* The value {@code 0} indicates card 1, and the value {@code 1} indicates card 2.
|
|
* @param callback Returns {@code true} if roaming is enabled for cellular data services; returns {@code false} otherwise.
|
|
* @permission ohos.permission.GET_NETWORK_INFO
|
|
*/
|
|
function isCellularDataRoamingEnabled(slotId: number, callback: AsyncCallback<boolean>): void;
|
|
function isCellularDataRoamingEnabled(slotId: number): Promise<boolean>;
|
|
|
|
/**
|
|
* Enables cellular data roaming.
|
|
*
|
|
* @param slotId Indicates the ID of a card slot.
|
|
* The value {@code 0} indicates card 1, and the value {@code 1} indicates card 2.
|
|
* @permission ohos.permission.SET_TELEPHONY_STATE
|
|
* @systemapi Hide this for inner system use.
|
|
*/
|
|
function enableCellularDataRoaming(slotId: number, callback: AsyncCallback<void>): void;
|
|
function enableCellularDataRoaming(slotId: number): Promise<void>;
|
|
|
|
/**
|
|
* Disables cellular data roaming.
|
|
*
|
|
* @param slotId Indicates the ID of a card slot.
|
|
* The value {@code 0} indicates card 1, and the value {@code 1} indicates card 2.
|
|
* @permission ohos.permission.SET_TELEPHONY_STATE
|
|
* @systemapi Hide this for inner system use.
|
|
*/
|
|
function disableCellularDataRoaming(slotId: number, callback: AsyncCallback<void>): void;
|
|
function disableCellularDataRoaming(slotId: number): Promise<void>;
|
|
|
|
/**
|
|
* Describes the cellular data flow type.
|
|
*/
|
|
export enum DataFlowType {
|
|
/**
|
|
* Indicates that there is no uplink or downlink data.
|
|
*/
|
|
DATA_FLOW_TYPE_NONE = 0,
|
|
|
|
/**
|
|
* Indicates that there is only downlink data.
|
|
*/
|
|
DATA_FLOW_TYPE_DOWN = 1,
|
|
|
|
/**
|
|
* Indicates that there is only uplink data.
|
|
*/
|
|
DATA_FLOW_TYPE_UP = 2,
|
|
|
|
/**
|
|
* Indicates that there is uplink and downlink data.
|
|
*/
|
|
DATA_FLOW_TYPE_UP_DOWN = 3,
|
|
|
|
/**
|
|
* Indicates that there is no uplink or downlink data, and the bottom-layer link is in the dormant state.
|
|
*/
|
|
DATA_FLOW_TYPE_DORMANT = 4
|
|
}
|
|
|
|
/**
|
|
* Describes the cellular data link connection state.
|
|
*/
|
|
export enum DataConnectState {
|
|
/**
|
|
* Indicates that a cellular data link is unknown.
|
|
*/
|
|
DATA_STATE_UNKNOWN = -1,
|
|
|
|
/**
|
|
* Indicates that a cellular data link is disconnected.
|
|
*/
|
|
DATA_STATE_DISCONNECTED = 0,
|
|
|
|
/**
|
|
* Indicates that a cellular data link is being connected.
|
|
*/
|
|
DATA_STATE_CONNECTING = 1,
|
|
|
|
/**
|
|
* Indicates that a cellular data link is connected.
|
|
*/
|
|
DATA_STATE_CONNECTED = 2,
|
|
|
|
/**
|
|
* Indicates that a cellular data link is suspended.
|
|
*/
|
|
DATA_STATE_SUSPENDED = 3
|
|
}
|
|
}
|
|
|
|
export default data; |