1 Star 0 Fork 3.9K

Feng Lin/interface_sdk-js

加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
文件
克隆/下载
@ohos.net.netFirewall.d.ts 30.47 KB
一键复制 编辑 原始数据 按行查看 历史
up200504098 提交于 2024-08-05 10:18 +08:00 . 更改返回值
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918
/*
* Copyright (C) 2024 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.
*/
/**
* @file
* @kit NetworkKit
*/
/**
* Provides interfaces to manage net firewall.
*
* @namespace netFirewall
* @syscap SystemCapability.Communication.NetManager.NetFirewall
* @since 12
*/
declare namespace netFirewall {
/**
* Set firewall policy by userId.
* <p>Enables or disables the firewall function, and specifies the default actions for inbound connections and
* outbound connections.</p>
*
* @permission ohos.permission.MANAGE_NET_FIREWALL
* @param { number } userId - Indicates the user ID. It cannot be the ID of a user that does not exist.
* @param { NetFirewallPolicy } policy - The firewall policy to be set.
* @returns { Promise<void> } Returns void.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 202 - Non-system applications use system APIs.
* @throws { BusinessError } 401 - Parameter error.
* @throws { BusinessError } 2100001 - Invalid parameter value.
* @throws { BusinessError } 2100002 - Operation failed. Cannot connect to service.
* @throws { BusinessError } 2100003 - System internal error.
* @throws { BusinessError } 29400000 - The specified user does not exist.
* @syscap SystemCapability.Communication.NetManager.NetFirewall
* @systemapi Hide this for inner system use.
* @since 12
*/
function setNetFirewallPolicy(userId: number, policy: NetFirewallPolicy): Promise<void>;
/**
* Get firewall policy by userId.
*
* @permission ohos.permission.GET_NET_FIREWALL
* @param { number } userId - Indicates the user ID. It cannot be the ID of a user that does not exist.
* @returns { Promise<NetFirewallPolicy> } Current user firewall policy.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 202 - Non-system applications use system APIs.
* @throws { BusinessError } 401 - Parameter error.
* @throws { BusinessError } 2100001 - Invalid parameter value.
* @throws { BusinessError } 2100002 - Operation failed. Cannot connect to service.
* @throws { BusinessError } 2100003 - System internal error.
* @throws { BusinessError } 29400000 - The specified user does not exist.
* @syscap SystemCapability.Communication.NetManager.NetFirewall
* @systemapi Hide this for inner system use.
* @since 12
*/
function getNetFirewallPolicy(userId: number): Promise<NetFirewallPolicy>;
/**
* Add a firewall rule.
*
* @permission ohos.permission.MANAGE_NET_FIREWALL
* @param { NetFirewallRule } rule - Firewall rule.
* @returns { Promise<number> } ruleId - Indicates the rule ID, generated by the system.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 202 - Non-system applications use system APIs.
* @throws { BusinessError } 401 - Parameter error.
* @throws { BusinessError } 2100001 - Invalid parameter value.
* @throws { BusinessError } 2100002 - Operation failed. Cannot connect to service.
* @throws { BusinessError } 2100003 - System internal error.
* @throws { BusinessError } 29400000 - The specified user does not exist.
* @throws { BusinessError } 29400001 - The number of firewall rules exceeds the maximum.
* @throws { BusinessError } 29400002 - The number of IP address rules in the firewall rule exceeds the maximum.
* @throws { BusinessError } 29400003 - The number of port rules in the firewall rule exceeds the maximum.
* @throws { BusinessError } 29400004 - The number of domain rules in the firewall rule exceeds the maximum.
* @throws { BusinessError } 29400005 - The number of domain rules exceeds the maximum.
* @throws { BusinessError } 29400007 - The dns rule is duplication.
* @syscap SystemCapability.Communication.NetManager.NetFirewall
* @systemapi Hide this for inner system use.
* @since 12
*/
function addNetFirewallRule(rule: NetFirewallRule): Promise<number>;
/**
* Update a firewall rule.
*
* @permission ohos.permission.MANAGE_NET_FIREWALL
* @param { NetFirewallRule } rule - Firewall rule.
* @returns { Promise<void> } Returns void.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 202 - Non-system applications use system APIs.
* @throws { BusinessError } 401 - Parameter error.
* @throws { BusinessError } 2100001 - Invalid parameter value.
* @throws { BusinessError } 2100002 - Operation failed. Cannot connect to service.
* @throws { BusinessError } 2100003 - System internal error.
* @throws { BusinessError } 29400000 - The specified user does not exist.
* @throws { BusinessError } 29400002 - The number of IP address rules in the firewall rule exceeds the maximum.
* @throws { BusinessError } 29400003 - The number of port rules in the firewall rule exceeds the maximum.
* @throws { BusinessError } 29400004 - The number of domain rules in the firewall rule exceeds the maximum.
* @throws { BusinessError } 29400005 - The number of domain rules exceeds the maximum.
* @throws { BusinessError } 29400006 - The specified rule does not exist.
* @throws { BusinessError } 29400007 - The dns rule is duplication.
* @syscap SystemCapability.Communication.NetManager.NetFirewall
* @systemapi Hide this for inner system use.
* @since 12
*/
function updateNetFirewallRule(rule: NetFirewallRule): Promise<void>;
/**
* Delete a firewall rule by userId and ruleId.
*
* @permission ohos.permission.MANAGE_NET_FIREWALL
* @param { number } userId - Indicates the user ID. It cannot be the ID of a user that does not exist.
* @param { number } ruleId - Rule ID.
* @returns { Promise<void> } Returns void.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 202 - Non-system applications use system APIs.
* @throws { BusinessError } 401 - Parameter error.
* @throws { BusinessError } 2100001 - Invalid parameter value.
* @throws { BusinessError } 2100002 - Operation failed. Cannot connect to service.
* @throws { BusinessError } 2100003 - System internal error.
* @throws { BusinessError } 29400000 - The specified user does not exist.
* @throws { BusinessError } 29400006 - The specified rule does not exist.
* @syscap SystemCapability.Communication.NetManager.NetFirewall
* @systemapi Hide this for inner system use.
* @since 12
*/
function removeNetFirewallRule(userId: number, ruleId: number): Promise<void>;
/**
* Get firewall rules by userId, and it is necessary to specify the pagination query parameters.
*
* @permission ohos.permission.GET_NET_FIREWALL
* @param { number } userId - Indicates the user ID. It cannot be the ID of a user that does not exist.
* @param { RequestParam } requestParam - Paging query input parameters.
* @returns { Promise<FirewallRulePage> } Paginated firewall rule list.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 202 - Non-system applications use system APIs.
* @throws { BusinessError } 401 - Parameter error.
* @throws { BusinessError } 2100001 - Invalid parameter value.
* @throws { BusinessError } 2100002 - Operation failed. Cannot connect to service.
* @throws { BusinessError } 2100003 - System internal error.
* @throws { BusinessError } 29400000 - The specified user does not exist.
* @syscap SystemCapability.Communication.NetManager.NetFirewall
* @systemapi Hide this for inner system use.
* @since 12
*/
function getNetFirewallRules(userId: number, requestParam: RequestParam): Promise<FirewallRulePage>;
/**
* Get a specified firewall rule by userId and ruleId.
*
* @permission ohos.permission.GET_NET_FIREWALL
* @param { number } userId - Indicates the user ID. It cannot be the ID of a user that does not exist.
* @param { number } ruleId - Rule ID.
* @returns { Promise<NetFirewallRule> } Firewall Rule.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 202 - Non-system applications use system APIs.
* @throws { BusinessError } 401 - Parameter error.
* @throws { BusinessError } 2100001 - Invalid parameter value.
* @throws { BusinessError } 2100002 - Operation failed. Cannot connect to service.
* @throws { BusinessError } 2100003 - System internal error.
* @throws { BusinessError } 29400000 - The specified user does not exist.
* @throws { BusinessError } 29400006 - The specified rule does not exist.
* @syscap SystemCapability.Communication.NetManager.NetFirewall
* @systemapi Hide this for inner system use.
* @since 12
*/
function getNetFirewallRule(userId: number, ruleId: number): Promise<NetFirewallRule>;
/**
* Get intercepted records by userId, and it is necessary to specify the pagination query parameters.
*
* @permission ohos.permission.GET_NET_FIREWALL
* @param { number } userId - Indicates the user ID. It cannot be the ID of a user that does not exist.
* @param { RequestParam } requestParam - Paging query input parameters.
* @returns { Promise<InterceptedRecordPage> } Block Record List.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 202 - Non-system applications use system APIs.
* @throws { BusinessError } 401 - Parameter error.
* @throws { BusinessError } 2100001 - Invalid parameter value.
* @throws { BusinessError } 2100002 - Operation failed. Cannot connect to service.
* @throws { BusinessError } 2100003 - System internal error.
* @throws { BusinessError } 29400000 - The specified user does not exist.
* @syscap SystemCapability.Communication.NetManager.NetFirewall
* @systemapi Hide this for inner system use.
* @since 12
*/
function getInterceptedRecords(userId: number, requestParam: RequestParam): Promise<InterceptedRecordPage>;
/**
* Firewall rule direction enumeration.
*
* @enum {number}
* @syscap SystemCapability.Communication.NetManager.NetFirewall
* @systemapi Hide this for inner system use.
* @since 12
*/
enum NetFirewallRuleDirection {
/**
* Inbound.
*
* @syscap SystemCapability.Communication.NetManager.NetFirewall
* @systemapi Hide this for inner system use.
* @since 12
*/
RULE_IN = 1,
/**
* Outbound.
*
* @syscap SystemCapability.Communication.NetManager.NetFirewall
* @systemapi Hide this for inner system use.
* @since 12
*/
RULE_OUT = 2
}
/**
* Firewall rule behavior enumeration.
*
* @enum {number}
* @syscap SystemCapability.Communication.NetManager.NetFirewall
* @systemapi Hide this for inner system use.
* @since 12
*/
enum FirewallRuleAction {
/**
* Allow access.
*
* @syscap SystemCapability.Communication.NetManager.NetFirewall
* @systemapi Hide this for inner system use.
* @since 12
*/
RULE_ALLOW = 0,
/**
* Deny access.
*
* @syscap SystemCapability.Communication.NetManager.NetFirewall
* @systemapi Hide this for inner system use.
* @since 12
*/
RULE_DENY = 1
}
/**
* Indicates the firewall rule type.
*
* @enum {number}
* @syscap SystemCapability.Communication.NetManager.NetFirewall
* @systemapi Hide this for inner system use.
* @since 12
*/
enum NetFirewallRuleType {
/**
* IP type rules.
*
* @syscap SystemCapability.Communication.NetManager.NetFirewall
* @systemapi Hide this for inner system use.
* @since 12
*/
RULE_IP = 1,
/**
* Domain type rules.
*
* @syscap SystemCapability.Communication.NetManager.NetFirewall
* @systemapi Hide this for inner system use.
* @since 12
*/
RULE_DOMAIN = 2,
/**
* DNS type rules.
*
* @syscap SystemCapability.Communication.NetManager.NetFirewall
* @systemapi Hide this for inner system use.
* @since 12
*/
RULE_DNS = 3
}
/**
* Pagination query sorting field.
*
* @enum {number}
* @syscap SystemCapability.Communication.NetManager.NetFirewall
* @systemapi Hide this for inner system use.
* @since 12
*/
enum NetFirewallOrderField {
/**
* Sort rule names, it can be referenced only by the getNetFirewallRules interface.
*
* @syscap SystemCapability.Communication.NetManager.NetFirewall
* @systemapi Hide this for inner system use.
* @since 12
*/
ORDER_BY_RULE_NAME = 1,
/**
* Sort the recorded time, it can be referenced only by the getNetFirewallRules interface.
*
* @syscap SystemCapability.Communication.NetManager.NetFirewall
* @systemapi Hide this for inner system use.
* @since 12
*/
ORDER_BY_RECORD_TIME = 100,
}
/**
* Pagination query sorting type.
*
* @enum {number}
* @syscap SystemCapability.Communication.NetManager.NetFirewall
* @systemapi Hide this for inner system use.
* @since 12
*/
enum NetFirewallOrderType {
/**
* Ascending order.
*
* @syscap SystemCapability.Communication.NetManager.NetFirewall
* @systemapi Hide this for inner system use.
* @since 12
*/
ORDER_ASC = 1,
/**
* Descending order.
*
* @syscap SystemCapability.Communication.NetManager.NetFirewall
* @systemapi Hide this for inner system use.
* @since 12
*/
ORDER_DESC = 100,
}
/**
* Firewall policy.
*
* @interface NetFirewallPolicy
* @syscap SystemCapability.Communication.NetManager.NetFirewall
* @systemapi Hide this for inner system use.
* @since 12
*/
interface NetFirewallPolicy {
/**
* Whether the firewall is open.
*
* @type {boolean}
* @syscap SystemCapability.Communication.NetManager.NetFirewall
* @systemapi Hide this for inner system use.
* @since 12
*/
isOpen: boolean;
/**
* Inbound connections are allowed or denied by default.
*
* @type {FirewallRuleAction}
* @syscap SystemCapability.Communication.NetManager.NetFirewall
* @systemapi Hide this for inner system use.
* @since 12
*/
inAction: FirewallRuleAction;
/**
* Outbound connections are allowed or denied by default.
*
* @type {FirewallRuleAction}
* @syscap SystemCapability.Communication.NetManager.NetFirewall
* @systemapi Hide this for inner system use.
* @since 12
*/
outAction: FirewallRuleAction;
}
/**
* Firewall IP parameters.
*
* @interface NetFirewallIpParams
* @syscap SystemCapability.Communication.NetManager.NetFirewall
* @systemapi Hide this for inner system use.
* @since 12
*/
interface NetFirewallIpParams {
/**
* 1: IP address or subnet, when using a single IP, the mask is 32; 2: IP segment.
*
* @type {number}
* @syscap SystemCapability.Communication.NetManager.NetFirewall
* @systemapi Hide this for inner system use.
* @since 12
*/
type: number;
/**
* 1: IPv4, 2: IPv6, default is IPv4.
*
* @type {?number}
* @syscap SystemCapability.Communication.NetManager.NetFirewall
* @systemapi Hide this for inner system use.
* @since 12
*/
family?: number;
/**
* IP address: Valid when type equals 1, otherwise it will be ignored.
*
* @type {?string}
* @syscap SystemCapability.Communication.NetManager.NetFirewall
* @systemapi Hide this for inner system use.
* @since 12
*/
address?: string;
/**
* IPv4: subnet mask, IPv6: prefix, valid when type equals 1, otherwise it will be ignored.
*
* @type {?number}
* @syscap SystemCapability.Communication.NetManager.NetFirewall
* @systemapi Hide this for inner system use.
* @since 12
*/
mask?: number;
/**
* Start IP: valid when type equals 2, otherwise it will be ignored.
*
* @type {?string}
* @syscap SystemCapability.Communication.NetManager.NetFirewall
* @systemapi Hide this for inner system use.
* @since 12
*/
startIp?: string;
/**
* End IP: valid when type equals 2, otherwise it will be ignored.
*
* @type {?string}
* @syscap SystemCapability.Communication.NetManager.NetFirewall
* @systemapi Hide this for inner system use.
* @since 12
*/
endIp?: string;
}
/**
* Firewall port parameters.
*
* @interface NetFirewallPortParams
* @syscap SystemCapability.Communication.NetManager.NetFirewall
* @systemapi Hide this for inner system use.
* @since 12
*/
interface NetFirewallPortParams {
/**
* Start port, when there is only one port, the start port is the same as the end port.
*
* @type {number}
* @syscap SystemCapability.Communication.NetManager.NetFirewall
* @systemapi Hide this for inner system use.
* @since 12
*/
startPort: number;
/**
* End port, when there is only one port, the start port is the same as the end port.
*
* @type {number}
* @syscap SystemCapability.Communication.NetManager.NetFirewall
* @systemapi Hide this for inner system use.
* @since 12
*/
endPort: number;
}
/**
* Firewall domain name parameters.
*
* @interface NetFirewallDomainParams
* @syscap SystemCapability.Communication.NetManager.NetFirewall
* @systemapi Hide this for inner system use.
* @since 12
*/
interface NetFirewallDomainParams {
/**
* Is there a universal configuration rule.
*
* @type {boolean}
* @syscap SystemCapability.Communication.NetManager.NetFirewall
* @systemapi Hide this for inner system use.
* @since 12
*/
isWildcard: boolean;
/**
* Domain: when isWildcard is false, the complete domain that needs to be determined;
* When isWildcard is true, fuzzy domain only support domains like *.openharmony.cn; *.com.
*
* @type {string}
* @syscap SystemCapability.Communication.NetManager.NetFirewall
* @systemapi Hide this for inner system use.
* @since 12
*/
domain: string;
}
/**
* Firewall DNS parameters.
*
* @interface NetFirewallDnsParams
* @syscap SystemCapability.Communication.NetManager.NetFirewall
* @systemapi Hide this for inner system use.
* @since 12
*/
interface NetFirewallDnsParams {
/**
* Primary DNS.
*
* @type {string}
* @syscap SystemCapability.Communication.NetManager.NetFirewall
* @systemapi Hide this for inner system use.
* @since 12
*/
primaryDns: string;
/**
* Backup DNS.
*
* @type {?string}
* @syscap SystemCapability.Communication.NetManager.NetFirewall
* @systemapi Hide this for inner system use.
* @since 12
*/
standbyDns?: string;
}
/**
* Firewall rules.
*
* @interface NetFirewallRule
* @syscap SystemCapability.Communication.NetManager.NetFirewall
* @systemapi Hide this for inner system use.
* @since 12
*/
interface NetFirewallRule {
/**
* User id.
*
* @type {number}
* @syscap SystemCapability.Communication.NetManager.NetFirewall
* @systemapi Hide this for inner system use.
* @since 12
*/
userId: number;
/**
* Rule name.
*
* @type {string}
* @syscap SystemCapability.Communication.NetManager.NetFirewall
* @systemapi Hide this for inner system use.
* @since 12
*/
name: string;
/**
* Rule direction, inbound or outbound.
*
* @type {NetFirewallRuleDirection}
* @syscap SystemCapability.Communication.NetManager.NetFirewall
* @systemapi Hide this for inner system use.
* @since 12
*/
direction: NetFirewallRuleDirection;
/**
* Rule action.
*
* @type {FirewallRuleAction}
* @syscap SystemCapability.Communication.NetManager.NetFirewall
* @systemapi Hide this for inner system use.
* @since 12
*/
action: FirewallRuleAction;
/**
* Rule type.
*
* @type {NetFirewallRuleType}
* @syscap SystemCapability.Communication.NetManager.NetFirewall
* @systemapi Hide this for inner system use.
* @since 12
*/
type: NetFirewallRuleType;
/**
* Whether the rule is enabled.
*
* @type {boolean}
* @syscap SystemCapability.Communication.NetManager.NetFirewall
* @systemapi Hide this for inner system use.
* @since 12
*/
isEnabled: boolean;
/**
* Rule id: When a rule is added to the system, the system generates a rule ID.
*
* @type {?number}
* @syscap SystemCapability.Communication.NetManager.NetFirewall
* @systemapi Hide this for inner system use.
* @since 12
*/
id?: number;
/**
* Rule description.
*
* @type {?string}
* @syscap SystemCapability.Communication.NetManager.NetFirewall
* @systemapi Hide this for inner system use.
* @since 12
*/
description?: string;
/**
* Application or service UID.
*
* @type {?number}
* @syscap SystemCapability.Communication.NetManager.NetFirewall
* @systemapi Hide this for inner system use.
* @since 12
*/
appUid?: number;
/**
* Local IP address: valid when ruleType = RULE_IP, otherwise it will be ignored.
*
* @type {?Array<NetFirewallIpParams>}
* @syscap SystemCapability.Communication.NetManager.NetFirewall
* @systemapi Hide this for inner system use.
* @since 12
*/
localIps?: Array<NetFirewallIpParams>;
/**
* Remote IP address: valid when ruleType = RULE_IP, otherwise it will be ignored.
*
* @type {?Array<NetFirewallIpParams>}
* @syscap SystemCapability.Communication.NetManager.NetFirewall
* @systemapi Hide this for inner system use.
* @since 12
*/
remoteIps?: Array<NetFirewallIpParams>;
/**
* Protocol, 1: ICMPv4, 6: TCP, 17: UDP, 58: ICMPv6. Valid when ruleType = RULE_IP, otherwise it will be ignored.
*
* @type {?number}
* @syscap SystemCapability.Communication.NetManager.NetFirewall
* @systemapi Hide this for inner system use.
* @since 12
*/
protocol?: number;
/**
* Local ports: valid when ruleType = RULE_IP, otherwise it will be ignored.
*
* @type {?Array<NetFirewallPortParams>}
* @syscap SystemCapability.Communication.NetManager.NetFirewall
* @systemapi Hide this for inner system use.
* @since 12
*/
localPorts?: Array<NetFirewallPortParams>;
/**
* Remote ports: valid when ruleType = RULE_IP, otherwise it will be ignored.
*
* @type {?Array<NetFirewallPortParams>}
* @syscap SystemCapability.Communication.NetManager.NetFirewall
* @systemapi Hide this for inner system use.
* @since 12
*/
remotePorts?: Array<NetFirewallPortParams>;
/**
* Domain name list: valid when ruleType = RULE_DOMAIN, otherwise it will be ignored.
*
* @type {?Array<NetFirewallDomainParams>}
* @syscap SystemCapability.Communication.NetManager.NetFirewall
* @systemapi Hide this for inner system use.
* @since 12
*/
domains?: Array<NetFirewallDomainParams>;
/**
* DNS: valid when ruleType = RULE_DNS, otherwise it will be ignored.
*
* @type {?NetFirewallDnsParams}
* @syscap SystemCapability.Communication.NetManager.NetFirewall
* @systemapi Hide this for inner system use.
* @since 12
*/
dns?: NetFirewallDnsParams;
}
/**
* Intercepted record.
*
* @interface InterceptedRecord
* @syscap SystemCapability.Communication.NetManager.NetFirewall
* @systemapi Hide this for inner system use.
* @since 12
*/
interface InterceptedRecord {
/**
* Time stamp.
*
* @type {number}
* @syscap SystemCapability.Communication.NetManager.NetFirewall
* @systemapi Hide this for inner system use.
* @since 12
*/
time: number;
/**
* Local IP.
*
* @type {?string}
* @syscap SystemCapability.Communication.NetManager.NetFirewall
* @systemapi Hide this for inner system use.
* @since 12
*/
localIp?: string;
/**
* Remote IP.
*
* @type {?string}
* @syscap SystemCapability.Communication.NetManager.NetFirewall
* @systemapi Hide this for inner system use.
* @since 12
*/
remoteIp?: string;
/**
* Local port.
*
* @type {?number}
* @syscap SystemCapability.Communication.NetManager.NetFirewall
* @systemapi Hide this for inner system use.
* @since 12
*/
localPort?: number;
/**
* Remote port.
*
* @type {?number}
* @syscap SystemCapability.Communication.NetManager.NetFirewall
* @systemapi Hide this for inner system use.
* @since 12
*/
remotePort?: number;
/**
* Transport layer protocol.
*
* @type {?number}
* @syscap SystemCapability.Communication.NetManager.NetFirewall
* @systemapi Hide this for inner system use.
* @since 12
*/
protocol?: number;
/**
* Application or service ID.
*
* @type {?number}
* @syscap SystemCapability.Communication.NetManager.NetFirewall
* @systemapi Hide this for inner system use.
* @since 12
*/
appUid?: number;
/**
* Blocked domain name information.
*
* @type {?string}
* @syscap SystemCapability.Communication.NetManager.NetFirewall
* @systemapi Hide this for inner system use.
* @since 12
*/
domain?: string;
}
/**
* Pagination query input parameters.
*
* @interface RequestParam
* @syscap SystemCapability.Communication.NetManager.NetFirewall
* @systemapi Hide this for inner system use.
* @since 12
*/
interface RequestParam {
/**
* Page number: indicates the page number to be queried. The start value is 1.
*
* @type {number}
* @syscap SystemCapability.Communication.NetManager.NetFirewall
* @systemapi Hide this for inner system use.
* @since 12
*/
page: number;
/**
* Page size: indicates the number of data records to be queried at a time. The maximum value is 50.
*
* @type {number}
* @syscap SystemCapability.Communication.NetManager.NetFirewall
* @systemapi Hide this for inner system use.
* @since 12
*/
pageSize: number;
/**
* Sort field.
*
* @type {NetFirewallOrderField}
* @syscap SystemCapability.Communication.NetManager.NetFirewall
* @systemapi Hide this for inner system use.
* @since 12
*/
orderField: NetFirewallOrderField;
/**
* Sort Type: ascending or descending.
*
* @type {NetFirewallOrderType}
* @syscap SystemCapability.Communication.NetManager.NetFirewall
* @systemapi Hide this for inner system use.
* @since 12
*/
orderType: NetFirewallOrderType;
}
/**
* Rule page information.
*
* @interface FirewallRulePage
* @syscap SystemCapability.Communication.NetManager.NetFirewall
* @systemapi Hide this for inner system use.
* @since 12
*/
interface FirewallRulePage {
/**
* Current page number: indicates the page number of this query.
*
* @type {number}
* @syscap SystemCapability.Communication.NetManager.NetFirewall
* @systemapi Hide this for inner system use.
* @since 12
*/
page: number;
/**
* Page size: maximum number of records on a page for this query.
*
* @type {number}
* @syscap SystemCapability.Communication.NetManager.NetFirewall
* @systemapi Hide this for inner system use.
* @since 12
*/
pageSize: number;
/**
* Total pages: total number of pages.
*
* @type {number}
* @syscap SystemCapability.Communication.NetManager.NetFirewall
* @systemapi Hide this for inner system use.
* @since 12
*/
totalPage: number;
/**
* Page data: all records displayed on this page.
*
* @type {Array<NetFirewallRule> }
* @syscap SystemCapability.Communication.NetManager.NetFirewall
* @systemapi Hide this for inner system use.
* @since 12
*/
data: Array<NetFirewallRule>;
}
/**
* Intercepted record page information.
*
* @interface InterceptedRecordPage
* @syscap SystemCapability.Communication.NetManager.NetFirewall
* @systemapi Hide this for inner system use.
* @since 12
*/
interface InterceptedRecordPage {
/**
* Current page number: indicates the page number of this query.
*
* @type {number}
* @syscap SystemCapability.Communication.NetManager.NetFirewall
* @systemapi Hide this for inner system use.
* @since 12
*/
page: number;
/**
* Page size: maximum number of records on a page for this query.
*
* @type {number}
* @syscap SystemCapability.Communication.NetManager.NetFirewall
* @systemapi Hide this for inner system use.
* @since 12
*/
pageSize: number;
/**
* Total pages: total number of pages.
*
* @type {number}
* @syscap SystemCapability.Communication.NetManager.NetFirewall
* @systemapi Hide this for inner system use.
* @since 12
*/
totalPage: number;
/**
* Page data: all records displayed on this page.
*
* @type {Array<InterceptedRecord>}
* @syscap SystemCapability.Communication.NetManager.NetFirewall
* @systemapi Hide this for inner system use.
* @since 12
*/
data: Array<InterceptedRecord>;
}
}
export default netFirewall;
Loading...
马建仓 AI 助手
尝试更多
代码解读
代码找茬
代码优化
1
https://gitee.com/lffl8796/interface_sdk-js.git
git@gitee.com:lffl8796/interface_sdk-js.git
lffl8796
interface_sdk-js
interface_sdk-js
master

搜索帮助