interface_sdk-js/api/@ohos.net.ethernet.d.ts
fuchao 442fa215c5 Add @ohos.net.ethernet.d.ts file
Signed-off-by: fuchao <chao.fu@thundersoft.com>
2022-10-09 09:30:25 +08:00

88 lines
2.8 KiB
TypeScript

/*
* Copyright (C) 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, Callback} from "./basic";
/**
* Provides interfaces to manage ethernet.
*
* @since 9
* @syscap SystemCapability.Communication.NetManager.Ethernet
*/
declare namespace ethernet {
/**
* Get the specified network interface information.
*
* @param iface Indicates the network interface name.
* @permission ohos.permission.GET_NETWORK_INFO
* @systemapi Hide this for inner system use.
*/
function getIfaceConfig(iface: string, callback: AsyncCallback<InterfaceConfiguration>): void;
function getIfaceConfig(iface: string): Promise<InterfaceConfiguration>;
/**
* Set the specified network interface parameters.
*
* @param iface Indicates the network interface name of the network parameter.
* @param ic Indicates the ic. See {@link InterfaceConfiguration}.
* @permission ohos.permission.CONNECTIVITY_INTERNAL
* @systemapi Hide this for inner system use.
*/
function setIfaceConfig(iface: string, ic: InterfaceConfiguration, callback: AsyncCallback<void>): void;
function setIfaceConfig(iface: string, ic: InterfaceConfiguration): Promise<void>;
/**
* Check whether the specified network is active.
*
* @param iface Indicates the network interface name.
* @permission ohos.permission.GET_NETWORK_INFO
* @systemapi Hide this for inner system use.
*/
function isIfaceActive(iface: string, callback: AsyncCallback<number>): void;
function isIfaceActive(iface: string): Promise<number>;
/**
* Gets the names of all active network interfaces.
*
* @permission ohos.permission.GET_NETWORK_INFO
* @systemapi Hide this for inner system use.
*/
function getAllActiveIfaces(callback: AsyncCallback<Array<string>>): void;
function getAllActiveIfaces(): Promise<Array<string>>;
/**
* @systemapi Hide this for inner system use.
*/
export interface InterfaceConfiguration {
/*See {@link IPSetMode}*/
mode: IPSetMode;
ipAddr: string;
route: string;
gateway: string;
netMask: string;
dnsServers: string;
domain: string;
}
/**
* @systemapi Hide this for inner system use.
*/
export enum IPSetMode {
STATIC = 0,
DHCP = 1
}
}
export default ethernet;